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

package/tenants/lib/tenant-configuration.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CIVICPLUS = exports.ONEBLINK = void 0;
+exports.ONEBLINK = {
+    awsRegion: 'ap-southeast-2',
+    test: {
+        apiOrigin: 'https://auth-api.test.blinkm.io',
+    },
+    prod: {
+        apiOrigin: 'https://auth-api.blinkm.io',
+    },
+};
+exports.CIVICPLUS = {
+    awsRegion: 'us-east-2',
+    test: {
+        apiOrigin: 'https://auth-api.test.transform.civicplus.com',
+    },
+    prod: {
+        apiOrigin: 'https://auth-api.transform.civicplus.com',
+    },
+};
+//# sourceMappingURL=tenant-configuration.js.map

package/tenants/lib/tenant-configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant-configuration.js","sourceRoot":"","sources":["../../src/lib/tenant-configuration.ts"],"names":[],"mappings":";;;AAEa,QAAA,QAAQ,GAAwB;IAC3C,SAAS,EAAE,gBAAgB;IAC3B,IAAI,EAAE;QACJ,SAAS,EAAE,iCAAiC;KAC7C;IACD,IAAI,EAAE;QACJ,SAAS,EAAE,4BAA4B;KACxC;CACF,CAAA;AAEY,QAAA,SAAS,GAAwB;IAC5C,SAAS,EAAE,WAAW;IACtB,IAAI,EAAE;QACJ,SAAS,EAAE,+CAA+C;KAC3D;IACD,IAAI,EAAE;QACJ,SAAS,EAAE,0CAA0C;KACtD;CACF,CAAA"}

package/tenants/lib/upload-asset.d.ts

@@ -0,0 +1,4 @@
+import { PreFillMeta } from '../types';
+export default function uploadAsset<T>(assetCredentials: PreFillMeta, data: T, assetContentType?: string): Promise<{
+    Location: string;
+}>;

package/tenants/lib/upload-asset.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const aws_sdk_1 = __importDefault(require("aws-sdk"));
+async function uploadAsset(assetCredentials, data, assetContentType) {
+    const s3 = new aws_sdk_1.default.S3({
+        region: assetCredentials.s3.region,
+        accessKeyId: assetCredentials.credentials.AccessKeyId,
+        secretAccessKey: assetCredentials.credentials.SecretAccessKey,
+        sessionToken: assetCredentials.credentials.SessionToken,
+    });
+    const objectMeta = {
+        Bucket: assetCredentials.s3.bucket,
+        Key: assetCredentials.s3.key,
+        Body: data,
+        Expires: new Date(new Date().setFullYear(new Date().getFullYear() + 1)),
+        CacheControl: 'max-age=31536000',
+        ContentType: assetContentType,
+        ACL: 'public-read',
+    };
+    const uploadOptions = {
+        partSize: 5 * 1024 * 1024,
+        queueSize: 1,
+    };
+    return await s3.upload(objectMeta, uploadOptions).promise();
+}
+exports.default = uploadAsset;
+//# sourceMappingURL=upload-asset.js.map

package/tenants/lib/upload-asset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-asset.js","sourceRoot":"","sources":["../../src/lib/upload-asset.ts"],"names":[],"mappings":";;;;;AAAA,sDAAyB;AAGV,KAAK,UAAU,WAAW,CACvC,gBAA6B,EAC7B,IAAO,EACP,gBAAyB;IAEzB,MAAM,EAAE,GAAG,IAAI,iBAAG,CAAC,EAAE,CAAC;QACpB,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC,MAAM;QAClC,WAAW,EAAE,gBAAgB,CAAC,WAAW,CAAC,WAAW;QACrD,eAAe,EAAE,gBAAgB,CAAC,WAAW,CAAC,eAAe;QAC7D,YAAY,EAAE,gBAAgB,CAAC,WAAW,CAAC,YAAY;KACxD,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG;QACjB,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC,MAAM;QAClC,GAAG,EAAE,gBAAgB,CAAC,EAAE,CAAC,GAAG;QAC5B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;QACvE,YAAY,EAAE,kBAAkB;QAChC,WAAW,EAAE,gBAAgB;QAC7B,GAAG,EAAE,aAAa;KACnB,CAAA;IACD,MAAM,aAAa,GAAG;QACpB,QAAQ,EAAE,CAAC,GAAG,IAAI,GAAG,IAAI;QACzB,SAAS,EAAE,CAAC;KACb,CAAA;IACD,OAAO,MAAM,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,OAAO,EAAE,CAAA;AAC7D,CAAC;AA1BD,8BA0BC"}

package/tenants/lib/user-token-helpers.d.ts

@@ -0,0 +1,9 @@
+declare function encryptUserToken({ username, secret, }: {
+    username: string;
+    secret: string;
+}): string;
+declare function decryptUserToken({ userToken, secret, }: {
+    userToken: string;
+    secret: string;
+}): string;
+export { encryptUserToken, decryptUserToken };

package/tenants/lib/user-token-helpers.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decryptUserToken = exports.encryptUserToken = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const ALGORITHM = 'aes-256-cbc';
+const IV_LENGTH = 16; // For AES, this is always 16
+// Encryption key for this algorithm must be 256 bits (32 characters)
+const generateEncryptionKey = (secret) => crypto_1.default.createHash('md5').update(secret).digest('hex');
+function encryptUserToken({ username, secret, }) {
+    const encryptionKey = generateEncryptionKey(secret);
+    const iv = crypto_1.default.randomBytes(IV_LENGTH);
+    const cipher = crypto_1.default.createCipheriv(ALGORITHM, Buffer.from(encryptionKey), iv);
+    let encrypted = cipher.update(Buffer.from(username, 'utf8'));
+    encrypted = Buffer.concat([encrypted, cipher.final()]);
+    return Buffer.concat([iv, encrypted]).toString('base64');
+}
+exports.encryptUserToken = encryptUserToken;
+function decryptUserToken({ userToken, secret, }) {
+    const encryptionKey = generateEncryptionKey(secret);
+    const data = Buffer.from(userToken, 'base64');
+    const iv = Buffer.alloc(IV_LENGTH);
+    const encryptedText = Buffer.alloc(data.length - iv.length);
+    data.copy(iv, 0, 0, iv.length);
+    data.copy(encryptedText, 0, iv.length);
+    const decipher = crypto_1.default.createDecipheriv(ALGORITHM, Buffer.from(encryptionKey), iv);
+    let decrypted = decipher.update(encryptedText);
+    decrypted = Buffer.concat([decrypted, decipher.final()]);
+    return decrypted.toString();
+}
+exports.decryptUserToken = decryptUserToken;
+//# sourceMappingURL=user-token-helpers.js.map

package/tenants/lib/user-token-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-token-helpers.js","sourceRoot":"","sources":["../../src/lib/user-token-helpers.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2B;AAE3B,MAAM,SAAS,GAAG,aAAa,CAAA;AAC/B,MAAM,SAAS,GAAG,EAAE,CAAA,CAAC,6BAA6B;AAElD,qEAAqE;AACrE,MAAM,qBAAqB,GAAG,CAAC,MAAc,EAAE,EAAE,CAC/C,gBAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAEvD,SAAS,gBAAgB,CAAC,EACxB,QAAQ,EACR,MAAM,GAIP;IACC,MAAM,aAAa,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAA;IACnD,MAAM,EAAE,GAAG,gBAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;IACxC,MAAM,MAAM,GAAG,gBAAM,CAAC,cAAc,CAClC,SAAS,EACT,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,EAC1B,EAAE,CACH,CAAA;IACD,IAAI,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAA;IAE5D,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;IACtD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAC1D,CAAC;AA2BQ,4CAAgB;AAzBzB,SAAS,gBAAgB,CAAC,EACxB,SAAS,EACT,MAAM,GAIP;IACC,MAAM,aAAa,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAA;IACnD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAA;IAC7C,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;IAClC,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,MAAM,CAAC,CAAA;IAC3D,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAA;IAC9B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAA;IACtC,MAAM,QAAQ,GAAG,gBAAM,CAAC,gBAAgB,CACtC,SAAS,EACT,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,EAC1B,EAAE,CACH,CAAA;IACD,IAAI,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;IAE9C,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;IAExD,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAA;AAC7B,CAAC;AAE0B,4CAAgB"}

package/tenants/oneblink.d.ts

@@ -0,0 +1 @@
+export * from './classes';

package/tenants/oneblink.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const tenant_configuration_1 = require("./lib/tenant-configuration");
+const generate_tenant_1 = __importDefault(require("./lib/generate-tenant"));
+const one_blink_api_1 = __importDefault(require("./lib/one-blink-api"));
+const tenant = (0, generate_tenant_1.default)(tenant_configuration_1.ONEBLINK);
+one_blink_api_1.default.tenant = tenant;
+__exportStar(require("./classes"), exports);
+//# sourceMappingURL=oneblink.js.map

package/tenants/oneblink.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oneblink.js","sourceRoot":"","sources":["../src/oneblink.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,qEAAqD;AACrD,4EAAkD;AAClD,wEAA6C;AAE7C,MAAM,MAAM,GAAG,IAAA,yBAAc,EAAC,+BAAQ,CAAC,CAAA;AACvC,uBAAW,CAAC,MAAM,GAAG,MAAM,CAAA;AAC3B,4CAAyB"}

package/tenants/types.d.ts

@@ -0,0 +1,304 @@
+import { ApprovalTypes, EmailTemplateTypes, EnvironmentTypes, FormTypes, SubmissionTypes, MiscTypes, AWSTypes, SchedulingTypes } from '@oneblink/types';
+import { FormStoreRecord } from '@oneblink/types/typescript/submissions';
+import { HeadObjectOutput } from 'aws-sdk/clients/s3';
+import { SendMailOptions } from 'nodemailer';
+export * from '@oneblink/types';
+export { HeadObjectOutput };
+export declare type ConstructorOptions = {
+    accessKey: string;
+    secretKey: string;
+};
+export declare type PreFillMeta = AWSTypes.FormS3Credentials & {
+    preFillFormDataId: string;
+};
+export declare type BaseSearchOptions = {
+    /** Limit the number of results returned */
+    limit?: number;
+    /** Skip a specific number of results, used in conjunction with `limit` to enforce paging */
+    offset?: number;
+};
+export declare type TenantBase = {
+    awsRegion: string;
+};
+export declare type TenantEnvironment = {
+    apiOrigin: string;
+};
+export declare type TenantConfiguration = TenantBase & {
+    test: TenantEnvironment;
+    prod: TenantEnvironment;
+};
+export declare type Tenant = TenantBase & TenantEnvironment;
+export declare type FormSubmissionApprovalHistoryRecord = {
+    formSubmissionMeta: SubmissionTypes.FormSubmissionMeta;
+    formApprovalFlowInstance: ApprovalTypes.FormApprovalFlowInstance;
+    formSubmissionApprovals: ApprovalTypes.FormSubmissionApproval[];
+};
+export declare type FormSubmissionsAdministrationApprovalsResponse = MiscTypes.BaseSearchResult & {
+    approvals: Array<FormSubmissionApprovalHistoryRecord & {
+        history: FormSubmissionApprovalHistoryRecord[];
+    }>;
+};
+export declare type FormSubmissionApprovalResponse = {
+    formSubmissionMeta: SubmissionTypes.FormSubmissionMeta;
+    formSubmissionApproval: ApprovalTypes.FormSubmissionApproval;
+    formApprovalFlowInstance: ApprovalTypes.FormApprovalFlowInstance;
+    form: FormTypes.Form;
+    history: FormSubmissionApprovalHistoryRecord[];
+};
+export declare type FormApprovalFlowInstanceResponse = {
+    formSubmissionMeta: SubmissionTypes.FormSubmissionMeta;
+    formApprovalFlowInstance: ApprovalTypes.FormApprovalFlowInstance;
+    form: FormTypes.Form;
+    formSubmissionApprovals: ApprovalTypes.FormSubmissionApproval[];
+};
+export declare type FormsSearchResult = {
+    forms: FormTypes.Form[];
+} & MiscTypes.BaseSearchResult;
+export declare type FormsSearchOptions = BaseSearchOptions & {
+    /**
+     * Search on the `isAuthenticated` property of a form. Must be either `true`
+     * or `false` or not specified.
+     */
+    isAuthenticated?: boolean;
+    /** Search on the `name` property of a form. Can be a prefix, suffix or partial match */
+    name?: string;
+    /**
+     * Search on the `isInfoPage` property of a form. Must be either `true` or
+     * `false` or not specified.
+     */
+    isInfoPage?: boolean;
+    /**
+     * Search on the `formsAppIds` property of a form. Must be the exact match of
+     * one the ids in `formsAppIds`.
+     */
+    formsAppId?: number;
+    /**
+     * Search on the `formsAppEnvironmentId` property of a form. Must be the exact
+     * match of a `formsAppEnvironmentId`.
+     */
+    formsAppEnvironmentId?: number;
+};
+export declare type FormSubmissionHistorySearchParameters = BaseSearchOptions & {
+    /** Search for Submissions for a particular form Id */
+    formId: number;
+    /** Search for Submissions starting at this date */
+    submissionDateFrom?: string;
+    /** Search for Submissions ending on this date */
+    submissionDateTo?: string;
+    /**
+     * Search for only valid submissions, only invalid ones, or emit this property
+     * to search all
+     */
+    isValid?: boolean;
+};
+export declare type FormSubmissionHistorySearchResults = MiscTypes.BaseSearchResult & {
+    formSubmissionMeta: SubmissionTypes.FormSubmissionMeta[];
+};
+export declare type EmailTemplatesSearchResult = {
+    emailTemplates: EmailTemplateTypes.EmailTemplate[];
+} & MiscTypes.BaseSearchResult;
+export declare type EmailTemplatesSearchOptions = BaseSearchOptions;
+export declare type FormSubmissionMetaResult = {
+    /** The meta record for the submission */
+    formSubmissionMeta: SubmissionTypes.FormSubmissionMeta;
+    /**
+     * The approval flow related to the submission if the form had an approval
+     * flow configured at the time of submission
+     */
+    formApprovalFlowInstance?: ApprovalTypes.FormApprovalFlowInstance;
+    /**
+     * The approvals related to the approval flow if the form had an approval flow
+     * configured at the time of submission
+     */
+    formSubmissionApprovals?: ApprovalTypes.FormSubmissionApproval[];
+    /**
+     * The payments made after the submission if the form had a payment event
+     * configured at the time of submission
+     */
+    formSubmissionPayments?: SubmissionTypes.FormSubmissionPayment[];
+    /** The workflow events containing a status for each */
+    formSubmissionWorkflowEvents?: SubmissionTypes.FormSubmissionWorkflowEvent[];
+    /**
+     * The bookings made after the submission if the form had a scheduling vent
+     * configured at the time of submission
+     */
+    formSubmissionSchedulingBooking?: SchedulingTypes.SchedulingBooking;
+};
+export { SendMailOptions };
+export declare type SendEmailResult = {
+    envelope: {
+        from: string;
+        to: string[];
+    };
+    messageId: string;
+    response: string;
+    raw: string;
+};
+export declare type FormsAppEnvironmentsSearchResult = {
+    formsAppEnvironments: EnvironmentTypes.FormsAppEnvironment[];
+} & MiscTypes.BaseSearchResult;
+export declare type FormsAppEnvironmentsSearchOptions = BaseSearchOptions;
+export declare type JobsSearchResult = MiscTypes.BaseSearchResult & {
+    jobs: SubmissionTypes.FormsAppJob[];
+};
+export declare type DataManagerRegexFilter = {
+    /** 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:
+     * d,g,i,m,s,u,y.
+     * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#advanced_searching_with_flags
+     */
+    $options?: string;
+};
+export declare type DataManagerNumberFilter = {
+    /** Equal to */
+    $eq?: number;
+    /** Greater than */
+    $gt?: number;
+    /** Greater than or Equal to */
+    $gte?: number;
+    /** Less than */
+    $lt?: number;
+    /** Less than or Equal to */
+    $lte?: number;
+};
+export declare type DataManagerMultipleSelectionsArrayFilter = {
+    $elemMatch: {
+        /**
+         * The array of strings to match. Records will be returned if any of the
+         * values in the record matches any of these
+         */
+        $in: Array<string>;
+    };
+};
+export declare type DataManagerStringArrayFilter = {
+    /**
+     * The array of strings to match. Records will be returned if the value in the
+     * record matches any of these
+     */
+    $in: Array<string>;
+};
+export declare type DataManagerStringArrayComplianceFilter = {
+    /** The filter for the value */
+    value?: DataManagerStringArrayFilter;
+    /** The filter for the notes */
+    notes?: DataManagerRegexFilter;
+};
+export declare type DataManagerBooleanFilter = {
+    /** The boolean value to match */
+    $eq: boolean;
+};
+export declare type DataManagerDateTimeFilter = {
+    /** Equal to */
+    $eq?: string;
+    /** Greater than */
+    $gt?: string;
+    /** Greater than or Equal to */
+    $gte?: string;
+    /** Less than */
+    $lt?: string;
+    /** Less than or Equal to */
+    $lte?: string;
+};
+export declare type DataManagerUUIDFilter = {
+    /** The UUID string to match */
+    $eq: string;
+};
+export declare type DataManagerFreshdeskDependentFieldFilter = {
+    /**
+     * The filter for the `category`. This property is treated as a non multi
+     * `select` element.
+     */
+    category?: DataManagerStringArrayFilter;
+    /**
+     * The filter for the `subCategory`. This property is treated as a non multi
+     * `select` element.
+     */
+    subCategory?: DataManagerStringArrayFilter;
+    /** The filter for the `item`. This property is treated as a non multi `select` element. */
+    item?: DataManagerStringArrayFilter;
+};
+export declare type DataManagerNestedFilterFilter = {
+    /**
+     * The filter for an element in a `repeatableSet` or `form` element. Use
+     * whichever filter type is appropriate for each element type.
+     */
+    [elementName: string]: DataManagerSubmissionPropertyFilter;
+};
+/**
+ * Element of type: text, textarea, email, telephone, barcodeScanner: USE
+ * `DataManagerRegexFilter`.
+ *
+ * Element of type: number, calculation: USE `DataManagerNumberFilter`.
+ *
+ * Element of type: compliance: USE `DataManagerStringArrayComplianceFilter`.
+ *
+ * Element of type: checkboxes, select (multi): USE
+ * `DataManagerMultipleSelectionsArrayFilter`.
+ *
+ * Element of type: radio, autocomplete, select: USE `DataManagerStringArrayFilter`.
+ *
+ * Element of type: boolean: USE `DataManagerBooleanFilter`.
+ *
+ * Element of type: date, datetime, time: USE `DataManagerDateTimeFilter`.
+ *
+ * Element of type: freshdeskDependentField : USE
+ * `DataManagerFreshdeskDependentFieldFilter`.
+ *
+ * - Element of type: form, repeatableSet : USE `DataManagerNestedFilterFilter`.
+ *   `repeatableSet` requires `unwindRepeatableSets` be `true`
+ */
+export declare type DataManagerSubmissionPropertyFilter = DataManagerRegexFilter | DataManagerNumberFilter | DataManagerStringArrayComplianceFilter | DataManagerMultipleSelectionsArrayFilter | DataManagerStringArrayFilter | DataManagerBooleanFilter | DataManagerDateTimeFilter | DataManagerFreshdeskDependentFieldFilter;
+export declare type SearchDataManagerRecordsOptions = {
+    formId: number;
+    /** Required for filtering by `repeatableSets` */
+    unwindRepeatableSets?: boolean;
+    paging?: {
+        /** Limit results to between 1 and 50. Used for pagination. Default: 50 */
+        limit?: number;
+        /** Offset results. Used for pagination. Default: 0 */
+        offset?: number;
+    };
+    /** Sort results. */
+    sorting?: Array<{
+        /** The property to sort by e.g. "submission.Element_Name" */
+        property: string;
+        /** The direction to sort this property by. */
+        direction: 'ascending' | 'descending';
+    }>;
+    filters?: {
+        /**
+         * Filter by `dateTimeSubmitted`. All values as a date ISO string:
+         * https://en.wikipedia.org/wiki/ISO_8601
+         */
+        dateTimeSubmitted?: {
+            /** Equal to */
+            $eq?: string;
+            /** Greater than */
+            $gt?: string;
+            /** Greater than or Equal to */
+            $gte?: string;
+            /** Less than */
+            $lt?: string;
+            /** Less than or Equal to */
+            $lte?: string;
+        };
+        /** Filter by `submissionId`. A uuid string. */
+        submissionId?: DataManagerUUIDFilter;
+        /** Filter by `externalId`. */
+        externalId?: DataManagerRegexFilter;
+        /** Filter by `submittedBy`. */
+        submittedBy?: DataManagerRegexFilter;
+        /** Filter by values in the submission. */
+        submission?: Record<string, DataManagerSubmissionPropertyFilter>;
+    };
+};
+export declare type SearchDataManagerRecordsResponse = {
+    meta: {
+        limit: number;
+        offset: number;
+        nextOffset?: number;
+    };
+    submissions: Array<FormStoreRecord>;
+};

package/tenants/types.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@oneblink/types"), exports);
+//# sourceMappingURL=types.js.map

package/tenants/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAaA,kDAA+B"}

package/changelog.md

@@ -1,201 +0,0 @@
-# Changelog
-
-## Unreleased
-
-### Removed
-
-- Regex for apiId in the form submission
-
-### Added
-
-- `TRIM` submission event to forms schema
-
-# 0.4.3 (2020-02-26)
-
-### Added
-
-- Added [`searchSubmissions()`](./docs/forms#searchSubmissions) function to Form class
-
-# 0.4.2 (2020-02-13)
-
-### Added
-
-- `Files` element
-- `priority` as optional parameter to `createJob` function
-- `device` property to example of form submission data
-
-# 0.4.1 (2020-01-30)
-
-### Added
-
-- Added [`search()`](./docs/jobs#search) function to Jobs class
-
-# 0.4.0 (2019-12-18)
-
-### Added
-
-- Added form schema validation for `formsAppEnvironmentId` in Forms and FormsApps
-
-### Changed
-
-- element and data lookup configuration
-
-# 0.3.4 (2019-11-04)
-
-### Added
-
-- Added `restrictFileTypes` and `restrictedFileTypes` properties for file element
-
-# 0.3.3 (2019-09-16)
-
-### Added
-
-- Added `SEARCH` options type and `searchUrl` property for autocomplete element
-
-# 0.3.2 (2019-06-20)
-
-### Added
-
-- `isDraft` property to form submission events
-- `isDraft` parameter to [`Forms.getSubmissionData()`](./docs/forms.md#getsubmissiondata)
-- [`TeamMembers`](./docs/team-members.md) class
-
-# 0.3.1 (2019-06-18)
-
-### Added
-
-- `formsAppId` options to [`Forms.generateFormUrl()`](./docs/forms.md#generateformurl)
-
-# 0.3.0 (2019-06-07)
-
-### Breaking Changes
-
-- [`Forms.generateFormUrl()`](./docs/forms.md#generateformurl)) now takes an object with the following properties
-  - `formId`
-  - `externalId`
-  - `preFillData`
-  - `expiryInSeconds`
-
-```diff
-const OneBlink = require('@oneblink/sdk')
-
-const options = {
-  accessKey: '123455678901ABCDEFGHIJKL',
-  secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL'
-}
-const formsSDK = new OneBlink.Forms(options)
-
--const formId = 1
--const externalId = 'My Custom Identifier'
--const preFillData = {
--  'FieldName1' : 'A Machine',
--  'FieldName2' : 'Room B'
--}
--formsSDK.generateFormUrl(formId, externalId, preFillData)
-+formsSDK.generateFormUrl({
-+  formId: 1,
-+  externalId: 'My Custom Identifier',
-+  preFillData: {
-+    'FieldName1' : 'A Machine',
-+    'FieldName2' : 'Room B'
-+  }
-+})
-```
-
-## 0.2.9 (2019-06-03)
-
-### Added
-
-- [`getMyFormsApp()`](./docs/forms-apps.md#getmyformsapp) function
-- `injectForms` parameter to `getForm()` function
-
-## 0.2.8 (2019-05-23)
-
-### Added
-
-- ON-4090 # added `form` and `infoPage` element types
-- ON-4098 # Strip out unwanted properties from form elements
-- [`FormsApps`](./docs/forms-apps.md) class
-
-## 0.2.7 (2019-05-06)
-
-### Added
-
-- ON-4044 # added `validateForm()` function for validating a form schema
-- ON-4039 # added `generateFormElement()` function for generating & validating a form element
-
-## 0.2.6 (2019-03-14)
-
-### Added
-
-- `Jobs` class with `createJob()` and `deleteJob()` functions
-
-### Dependencies
-
-- update [aws-sdk](https://www.npmjs.com/package/aws-sdk) to [2.400.0](https://github.com/aws/aws-sdk-js/releases/tag/v2.400.0) (from [2.336.0](https://github.com/aws/aws-sdk-js/releases/tag/v2.336.0))
-
-- update [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken) to [8.4.0](https://github.com/auth0/node-jsonwebtoken/blob/master/CHANGELOG.md) (from [8.3.0](https://github.com/auth0/node-jsonwebtoken/blob/master/CHANGELOG.md))
-
-- depend upon [joi](https://www.npmjs.com/package/joi) [14.3.1](https://github.com/hapijs/joi/blob/master/CHANGELOG.md)
-
-## 0.2.5 (2018-01-14)
-
-### Changed
-
-- Changed `generateFormUrl()` function to get hostname via `appId`
-
-## 0.2.4 (2018-10-24)
-
-### Added
-
-- `forms.generateSubmissionDataUrl()` function
-
-## 0.2.3 (2018-10-17)
-
-### Added
-
-- `forms.getForm()` function
-
-## 0.2.2 (2018-09-25)
-
-### Added
-
-- `Organisations` classes
-- `Keys` class
-
-## 0.2.1 (2018-09-04)
-
-### Added
-
-- Pre filled data argument to `forms.generateFormUrl()` function
-
-### Fixed
-
-- Path of forms renderer URL to match `/forms/{formId}`
-
-## 0.2.0 (2018-08-07)
-
-### Changed
-
-- `forms.generateFormUrl(formId, externalId)` to return a promise that will resolve with the same value as before
-
-## 0.1.0 (2018-07-11)
-
-### Added
-
-- `isAuthenticated` search parameter to Forms `search()` function
-- `name` search parameter to Forms `search()` function
-
-### Removed
-
-- `organisationId` search parameter from Forms `search()` function
-
-### Dependencies
-
-- update [aws-sdk](https://www.npmjs.com/package/aws-sdk) to [2.272.1](https://github.com/aws/aws-sdk-js/releases/tag/v2.272.1) (from [2.251.1](https://github.com/aws/aws-sdk-js/releases/tag/v2.251.1))
-
-- update [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken) to [8.3.0](https://github.com/auth0/node-jsonwebtoken/blob/master/CHANGELOG.md) (from [8.2.2](https://github.com/auth0/node-jsonwebtoken/blob/master/CHANGELOG.md))
-
-## 0.0.1 (2018-06-13)
-
-### Initial Release