@extrahorizon/javascript-sdk 8.9.0-dev-121-e732d56 → 8.9.0-feat-134-c0f5b9d

package/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [8.9.0]
 
+### Added
+- Added the `exh.tasks.functions` methods `find`, `getByName`, `update`, `enable`, `disable` and `delete`
+- Added a `exh.users.findByEmail` method to find a user by their email address.
+
+### Fixed
+- Corrected the types for the `findFirst` (based) methods to indicate they may return `undefined` when no results are found.
+
 
 ## [8.8.2]
 

package/build/index.cjs.js

@@ -617,6 +617,18 @@ class LocalizationKeyMissingError extends BadRequestError {
 }
 class TemplateFillingError extends BadRequestError {
 }
+class TemplateSyntaxError extends BadRequestError {
+    constructor(apiError) {
+        super(apiError);
+        this.syntaxError = apiError.response.syntaxError;
+    }
+}
+class TemplateResolvingError extends BadRequestError {
+    constructor(apiError) {
+        super(apiError);
+        this.resolveError = apiError.response.resolveError;
+    }
+}
 class MissingRequiredFieldsError extends BadRequestError {
 }
 class InvalidCurrencyForProductPrice extends BadRequestError {
@@ -917,6 +929,8 @@ const ErrorClassMap = {
     801: DefaultLocalizationMissingError,
     1002: LocalizationKeyMissingError,
     1003: TemplateFillingError,
+    1004: TemplateSyntaxError,
+    1005: TemplateResolvingError,
     2605: InvalidTokenError,
     2606: UnauthorizedTokenError,
     2607: TokenNotDeleteableError,
@@ -985,6 +999,16 @@ exports.ApiRequestErrorType = void 0;
     ApiRequestErrorType["RESPONSE"] = "response";
 })(exports.ApiRequestErrorType || (exports.ApiRequestErrorType = {}));
 
+exports.FunctionPermissionMode = void 0;
+(function (FunctionPermissionMode) {
+    /** To execute this function directly the user needs the EXECUTE_TASK_FUNCTION permission */
+    FunctionPermissionMode["PERMISSION_REQUIRED"] = "permissionRequired";
+    /** Every logged in user can execute this function directly */
+    FunctionPermissionMode["ALL_USERS"] = "allUsers";
+    /** The function can be executed even by unauthenticated requests */
+    FunctionPermissionMode["PUBLIC"] = "public";
+})(exports.FunctionPermissionMode || (exports.FunctionPermissionMode = {}));
+
 exports.TaskStatus = void 0;
 (function (TaskStatus) {
     TaskStatus["NEW"] = "new";
@@ -1083,6 +1107,7 @@ exports.GlobalPermissionName = void 0;
     GlobalPermissionName["REMOVE_ROLE_PERMISSION"] = "REMOVE_ROLE_PERMISSION";
     GlobalPermissionName["REMOVE_STAFF"] = "REMOVE_STAFF";
     GlobalPermissionName["RESET_FAILED_LOGIN_ATTEMPTS"] = "RESET_FAILED_LOGIN_ATTEMPTS";
+    GlobalPermissionName["RESOLVE_TEMPLATES"] = "RESOLVE_TEMPLATES";
     GlobalPermissionName["SEND_MAILS"] = "SEND_MAILS";
     GlobalPermissionName["SYNC_PROFILE_GROUPS"] = "SYNC_PROFILE_GROUPS";
     GlobalPermissionName["TRANSFER_PERIOD"] = "TRANSFER_PERIOD";
@@ -1647,6 +1672,7 @@ const FILES_BASE = '/files/v1';
 const TASKS_BASE = '/tasks/v1';
 const CONFIGURATION_BASE = '/configurations/v2';
 const TEMPLATE_BASE = '/templates/v1';
+const TEMPLATES_V2_BASE = '/templates/v2';
 const MAIL_BASE = '/mail/v1';
 const DISPATCHERS_BASE = '/dispatchers/v1';
 const PAYMENTS_BASE = '/payments/v1';
@@ -3543,11 +3569,7 @@ var comments = (client, httpAuth) => ({
     },
     async findById(id, schemaIdOrName, documentId, options) {
         const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
-        const res = await this.find(schemaIdOrName, documentId, {
-            ...options,
-            rql: rqlWithId,
-        });
-        return res.data[0];
+        return await this.findFirst(schemaIdOrName, documentId, { ...options, rql: rqlWithId });
     },
     async findFirst(schemaIdOrName, documentId, options) {
         const res = await this.find(schemaIdOrName, documentId, options);
@@ -3600,8 +3622,7 @@ var documents = (client, httpAuth) => {
         },
         async findById(schemaIdOrName, documentId, options) {
             const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', documentId).build();
-            const res = await this.find(schemaIdOrName, { ...options, rql: rqlWithId });
-            return res.data[0];
+            return await this.findFirst(schemaIdOrName, { ...options, rql: rqlWithId });
         },
         async findFirst(schemaIdOrName, options) {
             const res = await this.find(schemaIdOrName, options);
@@ -3728,13 +3749,11 @@ var schemas = (client, httpAuth) => {
         },
         async findById(id, options) {
             const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
-            const res = await find({ ...options, rql: rqlWithId });
-            return res.data[0];
+            return await this.findFirst({ ...options, rql: rqlWithId });
         },
         async findByName(name, options) {
             const rqlWithName = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('name', name).build();
-            const res = await find({ ...options, rql: rqlWithName });
-            return res.data[0];
+            return await this.findFirst({ ...options, rql: rqlWithName });
         },
         async findFirst(options) {
             const res = await find(options);
@@ -3826,8 +3845,7 @@ var files = (client, httpAuth) => ({
     },
     async findByName(name, options) {
         const rqlWithName = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('name', name).build();
-        const res = await this.find({ ...options, rql: rqlWithName });
-        return res.data[0];
+        return await this.findFirst({ ...options, rql: rqlWithName });
     },
     async findFirst(options) {
         const res = await this.find(options);
@@ -4012,8 +4030,48 @@ var apiRequests = (client, httpAuth) => {
 };
 
 var functions = (client, httpAuth) => ({
+    async find(options) {
+        const response = await client.get(httpAuth, '/functions/', options);
+        return response.data;
+    },
+    async create(body, options) {
+        const response = await client.post(httpAuth, '/functions/', body, {
+            ...options,
+            customKeys: ['environmentVariables'],
+        });
+        return response.data;
+    },
+    async getByName(name, options) {
+        const response = await client.get(httpAuth, `/functions/${name}`, {
+            ...options,
+            customResponseKeys: ['environmentVariables'],
+        });
+        return response.data;
+    },
+    async update(name, body, options) {
+        const response = await client.put(httpAuth, `/functions/${name}`, body, {
+            ...options,
+            customRequestKeys: ['environmentVariables'],
+        });
+        return response.data;
+    },
+    async delete(name, options) {
+        const response = await client.delete(httpAuth, `/functions/${name}`, options);
+        return response.data;
+    },
+    async enable(name, options) {
+        const response = await client.post(httpAuth, `/functions/${name}/enable`, {}, options);
+        return response.data;
+    },
+    async disable(name, options) {
+        const response = await client.post(httpAuth, `/functions/${name}/disable`, {}, options);
+        return response.data;
+    },
     async execute(functionName, data, options) {
-        const response = await client.post(httpAuth, `/functions/${functionName}/execute`, { data }, { ...options, customKeys: ['data', 'result'] });
+        const response = await client.post(httpAuth, `/functions/${functionName}/execute`, { data }, {
+            ...options,
+            customKeys: ['data', 'result'],
+        });
         return response.data;
     },
 });
@@ -4084,8 +4142,7 @@ var tasks = (client, httpAuth) => ({
     },
     async findById(id, options) {
         const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
-        const res = await this.find({ ...options, rql: rqlWithId });
-        return res.data[0];
+        return await this.findFirst({ ...options, rql: rqlWithId });
     },
     async findFirst(options) {
         const res = await this.find(options);
@@ -4260,7 +4317,7 @@ var groupRoles = (client, httpWithAuth) => ({
     },
 });
 
-var health$6 = (userClient, http) => ({
+var health$7 = (userClient, http) => ({
     /**
      * Perform a health check
      * @returns {boolean} success
@@ -4310,6 +4367,10 @@ var users$1 = (userClient, httpWithAuth, http) => {
             const res = await find(options);
             return res.data[0];
         },
+        async findByEmail(email, options) {
+            const rqlWithEmail = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('email', email).build();
+            return await this.findFirst({ ...options, rql: rqlWithEmail });
+        },
         async removeUsers(rql, options) {
             return (await userClient.delete(httpWithAuth, `/${rql}`, options)).data;
         },
@@ -4457,7 +4518,7 @@ const usersService = (httpWithAuth, http) => {
         basePath: USER_BASE,
         transformRequestData: decamelizeRequestData,
     });
-    const healthMethods = health$6(userClient, httpWithAuth);
+    const healthMethods = health$7(userClient, httpWithAuth);
     const usersMethods = users$1(userClient, httpWithAuth, http);
     const groupRolesMethods = groupRoles(userClient, httpWithAuth);
     const globalRolesMethods = globalRoles(userClient, httpWithAuth);
@@ -4587,13 +4648,11 @@ var templates = (client, httpAuth) => ({
     },
     async findById(id, options) {
         const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
-        const res = await this.find({ ...options, rql: rqlWithId });
-        return res.data[0];
+        return await this.findFirst({ ...options, rql: rqlWithId });
     },
     async findByName(name, options) {
         const rqlWithName = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('name', name).build();
-        const res = await this.find({ ...options, rql: rqlWithName });
-        return res.data[0];
+        return await this.findFirst({ ...options, rql: rqlWithName });
     },
     async findFirst(options) {
         const res = await this.find(options);
@@ -4661,34 +4720,37 @@ var mails = (client, httpAuth) => ({
         return result.status === exports.Results.Success;
     },
     async find(options) {
-        return (await client.get(httpAuth, `/${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, {
+        const result = await client.get(httpAuth, `/${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, {
             ...options,
             customResponseKeys: ['data.content'],
-        })).data;
+        });
+        return result.data;
     },
     async findById(id, options) {
         const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
-        const res = await this.find({ ...options, rql: rqlWithId });
-        return res.data[0];
+        return await this.findFirst({ ...options, rql: rqlWithId });
     },
     async findFirst(options) {
         const res = await this.find(options);
         return res.data[0];
     },
     async send(requestBody, options) {
-        return (await client.post(httpAuth, '/', requestBody, {
+        const result = await client.post(httpAuth, '/', requestBody, {
             ...options,
             customKeys: ['content'],
-        })).data;
+        });
+        return result.data;
     },
     async track(trackingHash, options) {
-        return (await client.get(httpAuth, `/${trackingHash}/open`, options)).data;
+        const result = await client.get(httpAuth, `/${trackingHash}/open`, options);
+        return result.data;
     },
     async findOutbound(options) {
-        return (await client.get(httpAuth, `/queued${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, {
+        const result = await client.get(httpAuth, `/queued${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, {
             ...options,
             customResponseKeys: ['data.templateData.content'],
-        })).data;
+        });
+        return result.data;
     },
 });
 
@@ -4838,7 +4900,7 @@ var appStoreSubscriptions = (client, httpAuth) => ({
     },
 });
 
-var health$5 = (client, httpAuth) => ({
+var health$6 = (client, httpAuth) => ({
     /**
      * Check if the service is available
      * @returns true if service is up and running
@@ -4864,8 +4926,7 @@ var orders = (client, httpAuth) => ({
     },
     async findById(id, options) {
         const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
-        const res = await this.find({ ...options, rql: rqlWithId });
-        return res.data[0];
+        return await this.findFirst({ ...options, rql: rqlWithId });
     },
     async findFirst(options) {
         const res = await this.find(options);
@@ -4964,8 +5025,7 @@ var products = (client, httpAuth) => ({
     },
     async findById(id, options) {
         const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
-        const res = await this.find({ ...options, rql: rqlWithId });
-        return res.data[0];
+        return await this.findFirst({ ...options, rql: rqlWithId });
     },
     async findFirst(options) {
         const res = await this.find(options);
@@ -5044,7 +5104,7 @@ const paymentsService = (httpWithAuth) => {
         basePath: PAYMENTS_BASE,
     });
     return {
-        ...health$5(client, httpWithAuth),
+        ...health$6(client, httpWithAuth),
         products: products(client, httpWithAuth),
         orders: orders(client, httpWithAuth),
         subscriptions: subscriptions$1(client, httpWithAuth),
@@ -5066,7 +5126,7 @@ var countries = (client, httpAuth) => ({
     },
 });
 
-var health$4 = (client, http) => ({
+var health$5 = (client, http) => ({
     /**
      * Perform a health check
      * @returns {boolean} success
@@ -5089,8 +5149,7 @@ var localizations = (client, httpAuth) => ({
     },
     async findByKey(key, options) {
         const rqlWithKey = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('key', key).build();
-        const res = await this.find({ ...options, rql: rqlWithKey });
-        return res.data[0];
+        return await this.findFirst({ ...options, rql: rqlWithKey });
     },
     async findFirst(options) {
         const res = await this.find(options);
@@ -5119,7 +5178,7 @@ const localizationsService = (httpWithAuth) => {
         basePath: LOCALIZATIONS_BASE,
     });
     return {
-        ...health$4(client, httpWithAuth),
+        ...health$5(client, httpWithAuth),
         ...localizations(client, httpWithAuth),
         ...countries(client, httpWithAuth),
         ...languages(client, httpWithAuth),
@@ -5144,7 +5203,7 @@ var groups = (client, httpAuth) => ({
     },
 });
 
-var health$3 = (client, httpAuth) => ({
+var health$4 = (client, httpAuth) => ({
     /**
      * Perform a health check for profiles service
      * @returns {boolean} success
@@ -5198,8 +5257,7 @@ var profiles = (client, httpAuth) => ({
     },
     async findById(id, options) {
         const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
-        const res = await this.find({ ...options, rql: rqlWithId });
-        return res.data[0];
+        return await this.findFirst({ ...options, rql: rqlWithId });
     },
     async findFirst(options) {
         const res = await this.find(options);
@@ -5234,14 +5292,14 @@ const profilesService = (httpWithAuth) => {
         basePath: PROFILES_BASE,
     });
     return {
-        ...health$3(client, httpWithAuth),
+        ...health$4(client, httpWithAuth),
         ...profiles(client, httpWithAuth),
         groups: groups(client, httpWithAuth),
         logs: logs(client, httpWithAuth),
     };
 };
 
-var health$2 = (client, http) => ({
+var health$3 = (client, http) => ({
     /**
      * Perform a health check
      * @returns {boolean} success
@@ -5282,8 +5340,7 @@ var notifications = (client, httpAuth) => {
         },
         async findById(id, options) {
             const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
-            const res = await this.find({ ...options, rql: rqlWithId });
-            return res.data[0];
+            return await this.findFirst({ ...options, rql: rqlWithId });
         },
         async findFirst(options) {
             const res = await this.find(options);
@@ -5307,8 +5364,7 @@ var settings = (client, httpAuth) => ({
     },
     async findById(id, options) {
         const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
-        const res = await this.find({ ...options, rql: rqlWithId });
-        return res.data[0];
+        return await this.findFirst({ ...options, rql: rqlWithId });
     },
     async findFirst(options) {
         const res = await this.find(options);
@@ -5328,13 +5384,13 @@ const notificationsService = (httpWithAuth) => {
         transformRequestData: decamelizeRequestData,
     });
     return {
-        ...health$2(client, httpWithAuth),
+        ...health$3(client, httpWithAuth),
         ...notifications(client, httpWithAuth),
         settings: settings(client, httpWithAuth),
     };
 };
 
-var health$1 = (client, http) => ({
+var health$2 = (client, http) => ({
     /**
      * Perform a health check
      * @returns {boolean} success
@@ -5379,8 +5435,7 @@ var notificationsV2 = (client, httpWithAuth) => {
         },
         async findById(notificationId, options) {
             const rqlWithNotificationId = rqlBuilder().eq('id', notificationId).build();
-            const result = await find({ ...options, rql: rqlWithNotificationId });
-            return result.data[0];
+            return await this.findFirst({ ...options, rql: rqlWithNotificationId });
         },
     };
 };
@@ -5430,7 +5485,7 @@ const notificationsV2Service = (httpWithAuth) => {
         basePath: NOTIFICATIONS_V2_BASE,
     });
     return {
-        ...health$1(client, httpWithAuth),
+        ...health$2(client, httpWithAuth),
         ...notificationsV2(client, httpWithAuth),
         userSettings: notificationV2UserSettings(client, httpWithAuth),
     };
@@ -5442,8 +5497,7 @@ var events = (client, httpAuth) => ({
     },
     async findById(id, options) {
         const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
-        const res = await this.find({ ...options, rql: rqlWithId });
-        return res.data[0];
+        return await this.findFirst({ ...options, rql: rqlWithId });
     },
     async findFirst(options) {
         const res = await this.find(options);
@@ -5459,7 +5513,7 @@ var events = (client, httpAuth) => ({
     },
 });
 
-var health = (client, http) => ({
+var health$1 = (client, http) => ({
     /**
      * Perform a health check
      * @returns {boolean} success
@@ -5477,8 +5531,7 @@ var subscriptions = (client, httpAuth) => ({
     },
     async findById(id, options) {
         const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', id).build();
-        const res = await this.find({ ...options, rql: rqlWithId });
-        return res.data[0];
+        return await this.findFirst({ ...options, rql: rqlWithId });
     },
     async findFirst(options) {
         const res = await this.find(options);
@@ -5496,7 +5549,7 @@ const eventsService = (httpWithAuth) => {
         transformRequestData: decamelizeRequestData,
     });
     return {
-        ...health(client, httpWithAuth),
+        ...health$1(client, httpWithAuth),
         ...events(client, httpWithAuth),
         subscriptions: subscriptions(client, httpWithAuth),
     };
@@ -5528,7 +5581,87 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.9.0-dev-121-e732d56';
+var health = (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 templatesV2 = (client, httpWithAuth) => {
+    async function find(options) {
+        const result = await client.get(httpWithAuth, `/${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, {
+            ...options,
+            customResponseKeys: ['data.properties', 'data.outputs'],
+        });
+        return result.data;
+    }
+    return {
+        async create(requestBody, options) {
+            const result = (await client.post(httpWithAuth, '/', requestBody, {
+                ...options,
+                customKeys: ['properties', 'outputs'],
+            }));
+            return result.data;
+        },
+        async update(templateId, requestBody, options) {
+            const result = (await client.put(httpWithAuth, `/${templateId}`, requestBody, {
+                ...options,
+                customKeys: ['properties', 'outputs'],
+            }));
+            return result.data;
+        },
+        async remove(templateId, options) {
+            const result = (await client.delete(httpWithAuth, `/${templateId}`, options));
+            return result.data;
+        },
+        async resolve(templateId, requestBody, options) {
+            const result = (await client.post(httpWithAuth, `/${templateId}/resolve`, requestBody, {
+                ...options,
+                customRequestKeys: ['data'],
+                customResponseKeys: ['*'],
+            }));
+            return result.data;
+        },
+        async find(options) {
+            const result = await find(options);
+            return addPagersFn(find, options, result);
+        },
+        async findAll(options) {
+            return findAllGeneric(find, options);
+        },
+        async findById(templateId, options) {
+            const rqlWithId = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('id', templateId).build();
+            const result = await find({ ...options, rql: rqlWithId });
+            return result.data[0];
+        },
+        async findByName(name, options) {
+            const rqlWithName = rqlBuilder(options === null || options === void 0 ? void 0 : options.rql).eq('name', name).build();
+            const result = await find({ ...options, rql: rqlWithName });
+            return result.data[0];
+        },
+        async findFirst(options) {
+            const result = await find(options);
+            return result.data[0];
+        },
+    };
+};
+
+const templatesV2Service = (httpWithAuth) => {
+    const client = httpClient({
+        basePath: TEMPLATES_V2_BASE,
+    });
+    return {
+        ...health(client, httpWithAuth),
+        ...templatesV2(client, httpWithAuth),
+    };
+};
+
+const version = '8.9.0-feat-134-c0f5b9d';
 
 /**
  * Create ExtraHorizon client.
@@ -5561,6 +5694,7 @@ function createClient(rawConfig) {
         files: filesService(httpWithAuth),
         tasks: tasksService(httpWithAuth),
         templates: templatesService(httpWithAuth),
+        templatesV2: templatesV2Service(httpWithAuth),
         mails: mailsService(httpWithAuth),
         configurations: configurationsService(httpWithAuth),
         dispatchers: dispatchersService(httpWithAuth),
@@ -5798,6 +5932,8 @@ exports.StatusInUseError = StatusInUseError;
 exports.StripePaymentMethodError = StripePaymentMethodError;
 exports.StripeRequestError = StripeRequestError;
 exports.TemplateFillingError = TemplateFillingError;
+exports.TemplateResolvingError = TemplateResolvingError;
+exports.TemplateSyntaxError = TemplateSyntaxError;
 exports.TokenNotDeleteableError = TokenNotDeleteableError;
 exports.TooManyFailedAttemptsError = TooManyFailedAttemptsError;
 exports.UnauthorizedClientError = UnauthorizedClientError;