feat: add support for tenant preference overlays

src/knock.ts

@@ -19,7 +19,6 @@ import {
   MethodOptions,
 } from "./common/interfaces";
 import { Users } from "./resources/users";
-import { Preferences } from "./resources/preferences";
 import { Workflows } from "./resources/workflows";
 import { TriggerWorkflowProperties } from "./resources/workflows/interfaces";
 import { BulkOperations } from "./resources/bulk_operations";
@@ -35,7 +34,6 @@ class Knock {
 
   // Service accessors
   readonly users = new Users(this);
-  readonly preferences = new Preferences(this);
   readonly workflows = new Workflows(this);
   readonly bulkOperations = new BulkOperations(this);
   readonly objects = new Objects(this);

src/resources/objects/index.ts

@@ -23,6 +23,7 @@ import { ListMessagesOptions, Message } from "../messages/interfaces";
 import { ListSchedulesProps, Schedule } from "../workflows/interfaces";
 import {
   ChannelTypePreferences,
+  GetPreferencesOptions,
   PreferenceOptions,
   PreferenceSet,
   SetPreferencesProperties,
@@ -198,26 +199,18 @@ export class Objects {
     return data;
   }
 
-  /**
-   * @deprecated Use `objects.getPreferences` instead
-   */
-  async getPrefences(
-    collection: string,
-    objectId: string,
-    options: PreferenceOptions = {},
-  ): Promise<PreferenceSet> {
-    return this.getPreferences(collection, objectId, options);
-  }
-
   async getPreferences(
     collection: string,
     objectId: string,
-    options: PreferenceOptions = {},
+    options: GetPreferencesOptions = {},
   ): Promise<PreferenceSet> {
     const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;
 
-    const { data } = await this.knock.get(
+    const {
+      data,
+    } = await this.knock.get(
       `/v1/objects/${collection}/${objectId}/preferences/${preferenceSetId}`,
+      { tenant: options.tenant },
     );
 
     return data;

src/resources/preferences/interfaces.ts

@@ -33,3 +33,7 @@ export interface PreferenceSet {
 export interface PreferenceOptions {
   preferenceSet?: string;
 }
+
+export interface GetPreferencesOptions extends PreferenceOptions {
+  tenant?: string;
+}

src/resources/users/index.ts

@@ -10,6 +10,7 @@ import {
   ChannelTypePreferences,
   PreferenceOptions,
   PreferenceSet,
+  GetPreferencesOptions,
   SetPreferencesProperties,
   WorkflowPreferences,
   WorkflowPreferenceSetting,
@@ -128,24 +129,17 @@ export class Users {
     return data;
   }
 
-  /**
-   * @deprecated Use `users.getPreferences` instead
-   */
-  async getPrefences(
-    userId: string,
-    options: PreferenceOptions = {},
-  ): Promise<PreferenceSet> {
-    return this.getPreferences(userId, options);
-  }
-
   async getPreferences(
     userId: string,
-    options: PreferenceOptions = {},
+    options: GetPreferencesOptions = {},
   ): Promise<PreferenceSet> {
     const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;
 
-    const { data } = await this.knock.get(
+    const {
+      data,
+    } = await this.knock.get(
       `/v1/users/${userId}/preferences/${preferenceSetId}`,
+      { tenant: options.tenant },
     );
 
     return data;