@knocklabs/node 1.33.0 → 1.35.0

package/src/resources/users/preference-center.ts

@@ -0,0 +1,224 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as PreferenceCenterAPI from './preference-center';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * The preference center is a hosted page where users can manage their notification preferences.
+ */
+export class PreferenceCenter extends APIResource {
+  /**
+   * Generates a signed preference center URL and token for the given user in the
+   * current environment.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.users.preferenceCenter.generateSignedURL(
+   *     'user_id',
+   *   );
+   * ```
+   */
+  generateSignedURL(
+    userID: string,
+    options?: RequestOptions,
+  ): APIPromise<PreferenceCenterGenerateSignedURLResponse> {
+    return this._client.post(path`/v1/users/${userID}/preference_center/signed_url`, options);
+  }
+
+  /**
+   * Returns the preference center config with environment metadata for the given
+   * user.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.users.preferenceCenter.getConfig('user_id');
+   * ```
+   */
+  getConfig(userID: string, options?: RequestOptions): APIPromise<PreferenceCenterGetConfigResponse> {
+    return this._client.get(path`/v1/users/${userID}/preference_center/config`, options);
+  }
+}
+
+/**
+ * The branding for the preference center, sourced from public environment
+ * variables.
+ */
+export interface PreferenceCenterBrandingConfig {
+  /**
+   * The icon URL for the preference center. Must point to a valid image with an
+   * image MIME type.
+   */
+  icon_url?: string | null;
+
+  /**
+   * The logo URL for the preference center. Must point to a valid image with an
+   * image MIME type.
+   */
+  logo_url?: string | null;
+
+  /**
+   * The primary color for the preference center, provided as a hex value.
+   */
+  primary_color?: string | null;
+
+  /**
+   * The primary color contrast for the preference center, provided as a hex value.
+   */
+  primary_color_contrast?: string | null;
+}
+
+/**
+ * A signed preference center URL and token for a user.
+ */
+export interface PreferenceCenterGenerateSignedURLResponse {
+  /**
+   * The signed JWT token for the preference center, usable as the `/p/{token}` path
+   * segment.
+   */
+  token: string;
+
+  /**
+   * The full URL to the preference center for the user.
+   */
+  url: string;
+}
+
+/**
+ * The preference center configuration for an environment. Controls whether the
+ * preference center is enabled and defines the rows displayed in the UI.
+ */
+export interface PreferenceCenterGetConfigResponse {
+  /**
+   * The name of the account that the preference center is associated with.
+   */
+  account_name: string | null;
+
+  /**
+   * The branding for the preference center, sourced from public environment
+   * variables.
+   */
+  branding: PreferenceCenterGetConfigResponse.Branding;
+
+  /**
+   * The preference center configuration data containing the rows to display.
+   */
+  config: PreferenceCenterGetConfigResponse.Config;
+
+  /**
+   * Whether the preference center is enabled for this environment.
+   */
+  enabled: boolean;
+
+  /**
+   * A display label for the user that the preference center is associated with,
+   * resolved as email, then user id.
+   */
+  user_email: string | null;
+
+  /**
+   * Whether Knock branding is required in the preference center.
+   */
+  knock_branding_required?: boolean;
+}
+
+export namespace PreferenceCenterGetConfigResponse {
+  /**
+   * The branding for the preference center, sourced from public environment
+   * variables.
+   */
+  export interface Branding extends PreferenceCenterAPI.PreferenceCenterBrandingConfig {
+    /**
+     * The branding for the preference center, sourced from public environment
+     * variables.
+     */
+    dark?: PreferenceCenterAPI.PreferenceCenterBrandingConfig;
+  }
+
+  /**
+   * The preference center configuration data containing the rows to display.
+   */
+  export interface Config {
+    /**
+     * The body text displayed below the title.
+     */
+    body: string;
+
+    /**
+     * An ordered list of rows to display in the preference center.
+     */
+    rows: Array<Config.Row>;
+
+    /**
+     * The title displayed at the top of the preference center.
+     */
+    title: string;
+
+    /**
+     * Whether the account name should be displayed in the preference center.
+     */
+    show_account_name?: boolean;
+  }
+
+  export namespace Config {
+    /**
+     * A preference row in the preference center configuration.
+     */
+    export interface Row {
+      /**
+       * The display name of the preference row.
+       */
+      name: string;
+
+      /**
+       * The type of this preference row. `workflow` targets a workflow, `channel`
+       * targets a specific channel, `category` targets a workflow category,
+       * `channel_types` controls per-channel-type opt-in/out, and
+       * `commercial_subscribed` is the commercial notification toggle.
+       */
+      type: 'workflow' | 'channel' | 'category' | 'channel_types' | 'commercial_subscribed';
+
+      /**
+       * The list of channel types this preference is scoped to. An empty list (or
+       * `null`) means the preference applies to all channel types. Present for
+       * `workflow`, `category`, and `channel_types` types.
+       */
+      channel_types?: Array<
+        | 'email'
+        | 'in_app'
+        | 'in_app_feed'
+        | 'in_app_guide'
+        | 'sms'
+        | 'push'
+        | 'chat'
+        | 'http'
+        | 'log'
+        | 'deferred_log'
+      > | null;
+
+      /**
+       * A description shown below the preference row name.
+       */
+      description?: string;
+
+      /**
+       * The category name, workflow key, or channel ID this row controls (e.g.
+       * `marketing`, `new-project-mentions`, or a channel UUID). Present for `workflow`,
+       * `channel`, and `category` types.
+       */
+      identifier?: string | null;
+    }
+  }
+}
+
+export declare namespace PreferenceCenter {
+  export {
+    type PreferenceCenterBrandingConfig as PreferenceCenterBrandingConfig,
+    type PreferenceCenterGenerateSignedURLResponse as PreferenceCenterGenerateSignedURLResponse,
+    type PreferenceCenterGetConfigResponse as PreferenceCenterGetConfigResponse,
+  };
+}

package/src/resources/users/users.ts

@@ -23,16 +23,26 @@ import {
 } from './feeds';
 import * as GuidesAPI from './guides';
 import {
+  GuideActionResponse,
+  GuideArchivedRequest,
   GuideGetChannelParams,
   GuideGetChannelResponse,
+  GuideInteractedRequest,
   GuideMarkMessageAsArchivedParams,
-  GuideMarkMessageAsArchivedResponse,
   GuideMarkMessageAsInteractedParams,
-  GuideMarkMessageAsInteractedResponse,
   GuideMarkMessageAsSeenParams,
-  GuideMarkMessageAsSeenResponse,
+  GuideResetGuideEngagementsParams,
+  GuideSeenRequest,
+  GuideUnarchiveGuideMessageParams,
   Guides,
 } from './guides';
+import * as PreferenceCenterAPI from './preference-center';
+import {
+  PreferenceCenter,
+  PreferenceCenterBrandingConfig,
+  PreferenceCenterGenerateSignedURLResponse,
+  PreferenceCenterGetConfigResponse,
+} from './preference-center';
 import { APIPromise } from '../../core/api-promise';
 import {
   EntriesCursor,
@@ -52,6 +62,9 @@ export class Users extends APIResource {
   feeds: FeedsAPI.Feeds = new FeedsAPI.Feeds(this._client);
   guides: GuidesAPI.Guides = new GuidesAPI.Guides(this._client);
   bulk: BulkAPI.Bulk = new BulkAPI.Bulk(this._client);
+  preferenceCenter: PreferenceCenterAPI.PreferenceCenter = new PreferenceCenterAPI.PreferenceCenter(
+    this._client,
+  );
 
   /**
    * Create or update a user with the provided identification data. When you identify
@@ -512,6 +525,47 @@ export interface InlineIdentifyUserRequest {
   [k: string]: unknown;
 }
 
+/**
+ * A response containing a list of schedules.
+ */
+export interface ListSchedulesResponse {
+  /**
+   * A list of schedules.
+   */
+  entries: Array<SchedulesAPI.Schedule>;
+
+  /**
+   * Pagination information for a list of resources.
+   */
+  page_info: Shared.PageInfo;
+}
+
+/**
+ * A response containing a list of subscriptions.
+ */
+export interface ListSubscriptionsResponse {
+  /**
+   * A list of subscriptions.
+   */
+  entries: Array<SubscriptionsAPI.Subscription>;
+
+  /**
+   * Pagination information for a list of resources.
+   */
+  page_info: Shared.PageInfo;
+}
+
+/**
+ * A set of settings for the commercial subscribed preference. Currently, this can
+ * only be a list of conditions to apply.
+ */
+export interface PreferenceSetCommercialSubscribedSetting {
+  /**
+   * A list of conditions to apply to the commercial subscribed preference.
+   */
+  conditions: Array<Shared.Condition>;
+}
+
 /**
  * A [User](/concepts/users) represents an individual in your system who can
  * receive notifications through Knock. Users are the most common recipients of
@@ -803,9 +857,11 @@ export interface UserSetPreferencesParams {
 
   /**
    * Whether the recipient is subscribed to commercial communications. When false,
-   * the recipient will not receive commercial workflow notifications.
+   * the recipient will not receive commercial workflow notifications. Can also be
+   * set to a settings object with conditions that are evaluated at notification send
+   * time.
    */
-  commercial_subscribed?: boolean | null;
+  commercial_subscribed?: boolean | PreferenceSetCommercialSubscribedSetting | null;
 
   /**
    * An object where the key is the workflow key and the values are the preference
@@ -863,11 +919,15 @@ export namespace UserSetPreferencesParams {
 Users.Feeds = Feeds;
 Users.Guides = Guides;
 Users.Bulk = Bulk;
+Users.PreferenceCenter = PreferenceCenter;
 
 export declare namespace Users {
   export {
     type IdentifyUserRequest as IdentifyUserRequest,
     type InlineIdentifyUserRequest as InlineIdentifyUserRequest,
+    type ListSchedulesResponse as ListSchedulesResponse,
+    type ListSubscriptionsResponse as ListSubscriptionsResponse,
+    type PreferenceSetCommercialSubscribedSetting as PreferenceSetCommercialSubscribedSetting,
     type User as User,
     type UserListPreferencesResponse as UserListPreferencesResponse,
     type UsersEntriesCursor as UsersEntriesCursor,
@@ -892,14 +952,17 @@ export declare namespace Users {
 
   export {
     Guides as Guides,
+    type GuideActionResponse as GuideActionResponse,
+    type GuideArchivedRequest as GuideArchivedRequest,
+    type GuideInteractedRequest as GuideInteractedRequest,
+    type GuideSeenRequest as GuideSeenRequest,
     type GuideGetChannelResponse as GuideGetChannelResponse,
-    type GuideMarkMessageAsArchivedResponse as GuideMarkMessageAsArchivedResponse,
-    type GuideMarkMessageAsInteractedResponse as GuideMarkMessageAsInteractedResponse,
-    type GuideMarkMessageAsSeenResponse as GuideMarkMessageAsSeenResponse,
     type GuideGetChannelParams as GuideGetChannelParams,
     type GuideMarkMessageAsArchivedParams as GuideMarkMessageAsArchivedParams,
     type GuideMarkMessageAsInteractedParams as GuideMarkMessageAsInteractedParams,
     type GuideMarkMessageAsSeenParams as GuideMarkMessageAsSeenParams,
+    type GuideResetGuideEngagementsParams as GuideResetGuideEngagementsParams,
+    type GuideUnarchiveGuideMessageParams as GuideUnarchiveGuideMessageParams,
   };
 
   export {
@@ -908,6 +971,13 @@ export declare namespace Users {
     type BulkIdentifyParams as BulkIdentifyParams,
     type BulkSetPreferencesParams as BulkSetPreferencesParams,
   };
+
+  export {
+    PreferenceCenter as PreferenceCenter,
+    type PreferenceCenterBrandingConfig as PreferenceCenterBrandingConfig,
+    type PreferenceCenterGenerateSignedURLResponse as PreferenceCenterGenerateSignedURLResponse,
+    type PreferenceCenterGetConfigResponse as PreferenceCenterGetConfigResponse,
+  };
 }
 
 export { type MessagesItemsCursor, type SchedulesEntriesCursor, type SubscriptionsEntriesCursor };

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.33.0'; // x-release-please-version
+export const VERSION = '1.35.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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