@oneblink/sdk 7.2.0 → 7.3.0-beta.2

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@oneblink/sdk",
   "description": "OneBlink SDK to serve as an entry point for all OneBlink Services in NodeJS",
-  "version": "7.2.0",
+  "version": "7.3.0-beta.2",
   "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
   "bugs": {
     "url": "https://github.com/oneblink/sdk-node-js/issues"
   },
   "dependencies": {
     "@aws-sdk/client-sesv2": "^3.606.0",
-    "@oneblink/sdk-core": "^6.3.0-beta.2",
+    "@oneblink/sdk-core": "^6.3.1-beta.1",
     "@oneblink/storage": "^2.1.0-beta.3",
     "joi": "^17.12.2",
     "jsonwebtoken": "^9.0.2",
@@ -40,7 +40,7 @@
     "prettier": "^3.2.5",
     "prettier-plugin-jsdoc": "^1.3.0",
     "ts-jest": "^29.1.2",
-    "typedoc": "^0.25.9",
+    "typedoc": "^0.26.5",
     "typescript": "^5.3.3"
   },
   "directories": {

package/tenants/classes/Approvals.d.ts

@@ -2,32 +2,28 @@ import OneBlinkAPI from '../lib/one-blink-api';
 import { ConstructorOptions, FormApprovalFlowInstanceResponse, FormSubmissionApprovalResponse, FormSubmissionsAdministrationApprovalsResponse } from '../types';
 export default class Approvals extends OneBlinkAPI {
     /**
-     * #### Example
-     *
-     * ```typescript
-     * const OneBlink = require('@oneblink/sdk')
-     *
-     * const options = {
-     *   accessKey: '123455678901ABCDEFGHIJKL',
-     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
-     * }
-     *
-     * const approvals = new OneBlink.Approvals(options)
-     * ```
+     * @example
+     *   const OneBlink = require('@oneblink/sdk')
+     *   const options = {
+     *     accessKey: '123455678901ABCDEFGHIJKL',
+     *     secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     *   }
+     *   const approvals = new OneBlink.Approvals(options)
      */
     constructor(options: ConstructorOptions);
     /**
-     * #### Example
+     * **Minimum Role Permission**
      *
-     * ```javascript
-     * const { approvals, meta } =
-     *   await approvals.searchFormSubmissionAdministrationApprovals({
-     *     formsAppId: 1,
-     *     formId: 2,
-     *     limit: 50,
-     *     offset: 0,
-     *   })
-     * ```
+     * Submission Data: _Read Only_
+     *
+     * @example
+     *   const { approvals, meta } =
+     *     await approvals.searchFormSubmissionAdministrationApprovals({
+     *       formsAppId: 1,
+     *       formId: 2,
+     *       limit: 50,
+     *       offset: 0,
+     *     })
      *
      * @param options Search options
      * @returns
@@ -68,28 +64,30 @@ export default class Approvals extends OneBlinkAPI {
         formApprovalFlowInstanceId?: number;
     }): Promise<FormSubmissionsAdministrationApprovalsResponse>;
     /**
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Submission Data: _Read Only_
      *
-     * ```javascript
-     * const formSubmissionApproval =
-     *   await approvals.getFormSubmissionApproval(
-     *     'aaaaaaaa-bbbb-4543-cccc-addddd543454',
-     *   )
-     * // Use data here...
-     * ```
+     * @example
+     *   const formSubmissionApproval =
+     *     await approvals.getFormSubmissionApproval(
+     *       'aaaaaaaa-bbbb-4543-cccc-addddd543454',
+     *     )
+     *   // Use data here...
      *
      * @param id The id of the form submission approval
      * @returns
      */
     getFormSubmissionApproval(id: string): Promise<FormSubmissionApprovalResponse>;
     /**
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Submission Data: _Read Only_
      *
-     * ```javascript
-     * const formSubmissionApproval =
-     *   await approvals.getFormApprovalFlowInstance(1)
-     * // Use data here...
-     * ```
+     * @example
+     *   const formSubmissionApproval =
+     *     await approvals.getFormApprovalFlowInstance(1)
+     *   // Use data here...
      *
      * @param id The id of the form approval flow instance
      * @returns

package/tenants/classes/Approvals.js

@@ -6,35 +6,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const one_blink_api_1 = __importDefault(require("../lib/one-blink-api"));
 class Approvals extends one_blink_api_1.default {
     /**
-     * #### Example
-     *
-     * ```typescript
-     * const OneBlink = require('@oneblink/sdk')
-     *
-     * const options = {
-     *   accessKey: '123455678901ABCDEFGHIJKL',
-     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
-     * }
-     *
-     * const approvals = new OneBlink.Approvals(options)
-     * ```
+     * @example
+     *   const OneBlink = require('@oneblink/sdk')
+     *   const options = {
+     *     accessKey: '123455678901ABCDEFGHIJKL',
+     *     secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     *   }
+     *   const approvals = new OneBlink.Approvals(options)
      */
     constructor(options) {
         options = options || {};
         super(options.accessKey, options.secretKey);
     }
     /**
-     * #### Example
+     * **Minimum Role Permission**
      *
-     * ```javascript
-     * const { approvals, meta } =
-     *   await approvals.searchFormSubmissionAdministrationApprovals({
-     *     formsAppId: 1,
-     *     formId: 2,
-     *     limit: 50,
-     *     offset: 0,
-     *   })
-     * ```
+     * Submission Data: _Read Only_
+     *
+     * @example
+     *   const { approvals, meta } =
+     *     await approvals.searchFormSubmissionAdministrationApprovals({
+     *       formsAppId: 1,
+     *       formId: 2,
+     *       limit: 50,
+     *       offset: 0,
+     *     })
      *
      * @param options Search options
      * @returns
@@ -53,15 +49,16 @@ class Approvals extends one_blink_api_1.default {
         });
     }
     /**
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Submission Data: _Read Only_
      *
-     * ```javascript
-     * const formSubmissionApproval =
-     *   await approvals.getFormSubmissionApproval(
-     *     'aaaaaaaa-bbbb-4543-cccc-addddd543454',
-     *   )
-     * // Use data here...
-     * ```
+     * @example
+     *   const formSubmissionApproval =
+     *     await approvals.getFormSubmissionApproval(
+     *       'aaaaaaaa-bbbb-4543-cccc-addddd543454',
+     *     )
+     *   // Use data here...
      *
      * @param id The id of the form submission approval
      * @returns
@@ -73,13 +70,14 @@ class Approvals extends one_blink_api_1.default {
         return await super.getRequest(`/form-submission-approvals/${id}`);
     }
     /**
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Submission Data: _Read Only_
      *
-     * ```javascript
-     * const formSubmissionApproval =
-     *   await approvals.getFormApprovalFlowInstance(1)
-     * // Use data here...
-     * ```
+     * @example
+     *   const formSubmissionApproval =
+     *     await approvals.getFormApprovalFlowInstance(1)
+     *   // Use data here...
      *
      * @param id The id of the form approval flow instance
      * @returns

package/tenants/classes/Approvals.js.map

@@ -1 +1 @@
-{"version":3,"file":"Approvals.js","sourceRoot":"","sources":["../../src/classes/Approvals.ts"],"names":[],"mappings":";;;;;AAAA,yEAA8C;AAQ9C,MAAqB,SAAU,SAAQ,uBAAW;IAChD;;;;;;;;;;;;;OAaG;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;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,2CAA2C,CAAC,EAChD,UAAU,EACV,KAAK,EACL,MAAM,EACN,GAAG,IAAI,EAmCR;QACC,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;QAClE,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;QACtD,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,aAAa,CAAC,eAAe,UAAU,YAAY,EAAE;YACtE,KAAK;YACL,MAAM;YACN,GAAG,IAAI;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,yBAAyB,CAC7B,EAAU;QAEV,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC1D,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,UAAU,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAA;IACnE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,2BAA2B,CAC/B,EAAU;QAEV,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC1D,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,UAAU,CAAC,iCAAiC,EAAE,EAAE,CAAC,CAAA;IACtE,CAAC;CACF;AApID,4BAoIC"}
+{"version":3,"file":"Approvals.js","sourceRoot":"","sources":["../../src/classes/Approvals.ts"],"names":[],"mappings":";;;;;AAAA,yEAA8C;AAQ9C,MAAqB,SAAU,SAAQ,uBAAW;IAChD;;;;;;;;OAQG;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;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,2CAA2C,CAAC,EAChD,UAAU,EACV,KAAK,EACL,MAAM,EACN,GAAG,IAAI,EAmCR;QACC,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;QAClE,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;QACtD,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,aAAa,CAAC,eAAe,UAAU,YAAY,EAAE;YACtE,KAAK;YACL,MAAM;YACN,GAAG,IAAI;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,yBAAyB,CAC7B,EAAU;QAEV,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC1D,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,UAAU,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAA;IACnE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,2BAA2B,CAC/B,EAAU;QAEV,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC1D,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,UAAU,CAAC,iCAAiC,EAAE,EAAE,CAAC,CAAA;IACtE,CAAC;CACF;AAlID,4BAkIC"}

package/tenants/classes/DataManager.d.ts

@@ -3,40 +3,37 @@ import OneBlinkAPI from '../lib/one-blink-api';
 import { ConstructorOptions, SearchDataManagerRecordsOptions, SearchDataManagerRecordsResponse } from '../types';
 export default class DataManager extends OneBlinkAPI {
     /**
-     * #### Example
-     *
-     * ```typescript
-     * const OneBlink = require('@oneblink/sdk')
-     *
-     * const options = {
-     *   accessKey: '123455678901ABCDEFGHIJKL',
-     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
-     * }
-     *
-     * const dataManager = new OneBlink.DataManager(options)
-     * ```
+     * @example
+     *   const OneBlink = require('@oneblink/sdk')
+     *   const options = {
+     *     accessKey: '123455678901ABCDEFGHIJKL',
+     *     secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     *   }
+     *   const dataManager = new OneBlink.DataManager(options)
      */
     constructor(options: ConstructorOptions);
     /**
-     * #### Example
+     * **Minimum Role Permission**
      *
-     * ```javascript
-     * const { formId, formElements } = await dataManager.getFormDefinition(2)
-     * ```
+     * Submission Data: _Read Only_
+     *
+     * @example
+     *   const { formId, formElements } = await dataManager.getFormDefinition(2)
      *
      * @param id The form ID to get the definition for.
      * @returns
      */
     getFormDefinition(id: number): Promise<FormStoreDefinition>;
     /**
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Submission Data: _Read Only_
      *
-     * ```javascript
-     * const { submissions, meta } = await dataManager.searchRecords({
-     *   formId: 1,
-     * })
-     * // Use data here...
-     * ```
+     * @example
+     *   const { submissions, meta } = await dataManager.searchRecords({
+     *     formId: 1,
+     *   })
+     *   // Use data here...
      *
      * @param options The options for the Search Request
      * @returns

package/tenants/classes/DataManager.js

@@ -6,29 +6,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const one_blink_api_1 = __importDefault(require("../lib/one-blink-api"));
 class DataManager extends one_blink_api_1.default {
     /**
-     * #### Example
-     *
-     * ```typescript
-     * const OneBlink = require('@oneblink/sdk')
-     *
-     * const options = {
-     *   accessKey: '123455678901ABCDEFGHIJKL',
-     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
-     * }
-     *
-     * const dataManager = new OneBlink.DataManager(options)
-     * ```
+     * @example
+     *   const OneBlink = require('@oneblink/sdk')
+     *   const options = {
+     *     accessKey: '123455678901ABCDEFGHIJKL',
+     *     secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     *   }
+     *   const dataManager = new OneBlink.DataManager(options)
      */
     constructor(options) {
         options = options || {};
         super(options.accessKey, options.secretKey);
     }
     /**
-     * #### Example
+     * **Minimum Role Permission**
      *
-     * ```javascript
-     * const { formId, formElements } = await dataManager.getFormDefinition(2)
-     * ```
+     * Submission Data: _Read Only_
+     *
+     * @example
+     *   const { formId, formElements } = await dataManager.getFormDefinition(2)
      *
      * @param id The form ID to get the definition for.
      * @returns
@@ -42,14 +38,15 @@ class DataManager extends one_blink_api_1.default {
         });
     }
     /**
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Submission Data: _Read Only_
      *
-     * ```javascript
-     * const { submissions, meta } = await dataManager.searchRecords({
-     *   formId: 1,
-     * })
-     * // Use data here...
-     * ```
+     * @example
+     *   const { submissions, meta } = await dataManager.searchRecords({
+     *     formId: 1,
+     *   })
+     *   // Use data here...
      *
      * @param options The options for the Search Request
      * @returns

package/tenants/classes/DataManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"DataManager.js","sourceRoot":"","sources":["../../src/classes/DataManager.ts"],"names":[],"mappings":";;;;;AACA,yEAA8C;AAO9C,MAAqB,WAAY,SAAQ,uBAAW;IAClD;;;;;;;;;;;;;OAaG;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;;;;;;;;;OASG;IACH,KAAK,CAAC,iBAAiB,CAAC,EAAU;QAChC,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC1D,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,aAAa,CAAC,sBAAsB,EAAE;YACvD,MAAM,EAAE,EAAE;SACX,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC;QAExC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;QACvD,CAAC;QACD,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;QAC9D,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,WAAW,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IACxD,CAAC;CACF;AA/DD,8BA+DC"}
+{"version":3,"file":"DataManager.js","sourceRoot":"","sources":["../../src/classes/DataManager.ts"],"names":[],"mappings":";;;;;AACA,yEAA8C;AAO9C,MAAqB,WAAY,SAAQ,uBAAW;IAClD;;;;;;;;OAQG;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;;;;;;;;;;OAUG;IACH,KAAK,CAAC,iBAAiB,CAAC,EAAU;QAChC,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC1D,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,aAAa,CAAC,sBAAsB,EAAE;YACvD,MAAM,EAAE,EAAE;SACX,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC;QAExC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;QACvD,CAAC;QACD,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;QAC9D,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,WAAW,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IACxD,CAAC;CACF;AA5DD,8BA4DC"}

package/tenants/classes/EmailTemplates.d.ts

@@ -3,98 +3,104 @@ import { EmailTemplateTypes } from '@oneblink/types';
 import { ConstructorOptions, EmailTemplatesSearchOptions, EmailTemplatesSearchResult } from '../types';
 export default class EmailTemplates extends OneBlinkAPI {
     /**
-     * #### Example
-     *
-     * ```typescript
-     * const OneBlink = require('@oneblink/sdk')
-     *
-     * const options = {
-     *   accessKey: '123455678901ABCDEFGHIJKL',
-     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
-     * }
-     * const emailTemplates = new OneBlink.EmailTemplates(options)
-     * ```
+     * @example
+     *   const OneBlink = require('@oneblink/sdk')
+     *   const options = {
+     *     accessKey: '123455678901ABCDEFGHIJKL',
+     *     secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     *   }
+     *   const emailTemplates = new OneBlink.EmailTemplates(options)
      */
     constructor(options: ConstructorOptions);
     /**
-     * #### Example
+     * **Minimum Role Permission**
      *
-     * ```javascript
-     * const searchParams = {
-     *   limit: 1,
-     *   offset: 0,
-     * }
-     * const { emailTemplates, meta } =
-     *   await emailTemplates.searchEmailTemplates(searchParams)
-     * ```
+     * Email Templates: _Read Only_
+     *
+     * @example
+     *   const searchParams = {
+     *     limit: 1,
+     *     offset: 0,
+     *   }
+     *   const { emailTemplates, meta } =
+     *     await emailTemplates.searchEmailTemplates(searchParams)
      *
      * @param searchParams Search options
+     * @returns
      */
     searchEmailTemplates(searchParams: EmailTemplatesSearchOptions): Promise<EmailTemplatesSearchResult>;
     /**
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Email Templates: _Read Only_
      *
-     * ```javascript
-     * const emailTemplate = await emailTemplates.getEmailTemplate(1)
-     * // Use data here...
-     * ```
+     * @example
+     *   const emailTemplate = await emailTemplates.getEmailTemplate(1)
+     *   // Use data here...
      *
      * @param id The id of the email template
+     * @returns
      */
     getEmailTemplate(id: number): Promise<EmailTemplateTypes.EmailTemplate>;
     /**
-     * #### Example
+     * **Minimum Role Permission**
      *
-     * ```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...
-     * ```
+     * Email Templates: _Manager_
+     *
+     * @example
+     *   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
+     * @returns
      */
     createEmailTemplate(data: EmailTemplateTypes.NewEmailTemplate): Promise<EmailTemplateTypes.EmailTemplate>;
     /**
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Email Templates: _Manager_
      *
-     * ```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...
-     * ```
+     * @example
+     *   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
+     * @returns
      */
     updateEmailTemplate(data: EmailTemplateTypes.EmailTemplate): Promise<EmailTemplateTypes.EmailTemplate>;
     /**
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Email Templates: _Manager_
      *
-     * ```javascript
-     * await emailTemplates.deleteEmailTemplate(1)
-     * ```
+     * @example
+     *   await emailTemplates.deleteEmailTemplate(1)
      *
      * @param id The id of the email template to delete
+     * @returns
      */
     deleteEmailTemplate(id: number): Promise<void>;
 }