@oneblink/sdk 0.4.4-beta.1 → 0.4.4-beta.2

package/tenants/classes/EmailTemplates.js

@@ -0,0 +1,128 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const one_blink_api_1 = __importDefault(require("../lib/one-blink-api"));
+const basePath = `/email-templates`;
+class EmailTemplates extends one_blink_api_1.default {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const OneBlink = require('@oneblink/sdk')
+     *
+     * const options = {
+     *   accessKey: '123455678901ABCDEFGHIJKL',
+     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     * }
+     * const emailTemplates = new OneBlink.EmailTemplates(options)
+     * ```
+     */
+    constructor(options) {
+        options = options || {};
+        super(options.accessKey, options.secretKey);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const searchParams = {
+     *   limit: 1,
+     *   offset: 0,
+     * }
+     * const { emailTemplates, meta } =
+     *   await emailTemplates.searchEmailTemplates(searchParams)
+     * ```
+     *
+     * @param searchParams Search options
+     */
+    searchEmailTemplates(searchParams) {
+        return super.searchRequest(basePath, searchParams);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const emailTemplate = await emailTemplates.getEmailTemplate(1)
+     * // Use data here...
+     * ```
+     *
+     * @param id The id of the email template
+     */
+    async getEmailTemplate(id) {
+        if (typeof id !== 'number') {
+            throw new TypeError('Must supply "id" as a number');
+        }
+        return super.searchRequest(`${basePath}/${id}`);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const data = {
+     *   name: 'my template',
+     *   organisationId: 'abc123',
+     *   environments: [
+     *     {
+     *       template: 'My email template {{custom:my-custom-tag}}',
+     *       formsAppEnvironmentId: 1,
+     *     },
+     *   ],
+     *   type: 'FORM_SUBMISSION_EVENT_PDF',
+     * }
+     * const emailTemplate = await emailTemplates.createEmailTemplate(data)
+     * // Use emailTemplate here...
+     * ```
+     *
+     * @param data The data for the new email template
+     */
+    async createEmailTemplate(data) {
+        return super.postRequest(basePath, data);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const data = {
+     *   id: 1,
+     *   name: 'my updated template',
+     *   organisationId: 'abc123',
+     *   environments: [
+     *     {
+     *       template: 'My email template {{custom:my-custom-tag}}',
+     *       formsAppEnvironmentId: 1,
+     *     },
+     *   ],
+     *   type: 'FORM_SUBMISSION_EVENT_PDF',
+     * }
+     * const emailTemplate = await emailTemplates.updateEmailTemplate(data)
+     * // Use emailTemplate here...
+     * ```
+     *
+     * @param data The data for the email template to update
+     */
+    async updateEmailTemplate(data) {
+        if (!data || typeof data.id !== 'number') {
+            throw new TypeError('Must supply "EmailTemplate.id" as a number');
+        }
+        return super.putRequest(`${basePath}/${data.id}`, data);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * await emailTemplates.deleteEmailTemplate(1)
+     * ```
+     *
+     * @param id The id of the email template to delete
+     */
+    async deleteEmailTemplate(id) {
+        if (typeof id !== 'number') {
+            throw new TypeError('Must supply "id" as a number');
+        }
+        return super.deleteRequest(`${basePath}/${id}`);
+    }
+}
+exports.default = EmailTemplates;
+//# sourceMappingURL=EmailTemplates.js.map

package/tenants/classes/EmailTemplates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EmailTemplates.js","sourceRoot":"","sources":["../../src/classes/EmailTemplates.ts"],"names":[],"mappings":";;;;;AAAA,yEAA8C;AAQ9C,MAAM,QAAQ,GAAG,kBAAkB,CAAA;AACnC,MAAqB,cAAe,SAAQ,uBAAW;IACrD;;;;;;;;;;;;OAYG;IACH,YAAY,OAA2B;QACrC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;QACvB,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;IAC7C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAClB,YAAyC;QAEzC,OAAO,KAAK,CAAC,aAAa,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAA;IACpD,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,gBAAgB,CACpB,EAAU;QAEV,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;YAC1B,MAAM,IAAI,SAAS,CAAC,8BAA8B,CAAC,CAAA;SACpD;QAED,OAAO,KAAK,CAAC,aAAa,CAAC,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC,CAAA;IACjD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,mBAAmB,CACvB,IAAyC;QAEzC,OAAO,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IAC1C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,mBAAmB,CACvB,IAAsC;QAEtC,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,EAAE;YACxC,MAAM,IAAI,SAAS,CAAC,4CAA4C,CAAC,CAAA;SAClE;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,QAAQ,IAAI,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAA;IACzD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,mBAAmB,CAAC,EAAU;QAClC,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;YAC1B,MAAM,IAAI,SAAS,CAAC,8BAA8B,CAAC,CAAA;SACpD;QAED,OAAO,KAAK,CAAC,aAAa,CAAC,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC,CAAA;IACjD,CAAC;CACF;AAtID,iCAsIC"}