@knocklabs/node 1.20.0 → 1.22.0

package/src/resources/recipients/channel-data.ts

@@ -4,6 +4,53 @@ import { APIResource } from '../../core/resource';
 
 export class ChannelData extends APIResource {}
 
+/**
+ * AWS SNS push channel data.
+ */
+export interface AwsSnsPushChannelDataDevicesOnly {
+  /**
+   * A list of devices. Each device contains a target_arn, and optionally a locale
+   * and timezone.
+   */
+  devices: Array<AwsSnsPushChannelDataDevicesOnly.Device>;
+}
+
+export namespace AwsSnsPushChannelDataDevicesOnly {
+  export interface Device {
+    /**
+     * The ARN of a platform endpoint associated with a platform application and a
+     * device token. See
+     * [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
+     */
+    target_arn: string;
+
+    /**
+     * The locale of the object. Used for
+     * [message localization](/concepts/translations).
+     */
+    locale?: string | null;
+
+    /**
+     * The timezone of the object. Must be a
+     * valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+     * Used
+     * for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+     */
+    timezone?: string | null;
+  }
+}
+
+/**
+ * AWS SNS push channel data.
+ */
+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>;
+}
+
 /**
  * Channel data for a given channel type.
  */
@@ -22,12 +69,12 @@ export interface ChannelData {
    * Channel data for a given channel type.
    */
   data:
-    | PushChannelData
+    | ChannelData.PushChannelDataFull
+    | ChannelData.AwssnsPushChannelDataFull
+    | OneSignalChannelDataPlayerIDsOnly
     | SlackChannelData
     | MsTeamsChannelData
-    | DiscordChannelData
-    | OneSignalChannelData
-    | ChannelData.AwsSnsPushChannelData;
+    | DiscordChannelData;
 
   /**
    * The type of provider.
@@ -45,16 +92,86 @@ export interface ChannelData {
 }
 
 export namespace ChannelData {
+  /**
+   * Push channel data.
+   */
+  export interface PushChannelDataFull {
+    /**
+     * A list of devices. Each device contains a token, and optionally a locale and
+     * timezone.
+     */
+    devices: Array<PushChannelDataFull.Device>;
+
+    /**
+     * A list of push channel tokens.
+     */
+    tokens: Array<string>;
+  }
+
+  export namespace PushChannelDataFull {
+    export interface Device {
+      /**
+       * The device token to send the push notification to.
+       */
+      token: string;
+
+      /**
+       * The locale of the object. Used for
+       * [message localization](/concepts/translations).
+       */
+      locale?: string | null;
+
+      /**
+       * The timezone of the object. Must be a
+       * valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+       * Used
+       * for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+       */
+      timezone?: string | null;
+    }
+  }
+
   /**
    * AWS SNS push channel data.
    */
-  export interface AwsSnsPushChannelData {
+  export interface AwssnsPushChannelDataFull {
+    /**
+     * A list of devices. Each device contains a target_arn, and optionally a locale
+     * and timezone.
+     */
+    devices: Array<AwssnsPushChannelDataFull.Device>;
+
     /**
      * 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>;
   }
+
+  export namespace AwssnsPushChannelDataFull {
+    export interface Device {
+      /**
+       * The ARN of a platform endpoint associated with a platform application and a
+       * device token. See
+       * [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
+       */
+      target_arn: string;
+
+      /**
+       * The locale of the object. Used for
+       * [message localization](/concepts/translations).
+       */
+      locale?: string | null;
+
+      /**
+       * The timezone of the object. Must be a
+       * valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+       * Used
+       * for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+       */
+      timezone?: string | null;
+    }
+  }
 }
 
 /**
@@ -65,27 +182,16 @@ export interface ChannelDataRequest {
    * Channel data for a given channel type.
    */
   data:
-    | PushChannelData
-    | OneSignalChannelData
-    | ChannelDataRequest.AwsSnsPushChannelData
+    | PushChannelDataTokensOnly
+    | PushChannelDataDevicesOnly
+    | AwsSnsPushChannelDataTargetArnsOnly
+    | AwsSnsPushChannelDataDevicesOnly
+    | OneSignalChannelDataPlayerIDsOnly
     | SlackChannelData
     | MsTeamsChannelData
     | DiscordChannelData;
 }
 
-export namespace ChannelDataRequest {
-  /**
-   * AWS SNS push channel data.
-   */
-  export interface AwsSnsPushChannelData {
-    /**
-     * 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>;
-  }
-}
-
 /**
  * Discord channel data.
  */
@@ -137,27 +243,16 @@ export namespace DiscordChannelData {
  */
 export type InlineChannelDataRequest = {
   [key: string]:
-    | PushChannelData
-    | OneSignalChannelData
-    | InlineChannelDataRequest.AwsSnsPushChannelData
+    | PushChannelDataTokensOnly
+    | PushChannelDataDevicesOnly
+    | AwsSnsPushChannelDataTargetArnsOnly
+    | AwsSnsPushChannelDataDevicesOnly
+    | OneSignalChannelDataPlayerIDsOnly
     | SlackChannelData
     | MsTeamsChannelData
     | DiscordChannelData;
 };
 
-export namespace InlineChannelDataRequest {
-  /**
-   * AWS SNS push channel data.
-   */
-  export interface AwsSnsPushChannelData {
-    /**
-     * 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>;
-  }
-}
-
 /**
  * Microsoft Teams channel data.
  */
@@ -227,7 +322,7 @@ export namespace MsTeamsChannelData {
 /**
  * OneSignal channel data.
  */
-export interface OneSignalChannelData {
+export interface OneSignalChannelDataPlayerIDsOnly {
   /**
    * A list of OneSignal player IDs.
    */
@@ -237,7 +332,41 @@ export interface OneSignalChannelData {
 /**
  * Push channel data.
  */
-export interface PushChannelData {
+export interface PushChannelDataDevicesOnly {
+  /**
+   * A list of devices. Each device contains a token, and optionally a locale and
+   * timezone.
+   */
+  devices: Array<PushChannelDataDevicesOnly.Device>;
+}
+
+export namespace PushChannelDataDevicesOnly {
+  export interface Device {
+    /**
+     * The device token to send the push notification to.
+     */
+    token: string;
+
+    /**
+     * The locale of the object. Used for
+     * [message localization](/concepts/translations).
+     */
+    locale?: string | null;
+
+    /**
+     * The timezone of the object. Must be a
+     * valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+     * Used
+     * for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+     */
+    timezone?: string | null;
+  }
+}
+
+/**
+ * Push channel data.
+ */
+export interface PushChannelDataTokensOnly {
   /**
    * A list of push channel tokens.
    */
@@ -303,13 +432,16 @@ export namespace SlackChannelData {
 
 export declare namespace ChannelData {
   export {
+    type AwsSnsPushChannelDataDevicesOnly as AwsSnsPushChannelDataDevicesOnly,
+    type AwsSnsPushChannelDataTargetArnsOnly as AwsSnsPushChannelDataTargetArnsOnly,
     type ChannelData as ChannelData,
     type ChannelDataRequest as ChannelDataRequest,
     type DiscordChannelData as DiscordChannelData,
     type InlineChannelDataRequest as InlineChannelDataRequest,
     type MsTeamsChannelData as MsTeamsChannelData,
-    type OneSignalChannelData as OneSignalChannelData,
-    type PushChannelData as PushChannelData,
+    type OneSignalChannelDataPlayerIDsOnly as OneSignalChannelDataPlayerIDsOnly,
+    type PushChannelDataDevicesOnly as PushChannelDataDevicesOnly,
+    type PushChannelDataTokensOnly as PushChannelDataTokensOnly,
     type SlackChannelData as SlackChannelData,
   };
 }

package/src/resources/recipients/index.ts

@@ -2,18 +2,22 @@
 
 export {
   ChannelData,
+  type AwsSnsPushChannelDataDevicesOnly,
+  type AwsSnsPushChannelDataTargetArnsOnly,
   type ChannelDataRequest,
   type DiscordChannelData,
   type InlineChannelDataRequest,
   type MsTeamsChannelData,
-  type OneSignalChannelData,
-  type PushChannelData,
+  type OneSignalChannelDataPlayerIDsOnly,
+  type PushChannelDataDevicesOnly,
+  type PushChannelDataTokensOnly,
   type SlackChannelData,
 } from './channel-data';
 export {
   Preferences,
   type InlinePreferenceSetRequest,
   type PreferenceSet,
+  type PreferenceSetChannelSetting,
   type PreferenceSetChannelTypeSetting,
   type PreferenceSetChannelTypes,
   type PreferenceSetRequest,

package/src/resources/recipients/preferences.ts

@@ -34,6 +34,17 @@ export interface PreferenceSet {
    */
   channel_types?: PreferenceSetChannelTypes | null;
 
+  /**
+   * Channel preferences.
+   */
+  channels?: { [key: string]: boolean | 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,6 +63,11 @@ export namespace PreferenceSet {
      */
     channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
 
+    /**
+     * Channel preferences.
+     */
+    channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
+
     /**
      * A list of conditions to apply to a channel type.
      */
@@ -68,6 +84,11 @@ export namespace PreferenceSet {
      */
     channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
 
+    /**
+     * Channel preferences.
+     */
+    channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
+
     /**
      * A list of conditions to apply to a channel type.
      */
@@ -75,6 +96,17 @@ export namespace PreferenceSet {
   }
 }
 
+/**
+ * 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 channel type. Currently, this can only be a list of
  * conditions to apply.
@@ -144,6 +176,17 @@ export interface PreferenceSetRequest {
    */
   channel_types?: PreferenceSetChannelTypes | null;
 
+  /**
+   * Channel preferences.
+   */
+  channels?: { [key: string]: boolean | 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,6 +207,11 @@ export namespace PreferenceSetRequest {
      */
     channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
 
+    /**
+     * Channel preferences.
+     */
+    channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
+
     /**
      * A list of conditions to apply to a channel type.
      */
@@ -180,6 +228,11 @@ export namespace PreferenceSetRequest {
      */
     channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
 
+    /**
+     * Channel preferences.
+     */
+    channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
+
     /**
      * A list of conditions to apply to a channel type.
      */
@@ -191,6 +244,7 @@ export declare namespace Preferences {
   export {
     type InlinePreferenceSetRequest as InlinePreferenceSetRequest,
     type PreferenceSet as PreferenceSet,
+    type PreferenceSetChannelSetting as PreferenceSetChannelSetting,
     type PreferenceSetChannelTypeSetting as PreferenceSetChannelTypeSetting,
     type PreferenceSetChannelTypes as PreferenceSetChannelTypes,
     type PreferenceSetRequest as PreferenceSetRequest,

package/src/resources/recipients/recipients.ts

@@ -4,19 +4,23 @@ import { APIResource } from '../../core/resource';
 import * as ObjectsAPI from '../objects/objects';
 import * as ChannelDataAPI from './channel-data';
 import {
+  AwsSnsPushChannelDataDevicesOnly,
+  AwsSnsPushChannelDataTargetArnsOnly,
   ChannelData,
   ChannelDataRequest,
   DiscordChannelData,
   InlineChannelDataRequest,
   MsTeamsChannelData,
-  OneSignalChannelData,
-  PushChannelData,
+  OneSignalChannelDataPlayerIDsOnly,
+  PushChannelDataDevicesOnly,
+  PushChannelDataTokensOnly,
   SlackChannelData,
 } from './channel-data';
 import * as PreferencesAPI from './preferences';
 import {
   InlinePreferenceSetRequest,
   PreferenceSet,
+  PreferenceSetChannelSetting,
   PreferenceSetChannelTypeSetting,
   PreferenceSetChannelTypes,
   PreferenceSetRequest,
@@ -83,6 +87,7 @@ export declare namespace Recipients {
     Preferences as Preferences,
     type InlinePreferenceSetRequest as InlinePreferenceSetRequest,
     type PreferenceSet as PreferenceSet,
+    type PreferenceSetChannelSetting as PreferenceSetChannelSetting,
     type PreferenceSetChannelTypeSetting as PreferenceSetChannelTypeSetting,
     type PreferenceSetChannelTypes as PreferenceSetChannelTypes,
     type PreferenceSetRequest as PreferenceSetRequest,
@@ -90,12 +95,15 @@ export declare namespace Recipients {
 
   export {
     type ChannelData as ChannelData,
+    type AwsSnsPushChannelDataDevicesOnly as AwsSnsPushChannelDataDevicesOnly,
+    type AwsSnsPushChannelDataTargetArnsOnly as AwsSnsPushChannelDataTargetArnsOnly,
     type ChannelDataRequest as ChannelDataRequest,
     type DiscordChannelData as DiscordChannelData,
     type InlineChannelDataRequest as InlineChannelDataRequest,
     type MsTeamsChannelData as MsTeamsChannelData,
-    type OneSignalChannelData as OneSignalChannelData,
-    type PushChannelData as PushChannelData,
+    type OneSignalChannelDataPlayerIDsOnly as OneSignalChannelDataPlayerIDsOnly,
+    type PushChannelDataDevicesOnly as PushChannelDataDevicesOnly,
+    type PushChannelDataTokensOnly as PushChannelDataTokensOnly,
     type SlackChannelData as SlackChannelData,
   };
 }

package/src/resources/tenants/bulk.ts

@@ -29,7 +29,7 @@ export class Bulk extends APIResource {
    * @example
    * ```ts
    * const bulkOperation = await client.tenants.bulk.set({
-   *   tenants: ['[object Object]'],
+   *   tenants: [{ id: 'tenant_1', name: 'Acme Corp, Inc.' }],
    * });
    * ```
    */

package/src/resources/tenants/tenants.ts

@@ -66,6 +66,7 @@ export class Tenants extends APIResource {
    * @example
    * ```ts
    * const tenant = await client.tenants.set('id', {
+   *   name: 'Jurassic Park',
    *   settings: {
    *     branding: {
    *       icon_url:
@@ -179,6 +180,11 @@ export interface TenantRequest {
    */
   channel_data?: ChannelDataAPI.InlineChannelDataRequest | null;
 
+  /**
+   * An optional name for the tenant.
+   */
+  name?: string | null;
+
   /**
    * Inline set preferences for a recipient, where the key is the preference set id.
    * Preferences that are set inline will be merged into any existing preferences
@@ -258,6 +264,11 @@ export interface TenantSetParams {
    */
   channel_data?: ChannelDataAPI.InlineChannelDataRequest | null;
 
+  /**
+   * An optional name for the tenant.
+   */
+  name?: string | null;
+
   /**
    * The settings for the tenant. Includes branding and preference set.
    */

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/feeds.ts

@@ -291,6 +291,14 @@ export interface FeedListItemsParams extends EntriesCursorParams {
    */
   has_tenant?: boolean;
 
+  /**
+   * The locale to render the feed items in. Must be in the IETF 5646 format (e.g.
+   * `en-US`). When not provided, will default to the locale that the feed items were
+   * rendered in. Only available for enterprise plan customers using custom
+   * translations.
+   */
+  locale?: string;
+
   /**
    * The workflow key associated with the message in the feed.
    */