@extrahorizon/javascript-sdk 8.7.0-dev-99-db18adc → 8.7.0-dev-101-9e49b6c

package/build/index.cjs.js

@@ -5361,10 +5361,26 @@ var notificationV2Users = (client, httpWithAuth) => {
         return result.data;
     }
     return {
+        async getById(userId, options) {
+            const result = await client.get(httpWithAuth, `/users/${userId}`, options);
+            return result.data;
+        },
         async update(userId, requestBody, options) {
             const result = await client.put(httpWithAuth, `/users/${userId}`, requestBody, options);
             return result.data;
         },
+        async remove(userId, options) {
+            const result = await client.delete(httpWithAuth, `/users/${userId}`, options);
+            return result.data;
+        },
+        async addOrUpdateDevice(userId, deviceName, requestBody, options) {
+            const result = await client.put(httpWithAuth, `/users/${userId}/devices/${deviceName}`, requestBody, options);
+            return result.data;
+        },
+        async removeDevice(userId, deviceName, options) {
+            const result = await client.delete(httpWithAuth, `/users/${userId}/devices/${deviceName}`, options);
+            return result.data;
+        },
         async find(options) {
             const result = await find(options);
             return addPagersFn(find, options, result);
@@ -5372,11 +5388,6 @@ var notificationV2Users = (client, httpWithAuth) => {
         async findAll(options) {
             return findAllGeneric(find, options);
         },
-        async findByUserId(userId, options) {
-            const rqlWithUserId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', userId).build();
-            const result = await find({ ...options, rql: rqlWithUserId });
-            return result.data[0];
-        },
         async findFirst(options) {
             const result = await find(options);
             return result.data[0];
@@ -5487,7 +5498,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.7.0-dev-99-db18adc';
+const version = '8.7.0-dev-101-9e49b6c';
 
 /**
  * Create ExtraHorizon client.

package/build/index.mjs

@@ -5331,10 +5331,26 @@ var notificationV2Users = (client, httpWithAuth) => {
         return result.data;
     }
     return {
+        async getById(userId, options) {
+            const result = await client.get(httpWithAuth, `/users/${userId}`, options);
+            return result.data;
+        },
         async update(userId, requestBody, options) {
             const result = await client.put(httpWithAuth, `/users/${userId}`, requestBody, options);
             return result.data;
         },
+        async remove(userId, options) {
+            const result = await client.delete(httpWithAuth, `/users/${userId}`, options);
+            return result.data;
+        },
+        async addOrUpdateDevice(userId, deviceName, requestBody, options) {
+            const result = await client.put(httpWithAuth, `/users/${userId}/devices/${deviceName}`, requestBody, options);
+            return result.data;
+        },
+        async removeDevice(userId, deviceName, options) {
+            const result = await client.delete(httpWithAuth, `/users/${userId}/devices/${deviceName}`, options);
+            return result.data;
+        },
         async find(options) {
             const result = await find(options);
             return addPagersFn(find, options, result);
@@ -5342,11 +5358,6 @@ var notificationV2Users = (client, httpWithAuth) => {
         async findAll(options) {
             return findAllGeneric(find, options);
         },
-        async findByUserId(userId, options) {
-            const rqlWithUserId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', userId).build();
-            const result = await find({ ...options, rql: rqlWithUserId });
-            return result.data[0];
-        },
         async findFirst(options) {
             const result = await find(options);
             return result.data[0];
@@ -5457,7 +5468,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.7.0-dev-99-db18adc';
+const version = '8.7.0-dev-101-9e49b6c';
 
 /**
  * Create ExtraHorizon client.

package/build/types/mockType.d.ts

@@ -436,10 +436,13 @@ export declare type MockClientOAuth1<MockFn> = {
         findFirst: MockFn;
         findById: MockFn;
         users: {
+            getById: MockFn;
             update: MockFn;
+            remove: MockFn;
+            addOrUpdateDevice: MockFn;
+            removeDevice: MockFn;
             find: MockFn;
             findAll: MockFn;
-            findByUserId: MockFn;
             findFirst: MockFn;
         };
     };
@@ -986,10 +989,13 @@ export declare type MockClientOAuth2<MockFn> = {
         findFirst: MockFn;
         findById: MockFn;
         users: {
+            getById: MockFn;
             update: MockFn;
+            remove: MockFn;
+            addOrUpdateDevice: MockFn;
+            removeDevice: MockFn;
             find: MockFn;
             findAll: MockFn;
-            findByUserId: MockFn;
             findFirst: MockFn;
         };
     };
@@ -1536,10 +1542,13 @@ export declare type MockClientProxy<MockFn> = {
         findFirst: MockFn;
         findById: MockFn;
         users: {
+            getById: MockFn;
             update: MockFn;
+            remove: MockFn;
+            addOrUpdateDevice: MockFn;
+            removeDevice: MockFn;
             find: MockFn;
             findAll: MockFn;
-            findByUserId: MockFn;
             findFirst: MockFn;
         };
     };

package/build/types/services/notificationsV2/users/types.d.ts

@@ -1,13 +1,38 @@
 import { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResultWithPager } from '../../types';
 export interface NotificationV2UserUpsert {
+    /** @deprecated We recommend using `devices` instead */
     fcmToken: string;
 }
 export interface NotificationV2User extends NotificationV2UserUpsert {
     id: ObjectId;
+    devices?: NotificationV2UserDevice[];
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+}
+export interface NotificationV2UserDeviceUpsert {
+    description?: string | null;
+    fcmToken?: string | null;
+}
+export interface NotificationV2UserDevice {
+    name: string;
+    description?: string;
+    fcmToken?: string;
     creationTimestamp: Date;
     updateTimestamp: Date;
 }
 export interface NotificationV2UserService {
+    /**
+     * # Get the notification settings for a specific user
+     *
+     * This will always return a notification settings object, even if the user does not have any notification settings set up.
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `VIEW_NOTIFICATION_SETTINGS` | `global` | View all notifications
+     * none | | View your own notification settings
+     */
+    getById(userId: ObjectId, options?: OptionsBase): Promise<NotificationV2User>;
     /**
      * # Update a user its notification settings
      *
@@ -19,12 +44,58 @@ export interface NotificationV2UserService {
      * `UPDATE_NOTIFICATION_SETTINGS` | `global` | Update the notification settings of any user
      * none | | Update your own notification settings
      *
-     * # Interface
+     * ## Interface
      * @param requestBody
      * @param options
      * @returns AffectedRecords
      */
     update(userId: ObjectId, requestBody: NotificationV2UserUpsert, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * # Delete the notification settings for a specific user
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `DELETE_NOTIFICATION_SETTINGS` | `global` | Delete the notification settings of any user
+     * none | | Delete your own notification settings
+     *
+     * ## Interface
+     * @throws {ResourceUnknownError} when notification settings for the specified user do not exist
+     */
+    remove(userId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * # Add or update a device for the notification settings of a user
+     *
+     * Create or update the device with the specified name for the user with the given Id.
+     *
+     * If the user already has a device with the specified name, it will be updated.
+     *
+     * If the user does not have a device with the specified name, it will be created.
+     *
+     * If the user does not have user settings, it will be created.
+     *
+     * Setting `null` for `fcmToken` or `description` will remove the configured value.
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `UPDATE_NOTIFICATION_SETTINGS_DEVICE` | `global` | Update devices for notification settings of any user
+     * none | | Update devices for your own notification settings
+     */
+    addOrUpdateDevice(userId: ObjectId, deviceName: string, requestBody: NotificationV2UserDeviceUpsert, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * # Remove a device from the notification settings of a user
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `DELETE_NOTIFICATION_SETTINGS_DEVICE` | `global` | Delete devices from notification settings of any user
+     * none | | Delete devices from your own notification settings
+     *
+     * ## Interface
+     * @throws {ResourceUnknownError} when specified user or device does not exist
+     */
+    removeDevice(userId: ObjectId, deviceName: string, options?: OptionsBase): Promise<AffectedRecords>;
     /**
     * # Request a list of user notification settings
     *
@@ -33,7 +104,7 @@ export interface NotificationV2UserService {
     * - | - | -
     * `VIEW_NOTIFICATION_SETTINGS` | `global` | View all notifications
     *
-    * # Interface
+    * ## Interface
     * @returns PagedResultWithPager<NotificationV2User>
     */
     find(options?: OptionsWithRql): Promise<PagedResultWithPager<NotificationV2User>>;
@@ -47,23 +118,10 @@ export interface NotificationV2UserService {
     * - | - | -
     * `VIEW_NOTIFICATION_SETTINGS` | `global` | View all notifications
     *
-    * # Interface
+    * ## Interface
     * @returns NotificationV2User[]
     */
     findAll(options?: OptionsWithRql): Promise<NotificationV2User[]>;
-    /**
-    * # Request notification settings for a specific user
-    *
-    * ## Access via permissions
-    * Permission | Scopes | Effect
-    * - | - | -
-    * `VIEW_NOTIFICATION_SETTINGS` | `global` | View all notifications
-    *
-    * # Interface
-    * @param userId the user id to search for
-    * @returns NotificationV2User | undefined
-    */
-    findByUserId(userId: ObjectId, options?: OptionsWithRql): Promise<NotificationV2User | undefined>;
     /**
      * # Request the first user notification settings
      *
@@ -72,7 +130,7 @@ export interface NotificationV2UserService {
      * - | - | -
      * `VIEW_NOTIFICATION_SETTINGS` | `global` | View all notifications
      *
-     * # Interface
+     * ## Interface
      * @returns NotificationV2User | undefined
      */
     findFirst(options?: OptionsWithRql): Promise<NotificationV2User | undefined>;

package/build/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.7.0-dev-99-db18adc";
+export declare const version = "8.7.0-dev-101-9e49b6c";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.7.0-dev-99-db18adc",
+  "version": "8.7.0-dev-101-9e49b6c",
   "description": "This package serves as a JavaScript wrapper around all Extra Horizon cloud services.",
   "main": "build/index.cjs.js",
   "types": "build/types/index.d.ts",