@oneblink/sdk 3.2.0-beta.2 → 3.2.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oneblink/sdk",
   "description": "OneBlink SDK to serve as an entry point for all OneBlink Services in NodeJS",
-  "version": "3.2.0-beta.2",
+  "version": "3.2.0",
   "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
   "bugs": {
     "url": "https://github.com/oneblink/sdk-node-js/issues"

package/tenants/classes/FormElementLists.d.ts

@@ -0,0 +1,111 @@
+import { FormTypes } from '@oneblink/types';
+import OneBlinkAPI from '../lib/one-blink-api';
+import { ConstructorOptions, FormElementListSearchOptions, FormElementListSearchResult } from '../types';
+export default class FormElementLists extends OneBlinkAPI {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * import { FormElementLists } from '@oneblink/sdk'
+     *
+     * const options = {
+     *   accessKey: '123455678901ABCDEFGHIJKL',
+     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     * }
+     * const formElementListsClient = new FormElementLists(options)
+     * ```
+     */
+    constructor(options: ConstructorOptions);
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const searchParams = {
+     *   limit: 1,
+     *   offset: 0,
+     * }
+     * const { formElementLists, meta } =
+     *   await formElementListsClient.searchFormElementLists(searchParams)
+     * ```
+     *
+     * @param searchParams Search options
+     */
+    searchFormElementLists(searchParams: FormElementListSearchOptions): Promise<FormElementListSearchResult>;
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const data = {
+     *   name: 'my list',
+     *   organisationId: 'abc123',
+     *   environments: [
+     *     {
+     *       options: [
+     *          {
+     *            label: 'One'
+     *            value: '1'
+     *          },
+     *          {
+     *            label: 'Two'
+     *            value: '2'
+     *          }
+     *       ]
+     *       formsAppEnvironmentId: 1,
+     *     },
+     *   ],
+     *   type: 'STATIC',
+     * }
+     * const list = await formElementListsClient.createFormElementList(data)
+     * // Use list here...
+     * ```
+     *
+     * @param newFormElementList The data for the new list
+     */
+    createFormElementList(newFormElementList: FormTypes.NewFormElementOptionSet): Promise<FormTypes.FormElementOptionSet>;
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const data = {
+     *   id: 1,
+     *   name: 'my list',
+     *   organisationId: 'abc123',
+     *   environments: [
+     *     {
+     *       options: [
+     *          {
+     *            label: 'One'
+     *            value: '1'
+     *          },
+     *          {
+     *            label: 'Two'
+     *            value: '2'
+     *          },
+     *          {
+     *            label: 'Three'
+     *            value: '2'
+     *          },
+     *       ]
+     *       formsAppEnvironmentId: 1,
+     *     },
+     *   ],
+     *   type: 'STATIC',
+     * }
+     * const list = await formElementListsClient.updateFormElementList(data)
+     * // Use list here...
+     * ```
+     *
+     * @param list The data for the list to update
+     */
+    updateFormElementList(list: FormTypes.FormElementOptionSet): Promise<FormTypes.FormElementOptionSet>;
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * await formElementListsClient.deleteFormElementList(1)
+     * ```
+     *
+     * @param id The id of the list to delete
+     */
+    deleteFormElementList(id: number): Promise<void>;
+}

package/tenants/classes/FormElementLists.js

@@ -0,0 +1,149 @@
+"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 = `/form-element-options/dynamic`;
+class FormElementLists extends one_blink_api_1.default {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * import { FormElementLists } from '@oneblink/sdk'
+     *
+     * const options = {
+     *   accessKey: '123455678901ABCDEFGHIJKL',
+     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     * }
+     * const formElementListsClient = new FormElementLists(options)
+     * ```
+     */
+    constructor(options) {
+        options = options || {};
+        super(options.accessKey, options.secretKey);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const searchParams = {
+     *   limit: 1,
+     *   offset: 0,
+     * }
+     * const { formElementLists, meta } =
+     *   await formElementListsClient.searchFormElementLists(searchParams)
+     * ```
+     *
+     * @param searchParams Search options
+     */
+    async searchFormElementLists(searchParams) {
+        if (!searchParams ||
+            typeof searchParams !== 'object' ||
+            typeof searchParams.organisationId !== 'string') {
+            throw new TypeError('Must supply "options.organisationId" as a string');
+        }
+        const result = await super.searchRequest(basePath, searchParams);
+        return {
+            meta: result.meta,
+            formElementLists: result.formElementDynamicOptionSets,
+        };
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const data = {
+     *   name: 'my list',
+     *   organisationId: 'abc123',
+     *   environments: [
+     *     {
+     *       options: [
+     *          {
+     *            label: 'One'
+     *            value: '1'
+     *          },
+     *          {
+     *            label: 'Two'
+     *            value: '2'
+     *          }
+     *       ]
+     *       formsAppEnvironmentId: 1,
+     *     },
+     *   ],
+     *   type: 'STATIC',
+     * }
+     * const list = await formElementListsClient.createFormElementList(data)
+     * // Use list here...
+     * ```
+     *
+     * @param newFormElementList The data for the new list
+     */
+    async createFormElementList(newFormElementList) {
+        if (!newFormElementList || typeof newFormElementList !== 'object') {
+            throw new TypeError('Must supply "newList" as an object');
+        }
+        return super.postRequest(basePath, newFormElementList);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const data = {
+     *   id: 1,
+     *   name: 'my list',
+     *   organisationId: 'abc123',
+     *   environments: [
+     *     {
+     *       options: [
+     *          {
+     *            label: 'One'
+     *            value: '1'
+     *          },
+     *          {
+     *            label: 'Two'
+     *            value: '2'
+     *          },
+     *          {
+     *            label: 'Three'
+     *            value: '2'
+     *          },
+     *       ]
+     *       formsAppEnvironmentId: 1,
+     *     },
+     *   ],
+     *   type: 'STATIC',
+     * }
+     * const list = await formElementListsClient.updateFormElementList(data)
+     * // Use list here...
+     * ```
+     *
+     * @param list The data for the list to update
+     */
+    async updateFormElementList(list) {
+        if (!list || typeof list !== 'object') {
+            throw new TypeError('Must supply "list" as an object');
+        }
+        if (typeof list.id !== 'number') {
+            throw new TypeError('Must supply "list.id" as a number');
+        }
+        return super.putRequest(`${basePath}/${list.id}`, list);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * await formElementListsClient.deleteFormElementList(1)
+     * ```
+     *
+     * @param id The id of the list to delete
+     */
+    async deleteFormElementList(id) {
+        if (typeof id !== 'number' || Number.isNaN(id)) {
+            throw new TypeError('Must supply "id" as a number');
+        }
+        return super.deleteRequest(`${basePath}/${id}`);
+    }
+}
+exports.default = FormElementLists;
+//# sourceMappingURL=FormElementLists.js.map

package/tenants/classes/FormElementLists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormElementLists.js","sourceRoot":"","sources":["../../src/classes/FormElementLists.ts"],"names":[],"mappings":";;;;;AACA,yEAA8C;AAO9C,MAAM,QAAQ,GAAG,+BAA+B,CAAA;AAEhD,MAAqB,gBAAiB,SAAQ,uBAAW;IACvD;;;;;;;;;;;;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,sBAAsB,CAC1B,YAA0C;QAE1C,IACE,CAAC,YAAY;YACb,OAAO,YAAY,KAAK,QAAQ;YAChC,OAAO,YAAY,CAAC,cAAc,KAAK,QAAQ,EAC/C;YACA,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAA;SACxE;QACD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,aAAa,CAItC,QAAQ,EAAE,YAAY,CAAC,CAAA;QACzB,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,gBAAgB,EAAE,MAAM,CAAC,4BAA4B;SACtD,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,qBAAqB,CACzB,kBAAqD;QAErD,IAAI,CAAC,kBAAkB,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE;YACjE,MAAM,IAAI,SAAS,CAAC,oCAAoC,CAAC,CAAA;SAC1D;QACD,OAAO,KAAK,CAAC,WAAW,CAGtB,QAAQ,EAAE,kBAAkB,CAAC,CAAA;IACjC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,qBAAqB,CACzB,IAAoC;QAEpC,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YACrC,MAAM,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAA;SACvD;QAED,IAAI,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,EAAE;YAC/B,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAA;SACzD;QAED,OAAO,KAAK,CAAC,UAAU,CAGrB,GAAG,QAAQ,IAAI,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAA;IACnC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,qBAAqB,CAAC,EAAU;QACpC,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE;YAC9C,MAAM,IAAI,SAAS,CAAC,8BAA8B,CAAC,CAAA;SACpD;QAED,OAAO,KAAK,CAAC,aAAa,CAAC,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC,CAAA;IACjD,CAAC;CACF;AApKD,mCAoKC"}

package/tenants/classes/FormElementLookups.d.ts

@@ -0,0 +1,120 @@
+import { FormTypes } from '@oneblink/types';
+import OneBlinkAPI from '../lib/one-blink-api';
+import { ConstructorOptions, FormElementLookupSearchResult } from '../types';
+export default class FormElementLookups extends OneBlinkAPI {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * import { FormElementLookups } from '@oneblink/sdk'
+     *
+     * const options = {
+     *   accessKey: '123455678901ABCDEFGHIJKL',
+     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     * }
+     * const formElementLookups = new FormElementLookups(options)
+     * ```
+     */
+    constructor(options: ConstructorOptions);
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const lookupId = 1
+     * const lookup = await formElementLookups.getFormElementLookup(lookupId)
+     * // Use lookup here
+     * ```
+     *
+     * @param id The exact id of the lookup you wish to get
+     * @returns
+     */
+    getFormElementLookup(id: number): Promise<FormTypes.FormElementLookup>;
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const organisationId = '2i4321a7n2389a2700065425'
+     * const lookups = await formElementLookups.searchFormElementLookups({
+     *   organisationId,
+     *   limit: 50,
+     *   offset: 0,
+     * })
+     * // Use lookups here
+     * ```
+     *
+     * @param options
+     * @returns
+     */
+    searchFormElementLookups(options: {
+        /**
+         * The exact id of organisation associated with the lookups you wish to
+         * search
+         */
+        organisationId: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<FormElementLookupSearchResult>;
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const newLookup = {
+     *   name: 'My New Lookup',
+     *   environments: [
+     *     {
+     *       formsAppEnvironmentId: 1,
+     *       urL: 'https://my-url.com/lookup',
+     *     },
+     *   ],
+     *   type: 'DATA',
+     *   organisationId: '',
+     * }
+     * const createdLookup = await lookups.createFormElementLookup(newLookup)
+     * // Use lookup here
+     * ```
+     *
+     * @param newFormElementLookup
+     * @returns
+     */
+    createFormElementLookup(newFormElementLookup: FormTypes.NewFormElementLookup): Promise<FormTypes.FormElementLookup>;
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const lookup = {
+     *   id: 1,
+     *   createdAt: '2023-06-28T02:00:03.000Z',
+     *   updatedAt: '2023-06-28T02:00:03.000Z',
+     *   name: 'My New Lookup',
+     *   environments: [
+     *     {
+     *       formsAppEnvironmentId: 1,
+     *       url: 'https://my-url.com/lookup',
+     *     },
+     *   ],
+     *   type: 'DATA',
+     *   organisationId: '',
+     * }
+     * const updatedLookup = await formElementLookups.updateFormElementLookup(
+     *   lookup,
+     * )
+     * // Use lookup here
+     * ```
+     *
+     * @param formElementLookup
+     * @returns
+     */
+    updateFormElementLookup(formElementLookup: FormTypes.FormElementLookup): Promise<FormTypes.FormElementLookup>;
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const lookupId = 7
+     * await formElementLookups.deleteFormElementLookup(lookupId)
+     * ```
+     *
+     * @param id The id of the lookup to delete
+     * @returns
+     */
+    deleteFormElementLookup(id: number): Promise<void>;
+}

package/tenants/classes/FormElementLookups.js

@@ -0,0 +1,151 @@
+"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 FormElementLookups extends one_blink_api_1.default {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * import { FormElementLookups } from '@oneblink/sdk'
+     *
+     * const options = {
+     *   accessKey: '123455678901ABCDEFGHIJKL',
+     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     * }
+     * const formElementLookups = new FormElementLookups(options)
+     * ```
+     */
+    constructor(options) {
+        options = options || {};
+        super(options.accessKey, options.secretKey);
+    }
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const lookupId = 1
+     * const lookup = await formElementLookups.getFormElementLookup(lookupId)
+     * // Use lookup here
+     * ```
+     *
+     * @param id The exact id of the lookup you wish to get
+     * @returns
+     */
+    async getFormElementLookup(id) {
+        if (typeof id !== 'number' || Number.isNaN(id)) {
+            throw new TypeError('Must supply "id" as a number');
+        }
+        return super.getRequest(`/form-element-lookups/${id}`);
+    }
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const organisationId = '2i4321a7n2389a2700065425'
+     * const lookups = await formElementLookups.searchFormElementLookups({
+     *   organisationId,
+     *   limit: 50,
+     *   offset: 0,
+     * })
+     * // Use lookups here
+     * ```
+     *
+     * @param options
+     * @returns
+     */
+    async searchFormElementLookups(options) {
+        if (!options ||
+            typeof options !== 'object' ||
+            typeof options.organisationId !== 'string') {
+            throw new TypeError('Must supply "options.organisationId" as a string');
+        }
+        return super.searchRequest(`/form-element-lookups`, {
+            limit: options.limit,
+            offset: options.offset,
+            organisationId: options.organisationId,
+        });
+    }
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const newLookup = {
+     *   name: 'My New Lookup',
+     *   environments: [
+     *     {
+     *       formsAppEnvironmentId: 1,
+     *       urL: 'https://my-url.com/lookup',
+     *     },
+     *   ],
+     *   type: 'DATA',
+     *   organisationId: '',
+     * }
+     * const createdLookup = await lookups.createFormElementLookup(newLookup)
+     * // Use lookup here
+     * ```
+     *
+     * @param newFormElementLookup
+     * @returns
+     */
+    async createFormElementLookup(newFormElementLookup) {
+        if (!newFormElementLookup || typeof newFormElementLookup !== 'object') {
+            throw new TypeError('Must supply "newLookup" as an object');
+        }
+        return super.postRequest(`/form-element-lookups`, newFormElementLookup);
+    }
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const lookup = {
+     *   id: 1,
+     *   createdAt: '2023-06-28T02:00:03.000Z',
+     *   updatedAt: '2023-06-28T02:00:03.000Z',
+     *   name: 'My New Lookup',
+     *   environments: [
+     *     {
+     *       formsAppEnvironmentId: 1,
+     *       url: 'https://my-url.com/lookup',
+     *     },
+     *   ],
+     *   type: 'DATA',
+     *   organisationId: '',
+     * }
+     * const updatedLookup = await formElementLookups.updateFormElementLookup(
+     *   lookup,
+     * )
+     * // Use lookup here
+     * ```
+     *
+     * @param formElementLookup
+     * @returns
+     */
+    async updateFormElementLookup(formElementLookup) {
+        if (!formElementLookup || typeof formElementLookup !== 'object') {
+            throw new TypeError('Must supply "updatedLookup" as an object');
+        }
+        return super.putRequest(`/form-element-lookups/${formElementLookup.id}`, formElementLookup);
+    }
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const lookupId = 7
+     * await formElementLookups.deleteFormElementLookup(lookupId)
+     * ```
+     *
+     * @param id The id of the lookup to delete
+     * @returns
+     */
+    async deleteFormElementLookup(id) {
+        if (typeof id !== 'number' || Number.isNaN(id)) {
+            throw new TypeError('Must supply "id" as a number');
+        }
+        return super.deleteRequest(`/form-element-lookups/${id}`);
+    }
+}
+exports.default = FormElementLookups;
+//# sourceMappingURL=FormElementLookups.js.map

package/tenants/classes/FormElementLookups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormElementLookups.js","sourceRoot":"","sources":["../../src/classes/FormElementLookups.ts"],"names":[],"mappings":";;;;;AACA,yEAA8C;AAG9C,MAAqB,kBAAmB,SAAQ,uBAAW;IACzD;;;;;;;;;;;;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;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,oBAAoB,CAAC,EAAU;QACnC,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE;YAC9C,MAAM,IAAI,SAAS,CAAC,8BAA8B,CAAC,CAAA;SACpD;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAA;IACxD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,wBAAwB,CAAC,OAQ9B;QACC,IACE,CAAC,OAAO;YACR,OAAO,OAAO,KAAK,QAAQ;YAC3B,OAAO,OAAO,CAAC,cAAc,KAAK,QAAQ,EAC1C;YACA,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAA;SACxE;QAED,OAAO,KAAK,CAAC,aAAa,CAAC,uBAAuB,EAAE;YAClD,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,uBAAuB,CAC3B,oBAAoD;QAEpD,IAAI,CAAC,oBAAoB,IAAI,OAAO,oBAAoB,KAAK,QAAQ,EAAE;YACrE,MAAM,IAAI,SAAS,CAAC,sCAAsC,CAAC,CAAA;SAC5D;QACD,OAAO,KAAK,CAAC,WAAW,CAAC,uBAAuB,EAAE,oBAAoB,CAAC,CAAA;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,uBAAuB,CAC3B,iBAA8C;QAE9C,IAAI,CAAC,iBAAiB,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;YAC/D,MAAM,IAAI,SAAS,CAAC,0CAA0C,CAAC,CAAA;SAChE;QACD,OAAO,KAAK,CAAC,UAAU,CACrB,yBAAyB,iBAAiB,CAAC,EAAE,EAAE,EAC/C,iBAAiB,CAClB,CAAA;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,uBAAuB,CAAC,EAAU;QACtC,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE;YAC9C,MAAM,IAAI,SAAS,CAAC,8BAA8B,CAAC,CAAA;SACpD;QACD,OAAO,KAAK,CAAC,aAAa,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAA;IAC3D,CAAC;CACF;AAtKD,qCAsKC"}

package/tenants/classes/index.d.ts

@@ -9,5 +9,7 @@ import Approvals from './Approvals';
 import FormsAppEnvironments from './FormsAppEnvironments';
 import EmailTemplates from './EmailTemplates';
 import DataManager from './DataManager';
+import FormElementLookups from './FormElementLookups';
+import FormElementLists from './FormElementLists';
 import sendEmail from './sendEmail';
-export { Forms, FormsApps, Jobs, Keys, Organisations, TeamMembers, PDF, Approvals, FormsAppEnvironments, EmailTemplates, DataManager, sendEmail, };
+export { Forms, FormsApps, Jobs, Keys, Organisations, TeamMembers, PDF, Approvals, FormsAppEnvironments, EmailTemplates, DataManager, FormElementLookups, FormElementLists, sendEmail, };

package/tenants/classes/index.js

@@ -3,7 +3,7 @@ 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;
+exports.sendEmail = exports.FormElementLists = exports.FormElementLookups = 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;
@@ -27,6 +27,10 @@ const EmailTemplates_1 = __importDefault(require("./EmailTemplates"));
 exports.EmailTemplates = EmailTemplates_1.default;
 const DataManager_1 = __importDefault(require("./DataManager"));
 exports.DataManager = DataManager_1.default;
+const FormElementLookups_1 = __importDefault(require("./FormElementLookups"));
+exports.FormElementLookups = FormElementLookups_1.default;
+const FormElementLists_1 = __importDefault(require("./FormElementLists"));
+exports.FormElementLists = FormElementLists_1.default;
 // Functions
 const sendEmail_1 = __importDefault(require("./sendEmail"));
 exports.sendEmail = sendEmail_1.default;

package/tenants/classes/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/classes/index.ts"],"names":[],"mappings":";;;;;;AAAA,UAAU;AACV,oDAA2B;AAiBzB,gBAjBK,eAAK,CAiBL;AAhBP,4DAAmC;AAiBjC,oBAjBK,mBAAS,CAiBL;AAhBX,kDAAyB;AAiBvB,eAjBK,cAAI,CAiBL;AAhBN,kDAAyB;AAiBvB,eAjBK,cAAI,CAiBL;AAhBN,oEAA2C;AAiBzC,wBAjBK,uBAAa,CAiBL;AAhBf,gEAAuC;AAiBrC,sBAjBK,qBAAW,CAiBL;AAhBb,gDAAuB;AAiBrB,cAjBK,aAAG,CAiBL;AAhBL,4DAAmC;AAiBjC,oBAjBK,mBAAS,CAiBL;AAhBX,kFAAyD;AAiBvD,+BAjBK,8BAAoB,CAiBL;AAhBtB,sEAA6C;AAiB3C,yBAjBK,wBAAc,CAiBL;AAhBhB,gEAAuC;AAiBrC,sBAjBK,qBAAW,CAiBL;AAhBb,8EAAqD;AAiBnD,6BAjBK,4BAAkB,CAiBL;AAhBpB,0EAAiD;AAiB/C,2BAjBK,0BAAgB,CAiBL;AAhBlB,YAAY;AACZ,4DAAmC;AAgBjC,oBAhBK,mBAAS,CAgBL"}

package/tenants/types.d.ts

@@ -15,7 +15,10 @@ export type PreFillMeta = AWSTypes.FormS3Credentials & {
 export type BaseSearchOptions = {
     /** Limit the number of results returned */
     limit?: number;
-    /** Skip a specific number of results, used in conjunction with `limit` to enforce paging */
+    /**
+     * Skip a specific number of results, used in conjunction with `limit` to
+     * enforce paging
+     */
     offset?: number;
 };
 export type TenantBase = {
@@ -64,7 +67,10 @@ export type FormsSearchOptions = BaseSearchOptions & {
      * or `false` or not specified.
      */
     isAuthenticated?: boolean;
-    /** Search on the `name` property of a form. Can be a prefix, suffix or partial match */
+    /**
+     * Search on the `name` property of a form. Can be a prefix, suffix or partial
+     * match
+     */
     name?: string;
     /**
      * Search on the `formsAppIds` property of a form. Must be the exact match of
@@ -141,7 +147,10 @@ export type JobsSearchResult = MiscTypes.BaseSearchResult & {
     jobs: SubmissionTypes.FormsAppJob[];
 };
 export type DataManagerRegexFilter = {
-    /** The Regular expression to search with. This can just be a simple string if desired. */
+    /**
+     * The Regular expression to search with. This can just be a simple string if
+     * desired.
+     */
     $regex: string;
     /**
      * Regex options. String with any combination of the following characters:
@@ -215,7 +224,10 @@ export type DataManagerFreshdeskDependentFieldFilter = {
      * `select` element.
      */
     subCategory?: DataManagerStringArrayFilter;
-    /** The filter for the `item`. This property is treated as a non multi `select` element. */
+    /**
+     * The filter for the `item`. This property is treated as a non multi `select`
+     * element.
+     */
     item?: DataManagerStringArrayFilter;
 };
 export type DataManagerNestedFilterFilter = {
@@ -236,7 +248,8 @@ export type DataManagerNestedFilterFilter = {
  * Element of type: checkboxes, select (multi): USE
  * `DataManagerMultipleSelectionsArrayFilter`.
  *
- * Element of type: radio, autocomplete, select: USE `DataManagerStringArrayFilter`.
+ * Element of type: radio, autocomplete, select: USE
+ * `DataManagerStringArrayFilter`.
  *
  * Element of type: boolean: USE `DataManagerBooleanFilter`.
  *
@@ -301,3 +314,12 @@ export type SearchDataManagerRecordsResponse = {
     };
     submissions: Array<FormStoreRecord>;
 };
+export type FormElementLookupSearchResult = {
+    formElementLookups: FormTypes.FormElementLookup[];
+} & MiscTypes.BaseSearchResult;
+export type FormElementListSearchResult = {
+    formElementLists: FormTypes.FormElementOptionSet[];
+} & MiscTypes.BaseSearchResult;
+export type FormElementListSearchOptions = BaseSearchOptions & {
+    organisationId: string;
+};