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

package/tenants/classes/FormsApps.js

@@ -0,0 +1,296 @@
+"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 jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+const basePath = `/forms-apps`;
+class FormsApps extends one_blink_api_1.default {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * const OneBlink = require('@oneblink/sdk')
+     *
+     * const options = {
+     *   accessKey: '123455678901ABCDEFGHIJKL',
+     *   secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
+     * }
+     * const formsAppsSDK = new OneBlink.FormsApps(options)
+     * ```
+     */
+    constructor(options) {
+        options = options || {};
+        super(options.accessKey, options.secretKey);
+    }
+    /**
+     * Verify a JWT and return its result
+     *
+     * #### Example
+     *
+     * ```javascript
+     * const token =
+     *   'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
+     * // or
+     * const token =
+     *   'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
+     * OneBlink.FormsApps.verifyJWT(token)
+     *   .then((result) => {
+     *     // Result is Decoded Token
+     *   })
+     *   .catch((e) => {
+     *     // Token was invalid
+     *   })
+     * ```
+     *
+     * @param token The JWT you wish to verify
+     */
+    async verifyJWT(token) {
+        if (token.includes('Bearer ')) {
+            token = token.split(' ')[1];
+        }
+        await this.getMyFormsApp(token);
+        return jsonwebtoken_1.default.decode(token);
+    }
+    /** @deprecated Use `(new FormsApps()).verifyJWT()` instead */
+    static async verifyJWT(token) {
+        const formsAppsClient = new FormsApps({
+            accessKey: 'not used',
+            secretKey: 'not used',
+        });
+        return await formsAppsClient.verifyJWT(token);
+    }
+    /**
+     * Get a single Forms App by its identifier
+     *
+     * #### Example
+     *
+     * ```javascript
+     * const formsAppId = 1
+     * formsAppsSDK.getFormsApp(formsAppId).then((formsApp) => {
+     *   // Use Forms App here...
+     * })
+     * ```
+     *
+     * @param formsAppId The exact identifier of the Forms App you wish to get
+     */
+    async getFormsApp(formsAppId) {
+        if (typeof formsAppId !== 'number') {
+            return Promise.reject(new TypeError('Must supply "formsAppId" as a number'));
+        }
+        return super.getRequest(`${basePath}/${formsAppId}`);
+    }
+    /**
+     * Get a single Forms App for the Bearer token of a Forms App User
+     *
+     * #### Example
+     *
+     * ```javascript
+     * const bearerToken = ''
+     * formsAppsSDK.getMyFormsApp(bearerToken).then((formsApp) => {
+     *   // Use Forms App here...
+     * })
+     * ```
+     *
+     * @param formsAppUserToken The Bearer token in the `Authorization` header
+     *   from a request from an App User
+     */
+    async getMyFormsApp(formsAppUserToken) {
+        if (typeof formsAppUserToken !== 'string') {
+            return Promise.reject(new TypeError('Must supply "formsAppUserToken" as a string'));
+        }
+        const response = await super.request({
+            origin: one_blink_api_1.default.tenant.apiOrigin,
+            method: 'GET',
+            path: '/my-forms-app',
+            headers: {
+                Authorization: `Bearer ${formsAppUserToken}`,
+            },
+        });
+        return await response.json();
+    }
+    /**
+     * Create a Forms App
+     *
+     * #### Example
+     *
+     * ```javascript
+     * formsAppsSDK.createFormsApp(formsApp).then((savedFormsApp) => {
+     *   // Use Forms App here...
+     * })
+     * ```
+     *
+     * @param formsApp Forms App properties
+     */
+    async createFormsApp(formsApp) {
+        return super.postRequest(basePath, formsApp);
+    }
+    /**
+     * Update a Forms App
+     *
+     * #### Example
+     *
+     * ```javascript
+     * formsAppsSDK.updateFormsApp(formsApp).then((savedFormsApp) => {
+     *   // Use Forms App here...
+     * })
+     * ```
+     *
+     * @param formsApp Forms App properties
+     */
+    async updateFormsApp(formsApp) {
+        if (!formsApp || typeof formsApp.id !== 'number') {
+            return Promise.reject(new TypeError('Must supply "formsApp.id" as a number'));
+        }
+        return super.putRequest(`${basePath}/${formsApp.id}`, formsApp);
+    }
+    /**
+     * Delete a Forms App by its identifier
+     *
+     * #### Example
+     *
+     * ```javascript
+     * const formsAppId = 1
+     * formsAppsSDK.deleteFormsApp(formsAppId).then(() => {
+     *   // Forms App has been deleted...
+     * })
+     * ```
+     *
+     * @param formsAppId The exact identifier of the Forms App you wish to delete
+     */
+    async deleteFormsApp(formsAppId) {
+        if (typeof formsAppId !== 'number') {
+            return Promise.reject(new TypeError('Must supply "formsAppId" as a number'));
+        }
+        return super.deleteRequest(`${basePath}/${formsAppId}`);
+    }
+    /**
+     * Update styles for Forms App
+     *
+     * #### Example
+     *
+     * ```javascript
+     * formsAppsSDK.updateStyles(formsAppId, styles).then(() => {
+     *   // Styles have been updated...
+     * })
+     * ```
+     *
+     * @param formsAppId The exact identifier of the Forms App you wish to update the styles
+     * @param styles Forms App styles properties
+     */
+    async updateStyles(formsAppId, styles) {
+        if (typeof formsAppId !== 'number') {
+            return Promise.reject(new TypeError('Must supply "formsAppId" as a number'));
+        }
+        return super.putRequest(`${basePath}/${formsAppId}/styles`, styles);
+    }
+    /**
+     * Create a Forms App User
+     *
+     * #### Example
+     *
+     * ```javascript
+     * formsAppsSDK.createUser(formsAppUser).then((savedFormsAppUser) => {
+     *   // Use Forms App User here...
+     * })
+     * ```
+     *
+     * @param formsAppUser Forms App User
+     */
+    async createUser(formsAppUser) {
+        return super.postRequest('/appUsers', formsAppUser);
+    }
+    /**
+     * Delete a Forms App User by its identifier
+     *
+     * #### Example
+     *
+     * ```javascript
+     * const formsAppUserId = 1
+     * formsAppsSDK.deleteUser(formsAppUserId).then(() => {
+     *   // Forms App User has been deleted...
+     * })
+     * ```
+     *
+     * @param formsAppUserId The exact Forms App User identifier you wish to delete
+     */
+    async deleteUser(formsAppUserId) {
+        if (typeof formsAppUserId !== 'number') {
+            return Promise.reject(new TypeError('Must supply "formsAppUserId" as a number'));
+        }
+        return super.deleteRequest(`/appUsers/${formsAppUserId}`);
+    }
+    /**
+     * Get the email address forms app emails will be sent from
+     *
+     * #### Example
+     *
+     * ```javascript
+     * const res = await formsAppsSDK.getSendingAddress(formsAppId)
+     * ```
+     *
+     * @param formsAppId The ID of the forms app you wish to get the sending address for
+     */
+    async getSendingAddress(formsAppId) {
+        if (typeof formsAppId !== 'number') {
+            return Promise.reject(new TypeError('Must supply "formsAppId" as a number'));
+        }
+        return super.getRequest(`/v2/forms-apps/${formsAppId}/sending-address`);
+    }
+    /**
+     * Set the email address forms app emails will be sent from
+     *
+     * #### Example
+     *
+     * ```javascript
+     * const res = await formsAppsSDK.setSendingAddress(
+     *   formsAppId,
+     *   sendingAddressConfig,
+     * )
+     * ```
+     *
+     * @param formsAppId The ID of the forms app you wish to set the sending address for
+     * @param sendingAddressConfig The object containing the `emailAddress` &
+     *   `emailName` properties
+     */
+    async setSendingAddress(formsAppId, sendingAddressConfig) {
+        if (typeof formsAppId !== 'number') {
+            return Promise.reject(new TypeError('Must supply "formsAppId" as a number'));
+        }
+        if (!sendingAddressConfig) {
+            return Promise.reject(new TypeError('Must supply an object containing "emailAddress" & "emailName" properties'));
+        }
+        if (typeof sendingAddressConfig.emailAddress !== 'string') {
+            return Promise.reject(new TypeError('Must supply "emailAddress" as a string'));
+        }
+        if (sendingAddressConfig.emailName &&
+            typeof sendingAddressConfig.emailName !== 'string') {
+            return Promise.reject(new TypeError('Must supply "emailName" as a string or not at all'));
+        }
+        return super.postRequest(`/v2/forms-apps/${formsAppId}/sending-address`, {
+            emailAddress: sendingAddressConfig.emailAddress,
+            emailName: sendingAddressConfig.emailName,
+        });
+    }
+    /**
+     * Remove a custom sending address for a forms app
+     *
+     * #### Example
+     *
+     * ```javascript
+     * const formsAppId = 1
+     * await formsAppsSDK.deleteSendingAddress(formsAppId)
+     * ```
+     *
+     * @param formsAppId The ID of the forms app you wish to remove the sending address from
+     */
+    async deleteSendingAddress(formsAppId) {
+        if (typeof formsAppId !== 'number') {
+            return Promise.reject(new TypeError('Must supply "formsAppId" as a number'));
+        }
+        return super.deleteRequest(`/forms-apps/${formsAppId}/sending-address`);
+    }
+}
+exports.default = FormsApps;
+//# sourceMappingURL=FormsApps.js.map

package/tenants/classes/FormsApps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormsApps.js","sourceRoot":"","sources":["../../src/classes/FormsApps.ts"],"names":[],"mappings":";;;;;AACA,yEAA8C;AAE9C,gEAA8B;AAE9B,MAAM,QAAQ,GAAG,aAAa,CAAA;AAE9B,MAAqB,SAAU,SAAQ,uBAAW;IAChD;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,SAAS,CACb,KAAa;QAEb,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;YAC7B,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;SAC5B;QAED,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;QAE/B,OAAO,sBAAG,CAAC,MAAM,CAAC,KAAK,CAAM,CAAA;IAC/B,CAAC;IAED,8DAA8D;IAC9D,MAAM,CAAC,KAAK,CAAC,SAAS,CACpB,KAAa;QAEb,MAAM,eAAe,GAAG,IAAI,SAAS,CAAC;YACpC,SAAS,EAAE,UAAU;YACrB,SAAS,EAAE,UAAU;SACtB,CAAC,CAAA;QAEF,OAAO,MAAM,eAAe,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IAC/C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,WAAW,CAAC,UAAkB;QAClC,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAClC,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,SAAS,CAAC,sCAAsC,CAAC,CACtD,CAAA;SACF;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,QAAQ,IAAI,UAAU,EAAE,CAAC,CAAA;IACtD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,aAAa,CACjB,iBAA2B;QAE3B,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;YACzC,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAC7D,CAAA;SACF;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC;YACnC,MAAM,EAAE,uBAAW,CAAC,MAAM,CAAC,SAAS;YACpC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,iBAAiB,EAAE;aAC7C;SACF,CAAC,CAAA;QACF,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;IAC9B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,cAAc,CAClB,QAAoD;QAEpD,OAAO,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,cAAc,CAClB,QAAiC;QAEjC,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,CAAC,EAAE,KAAK,QAAQ,EAAE;YAChD,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,SAAS,CAAC,uCAAuC,CAAC,CACvD,CAAA;SACF;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,QAAQ,IAAI,QAAQ,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAA;IACjE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,cAAc,CAAC,UAAkB;QACrC,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAClC,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,SAAS,CAAC,sCAAsC,CAAC,CACtD,CAAA;SACF;QAED,OAAO,KAAK,CAAC,aAAa,CAAC,GAAG,QAAQ,IAAI,UAAU,EAAE,CAAC,CAAA;IACzD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,YAAY,CAChB,UAAkB,EAClB,MAA0E;QAE1E,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAClC,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,SAAS,CAAC,sCAAsC,CAAC,CACtD,CAAA;SACF;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,QAAQ,IAAI,UAAU,SAAS,EAAE,MAAM,CAAC,CAAA;IACrE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CACd,YAA4C;QAE5C,OAAO,KAAK,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;IACrD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,UAAU,CAAC,cAAsB;QACrC,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;YACtC,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,SAAS,CAAC,0CAA0C,CAAC,CAC1D,CAAA;SACF;QAED,OAAO,KAAK,CAAC,aAAa,CAAC,aAAa,cAAc,EAAE,CAAC,CAAA;IAC3D,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,iBAAiB,CACrB,UAAkB;QAElB,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAClC,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,SAAS,CAAC,sCAAsC,CAAC,CACtD,CAAA;SACF;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,kBAAkB,UAAU,kBAAkB,CAAC,CAAA;IACzE,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,iBAAiB,CACrB,UAAkB,EAClB,oBAGC;QAED,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAClC,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,SAAS,CAAC,sCAAsC,CAAC,CACtD,CAAA;SACF;QAED,IAAI,CAAC,oBAAoB,EAAE;YACzB,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,SAAS,CACX,0EAA0E,CAC3E,CACF,CAAA;SACF;QAED,IAAI,OAAO,oBAAoB,CAAC,YAAY,KAAK,QAAQ,EAAE;YACzD,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,SAAS,CAAC,wCAAwC,CAAC,CACxD,CAAA;SACF;QAED,IACE,oBAAoB,CAAC,SAAS;YAC9B,OAAO,oBAAoB,CAAC,SAAS,KAAK,QAAQ,EAClD;YACA,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,SAAS,CAAC,mDAAmD,CAAC,CACnE,CAAA;SACF;QAED,OAAO,KAAK,CAAC,WAAW,CAAC,kBAAkB,UAAU,kBAAkB,EAAE;YACvE,YAAY,EAAE,oBAAoB,CAAC,YAAY;YAC/C,SAAS,EAAE,oBAAoB,CAAC,SAAS;SAC1C,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,oBAAoB,CAAC,UAAkB;QAC3C,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAClC,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,SAAS,CAAC,sCAAsC,CAAC,CACtD,CAAA;SACF;QAED,OAAO,KAAK,CAAC,aAAa,CAAC,eAAe,UAAU,kBAAkB,CAAC,CAAA;IACzE,CAAC;CACF;AA3WD,4BA2WC"}

package/tenants/classes/Jobs.d.ts

@@ -0,0 +1,102 @@
+import { SubmissionTypes } from '@oneblink/types';
+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)
+     * ```
+     */
+    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
+     * })
+     * ```
+     *
+     * @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
+     */
+    createJob(data: SubmissionTypes.NewFormsAppJob, preFillData?: Record<string, unknown>): Promise<SubmissionTypes.FormsAppJob>;
+    /**
+     * Delete a single Job
+     *
+     * #### Example
+     *
+     * ```javascript
+     * 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
+     */
+    deleteJob(jobId: string): Promise<void>;
+    /**
+     * Search Jobs
+     *
+     * #### Example
+     *
+     * ```javascript
+     * const results = await jobs.searchJobs({
+     *   username: 'user@domain.io',
+     *   formId: 10,
+     * })
+     *
+     * // an array of jobs
+     * const jobs = results.jobs
+     * ```
+     *
+     * @param options Search options
+     */
+    searchJobs(options?: {
+        /** The `externalId` property of a job */
+        externalId?: string;
+        /** The `formId` matching the form that a job was created for */
+        formId?: number;
+        /** The `username` that the job was assigned to */
+        username?: string;
+        /** Whether the job has been submitted or not */
+        isSubmitted?: boolean;
+        /** Limit the number of jobs returned */
+        limit?: number;
+        /**
+         * Skip a specific number of results, used in conjunction with `limit` to
+         * enforce paging
+         */
+        offset?: number;
+    }): Promise<JobsSearchResult>;
+}

package/tenants/classes/Jobs.js

@@ -0,0 +1,180 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const joi_1 = __importDefault(require("joi"));
+const one_blink_api_1 = __importDefault(require("../lib/one-blink-api"));
+const pre_fill_data_1 = __importDefault(require("../lib/pre-fill-data"));
+const newJobSchema = joi_1.default.object()
+    .required()
+    .keys({
+    username: joi_1.default.string().required(),
+    formId: joi_1.default.number().required().min(1),
+    externalId: joi_1.default.string(),
+    details: joi_1.default.object().required().keys({
+        key: joi_1.default.string(),
+        title: joi_1.default.string().required(),
+        description: joi_1.default.string(),
+        type: joi_1.default.string(),
+        priority: joi_1.default.number(),
+    }),
+});
+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)
+     * ```
+     */
+    constructor(options) {
+        options = options || {};
+        super(options.accessKey, options.secretKey);
+    }
+    /**
+     * 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
+     * })
+     * ```
+     *
+     * @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
+     */
+    async createJob(data, preFillData) {
+        const result = newJobSchema.validate(data, { stripUnknown: true });
+        if (result.error) {
+            throw result.error;
+        }
+        const newJob = result.value;
+        if (preFillData) {
+            const preFillMeta = await super.postEmptyRequest(`/forms/${newJob.formId}/pre-fill-credentials`);
+            await (0, pre_fill_data_1.default)(preFillMeta, preFillData);
+            newJob.preFillFormDataId = preFillMeta.preFillFormDataId;
+        }
+        const job = await super.postRequest('/jobs', newJob);
+        return job;
+    }
+    /**
+     * Delete a single Job
+     *
+     * #### Example
+     *
+     * ```javascript
+     * 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
+     */
+    deleteJob(jobId) {
+        if (!jobId || typeof jobId !== 'string') {
+            return Promise.reject(new TypeError('Must supply "jobId" as a string'));
+        }
+        return super.deleteRequest(`/jobs/${jobId}`);
+    }
+    /**
+     * Search Jobs
+     *
+     * #### Example
+     *
+     * ```javascript
+     * const results = await jobs.searchJobs({
+     *   username: 'user@domain.io',
+     *   formId: 10,
+     * })
+     *
+     * // an array of jobs
+     * const jobs = results.jobs
+     * ```
+     *
+     * @param options Search options
+     */
+    async searchJobs(options) {
+        let searchOptions = {};
+        if (options) {
+            if (options.externalId) {
+                if (typeof options.externalId !== 'string') {
+                    throw new TypeError(`externalId must be provided as a string or not at all`);
+                }
+                searchOptions = Object.assign(searchOptions, {
+                    externalId: options.externalId,
+                });
+            }
+            if (options.username) {
+                if (typeof options.username !== 'string') {
+                    throw new TypeError(`username must be provided as a string or not at all`);
+                }
+                searchOptions = Object.assign(searchOptions, {
+                    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`);
+                }
+                searchOptions = Object.assign(searchOptions, {
+                    isSubmitted: options.isSubmitted,
+                });
+            }
+            if (options.formId) {
+                if (typeof options.formId !== 'number') {
+                    throw new TypeError(`formId must be provided as a number or not at all`);
+                }
+                searchOptions = Object.assign(searchOptions, {
+                    formId: options.formId,
+                });
+            }
+            if (options.limit) {
+                if (typeof options.limit !== 'number') {
+                    throw new TypeError(`limit must be provided as a number or not at all`);
+                }
+                searchOptions = Object.assign(searchOptions, { limit: options.limit });
+            }
+            if (options.offset) {
+                if (typeof options.offset !== 'number') {
+                    throw new TypeError(`offset must be provided as a number or not at all`);
+                }
+                searchOptions = Object.assign(searchOptions, {
+                    offset: options.offset,
+                });
+            }
+        }
+        const results = await super.searchRequest(`/jobs`, searchOptions);
+        return results;
+    }
+}
+exports.default = Jobs;
+//# sourceMappingURL=Jobs.js.map

package/tenants/classes/Jobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Jobs.js","sourceRoot":"","sources":["../../src/classes/Jobs.ts"],"names":[],"mappings":";;;;;AACA,8CAAqB;AAErB,yEAA8C;AAC9C,yEAAiD;AAGjD,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;YAChB,MAAM,MAAM,CAAC,KAAK,CAAA;SACnB;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,KAAuC,CAAA;QAE7D,IAAI,WAAW,EAAE;YACf,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,gBAAgB,CAC9C,UAAU,MAAM,CAAC,MAAM,uBAAuB,CAC/C,CAAA;YACD,MAAM,IAAA,uBAAc,EAAC,WAAW,EAAE,WAAW,CAAC,CAAA;YAC9C,MAAM,CAAC,iBAAiB,GAAG,WAAW,CAAC,iBAAiB,CAAA;SACzD;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;YACvC,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC,CAAA;SACxE;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;YACX,IAAI,OAAO,CAAC,UAAU,EAAE;gBACtB,IAAI,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ,EAAE;oBAC1C,MAAM,IAAI,SAAS,CACjB,uDAAuD,CACxD,CAAA;iBACF;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,UAAU,EAAE,OAAO,CAAC,UAAU;iBAC/B,CAAC,CAAA;aACH;YAED,IAAI,OAAO,CAAC,QAAQ,EAAE;gBACpB,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE;oBACxC,MAAM,IAAI,SAAS,CACjB,qDAAqD,CACtD,CAAA;iBACF;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,QAAQ,EAAE,OAAO,CAAC,QAAQ;iBAC3B,CAAC,CAAA;aACH;YAED,IAAI,OAAO,CAAC,WAAW,EAAE;gBACvB,IAAI,OAAO,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE;oBAC5C,MAAM,IAAI,SAAS,CACjB,yDAAyD,CAC1D,CAAA;iBACF;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,WAAW,EAAE,OAAO,CAAC,WAAW;iBACjC,CAAC,CAAA;aACH;YAED,IAAI,OAAO,CAAC,MAAM,EAAE;gBAClB,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE;oBACtC,MAAM,IAAI,SAAS,CACjB,mDAAmD,CACpD,CAAA;iBACF;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,MAAM,EAAE,OAAO,CAAC,MAAM;iBACvB,CAAC,CAAA;aACH;YAED,IAAI,OAAO,CAAC,KAAK,EAAE;gBACjB,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,EAAE;oBACrC,MAAM,IAAI,SAAS,CACjB,kDAAkD,CACnD,CAAA;iBACF;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAA;aACvE;YAED,IAAI,OAAO,CAAC,MAAM,EAAE;gBAClB,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE;oBACtC,MAAM,IAAI,SAAS,CACjB,mDAAmD,CACpD,CAAA;iBACF;gBACD,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE;oBAC3C,MAAM,EAAE,OAAO,CAAC,MAAM;iBACvB,CAAC,CAAA;aACH;SACF;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

@@ -0,0 +1,33 @@
+import { KeyTypes } from '@oneblink/types';
+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)
+     * ```
+     */
+    constructor(options: ConstructorOptions);
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const keyId = '123455678901ABCDEFGHIJKL'
+     * keys.getKey(keyId).then((key) => {
+     *   // Use key here...
+     * })
+     * ```
+     *
+     * @param keyId The exact id of the key you wish to get
+     * @returns
+     */
+    getKey(keyId: string): Promise<KeyTypes.Key>;
+}

package/tenants/classes/Keys.js

@@ -0,0 +1,46 @@
+"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 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)
+     * ```
+     */
+    constructor(options) {
+        options = options || {};
+        super(options.accessKey, options.secretKey);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const keyId = '123455678901ABCDEFGHIJKL'
+     * keys.getKey(keyId).then((key) => {
+     *   // Use key here...
+     * })
+     * ```
+     *
+     * @param keyId The exact id of the key you wish to get
+     * @returns
+     */
+    getKey(keyId) {
+        if (typeof keyId !== 'string') {
+            return Promise.reject(new TypeError('Must supply "keyId" as a string'));
+        }
+        return super.getRequest(`/keys/${keyId}`);
+    }
+}
+exports.default = Keys;
+//# sourceMappingURL=Keys.js.map

package/tenants/classes/Keys.js.map

@@ -0,0 +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;YAC7B,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC,CAAA;SACxE;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,SAAS,KAAK,EAAE,CAAC,CAAA;IAC3C,CAAC;CACF;AAvCD,uBAuCC"}