@extrahorizon/javascript-sdk 8.9.0-dev-136-24be1b9 → 8.9.0-dev-138-3022f93

package/build/types/mockType.d.ts

@@ -1,6 +1,5 @@
 export declare type MockClientOAuth1<MockFn> = {
     users: {
-        health: MockFn;
         me: MockFn;
         findById: MockFn;
         update: MockFn;
@@ -31,6 +30,7 @@ export declare type MockClientOAuth1<MockFn> = {
         updatePasswordPolicy: MockFn;
         getEmailTemplates: MockFn;
         setEmailTemplates: MockFn;
+        health: MockFn;
         groupRoles: {
             getPermissions: MockFn;
             find: MockFn;
@@ -175,6 +175,7 @@ export declare type MockClientOAuth1<MockFn> = {
         cancel: MockFn;
         schedules: {
             create: MockFn;
+            remove: MockFn;
             delete: MockFn;
             find: MockFn;
             findAll: MockFn;
@@ -182,6 +183,13 @@ export declare type MockClientOAuth1<MockFn> = {
             findFirst: MockFn;
         };
         functions: {
+            find: MockFn;
+            create: MockFn;
+            getByName: MockFn;
+            update: MockFn;
+            remove: MockFn;
+            enable: MockFn;
+            disable: MockFn;
             execute: MockFn;
         };
         api: {
@@ -223,7 +231,6 @@ export declare type MockClientOAuth1<MockFn> = {
         resolveAsJsonUsingCode: MockFn;
     };
     templatesV2: {
-        health: MockFn;
         create: MockFn;
         update: MockFn;
         remove: MockFn;
@@ -233,6 +240,7 @@ export declare type MockClientOAuth1<MockFn> = {
         findById: MockFn;
         findByName: MockFn;
         findFirst: MockFn;
+        health: MockFn;
     };
     mails: {
         health: MockFn;
@@ -382,7 +390,6 @@ export declare type MockClientOAuth1<MockFn> = {
         };
     };
     localizations: {
-        health: MockFn;
         find: MockFn;
         findByKey: MockFn;
         findFirst: MockFn;
@@ -390,12 +397,12 @@ export declare type MockClientOAuth1<MockFn> = {
         update: MockFn;
         remove: MockFn;
         getByKeys: MockFn;
+        health: MockFn;
         getCountries: MockFn;
         getRegions: MockFn;
         getLanguages: MockFn;
     };
     profiles: {
-        health: MockFn;
         find: MockFn;
         findAll: MockFn;
         findAllIterator: MockFn;
@@ -406,6 +413,7 @@ export declare type MockClientOAuth1<MockFn> = {
         removeFields: MockFn;
         getComorbidities: MockFn;
         getImpediments: MockFn;
+        health: MockFn;
         groups: {
             create: MockFn;
             update: MockFn;
@@ -422,7 +430,6 @@ export declare type MockClientOAuth1<MockFn> = {
         };
     };
     notifications: {
-        health: MockFn;
         create: MockFn;
         find: MockFn;
         findAll: MockFn;
@@ -432,6 +439,7 @@ export declare type MockClientOAuth1<MockFn> = {
         remove: MockFn;
         markAsViewed: MockFn;
         getTypes: MockFn;
+        health: MockFn;
         settings: {
             find: MockFn;
             findById: MockFn;
@@ -441,13 +449,13 @@ export declare type MockClientOAuth1<MockFn> = {
         };
     };
     notificationsV2: {
-        health: MockFn;
         create: MockFn;
         find: MockFn;
         findAll: MockFn;
         findByTargetUserId: MockFn;
         findFirst: MockFn;
         findById: MockFn;
+        health: MockFn;
         userSettings: {
             getById: MockFn;
             update: MockFn;
@@ -460,11 +468,11 @@ export declare type MockClientOAuth1<MockFn> = {
         };
     };
     events: {
-        health: MockFn;
         find: MockFn;
         findById: MockFn;
         findFirst: MockFn;
         create: MockFn;
+        health: MockFn;
         subscriptions: {
             find: MockFn;
             findById: MockFn;
@@ -534,6 +542,7 @@ export declare type MockClientOAuth1<MockFn> = {
                 update: MockFn;
                 enable: MockFn;
                 disable: MockFn;
+                remove: MockFn;
                 delete: MockFn;
             };
             loginAttempts: {
@@ -566,7 +575,6 @@ export declare type MockClientOAuth1<MockFn> = {
 };
 export declare type MockClientOAuth2<MockFn> = {
     users: {
-        health: MockFn;
         me: MockFn;
         findById: MockFn;
         update: MockFn;
@@ -597,6 +605,7 @@ export declare type MockClientOAuth2<MockFn> = {
         updatePasswordPolicy: MockFn;
         getEmailTemplates: MockFn;
         setEmailTemplates: MockFn;
+        health: MockFn;
         groupRoles: {
             getPermissions: MockFn;
             find: MockFn;
@@ -741,6 +750,7 @@ export declare type MockClientOAuth2<MockFn> = {
         cancel: MockFn;
         schedules: {
             create: MockFn;
+            remove: MockFn;
             delete: MockFn;
             find: MockFn;
             findAll: MockFn;
@@ -748,6 +758,13 @@ export declare type MockClientOAuth2<MockFn> = {
             findFirst: MockFn;
         };
         functions: {
+            find: MockFn;
+            create: MockFn;
+            getByName: MockFn;
+            update: MockFn;
+            remove: MockFn;
+            enable: MockFn;
+            disable: MockFn;
             execute: MockFn;
         };
         api: {
@@ -789,7 +806,6 @@ export declare type MockClientOAuth2<MockFn> = {
         resolveAsJsonUsingCode: MockFn;
     };
     templatesV2: {
-        health: MockFn;
         create: MockFn;
         update: MockFn;
         remove: MockFn;
@@ -799,6 +815,7 @@ export declare type MockClientOAuth2<MockFn> = {
         findById: MockFn;
         findByName: MockFn;
         findFirst: MockFn;
+        health: MockFn;
     };
     mails: {
         health: MockFn;
@@ -948,7 +965,6 @@ export declare type MockClientOAuth2<MockFn> = {
         };
     };
     localizations: {
-        health: MockFn;
         find: MockFn;
         findByKey: MockFn;
         findFirst: MockFn;
@@ -956,12 +972,12 @@ export declare type MockClientOAuth2<MockFn> = {
         update: MockFn;
         remove: MockFn;
         getByKeys: MockFn;
+        health: MockFn;
         getCountries: MockFn;
         getRegions: MockFn;
         getLanguages: MockFn;
     };
     profiles: {
-        health: MockFn;
         find: MockFn;
         findAll: MockFn;
         findAllIterator: MockFn;
@@ -972,6 +988,7 @@ export declare type MockClientOAuth2<MockFn> = {
         removeFields: MockFn;
         getComorbidities: MockFn;
         getImpediments: MockFn;
+        health: MockFn;
         groups: {
             create: MockFn;
             update: MockFn;
@@ -988,7 +1005,6 @@ export declare type MockClientOAuth2<MockFn> = {
         };
     };
     notifications: {
-        health: MockFn;
         create: MockFn;
         find: MockFn;
         findAll: MockFn;
@@ -998,6 +1014,7 @@ export declare type MockClientOAuth2<MockFn> = {
         remove: MockFn;
         markAsViewed: MockFn;
         getTypes: MockFn;
+        health: MockFn;
         settings: {
             find: MockFn;
             findById: MockFn;
@@ -1007,13 +1024,13 @@ export declare type MockClientOAuth2<MockFn> = {
         };
     };
     notificationsV2: {
-        health: MockFn;
         create: MockFn;
         find: MockFn;
         findAll: MockFn;
         findByTargetUserId: MockFn;
         findFirst: MockFn;
         findById: MockFn;
+        health: MockFn;
         userSettings: {
             getById: MockFn;
             update: MockFn;
@@ -1026,11 +1043,11 @@ export declare type MockClientOAuth2<MockFn> = {
         };
     };
     events: {
-        health: MockFn;
         find: MockFn;
         findById: MockFn;
         findFirst: MockFn;
         create: MockFn;
+        health: MockFn;
         subscriptions: {
             find: MockFn;
             findById: MockFn;
@@ -1100,6 +1117,7 @@ export declare type MockClientOAuth2<MockFn> = {
                 update: MockFn;
                 enable: MockFn;
                 disable: MockFn;
+                remove: MockFn;
                 delete: MockFn;
             };
             loginAttempts: {
@@ -1132,7 +1150,6 @@ export declare type MockClientOAuth2<MockFn> = {
 };
 export declare type MockClientProxy<MockFn> = {
     users: {
-        health: MockFn;
         me: MockFn;
         findById: MockFn;
         update: MockFn;
@@ -1163,6 +1180,7 @@ export declare type MockClientProxy<MockFn> = {
         updatePasswordPolicy: MockFn;
         getEmailTemplates: MockFn;
         setEmailTemplates: MockFn;
+        health: MockFn;
         groupRoles: {
             getPermissions: MockFn;
             find: MockFn;
@@ -1307,6 +1325,7 @@ export declare type MockClientProxy<MockFn> = {
         cancel: MockFn;
         schedules: {
             create: MockFn;
+            remove: MockFn;
             delete: MockFn;
             find: MockFn;
             findAll: MockFn;
@@ -1314,6 +1333,13 @@ export declare type MockClientProxy<MockFn> = {
             findFirst: MockFn;
         };
         functions: {
+            find: MockFn;
+            create: MockFn;
+            getByName: MockFn;
+            update: MockFn;
+            remove: MockFn;
+            enable: MockFn;
+            disable: MockFn;
             execute: MockFn;
         };
         api: {
@@ -1355,7 +1381,6 @@ export declare type MockClientProxy<MockFn> = {
         resolveAsJsonUsingCode: MockFn;
     };
     templatesV2: {
-        health: MockFn;
         create: MockFn;
         update: MockFn;
         remove: MockFn;
@@ -1365,6 +1390,7 @@ export declare type MockClientProxy<MockFn> = {
         findById: MockFn;
         findByName: MockFn;
         findFirst: MockFn;
+        health: MockFn;
     };
     mails: {
         health: MockFn;
@@ -1514,7 +1540,6 @@ export declare type MockClientProxy<MockFn> = {
         };
     };
     localizations: {
-        health: MockFn;
         find: MockFn;
         findByKey: MockFn;
         findFirst: MockFn;
@@ -1522,12 +1547,12 @@ export declare type MockClientProxy<MockFn> = {
         update: MockFn;
         remove: MockFn;
         getByKeys: MockFn;
+        health: MockFn;
         getCountries: MockFn;
         getRegions: MockFn;
         getLanguages: MockFn;
     };
     profiles: {
-        health: MockFn;
         find: MockFn;
         findAll: MockFn;
         findAllIterator: MockFn;
@@ -1538,6 +1563,7 @@ export declare type MockClientProxy<MockFn> = {
         removeFields: MockFn;
         getComorbidities: MockFn;
         getImpediments: MockFn;
+        health: MockFn;
         groups: {
             create: MockFn;
             update: MockFn;
@@ -1554,7 +1580,6 @@ export declare type MockClientProxy<MockFn> = {
         };
     };
     notifications: {
-        health: MockFn;
         create: MockFn;
         find: MockFn;
         findAll: MockFn;
@@ -1564,6 +1589,7 @@ export declare type MockClientProxy<MockFn> = {
         remove: MockFn;
         markAsViewed: MockFn;
         getTypes: MockFn;
+        health: MockFn;
         settings: {
             find: MockFn;
             findById: MockFn;
@@ -1573,13 +1599,13 @@ export declare type MockClientProxy<MockFn> = {
         };
     };
     notificationsV2: {
-        health: MockFn;
         create: MockFn;
         find: MockFn;
         findAll: MockFn;
         findByTargetUserId: MockFn;
         findFirst: MockFn;
         findById: MockFn;
+        health: MockFn;
         userSettings: {
             getById: MockFn;
             update: MockFn;
@@ -1592,11 +1618,11 @@ export declare type MockClientProxy<MockFn> = {
         };
     };
     events: {
-        health: MockFn;
         find: MockFn;
         findById: MockFn;
         findFirst: MockFn;
         create: MockFn;
+        health: MockFn;
         subscriptions: {
             find: MockFn;
             findById: MockFn;
@@ -1666,6 +1692,7 @@ export declare type MockClientProxy<MockFn> = {
                 update: MockFn;
                 enable: MockFn;
                 disable: MockFn;
+                remove: MockFn;
                 delete: MockFn;
             };
             loginAttempts: {

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

@@ -83,6 +83,10 @@ export interface OidcProviderService {
      * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
      * @throws {@link IllegalStateError} when the provider is enabled (Only disabled providers can be removed) or when there are still users linked to this provider.
      */
+    remove(providerId: string): Promise<AffectedRecords>;
+    /**
+     * @deprecated Use `remove` instead.
+     */
     delete(providerId: string): Promise<AffectedRecords>;
     /**
      * ## Enable an OpenID Connect provider

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

@@ -1,6 +1,5 @@
 import type { EventsService, HttpInstance, SubscriptionsService } from '../../types';
-import health from './health';
 import subscriptions from './subscriptions';
-export declare const eventsService: (httpWithAuth: HttpInstance) => ReturnType<typeof health> & EventsService & {
+export declare const eventsService: (httpWithAuth: HttpInstance) => EventsService & {
     subscriptions: SubscriptionsService;
 };

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

@@ -62,6 +62,11 @@ export interface EventsService {
      * @returns Event
      */
     create(requestBody: CreateEvent, options?: CreateEventOptions): Promise<Event>;
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
 }
 export interface SubscriptionsService {
     /**

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

@@ -1,4 +1,3 @@
 import type { HttpInstance } from '../../types';
-import health from './health';
 import { CountriesService, LanguagesService, LocalizationsService } from './types';
-export declare const localizationsService: (httpWithAuth: HttpInstance) => ReturnType<typeof health> & LocalizationsService & CountriesService & LanguagesService;
+export declare const localizationsService: (httpWithAuth: HttpInstance) => LocalizationsService & CountriesService & LanguagesService;

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

@@ -141,5 +141,10 @@ export interface LocalizationsService {
      * @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/types/services/notifications/index.d.ts

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

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

@@ -178,6 +178,11 @@ export interface NotificationsService {
      * @returns PagedResult<NotifTypeDef>
      */
     getTypes(options?: OptionsBase): Promise<PagedResult<NotifTypeDef>>;
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
 }
 export interface NotificationSettingsServices {
     /**

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

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

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

@@ -158,4 +158,9 @@ export interface NotificationV2Service {
      * @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/types/services/profiles/index.d.ts

@@ -1,9 +1,8 @@
 import type { HttpInstance } from '../../types';
 import groups from './groups';
-import health from './health';
 import logs from './logs';
 import { ProfilesGroupsService, ProfilesLogsService, ProfilesService } from './types';
-export declare const profilesService: (httpWithAuth: HttpInstance) => ReturnType<typeof health> & ProfilesService & {
+export declare const profilesService: (httpWithAuth: HttpInstance) => ProfilesService & {
     groups: ProfilesGroupsService;
     logs: ProfilesLogsService;
 };

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

@@ -367,4 +367,9 @@ export interface ProfilesService {
      * @returns PagedResult<Impediments>
      */
     getImpediments(options?: OptionsBase): Promise<PagedResult<Impediments>>;
+    /**
+     * Perform a health check for profiles service
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
 }

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

@@ -1,6 +1,82 @@
-import { OptionsBase } from '../../types';
+import { OptionsBase, type AffectedRecords, type PagedResult } from '../../types';
 import { Task } from '../types';
 export interface FunctionsService {
+    /**
+     * View a list of functions.
+     *
+     * Although this endpoint is a paged-like endpoint, it will return all functions in a single page.
+     * RQL is not supported for this endpoint, and any RQL provided will be ignored.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TASK_FUNCTIONS` | `global` | **Required** for this endpoint
+     */
+    find(options?: OptionsBase): Promise<PagedResult<FunctionBase>>;
+    /**
+     * View a list of functions.
+     *
+     * Although this endpoint is a paged-like endpoint, it will return all functions in a single page.
+     * RQL is not supported for this endpoint, and any RQL provided will be ignored.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TASK_FUNCTIONS` | `global` | **Required** for this endpoint
+     */
+    create(body: FunctionCreation, options?: OptionsBase): Promise<FunctionDetails>;
+    /**
+     * View details of a function by its name.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TASK_FUNCTION_DETAILS` | `global` | **Required** for this endpoint
+     *
+     * @throws {ResourceUnknownError} When no function with the specified name is found
+     */
+    getByName(name: string, options?: OptionsBase): Promise<FunctionDetails>;
+    /**
+     * Update a function by its name.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_TASK_FUNCTION` | `global` | **Required** for this endpoint
+     *
+     * @throws {ResourceUnknownError} When no function with the specified name is found
+     */
+    update(name: string, body: Partial<FunctionCreation>, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Delete a function by its name.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `DELETE_TASK_FUNCTION` | `global` | **Required** for this endpoint
+     *
+     * @throws {ResourceUnknownError} When no function with the specified name is found
+     */
+    remove(name: string, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Enable a function by its name.
+     *
+     * Does nothing if the function is already enabled.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_TASK_FUNCTION` | `global` | **Required** for this endpoint
+     *
+     * @throws {ResourceUnknownError} When no function with the specified name is found
+     */
+    enable(name: string, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Disable a function by its name.
+     *
+     * Does nothing if the function is already disabled.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_TASK_FUNCTION` | `global` | **Required** for this endpoint
+     *
+     * @throws {ResourceUnknownError} When no function with the specified name is found
+     */
+    disable(name: string, options?: OptionsBase): Promise<AffectedRecords>;
     /**
      * ## Execute a Function directly
      *
@@ -21,6 +97,74 @@ export interface FunctionsService {
      */
     execute<T = any, U = any>(functionName: string, data?: U, options?: OptionsBase): Promise<DirectExecutionResponse<T, U>>;
 }
+export interface FunctionBase {
+    /** The name of the Function */
+    name: string;
+    /** A description of the Function */
+    description: string;
+    /** The timestamp when the Function was last updated */
+    updateTimestamp: Date;
+}
+export interface FunctionCreation {
+    /** The name of the Function, this serves as the unique identifier amongst all Functions */
+    name: string;
+    /** A description of the Function */
+    description?: string;
+    /** Base64 Encoded binary value of the compressed (.zip) function code */
+    code: string;
+    /** Entry point for execution of the function, e.g. `index.handler` */
+    entryPoint: string;
+    /**
+     * The runtime environment for the Function, e.g. `nodejs24.x`
+     * The supported runtimes can be found in the [task service documentation](https://docs.extrahorizon.com/extrahorizon/services/automation/task-service/functions#runtime)
+     */
+    runtime: string;
+    /**
+     * Maximum execution time (seconds) of the function.
+     * Should be between 3 and 300 seconds, defaults to 30 seconds if not provided.
+     */
+    timeLimit?: number;
+    /**
+     * Memory limit (MB) for the function.
+     * Should be between 128 and 10240, defaults to 128 if not provided.
+     */
+    memoryLimit?: number;
+    /** Environment variables to be made available to the function during execution */
+    environmentVariables?: {
+        [key: string]: {
+            value: string;
+        };
+    };
+    /** Options related to the execution of the function, such as permission an priority */
+    executionOptions?: {
+        /** Defines access for executing the function directly or for invoking it as an API function. */
+        permissionMode?: FunctionPermissionMode;
+        /** The default priority assigned to all tasks created for this function, unless a priority is specified for a task explicitly */
+        defaultPriority?: number;
+    };
+    /** The policy that determines system behavior after the execution of a Function fails. */
+    retryPolicy?: {
+        /**
+         * The retry policy is disabled by default, If this field is set to true, the retry policy becomes active.
+         * If active the policy will retry a maximum of 3 times, with an increasing timeout of 2, 5 and 10 seconds respectively.
+         */
+        enabled: boolean;
+        /** A list of error names that should trigger a retry. If not specified, the default is to retry on all errors. */
+        errorsToRetry: string[];
+    };
+}
+export declare type FunctionDetails = Omit<FunctionCreation, 'code'> & FunctionBase & {
+    /** Indicates whether the function is enabled or disabled for execution/invocation. Enabled by default. */
+    enabled: boolean;
+};
+export declare enum FunctionPermissionMode {
+    /** To execute this function directly the user needs the EXECUTE_TASK_FUNCTION permission */
+    PERMISSION_REQUIRED = "permissionRequired",
+    /** Every logged in user can execute this function directly */
+    ALL_USERS = "allUsers",
+    /** The function can be executed even by unauthenticated requests */
+    PUBLIC = "public"
+}
 export interface DirectExecutionResponse<T, U> extends Task<U> {
     /** The result of the Function execution, this may be user defined */
     result: T;

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

@@ -20,6 +20,10 @@ export interface SchedulesService {
      * @param scheduleId - The id of the schedule to delete
      * @param options - Additional options for the request
      */
+    remove(scheduleId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * @deprecated Use `remove` instead.
+     */
     delete(scheduleId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
     /**
      * ## Retrieve a paged list of schedules