@knocklabs/node 1.10.3 → 1.11.1

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

@@ -96,13 +96,17 @@ export namespace DiscordChannelData {
 /**
  * A request to set channel data for a type of channel inline.
  */
-export type InlineChannelDataRequest = Record<
-  string,
-  PushChannelData | OneSignalChannelData | SlackChannelData | MsTeamsChannelData | DiscordChannelData
->;
+export type InlineChannelDataRequest = {
+  [key: string]:
+    | PushChannelData
+    | OneSignalChannelData
+    | SlackChannelData
+    | MsTeamsChannelData
+    | DiscordChannelData;
+};
 
 /**
- * Microsoft Teams channel connection.
+ * Microsoft Teams channel data.
  */
 export interface MsTeamsChannelData {
   /**
@@ -178,7 +182,7 @@ export interface OneSignalChannelData {
 }
 
 /**
- * The content of a push notification.
+ * Push channel data.
  */
 export interface PushChannelData {
   /**
@@ -188,7 +192,7 @@ export interface PushChannelData {
 }
 
 /**
- * Slack channel data
+ * Slack channel data.
  */
 export interface SlackChannelData {
   /**

package/src/resources/recipients/preferences.ts

@@ -11,7 +11,7 @@ export class Preferences extends APIResource {}
  * Preferences that are set inline will be merged into any existing preferences
  * rather than replacing them.
  */
-export type InlinePreferenceSetRequest = Record<string, PreferenceSetRequest>;
+export type InlinePreferenceSetRequest = { [key: string]: PreferenceSetRequest };
 
 /**
  * A preference set represents a specific set of notification preferences for a
@@ -27,7 +27,7 @@ export interface PreferenceSet {
    * An object where the key is the category and the values are the preference
    * settings for that category.
    */
-  categories?: Record<string, boolean | PreferenceSet.PreferenceSetWorkflowCategorySettingObject> | null;
+  categories?: { [key: string]: boolean | PreferenceSet.PreferenceSetWorkflowCategorySettingObject } | null;
 
   /**
    * Channel type preferences.
@@ -38,7 +38,7 @@ export interface PreferenceSet {
    * An object where the key is the workflow key and the values are the preference
    * settings for that workflow.
    */
-  workflows?: Record<string, boolean | PreferenceSet.PreferenceSetWorkflowCategorySettingObject> | null;
+  workflows?: { [key: string]: boolean | PreferenceSet.PreferenceSetWorkflowCategorySettingObject } | null;
 }
 
 export namespace PreferenceSet {
@@ -129,10 +129,9 @@ export interface PreferenceSetRequest {
    * An object where the key is the category and the values are the preference
    * settings for that category.
    */
-  categories?: Record<
-    string,
-    boolean | PreferenceSetRequest.PreferenceSetWorkflowCategorySettingObject
-  > | null;
+  categories?: {
+    [key: string]: boolean | PreferenceSetRequest.PreferenceSetWorkflowCategorySettingObject;
+  } | null;
 
   /**
    * Channel type preferences.
@@ -143,10 +142,9 @@ export interface PreferenceSetRequest {
    * An object where the key is the workflow key and the values are the preference
    * settings for that workflow.
    */
-  workflows?: Record<
-    string,
-    boolean | PreferenceSetRequest.PreferenceSetWorkflowCategorySettingObject
-  > | null;
+  workflows?: {
+    [key: string]: boolean | PreferenceSetRequest.PreferenceSetWorkflowCategorySettingObject;
+  } | null;
 }
 
 export namespace PreferenceSetRequest {

package/src/resources/recipients/subscriptions.ts

@@ -41,7 +41,7 @@ export interface Subscription {
   /**
    * The custom properties associated with the subscription relationship.
    */
-  properties?: Record<string, unknown> | null;
+  properties?: { [key: string]: unknown } | null;
 }
 
 export declare namespace Subscriptions {

package/src/resources/schedules/bulk.ts

@@ -74,12 +74,12 @@ export namespace BulkCreateParams {
     actor?: RecipientsAPI.RecipientRequest | null;
 
     /**
-     * An optional map of data to pass into the workflow execution. There is a 1024
-     * byte limit on the size of any single string value (with the exception of
-     * [email attachments](/integrations/email/attachments)), and a 10MB limit on the
-     * size of the full `data` payload.
+     * An optional map of data to pass into the workflow execution. There is a 10MB
+     * limit on the size of the full `data` payload. Any individual string value
+     * greater than 1024 bytes in length will be
+     * [truncated](/developer-tools/api-logs#log-truncation) in your logs.
      */
-    data?: Record<string, unknown> | null;
+    data?: { [key: string]: unknown } | null;
 
     /**
      * The ending date and time for the schedule.

package/src/resources/schedules/schedules.ts

@@ -172,12 +172,12 @@ export interface Schedule {
   actor?: RecipientsAPI.Recipient | null;
 
   /**
-   * An optional map of data to pass into the workflow execution. There is a 1024
-   * byte limit on the size of any single string value (with the exception of
-   * [email attachments](/integrations/email/attachments)), and a 10MB limit on the
-   * size of the full `data` payload.
+   * An optional map of data to pass into the workflow execution. There is a 10MB
+   * limit on the size of the full `data` payload. Any individual string value
+   * greater than 1024 bytes in length will be
+   * [truncated](/developer-tools/api-logs#log-truncation) in your logs.
    */
-  data?: Record<string, unknown> | null;
+  data?: { [key: string]: unknown } | null;
 
   /**
    * The last occurrence of the schedule.
@@ -271,12 +271,12 @@ export interface ScheduleCreateParams {
   actor?: RecipientsAPI.RecipientRequest | null;
 
   /**
-   * An optional map of data to pass into the workflow execution. There is a 1024
-   * byte limit on the size of any single string value (with the exception of
-   * [email attachments](/integrations/email/attachments)), and a 10MB limit on the
-   * size of the full `data` payload.
+   * An optional map of data to pass into the workflow execution. There is a 10MB
+   * limit on the size of the full `data` payload. Any individual string value
+   * greater than 1024 bytes in length will be
+   * [truncated](/developer-tools/api-logs#log-truncation) in your logs.
    */
-  data?: Record<string, unknown> | null;
+  data?: { [key: string]: unknown } | null;
 
   /**
    * The ending date and time for the schedule.
@@ -312,12 +312,12 @@ export interface ScheduleUpdateParams {
   actor?: RecipientsAPI.RecipientReference | null;
 
   /**
-   * An optional map of data to pass into the workflow execution. There is a 1024
-   * byte limit on the size of any single string value (with the exception of
-   * [email attachments](/integrations/email/attachments)), and a 10MB limit on the
-   * size of the full `data` payload.
+   * An optional map of data to pass into the workflow execution. There is a 10MB
+   * limit on the size of the full `data` payload. Any individual string value
+   * greater than 1024 bytes in length will be
+   * [truncated](/developer-tools/api-logs#log-truncation) in your logs.
    */
-  data?: Record<string, unknown> | null;
+  data?: { [key: string]: unknown } | null;
 
   /**
    * The ending date and time for the schedule.

package/src/resources/shared.ts

@@ -52,7 +52,7 @@ export interface PageInfo {
   __typename: string;
 
   /**
-   * The number of items per page.
+   * The number of items per page (defaults to 50).
    */
   page_size: number;
 

package/src/resources/users/feeds.ts

@@ -25,8 +25,20 @@ export class Feeds extends APIResource {
   }
 
   /**
-   * Returns a paginated list of feed items for a user, including metadata about the
-   * feed.
+   * Returns a paginated list of feed items for a user in reverse chronological
+   * order, including metadata about the feed. If the user has not yet been
+   * identified within Knock, an empty feed will be returned.
+   *
+   * You can customize the response using
+   * [response filters](/integrations/in-app/knock#customizing-api-response-content)
+   * to exclude or only include specific properties on your resources.
+   *
+   * **Notes:**
+   *
+   * - When making this call from a client-side environment, use your publishable key
+   *   along with a user token.
+   * - This endpoint’s rate limit is always scoped per-user and per-environment. This
+   *   is true even for requests made without a signed user token.
    *
    * @example
    * ```ts
@@ -111,7 +123,7 @@ export interface FeedListItemsResponse {
   /**
    * Additional data associated with the feed item.
    */
-  data: Record<string, unknown> | null;
+  data: { [key: string]: unknown } | null;
 
   /**
    * Timestamp when the resource was created.
@@ -280,7 +292,7 @@ export interface FeedListItemsParams extends EntriesCursorParams {
   has_tenant?: boolean;
 
   /**
-   * The source of the feed items.
+   * The workflow key associated with the message in the feed.
    */
   source?: string;
 

package/src/resources/users/guides.ts

@@ -165,7 +165,7 @@ export namespace GuideGetChannelResponse {
     /**
      * The metadata of the guide.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
 
     /**
      * The title of the guide.
@@ -255,12 +255,12 @@ export interface GuideMarkMessageAsArchivedParams {
   /**
    * The content of the guide.
    */
-  content?: Record<string, unknown>;
+  content?: { [key: string]: unknown };
 
   /**
    * The data of the guide.
    */
-  data?: Record<string, unknown>;
+  data?: { [key: string]: unknown };
 
   /**
    * Whether the guide is final.
@@ -270,7 +270,7 @@ export interface GuideMarkMessageAsArchivedParams {
   /**
    * The metadata of the guide.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * The tenant ID of the guide.
@@ -302,12 +302,12 @@ export interface GuideMarkMessageAsInteractedParams {
   /**
    * The content of the guide.
    */
-  content?: Record<string, unknown>;
+  content?: { [key: string]: unknown };
 
   /**
    * The data of the guide.
    */
-  data?: Record<string, unknown>;
+  data?: { [key: string]: unknown };
 
   /**
    * Whether the guide is final.
@@ -317,7 +317,7 @@ export interface GuideMarkMessageAsInteractedParams {
   /**
    * The metadata of the guide.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * The tenant ID of the guide.
@@ -349,12 +349,12 @@ export interface GuideMarkMessageAsSeenParams {
   /**
    * The content of the guide.
    */
-  content?: Record<string, unknown>;
+  content?: { [key: string]: unknown };
 
   /**
    * The data of the guide.
    */
-  data?: Record<string, unknown>;
+  data?: { [key: string]: unknown };
 
   /**
    * Whether the guide is final.
@@ -364,7 +364,7 @@ export interface GuideMarkMessageAsSeenParams {
   /**
    * The metadata of the guide.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * The tenant ID of the guide.

package/src/resources/users/users.ts

@@ -166,9 +166,9 @@ export class Users extends APIResource {
   }
 
   /**
-   * Returns a paginated list of messages for a specific user. Allows filtering by
-   * message status and provides various sorting options. Messages outside the
-   * account's retention window will not be included in the results.
+   * Returns a paginated list of messages for a specific user. Messages are sorted
+   * with the most recent ones appearing first. Messages outside the account's
+   * retention window will not be included in the results.
    *
    * @example
    * ```ts
@@ -352,7 +352,7 @@ export type UsersEntriesCursor = EntriesCursor<User>;
  */
 export interface IdentifyUserRequest {
   /**
-   * URL to the user's avatar image.
+   * A URL for the avatar of the user.
    */
   avatar?: string | null;
 
@@ -413,12 +413,12 @@ export interface IdentifyUserRequest {
  */
 export interface InlineIdentifyUserRequest {
   /**
-   * The ID for the user that you set when identifying them in Knock.
+   * The unique identifier of the user.
    */
   id: string;
 
   /**
-   * URL to the user's avatar image.
+   * A URL for the avatar of the user.
    */
   avatar?: string | null;
 
@@ -478,7 +478,7 @@ export interface InlineIdentifyUserRequest {
  */
 export interface User {
   /**
-   * The ID for the user that you set when identifying them in Knock.
+   * The unique identifier of the user.
    */
   id: string;
 
@@ -493,7 +493,7 @@ export interface User {
   updated_at: string;
 
   /**
-   * URL to the user's avatar image.
+   * A URL for the avatar of the user.
    */
   avatar?: string | null;
 
@@ -546,7 +546,7 @@ export type UserUnsetChannelDataResponse = string;
 
 export interface UserUpdateParams {
   /**
-   * URL to the user's avatar image.
+   * A URL for the avatar of the user.
    */
   avatar?: string | null;
 
@@ -747,10 +747,9 @@ export interface UserSetPreferencesParams {
    * An object where the key is the category and the values are the preference
    * settings for that category.
    */
-  categories?: Record<
-    string,
-    boolean | UserSetPreferencesParams.PreferenceSetWorkflowCategorySettingObject
-  > | null;
+  categories?: {
+    [key: string]: boolean | UserSetPreferencesParams.PreferenceSetWorkflowCategorySettingObject;
+  } | null;
 
   /**
    * Channel type preferences.
@@ -761,10 +760,9 @@ export interface UserSetPreferencesParams {
    * An object where the key is the workflow key and the values are the preference
    * settings for that workflow.
    */
-  workflows?: Record<
-    string,
-    boolean | UserSetPreferencesParams.PreferenceSetWorkflowCategorySettingObject
-  > | null;
+  workflows?: {
+    [key: string]: boolean | UserSetPreferencesParams.PreferenceSetWorkflowCategorySettingObject;
+  } | null;
 }
 
 export namespace UserSetPreferencesParams {

package/src/resources/workflows.ts

@@ -120,12 +120,12 @@ export interface WorkflowTriggerParams {
   cancellation_key?: string | null;
 
   /**
-   * An optional map of data to pass into the workflow execution. There is a 1024
-   * byte limit on the size of any single string value (with the exception of
-   * [email attachments](/integrations/email/attachments)), and a 10MB limit on the
-   * size of the full `data` payload.
+   * An optional map of data to pass into the workflow execution. There is a 10MB
+   * limit on the size of the full `data` payload. Any individual string value
+   * greater than 1024 bytes in length will be
+   * [truncated](/developer-tools/api-logs#log-truncation) in your logs.
    */
-  data?: Record<string, unknown> | null;
+  data?: { [key: string]: unknown } | null;
 
   /**
    * An request to set a tenant inline.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.10.3'; // x-release-please-version
+export const VERSION = '1.11.1'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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