diff --git a/.husky/pre-commit b/.husky/pre-commit new file mode 100755 index 00000000..0da96d6b --- /dev/null +++ b/.husky/pre-commit @@ -0,0 +1,4 @@ +#!/usr/bin/env sh +. "$(dirname -- "$0")/_/husky.sh" + +npx pretty-quick --staged diff --git a/README.md b/README.md index b9f09f8b..882a1659 100644 --- a/README.md +++ b/README.md @@ -154,6 +154,8 @@ As this project is partially generated via the OpenAPI Generator tool, it has a ├── .github/ │ └── workflows/ │ └── GH Action files +├── .husky/ +│ └── pre-commit files ├── libTemplate/ │ └── template files ├── src/ @@ -192,6 +194,8 @@ Files and folders to be aware of in the root of the project. - The [`config.json`](config.json) file is a configuration file of additional properties used by the OpenAPI Generator and its JavaScript library template to define certain variables like license type, project name, project version, etc. +- The [`.husky/`](.husky/) folder is a set of pre-commit hooks that [Husky](https://typicode.github.io/husky/#/) runs on all files staged for commit to GitHub. It currently runs them through our [Prettier](https://prettier.io/) file formatting tool via the [pretty-quick](https://www.npmjs.com/package/pretty-quick) npm library. + ### `src/` Folder The `src/` folder inside the root of the project contains the contents of the auto-generated `notehub-js` library that is eventually [published to npm](https://www.npmjs.com/package/@blues-inc/notehub-js), including: @@ -218,7 +222,7 @@ This project uses [Node.js](https://nodejs.org/en/) as a runtime, [npm](https:// $ volta install node npm ``` -3. Navigate to the root of the folder in your terminal or command prompt and run `npm install`, which installs the repo's npm dependencies. +3. Navigate to the root of the folder in your terminal or command prompt and run `npm install`, which installs the repo's npm dependencies, including the [`prettier`](https://prettier.io/), [`pretty-quick`](https://www.npmjs.com/package/pretty-quick), and [`husky`](https://typicode.github.io/husky/#/?id=automatic-recommended) libraries which will format any files staged for commit according to our coding style as defined in the `.prettierrc` file. ```shell $ npm install diff --git a/package-lock.json b/package-lock.json index 808205f2..18042710 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,7 +7,10 @@ "name": "notehub-js", "license": "MIT", "devDependencies": { - "@openapitools/openapi-generator-cli": "^2.5.2" + "@openapitools/openapi-generator-cli": "^2.5.2", + "husky": "^8.0.0", + "prettier": "^2.8.4", + "pretty-quick": "^3.1.3" } }, "node_modules/@nestjs/common": { @@ -147,6 +150,12 @@ "url": "https://opencollective.com/openapi_generator" } }, + "node_modules/@types/minimatch": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.5.tgz", + "integrity": "sha512-Klz949h02Gz2uZCMGwDUSDS1YBlTdDDgbWHi+81l29tQALUtvz4rAYi5uoVhE5Lagoq6DeqAUlbrHvW/mXDgdQ==", + "dev": true + }, "node_modules/ansi-escapes": { "version": "4.3.2", "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", @@ -186,6 +195,33 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, + "node_modules/array-differ": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/array-differ/-/array-differ-3.0.0.tgz", + "integrity": "sha512-THtfYS6KtME/yIAhKjZ2ul7XI96lQGHRputJQHO80LAWQnuGP4iCIN8vdMRboGbIEYBwU33q8Tch1os2+X0kMg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/arrify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/arrify/-/arrify-2.0.1.tgz", + "integrity": "sha512-3duEwti880xqi4eAMN8AyR4a0ByT90zoYdLlevfrvU43vb0YZwZVfxOgxWrLXXXpyugL0hNZc9G6BiB5B3nUug==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/axios": { "version": "0.26.1", "resolved": "https://registry.npmjs.org/axios/-/axios-0.26.1.tgz", @@ -453,6 +489,20 @@ "node": "> 0.10" } }, + "node_modules/cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, "node_modules/date-fns": { "version": "2.29.3", "resolved": "https://registry.npmjs.org/date-fns/-/date-fns-2.29.3.tgz", @@ -493,6 +543,15 @@ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", "dev": true }, + "node_modules/end-of-stream": { + "version": "1.4.4", + "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", + "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", + "dev": true, + "dependencies": { + "once": "^1.4.0" + } + }, "node_modules/escalade": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", @@ -511,6 +570,29 @@ "node": ">=0.8.0" } }, + "node_modules/execa": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/execa/-/execa-4.1.0.tgz", + "integrity": "sha512-j5W0//W7f8UxAn8hXVnwG8tLwdiUy4FJLcSupCg6maBYZDpyBvTApK7KyuI4bKj8KOh1r2YH+6ucuYtJv1bTZA==", + "dev": true, + "dependencies": { + "cross-spawn": "^7.0.0", + "get-stream": "^5.0.0", + "human-signals": "^1.1.1", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.0", + "onetime": "^5.1.0", + "signal-exit": "^3.0.2", + "strip-final-newline": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, "node_modules/external-editor": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-3.1.0.tgz", @@ -546,6 +628,19 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/find-up": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", + "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", + "dev": true, + "dependencies": { + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/follow-redirects": { "version": "1.15.2", "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz", @@ -595,6 +690,21 @@ "node": "6.* || 8.* || >= 10.*" } }, + "node_modules/get-stream": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-5.2.0.tgz", + "integrity": "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==", + "dev": true, + "dependencies": { + "pump": "^3.0.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/glob": { "version": "7.1.6", "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz", @@ -630,6 +740,30 @@ "node": ">=8" } }, + "node_modules/human-signals": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-1.1.1.tgz", + "integrity": "sha512-SEQu7vl8KjNL2eoGBLF3+wAjpsNfA9XMlXAYj/3EdaNfAlxKthD1xjEQfGOUhllCGGJVNY34bRr6lPINhNjyZw==", + "dev": true, + "engines": { + "node": ">=8.12.0" + } + }, + "node_modules/husky": { + "version": "8.0.3", + "resolved": "https://registry.npmjs.org/husky/-/husky-8.0.3.tgz", + "integrity": "sha512-+dQSyqPh4x1hlO1swXBiNb2HzTDN1I2IGLQx1GrBuiqFJfoMrnZWwVmatvSiO+Iz8fBUnf+lekwNo4c2LlXItg==", + "dev": true, + "bin": { + "husky": "lib/bin.js" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/typicode" + } + }, "node_modules/iconv-lite": { "version": "0.4.24", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", @@ -662,6 +796,15 @@ } ] }, + "node_modules/ignore": { + "version": "5.2.4", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.4.tgz", + "integrity": "sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, "node_modules/inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -721,6 +864,18 @@ "node": ">=8" } }, + "node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/is-unicode-supported": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz", @@ -733,6 +888,12 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "dev": true + }, "node_modules/iterare": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/iterare/-/iterare-1.2.1.tgz", @@ -754,6 +915,18 @@ "graceful-fs": "^4.1.6" } }, + "node_modules/locate-path": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", + "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", + "dev": true, + "dependencies": { + "p-locate": "^4.1.0" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/lodash": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", @@ -776,6 +949,12 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/merge-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", + "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", + "dev": true + }, "node_modules/mimic-fn": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", @@ -797,6 +976,31 @@ "node": "*" } }, + "node_modules/mri": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/mri/-/mri-1.2.0.tgz", + "integrity": "sha512-tzzskb3bG8LvYGFF/mDTpq3jpI6Q9wc3LEmBaghu+DdCssd1FakN7Bc0hVNmEyGq1bq3RgfkCb3cmQLpNPOroA==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/multimatch": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/multimatch/-/multimatch-4.0.0.tgz", + "integrity": "sha512-lDmx79y1z6i7RNx0ZGCPq1bzJ6ZoDDKbvh7jxr9SJcWLkShMzXrHbYVpTdnhNM5MXpDUxCQ4DgqVttVXlBgiBQ==", + "dev": true, + "dependencies": { + "@types/minimatch": "^3.0.3", + "array-differ": "^3.0.0", + "array-union": "^2.1.0", + "arrify": "^2.0.1", + "minimatch": "^3.0.4" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/mute-stream": { "version": "0.0.8", "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz", @@ -823,6 +1027,18 @@ } } }, + "node_modules/npm-run-path": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", + "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "dev": true, + "dependencies": { + "path-key": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/object-hash": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/object-hash/-/object-hash-3.0.0.tgz", @@ -888,6 +1104,51 @@ "node": ">=0.10.0" } }, + "node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-locate": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", + "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", + "dev": true, + "dependencies": { + "p-limit": "^2.2.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/path-exists": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", + "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/path-is-absolute": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", @@ -897,12 +1158,82 @@ "node": ">=0.10.0" } }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/path-to-regexp": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-3.2.0.tgz", "integrity": "sha512-jczvQbCUS7XmS7o+y1aEO9OBVFeZBQ1MDSEqmO7xSoPgOPoowY/SxLpZ6Vh97/8qHZOteiCKb7gkG9gA2ZUxJA==", "dev": true }, + "node_modules/prettier": { + "version": "2.8.4", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.4.tgz", + "integrity": "sha512-vIS4Rlc2FNh0BySk3Wkd6xmwxB0FpOndW5fisM5H8hsZSxU2VWVB5CWIkIjWvrHjIhxk2g3bfMKM87zNTrZddw==", + "dev": true, + "bin": { + "prettier": "bin-prettier.js" + }, + "engines": { + "node": ">=10.13.0" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" + } + }, + "node_modules/pretty-quick": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/pretty-quick/-/pretty-quick-3.1.3.tgz", + "integrity": "sha512-kOCi2FJabvuh1as9enxYmrnBC6tVMoVOenMaBqRfsvBHB0cbpYHjdQEpSglpASDFEXVwplpcGR4CLEaisYAFcA==", + "dev": true, + "dependencies": { + "chalk": "^3.0.0", + "execa": "^4.0.0", + "find-up": "^4.1.0", + "ignore": "^5.1.4", + "mri": "^1.1.5", + "multimatch": "^4.0.0" + }, + "bin": { + "pretty-quick": "bin/pretty-quick.js" + }, + "engines": { + "node": ">=10.13" + }, + "peerDependencies": { + "prettier": ">=2.0.0" + } + }, + "node_modules/pretty-quick/node_modules/chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/pump": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz", + "integrity": "sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==", + "dev": true, + "dependencies": { + "end-of-stream": "^1.1.0", + "once": "^1.3.1" + } + }, "node_modules/readable-stream": { "version": "3.6.0", "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz", @@ -995,6 +1326,27 @@ "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", "dev": true }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/signal-exit": { "version": "3.0.7", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", @@ -1042,6 +1394,15 @@ "node": ">=8" } }, + "node_modules/strip-final-newline": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", + "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, "node_modules/supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", @@ -1154,6 +1515,21 @@ "webidl-conversions": "^3.0.0" } }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, "node_modules/wrap-ansi": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", @@ -1292,6 +1668,12 @@ "tslib": "2.0.3" } }, + "@types/minimatch": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.5.tgz", + "integrity": "sha512-Klz949h02Gz2uZCMGwDUSDS1YBlTdDDgbWHi+81l29tQALUtvz4rAYi5uoVhE5Lagoq6DeqAUlbrHvW/mXDgdQ==", + "dev": true + }, "ansi-escapes": { "version": "4.3.2", "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", @@ -1316,6 +1698,24 @@ "color-convert": "^2.0.1" } }, + "array-differ": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/array-differ/-/array-differ-3.0.0.tgz", + "integrity": "sha512-THtfYS6KtME/yIAhKjZ2ul7XI96lQGHRputJQHO80LAWQnuGP4iCIN8vdMRboGbIEYBwU33q8Tch1os2+X0kMg==", + "dev": true + }, + "array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true + }, + "arrify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/arrify/-/arrify-2.0.1.tgz", + "integrity": "sha512-3duEwti880xqi4eAMN8AyR4a0ByT90zoYdLlevfrvU43vb0YZwZVfxOgxWrLXXXpyugL0hNZc9G6BiB5B3nUug==", + "dev": true + }, "axios": { "version": "0.26.1", "resolved": "https://registry.npmjs.org/axios/-/axios-0.26.1.tgz", @@ -1512,6 +1912,17 @@ "easy-table": "1.1.0" } }, + "cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "requires": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + } + }, "date-fns": { "version": "2.29.3", "resolved": "https://registry.npmjs.org/date-fns/-/date-fns-2.29.3.tgz", @@ -1542,6 +1953,15 @@ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", "dev": true }, + "end-of-stream": { + "version": "1.4.4", + "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", + "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", + "dev": true, + "requires": { + "once": "^1.4.0" + } + }, "escalade": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", @@ -1554,6 +1974,23 @@ "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", "dev": true }, + "execa": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/execa/-/execa-4.1.0.tgz", + "integrity": "sha512-j5W0//W7f8UxAn8hXVnwG8tLwdiUy4FJLcSupCg6maBYZDpyBvTApK7KyuI4bKj8KOh1r2YH+6ucuYtJv1bTZA==", + "dev": true, + "requires": { + "cross-spawn": "^7.0.0", + "get-stream": "^5.0.0", + "human-signals": "^1.1.1", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.0", + "onetime": "^5.1.0", + "signal-exit": "^3.0.2", + "strip-final-newline": "^2.0.0" + } + }, "external-editor": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-3.1.0.tgz", @@ -1580,6 +2017,16 @@ "escape-string-regexp": "^1.0.5" } }, + "find-up": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", + "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", + "dev": true, + "requires": { + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" + } + }, "follow-redirects": { "version": "1.15.2", "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz", @@ -1609,6 +2056,15 @@ "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", "dev": true }, + "get-stream": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-5.2.0.tgz", + "integrity": "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==", + "dev": true, + "requires": { + "pump": "^3.0.0" + } + }, "glob": { "version": "7.1.6", "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz", @@ -1635,6 +2091,18 @@ "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true }, + "human-signals": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-1.1.1.tgz", + "integrity": "sha512-SEQu7vl8KjNL2eoGBLF3+wAjpsNfA9XMlXAYj/3EdaNfAlxKthD1xjEQfGOUhllCGGJVNY34bRr6lPINhNjyZw==", + "dev": true + }, + "husky": { + "version": "8.0.3", + "resolved": "https://registry.npmjs.org/husky/-/husky-8.0.3.tgz", + "integrity": "sha512-+dQSyqPh4x1hlO1swXBiNb2HzTDN1I2IGLQx1GrBuiqFJfoMrnZWwVmatvSiO+Iz8fBUnf+lekwNo4c2LlXItg==", + "dev": true + }, "iconv-lite": { "version": "0.4.24", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", @@ -1650,6 +2118,12 @@ "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", "dev": true }, + "ignore": { + "version": "5.2.4", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.4.tgz", + "integrity": "sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==", + "dev": true + }, "inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -1700,12 +2174,24 @@ "integrity": "sha512-2HvIEKRoqS62guEC+qBjpvRubdX910WCMuJTZ+I9yvqKU2/12eSL549HMwtabb4oupdj2sMP50k+XJfB/8JE6w==", "dev": true }, + "is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "dev": true + }, "is-unicode-supported": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz", "integrity": "sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==", "dev": true }, + "isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "dev": true + }, "iterare": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/iterare/-/iterare-1.2.1.tgz", @@ -1722,6 +2208,15 @@ "universalify": "^2.0.0" } }, + "locate-path": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", + "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", + "dev": true, + "requires": { + "p-locate": "^4.1.0" + } + }, "lodash": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", @@ -1738,6 +2233,12 @@ "is-unicode-supported": "^0.1.0" } }, + "merge-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", + "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", + "dev": true + }, "mimic-fn": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", @@ -1753,6 +2254,25 @@ "brace-expansion": "^1.1.7" } }, + "mri": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/mri/-/mri-1.2.0.tgz", + "integrity": "sha512-tzzskb3bG8LvYGFF/mDTpq3jpI6Q9wc3LEmBaghu+DdCssd1FakN7Bc0hVNmEyGq1bq3RgfkCb3cmQLpNPOroA==", + "dev": true + }, + "multimatch": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/multimatch/-/multimatch-4.0.0.tgz", + "integrity": "sha512-lDmx79y1z6i7RNx0ZGCPq1bzJ6ZoDDKbvh7jxr9SJcWLkShMzXrHbYVpTdnhNM5MXpDUxCQ4DgqVttVXlBgiBQ==", + "dev": true, + "requires": { + "@types/minimatch": "^3.0.3", + "array-differ": "^3.0.0", + "array-union": "^2.1.0", + "arrify": "^2.0.1", + "minimatch": "^3.0.4" + } + }, "mute-stream": { "version": "0.0.8", "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz", @@ -1768,6 +2288,15 @@ "whatwg-url": "^5.0.0" } }, + "npm-run-path": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", + "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "dev": true, + "requires": { + "path-key": "^3.0.0" + } + }, "object-hash": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/object-hash/-/object-hash-3.0.0.tgz", @@ -1815,18 +2344,96 @@ "integrity": "sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g==", "dev": true }, + "p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "requires": { + "p-try": "^2.0.0" + } + }, + "p-locate": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", + "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", + "dev": true, + "requires": { + "p-limit": "^2.2.0" + } + }, + "p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true + }, + "path-exists": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", + "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "dev": true + }, "path-is-absolute": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", "dev": true }, + "path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true + }, "path-to-regexp": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-3.2.0.tgz", "integrity": "sha512-jczvQbCUS7XmS7o+y1aEO9OBVFeZBQ1MDSEqmO7xSoPgOPoowY/SxLpZ6Vh97/8qHZOteiCKb7gkG9gA2ZUxJA==", "dev": true }, + "prettier": { + "version": "2.8.4", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.4.tgz", + "integrity": "sha512-vIS4Rlc2FNh0BySk3Wkd6xmwxB0FpOndW5fisM5H8hsZSxU2VWVB5CWIkIjWvrHjIhxk2g3bfMKM87zNTrZddw==", + "dev": true + }, + "pretty-quick": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/pretty-quick/-/pretty-quick-3.1.3.tgz", + "integrity": "sha512-kOCi2FJabvuh1as9enxYmrnBC6tVMoVOenMaBqRfsvBHB0cbpYHjdQEpSglpASDFEXVwplpcGR4CLEaisYAFcA==", + "dev": true, + "requires": { + "chalk": "^3.0.0", + "execa": "^4.0.0", + "find-up": "^4.1.0", + "ignore": "^5.1.4", + "mri": "^1.1.5", + "multimatch": "^4.0.0" + }, + "dependencies": { + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + } + } + }, + "pump": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz", + "integrity": "sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==", + "dev": true, + "requires": { + "end-of-stream": "^1.1.0", + "once": "^1.3.1" + } + }, "readable-stream": { "version": "3.6.0", "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz", @@ -1895,6 +2502,21 @@ "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", "dev": true }, + "shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "requires": { + "shebang-regex": "^3.0.0" + } + }, + "shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true + }, "signal-exit": { "version": "3.0.7", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", @@ -1936,6 +2558,12 @@ "ansi-regex": "^5.0.1" } }, + "strip-final-newline": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", + "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", + "dev": true + }, "supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", @@ -2027,6 +2655,15 @@ "webidl-conversions": "^3.0.0" } }, + "which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "requires": { + "isexe": "^2.0.0" + } + }, "wrap-ansi": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", diff --git a/package.json b/package.json index 17474179..c2d4d71f 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,13 @@ "scripts": { "downloadJsTemplate": "openapi-generator-cli author template -g javascript --library javascript", "generateDocs": "openapi-generator-cli generate -g javascript --library javascript -t libTemplate -o src -i openapi.yaml -c config.json", - "test": "echo \"Error: no test specified\" && exit 1" + "test": "echo \"Error: no test specified\" && exit 1", + "prepare": "husky install" + }, + "husky": { + "hooks": { + "pre-commit": "pretty-quick --staged" + } }, "repository": { "type": "git", @@ -29,7 +35,10 @@ "directory": "./src" }, "devDependencies": { - "@openapitools/openapi-generator-cli": "^2.5.2" + "@openapitools/openapi-generator-cli": "^2.5.2", + "husky": "^8.0.0", + "prettier": "^2.8.4", + "pretty-quick": "^3.1.3" }, "volta": { "node": "18.13.0", diff --git a/src/docs/CreateProductRequest.md b/src/docs/CreateProductRequest.md index a68321f4..a173d414 100644 --- a/src/docs/CreateProductRequest.md +++ b/src/docs/CreateProductRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| --------------------------- | ------------ | ----------------------------------------------------------------------------------------- | ---------- | -| **productUid** | **String** | The requested uid for the Product. Will be prefixed with the user's reversed email. | -| **label** | **String** | The label for the Product. | -| **autoProvisionFleets** | **[String]** | | [optional] | -| **disableDevicesByDefault** | **Boolean** | If `true`, devices provisioned to this product will be automatically disabled by default. | [optional] | +| Name | Type | Description | Notes | +| --------------------------- | ------------ | --------------------------------------------------------------------------------------------------- | ---------- | +| **productUid** | **String** | The requested uid for the Product. Will be prefixed with the user's reversed email. | +| **label** | **String** | The label for the Product. | +| **autoProvisionFleets** | **[String]** | | [optional] | +| **disableDevicesByDefault** | **Boolean** | If `true`, devices provisioned to this product will be automatically disabled by default. | [optional] | diff --git a/src/docs/DFUState.md b/src/docs/DFUState.md index 7af557e7..0994c134 100644 --- a/src/docs/DFUState.md +++ b/src/docs/DFUState.md @@ -2,21 +2,21 @@ ## Properties -| Name | Type | Description | Notes | -| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -| **type** | **String** | | [optional] | -| **file** | **String** | Firmware filename | [optional] | -| **length** | **Number** | Length of firmware file | [optional] | -| **crc32** | **Number** | Used for image verification | [optional] | -| **md5** | **String** | Used for image verification | [optional] | -| **mode** | **String** | _ "idle" - nothing downloading or downloaded _ "error" - halted and in the error state _ "downloading" - transferring data from cloud to module _ "sideloading" - transferring data via request to module _ "ready" - DFU data is ready/verified and waiting on external storage _ "ready-retry" - DFU data is ready/verified and retrying _ "updating" - currently updating _ "completed" - DFU is done successfully | [optional] | -| **status** | **String** | Status message | [optional] | -| **began** | **Number** | The time when the DFU began | [optional] | -| **retry** | **Number** | Value of \_fw_retry environment var at time of DFU initialization | [optional] | -| **errors** | **Number** | The number of consecutive errors the DFU process has encountered | [optional] | -| **read** | **Number** | The amount the notecard has read of the image from notehub | [optional] | -| **updated** | **Number** | Last updated timestamp | [optional] | -| **version** | **String** | Last known version, which is generally a JSON object contained within the firmware image | [optional] | +| Name | Type | Description | Notes | +| ----------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **type** | **String** | | [optional] | +| **file** | **String** | Firmware filename | [optional] | +| **length** | **Number** | Length of firmware file | [optional] | +| **crc32** | **Number** | Used for image verification | [optional] | +| **md5** | **String** | Used for image verification | [optional] | +| **mode** | **String** | _ \"idle\" - nothing downloading or downloaded _ \"error\" - halted and in the error state _ \"downloading\" - transferring data from cloud to module _ \"sideloading\" - transferring data via request to module _ \"ready\" - DFU data is ready/verified and waiting on external storage _ \"ready-retry\" - DFU data is ready/verified and retrying _ \"updating\" - currently updating _ \"completed\" - DFU is done successfully | [optional] | +| **status** | **String** | Status message | [optional] | +| **began** | **Number** | The time when the DFU began | [optional] | +| **retry** | **Number** | Value of \_fw_retry environment var at time of DFU initialization | [optional] | +| **errors** | **Number** | The number of consecutive errors the DFU process has encountered | [optional] | +| **read** | **Number** | The amount the notecard has read of the image from notehub | [optional] | +| **updated** | **Number** | Last updated timestamp | [optional] | +| **version** | **String** | Last known version, which is generally a JSON object contained within the firmware image | [optional] | ## Enum: TypeEnum diff --git a/src/docs/DeviceSession.md b/src/docs/DeviceSession.md index 61d1178c..088b9085 100644 --- a/src/docs/DeviceSession.md +++ b/src/docs/DeviceSession.md @@ -2,51 +2,51 @@ ## Properties -| Name | Type | Description | Notes | -| ----------------- | ------------------------------------- | ----------------------------------------------------------------------- | ---------- | -| **session** | **String** | Session UID | [optional] | -| **device** | **String** | Device UID | [optional] | -| **sn** | **String** | Device Serial Number | [optional] | -| **product** | **String** | Product UID | [optional] | -| **fleets** | **[String]** | Array of Fleet UIDs | [optional] | -| **cell** | **String** | Cell ID where the session originated and quality ("mcc,mnc,lac,cellid") | [optional] | -| **scan** | **Blob** | | [optional] | -| **triangulate** | **Object** | | [optional] | -| **rssi** | **Number** | | [optional] | -| **sinr** | **Number** | | [optional] | -| **rsrp** | **Number** | | [optional] | -| **rsrq** | **Number** | | [optional] | -| **bars** | **Number** | | [optional] | -| **rat** | **String** | | [optional] | -| **bearer** | **String** | | [optional] | -| **ip** | **String** | | [optional] | -| **bssid** | **String** | | [optional] | -| **ssid** | **String** | | [optional] | -| **iccid** | **String** | | [optional] | -| **apn** | **String** | | [optional] | -| **tower** | [**TowerLocation**](TowerLocation.md) | | [optional] | -| **tri** | [**TowerLocation**](TowerLocation.md) | | [optional] | -| **when** | **Number** | Last known capture time of a note routed through this session | [optional] | -| **whereWhen** | **Number** | | [optional] | -| **where** | **String** | Where OLC | [optional] | -| **whereLat** | **Number** | | [optional] | -| **whereLon** | **Number** | | [optional] | -| **whereLocation** | **String** | | [optional] | -| **whereCountry** | **String** | | [optional] | -| **whereTimezone** | **String** | | [optional] | -| **usageActual** | **Boolean** | | [optional] | -| **voltage** | **Number** | | [optional] | -| **temp** | **Number** | | [optional] | -| **continuous** | **Boolean** | | [optional] | -| **tls** | **Boolean** | | [optional] | -| **work** | **Number** | Last time work was done for this session | [optional] | -| **events** | **Number** | Number of events routed | [optional] | -| **moved** | **Number** | | [optional] | -| **orientation** | **String** | | [optional] | -| **hpSecsTotal** | **Number** | | [optional] | -| **hpSecsData** | **Number** | | [optional] | -| **hpSecsGps** | **Number** | | [optional] | -| **hpCyclesTotal** | **Number** | | [optional] | -| **hpCyclesData** | **Number** | | [optional] | -| **hpCyclesGps** | **Number** | | [optional] | -| **period** | [**DeviceUsage**](DeviceUsage.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------- | ----------------------------------------------------------------------------------- | ---------- | +| **session** | **String** | Session UID | [optional] | +| **device** | **String** | Device UID | [optional] | +| **sn** | **String** | Device Serial Number | [optional] | +| **product** | **String** | Product UID | [optional] | +| **fleets** | **[String]** | Array of Fleet UIDs | [optional] | +| **cell** | **String** | Cell ID where the session originated and quality (\"mcc,mnc,lac,cellid\") | [optional] | +| **scan** | **Blob** | | [optional] | +| **triangulate** | **Object** | | [optional] | +| **rssi** | **Number** | | [optional] | +| **sinr** | **Number** | | [optional] | +| **rsrp** | **Number** | | [optional] | +| **rsrq** | **Number** | | [optional] | +| **bars** | **Number** | | [optional] | +| **rat** | **String** | | [optional] | +| **bearer** | **String** | | [optional] | +| **ip** | **String** | | [optional] | +| **bssid** | **String** | | [optional] | +| **ssid** | **String** | | [optional] | +| **iccid** | **String** | | [optional] | +| **apn** | **String** | | [optional] | +| **tower** | [**TowerLocation**](TowerLocation.md) | | [optional] | +| **tri** | [**TowerLocation**](TowerLocation.md) | | [optional] | +| **when** | **Number** | Last known capture time of a note routed through this session | [optional] | +| **whereWhen** | **Number** | | [optional] | +| **where** | **String** | Where OLC | [optional] | +| **whereLat** | **Number** | | [optional] | +| **whereLon** | **Number** | | [optional] | +| **whereLocation** | **String** | | [optional] | +| **whereCountry** | **String** | | [optional] | +| **whereTimezone** | **String** | | [optional] | +| **usageActual** | **Boolean** | | [optional] | +| **voltage** | **Number** | | [optional] | +| **temp** | **Number** | | [optional] | +| **continuous** | **Boolean** | | [optional] | +| **tls** | **Boolean** | | [optional] | +| **work** | **Number** | Last time work was done for this session | [optional] | +| **events** | **Number** | Number of events routed | [optional] | +| **moved** | **Number** | | [optional] | +| **orientation** | **String** | | [optional] | +| **hpSecsTotal** | **Number** | | [optional] | +| **hpSecsData** | **Number** | | [optional] | +| **hpSecsGps** | **Number** | | [optional] | +| **hpCyclesTotal** | **Number** | | [optional] | +| **hpCyclesData** | **Number** | | [optional] | +| **hpCyclesGps** | **Number** | | [optional] | +| **period** | [**DeviceUsage**](DeviceUsage.md) | | [optional] | diff --git a/src/docs/DevicesApi.md b/src/docs/DevicesApi.md index 8f2a4ce0..2c062b4d 100644 --- a/src/docs/DevicesApi.md +++ b/src/docs/DevicesApi.md @@ -39,11 +39,11 @@ apiInstance.deleteProjectDevice(projectUID, deviceUID, purge).then(() => { ### Parameters -| Name | Type | Description | Notes | -| -------------- | ---------- | ----------- | -------------------- | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ---------------------------- | | **projectUID** | **String** | | | **deviceUID** | **String** | | -| **purge** | **String** | | [default to 'false'] | +| **purge** | **String** | | [default to 'false'] | ### Return type diff --git a/src/docs/Event.md b/src/docs/Event.md index 592e77d3..ed079b55 100644 --- a/src/docs/Event.md +++ b/src/docs/Event.md @@ -20,7 +20,7 @@ | **updates** | **Number** | | [optional] | | **body** | **Object** | A JSON object containing event details | [optional] | | **payload** | **String** | A base64-encoded binary payload | [optional] | -| **bestLocationType** | **String** | One of "gps", "triangulated", or "tower" | [optional] | +| **bestLocationType** | **String** | One of \"gps\", \"triangulated\", or \"tower\" | [optional] | | **bestLocationWhen** | **Number** | Unix timestamp | [optional] | | **bestLat** | **Number** | Latitude | [optional] | | **bestLon** | **Number** | Longitude | [optional] | @@ -58,4 +58,4 @@ | **bars** | **Number** | Bars. Only available on \_session.qo events. | [optional] | | **voltage** | **Number** | Device voltage. Only available on \_session.qo events. | [optional] | | **temp** | **Number** | Device temperature. Only available on \_session.qo events. | [optional] | -| **environment** | **Object** | Routed environment variables beginning with "$". Only available on \_session.qo events. | [optional] | +| **environment** | **Object** | Routed environment variables beginning with \"$\". Only available on \_session.qo events. | [optional] | diff --git a/src/docs/EventApi.md b/src/docs/EventApi.md index b2430ee5..00f0f9f9 100644 --- a/src/docs/EventApi.md +++ b/src/docs/EventApi.md @@ -48,19 +48,19 @@ apiInstance.getFleetEvents(projectUID, fleetUID, opts).then((data) => { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ----------- | -------------- | ---------------------------------- | +| Name | Type | Description | Notes | +| ------------------- | ----------- | -------------- | ------------------------------------------ | | **projectUID** | **String** | | | **fleetUID** | **String** | | -| **pageSize** | **Number** | | [optional] [default to 50] | -| **pageNum** | **Number** | | [optional] [default to 1] | -| **deviceUID** | **String** | A Device UID. | [optional] | -| **sortBy** | **String** | | [optional] [default to 'captured'] | -| **sortOrder** | **String** | | [optional] [default to 'asc'] | -| **startDate** | **Number** | Unix timestamp | [optional] | -| **endDate** | **Number** | Unix timestamp | [optional] | -| **systemFilesOnly** | **Boolean** | | [optional] | -| **files** | **String** | | [optional] | +| **pageSize** | **Number** | | [optional] [default to 50] | +| **pageNum** | **Number** | | [optional] [default to 1] | +| **deviceUID** | **String** | A Device UID. | [optional] | +| **sortBy** | **String** | | [optional] [default to 'captured'] | +| **sortOrder** | **String** | | [optional] [default to 'asc'] | +| **startDate** | **Number** | Unix timestamp | [optional] | +| **endDate** | **Number** | Unix timestamp | [optional] | +| **systemFilesOnly** | **Boolean** | | [optional] | +| **files** | **String** | | [optional] | ### Return type @@ -113,18 +113,18 @@ apiInstance.getFleetEventsByCursor(projectUID, fleetUID, opts).then((data) => { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| **projectUID** | **String** | | -| **fleetUID** | **String** | | -| **limit** | **Number** | | [optional] [default to 50] | -| **cursor** | **String** | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. | [optional] | -| **sortOrder** | **String** | | [optional] [default to 'asc'] | -| **systemFilesOnly** | **Boolean** | | [optional] | -| **files** | **String** | | [optional] | -| **deviceUID** | **String** | A Device UID. | [optional] | -| **startDate** | **Number** | Unix timestamp | [optional] | -| **endDate** | **Number** | Unix timestamp | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| **projectUID** | **String** | | +| **fleetUID** | **String** | | +| **limit** | **Number** | | [optional] [default to 50] | +| **cursor** | **String** | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. | [optional] | +| **sortOrder** | **String** | | [optional] [default to 'asc'] | +| **systemFilesOnly** | **Boolean** | | [optional] | +| **files** | **String** | | [optional] | +| **deviceUID** | **String** | A Device UID. | [optional] | +| **startDate** | **Number** | Unix timestamp | [optional] | +| **endDate** | **Number** | Unix timestamp | [optional] | ### Return type @@ -177,18 +177,18 @@ apiInstance.getProjectEvents(projectUID, opts).then((data) => { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ----------- | -------------- | ---------------------------------- | +| Name | Type | Description | Notes | +| ------------------- | ----------- | -------------- | ------------------------------------------ | | **projectUID** | **String** | | -| **pageSize** | **Number** | | [optional] [default to 50] | -| **pageNum** | **Number** | | [optional] [default to 1] | -| **deviceUID** | **String** | A Device UID. | [optional] | -| **sortBy** | **String** | | [optional] [default to 'captured'] | -| **sortOrder** | **String** | | [optional] [default to 'asc'] | -| **startDate** | **Number** | Unix timestamp | [optional] | -| **endDate** | **Number** | Unix timestamp | [optional] | -| **systemFilesOnly** | **Boolean** | | [optional] | -| **files** | **String** | | [optional] | +| **pageSize** | **Number** | | [optional] [default to 50] | +| **pageNum** | **Number** | | [optional] [default to 1] | +| **deviceUID** | **String** | A Device UID. | [optional] | +| **sortBy** | **String** | | [optional] [default to 'captured'] | +| **sortOrder** | **String** | | [optional] [default to 'asc'] | +| **startDate** | **Number** | Unix timestamp | [optional] | +| **endDate** | **Number** | Unix timestamp | [optional] | +| **systemFilesOnly** | **Boolean** | | [optional] | +| **files** | **String** | | [optional] | ### Return type @@ -240,17 +240,17 @@ apiInstance.getProjectEventsByCursor(projectUID, opts).then((data) => { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| **projectUID** | **String** | | -| **limit** | **Number** | | [optional] [default to 50] | -| **cursor** | **String** | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. | [optional] | -| **sortOrder** | **String** | | [optional] [default to 'asc'] | -| **systemFilesOnly** | **Boolean** | | [optional] | -| **files** | **String** | | [optional] | -| **deviceUID** | **String** | A Device UID. | [optional] | -| **startDate** | **Number** | Unix timestamp | [optional] | -| **endDate** | **Number** | Unix timestamp | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| **projectUID** | **String** | | +| **limit** | **Number** | | [optional] [default to 50] | +| **cursor** | **String** | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. | [optional] | +| **sortOrder** | **String** | | [optional] [default to 'asc'] | +| **systemFilesOnly** | **Boolean** | | [optional] | +| **files** | **String** | | [optional] | +| **deviceUID** | **String** | A Device UID. | [optional] | +| **startDate** | **Number** | Unix timestamp | [optional] | +| **endDate** | **Number** | Unix timestamp | [optional] | ### Return type diff --git a/src/docs/FleetApi.md b/src/docs/FleetApi.md index 49dc68ba..5f69eb29 100644 --- a/src/docs/FleetApi.md +++ b/src/docs/FleetApi.md @@ -337,19 +337,19 @@ apiInstance.getFleetEvents(projectUID, fleetUID, opts).then((data) => { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ----------- | -------------- | ---------------------------------- | +| Name | Type | Description | Notes | +| ------------------- | ----------- | -------------- | ------------------------------------------ | | **projectUID** | **String** | | | **fleetUID** | **String** | | -| **pageSize** | **Number** | | [optional] [default to 50] | -| **pageNum** | **Number** | | [optional] [default to 1] | -| **deviceUID** | **String** | A Device UID. | [optional] | -| **sortBy** | **String** | | [optional] [default to 'captured'] | -| **sortOrder** | **String** | | [optional] [default to 'asc'] | -| **startDate** | **Number** | Unix timestamp | [optional] | -| **endDate** | **Number** | Unix timestamp | [optional] | -| **systemFilesOnly** | **Boolean** | | [optional] | -| **files** | **String** | | [optional] | +| **pageSize** | **Number** | | [optional] [default to 50] | +| **pageNum** | **Number** | | [optional] [default to 1] | +| **deviceUID** | **String** | A Device UID. | [optional] | +| **sortBy** | **String** | | [optional] [default to 'captured'] | +| **sortOrder** | **String** | | [optional] [default to 'asc'] | +| **startDate** | **Number** | Unix timestamp | [optional] | +| **endDate** | **Number** | Unix timestamp | [optional] | +| **systemFilesOnly** | **Boolean** | | [optional] | +| **files** | **String** | | [optional] | ### Return type @@ -402,18 +402,18 @@ apiInstance.getFleetEventsByCursor(projectUID, fleetUID, opts).then((data) => { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| **projectUID** | **String** | | -| **fleetUID** | **String** | | -| **limit** | **Number** | | [optional] [default to 50] | -| **cursor** | **String** | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. | [optional] | -| **sortOrder** | **String** | | [optional] [default to 'asc'] | -| **systemFilesOnly** | **Boolean** | | [optional] | -| **files** | **String** | | [optional] | -| **deviceUID** | **String** | A Device UID. | [optional] | -| **startDate** | **Number** | Unix timestamp | [optional] | -| **endDate** | **Number** | Unix timestamp | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| **projectUID** | **String** | | +| **fleetUID** | **String** | | +| **limit** | **Number** | | [optional] [default to 50] | +| **cursor** | **String** | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. | [optional] | +| **sortOrder** | **String** | | [optional] [default to 'asc'] | +| **systemFilesOnly** | **Boolean** | | [optional] | +| **files** | **String** | | [optional] | +| **deviceUID** | **String** | A Device UID. | [optional] | +| **startDate** | **Number** | Unix timestamp | [optional] | +| **endDate** | **Number** | Unix timestamp | [optional] | ### Return type diff --git a/src/docs/GetDeviceLatest200Response.md b/src/docs/GetDeviceLatest200Response.md index 9ddb8e73..7d9b5c41 100644 --- a/src/docs/GetDeviceLatest200Response.md +++ b/src/docs/GetDeviceLatest200Response.md @@ -2,6 +2,6 @@ ## Properties -| Name | Type | Description | Notes | -| ---------------- | ----------------------- | -------------------------------------------------------------------------------- | ---------- | -| **latestEvents** | [**[Event]**](Event.md) | The set of latest events. Will always include the current "session.begin" event. | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ----------------------- | -------------------------------------------------------------------------------------------- | ---------- | +| **latestEvents** | [**[Event]**](Event.md) | The set of latest events. Will always include the current \"session.begin\" event. | [optional] | diff --git a/src/docs/GetProjectEventsByCursor200Response.md b/src/docs/GetProjectEventsByCursor200Response.md index 215c5fa6..1a75a9de 100644 --- a/src/docs/GetProjectEventsByCursor200Response.md +++ b/src/docs/GetProjectEventsByCursor200Response.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| -------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | -| **events** | [**[Event]**](Event.md) | | -| **nextCursor** | **String** | The cursor value of the next result, which is intended to be used as the "cursor" parameter value of the next call to this method. An empty string is returned if there are no more results after this results set. | -| **hasMore** | **Boolean** | True if there are more events | +| Name | Type | Description | Notes | +| -------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **events** | [**[Event]**](Event.md) | | +| **nextCursor** | **String** | The cursor value of the next result, which is intended to be used as the \"cursor\" parameter value of the next call to this method. An empty string is returned if there are no more results after this results set. | +| **hasMore** | **Boolean** | True if there are more events | diff --git a/src/docs/HttpTransform.md b/src/docs/HttpTransform.md index f5eb4f45..cb5bd8bf 100644 --- a/src/docs/HttpTransform.md +++ b/src/docs/HttpTransform.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ----------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -| **format** | **String** | Data transformation to apply. Options of "" for none, "bridge" for Azure IoT, "jsonata" for JSONata expression, or "flatten", "simple", "body" or "payload" | [optional] | -| **jsonata** | **String** | JSONata transformation, if JSONata | [optional] | +| Name | Type | Description | Notes | +| ----------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **format** | **String** | Data transformation to apply. Options of \"\" for none, \"bridge\" for Azure IoT, \"jsonata\" for JSONata expression, or \"flatten\", \"simple\", \"body\" or \"payload\" | [optional] | +| **jsonata** | **String** | JSONata transformation, if JSONata | [optional] | ## Enum: FormatEnum diff --git a/src/docs/NotesApi.md b/src/docs/NotesApi.md index c2357cf6..3fb9f122 100644 --- a/src/docs/NotesApi.md +++ b/src/docs/NotesApi.md @@ -15,7 +15,7 @@ All URIs are relative to *https://api.notefile.net* > handleNoteAdd(projectUID, deviceUID, notefileID, note) -Adds a Note to a Notefile, creating the Notefile if it doesn't yet exist. +Adds a Note to a Notefile, creating the Notefile if it doesn't yet exist. ### Example @@ -127,7 +127,7 @@ apiInstance.handleNoteChanges(projectUID, deviceUID, notefileID, opts).then((dat > handleNoteCreateAdd(projectUID, deviceUID, notefileID, noteID, note) -Adds a Note to a Notefile, creating the Notefile if it doesn't yet exist. +Adds a Note to a Notefile, creating the Notefile if it doesn't yet exist. ### Example diff --git a/src/docs/ProjectApi.md b/src/docs/ProjectApi.md index 2f63b7fa..008d3aca 100644 --- a/src/docs/ProjectApi.md +++ b/src/docs/ProjectApi.md @@ -434,18 +434,18 @@ apiInstance.getProjectEvents(projectUID, opts).then((data) => { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ----------- | -------------- | ---------------------------------- | +| Name | Type | Description | Notes | +| ------------------- | ----------- | -------------- | ------------------------------------------ | | **projectUID** | **String** | | -| **pageSize** | **Number** | | [optional] [default to 50] | -| **pageNum** | **Number** | | [optional] [default to 1] | -| **deviceUID** | **String** | A Device UID. | [optional] | -| **sortBy** | **String** | | [optional] [default to 'captured'] | -| **sortOrder** | **String** | | [optional] [default to 'asc'] | -| **startDate** | **Number** | Unix timestamp | [optional] | -| **endDate** | **Number** | Unix timestamp | [optional] | -| **systemFilesOnly** | **Boolean** | | [optional] | -| **files** | **String** | | [optional] | +| **pageSize** | **Number** | | [optional] [default to 50] | +| **pageNum** | **Number** | | [optional] [default to 1] | +| **deviceUID** | **String** | A Device UID. | [optional] | +| **sortBy** | **String** | | [optional] [default to 'captured'] | +| **sortOrder** | **String** | | [optional] [default to 'asc'] | +| **startDate** | **Number** | Unix timestamp | [optional] | +| **endDate** | **Number** | Unix timestamp | [optional] | +| **systemFilesOnly** | **Boolean** | | [optional] | +| **files** | **String** | | [optional] | ### Return type @@ -497,17 +497,17 @@ apiInstance.getProjectEventsByCursor(projectUID, opts).then((data) => { ### Parameters -| Name | Type | Description | Notes | -| ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| **projectUID** | **String** | | -| **limit** | **Number** | | [optional] [default to 50] | -| **cursor** | **String** | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. | [optional] | -| **sortOrder** | **String** | | [optional] [default to 'asc'] | -| **systemFilesOnly** | **Boolean** | | [optional] | -| **files** | **String** | | [optional] | -| **deviceUID** | **String** | A Device UID. | [optional] | -| **startDate** | **Number** | Unix timestamp | [optional] | -| **endDate** | **Number** | Unix timestamp | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| **projectUID** | **String** | | +| **limit** | **Number** | | [optional] [default to 50] | +| **cursor** | **String** | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. | [optional] | +| **sortOrder** | **String** | | [optional] [default to 'asc'] | +| **systemFilesOnly** | **Boolean** | | [optional] | +| **files** | **String** | | [optional] | +| **deviceUID** | **String** | A Device UID. | [optional] | +| **startDate** | **Number** | Unix timestamp | [optional] | +| **endDate** | **Number** | Unix timestamp | [optional] | ### Return type diff --git a/src/docs/Route.md b/src/docs/Route.md index f4d3e055..a5d95bf0 100644 --- a/src/docs/Route.md +++ b/src/docs/Route.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ------------- | --------------------------------- | ------------------ | ------------------------------ | -| **uid** | **String** | Route UID | [optional] | -| **label** | **String** | Route Label | [optional] | -| **routeType** | **String** | Type of route. | [optional] [default to 'http'] | -| **modified** | **String** | Last Modified | [optional] | -| **disabled** | **Boolean** | Is route disabled? | [optional] [default to false] | -| **schema** | [**RouteSchema**](RouteSchema.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------- | --------------------------------- | ------------------ | -------------------------------------- | +| **uid** | **String** | Route UID | [optional] | +| **label** | **String** | Route Label | [optional] | +| **routeType** | **String** | Type of route. | [optional] [default to 'http'] | +| **modified** | **String** | Last Modified | [optional] | +| **disabled** | **Boolean** | Is route disabled? | [optional] [default to false] | +| **schema** | [**RouteSchema**](RouteSchema.md) | | [optional] | ## Enum: RouteTypeEnum diff --git a/src/docs/RouteSchema.md b/src/docs/RouteSchema.md index 46f8cf7c..17291eed 100644 --- a/src/docs/RouteSchema.md +++ b/src/docs/RouteSchema.md @@ -2,41 +2,41 @@ ## Properties -| Name | Type | Description | Notes | -| -------------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | -| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] | -| **transform** | [**SnowflakeTransform**](SnowflakeTransform.md) | | [optional] | -| **throttleMs** | **Number** | | [optional] | -| **url** | **String** | | [optional] | -| **httpHeaders** | **{String: String}** | | [optional] | -| **disableHttpHeaders** | **Boolean** | | [optional] [default to false] | -| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] | -| **alias** | **String** | | [optional] | -| **broker** | **String** | | [optional] | -| **port** | **Number** | | [optional] | -| **username** | **String** | | [optional] | -| **password** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | -| **topic** | **String** | | [optional] | -| **certificate** | **String** | Certificate with \\n newlines. This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | -| **certificateName** | **String** | Name of certificate. | [optional] | -| **key** | **String** | Key with \\n newlines. This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | -| **privateKeyName** | **String** | Name of PEM key. If omitted, defaults to "present" | [optional] [default to 'present'] | -| **region** | **String** | | [optional] | -| **accessKeyId** | **String** | | [optional] | -| **accessKeySecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | -| **messageGroupId** | **String** | | [optional] | -| **messageDeduplicationId** | **String** | | [optional] | -| **channel** | **String** | | [optional] | -| **testApi** | **Boolean** | | [optional] [default to false] | -| **dataFeedKey** | **String** | | [optional] | -| **clientId** | **String** | | [optional] | -| **clientSecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | -| **functionsKeySecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | -| **sasPolicyName** | **String** | | [optional] | -| **sasPolicyKey** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | -| **appKey** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | -| **organizationName** | **String** | | [optional] | -| **accountName** | **String** | | [optional] | -| **userName** | **String** | | [optional] | -| **pem** | **String** | PEM key with \\n newlines. This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| Name | Type | Description | Notes | +| -------------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | +| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] | +| **transform** | [**SnowflakeTransform**](SnowflakeTransform.md) | | [optional] | +| **throttleMs** | **Number** | | [optional] | +| **url** | **String** | | [optional] | +| **httpHeaders** | **{String: String}** | | [optional] | +| **disableHttpHeaders** | **Boolean** | | [optional] [default to false] | +| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] | +| **alias** | **String** | | [optional] | +| **broker** | **String** | | [optional] | +| **port** | **Number** | | [optional] | +| **username** | **String** | | [optional] | +| **password** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **topic** | **String** | | [optional] | +| **certificate** | **String** | Certificate with \\n newlines. This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **certificateName** | **String** | Name of certificate. | [optional] | +| **key** | **String** | Key with \\n newlines. This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **privateKeyName** | **String** | Name of PEM key. If omitted, defaults to \"present\" | [optional] [default to 'present'] | +| **region** | **String** | | [optional] | +| **accessKeyId** | **String** | | [optional] | +| **accessKeySecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **messageGroupId** | **String** | | [optional] | +| **messageDeduplicationId** | **String** | | [optional] | +| **channel** | **String** | | [optional] | +| **testApi** | **Boolean** | | [optional] [default to false] | +| **dataFeedKey** | **String** | | [optional] | +| **clientId** | **String** | | [optional] | +| **clientSecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **functionsKeySecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **sasPolicyName** | **String** | | [optional] | +| **sasPolicyKey** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **appKey** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **organizationName** | **String** | | [optional] | +| **accountName** | **String** | | [optional] | +| **userName** | **String** | | [optional] | +| **pem** | **String** | PEM key with \\n newlines. This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | diff --git a/src/docs/Snowflake.md b/src/docs/Snowflake.md index 9bf9107a..20056ffe 100644 --- a/src/docs/Snowflake.md +++ b/src/docs/Snowflake.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| -------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | -| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] | -| **transform** | [**SnowflakeTransform**](SnowflakeTransform.md) | | [optional] | -| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] | -| **organizationName** | **String** | | [optional] | -| **accountName** | **String** | | [optional] | -| **userName** | **String** | | [optional] | -| **privateKeyName** | **String** | Name of PEM key. If omitted, defaults to "present" | [optional] [default to 'present'] | -| **pem** | **String** | PEM key with \\n newlines. This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | +| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] | +| **transform** | [**SnowflakeTransform**](SnowflakeTransform.md) | | [optional] | +| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] | +| **organizationName** | **String** | | [optional] | +| **accountName** | **String** | | [optional] | +| **userName** | **String** | | [optional] | +| **privateKeyName** | **String** | Name of PEM key. If omitted, defaults to \"present\" | [optional] [default to 'present'] | +| **pem** | **String** | PEM key with \\n newlines. This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | diff --git a/src/docs/SnowflakeTransform.md b/src/docs/SnowflakeTransform.md index 9714a547..19ee983c 100644 --- a/src/docs/SnowflakeTransform.md +++ b/src/docs/SnowflakeTransform.md @@ -2,7 +2,7 @@ ## Properties -| Name | Type | Description | Notes | -| ----------- | ---------- | -------------------------------------------------------------------------- | --------------------------------- | -| **format** | **String** | Data transformation to apply. Only "jsonata" is valid for Snowflake routes | [optional] [default to 'jsonata'] | -| **jsonata** | **String** | JSONata transformation | [optional] | +| Name | Type | Description | Notes | +| ----------- | ---------- | -------------------------------------------------------------------------------------- | ----------------------------------------- | +| **format** | **String** | Data transformation to apply. Only \"jsonata\" is valid for Snowflake routes | [optional] [default to 'jsonata'] | +| **jsonata** | **String** | JSONata transformation | [optional] | diff --git a/src/docs/UserDbRoute.md b/src/docs/UserDbRoute.md index 696f11f8..90f0e7df 100644 --- a/src/docs/UserDbRoute.md +++ b/src/docs/UserDbRoute.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ------------ | ----------- | ----------- | ---------------------------------------------------------------- | -| **uid** | **String** | | [optional] [default to 'route:8d65a087d5d290ce5bdf03aeff2becc0'] | -| **label** | **String** | | [optional] [default to 'success route'] | -| **type** | **String** | | [optional] [default to 'http'] | -| **modified** | **String** | | [optional] [default to '2020-03-09T17:58:37Z'] | -| **disabled** | **Boolean** | | [optional] [default to false] | +| Name | Type | Description | Notes | +| ------------ | ----------- | ----------- | ------------------------------------------------------------------------ | +| **uid** | **String** | | [optional] [default to 'route:8d65a087d5d290ce5bdf03aeff2becc0'] | +| **label** | **String** | | [optional] [default to 'success route'] | +| **type** | **String** | | [optional] [default to 'http'] | +| **modified** | **String** | | [optional] [default to '2020-03-09T17:58:37Z'] | +| **disabled** | **Boolean** | | [optional] [default to false] |