@knocklabs/node 1.21.0 → 1.22.1

package/src/resources/objects/objects.ts

@@ -298,6 +298,7 @@ export class Objects extends APIResource {
    *       },
    *     },
    *     locale: 'en-US',
+   *     name: 'My product',
    *     preferences: {
    *       default: {
    *         channel_types: { email: true },
@@ -444,6 +445,11 @@ export interface InlineObjectRequest {
    */
   created_at?: string | null;
 
+  /**
+   * An optional name for the object.
+   */
+  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
@@ -683,6 +689,11 @@ export interface ObjectSetParams {
    */
   locale?: string | null;
 
+  /**
+   * An optional name for the object.
+   */
+  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
@@ -706,47 +717,16 @@ export interface ObjectSetChannelDataParams {
    * Channel data for a given channel type.
    */
   data:
-    | ObjectSetChannelDataParams.PushChannelDataTokensOnly
-    | ObjectSetChannelDataParams.AwssnsPushChannelDataTargetArNsOnly
-    | ObjectSetChannelDataParams.OneSignalChannelDataPlayerIDsOnly
+    | ChannelDataAPI.PushChannelDataTokensOnly
+    | ChannelDataAPI.PushChannelDataDevicesOnly
+    | ChannelDataAPI.AwsSnsPushChannelDataTargetArnsOnly
+    | ChannelDataAPI.AwsSnsPushChannelDataDevicesOnly
+    | ChannelDataAPI.OneSignalChannelDataPlayerIDsOnly
     | ChannelDataAPI.SlackChannelData
     | ChannelDataAPI.MsTeamsChannelData
     | ChannelDataAPI.DiscordChannelData;
 }
 
-export namespace ObjectSetChannelDataParams {
-  /**
-   * Push channel data.
-   */
-  export interface PushChannelDataTokensOnly {
-    /**
-     * A list of push channel tokens.
-     */
-    tokens: Array<string>;
-  }
-
-  /**
-   * 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>;
-  }
-
-  /**
-   * OneSignal channel data.
-   */
-  export interface OneSignalChannelDataPlayerIDsOnly {
-    /**
-     * A list of OneSignal player IDs.
-     */
-    player_ids: Array<string>;
-  }
-}
-
 export interface ObjectSetPreferencesParams {
   /**
    * Controls how the preference set is persisted. 'replace' will completely replace
@@ -770,7 +750,7 @@ export interface ObjectSetPreferencesParams {
   /**
    * Channel preferences.
    */
-  channels?: { [key: string]: boolean | ObjectSetPreferencesParams.PreferenceSetChannelSetting } | null;
+  channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
 
   /**
    * Whether the recipient is subscribed to commercial communications. When false,
@@ -801,9 +781,7 @@ export namespace ObjectSetPreferencesParams {
     /**
      * Channel preferences.
      */
-    channels?: {
-      [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
-    } | null;
+    channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
 
     /**
      * A list of conditions to apply to a channel type.
@@ -811,30 +789,6 @@ export namespace ObjectSetPreferencesParams {
     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>;
-  }
-
   /**
    * The settings object for a workflow or category, where you can specify channel
    * types or conditions.
@@ -848,28 +802,13 @@ export namespace ObjectSetPreferencesParams {
     /**
      * Channel preferences.
      */
-    channels?: {
-      [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
-    } | null;
+    channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
 
     /**
      * A list of conditions to apply to a channel type.
      */
     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>;
-    }
-  }
 }
 
 Objects.Bulk = Bulk;

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.
  */
@@ -24,7 +71,7 @@ export interface ChannelData {
   data:
     | ChannelData.PushChannelDataFull
     | ChannelData.AwssnsPushChannelDataFull
-    | ChannelData.OneSignalChannelDataPlayerIDsOnly
+    | OneSignalChannelDataPlayerIDsOnly
     | SlackChannelData
     | MsTeamsChannelData
     | DiscordChannelData;
@@ -125,16 +172,6 @@ export namespace ChannelData {
       timezone?: string | null;
     }
   }
-
-  /**
-   * OneSignal channel data.
-   */
-  export interface OneSignalChannelDataPlayerIDsOnly {
-    /**
-     * A list of OneSignal player IDs.
-     */
-    player_ids: Array<string>;
-  }
 }
 
 /**
@@ -145,47 +182,16 @@ export interface ChannelDataRequest {
    * Channel data for a given channel type.
    */
   data:
-    | ChannelDataRequest.PushChannelDataTokensOnly
-    | ChannelDataRequest.AwssnsPushChannelDataTargetArNsOnly
-    | ChannelDataRequest.OneSignalChannelDataPlayerIDsOnly
+    | PushChannelDataTokensOnly
+    | PushChannelDataDevicesOnly
+    | AwsSnsPushChannelDataTargetArnsOnly
+    | AwsSnsPushChannelDataDevicesOnly
+    | OneSignalChannelDataPlayerIDsOnly
     | SlackChannelData
     | MsTeamsChannelData
     | DiscordChannelData;
 }
 
-export namespace ChannelDataRequest {
-  /**
-   * Push channel data.
-   */
-  export interface PushChannelDataTokensOnly {
-    /**
-     * A list of push channel tokens.
-     */
-    tokens: Array<string>;
-  }
-
-  /**
-   * 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>;
-  }
-
-  /**
-   * OneSignal channel data.
-   */
-  export interface OneSignalChannelDataPlayerIDsOnly {
-    /**
-     * A list of OneSignal player IDs.
-     */
-    player_ids: Array<string>;
-  }
-}
-
 /**
  * Discord channel data.
  */
@@ -237,47 +243,16 @@ export namespace DiscordChannelData {
  */
 export type InlineChannelDataRequest = {
   [key: string]:
-    | InlineChannelDataRequest.PushChannelDataTokensOnly
-    | InlineChannelDataRequest.AwssnsPushChannelDataTargetArNsOnly
-    | InlineChannelDataRequest.OneSignalChannelDataPlayerIDsOnly
+    | PushChannelDataTokensOnly
+    | PushChannelDataDevicesOnly
+    | AwsSnsPushChannelDataTargetArnsOnly
+    | AwsSnsPushChannelDataDevicesOnly
+    | OneSignalChannelDataPlayerIDsOnly
     | SlackChannelData
     | MsTeamsChannelData
     | DiscordChannelData;
 };
 
-export namespace InlineChannelDataRequest {
-  /**
-   * Push channel data.
-   */
-  export interface PushChannelDataTokensOnly {
-    /**
-     * A list of push channel tokens.
-     */
-    tokens: Array<string>;
-  }
-
-  /**
-   * 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>;
-  }
-
-  /**
-   * OneSignal channel data.
-   */
-  export interface OneSignalChannelDataPlayerIDsOnly {
-    /**
-     * A list of OneSignal player IDs.
-     */
-    player_ids: Array<string>;
-  }
-}
-
 /**
  * Microsoft Teams channel data.
  */
@@ -344,6 +319,60 @@ export namespace MsTeamsChannelData {
   }
 }
 
+/**
+ * OneSignal channel data.
+ */
+export interface OneSignalChannelDataPlayerIDsOnly {
+  /**
+   * A list of OneSignal player IDs.
+   */
+  player_ids: Array<string>;
+}
+
+/**
+ * Push channel data.
+ */
+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.
+   */
+  tokens: Array<string>;
+}
+
 /**
  * Slack channel data.
  */
@@ -403,11 +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 OneSignalChannelDataPlayerIDsOnly as OneSignalChannelDataPlayerIDsOnly,
+    type PushChannelDataDevicesOnly as PushChannelDataDevicesOnly,
+    type PushChannelDataTokensOnly as PushChannelDataTokensOnly,
     type SlackChannelData as SlackChannelData,
   };
 }

package/src/resources/recipients/index.ts

@@ -2,16 +2,22 @@
 
 export {
   ChannelData,
+  type AwsSnsPushChannelDataDevicesOnly,
+  type AwsSnsPushChannelDataTargetArnsOnly,
   type ChannelDataRequest,
   type DiscordChannelData,
   type InlineChannelDataRequest,
   type MsTeamsChannelData,
+  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

@@ -37,7 +37,7 @@ export interface PreferenceSet {
   /**
    * Channel preferences.
    */
-  channels?: { [key: string]: boolean | PreferenceSet.PreferenceSetChannelSetting } | null;
+  channels?: { [key: string]: boolean | PreferenceSetChannelSetting } | null;
 
   /**
    * Whether the recipient is subscribed to commercial communications. When false,
@@ -66,9 +66,7 @@ export namespace PreferenceSet {
     /**
      * Channel preferences.
      */
-    channels?: {
-      [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
-    } | null;
+    channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
 
     /**
      * A list of conditions to apply to a channel type.
@@ -76,30 +74,6 @@ export namespace PreferenceSet {
     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>;
-  }
-
   /**
    * The settings object for a workflow or category, where you can specify channel
    * types or conditions.
@@ -113,28 +87,24 @@ export namespace PreferenceSet {
     /**
      * Channel preferences.
      */
-    channels?: {
-      [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
-    } | null;
+    channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
 
     /**
      * A list of conditions to apply to a channel type.
      */
     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>;
 }
 
 /**
@@ -209,7 +179,7 @@ export interface PreferenceSetRequest {
   /**
    * Channel preferences.
    */
-  channels?: { [key: string]: boolean | PreferenceSetRequest.PreferenceSetChannelSetting } | null;
+  channels?: { [key: string]: boolean | PreferenceSetChannelSetting } | null;
 
   /**
    * Whether the recipient is subscribed to commercial communications. When false,
@@ -240,9 +210,7 @@ export namespace PreferenceSetRequest {
     /**
      * Channel preferences.
      */
-    channels?: {
-      [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
-    } | null;
+    channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
 
     /**
      * A list of conditions to apply to a channel type.
@@ -250,30 +218,6 @@ export namespace PreferenceSetRequest {
     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>;
-  }
-
   /**
    * The settings object for a workflow or category, where you can specify channel
    * types or conditions.
@@ -287,34 +231,20 @@ export namespace PreferenceSetRequest {
     /**
      * Channel preferences.
      */
-    channels?: {
-      [key: string]: boolean | PreferenceSetWorkflowCategorySettingObject.PreferenceSetChannelSetting;
-    } | null;
+    channels?: { [key: string]: boolean | PreferencesAPI.PreferenceSetChannelSetting } | null;
 
     /**
      * A list of conditions to apply to a channel type.
      */
     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>;
-    }
-  }
 }
 
 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,17 +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,
+  OneSignalChannelDataPlayerIDsOnly,
+  PushChannelDataDevicesOnly,
+  PushChannelDataTokensOnly,
   SlackChannelData,
 } from './channel-data';
 import * as PreferencesAPI from './preferences';
 import {
   InlinePreferenceSetRequest,
   PreferenceSet,
+  PreferenceSetChannelSetting,
   PreferenceSetChannelTypeSetting,
   PreferenceSetChannelTypes,
   PreferenceSetRequest,
@@ -81,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,
@@ -88,10 +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 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.' }],
    * });
    * ```
    */