@extrahorizon/javascript-sdk 8.10.0-dev-159-0e9a0f1 → 8.10.0-dev-161-c1dd6ca

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

@@ -0,0 +1,166 @@
+import { ObjectId, OptionsBase, OptionsWithRql, PagedResultWithPager } from '../types';
+export * from './userSettings/types';
+export interface NotificationV2Creation<T extends Record<string, string> = Record<string, string>> {
+    targetUserId: ObjectId;
+    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;
+    /**
+     * Indicates whether we tried to send the notification.
+     * Would be `false` if no devices with FCM tokens were found for the user.
+     * See `errors` for any errors that occurred.
+     */
+    sent: boolean;
+    /**
+     * The errors that occurred while sending the notification, if any.
+     */
+    errors?: NotificationV2Error[];
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+}
+export interface NotificationV2Error {
+    /**
+     * The name of the device for which the error occurred.
+     * If not set, the error occurred for the FCM token defined on the root of the user settings.
+     */
+    deviceName?: string;
+    exhError: {
+        code: string;
+        name: string;
+        message: string;
+    };
+    /**
+     * The error received from FCM, unchanged, if available.
+     * @example
+     * {
+     *   "error": {
+     *     "code": 403,
+     *     "message": "SenderId mismatch",
+     *     "status": "PERMISSION_DENIED",
+     *     "details": [
+     *       {
+     *         "@type": "type.googleapis.com/google.firebase.fcm.v1.FcmError",
+     *         "errorCode": "SENDER_ID_MISMATCH",
+     *       }
+     *     ]
+     *   }
+     * }
+     * */
+    fcmError?: any;
+}
+export interface NotificationV2Service {
+    /**
+     * # Create a notification
+     *
+     * A user's FCM token and their device's with an FCM token will be targeted for the notification
+     *
+     * If an unusable FCM token is detected, the request will succeed, however, the FCM token will be removed from the user's settings.
+     * Any unusable FCM token errors will be included in the `errors` field of the response.
+     *
+     * Multiple errors can occur at once when multiple devices are targeted and errors are thrown in this order:
+     * - `FirebaseConnectionError`
+     * - `FirebaseInvalidPlatformDataError`
+     * Both error types will include a `notificationId` and an `errors` field with details about any errors that occurred.
+     *
+     * ## Access via permissions
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `CREATE_NOTIFICATIONS` | `global` | Create notifications for any user
+     * `CREATE_NOTIFICATIONS` | `group` | Create notifications for any patient in a group
+     * none | | Create notifications for yourself
+     *
+     * # Interface
+     * @param requestBody
+     * @param options
+     * @returns NotificationV2<T>
+     *
+     * @throws {FirebaseInvalidPlatformDataError} if FCM reports invalid values for `android`, `apns`, or `webpush`.
+     * @throws {FirebaseConnectionError} if FCM is unreachable or returns an unknown error.
+     */
+    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>;
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
+}

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

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

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

@@ -0,0 +1,138 @@
+import { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResultWithPager } from '../../types';
+export interface NotificationV2UserSettingsUpsert {
+    /** @deprecated We recommend using `devices` instead */
+    fcmToken: string | null;
+}
+export interface NotificationV2UserSettings extends NotificationV2UserSettingsUpsert {
+    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 NotificationV2UserSettingsService {
+    /**
+     * # 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<NotificationV2UserSettings>;
+    /**
+     * @deprecated We recommend using `devices` instead, managed by the `addOrUpdateDevice()` and `removeDevice()` methods.
+     * # 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: NotificationV2UserSettingsUpsert, 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
+    *
+    * ## Access via permissions
+    * Permission | Scopes | Effect
+    * - | - | -
+    * `VIEW_NOTIFICATION_SETTINGS` | `global` | View all notifications
+    *
+    * ## Interface
+    * @returns PagedResultWithPager<NotificationV2User>
+    */
+    find(options?: OptionsWithRql): Promise<PagedResultWithPager<NotificationV2UserSettings>>;
+    /**
+    * # 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<NotificationV2UserSettings[]>;
+    /**
+     * # 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<NotificationV2UserSettings | undefined>;
+}

package/build/services/payments/appStore.d.ts

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

package/build/services/payments/appStoreSubscriptions.d.ts

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

package/build/services/payments/health.d.ts

@@ -0,0 +1,9 @@
+import type { HttpInstance } from '../../types';
+declare const _default: (client: any, httpAuth: HttpInstance) => {
+    /**
+     * Check if the service is available
+     * @returns true if service is up and running
+     */
+    health(): Promise<boolean>;
+};
+export default _default;

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

@@ -0,0 +1,15 @@
+import type { HttpInstance } from '../../types';
+import health from './health';
+import { PaymentsAppStoreService, PaymentsAppStoreSubscriptionsService, PaymentsOrdersService, PaymentsProductsService, PaymentsStripeService, PaymentsSubscriptionsService, PaymentsPlayStoreService, PaymentsPlayStoreSubscriptionsService, PaymentsPlayStoreHistoryService } from './types';
+export declare type PaymentsService = ReturnType<typeof health> & {
+    products: PaymentsProductsService;
+    orders: PaymentsOrdersService;
+    subscriptions: PaymentsSubscriptionsService;
+    appStore: PaymentsAppStoreService;
+    appStoreSubscriptions: PaymentsAppStoreSubscriptionsService;
+    playStore: PaymentsPlayStoreService;
+    playStoreHistory: PaymentsPlayStoreHistoryService;
+    playStoreSubscriptions: PaymentsPlayStoreSubscriptionsService;
+    stripe: PaymentsStripeService;
+};
+export declare const paymentsService: (httpWithAuth: HttpInstance) => PaymentsService;

package/build/services/payments/orders.d.ts

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

package/build/services/payments/playStore.d.ts

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

package/build/services/payments/playStoreHistory.d.ts

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

package/build/services/payments/playStoreSubscriptions.d.ts

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

package/build/services/payments/products.d.ts

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

package/build/services/payments/stripe.d.ts

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

package/build/services/payments/subscriptions.d.ts

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