@knocklabs/node 1.19.0 → 1.21.0

package/src/resources/recipients/preferences.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as PreferencesAPI from './preferences';
-import * as SharedAPI from '../shared';
+import * as Shared from '../shared';
 
 export class Preferences extends APIResource {}
 
@@ -34,6 +34,17 @@ export interface PreferenceSet {
    */
   channel_types?: PreferenceSetChannelTypes | null;
 
+  /**
+   * Channel preferences.
+   */
+  channels?: { [key: string]: boolean | PreferenceSet.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.
@@ -52,10 +63,41 @@ export namespace PreferenceSet {
      */
     channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
 
+    /**
+     * Channel preferences.
+     */
+    channels?: {
+      [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
+    } | null;
+
     /**
      * A list of conditions to apply to a channel type.
      */
-    conditions?: Array<SharedAPI.Condition> | null;
+    conditions?: Array<Shared.Condition> | null;
+  }
+
+  export namespace PreferenceSetWorkflowCategorySettingObject {
+    /**
+     * A set of settings for a specific channel. Currently, this can only be a list of
+     * conditions to apply.
+     */
+    export interface PreferenceSetChannelSetting {
+      /**
+       * A list of conditions to apply to a specific channel.
+       */
+      conditions: Array<Shared.Condition>;
+    }
+  }
+
+  /**
+   * A set of settings for a specific channel. Currently, this can only be a list of
+   * conditions to apply.
+   */
+  export interface PreferenceSetChannelSetting {
+    /**
+     * A list of conditions to apply to a specific channel.
+     */
+    conditions: Array<Shared.Condition>;
   }
 
   /**
@@ -68,10 +110,30 @@ export namespace PreferenceSet {
      */
     channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
 
+    /**
+     * Channel preferences.
+     */
+    channels?: {
+      [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
+    } | null;
+
     /**
      * A list of conditions to apply to a channel type.
      */
-    conditions?: Array<SharedAPI.Condition> | null;
+    conditions?: Array<Shared.Condition> | null;
+  }
+
+  export namespace PreferenceSetWorkflowCategorySettingObject {
+    /**
+     * A set of settings for a specific channel. Currently, this can only be a list of
+     * conditions to apply.
+     */
+    export interface PreferenceSetChannelSetting {
+      /**
+       * A list of conditions to apply to a specific channel.
+       */
+      conditions: Array<Shared.Condition>;
+    }
   }
 }
 
@@ -83,7 +145,7 @@ export interface PreferenceSetChannelTypeSetting {
   /**
    * A list of conditions to apply to a channel type.
    */
-  conditions: Array<SharedAPI.Condition>;
+  conditions: Array<Shared.Condition>;
 }
 
 /**
@@ -144,6 +206,17 @@ export interface PreferenceSetRequest {
    */
   channel_types?: PreferenceSetChannelTypes | null;
 
+  /**
+   * Channel preferences.
+   */
+  channels?: { [key: string]: boolean | PreferenceSetRequest.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.
@@ -164,10 +237,41 @@ export namespace PreferenceSetRequest {
      */
     channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
 
+    /**
+     * Channel preferences.
+     */
+    channels?: {
+      [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
+    } | null;
+
     /**
      * A list of conditions to apply to a channel type.
      */
-    conditions?: Array<SharedAPI.Condition> | null;
+    conditions?: Array<Shared.Condition> | null;
+  }
+
+  export namespace PreferenceSetWorkflowCategorySettingObject {
+    /**
+     * A set of settings for a specific channel. Currently, this can only be a list of
+     * conditions to apply.
+     */
+    export interface PreferenceSetChannelSetting {
+      /**
+       * A list of conditions to apply to a specific channel.
+       */
+      conditions: Array<Shared.Condition>;
+    }
+  }
+
+  /**
+   * A set of settings for a specific channel. Currently, this can only be a list of
+   * conditions to apply.
+   */
+  export interface PreferenceSetChannelSetting {
+    /**
+     * A list of conditions to apply to a specific channel.
+     */
+    conditions: Array<Shared.Condition>;
   }
 
   /**
@@ -180,10 +284,30 @@ export namespace PreferenceSetRequest {
      */
     channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
 
+    /**
+     * Channel preferences.
+     */
+    channels?: {
+      [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
+    } | null;
+
     /**
      * A list of conditions to apply to a channel type.
      */
-    conditions?: Array<SharedAPI.Condition> | null;
+    conditions?: Array<Shared.Condition> | null;
+  }
+
+  export namespace PreferenceSetWorkflowCategorySettingObject {
+    /**
+     * A set of settings for a specific channel. Currently, this can only be a list of
+     * conditions to apply.
+     */
+    export interface PreferenceSetChannelSetting {
+      /**
+       * A list of conditions to apply to a specific channel.
+       */
+      conditions: Array<Shared.Condition>;
+    }
   }
 }
 

package/src/resources/recipients/recipients.ts

@@ -9,8 +9,6 @@ import {
   DiscordChannelData,
   InlineChannelDataRequest,
   MsTeamsChannelData,
-  OneSignalChannelData,
-  PushChannelData,
   SlackChannelData,
 } from './channel-data';
 import * as PreferencesAPI from './preferences';
@@ -94,8 +92,6 @@ export declare namespace Recipients {
     type DiscordChannelData as DiscordChannelData,
     type InlineChannelDataRequest as InlineChannelDataRequest,
     type MsTeamsChannelData as MsTeamsChannelData,
-    type OneSignalChannelData as OneSignalChannelData,
-    type PushChannelData as PushChannelData,
     type SlackChannelData as SlackChannelData,
   };
 }

package/src/resources/shared.ts

@@ -1,9 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../core/resource';
-
-export class Shared extends APIResource {}
-
 /**
  * A condition to be evaluated.
  */
@@ -66,7 +62,3 @@ export interface PageInfo {
    */
   before?: string | null;
 }
-
-export declare namespace Shared {
-  export { type Condition as Condition, type PageInfo as PageInfo };
-}

package/src/resources/users/bulk.ts

@@ -63,6 +63,19 @@ export class Bulk extends APIResource {
    *         transactional: { channel_types: { email: false } },
    *       },
    *       channel_types: { email: true },
+   *       channels: {
+   *         '2f641633-95d3-4555-9222-9f1eb7888a80': {
+   *           conditions: [
+   *             {
+   *               argument: 'US',
+   *               operator: 'equal_to',
+   *               variable: 'recipient.country_code',
+   *             },
+   *           ],
+   *         },
+   *         'aef6e715-df82-4ab6-b61e-b743e249f7b6': true,
+   *       },
+   *       commercial_subscribed: true,
    *       workflows: {
    *         'dinosaurs-loose': {
    *           channel_types: { email: false },

package/src/resources/users/guides.ts

@@ -142,50 +142,149 @@ export interface GuideGetChannelResponse {
   /**
    * A list of guides.
    */
-  guides: Array<GuideGetChannelResponse.Guide>;
+  entries: Array<GuideGetChannelResponse.Entry>;
 
   /**
-   * The recipient of the guide.
+   * A map of guide group keys to their last display timestamps.
    */
-  recipient?: GuideGetChannelResponse.Recipient | null;
+  guide_group_display_logs: { [key: string]: string };
+
+  /**
+   * A list of guide groups with their display sequences and intervals.
+   */
+  guide_groups: Array<GuideGetChannelResponse.GuideGroup>;
 }
 
 export namespace GuideGetChannelResponse {
-  export interface Guide {
+  export interface Entry {
     /**
      * The unique identifier for the guide.
      */
     id?: string;
 
     /**
-     * Whether the guide is active.
+     * The typename of the schema.
      */
-    active?: boolean;
+    __typename?: string;
 
     /**
-     * The content of the guide.
+     * A list of URL Patterns to evaluate user's current location to activate the
+     * guide, if matched
      */
-    content?: string;
+    activation_url_patterns?: Array<Entry.ActivationURLPattern>;
 
     /**
-     * The metadata of the guide.
+     * A list of URL rules to evaluate user's current location to activate the guide,
+     * if matched
      */
-    metadata?: { [key: string]: unknown };
+    activation_url_rules?: Array<Entry.ActivationURLRule>;
 
     /**
-     * The title of the guide.
+     * Whether the guide is active.
      */
-    title?: string;
-  }
+    active?: boolean;
+
+    bypass_global_group_limit?: boolean;
+
+    channel_id?: string;
+
+    inserted_at?: string;
 
-  /**
-   * The recipient of the guide.
-   */
-  export interface Recipient {
     /**
-     * Unique identifier for the recipient.
+     * The key of the guide.
      */
-    id?: string;
+    key?: string;
+
+    semver?: string;
+
+    steps?: Array<Entry.Step>;
+
+    /**
+     * The type of the guide.
+     */
+    type?: string;
+
+    updated_at?: string;
+  }
+
+  export namespace Entry {
+    export interface ActivationURLPattern {
+      /**
+       * The directive for the URL pattern ('allow' or 'block')
+       */
+      directive?: string;
+
+      /**
+       * The pathname pattern to match (supports wildcards like /\*)
+       */
+      pathname?: string;
+    }
+
+    export interface ActivationURLRule {
+      /**
+       * The value to compare against
+       */
+      argument?: string;
+
+      /**
+       * The directive for the URL pattern ('allow' or 'block')
+       */
+      directive?: string;
+
+      /**
+       * The comparison operator ('contains' or 'equal_to')
+       */
+      operator?: string;
+
+      /**
+       * The variable to evaluate ('pathname')
+       */
+      variable?: string;
+    }
+
+    export interface Step {
+      content?: { [key: string]: unknown };
+
+      message?: Step.Message;
+
+      ref?: string;
+
+      schema_key?: string;
+
+      schema_semver?: string;
+
+      schema_variant_key?: string;
+    }
+
+    export namespace Step {
+      export interface Message {
+        id?: string | null;
+
+        archived_at?: string | null;
+
+        interacted_at?: string | null;
+
+        link_clicked_at?: string | null;
+
+        read_at?: string | null;
+
+        seen_at?: string | null;
+      }
+    }
+  }
+
+  export interface GuideGroup {
+    __typename?: string;
+
+    display_interval?: number;
+
+    display_sequence?: Array<string>;
+
+    inserted_at?: string;
+
+    key?: string;
+
+    updated_at?: string;
   }
 }
 

package/src/resources/users/users.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as SharedAPI from '../shared';
+import * as Shared from '../shared';
 import * as MessagesAPI from '../messages/messages';
 import { MessagesItemsCursor } from '../messages/messages';
 import * as ChannelDataAPI from '../recipients/channel-data';
@@ -316,6 +316,19 @@ export class Users extends APIResource {
    *       transactional: { channel_types: { email: false } },
    *     },
    *     channel_types: { email: true },
+   *     channels: {
+   *       '2f641633-95d3-4555-9222-9f1eb7888a80': {
+   *         conditions: [
+   *           {
+   *             argument: 'US',
+   *             operator: 'equal_to',
+   *             variable: 'recipient.country_code',
+   *           },
+   *         ],
+   *       },
+   *       'aef6e715-df82-4ab6-b61e-b743e249f7b6': true,
+   *     },
+   *     commercial_subscribed: true,
    *     workflows: {
    *       'dinosaurs-loose': {
    *         channel_types: { email: false },
@@ -735,25 +748,45 @@ export interface UserSetChannelDataParams {
    * Channel data for a given channel type.
    */
   data:
-    | ChannelDataAPI.PushChannelData
-    | ChannelDataAPI.OneSignalChannelData
-    | UserSetChannelDataParams.AwsSnsPushChannelData
+    | UserSetChannelDataParams.PushChannelDataTokensOnly
+    | UserSetChannelDataParams.AwssnsPushChannelDataTargetArNsOnly
+    | UserSetChannelDataParams.OneSignalChannelDataPlayerIDsOnly
     | ChannelDataAPI.SlackChannelData
     | ChannelDataAPI.MsTeamsChannelData
     | ChannelDataAPI.DiscordChannelData;
 }
 
 export namespace UserSetChannelDataParams {
+  /**
+   * Push channel data.
+   */
+  export interface PushChannelDataTokensOnly {
+    /**
+     * A list of push channel tokens.
+     */
+    tokens: Array<string>;
+  }
+
   /**
    * AWS SNS push channel data.
    */
-  export interface AwsSnsPushChannelData {
+  export interface AwssnsPushChannelDataTargetArNsOnly {
     /**
      * A list of platform endpoint ARNs. See
      * [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
      */
     target_arns: Array<string>;
   }
+
+  /**
+   * OneSignal channel data.
+   */
+  export interface OneSignalChannelDataPlayerIDsOnly {
+    /**
+     * A list of OneSignal player IDs.
+     */
+    player_ids: Array<string>;
+  }
 }
 
 export interface UserSetPreferencesParams {
@@ -776,6 +809,17 @@ export interface UserSetPreferencesParams {
    */
   channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
 
+  /**
+   * Channel preferences.
+   */
+  channels?: { [key: string]: boolean | UserSetPreferencesParams.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.
@@ -796,10 +840,41 @@ export namespace UserSetPreferencesParams {
      */
     channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
 
+    /**
+     * Channel preferences.
+     */
+    channels?: {
+      [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
+    } | null;
+
     /**
      * A list of conditions to apply to a channel type.
      */
-    conditions?: Array<SharedAPI.Condition> | null;
+    conditions?: Array<Shared.Condition> | null;
+  }
+
+  export namespace PreferenceSetWorkflowCategorySettingObject {
+    /**
+     * A set of settings for a specific channel. Currently, this can only be a list of
+     * conditions to apply.
+     */
+    export interface PreferenceSetChannelSetting {
+      /**
+       * A list of conditions to apply to a specific channel.
+       */
+      conditions: Array<Shared.Condition>;
+    }
+  }
+
+  /**
+   * A set of settings for a specific channel. Currently, this can only be a list of
+   * conditions to apply.
+   */
+  export interface PreferenceSetChannelSetting {
+    /**
+     * A list of conditions to apply to a specific channel.
+     */
+    conditions: Array<Shared.Condition>;
   }
 
   /**
@@ -812,10 +887,30 @@ export namespace UserSetPreferencesParams {
      */
     channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
 
+    /**
+     * Channel preferences.
+     */
+    channels?: {
+      [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
+    } | null;
+
     /**
      * A list of conditions to apply to a channel type.
      */
-    conditions?: Array<SharedAPI.Condition> | null;
+    conditions?: Array<Shared.Condition> | null;
+  }
+
+  export namespace PreferenceSetWorkflowCategorySettingObject {
+    /**
+     * A set of settings for a specific channel. Currently, this can only be a list of
+     * conditions to apply.
+     */
+    export interface PreferenceSetChannelSetting {
+      /**
+       * A list of conditions to apply to a specific channel.
+       */
+      conditions: Array<Shared.Condition>;
+    }
   }
 }
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.19.0'; // x-release-please-version
+export const VERSION = '1.21.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.19.0";
+export declare const VERSION = "1.21.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.19.0'; // x-release-please-version
+exports.VERSION = '1.21.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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