@oneblink/sdk 7.2.0 → 7.3.0-beta.2

package/tenants/classes/Jobs.d.ts

@@ -3,84 +3,88 @@ import OneBlinkAPI from '../lib/one-blink-api';
 import { ConstructorOptions, JobsSearchResult } from '../types';
 export default class Jobs extends OneBlinkAPI {
     /**
-     * #### Example
-     *
-     * ```typescript
-     * const OneBlink = require('@oneblink/sdk')
-     *
-     * const options = {
-     *   accessKey: '123455678901ABCDEFGHIJKL',
-     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
-     * }
-     * const jobs = new OneBlink.Jobs(options)
-     * ```
+     * @example
+     *   const OneBlink = require('@oneblink/sdk')
+     *   const options = {
+     *     accessKey: '123455678901ABCDEFGHIJKL',
+     *     secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     *   }
+     *   const jobs = new OneBlink.Jobs(options)
      */
     constructor(options: ConstructorOptions);
     /**
      * Create a single Job
      *
-     * #### Example
-     *
-     * ```javascript
-     * const newJob = {
-     *   username: 'user@domain.io',
-     *   formId: 1,
-     *   externalId: 'your-job-identifier',
-     *   details: {
-     *     key: 'JOB-123',
-     *     title: 'Job Title',
-     *     description: 'Job description',
-     *     type: 'Type',
-     *     priority: 3,
-     *   },
-     * }
-     *
-     * const preFillData = {
-     *   text_element: 'abc',
-     *   number_element: 123,
-     * }
-     *
-     * jobs.createJob(newJob, preFillData).then((job) => {
-     *   // job.id can be used to delete the Job
-     * })
-     * ```
+     * **Minimum Role Permission**
+     *
+     * Jobs: _Manager_
+     *
+     * Upload Form Prefill Data: _On_ (only if using `preFillData`)
+     *
+     * @example
+     *   const newJob = {
+     *     username: 'user@domain.io',
+     *     formId: 1,
+     *     externalId: 'your-job-identifier',
+     *     details: {
+     *       key: 'JOB-123',
+     *       title: 'Job Title',
+     *       description: 'Job description',
+     *       type: 'Type',
+     *       priority: 3,
+     *     },
+     *   }
+     *
+     *   const preFillData = {
+     *     text_element: 'abc',
+     *     number_element: 123,
+     *   }
+     *
+     *   jobs.createJob(newJob, preFillData).then((job) => {
+     *     // job.id can be used to delete the Job
+     *   })
      *
      * @param data The Job to create
      * @param preFillData Key/value pairs with the form field names as keys and
      *   the pre-fill data as the values
+     * @returns
      */
     createJob(data: SubmissionTypes.NewFormsAppJob, preFillData?: Record<string, unknown>): Promise<SubmissionTypes.FormsAppJob>;
     /**
      * Delete a single Job
      *
-     * #### Example
+     * **Minimum Role Permission**
      *
-     * ```javascript
-     * const jobId = 'f73985fd-2dba-4bf7-abbe-e204889f5216'
-     * jobs.deleteJob(jobId).then(() => {
-     *   // Job has been deleted
-     * })
-     * ```
+     * Jobs: _Manager_
+     *
+     * @example
+     *   const jobId = 'f73985fd-2dba-4bf7-abbe-e204889f5216'
+     *   jobs.deleteJob(jobId).then(() => {
+     *     // Job has been deleted
+     *   })
      *
      * @param jobId The exact id of the job you wish to delete
+     * @returns
      */
     deleteJob(jobId: string): Promise<void>;
     /**
      * Search Jobs
      *
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Jobs: _Read Only_
      *
-     * ```javascript
-     * const results = await jobs.searchJobs({
-     *   username: 'user@domain.io',
-     *   formId: 10,
-     * })
+     * @example
+     *   const results = await jobs.searchJobs({
+     *     username: 'user@domain.io',
+     *     formId: 10,
+     *   })
      *
-     * // an array of jobs
-     * const jobs = results.jobs
-     * ```
+     *   // an array of jobs
+     *   const jobs = results.jobs
      *
      * @param options Search options
+     * @returns
      */
     searchJobs(options?: {
         /** The `externalId` property of a job */

package/tenants/classes/Jobs.js

@@ -21,17 +21,13 @@ const newJobSchema = joi_1.default.object()
 });
 class Jobs extends one_blink_api_1.default {
     /**
-     * #### Example
-     *
-     * ```typescript
-     * const OneBlink = require('@oneblink/sdk')
-     *
-     * const options = {
-     *   accessKey: '123455678901ABCDEFGHIJKL',
-     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
-     * }
-     * const jobs = new OneBlink.Jobs(options)
-     * ```
+     * @example
+     *   const OneBlink = require('@oneblink/sdk')
+     *   const options = {
+     *     accessKey: '123455678901ABCDEFGHIJKL',
+     *     secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     *   }
+     *   const jobs = new OneBlink.Jobs(options)
      */
     constructor(options) {
         options = options || {};
@@ -40,35 +36,39 @@ class Jobs extends one_blink_api_1.default {
     /**
      * Create a single Job
      *
-     * #### Example
-     *
-     * ```javascript
-     * const newJob = {
-     *   username: 'user@domain.io',
-     *   formId: 1,
-     *   externalId: 'your-job-identifier',
-     *   details: {
-     *     key: 'JOB-123',
-     *     title: 'Job Title',
-     *     description: 'Job description',
-     *     type: 'Type',
-     *     priority: 3,
-     *   },
-     * }
-     *
-     * const preFillData = {
-     *   text_element: 'abc',
-     *   number_element: 123,
-     * }
-     *
-     * jobs.createJob(newJob, preFillData).then((job) => {
-     *   // job.id can be used to delete the Job
-     * })
-     * ```
+     * **Minimum Role Permission**
+     *
+     * Jobs: _Manager_
+     *
+     * Upload Form Prefill Data: _On_ (only if using `preFillData`)
+     *
+     * @example
+     *   const newJob = {
+     *     username: 'user@domain.io',
+     *     formId: 1,
+     *     externalId: 'your-job-identifier',
+     *     details: {
+     *       key: 'JOB-123',
+     *       title: 'Job Title',
+     *       description: 'Job description',
+     *       type: 'Type',
+     *       priority: 3,
+     *     },
+     *   }
+     *
+     *   const preFillData = {
+     *     text_element: 'abc',
+     *     number_element: 123,
+     *   }
+     *
+     *   jobs.createJob(newJob, preFillData).then((job) => {
+     *     // job.id can be used to delete the Job
+     *   })
      *
      * @param data The Job to create
      * @param preFillData Key/value pairs with the form field names as keys and
      *   the pre-fill data as the values
+     * @returns
      */
     async createJob(data, preFillData) {
         const result = newJobSchema.validate(data, { stripUnknown: true });
@@ -89,16 +89,18 @@ class Jobs extends one_blink_api_1.default {
     /**
      * Delete a single Job
      *
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Jobs: _Manager_
      *
-     * ```javascript
-     * const jobId = 'f73985fd-2dba-4bf7-abbe-e204889f5216'
-     * jobs.deleteJob(jobId).then(() => {
-     *   // Job has been deleted
-     * })
-     * ```
+     * @example
+     *   const jobId = 'f73985fd-2dba-4bf7-abbe-e204889f5216'
+     *   jobs.deleteJob(jobId).then(() => {
+     *     // Job has been deleted
+     *   })
      *
      * @param jobId The exact id of the job you wish to delete
+     * @returns
      */
     deleteJob(jobId) {
         if (!jobId || typeof jobId !== 'string') {
@@ -109,19 +111,21 @@ class Jobs extends one_blink_api_1.default {
     /**
      * Search Jobs
      *
-     * #### Example
+     * **Minimum Role Permission**
      *
-     * ```javascript
-     * const results = await jobs.searchJobs({
-     *   username: 'user@domain.io',
-     *   formId: 10,
-     * })
+     * Jobs: _Read Only_
      *
-     * // an array of jobs
-     * const jobs = results.jobs
-     * ```
+     * @example
+     *   const results = await jobs.searchJobs({
+     *     username: 'user@domain.io',
+     *     formId: 10,
+     *   })
+     *
+     *   // an array of jobs
+     *   const jobs = results.jobs
      *
      * @param options Search options
+     * @returns
      */
     async searchJobs(options) {
         let searchOptions = {};
@@ -142,10 +146,7 @@ class Jobs extends one_blink_api_1.default {
                     username: options.username,
                 });
             }
-            if (options.isSubmitted) {
-                if (typeof options.isSubmitted !== 'boolean') {
-                    throw new TypeError(`isSubmitted must be provided as a boolean or not at all`);
-                }
+            if (typeof options.isSubmitted === 'boolean') {
                 searchOptions = Object.assign(searchOptions, {
                     isSubmitted: options.isSubmitted,
                 });

package/tenants/classes/Jobs.js.map

@@ -1 +1 @@
-{"version":3,"file":"Jobs.js","sourceRoot":"","sources":["../../src/classes/Jobs.ts"],"names":[],"mappings":";;;;;AACA,8CAAqB;AAErB,yEAA8C;AAG9C,MAAM,YAAY,GAAG,aAAG,CAAC,MAAM,EAAE;KAC9B,QAAQ,EAAE;KACV,IAAI,CAAC;IACJ,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE;IACxB,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC;QACpC,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE;QACjB,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE;QACzB,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;QAClB,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE;KACvB,CAAC;CACH,CAAC,CAAA;AAEJ,MAAqB,IAAK,SAAQ,uBAAW;IAC3C;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,SAAS,CACb,IAAoC,EACpC,WAAqC;QAErC,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAA;QAClE,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,KAAK,CAAA;QACpB,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,KAAuC,CAAA;QAE7D,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,EAAE,iBAAiB,EAAE,GACzB,MAAM,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC;gBAC5C,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,WAAW,EAAE,WAAW;aACzB,CAAC,CAAA;YACJ,MAAM,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;QAC9C,CAAC;QAED,MAAM,GAAG,GAAgC,MAAM,KAAK,CAAC,WAAW,CAC9D,OAAO,EACP,MAAM,CACP,CAAA;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,KAAa;QACrB,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACxC,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC,CAAA;QACzE,CAAC;QAED,OAAO,KAAK,CAAC,aAAa,CAAC,SAAS,KAAK,EAAE,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,UAAU,CAAC,OAgBhB;QACC,IAAI,aAAa,GAAG,EAAE,CAAA;QAEtB,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACvB,IAAI,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;oBAC3C,MAAM,IAAI,SAAS,CACjB,uDAAuD,CACxD,CAAA;gBACH,CAAC;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,UAAU,EAAE,OAAO,CAAC,UAAU;iBAC/B,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrB,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;oBACzC,MAAM,IAAI,SAAS,CACjB,qDAAqD,CACtD,CAAA;gBACH,CAAC;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,QAAQ,EAAE,OAAO,CAAC,QAAQ;iBAC3B,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;gBACxB,IAAI,OAAO,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC7C,MAAM,IAAI,SAAS,CACjB,yDAAyD,CAC1D,CAAA;gBACH,CAAC;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,WAAW,EAAE,OAAO,CAAC,WAAW;iBACjC,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnB,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;oBACvC,MAAM,IAAI,SAAS,CACjB,mDAAmD,CACpD,CAAA;gBACH,CAAC;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,MAAM,EAAE,OAAO,CAAC,MAAM;iBACvB,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBAClB,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;oBACtC,MAAM,IAAI,SAAS,CACjB,kDAAkD,CACnD,CAAA;gBACH,CAAC;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAA;YACxE,CAAC;YAED,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnB,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;oBACvC,MAAM,IAAI,SAAS,CACjB,mDAAmD,CACpD,CAAA;gBACH,CAAC;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,MAAM,EAAE,OAAO,CAAC,MAAM;iBACvB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAqB,MAAM,KAAK,CAAC,aAAa,CACzD,OAAO,EACP,aAAa,CACd,CAAA;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;CACF;AAnND,uBAmNC"}
+{"version":3,"file":"Jobs.js","sourceRoot":"","sources":["../../src/classes/Jobs.ts"],"names":[],"mappings":";;;;;AACA,8CAAqB;AAErB,yEAA8C;AAG9C,MAAM,YAAY,GAAG,aAAG,CAAC,MAAM,EAAE;KAC9B,QAAQ,EAAE;KACV,IAAI,CAAC;IACJ,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE;IACxB,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC;QACpC,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE;QACjB,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE;QACzB,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;QAClB,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE;KACvB,CAAC;CACH,CAAC,CAAA;AAEJ,MAAqB,IAAK,SAAQ,uBAAW;IAC3C;;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,KAAK,CAAC,SAAS,CACb,IAAoC,EACpC,WAAqC;QAErC,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAA;QAClE,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,KAAK,CAAA;QACpB,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,KAAuC,CAAA;QAE7D,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,EAAE,iBAAiB,EAAE,GACzB,MAAM,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC;gBAC5C,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,WAAW,EAAE,WAAW;aACzB,CAAC,CAAA;YACJ,MAAM,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;QAC9C,CAAC;QAED,MAAM,GAAG,GAAgC,MAAM,KAAK,CAAC,WAAW,CAC9D,OAAO,EACP,MAAM,CACP,CAAA;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CAAC,KAAa;QACrB,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACxC,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC,CAAA;QACzE,CAAC;QAED,OAAO,KAAK,CAAC,aAAa,CAAC,SAAS,KAAK,EAAE,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,UAAU,CAAC,OAgBhB;QACC,IAAI,aAAa,GAAG,EAAE,CAAA;QAEtB,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACvB,IAAI,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;oBAC3C,MAAM,IAAI,SAAS,CACjB,uDAAuD,CACxD,CAAA;gBACH,CAAC;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,UAAU,EAAE,OAAO,CAAC,UAAU;iBAC/B,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrB,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;oBACzC,MAAM,IAAI,SAAS,CACjB,qDAAqD,CACtD,CAAA;gBACH,CAAC;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,QAAQ,EAAE,OAAO,CAAC,QAAQ;iBAC3B,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,OAAO,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC7C,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,WAAW,EAAE,OAAO,CAAC,WAAW;iBACjC,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnB,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;oBACvC,MAAM,IAAI,SAAS,CACjB,mDAAmD,CACpD,CAAA;gBACH,CAAC;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,MAAM,EAAE,OAAO,CAAC,MAAM;iBACvB,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBAClB,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;oBACtC,MAAM,IAAI,SAAS,CACjB,kDAAkD,CACnD,CAAA;gBACH,CAAC;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAA;YACxE,CAAC;YAED,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnB,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;oBACvC,MAAM,IAAI,SAAS,CACjB,mDAAmD,CACpD,CAAA;gBACH,CAAC;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,MAAM,EAAE,OAAO,CAAC,MAAM;iBACvB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAqB,MAAM,KAAK,CAAC,aAAa,CACzD,OAAO,EACP,aAAa,CACd,CAAA;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;CACF;AAlND,uBAkNC"}

package/tenants/classes/Keys.d.ts

@@ -3,28 +3,25 @@ import OneBlinkAPI from '../lib/one-blink-api';
 import { ConstructorOptions } from '../types';
 export default class Keys extends OneBlinkAPI {
     /**
-     * #### Example
-     *
-     * ```typescript
-     * const OneBlink = require('@oneblink/sdk')
-     *
-     * const options = {
-     *   accessKey: '123455678901ABCDEFGHIJKL',
-     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
-     * }
-     * const keys = new OneBlink.Keys(options)
-     * ```
+     * @example
+     *   const OneBlink = require('@oneblink/sdk')
+     *   const options = {
+     *     accessKey: '123455678901ABCDEFGHIJKL',
+     *     secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     *   }
+     *   const keys = new OneBlink.Keys(options)
      */
     constructor(options: ConstructorOptions);
     /**
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Calendar Bookings, Integrations & Development Keys: _Read Only_
      *
-     * ```javascript
-     * const keyId = '123455678901ABCDEFGHIJKL'
-     * keys.getKey(keyId).then((key) => {
-     *   // Use key here...
-     * })
-     * ```
+     * @example
+     *   const keyId = '123455678901ABCDEFGHIJKL'
+     *   keys.getKey(keyId).then((key) => {
+     *     // Use key here...
+     *   })
      *
      * @param keyId The exact id of the key you wish to get
      * @returns

package/tenants/classes/Keys.js

@@ -6,31 +6,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const one_blink_api_1 = __importDefault(require("../lib/one-blink-api"));
 class Keys extends one_blink_api_1.default {
     /**
-     * #### Example
-     *
-     * ```typescript
-     * const OneBlink = require('@oneblink/sdk')
-     *
-     * const options = {
-     *   accessKey: '123455678901ABCDEFGHIJKL',
-     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
-     * }
-     * const keys = new OneBlink.Keys(options)
-     * ```
+     * @example
+     *   const OneBlink = require('@oneblink/sdk')
+     *   const options = {
+     *     accessKey: '123455678901ABCDEFGHIJKL',
+     *     secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     *   }
+     *   const keys = new OneBlink.Keys(options)
      */
     constructor(options) {
         options = options || {};
         super(options.accessKey, options.secretKey);
     }
     /**
-     * #### Example
+     * **Minimum Role Permission**
+     *
+     * Calendar Bookings, Integrations & Development Keys: _Read Only_
      *
-     * ```javascript
-     * const keyId = '123455678901ABCDEFGHIJKL'
-     * keys.getKey(keyId).then((key) => {
-     *   // Use key here...
-     * })
-     * ```
+     * @example
+     *   const keyId = '123455678901ABCDEFGHIJKL'
+     *   keys.getKey(keyId).then((key) => {
+     *     // Use key here...
+     *   })
      *
      * @param keyId The exact id of the key you wish to get
      * @returns

package/tenants/classes/Keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"Keys.js","sourceRoot":"","sources":["../../src/classes/Keys.ts"],"names":[],"mappings":";;;;;AACA,yEAA8C;AAG9C,MAAqB,IAAK,SAAQ,uBAAW;IAC3C;;;;;;;;;;;;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;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,KAAa;QAClB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC,CAAA;QACzE,CAAC;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,SAAS,KAAK,EAAE,CAAC,CAAA;IAC3C,CAAC;CACF;AAvCD,uBAuCC"}
+{"version":3,"file":"Keys.js","sourceRoot":"","sources":["../../src/classes/Keys.ts"],"names":[],"mappings":";;;;;AACA,yEAA8C;AAG9C,MAAqB,IAAK,SAAQ,uBAAW;IAC3C;;;;;;;;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;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,KAAa;QAClB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC,CAAA;QACzE,CAAC;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,SAAS,KAAK,EAAE,CAAC,CAAA;IAC3C,CAAC;CACF;AApCD,uBAoCC"}

package/tenants/classes/Organisations.d.ts

@@ -3,42 +3,35 @@ 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)
-     * ```
+     * @example
+     *   const OneBlink = require('@oneblink/sdk')
+     *   const options = {
+     *     accessKey: '123455678901ABCDEFGHIJKL',
+     *     secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     *   }
+     *   const organisations = new OneBlink.Organisations(options)
      */
     constructor(options: ConstructorOptions);
     /**
-     * #### Example
+     * @example
+     *   const organisation = await organisations.getOrganisation()
+     *   // Use organisation here...
      *
-     * ```javascript
-     * const organisation = await organisations.getOrganisation()
-     * // Use organisation here...
-     * ```
+     * @returns
      */
     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...
-     * ```
+     * @example
+     *   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
+     * @returns
      */
     uploadAsset(asset: {
         assetData: unknown;

package/tenants/classes/Organisations.js

@@ -7,29 +7,24 @@ const one_blink_api_1 = __importDefault(require("../lib/one-blink-api"));
 const stream_1 = require("stream");
 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)
-     * ```
+     * @example
+     *   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
+     * @example
+     *   const organisation = await organisations.getOrganisation()
+     *   // Use organisation here...
      *
-     * ```javascript
-     * const organisation = await organisations.getOrganisation()
-     * // Use organisation here...
-     * ```
+     * @returns
      */
     async getOrganisation() {
         const searchResponse = await super.getRequest('/organisations');
@@ -39,19 +34,17 @@ class Organisations extends one_blink_api_1.default {
         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...
-     * ```
+     * @example
+     *   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
+     * @returns
      */
     async uploadAsset(asset) {
         const { assetData, assetFileName, assetContentType } = asset;

package/tenants/classes/Organisations.js.map

@@ -1 +1 @@
-{"version":3,"file":"Organisations.js","sourceRoot":"","sources":["../../src/classes/Organisations.ts"],"names":[],"mappings":";;;;;AACA,yEAA8C;AAE9C,mCAAiC;AAEjC,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,CAAC;YACtE,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAA;QACpE,CAAC;QAED,OAAO,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;IACxC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,WAAW,CAAC,KAIjB;QACC,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAA;QAC5D,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;YACtC,MAAM,IAAI,SAAS,CAAC,yCAAyC,CAAC,CAAA;QAChE,CAAC;QACD,IAAI,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE,CAAC;YAC7D,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAA;QACzE,CAAC;QAED,IACE,OAAO,SAAS,KAAK,QAAQ;YAC7B,CAAC,CACC,SAAS,YAAY,MAAM;gBAC3B,SAAS,YAAY,UAAU;gBAC/B,SAAS,YAAY,iBAAQ,CAC9B,EACD,CAAC;YACD,MAAM,IAAI,SAAS,CACjB,qEAAqE,CACtE,CAAA;QACH,CAAC;QACD,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAA;QAE3D,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC;YACtD,IAAI,EAAE,SAAS;YACf,oEAAoE;YACpE,WAAW,EAAE,gBAAgB,IAAI,0BAA0B;YAC3D,QAAQ,EAAE,aAAa;YACvB,cAAc;SACf,CAAC,CAAA;QACF,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAA;IAC1B,CAAC;CACF;AAzFD,gCAyFC"}
+{"version":3,"file":"Organisations.js","sourceRoot":"","sources":["../../src/classes/Organisations.ts"],"names":[],"mappings":";;;;;AACA,yEAA8C;AAE9C,mCAAiC;AAEjC,MAAqB,aAAc,SAAQ,uBAAW;IACpD;;;;;;;;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;;;;;;OAMG;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,CAAC;YACtE,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAA;QACpE,CAAC;QAED,OAAO,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;IACxC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,WAAW,CAAC,KAIjB;QACC,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAA;QAC5D,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;YACtC,MAAM,IAAI,SAAS,CAAC,yCAAyC,CAAC,CAAA;QAChE,CAAC;QACD,IAAI,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE,CAAC;YAC7D,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAA;QACzE,CAAC;QAED,IACE,OAAO,SAAS,KAAK,QAAQ;YAC7B,CAAC,CACC,SAAS,YAAY,MAAM;gBAC3B,SAAS,YAAY,UAAU;gBAC/B,SAAS,YAAY,iBAAQ,CAC9B,EACD,CAAC;YACD,MAAM,IAAI,SAAS,CACjB,qEAAqE,CACtE,CAAA;QACH,CAAC;QACD,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAA;QAE3D,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC;YACtD,IAAI,EAAE,SAAS;YACf,oEAAoE;YACpE,WAAW,EAAE,gBAAgB,IAAI,0BAA0B;YAC3D,QAAQ,EAAE,aAAa;YACvB,cAAc;SACf,CAAC,CAAA;QACF,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAA;IAC1B,CAAC;CACF;AAlFD,gCAkFC"}