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

package/tenants/classes/Organisations.d.ts

@@ -0,0 +1,50 @@
+import { OrganisationTypes } from '@oneblink/types';
+import OneBlinkAPI from '../lib/one-blink-api';
+import { ConstructorOptions } from '../types';
+export default class Organisations extends OneBlinkAPI {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const OneBlink = require('@oneblink/sdk')
+     *
+     * const options = {
+     *   accessKey: '123455678901ABCDEFGHIJKL',
+     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     * }
+     * const organisations = new OneBlink.Organisations(options)
+     * ```
+     */
+    constructor(options: ConstructorOptions);
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const organisation = await organisations.getOrganisation()
+     * // Use organisation here...
+     * ```
+     */
+    getOrganisation(): Promise<OrganisationTypes.Organisation>;
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const asset = {
+     *   assetData: 'some kind of data',
+     *   assetFileName: 'myfile.png',
+     *   assetContentType: 'image/png',
+     * }
+     * const { location } = await organisations.uploadAsset(asset)
+     * // Use location here...
+     * ```
+     *
+     * @param asset The properties of the asset to upload
+     */
+    uploadAsset(asset: {
+        assetData: unknown;
+        assetFileName?: unknown;
+        assetContentType?: string;
+    }): Promise<{
+        location: string;
+    }>;
+}

package/tenants/classes/Organisations.js

@@ -0,0 +1,73 @@
+"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 upload_asset_1 = __importDefault(require("../lib/upload-asset"));
+class Organisations extends one_blink_api_1.default {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const OneBlink = require('@oneblink/sdk')
+     *
+     * const options = {
+     *   accessKey: '123455678901ABCDEFGHIJKL',
+     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     * }
+     * const organisations = new OneBlink.Organisations(options)
+     * ```
+     */
+    constructor(options) {
+        options = options || {};
+        super(options.accessKey, options.secretKey);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const organisation = await organisations.getOrganisation()
+     * // Use organisation here...
+     * ```
+     */
+    async getOrganisation() {
+        const searchResponse = await super.getRequest('/organisations');
+        if (!searchResponse.organisations || !searchResponse.organisations[0]) {
+            throw new TypeError('You do not have access to any organisations');
+        }
+        return searchResponse.organisations[0];
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const asset = {
+     *   assetData: 'some kind of data',
+     *   assetFileName: 'myfile.png',
+     *   assetContentType: 'image/png',
+     * }
+     * const { location } = await organisations.uploadAsset(asset)
+     * // Use location here...
+     * ```
+     *
+     * @param asset The properties of the asset to upload
+     */
+    async uploadAsset(asset) {
+        if (typeof asset.assetFileName !== 'string') {
+            throw new TypeError('Must supply "assetFileName" as a string');
+        }
+        if (asset.assetContentType && typeof asset.assetContentType !== 'string') {
+            throw new TypeError('If supplied, "assetContentType" must be a string');
+        }
+        const { id: organisationId } = await this.getOrganisation();
+        const credentials = await super.postRequest('/asset-upload-credentials', {
+            assetPath: `assets/${asset.assetFileName}`,
+            organisationId,
+        });
+        const uploadDetails = await (0, upload_asset_1.default)(credentials, asset.assetData, asset.assetContentType);
+        return { location: uploadDetails.Location };
+    }
+}
+exports.default = Organisations;
+//# sourceMappingURL=Organisations.js.map

package/tenants/classes/Organisations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Organisations.js","sourceRoot":"","sources":["../../src/classes/Organisations.ts"],"names":[],"mappings":";;;;;AACA,yEAA8C;AAE9C,uEAA6C;AAE7C,MAAqB,aAAc,SAAQ,uBAAW;IACpD;;;;;;;;;;;;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;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,UAAU,CAE1C,gBAAgB,CAAC,CAAA;QACpB,IAAI,CAAC,cAAc,CAAC,aAAa,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE;YACrE,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAA;SACnE;QAED,OAAO,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;IACxC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,WAAW,CAAC,KAIjB;QACC,IAAI,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ,EAAE;YAC3C,MAAM,IAAI,SAAS,CAAC,yCAAyC,CAAC,CAAA;SAC/D;QACD,IAAI,KAAK,CAAC,gBAAgB,IAAI,OAAO,KAAK,CAAC,gBAAgB,KAAK,QAAQ,EAAE;YACxE,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAA;SACxE;QACD,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAA;QAC3D,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,WAAW,CAMzC,2BAA2B,EAAE;YAC7B,SAAS,EAAE,UAAU,KAAK,CAAC,aAAa,EAAE;YAC1C,cAAc;SACf,CAAC,CAAA;QAEF,MAAM,aAAa,GAAG,MAAM,IAAA,sBAAW,EACrC,WAAW,EACX,KAAK,CAAC,SAAS,EACf,KAAK,CAAC,gBAAgB,CACvB,CAAA;QACD,OAAO,EAAE,QAAQ,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAA;IAC7C,CAAC;CACF;AAnFD,gCAmFC"}

package/tenants/classes/PDF.d.ts

@@ -0,0 +1,108 @@
+/// <reference types="node" />
+import { PDFTypes, SubmissionEventTypes } from '@oneblink/types';
+import OneBlinkAPI from '../lib/one-blink-api';
+import { ConstructorOptions } from '../types';
+export default class PDF extends OneBlinkAPI {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const OneBlink = require('@oneblink/sdk')
+     *
+     * const options = {
+     *   accessKey: '123455678901ABCDEFGHIJKL',
+     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     * }
+     * const pdf = new OneBlink.PDF(options)
+     * ```
+     */
+    constructor(options: ConstructorOptions);
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const fs = require('fs')
+     * const util = require('util')
+     *
+     * const writeFileAsync = util.promisify(fs.writeFile)
+     *
+     * async function run() {
+     *   const buffer = await pdf.generateFormSubmissionPDF({
+     *     formId: 1,
+     *     submissionId: 'c63ec3ac-12ab-447c-951c-2815d0e6fc24',
+     *     isDraft: false,
+     *     includeSubmissionIdInPdf: false,
+     *     excludedElementIds: ['1ae6d5f5-eade-411c-b85a-45fe40fe469e'],
+     *   })
+     *   await writeFileAsync('./submission.pdf', buffer, 'binary')
+     * }
+     * ```
+     *
+     * @param options An object containing all parameters to be passed into the function.
+     */
+    generateFormSubmissionPDF(options: {
+        /** The exact identifier of the form you wish to generate a pdf for */
+        formId: number;
+        /** The submission identifier generated after a successful form submission */
+        submissionId: string;
+        /** `true` if the submission is a draft submission, otherwise `false` */
+        isDraft?: boolean;
+        /**
+         * `true` to include the payment details associated with the submission in
+         * the PDF, otherwise `false`
+         */
+        includePaymentInPdf?: boolean;
+        /** `true` to include the submission identifier in the PDF, otherwise `false` */
+        includeSubmissionIdInPdf?: boolean;
+        /** Array of elements ids to be excluded from the PDF document */
+        excludedElementIds?: string[];
+        /** Whether pages in the form submission should translate to page breaks in the PDF */
+        usePagesAsBreaks?: boolean;
+    } & SubmissionEventTypes.ApprovalFormsInclusionConfiguration): Promise<Buffer>;
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const fs = require('fs')
+     * const util = require('util')
+     *
+     * const writeFileAsync = util.promisify(fs.writeFile)
+     *
+     * async function run() {
+     *   const buffer = await pdf.generatePDF({
+     *     body: {
+     *       html: `
+     *         <p>I will be in the middle</p>
+     *       `,
+     *     },
+     *     header: {
+     *       html: `
+     *       <div style="font-size: 9px; margin: 0 15px; width: 100%; text-align: center;">
+     *         I will be at the top of every page
+     *       </div>
+     *       `,
+     *     },
+     *     footer: {
+     *       html: `
+     *       <div style="font-size: 9px; margin: 0 15px; width: 100%; text-align: center;">
+     *         I will be at the bottom of every page ({_BLINK_PAGE_NO_}/{_BLINK_PAGES_})
+     *       </div>
+     *       `,
+     *     },
+     *     page: {
+     *       orientation: 'Portrait',
+     *       size: 'A4',
+     *       margins: {
+     *         top: '15mm',
+     *         right: '5mm',
+     *         bottom: '15mm',
+     *         left: '5mm',
+     *       },
+     *     },
+     *   })
+     *   await writeFileAsync('./custom.pdf', buffer, 'binary')
+     * }
+     * ```
+     */
+    generatePDF(options: PDFTypes.GeneratePDFOptions): Promise<Buffer>;
+}

package/tenants/classes/PDF.js

@@ -0,0 +1,133 @@
+"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"));
+class PDF extends one_blink_api_1.default {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const OneBlink = require('@oneblink/sdk')
+     *
+     * const options = {
+     *   accessKey: '123455678901ABCDEFGHIJKL',
+     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     * }
+     * const pdf = new OneBlink.PDF(options)
+     * ```
+     */
+    constructor(options) {
+        options = options || {};
+        super(options.accessKey, options.secretKey);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const fs = require('fs')
+     * const util = require('util')
+     *
+     * const writeFileAsync = util.promisify(fs.writeFile)
+     *
+     * async function run() {
+     *   const buffer = await pdf.generateFormSubmissionPDF({
+     *     formId: 1,
+     *     submissionId: 'c63ec3ac-12ab-447c-951c-2815d0e6fc24',
+     *     isDraft: false,
+     *     includeSubmissionIdInPdf: false,
+     *     excludedElementIds: ['1ae6d5f5-eade-411c-b85a-45fe40fe469e'],
+     *   })
+     *   await writeFileAsync('./submission.pdf', buffer, 'binary')
+     * }
+     * ```
+     *
+     * @param options An object containing all parameters to be passed into the function.
+     */
+    async generateFormSubmissionPDF(options) {
+        if (!options) {
+            throw new TypeError('Must supply "options" as a string');
+        }
+        const { submissionId, formId, ...body } = options;
+        if (!submissionId || typeof submissionId !== 'string') {
+            throw new TypeError('Must supply "options.submissionId" as a string');
+        }
+        if (Number.isNaN(formId) || typeof formId !== 'number') {
+            throw new TypeError('Must supply "options.formId" as a number');
+        }
+        const response = await super.request({
+            origin: one_blink_api_1.default.tenant.apiOrigin,
+            method: 'POST',
+            path: `/forms/${formId}/submissions/${submissionId}/pdf-document`,
+            headers: {
+                Accept: `application/pdf`,
+            },
+            body: JSON.stringify(body),
+        });
+        return response.buffer();
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const fs = require('fs')
+     * const util = require('util')
+     *
+     * const writeFileAsync = util.promisify(fs.writeFile)
+     *
+     * async function run() {
+     *   const buffer = await pdf.generatePDF({
+     *     body: {
+     *       html: `
+     *         <p>I will be in the middle</p>
+     *       `,
+     *     },
+     *     header: {
+     *       html: `
+     *       <div style="font-size: 9px; margin: 0 15px; width: 100%; text-align: center;">
+     *         I will be at the top of every page
+     *       </div>
+     *       `,
+     *     },
+     *     footer: {
+     *       html: `
+     *       <div style="font-size: 9px; margin: 0 15px; width: 100%; text-align: center;">
+     *         I will be at the bottom of every page ({_BLINK_PAGE_NO_}/{_BLINK_PAGES_})
+     *       </div>
+     *       `,
+     *     },
+     *     page: {
+     *       orientation: 'Portrait',
+     *       size: 'A4',
+     *       margins: {
+     *         top: '15mm',
+     *         right: '5mm',
+     *         bottom: '15mm',
+     *         left: '5mm',
+     *       },
+     *     },
+     *   })
+     *   await writeFileAsync('./custom.pdf', buffer, 'binary')
+     * }
+     * ```
+     */
+    async generatePDF(options) {
+        if (!options || !options.body || !options.body.html) {
+            throw new TypeError('Must supply "options.body.html" as a string');
+        }
+        const response = await super.request({
+            origin: one_blink_api_1.default.tenant.apiOrigin,
+            method: 'POST',
+            path: '/pdf-document',
+            body: JSON.stringify(options),
+            headers: {
+                Accept: `application/pdf`,
+                'Content-Type': `application/json`,
+            },
+        });
+        return response.buffer();
+    }
+}
+exports.default = PDF;
+//# sourceMappingURL=PDF.js.map

package/tenants/classes/PDF.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDF.js","sourceRoot":"","sources":["../../src/classes/PDF.ts"],"names":[],"mappings":";;;;;AACA,yEAA8C;AAG9C,MAAqB,GAAI,SAAQ,uBAAW;IAC1C;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAkB4D;QAE5D,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAA;SACzD;QACD,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAA;QACjD,IAAI,CAAC,YAAY,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;YACrD,MAAM,IAAI,SAAS,CAAC,gDAAgD,CAAC,CAAA;SACtE;QACD,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YACtD,MAAM,IAAI,SAAS,CAAC,0CAA0C,CAAC,CAAA;SAChE;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC;YACnC,MAAM,EAAE,uBAAW,CAAC,MAAM,CAAC,SAAS;YACpC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU,MAAM,gBAAgB,YAAY,eAAe;YACjE,OAAO,EAAE;gBACP,MAAM,EAAE,iBAAiB;aAC1B;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAA;QAEF,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAA;IAC1B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,KAAK,CAAC,WAAW,CAAC,OAAoC;QACpD,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE;YACnD,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAA;SACnE;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC;YACnC,MAAM,EAAE,uBAAW,CAAC,MAAM,CAAC,SAAS;YACpC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC7B,OAAO,EAAE;gBACP,MAAM,EAAE,iBAAiB;gBACzB,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAC,CAAA;QAEF,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAA;IAC1B,CAAC;CACF;AAtJD,sBAsJC"}

package/tenants/classes/TeamMembers.d.ts

@@ -0,0 +1,34 @@
+import { TeamMemberTypes } from '@oneblink/types';
+import OneBlinkAPI from '../lib/one-blink-api';
+import { ConstructorOptions } from '../types';
+export default class TeamMembers extends OneBlinkAPI {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const OneBlink = require('@oneblink/sdk')
+     *
+     * const options = {
+     *   accessKey: '123455678901ABCDEFGHIJKL',
+     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     * }
+     * const teamMembersSDK = new OneBlink.TeamMembers(options)
+     * ```
+     */
+    constructor(options: ConstructorOptions);
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const email = 'email@domain.io'
+     * teamMembersSDK.getTeamMemberRole(email).then((role) => {
+     *   if (role !== null) {
+     *     // Use role here...
+     *   }
+     * })
+     * ```
+     *
+     * @param email The email address the team member uses to login
+     */
+    getTeamMemberRole(email: string): Promise<TeamMemberTypes.Role | null>;
+}

package/tenants/classes/TeamMembers.js

@@ -0,0 +1,55 @@
+"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"));
+class TeamMembers extends one_blink_api_1.default {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const OneBlink = require('@oneblink/sdk')
+     *
+     * const options = {
+     *   accessKey: '123455678901ABCDEFGHIJKL',
+     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     * }
+     * const teamMembersSDK = new OneBlink.TeamMembers(options)
+     * ```
+     */
+    constructor(options) {
+        options = options || {};
+        super(options.accessKey, options.secretKey);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const email = 'email@domain.io'
+     * teamMembersSDK.getTeamMemberRole(email).then((role) => {
+     *   if (role !== null) {
+     *     // Use role here...
+     *   }
+     * })
+     * ```
+     *
+     * @param email The email address the team member uses to login
+     */
+    async getTeamMemberRole(email) {
+        if (typeof email !== 'string') {
+            return Promise.reject(new TypeError('Must supply "email" as a string'));
+        }
+        const { permissions } = await super.searchRequest('/permissions', {
+            email,
+        });
+        if (!permissions[0] ||
+            !permissions[0].links ||
+            !permissions[0].links.role) {
+            return null;
+        }
+        return permissions[0].links.role;
+    }
+}
+exports.default = TeamMembers;
+//# sourceMappingURL=TeamMembers.js.map

package/tenants/classes/TeamMembers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TeamMembers.js","sourceRoot":"","sources":["../../src/classes/TeamMembers.ts"],"names":[],"mappings":";;;;;AACA,yEAA8C;AAG9C,MAAqB,WAAY,SAAQ,uBAAW;IAClD;;;;;;;;;;;;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,KAAK,CAAC,iBAAiB,CAAC,KAAa;QACnC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC,CAAA;SACxE;QAED,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC,cAAc,EAAE;YAChE,KAAK;SACN,CAAC,CAAA;QACF,IACE,CAAC,WAAW,CAAC,CAAC,CAAC;YACf,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK;YACrB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAC1B;YACA,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAA;IAClC,CAAC;CACF;AAnDD,8BAmDC"}

package/tenants/classes/index.d.ts

@@ -0,0 +1,13 @@
+import Forms from './Forms';
+import FormsApps from './FormsApps';
+import Jobs from './Jobs';
+import Keys from './Keys';
+import Organisations from './Organisations';
+import TeamMembers from './TeamMembers';
+import PDF from './PDF';
+import Approvals from './Approvals';
+import FormsAppEnvironments from './FormsAppEnvironments';
+import EmailTemplates from './EmailTemplates';
+import DataManager from './DataManager';
+import sendEmail from './sendEmail';
+export { Forms, FormsApps, Jobs, Keys, Organisations, TeamMembers, PDF, Approvals, FormsAppEnvironments, EmailTemplates, DataManager, sendEmail, };

package/tenants/classes/index.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendEmail = exports.DataManager = exports.EmailTemplates = exports.FormsAppEnvironments = exports.Approvals = exports.PDF = exports.TeamMembers = exports.Organisations = exports.Keys = exports.Jobs = exports.FormsApps = exports.Forms = void 0;
+// Classes
+const Forms_1 = __importDefault(require("./Forms"));
+exports.Forms = Forms_1.default;
+const FormsApps_1 = __importDefault(require("./FormsApps"));
+exports.FormsApps = FormsApps_1.default;
+const Jobs_1 = __importDefault(require("./Jobs"));
+exports.Jobs = Jobs_1.default;
+const Keys_1 = __importDefault(require("./Keys"));
+exports.Keys = Keys_1.default;
+const Organisations_1 = __importDefault(require("./Organisations"));
+exports.Organisations = Organisations_1.default;
+const TeamMembers_1 = __importDefault(require("./TeamMembers"));
+exports.TeamMembers = TeamMembers_1.default;
+const PDF_1 = __importDefault(require("./PDF"));
+exports.PDF = PDF_1.default;
+const Approvals_1 = __importDefault(require("./Approvals"));
+exports.Approvals = Approvals_1.default;
+const FormsAppEnvironments_1 = __importDefault(require("./FormsAppEnvironments"));
+exports.FormsAppEnvironments = FormsAppEnvironments_1.default;
+const EmailTemplates_1 = __importDefault(require("./EmailTemplates"));
+exports.EmailTemplates = EmailTemplates_1.default;
+const DataManager_1 = __importDefault(require("./DataManager"));
+exports.DataManager = DataManager_1.default;
+// Functions
+const sendEmail_1 = __importDefault(require("./sendEmail"));
+exports.sendEmail = sendEmail_1.default;
+//# sourceMappingURL=index.js.map

package/tenants/classes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/classes/index.ts"],"names":[],"mappings":";;;;;;AAAA,UAAU;AACV,oDAA2B;AAezB,gBAfK,eAAK,CAeL;AAdP,4DAAmC;AAejC,oBAfK,mBAAS,CAeL;AAdX,kDAAyB;AAevB,eAfK,cAAI,CAeL;AAdN,kDAAyB;AAevB,eAfK,cAAI,CAeL;AAdN,oEAA2C;AAezC,wBAfK,uBAAa,CAeL;AAdf,gEAAuC;AAerC,sBAfK,qBAAW,CAeL;AAdb,gDAAuB;AAerB,cAfK,aAAG,CAeL;AAdL,4DAAmC;AAejC,oBAfK,mBAAS,CAeL;AAdX,kFAAyD;AAevD,+BAfK,8BAAoB,CAeL;AAdtB,sEAA6C;AAe3C,yBAfK,wBAAc,CAeL;AAdhB,gEAAuC;AAerC,sBAfK,qBAAW,CAeL;AAdb,YAAY;AACZ,4DAAmC;AAcjC,oBAdK,mBAAS,CAcL"}

package/tenants/classes/sendEmail.d.ts

@@ -0,0 +1,36 @@
+import { SendMailOptions, SendEmailResult } from '../types';
+/**
+ * #### Example
+ *
+ * ```javascript
+ * const OneBlink = require('@oneblink/sdk')
+ *
+ * await OneBlink.sendEmail({
+ *   subject: 'Message title',
+ *   html: '<p>HTML version of the message</p>',
+ *   from: {
+ *     address: 'noreply@example.com',
+ *     name: 'No Reply',
+ *   },
+ *   to: ['email@example.com'],
+ *   cc: ['you@example.com'],
+ *   bcc: ['not-you@example.com'],
+ *   attachments: [
+ *     {
+ *       filename: pdfFileName,
+ *       content: pdfData,
+ *       contentType: 'application/pdf',
+ *       encoding: 'binary',
+ *     },
+ *   ],
+ * })
+ * ```
+ *
+ * #### Options
+ *
+ * This function uses the popular
+ * [`nodemailer`](https://www.npmjs.com/package/nodemailer) internally to send
+ * emails. Please see the documentation for [Message
+ * Configuration](https://nodemailer.com/message/) for available options.
+ */
+export default function sendEmail(options: SendMailOptions): Promise<SendEmailResult>;

package/tenants/classes/sendEmail.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const aws_sdk_1 = require("aws-sdk");
+// Have to use nodemailer as aws-sdk can not send attachments
+const nodemailer_1 = __importDefault(require("nodemailer"));
+const one_blink_api_1 = __importDefault(require("../lib/one-blink-api"));
+/**
+ * #### Example
+ *
+ * ```javascript
+ * const OneBlink = require('@oneblink/sdk')
+ *
+ * await OneBlink.sendEmail({
+ *   subject: 'Message title',
+ *   html: '<p>HTML version of the message</p>',
+ *   from: {
+ *     address: 'noreply@example.com',
+ *     name: 'No Reply',
+ *   },
+ *   to: ['email@example.com'],
+ *   cc: ['you@example.com'],
+ *   bcc: ['not-you@example.com'],
+ *   attachments: [
+ *     {
+ *       filename: pdfFileName,
+ *       content: pdfData,
+ *       contentType: 'application/pdf',
+ *       encoding: 'binary',
+ *     },
+ *   ],
+ * })
+ * ```
+ *
+ * #### Options
+ *
+ * This function uses the popular
+ * [`nodemailer`](https://www.npmjs.com/package/nodemailer) internally to send
+ * emails. Please see the documentation for [Message
+ * Configuration](https://nodemailer.com/message/) for available options.
+ */
+async function sendEmail(options) {
+    const transporter = nodemailer_1.default.createTransport({
+        SES: new aws_sdk_1.SES({ region: one_blink_api_1.default.tenant.awsRegion }),
+    });
+    const result = await transporter.sendMail(options);
+    // @ts-expect-error Provided type is bad
+    return result;
+}
+exports.default = sendEmail;
+//# sourceMappingURL=sendEmail.js.map

package/tenants/classes/sendEmail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendEmail.js","sourceRoot":"","sources":["../../src/classes/sendEmail.ts"],"names":[],"mappings":";;;;;AAAA,qCAA6B;AAC7B,6DAA6D;AAC7D,4DAAmC;AACnC,yEAA8C;AAG9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACY,KAAK,UAAU,SAAS,CACrC,OAAwB;IAExB,MAAM,WAAW,GAAG,oBAAU,CAAC,eAAe,CAAC;QAC7C,GAAG,EAAE,IAAI,aAAG,CAAC,EAAE,MAAM,EAAE,uBAAW,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;KACvD,CAAC,CAAA;IAEF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;IAClD,wCAAwC;IACxC,OAAO,MAAM,CAAA;AACf,CAAC;AAVD,4BAUC"}

package/tenants/lib/forms-schema/common.d.ts

@@ -0,0 +1,9 @@
+import Joi from 'joi';
+export declare const CUSTOM_OPTION_TYPE = "CUSTOM";
+export declare const DYNAMIC_OPTION_TYPE = "DYNAMIC";
+export declare const FRESHDESK_FIELD_OPTION_TYPE = "FRESHDESK_FIELD";
+export declare const SEARCH_OPTION_TYPE = "SEARCH";
+export declare const optionTypes: string[];
+export declare const JoiRange: any;
+export declare const base64DataRegex: RegExp;
+export declare const attachment: Joi.ObjectSchema<any>;