@extrahorizon/javascript-sdk 8.9.0-dev-122-b59ec47 → 8.9.0-feat-134-c0f5b9d

package/build/types/mockType.d.ts

@@ -8,6 +8,7 @@ export declare type MockClientOAuth1<MockFn> = {
         findAll: MockFn;
         findAllIterator: MockFn;
         findFirst: MockFn;
+        findByEmail: MockFn;
         removeUsers: MockFn;
         patients: MockFn;
         staff: MockFn;
@@ -181,6 +182,13 @@ export declare type MockClientOAuth1<MockFn> = {
             findFirst: MockFn;
         };
         functions: {
+            find: MockFn;
+            create: MockFn;
+            getByName: MockFn;
+            update: MockFn;
+            delete: MockFn;
+            enable: MockFn;
+            disable: MockFn;
             execute: MockFn;
         };
         api: {
@@ -221,6 +229,18 @@ export declare type MockClientOAuth1<MockFn> = {
         resolveAsJson: MockFn;
         resolveAsJsonUsingCode: MockFn;
     };
+    templatesV2: {
+        health: MockFn;
+        create: MockFn;
+        update: MockFn;
+        remove: MockFn;
+        resolve: MockFn;
+        find: MockFn;
+        findAll: MockFn;
+        findById: MockFn;
+        findByName: MockFn;
+        findFirst: MockFn;
+    };
     mails: {
         health: MockFn;
         find: MockFn;
@@ -561,6 +581,7 @@ export declare type MockClientOAuth2<MockFn> = {
         findAll: MockFn;
         findAllIterator: MockFn;
         findFirst: MockFn;
+        findByEmail: MockFn;
         removeUsers: MockFn;
         patients: MockFn;
         staff: MockFn;
@@ -734,6 +755,13 @@ export declare type MockClientOAuth2<MockFn> = {
             findFirst: MockFn;
         };
         functions: {
+            find: MockFn;
+            create: MockFn;
+            getByName: MockFn;
+            update: MockFn;
+            delete: MockFn;
+            enable: MockFn;
+            disable: MockFn;
             execute: MockFn;
         };
         api: {
@@ -774,6 +802,18 @@ export declare type MockClientOAuth2<MockFn> = {
         resolveAsJson: MockFn;
         resolveAsJsonUsingCode: MockFn;
     };
+    templatesV2: {
+        health: MockFn;
+        create: MockFn;
+        update: MockFn;
+        remove: MockFn;
+        resolve: MockFn;
+        find: MockFn;
+        findAll: MockFn;
+        findById: MockFn;
+        findByName: MockFn;
+        findFirst: MockFn;
+    };
     mails: {
         health: MockFn;
         find: MockFn;
@@ -1114,6 +1154,7 @@ export declare type MockClientProxy<MockFn> = {
         findAll: MockFn;
         findAllIterator: MockFn;
         findFirst: MockFn;
+        findByEmail: MockFn;
         removeUsers: MockFn;
         patients: MockFn;
         staff: MockFn;
@@ -1287,6 +1328,13 @@ export declare type MockClientProxy<MockFn> = {
             findFirst: MockFn;
         };
         functions: {
+            find: MockFn;
+            create: MockFn;
+            getByName: MockFn;
+            update: MockFn;
+            delete: MockFn;
+            enable: MockFn;
+            disable: MockFn;
             execute: MockFn;
         };
         api: {
@@ -1327,6 +1375,18 @@ export declare type MockClientProxy<MockFn> = {
         resolveAsJson: MockFn;
         resolveAsJsonUsingCode: MockFn;
     };
+    templatesV2: {
+        health: MockFn;
+        create: MockFn;
+        update: MockFn;
+        remove: MockFn;
+        resolve: MockFn;
+        find: MockFn;
+        findAll: MockFn;
+        findById: MockFn;
+        findByName: MockFn;
+        findFirst: MockFn;
+    };
     mails: {
         health: MockFn;
         find: MockFn;

package/build/types/services/auth/applications/types.d.ts

@@ -48,7 +48,7 @@ export interface AuthApplicationsService {
      *
      * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
      * */
-    findFirst(options?: OptionsWithRql): Promise<OAuth1Application | OAuth2Application>;
+    findFirst(options?: OptionsWithRql): Promise<(OAuth1Application | OAuth2Application) | undefined>;
     /**
      * ## Get an application by its id
      * Gets the application currently registered in the cluster by its id.
@@ -65,7 +65,7 @@ export interface AuthApplicationsService {
      *
      * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
      * */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<OAuth1Application | OAuth2Application>;
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<(OAuth1Application | OAuth2Application) | undefined>;
     /**
      * ## Get an application by its name
      * Gets the application currently registered in the cluster by its name.
@@ -82,7 +82,7 @@ export interface AuthApplicationsService {
      *
      * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
      * */
-    findByName(name: string, options?: OptionsWithRql): Promise<OAuth1Application | OAuth2Application>;
+    findByName(name: string, options?: OptionsWithRql): Promise<(OAuth1Application | OAuth2Application) | undefined>;
     /**
      * @deprecated Use `find` instead
      *

package/build/types/services/auth/oauth1/types.d.ts

@@ -62,7 +62,7 @@ export interface AuthOauth1TokenService {
      * none | | Can only see a list of OAuth1 tokens for this account
      * VIEW_AUTHORIZATIONS | global | Can see a list of OAuth1 tokens for any account
      */
-    findFirst(options?: OptionsWithRql): Promise<OAuth1Token>;
+    findFirst(options?: OptionsWithRql): Promise<OAuth1Token | undefined>;
     /**
      * Get an oAuth1 token by its id
      *
@@ -71,7 +71,7 @@ export interface AuthOauth1TokenService {
      * none | | Can only see a list of OAuth1 tokens for this account
      * VIEW_AUTHORIZATIONS | global | Can see a list of OAuth1 tokens for any account
      */
-    findById(id: string, options?: OptionsWithRql): Promise<OAuth1Token>;
+    findById(id: string, options?: OptionsWithRql): Promise<OAuth1Token | undefined>;
     /**
      * Remove a token
      *

package/build/types/services/auth/oauth2/types.d.ts

@@ -51,7 +51,7 @@ export interface AuthOauth2TokenService {
      * none | | Can only see a list of OAuth2 tokens for this account
      * VIEW_AUTHORIZATIONS | global | Can see a list of OAuth2 tokens for any account
      */
-    findFirst(options?: OptionsWithRql): Promise<OAuth2Token>;
+    findFirst(options?: OptionsWithRql): Promise<OAuth2Token | undefined>;
     /**
      * Get an oAuth2 token by its id
      *
@@ -60,7 +60,7 @@ export interface AuthOauth2TokenService {
      * none | | Can only see a list of OAuth2 tokens for this account
      * VIEW_AUTHORIZATIONS | global | Can see a list of OAuth2 tokens for any account
      */
-    findById(id: string, options?: OptionsWithRql): Promise<OAuth2Token>;
+    findById(id: string, options?: OptionsWithRql): Promise<OAuth2Token | undefined>;
     /**
      * Remove an oAuth2 token
      *

package/build/types/services/auth/oidc/loginAttempts/types.d.ts

@@ -37,7 +37,7 @@ export interface LoginAttemptsService {
      * @param options {@link OptionsWithRql} - Add filters to the requested list
      * @returns The first element of the queried login attempts {@link LoginAttempt}
      */
-    findFirst(options?: OptionsWithRql): Promise<LoginAttempt>;
+    findFirst(options?: OptionsWithRql): Promise<LoginAttempt | undefined>;
 }
 export declare enum LoginAttemptStatus {
     SUCCESS = "success",

package/build/types/services/auth/oidc/providers/types.d.ts

@@ -54,7 +54,7 @@ export interface OidcProviderService {
      * @returns The first element of the queried providers {@link OidcProvider}
      * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
      */
-    findFirst(options?: OptionsWithRql): Promise<OidcProvider>;
+    findFirst(options?: OptionsWithRql): Promise<OidcProvider | undefined>;
     /**
      * ## Update an OpenID Connect provider
      * ### You can use this function to update an existing OpenId Connect Provider. Fields left undefined will not be updated.

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

@@ -329,14 +329,14 @@ export interface DataCommentsService {
      * @param documentId The id of the targeted document.
      * @returns the first element found
      */
-    findById(id: ObjectId, schemaIdOrName: ObjectId | string, documentId: ObjectId, options?: OptionsWithRql): Promise<Comment>;
+    findById(id: ObjectId, schemaIdOrName: ObjectId | string, documentId: ObjectId, options?: OptionsWithRql): Promise<Comment | undefined>;
     /**
      * Find First
      * @param schemaIdOrName The id or name of the targeted schema.
      * @param documentId The id of the targeted document.
      * @returns the first element found
      */
-    findFirst(schemaIdOrName: ObjectId | string, documentId: ObjectId, options?: OptionsWithRql): Promise<Comment>;
+    findFirst(schemaIdOrName: ObjectId | string, documentId: ObjectId, options?: OptionsWithRql): Promise<Comment | undefined>;
     /**
      * Update a comment
      *
@@ -1345,18 +1345,18 @@ export interface DataSchemasService {
      * @param id the Id to search for
      * @returns the first element found
      */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<Schema>;
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Schema | undefined>;
     /**
      * Find By Name
      * @param name the name to search for
      * @returns the first element found
      */
-    findByName(name: string, options?: OptionsWithRql): Promise<Schema>;
+    findByName(name: string, options?: OptionsWithRql): Promise<Schema | undefined>;
     /**
      * Find First
      * @returns the first element found
      */
-    findFirst(options?: OptionsWithRql): Promise<Schema>;
+    findFirst(options?: OptionsWithRql): Promise<Schema | undefined>;
     /**
      * Update a schema
      *

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

@@ -52,7 +52,7 @@ export interface DispatchersService {
      * @param options {@link OptionsWithRql} - Add filters to the requested list
      * @returns The first element of the queried Dispatchers {@link Dispatcher}
      */
-    findFirst(options?: OptionsWithRql): Promise<Dispatcher>;
+    findFirst(options?: OptionsWithRql): Promise<Dispatcher | undefined>;
     /**
      * ## Create a Dispatcher
      *

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

@@ -42,13 +42,13 @@ export interface EventsService {
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<Event>;
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Event | undefined>;
     /**
      * Find First
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findFirst(options?: OptionsWithRql): Promise<Event>;
+    findFirst(options?: OptionsWithRql): Promise<Event | undefined>;
     /**
      * Creates an event
      *
@@ -80,13 +80,13 @@ export interface SubscriptionsService {
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<Subscription>;
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Subscription | undefined>;
     /**
      * Find First
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findFirst(options?: OptionsWithRql): Promise<Subscription>;
+    findFirst(options?: OptionsWithRql): Promise<Subscription | undefined>;
     /**
      * @deprecated Should not be used, services manage subscriptions themselves
      *

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

@@ -55,13 +55,13 @@ export interface FilesService {
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findByName(name: string, options?: OptionsWithRql): Promise<FileDetails>;
+    findByName(name: string, options?: OptionsWithRql): Promise<FileDetails | undefined>;
     /**
      * Find First
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findFirst(options?: OptionsWithRql): Promise<FileDetails>;
+    findFirst(options?: OptionsWithRql): Promise<FileDetails | undefined>;
     /**
      * ## Add a new file from a plain text source
      *

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

@@ -92,13 +92,13 @@ export interface LocalizationsService {
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findByKey(key: string, options?: OptionsWithRql): Promise<Localization>;
+    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>;
+    findFirst(options?: OptionsWithRql): Promise<Localization | undefined>;
     /**
      * Create new localizations
      *

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

@@ -17,11 +17,11 @@ export interface LogsAccessService {
      * @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>;
+    findFirst(options?: OptionsWithRql): Promise<AccessLog | undefined>;
 }
 export interface AccessLog {
     /** The time of request receival */
-    timestamp: string;
+    timestamp: Date;
     /** The status code of the response for the request */
     httpStatus: number;
     /** The duration of the request in seconds */

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

@@ -1,27 +1,31 @@
-import { ObjectId, LanguageCode, MailAddress, MailAddressList, MailRecipients, AffectedRecords, PagedResult, OptionsBase, OptionsWithRql } from '../types';
+import { ObjectId, LanguageCode, MailAddress, MailAddressList, MailRecipients, AffectedRecords, PagedResult, OptionsBase, OptionsWithRql, TimeZone } from '../types';
 export interface Mail {
-    id?: ObjectId;
+    id: ObjectId;
     creatorId?: ObjectId;
     awsMessageId?: ObjectId;
-    subject?: string;
-    recipients?: MailRecipients;
+    subject: string;
+    recipients: MailRecipients;
     templateId?: ObjectId;
+    templateName?: string;
     replyTo?: MailAddressList;
-    from?: MailAddress;
+    from: MailAddress;
     body?: string;
     language?: LanguageCode;
+    timeZone?: TimeZone;
     content?: Record<string, any>;
-    views?: number;
-    creationTimestamp?: Date;
-    updateTimestamp?: Date;
+    views: number;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
 }
 export declare type PlainMailCreation = {
     subject: string;
     body: string;
 } & CommonMailCreationProperties;
 export declare type TemplateBasedMailCreation = {
-    templateId: ObjectId;
+    templateId?: ObjectId;
+    templateName?: string;
     language?: LanguageCode;
+    timeZone?: TimeZone;
     content: Record<string, any>;
 } & CommonMailCreationProperties;
 export interface CommonMailCreationProperties {
@@ -42,9 +46,9 @@ export interface Attachment {
     type?: string;
 }
 export interface QueuedMail {
-    id?: ObjectId;
-    status?: QueuedMailStatus;
-    from?: string;
+    id: ObjectId;
+    status: QueuedMailStatus;
+    from: string;
     to?: MailAddressList;
     cc?: MailAddressList;
     bcc?: MailAddressList;
@@ -57,14 +61,18 @@ export interface QueuedMail {
     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;
@@ -98,13 +106,13 @@ export interface MailsService {
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findById: (id: ObjectId, options?: OptionsWithRql) => Promise<Mail>;
+    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>;
+    findFirst(options?: OptionsWithRql): Promise<Mail | undefined>;
     /**
      * Send a mail
      *

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

@@ -142,13 +142,13 @@ export interface NotificationsService {
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<Notification>;
+    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>;
+    findFirst(options?: OptionsWithRql): Promise<Notification | undefined>;
     /**
      * Delete notification(s)
      *
@@ -197,13 +197,13 @@ export interface NotificationSettingsServices {
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<NotificationSettings>;
+    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>;
+    findFirst(options?: OptionsWithRql): Promise<NotificationSettings | undefined>;
     /**
      * Update the notification settings for a user
      *

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

@@ -585,13 +585,13 @@ export interface PaymentsOrdersService {
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<OrderSchema>;
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<OrderSchema | undefined>;
     /**
      * Find First
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findFirst(options?: OptionsWithRql): Promise<OrderSchema>;
+    findFirst(options?: OptionsWithRql): Promise<OrderSchema | undefined>;
     /**
      * Create an order
      * @param requestBody
@@ -684,13 +684,13 @@ export interface PaymentsProductsService {
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<ProductSchema>;
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<ProductSchema | undefined>;
     /**
      * Find First
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findFirst(options?: OptionsWithRql): Promise<ProductSchema>;
+    findFirst(options?: OptionsWithRql): Promise<ProductSchema | undefined>;
     /**
      * Add Tags to a Product
      *

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

@@ -300,13 +300,13 @@ export interface ProfilesService {
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<Profile>;
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Profile | undefined>;
     /**
      * Find First
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findFirst(options?: OptionsWithRql): Promise<Profile>;
+    findFirst(options?: OptionsWithRql): Promise<Profile | undefined>;
     /**
      * Create a new profile
      *

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

@@ -21,5 +21,5 @@ export interface ApiRequestLogsService {
      * @param apiRequestId {@link string} The id of the targeted API Request
      * @param options {@link OptionsWithRql} - Additional options for the request
      * @returns The first element of the queried API Request logs {@link LogLine}     */
-    findFirst(apiRequestId: ObjectId, options?: OptionsWithRql): Promise<LogLine>;
+    findFirst(apiRequestId: ObjectId, options?: OptionsWithRql): Promise<LogLine | undefined>;
 }

package/build/types/services/tasks/apiRequests/types.d.ts

@@ -39,7 +39,7 @@ export interface ApiRequestService {
      * @param options {@link OptionsWithRql} - Add filters to the requested list
      * @returns The first element of the queried API Requests {@link ApiRequest}
      */
-    findFirst(options?: OptionsWithRql): Promise<ApiRequest>;
+    findFirst(options?: OptionsWithRql): Promise<ApiRequest | undefined>;
     logs: ApiRequestLogsService;
 }
 export interface ApiRequest {