@extrahorizon/javascript-sdk 8.6.0 → 8.7.0-dev-97-1cdbd8b

package/CHANGELOG.md

@@ -5,6 +5,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [8.7.0]
+
+
 ## [8.6.0]
 
 ### Added

package/build/index.cjs.js

@@ -1636,6 +1636,7 @@ const DISPATCHERS_BASE = '/dispatchers/v1';
 const PAYMENTS_BASE = '/payments/v1';
 const PROFILES_BASE = '/profiles/v1';
 const NOTIFICATIONS_BASE = '/notifications/v1';
+const NOTIFICATIONS_V2_BASE = '/notifications/v2';
 const LOCALIZATIONS_BASE = '/localizations/v1';
 const EVENTS_BASE = '/events/v1';
 const LOGS_BASE = '/logs/v1';
@@ -4229,7 +4230,7 @@ var groupRoles = (client, httpWithAuth) => ({
     },
 });
 
-var health$5 = (userClient, http) => ({
+var health$6 = (userClient, http) => ({
     /**
      * Perform a health check
      * @returns {boolean} success
@@ -4426,7 +4427,7 @@ const usersService = (httpWithAuth, http) => {
         basePath: USER_BASE,
         transformRequestData: decamelizeRequestData,
     });
-    const healthMethods = health$5(userClient, httpWithAuth);
+    const healthMethods = health$6(userClient, httpWithAuth);
     const usersMethods = users$1(userClient, httpWithAuth, http);
     const groupRolesMethods = groupRoles(userClient, httpWithAuth);
     const globalRolesMethods = globalRoles(userClient, httpWithAuth);
@@ -4807,7 +4808,7 @@ var appStoreSubscriptions = (client, httpAuth) => ({
     },
 });
 
-var health$4 = (client, httpAuth) => ({
+var health$5 = (client, httpAuth) => ({
     /**
      * Check if the service is available
      * @returns true if service is up and running
@@ -5013,7 +5014,7 @@ const paymentsService = (httpWithAuth) => {
         basePath: PAYMENTS_BASE,
     });
     return {
-        ...health$4(client, httpWithAuth),
+        ...health$5(client, httpWithAuth),
         products: products(client, httpWithAuth),
         orders: orders(client, httpWithAuth),
         subscriptions: subscriptions$1(client, httpWithAuth),
@@ -5035,7 +5036,7 @@ var countries = (client, httpAuth) => ({
     },
 });
 
-var health$3 = (client, http) => ({
+var health$4 = (client, http) => ({
     /**
      * Perform a health check
      * @returns {boolean} success
@@ -5088,7 +5089,7 @@ const localizationsService = (httpWithAuth) => {
         basePath: LOCALIZATIONS_BASE,
     });
     return {
-        ...health$3(client, httpWithAuth),
+        ...health$4(client, httpWithAuth),
         ...localizations(client, httpWithAuth),
         ...countries(client, httpWithAuth),
         ...languages(client, httpWithAuth),
@@ -5113,7 +5114,7 @@ var groups = (client, httpAuth) => ({
     },
 });
 
-var health$2 = (client, httpAuth) => ({
+var health$3 = (client, httpAuth) => ({
     /**
      * Perform a health check for profiles service
      * @returns {boolean} success
@@ -5203,14 +5204,14 @@ const profilesService = (httpWithAuth) => {
         basePath: PROFILES_BASE,
     });
     return {
-        ...health$2(client, httpWithAuth),
+        ...health$3(client, httpWithAuth),
         ...profiles(client, httpWithAuth),
         groups: groups(client, httpWithAuth),
         logs: logs(client, httpWithAuth),
     };
 };
 
-var health$1 = (client, http) => ({
+var health$2 = (client, http) => ({
     /**
      * Perform a health check
      * @returns {boolean} success
@@ -5297,12 +5298,103 @@ const notificationsService = (httpWithAuth) => {
         transformRequestData: decamelizeRequestData,
     });
     return {
-        ...health$1(client, httpWithAuth),
+        ...health$2(client, httpWithAuth),
         ...notifications(client, httpWithAuth),
         settings: settings(client, httpWithAuth),
     };
 };
 
+var health$1 = (client, http) => ({
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    async health() {
+        const result = await client.get(http, '/health');
+        return result.status === exports.Results.Success;
+    },
+});
+
+var notificationsV2 = (client, httpWithAuth) => {
+    async function find(options) {
+        const result = await client.get(httpWithAuth, `/${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, {
+            ...options,
+            customResponseKeys: ['data.data'],
+        });
+        return result.data;
+    }
+    return {
+        async create(requestBody, options) {
+            const result = await client.post(httpWithAuth, '/', requestBody, {
+                ...options,
+                customKeys: ['data'],
+            });
+            return result.data;
+        },
+        async find(options) {
+            const result = await find(options);
+            return addPagersFn(find, options, result);
+        },
+        async findAll(options) {
+            return findAllGeneric(find, options);
+        },
+        async findByTargetUserId(targetUserId, options) {
+            const rqlWithTargetUserId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('targetUserId', targetUserId).build();
+            const result = await find({ ...options, rql: rqlWithTargetUserId });
+            return addPagersFn(find, { ...options, rql: rqlWithTargetUserId }, result);
+        },
+        async findFirst(options) {
+            const result = await find(options);
+            return result.data[0];
+        },
+        async findById(notificationId, options) {
+            const rqlWithNotificationId = rqlBuilder().eq('id', notificationId).build();
+            const result = await find({ ...options, rql: rqlWithNotificationId });
+            return result.data[0];
+        },
+    };
+};
+
+var notificationV2Users = (client, httpWithAuth) => {
+    async function find(options) {
+        const result = await client.get(httpWithAuth, `/users/${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, options);
+        return result.data;
+    }
+    return {
+        async update(userId, requestBody, options) {
+            const result = await client.put(httpWithAuth, `/users/${userId}`, requestBody, options);
+            return result.data;
+        },
+        async find(options) {
+            const result = await find(options);
+            return addPagersFn(find, options, result);
+        },
+        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];
+        },
+    };
+};
+
+const notificationsV2Service = (httpWithAuth) => {
+    const client = httpClient({
+        basePath: NOTIFICATIONS_V2_BASE,
+    });
+    return {
+        ...health$1(client, httpWithAuth),
+        ...notificationsV2(client, httpWithAuth),
+        users: notificationV2Users(client, httpWithAuth),
+    };
+};
+
 var events = (client, httpAuth) => ({
     async find(options) {
         return (await client.get(httpAuth, `/${(options === null || options === void 0 ? void 0 : options.rql) || ''}`)).data;
@@ -5395,7 +5487,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.6.0';
+const version = '8.7.0-dev-97-1cdbd8b';
 
 /**
  * Create ExtraHorizon client.
@@ -5435,6 +5527,7 @@ function createClient(rawConfig) {
         localizations: localizationsService(httpWithAuth),
         profiles: profilesService(httpWithAuth),
         notifications: notificationsService(httpWithAuth),
+        notificationsV2: notificationsV2Service(httpWithAuth),
         events: eventsService(httpWithAuth),
         logs: logsService(httpWithAuth),
         auth: {

package/build/index.mjs

@@ -1606,6 +1606,7 @@ const DISPATCHERS_BASE = '/dispatchers/v1';
 const PAYMENTS_BASE = '/payments/v1';
 const PROFILES_BASE = '/profiles/v1';
 const NOTIFICATIONS_BASE = '/notifications/v1';
+const NOTIFICATIONS_V2_BASE = '/notifications/v2';
 const LOCALIZATIONS_BASE = '/localizations/v1';
 const EVENTS_BASE = '/events/v1';
 const LOGS_BASE = '/logs/v1';
@@ -4199,7 +4200,7 @@ var groupRoles = (client, httpWithAuth) => ({
     },
 });
 
-var health$5 = (userClient, http) => ({
+var health$6 = (userClient, http) => ({
     /**
      * Perform a health check
      * @returns {boolean} success
@@ -4396,7 +4397,7 @@ const usersService = (httpWithAuth, http) => {
         basePath: USER_BASE,
         transformRequestData: decamelizeRequestData,
     });
-    const healthMethods = health$5(userClient, httpWithAuth);
+    const healthMethods = health$6(userClient, httpWithAuth);
     const usersMethods = users$1(userClient, httpWithAuth, http);
     const groupRolesMethods = groupRoles(userClient, httpWithAuth);
     const globalRolesMethods = globalRoles(userClient, httpWithAuth);
@@ -4777,7 +4778,7 @@ var appStoreSubscriptions = (client, httpAuth) => ({
     },
 });
 
-var health$4 = (client, httpAuth) => ({
+var health$5 = (client, httpAuth) => ({
     /**
      * Check if the service is available
      * @returns true if service is up and running
@@ -4983,7 +4984,7 @@ const paymentsService = (httpWithAuth) => {
         basePath: PAYMENTS_BASE,
     });
     return {
-        ...health$4(client, httpWithAuth),
+        ...health$5(client, httpWithAuth),
         products: products(client, httpWithAuth),
         orders: orders(client, httpWithAuth),
         subscriptions: subscriptions$1(client, httpWithAuth),
@@ -5005,7 +5006,7 @@ var countries = (client, httpAuth) => ({
     },
 });
 
-var health$3 = (client, http) => ({
+var health$4 = (client, http) => ({
     /**
      * Perform a health check
      * @returns {boolean} success
@@ -5058,7 +5059,7 @@ const localizationsService = (httpWithAuth) => {
         basePath: LOCALIZATIONS_BASE,
     });
     return {
-        ...health$3(client, httpWithAuth),
+        ...health$4(client, httpWithAuth),
         ...localizations(client, httpWithAuth),
         ...countries(client, httpWithAuth),
         ...languages(client, httpWithAuth),
@@ -5083,7 +5084,7 @@ var groups = (client, httpAuth) => ({
     },
 });
 
-var health$2 = (client, httpAuth) => ({
+var health$3 = (client, httpAuth) => ({
     /**
      * Perform a health check for profiles service
      * @returns {boolean} success
@@ -5173,14 +5174,14 @@ const profilesService = (httpWithAuth) => {
         basePath: PROFILES_BASE,
     });
     return {
-        ...health$2(client, httpWithAuth),
+        ...health$3(client, httpWithAuth),
         ...profiles(client, httpWithAuth),
         groups: groups(client, httpWithAuth),
         logs: logs(client, httpWithAuth),
     };
 };
 
-var health$1 = (client, http) => ({
+var health$2 = (client, http) => ({
     /**
      * Perform a health check
      * @returns {boolean} success
@@ -5267,12 +5268,103 @@ const notificationsService = (httpWithAuth) => {
         transformRequestData: decamelizeRequestData,
     });
     return {
-        ...health$1(client, httpWithAuth),
+        ...health$2(client, httpWithAuth),
         ...notifications(client, httpWithAuth),
         settings: settings(client, httpWithAuth),
     };
 };
 
+var health$1 = (client, http) => ({
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    async health() {
+        const result = await client.get(http, '/health');
+        return result.status === Results.Success;
+    },
+});
+
+var notificationsV2 = (client, httpWithAuth) => {
+    async function find(options) {
+        const result = await client.get(httpWithAuth, `/${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, {
+            ...options,
+            customResponseKeys: ['data.data'],
+        });
+        return result.data;
+    }
+    return {
+        async create(requestBody, options) {
+            const result = await client.post(httpWithAuth, '/', requestBody, {
+                ...options,
+                customKeys: ['data'],
+            });
+            return result.data;
+        },
+        async find(options) {
+            const result = await find(options);
+            return addPagersFn(find, options, result);
+        },
+        async findAll(options) {
+            return findAllGeneric(find, options);
+        },
+        async findByTargetUserId(targetUserId, options) {
+            const rqlWithTargetUserId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('targetUserId', targetUserId).build();
+            const result = await find({ ...options, rql: rqlWithTargetUserId });
+            return addPagersFn(find, { ...options, rql: rqlWithTargetUserId }, result);
+        },
+        async findFirst(options) {
+            const result = await find(options);
+            return result.data[0];
+        },
+        async findById(notificationId, options) {
+            const rqlWithNotificationId = rqlBuilder().eq('id', notificationId).build();
+            const result = await find({ ...options, rql: rqlWithNotificationId });
+            return result.data[0];
+        },
+    };
+};
+
+var notificationV2Users = (client, httpWithAuth) => {
+    async function find(options) {
+        const result = await client.get(httpWithAuth, `/users/${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, options);
+        return result.data;
+    }
+    return {
+        async update(userId, requestBody, options) {
+            const result = await client.put(httpWithAuth, `/users/${userId}`, requestBody, options);
+            return result.data;
+        },
+        async find(options) {
+            const result = await find(options);
+            return addPagersFn(find, options, result);
+        },
+        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];
+        },
+    };
+};
+
+const notificationsV2Service = (httpWithAuth) => {
+    const client = httpClient({
+        basePath: NOTIFICATIONS_V2_BASE,
+    });
+    return {
+        ...health$1(client, httpWithAuth),
+        ...notificationsV2(client, httpWithAuth),
+        users: notificationV2Users(client, httpWithAuth),
+    };
+};
+
 var events = (client, httpAuth) => ({
     async find(options) {
         return (await client.get(httpAuth, `/${(options === null || options === void 0 ? void 0 : options.rql) || ''}`)).data;
@@ -5365,7 +5457,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.6.0';
+const version = '8.7.0-dev-97-1cdbd8b';
 
 /**
  * Create ExtraHorizon client.
@@ -5405,6 +5497,7 @@ function createClient(rawConfig) {
         localizations: localizationsService(httpWithAuth),
         profiles: profilesService(httpWithAuth),
         notifications: notificationsService(httpWithAuth),
+        notificationsV2: notificationsV2Service(httpWithAuth),
         events: eventsService(httpWithAuth),
         logs: logsService(httpWithAuth),
         auth: {

package/build/types/client.d.ts

@@ -1,5 +1,5 @@
 import { AuthHttpClient, OAuth1HttpClient, OAuth2HttpClient, ProxyInstance } from './http/types';
-import { authService, configurationsService, dataService, dispatchersService, eventsService, filesService, localizationsService, logsService, mailsService, notificationsService, paymentsService, profilesService, tasksService, templatesService, usersService } from './services';
+import { authService, configurationsService, dataService, dispatchersService, eventsService, filesService, localizationsService, logsService, mailsService, notificationsService, notificationsV2Service, paymentsService, profilesService, tasksService, templatesService, usersService } from './services';
 import { ClientParams, ParamsOauth1, ParamsOauth2, ParamsProxy } from './types';
 export interface Client<T extends ClientParams> {
     raw: AuthHttpClient;
@@ -58,6 +58,11 @@ export interface Client<T extends ClientParams> {
      * @see https://swagger.extrahorizon.com/listing/?service=notifications-service&redirectToVersion=1
      */
     notifications: ReturnType<typeof notificationsService>;
+    /**
+     * A service that handles push notifications.
+     * @see https://swagger.extrahorizon.com/listing/?service=notifications-service&redirectToVersion=2
+     */
+    notificationsV2: ReturnType<typeof notificationsV2Service>;
     /**
      * Service that provides event (publish/subscribe) functionality for other services.
      * @see https://swagger.extrahorizon.com/listing/?service=events-service&redirectToVersion=1

package/build/types/constants.d.ts

@@ -10,6 +10,7 @@ export declare const DISPATCHERS_BASE = "/dispatchers/v1";
 export declare const PAYMENTS_BASE = "/payments/v1";
 export declare const PROFILES_BASE = "/profiles/v1";
 export declare const NOTIFICATIONS_BASE = "/notifications/v1";
+export declare const NOTIFICATIONS_V2_BASE = "/notifications/v2";
 export declare const LOCALIZATIONS_BASE = "/localizations/v1";
 export declare const EVENTS_BASE = "/events/v1";
 export declare const LOGS_BASE = "/logs/v1";

package/build/types/mockType.d.ts

@@ -427,6 +427,22 @@ export declare type MockClientOAuth1<MockFn> = {
             remove: MockFn;
         };
     };
+    notificationsV2: {
+        health: MockFn;
+        create: MockFn;
+        find: MockFn;
+        findAll: MockFn;
+        findByTargetUserId: MockFn;
+        findFirst: MockFn;
+        findById: MockFn;
+        users: {
+            update: MockFn;
+            find: MockFn;
+            findAll: MockFn;
+            findByUserId: MockFn;
+            findFirst: MockFn;
+        };
+    };
     events: {
         health: MockFn;
         find: MockFn;
@@ -961,6 +977,22 @@ export declare type MockClientOAuth2<MockFn> = {
             remove: MockFn;
         };
     };
+    notificationsV2: {
+        health: MockFn;
+        create: MockFn;
+        find: MockFn;
+        findAll: MockFn;
+        findByTargetUserId: MockFn;
+        findFirst: MockFn;
+        findById: MockFn;
+        users: {
+            update: MockFn;
+            find: MockFn;
+            findAll: MockFn;
+            findByUserId: MockFn;
+            findFirst: MockFn;
+        };
+    };
     events: {
         health: MockFn;
         find: MockFn;
@@ -1495,6 +1527,22 @@ export declare type MockClientProxy<MockFn> = {
             remove: MockFn;
         };
     };
+    notificationsV2: {
+        health: MockFn;
+        create: MockFn;
+        find: MockFn;
+        findAll: MockFn;
+        findByTargetUserId: MockFn;
+        findFirst: MockFn;
+        findById: MockFn;
+        users: {
+            update: MockFn;
+            find: MockFn;
+            findAll: MockFn;
+            findByUserId: MockFn;
+            findFirst: MockFn;
+        };
+    };
     events: {
         health: MockFn;
         find: MockFn;

package/build/types/services/index.d.ts

@@ -11,5 +11,6 @@ export * from './payments';
 export * from './localizations';
 export * from './profiles';
 export * from './notifications';
+export * from './notificationsV2';
 export * from './events';
 export * from './logs';

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

@@ -0,0 +1,9 @@
+import type { HttpInstance } from '../../types';
+declare const _default: (client: any, http: HttpInstance) => {
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
+};
+export default _default;

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

@@ -0,0 +1,7 @@
+import { AuthHttpClient } from '../../types';
+import health from './health';
+import { NotificationV2Service } from './types';
+import { NotificationV2UserService } from './users/types';
+export declare const notificationsV2Service: (httpWithAuth: AuthHttpClient) => ReturnType<typeof health> & NotificationV2Service & {
+    users: NotificationV2UserService;
+};

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

@@ -0,0 +1,5 @@
+import { AuthHttpClient } from '../../types';
+import { HttpClient } from '../http-client';
+import { NotificationV2Service } from './types';
+declare const _default: (client: HttpClient, httpWithAuth: AuthHttpClient) => NotificationV2Service;
+export default _default;

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

@@ -0,0 +1,109 @@
+import { ObjectId, OptionsBase, OptionsWithRql, PagedResultWithPager } from '../types';
+export * from './users/types';
+export interface NotificationV2Creation<T extends Record<string, string> = Record<string, string>> {
+    targetUserId: string;
+    title: string;
+    body: string;
+    data?: T;
+    /**
+     * See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#AndroidConfig
+     */
+    android?: any;
+    /**
+     * See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#ApnsConfig
+     */
+    apns?: any;
+    /**
+     * See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#WebpushConfig
+     */
+    webpush?: any;
+}
+export interface NotificationV2<T extends Record<string, string> = Record<string, string>> extends NotificationV2Creation<T> {
+    id: ObjectId;
+    creatorId: ObjectId;
+    sent: boolean;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+}
+export interface NotificationV2Service {
+    /**
+     * # Create a notification
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `CREATE_NOTIFICATIONS` | `global` | Create notifications for any user
+     * `CREATE_NOTIFICATIONS` | `group` | Create notifications for any patient in group
+     * none | | Create notifications for yourself
+     *
+     * # Interface
+     * @param requestBody
+     * @param options
+     * @returns NotificationV2<T>
+     */
+    create<T extends Record<string, string>>(requestBody: NotificationV2Creation<T>, options?: OptionsBase): Promise<NotificationV2<T>>;
+    /**
+     * # Request a list of notifications
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `VIEW_NOTIFICATIONS` | `global` | View all notifications
+     *
+     * # Interface
+     * @returns PagedResultWithPager<NotificationV2<T>>
+     */
+    find<T extends Record<string, string>>(options?: OptionsWithRql): Promise<PagedResultWithPager<NotificationV2<T>>>;
+    /**
+     * # Request a list of notifications
+     *
+     * Do not pass in an rql with limit operator!
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `VIEW_NOTIFICATIONS` | `global` | View all notifications
+     *
+     * # Interface
+     * @returns NotificationV2<T>[]
+     */
+    findAll<T extends Record<string, string>>(options?: OptionsWithRql): Promise<NotificationV2<T>[]>;
+    /**
+     * # Request a list of notifications created for a user
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `VIEW_NOTIFICATIONS` | `global` | View all notifications
+     *
+     * # Interface
+     * @param targetUserId the user id to search for
+     * @returns PagedResultWithPager<NotificationV2<T>>
+     */
+    findByTargetUserId<T extends Record<string, string>>(targetUserId: ObjectId, options?: OptionsWithRql): Promise<PagedResultWithPager<NotificationV2<T>>>;
+    /**
+     * # Request the first notification found
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `VIEW_NOTIFICATIONS` | `global` | View all notifications
+     *
+     * # Interface
+     * @returns NotificationV2<T> | undefined
+     */
+    findFirst<T extends Record<string, string>>(options?: OptionsWithRql): Promise<NotificationV2<T> | undefined>;
+    /**
+     * # Request a notification by id
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `VIEW_NOTIFICATIONS` | `global` | View all notifications
+     *
+     * # Interface
+     * @param notificationId the Id to search for
+     * @returns NotificationV2<T> | undefined
+     */
+    findById<T extends Record<string, string>>(notificationId: ObjectId, options?: OptionsBase): Promise<NotificationV2<T> | undefined>;
+}

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

@@ -0,0 +1,5 @@
+import { AuthHttpClient } from '../../../types';
+import { HttpClient } from '../../http-client';
+import { NotificationV2UserService } from './types';
+declare const _default: (client: HttpClient, httpWithAuth: AuthHttpClient) => NotificationV2UserService;
+export default _default;

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

@@ -0,0 +1,79 @@
+import { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResultWithPager } from '../../types';
+export interface NotificationV2UserUpsert {
+    fcmToken: string;
+}
+export interface NotificationV2User extends NotificationV2UserUpsert {
+    id: ObjectId;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+}
+export interface NotificationV2UserService {
+    /**
+     * # Update a user its notification settings
+     *
+     * Updates (or creates if non exists) a user its settings for the specified user id.
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `UPDATE_NOTIFICATION_SETTINGS` | `global` | Update the notification settings of any user
+     * none | | Update your own notification settings
+     *
+     * # Interface
+     * @param requestBody
+     * @param options
+     * @returns AffectedRecords
+     */
+    update(userId: ObjectId, requestBody: NotificationV2UserUpsert, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+    * # Request a list of user notification settings
+    *
+    * ## Access via permissions
+    * Permission | Scopes | Effect
+    * - | - | -
+    * `VIEW_NOTIFICATION_SETTINGS` | `global` | View all notifications
+    *
+    * # Interface
+    * @returns PagedResultWithPager<NotificationV2User>
+    */
+    find(options?: OptionsWithRql): Promise<PagedResultWithPager<NotificationV2User>>;
+    /**
+    * # Request a list of user notification settings
+    *
+    * Do not pass in an rql with limit operator!
+    *
+    * ## Access via permissions
+    * Permission | Scopes | Effect
+    * - | - | -
+    * `VIEW_NOTIFICATION_SETTINGS` | `global` | View all notifications
+    *
+    * # 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
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `VIEW_NOTIFICATION_SETTINGS` | `global` | View all notifications
+     *
+     * # Interface
+     * @returns NotificationV2User | undefined
+     */
+    findFirst(options?: OptionsWithRql): Promise<NotificationV2User | undefined>;
+}

package/build/types/types.d.ts

@@ -15,6 +15,7 @@ export * from './services/payments/types';
 export * from './services/localizations/types';
 export * from './services/profiles/types';
 export * from './services/notifications/types';
+export * from './services/notificationsV2/types';
 export * from './services/events/types';
 export interface ParamsOauth1WithEmail {
     email: string;

package/build/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.6.0";
+export declare const version = "8.7.0-dev-97-1cdbd8b";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.6.0",
+  "version": "8.7.0-dev-97-1cdbd8b",
   "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",
@@ -58,4 +58,4 @@
     "ts-jest": "^29.1.2",
     "typescript": "^4.5.5"
   }
-}
+}