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

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2016 BlinkMobile
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 OneBlink
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,19 +1,7 @@
-# OneBlink SDK
-
-OneBlink SDK to serve as an entry point for all OneBlink Services in NodeJS
-
-## Installation
-
-```sh
-npm install @oneblink/sdk --save
-```
-
-## Usage
-
--   [Usage Documentation](./docs/README.md)
--   [Form Submissions](./docs/form-submissions.md)
--   [Form Element Definitions](./docs/form-elements/README.md)
-
-## Internal Documentation
-
--   [Development](./docs/development.md)
+# OneBlink SDK [![npm module](https://img.shields.io/npm/v/@oneblink/sdk.svg)](https://www.npmjs.com/package/@oneblink/sdk) [![tests](https://github.com/oneblink/sdk-node-js/actions/workflows/test.yml/badge.svg)](https://github.com/oneblink/sdk-node-js/actions)
+
+OneBlink SDK to serve as an entry point for all OneBlink Services in NodeJS
+
+## Documentation
+
+See the [Documentation](https://oneblink.github.io/sdk-node-js/) for more details.

package/package.json

@@ -1,30 +1,41 @@
 {
   "name": "@oneblink/sdk",
   "description": "OneBlink SDK to serve as an entry point for all OneBlink Services in NodeJS",
-  "version": "0.4.4-beta.1",
+  "version": "0.4.4-beta.2",
+  "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
   "bugs": {
-    "url": "https://github.com/blinkmobile/oneblink-sdk-js/issues"
+    "url": "https://github.com/oneblink/sdk-node-js/issues"
   },
   "dependencies": {
-    "aws-sdk": "2.578.0",
-    "axios": "0.19.0",
-    "joi": "14.3.1",
-    "jsonwebtoken": "8.5.1",
-    "uuid": "3.3.2"
+    "@oneblink/sdk-core": "^0.4.4-beta.1",
+    "joi": "^17.6.0",
+    "jsonwebtoken": "^8.5.1",
+    "node-fetch": "^2.6.7",
+    "nodemailer": "^6.7.7",
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "eslint": "^5.16.0",
-    "eslint-config-standard": "^12.0.0",
-    "eslint-plugin-import": "^2.17.3",
-    "eslint-plugin-node": "^9.1.0",
-    "eslint-plugin-promise": "^4.1.1",
-    "eslint-plugin-standard": "^4.0.0",
-    "fixpack": "^2.3.1",
-    "flow-bin": "^0.112.0",
-    "jest": "^24.9.0",
-    "remark-cli": "^6.0.1",
-    "remark-lint": "^6.0.4",
-    "remark-preset-lint-recommended": "^3.0.2"
+    "@oneblink/release-cli": "^1.2.0",
+    "@oneblink/types": "github:oneblink/types",
+    "@types/content-disposition": "^0.5.4",
+    "@types/jest": "^27.4.1",
+    "@types/joi": "^17.2.3",
+    "@types/jsonwebtoken": "^8.5.8",
+    "@types/node-fetch": "^2.6.1",
+    "@types/nodemailer": "^6.4.4",
+    "@types/uuid": "^8.3.4",
+    "@typescript-eslint/eslint-plugin": "^5.19.0",
+    "@typescript-eslint/parser": "^5.19.0",
+    "eslint": "^8.13.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "fixpack": "^4.0.0",
+    "jest": "^27.5.1",
+    "prettier": "^2.6.2",
+    "prettier-plugin-jsdoc": "^0.3.38",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.22.18",
+    "typescript": "^4.6.3"
   },
   "directories": {
     "doc": "docs",
@@ -32,40 +43,37 @@
     "test": "test"
   },
   "engines": {
-    "node": ">=8.3",
-    "npm": ">=6"
+    "node": ">=12",
+    "npm": ">=8"
   },
   "files": [
-    "flow-typed",
-    "lib",
-    "classes",
-    "index.js"
+    "tenants"
   ],
-  "homepage": "https://github.com/blinkmobile/oneblink-sdk-js",
+  "homepage": "https://oneblink.github.io/sdk-node-js/",
   "keywords": [],
   "license": "MIT",
-  "main": "index.js",
-  "nyc": {
-    "exclude": [
-      "dist",
-      "examples",
-      "test"
-    ]
+  "main": "./tenants/oneblink.js",
+  "peerDependencies": {
+    "aws-sdk": "^2.994.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/blinkmobile/oneblink-sdk-js.git"
+    "url": "git+https://github.com/oneblink/sdk-node-js.git"
   },
   "scripts": {
-    "eslint": "eslint --fix --cache .",
+    "build": "tsc --build",
+    "docs": "typedoc",
+    "eslint": "eslint --fix --cache ./src ./tests",
     "fixpack": "fixpack",
-    "flow_check": "flow check",
-    "jest": "jest",
-    "lint-md": "remark . --use remark-preset-lint-recommended",
-    "pretest": "npm run eslint && npm run flow_check && npm run fixpack && npm run lint-md",
-    "test": "npm run jest"
+    "jest": "jest --silent",
+    "prepare": "npm run build",
+    "pretest": "npm run eslint && tsc --noEmit && npm run fixpack",
+    "release": "npm run docs && oneblink-release",
+    "test": "npm run jest",
+    "types": "npm i -D github:oneblink/types",
+    "typescript": "tsc --noEmit"
   }
 }

package/tenants/civicplus.d.ts

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

package/tenants/civicplus.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.CIVICPLUS);
+one_blink_api_1.default.tenant = tenant;
+__exportStar(require("./classes"), exports);
+//# sourceMappingURL=civicplus.js.map

package/tenants/civicplus.js.map

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

package/tenants/classes/Approvals.d.ts

@@ -0,0 +1,95 @@
+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)
+     * ```
+     */
+    constructor(options: ConstructorOptions);
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const { approvals, meta } =
+     *   await approvals.searchFormSubmissionAdministrationApprovals({
+     *     formsAppId: 1,
+     *     formId: 2,
+     *     limit: 50,
+     *     offset: 0,
+     *   })
+     * ```
+     *
+     * @param options Search options
+     * @returns
+     */
+    searchFormSubmissionAdministrationApprovals({ formsAppId, limit, offset, ...rest }: {
+        /** The formsAppId of the approvals app */
+        formsAppId: number;
+        /** The formId of the approvals */
+        formId?: number;
+        /** An exact externalId to search by */
+        externalId?: string;
+        /** An exact submissionId to search by */
+        submissionId?: string;
+        /** The date submitted after as an ISO string */
+        submittedAfterDateTime?: string;
+        /** The date submitted before as an ISO string */
+        submittedBeforeDateTime?: string;
+        /** The number of results to return. Maximum is 50 */
+        limit: number;
+        /**
+         * The offset of the results to return. Use this in conjunction with `limit`
+         * for pagination
+         */
+        offset: number;
+        /**
+         * An array of statuses to filter by (`'PENDING'`,
+         * `'CLARIFICATION_RECEIVED'`, `'CLARIFICATION_REQUIRED'`, `'APPROVED'`, `'CLOSED'`)
+         */
+        statuses?: string[];
+        /** The date updated after as an ISO string */
+        updatedAfterDateTime?: string;
+        /** The date updated before as an ISO string */
+        updatedBeforeDateTime?: string;
+        /** An array of usernames to filter by */
+        lastUpdatedBy?: string[];
+    }): Promise<FormSubmissionsAdministrationApprovalsResponse>;
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * 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
+     *
+     * ```javascript
+     * const formSubmissionApproval =
+     *   await approvals.getFormApprovalFlowInstance(1)
+     * // Use data here...
+     * ```
+     *
+     * @param id The id of the form approval flow instance
+     * @returns
+     */
+    getFormApprovalFlowInstance(id: number): Promise<FormApprovalFlowInstanceResponse>;
+}

package/tenants/classes/Approvals.js

@@ -0,0 +1,95 @@
+"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 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)
+     * ```
+     */
+    constructor(options) {
+        options = options || {};
+        super(options.accessKey, options.secretKey);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const { approvals, meta } =
+     *   await approvals.searchFormSubmissionAdministrationApprovals({
+     *     formsAppId: 1,
+     *     formId: 2,
+     *     limit: 50,
+     *     offset: 0,
+     *   })
+     * ```
+     *
+     * @param options Search options
+     * @returns
+     */
+    async searchFormSubmissionAdministrationApprovals({ formsAppId, limit, offset, ...rest }) {
+        if (typeof formsAppId !== 'number') {
+            throw new Error('"formsAppId" must be a number and is required');
+        }
+        if (typeof limit !== 'number' || typeof offset !== 'number') {
+            throw new Error('"limit" and "offset" are required');
+        }
+        return await super.searchRequest(`/forms-apps/${formsAppId}/approvals`, {
+            limit,
+            offset,
+            ...rest,
+        });
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const formSubmissionApproval =
+     *   await approvals.getFormSubmissionApproval(
+     *     'aaaaaaaa-bbbb-4543-cccc-addddd543454',
+     *   )
+     * // Use data here...
+     * ```
+     *
+     * @param id The id of the form submission approval
+     * @returns
+     */
+    async getFormSubmissionApproval(id) {
+        if (!id) {
+            throw new Error('"id" must be a string and is required');
+        }
+        return await super.getRequest(`/form-submission-approvals/${id}`);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const formSubmissionApproval =
+     *   await approvals.getFormApprovalFlowInstance(1)
+     * // Use data here...
+     * ```
+     *
+     * @param id The id of the form approval flow instance
+     * @returns
+     */
+    async getFormApprovalFlowInstance(id) {
+        if (typeof id !== 'number') {
+            throw new Error('"id" must be a number and is required');
+        }
+        return await super.getRequest(`/form-approval-flow-instances/${id}`);
+    }
+}
+exports.default = Approvals;
+//# sourceMappingURL=Approvals.js.map

package/tenants/classes/Approvals.js.map

@@ -0,0 +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,EAgCR;QACC,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;SACjE;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC3D,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;SACrD;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;YACP,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;SACzD;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;YAC1B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;SACzD;QACD,OAAO,MAAM,KAAK,CAAC,UAAU,CAAC,iCAAiC,EAAE,EAAE,CAAC,CAAA;IACtE,CAAC;CACF;AAjID,4BAiIC"}

package/tenants/classes/DataManager.d.ts

@@ -0,0 +1,45 @@
+import { FormStoreDefinition } from '@oneblink/types/typescript/submissions';
+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)
+     * ```
+     */
+    constructor(options: ConstructorOptions);
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const { formId, formElements } = await dataManager.getFormDefinition(2)
+     * ```
+     *
+     * @param id The form ID to get the definition for.
+     * @returns
+     */
+    getFormDefinition(id: number): Promise<FormStoreDefinition>;
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const { submissions, meta } = await dataManager.searchRecords({
+     *   formId: 1,
+     * })
+     * // Use data here...
+     * ```
+     *
+     * @param options The options for the Search Request
+     * @returns
+     */
+    searchRecords(options: SearchDataManagerRecordsOptions): Promise<SearchDataManagerRecordsResponse>;
+}

package/tenants/classes/DataManager.js

@@ -0,0 +1,68 @@
+"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 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)
+     * ```
+     */
+    constructor(options) {
+        options = options || {};
+        super(options.accessKey, options.secretKey);
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const { formId, formElements } = await dataManager.getFormDefinition(2)
+     * ```
+     *
+     * @param id The form ID to get the definition for.
+     * @returns
+     */
+    async getFormDefinition(id) {
+        if (typeof id !== 'number') {
+            throw new Error('"id" must be a number and is required');
+        }
+        return await super.searchRequest(`/form-store/elements`, {
+            formId: id,
+        });
+    }
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const { submissions, meta } = await dataManager.searchRecords({
+     *   formId: 1,
+     * })
+     * // Use data here...
+     * ```
+     *
+     * @param options The options for the Search Request
+     * @returns
+     */
+    async searchRecords(options) {
+        if (!options) {
+            throw new Error('"options" object must be provided.');
+        }
+        if (typeof options.formId !== 'number') {
+            throw new Error('"formId" must be a number and is required');
+        }
+        return await super.postRequest(`/form-store`, options);
+    }
+}
+exports.default = DataManager;
+//# sourceMappingURL=DataManager.js.map

package/tenants/classes/DataManager.js.map

@@ -0,0 +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;YAC1B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;SACzD;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;YACZ,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;SACtD;QACD,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;SAC7D;QACD,OAAO,MAAM,KAAK,CAAC,WAAW,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IACxD,CAAC;CACF;AA/DD,8BA+DC"}

package/tenants/classes/EmailTemplates.d.ts

@@ -0,0 +1,100 @@
+import OneBlinkAPI from '../lib/one-blink-api';
+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)
+     * ```
+     */
+    constructor(options: ConstructorOptions);
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const searchParams = {
+     *   limit: 1,
+     *   offset: 0,
+     * }
+     * const { emailTemplates, meta } =
+     *   await emailTemplates.searchEmailTemplates(searchParams)
+     * ```
+     *
+     * @param searchParams Search options
+     */
+    searchEmailTemplates(searchParams: EmailTemplatesSearchOptions): Promise<EmailTemplatesSearchResult>;
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * const emailTemplate = await emailTemplates.getEmailTemplate(1)
+     * // Use data here...
+     * ```
+     *
+     * @param id The id of the email template
+     */
+    getEmailTemplate(id: number): Promise<EmailTemplateTypes.EmailTemplate>;
+    /**
+     * #### Example
+     *
+     * ```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...
+     * ```
+     *
+     * @param data The data for the new email template
+     */
+    createEmailTemplate(data: EmailTemplateTypes.NewEmailTemplate): Promise<EmailTemplateTypes.EmailTemplate>;
+    /**
+     * #### Example
+     *
+     * ```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...
+     * ```
+     *
+     * @param data The data for the email template to update
+     */
+    updateEmailTemplate(data: EmailTemplateTypes.EmailTemplate): Promise<EmailTemplateTypes.EmailTemplate>;
+    /**
+     * #### Example
+     *
+     * ```javascript
+     * await emailTemplates.deleteEmailTemplate(1)
+     * ```
+     *
+     * @param id The id of the email template to delete
+     */
+    deleteEmailTemplate(id: number): Promise<void>;
+}