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

package/build/services/localizations/languages.d.ts

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

package/build/services/localizations/localizations.d.ts

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

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

@@ -0,0 +1,150 @@
+import { RQLString } from '../../rql';
+import { AffectedRecords, OptionsBase, OptionsWithRql, PagedResult } from '../types';
+export declare enum SupportedLanguageCodes {
+    EN = "EN",
+    NL = "NL",
+    DE = "DE",
+    FR = "FR",
+    DA = "DA",
+    ES = "ES",
+    IT = "IT"
+}
+declare type SupportedLanguageCodesValues = keyof typeof SupportedLanguageCodes;
+export declare type MappedText = Record<SupportedLanguageCodesValues, string>;
+export interface Localization {
+    key: string;
+    text: {
+        [K in SupportedLanguageCodesValues]?: string;
+    };
+    creationTimestamp?: Date;
+    updateTimestamp?: Date;
+}
+export interface BulkLocalization {
+    localizations?: Array<Pick<Localization, 'key' | 'text'>>;
+}
+/**
+ * The 'created' field shows how many new localizations were succesfully created. The 'existing' field shows how many localizations with the given keys already existed. Eventually, the 'existing_ids' fields shows exactly which localizations already existed. Old localizations will not be overwritten by new ones.
+ */
+export interface BulkCreationResponse {
+    created?: number;
+    existing?: number;
+    existingIds?: string[];
+}
+/**
+ * The 'updated' field shows how many localizations were succesfully updated. The 'missing' field shows how many localizations with the given keys couldn't be found. Eventually, the 'missing_ids' fields shows exactly which localizations couldn't be found and are thus not updated.
+ */
+export interface BulkUpdateResponse {
+    updated?: number;
+    missing?: number;
+    missingIds?: string[];
+}
+export interface LocalizationRequest {
+    localizationCodes: SupportedLanguageCodesValues[];
+    localizations: string[];
+}
+export interface CountriesService {
+    /**
+     * Retrieve a list of all the defined countries
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @returns PagedResult<string>
+     */
+    getCountries(options?: OptionsBase): Promise<string[]>;
+    /**
+     * Retrieve a list of all the defined regions for the specified country code
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param country The country code (as defined in ISO 3166-1)
+     * @returns PagedResult<string>
+     * @throws {ResourceUnknownError}
+     */
+    getRegions(country: string, options?: OptionsBase): Promise<string[]>;
+}
+export interface LanguagesService {
+    /**
+     * Retrieve a list of all the defined languages
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @returns PagedResult<SupportedLanguageCodes>
+     */
+    getLanguages(options?: OptionsBase): Promise<string[]>;
+}
+export interface LocalizationsService {
+    /**
+     * Returns all possible localizations stored in this service
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<Localization>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<Localization>>;
+    /**
+     * Find By Key
+     * @param key the key to search for
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findByKey(key: string, options?: OptionsWithRql): Promise<Localization | undefined>;
+    /**
+     * Find First
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<Localization | undefined>;
+    /**
+     * Create new localizations
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CREATE_LOCALIZATIONS` | global | **Required** for this endpoint
+     * @param requestBody BulkLocalization
+     * @returns BulkCreationResponse
+     * @throws {DefaultLocalizationMissingError}
+     */
+    create(requestBody: BulkLocalization, options?: OptionsBase): Promise<BulkCreationResponse>;
+    /**
+     * Update localizations
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_LOCALIZATIONS` | global | **Required** for this endpoint
+     * @param requestBody BulkLocalization
+     * @returns BulkUpdateResponse
+     */
+    update(requestBody: BulkLocalization, options?: OptionsBase): Promise<BulkUpdateResponse>;
+    /**
+     * Delete localizations
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `DELETE_LOCALIZATIONS` | global | **Required** for this endpoint
+     * @param rql Add filters to the requested list, **required**.
+     * @returns AffectedRecords
+     */
+    remove(rql: RQLString, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Request localizations of multiple keys in a specific language
+     * The default language (EN) is always included in the response as a fallback in case there is no translation available for the specified language
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param requestBody LocalizationRequest
+     * @returns Record<string, MappedText>
+     */
+    getByKeys(requestBody: LocalizationRequest, options?: OptionsBase): Promise<Record<string, MappedText>>;
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
+}
+export {};

package/build/services/logs/access/index.d.ts

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

package/build/services/logs/access/types.d.ts

@@ -0,0 +1,41 @@
+import { OptionsWithRql } from '../../types';
+export interface LogsAccessService {
+    /**
+     * ## Retrieve a list of access logs
+     *
+     * **Global Permissions:**
+     * - `VIEW_ACCESS_LOGS` - Allows a user to view access logs
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An array of access logs {@link AccessLog AccessLog[]}
+     */
+    find(options?: OptionsWithRql): Promise<AccessLog[]>;
+    /**
+     * ## Retrieve the first queried access log
+     *
+     * **Global Permissions:**
+     * - `VIEW_ACCESS_LOGS` - Allows a user to view access logs
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns The first element of the queried access logs {@link AccessLog}
+     */
+    findFirst(options?: OptionsWithRql): Promise<AccessLog | undefined>;
+}
+export interface AccessLog {
+    /** The time of request receival */
+    timestamp: Date;
+    /** The status code of the response for the request */
+    httpStatus: number;
+    /** The duration of the request in seconds */
+    duration: number;
+    /** The Extra Horizon id of the request initiator */
+    userId: string;
+    /** The IP address of the request's origin */
+    userAddress: string;
+    /** The domain or IP of the accessed Extra Horizon deployment */
+    host: string;
+    /** The HTTP request */
+    request: string;
+    /** The size of the response in Bytes */
+    responseBodySize: number;
+    /** The signature of the request device and software */
+    userAgent: string;
+}

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

@@ -0,0 +1,3 @@
+import { HttpInstance } from '../../http/types';
+import { LogsService } from './types';
+export declare const logsService: (httpWithAuth: HttpInstance) => LogsService;

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

@@ -0,0 +1,4 @@
+import { LogsAccessService } from './access/types';
+export interface LogsService {
+    access: LogsAccessService;
+}

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

@@ -0,0 +1,3 @@
+import type { HttpInstance } from '../../types';
+import { MailsService } from './types';
+export declare const mailsService: (httpWithAuth: HttpInstance) => MailsService;

package/build/services/mails/mails.d.ts

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

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

@@ -0,0 +1,149 @@
+import { ObjectId, LanguageCode, MailAddress, MailAddressList, MailRecipients, AffectedRecords, PagedResult, OptionsBase, OptionsWithRql, TimeZone } from '../types';
+export interface Mail {
+    id: ObjectId;
+    creatorId?: ObjectId;
+    awsMessageId?: ObjectId;
+    subject: string;
+    recipients: MailRecipients;
+    templateId?: ObjectId;
+    templateName?: string;
+    replyTo?: MailAddressList;
+    from: MailAddress;
+    body?: string;
+    language?: LanguageCode;
+    timeZone?: TimeZone;
+    content?: Record<string, any>;
+    views: number;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+}
+export declare type PlainMailCreation = {
+    subject: string;
+    body: string;
+} & CommonMailCreationProperties;
+export declare type TemplateBasedMailCreation = {
+    templateId?: ObjectId;
+    templateName?: string;
+    language?: LanguageCode;
+    timeZone?: TimeZone;
+    content: Record<string, any>;
+} & CommonMailCreationProperties;
+export interface CommonMailCreationProperties {
+    recipients: MailRecipients;
+    from?: MailAddress;
+    replyTo?: MailAddressList;
+    attachments?: Attachment[];
+}
+export interface Attachment {
+    name: string;
+    /**
+     * Base64 encoded binary data
+     */
+    content: string;
+    /**
+     * MIME Type of the file
+     */
+    type?: string;
+}
+export interface QueuedMail {
+    id: ObjectId;
+    status: QueuedMailStatus;
+    from: string;
+    to?: MailAddressList;
+    cc?: MailAddressList;
+    bcc?: MailAddressList;
+    replyTo?: MailAddress;
+    subject?: string;
+    text?: string;
+    html?: string;
+    attachments?: QueuedMailAttachment[];
+    encoding?: string;
+    textEncoding?: string;
+    templateData?: {
+        templateId?: ObjectId;
+        templateName?: string;
+        credentials?: {
+            serviceId?: ObjectId;
+            applicationId?: ObjectId;
+            userId?: ObjectId;
+        };
+        language?: LanguageCode;
+        timeZone?: string;
+        content?: Record<string, any>;
+    };
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+}
+export interface QueuedMailAttachment {
+    filename?: string;
+    content?: string;
+    encoding?: string;
+}
+export declare enum QueuedMailStatus {
+    QUEUED = "queued",
+    SENDING = "sending",
+    FAILED = "failed"
+}
+export interface MailsService {
+    /**
+     * Perform a health check for mail service
+     * @returns {boolean} success
+     */
+    health(options?: OptionsBase): Promise<boolean>;
+    /**
+     * Retrieve a list of mails
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_MAILS` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<Mail>
+     */
+    find: (options?: OptionsWithRql) => Promise<PagedResult<Mail>>;
+    /**
+     * Find By Id
+     * @param id the Id to search for
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findById: (id: ObjectId, options?: OptionsWithRql) => Promise<Mail | undefined>;
+    /**
+     * Find First
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<Mail | undefined>;
+    /**
+     * Send a mail
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Send mails to your own email address
+     * none | `staff enlistment` | Send any mail to your patients or send a template mail based on pre-configured allowed templates to any email address.
+     * `SEND_MAILS` | `global` | Send mails to any email address
+     * @param requestBody mail creation data
+     * @returns Mail
+     * @throws {NotActivatedError}
+     */
+    send(requestBody: PlainMailCreation | TemplateBasedMailCreation, options?: OptionsBase): Promise<Mail>;
+    /**
+     * Register a mail being opened
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none |  | Everyone can use this endpoint
+     * @param trackingHash
+     * @returns AffectedRecords
+     */
+    track(trackingHash: string, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Retrieve the list of mails that are not sent yet
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_MAILS` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<QueuedMail>
+     */
+    findOutbound(options?: OptionsWithRql): Promise<PagedResult<QueuedMail>>;
+}

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

@@ -0,0 +1,6 @@
+import type { AuthHttpClient } from '../../types';
+import settings from './settings';
+import { NotificationSettingsServices, NotificationsService } from './types';
+export declare const notificationsService: (httpWithAuth: AuthHttpClient) => NotificationsService & {
+    settings: NotificationSettingsServices;
+};

package/build/services/notifications/notifications.d.ts

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

package/build/services/notifications/settings.d.ts

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

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

@@ -0,0 +1,235 @@
+import { FindAllIterator } from '../../services/helpers';
+import { AffectedRecords, ObjectId, OptionsBase, OptionsWithRql, PagedResult, PagedResultWithPager } from '../types';
+export interface Notification {
+    id?: ObjectId;
+    type?: string;
+    viewed?: boolean;
+    userId?: ObjectId;
+    fields?: Record<string, string>;
+    important?: boolean;
+    creationTimestamp?: Date;
+    updateTimestamp?: Date;
+}
+interface CreateNotificationRequestBase {
+    userId?: ObjectId;
+    important?: boolean;
+}
+interface CreateNotificationRequestMessage extends CreateNotificationRequestBase {
+    type: 'message';
+    fields: {
+        title: string;
+        body: string;
+    };
+}
+interface CreateNotificationRequestLink extends CreateNotificationRequestBase {
+    type: 'link';
+    fields: {
+        title: string;
+        body: string;
+        url: string;
+    };
+}
+interface CreateNotificationRequestMeasurementComment extends CreateNotificationRequestBase {
+    type: 'measurement_comment';
+    fields: {
+        commenterId: ObjectId;
+        measurementId: ObjectId;
+    };
+}
+interface CreateNotificationRequestMeasurementReviewed extends CreateNotificationRequestBase {
+    type: 'measurement_reviewed';
+    fields: {
+        measurementId: ObjectId;
+    };
+}
+interface CreateNotificationRequestMeasurementPrescriptionExpiry extends CreateNotificationRequestBase {
+    type: 'prescription_expiry';
+    fields: {
+        groupId: ObjectId;
+        groupName: string;
+    };
+}
+interface CreateNotificationRequestActivated extends CreateNotificationRequestBase {
+    type: 'activated';
+}
+interface CreateNotificationRequestPasswordChanged extends CreateNotificationRequestBase {
+    type: 'password_changed';
+}
+export declare type CreateNotificationRequest = CreateNotificationRequestMessage | CreateNotificationRequestLink | CreateNotificationRequestMeasurementComment | CreateNotificationRequestMeasurementReviewed | CreateNotificationRequestMeasurementPrescriptionExpiry | CreateNotificationRequestActivated | CreateNotificationRequestPasswordChanged;
+export interface NotifTypeDef {
+    name?: string;
+    requiredFields?: Record<string, FieldType>;
+    optionalFields?: Record<string, {
+        fieldType?: FieldType;
+        defaultValue?: string;
+    }>;
+    title?: string;
+    body?: string;
+    combinedBody?: string;
+    pushByDefault?: boolean;
+}
+export declare enum FieldType {
+    STRING = "STRING",
+    NUMBER = "NUMBER",
+    BOOLEAN = "BOOLEAN",
+    OBJECT_ID = "OBJECT_ID",
+    URL = "URL"
+}
+export interface NotificationSettings {
+    id?: ObjectId;
+    key?: string;
+    preferences?: {
+        passwordChanged?: boolean;
+        activated?: boolean;
+        prescriptionExpiry?: boolean;
+        measurementComment?: boolean;
+        measurementReviewed?: boolean;
+        message?: boolean;
+        link?: boolean;
+    };
+    creationTimestamp?: Date;
+    updateTimestamp?: Date;
+}
+export declare type SettingCreation = Required<Pick<NotificationSettings, 'key' | 'preferences'>>;
+export interface NotificationsService {
+    /**
+     * Create a notification
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Create a notification for yourself
+     * `CREATE_NOTIFICATIONS` | `global` | Create a notification for another person
+     * @param requestBody CreateNotificationRequest
+     * @returns Notification
+     */
+    create(requestBody: CreateNotificationRequest, options?: OptionsBase): Promise<Notification>;
+    /**
+     * Retrieve a list of notifications
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | View your own notifications
+     * `VIEW_NOTIFICATIONS` | `global` | View all notifications
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<Notification>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResultWithPager<Notification>>;
+    /**
+     * Request a list of all notifications
+     *
+     * Do not pass in an rql with limit operator!
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | View your own notifications
+     * `VIEW_NOTIFICATIONS` | `global` | View all notifications
+     * @returns Notification[]
+     */
+    findAll(options?: OptionsWithRql): Promise<Notification[]>;
+    /**
+     * Request a list of all notifications
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | View your own notifications
+     * `VIEW_NOTIFICATIONS` | `global` | View all notifications
+     * @returns Notification[]
+     */
+    findAllIterator(options?: OptionsWithRql): FindAllIterator<Notification>;
+    /**
+     * Find By Id
+     * @param id the Id to search for
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Notification | undefined>;
+    /**
+     * Find First
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<Notification | undefined>;
+    /**
+     * Delete notification(s)
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `DELETE_NOTIFICATIONS` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns AffectedRecords
+     */
+    remove(options?: OptionsWithRql): Promise<AffectedRecords>;
+    /**
+     * Mark your notification(s) as viewed
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns AffectedRecords
+     */
+    markAsViewed(options?: OptionsWithRql): Promise<AffectedRecords>;
+    /**
+     * Retrieve the list of notification types
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @returns PagedResult<NotifTypeDef>
+     */
+    getTypes(options?: OptionsBase): Promise<PagedResult<NotifTypeDef>>;
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
+}
+export interface NotificationSettingsServices {
+    /**
+     * Retrieve a list of notifications settings
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | View your own notification settings
+     * `VIEW_NOTIFICATION_SETTINGS` | `global` | View all notification settings
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<Setting>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<NotificationSettings>>;
+    /**
+     * Find By Id
+     * @param id the Id to search for
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<NotificationSettings | undefined>;
+    /**
+     * Find First
+     * @param rql an optional rql string
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<NotificationSettings | undefined>;
+    /**
+     * Update the notification settings for a user
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Update your own notification settings
+     * `UPDATE_NOTIFICATION_SETTINGS` | `global` | Update all notification settings
+     * @param userId The User Id
+     * @param requestBody SettingCreation object
+     * @returns Setting
+     */
+    update(userId: string, requestBody: SettingCreation, options?: OptionsBase): Promise<NotificationSettings>;
+    /**
+     * Delete the notifications settings for a user
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_NOTIFICATION_SETTINGS` | `global` | **Required** for this endpoint
+     * @param userId
+     * @returns AffectedRecords
+     */
+    remove(userId: string, options?: OptionsBase): Promise<AffectedRecords>;
+}
+export {};

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

@@ -0,0 +1,6 @@
+import { AuthHttpClient } from '../../types';
+import { NotificationV2Service } from './types';
+import { NotificationV2UserSettingsService } from './userSettings/types';
+export declare const notificationsV2Service: (httpWithAuth: AuthHttpClient) => NotificationV2Service & {
+    userSettings: NotificationV2UserSettingsService;
+};

package/build/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;