{"_id":"@b-jones-rfd/nice-api-tasks","_rev":"7-d16ede7c4842e1ff2777d1f38df4b249","name":"@b-jones-rfd/nice-api-tasks","dist-tags":{"latest":"0.2.5"},"versions":{"0.0.4":{"name":"@b-jones-rfd/nice-api-tasks","version":"0.0.4","keywords":[],"author":{"name":"B-Jones-RFD"},"license":"MIT","_id":"@b-jones-rfd/nice-api-tasks@0.0.4","maintainers":[{"name":"b-jones-rfd","email":"b.jones.rfd.82@gmail.com"}],"dist":{"shasum":"4f2dd9dddc18ce5c3b511bfef6e2b6ab3671c0a7","tarball":"https://registry.npmjs.org/@b-jones-rfd/nice-api-tasks/-/nice-api-tasks-0.0.4.tgz","fileCount":9,"integrity":"sha512-GEY2/NTyRD3AK5vrEoT48qElivs3dYsBASuRGx6jHpjDuaTriRdiOsokW2rutqc5DQmcIgC1GG2CBea2l7Fd9g==","signatures":[{"sig":"MEUCIQDRPy9uk6wNNO11yLei4ZiBCuQEGisgxR4dmrASCcdp6QIgeEm7+bKFro1YBSn68T5/pa4vUZij46GVW8nzQg/7Sgs=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":6599},"main":"./dist/index.js","_from":"file:b-jones-rfd-nice-api-tasks-0.0.4.tgz","types":"./dist/index.d.ts","module":"./dist/index.mjs","engines":{"node":">=18"},"private":false,"scripts":{"ci":"pnpm run lint && pnpm run test && pnpm run build","dev":"vitest","lint":"tsc","test":"vitest run","build":"tsup src/index.ts --format cjs,esm --dts","release":"pnpm run lint && pnpm run test && pnpm run build && changeset publish"},"_npmUser":{"name":"b-jones-rfd","actor":{"name":"b-jones-rfd","type":"user","email":"b.jones.rfd.82@gmail.com"},"email":"b.jones.rfd.82@gmail.com"},"_resolved":"/tmp/014f7f9a881e9348583fa6fb1f0e62e1/b-jones-rfd-nice-api-tasks-0.0.4.tgz","_integrity":"sha512-GEY2/NTyRD3AK5vrEoT48qElivs3dYsBASuRGx6jHpjDuaTriRdiOsokW2rutqc5DQmcIgC1GG2CBea2l7Fd9g==","_npmVersion":"10.9.2","description":"Perform common tasks using the Nice InContact API","directories":{},"_nodeVersion":"23.11.1","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.0","vitest":"^3.2.4","prettier":"^3.5.3","typescript":"^5.8.3","@types/node":"^24.0.3","@changesets/cli":"^2.29.4"},"_npmOperationalInternal":{"tmp":"tmp/nice-api-tasks_0.0.4_1750284906788_0.28368071952997975","host":"s3://npm-registry-packages-npm-production"}},"0.1.0":{"name":"@b-jones-rfd/nice-api-tasks","version":"0.1.0","keywords":[],"author":{"name":"B-Jones-RFD"},"license":"MIT","_id":"@b-jones-rfd/nice-api-tasks@0.1.0","maintainers":[{"name":"b-jones-rfd","email":"b.jones.rfd.82@gmail.com"}],"dist":{"shasum":"8805cde2247d134024aef079fea0d6dbd17e755f","tarball":"https://registry.npmjs.org/@b-jones-rfd/nice-api-tasks/-/nice-api-tasks-0.1.0.tgz","fileCount":10,"integrity":"sha512-XU4sD8gcOM+d0AjrAO0qUAzvh2lN01BicgXAlVF6NFWUFh6tRUI8jvAuiBdk8epPVVc/j/7MAV+Et4+KYam4iw==","signatures":[{"sig":"MEUCIHzyR/FkfDtwrB1Os0WxcqKaX+Up920ovDj3+YmehiF1AiEA1E69bZ0lT8ArNtqA4CBbQUZol0hl/Lhu9xP7K2nGEy8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":12112},"main":"./dist/index.js","_from":"file:b-jones-rfd-nice-api-tasks-0.1.0.tgz","types":"./dist/index.d.ts","module":"./dist/index.mjs","engines":{"node":">=18"},"private":false,"scripts":{"ci":"pnpm run lint && pnpm run test && pnpm run build","dev":"vitest","lint":"tsc","test":"vitest run","build":"tsup src/index.ts --format cjs,esm --dts","release":"pnpm run lint && pnpm run test && pnpm run build && changeset publish"},"_npmUser":{"name":"b-jones-rfd","actor":{"name":"b-jones-rfd","type":"user","email":"b.jones.rfd.82@gmail.com"},"email":"b.jones.rfd.82@gmail.com"},"_resolved":"/tmp/7135e70fd4bec476ff5716fb5f4554ff/b-jones-rfd-nice-api-tasks-0.1.0.tgz","_integrity":"sha512-XU4sD8gcOM+d0AjrAO0qUAzvh2lN01BicgXAlVF6NFWUFh6tRUI8jvAuiBdk8epPVVc/j/7MAV+Et4+KYam4iw==","_npmVersion":"10.9.2","description":"Perform common tasks using the Nice InContact API","directories":{},"_nodeVersion":"23.11.1","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.0","vitest":"^3.2.4","prettier":"^3.5.3","typescript":"^5.8.3","@types/node":"^24.0.3","@changesets/cli":"^2.29.4"},"_npmOperationalInternal":{"tmp":"tmp/nice-api-tasks_0.1.0_1751721577219_0.025114681851258203","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@b-jones-rfd/nice-api-tasks","version":"0.1.1","keywords":[],"author":{"name":"B-Jones-RFD"},"license":"MIT","_id":"@b-jones-rfd/nice-api-tasks@0.1.1","maintainers":[{"name":"b-jones-rfd","email":"b.jones.rfd.82@gmail.com"}],"dist":{"shasum":"b5fc68c61a45cc10c83f26686c7f5acb267b6a77","tarball":"https://registry.npmjs.org/@b-jones-rfd/nice-api-tasks/-/nice-api-tasks-0.1.1.tgz","fileCount":10,"integrity":"sha512-RJYY9QfXhJzJCD+HRURi+yu58j/2bhknR4/inf7OlNfJnNgv0So9ekJziFS4YR2p3wW4YlRsFqmgmJ+B+Nz0NA==","signatures":[{"sig":"MEYCIQCU2Ui+M3Fm5b4eIXIgp4U8rR+3csfE5ibzud/IeTJntAIhAI4tiTe8K5cJs9SAvPmZxLKWiDiRb1l5EjA/97edJ9Hb","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":15833},"main":"./dist/index.js","_from":"file:b-jones-rfd-nice-api-tasks-0.1.1.tgz","types":"./dist/index.d.ts","module":"./dist/index.mjs","engines":{"node":">=18"},"private":false,"scripts":{"ci":"pnpm run lint && pnpm run test && pnpm run build","dev":"vitest","lint":"tsc","test":"vitest run","build":"tsup src/index.ts --format cjs,esm --dts","release":"pnpm run lint && pnpm run test && pnpm run build && changeset publish"},"_npmUser":{"name":"b-jones-rfd","actor":{"name":"b-jones-rfd","type":"user","email":"b.jones.rfd.82@gmail.com"},"email":"b.jones.rfd.82@gmail.com"},"_resolved":"/tmp/8edbecea41c642de12dcab319c8565d0/b-jones-rfd-nice-api-tasks-0.1.1.tgz","_integrity":"sha512-RJYY9QfXhJzJCD+HRURi+yu58j/2bhknR4/inf7OlNfJnNgv0So9ekJziFS4YR2p3wW4YlRsFqmgmJ+B+Nz0NA==","_npmVersion":"10.9.2","description":"Perform common tasks using the Nice InContact API","directories":{},"_nodeVersion":"23.11.1","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.0","vitest":"^3.2.4","prettier":"^3.5.3","typescript":"^5.8.3","@types/node":"^24.0.3","@changesets/cli":"^2.29.4"},"_npmOperationalInternal":{"tmp":"tmp/nice-api-tasks_0.1.1_1751725613146_0.7870816286769526","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@b-jones-rfd/nice-api-tasks","version":"0.1.2","keywords":[],"author":{"name":"B-Jones-RFD"},"license":"MIT","_id":"@b-jones-rfd/nice-api-tasks@0.1.2","maintainers":[{"name":"b-jones-rfd","email":"b.jones.rfd.82@gmail.com"}],"dist":{"shasum":"492df9831f7b8be0f0c41b93dc3edfb1ab970452","tarball":"https://registry.npmjs.org/@b-jones-rfd/nice-api-tasks/-/nice-api-tasks-0.1.2.tgz","fileCount":10,"integrity":"sha512-5zOGFSl4FSITcIwJsuR6+jd37qbQPlwOGyX1onHrwJmyktGI7D5UhRsRTNAYYIOpUyQw2oTq7PDbycQxSQWHhg==","signatures":[{"sig":"MEUCIQDTSe5EKVNgVPMZ4pXzQKO27R7uQnxnqGF+vULqjcu6pwIgdDj2+jTiPFzRrwrZOoddkHBOqAHocWfDWZjo1pMKBmE=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":20210},"main":"./dist/index.js","_from":"file:b-jones-rfd-nice-api-tasks-0.1.2.tgz","types":"./dist/index.d.ts","module":"./dist/index.mjs","engines":{"node":">=18"},"private":false,"scripts":{"ci":"pnpm run lint && pnpm run test && pnpm run build","dev":"vitest","lint":"tsc","test":"vitest run","build":"tsup src/index.ts --format cjs,esm --dts","release":"pnpm run lint && pnpm run test && pnpm run build && changeset publish"},"_npmUser":{"name":"b-jones-rfd","actor":{"name":"b-jones-rfd","type":"user","email":"b.jones.rfd.82@gmail.com"},"email":"b.jones.rfd.82@gmail.com"},"_resolved":"/tmp/e39ff12845e8d6426df43a39e0cdbd3d/b-jones-rfd-nice-api-tasks-0.1.2.tgz","_integrity":"sha512-5zOGFSl4FSITcIwJsuR6+jd37qbQPlwOGyX1onHrwJmyktGI7D5UhRsRTNAYYIOpUyQw2oTq7PDbycQxSQWHhg==","_npmVersion":"10.9.2","description":"Perform common tasks using the Nice InContact API","directories":{},"_nodeVersion":"23.11.1","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.0","vitest":"^3.2.4","prettier":"^3.5.3","typescript":"^5.8.3","@types/node":"^24.0.3","@changesets/cli":"^2.29.4"},"_npmOperationalInternal":{"tmp":"tmp/nice-api-tasks_0.1.2_1751729768473_0.3272186086644657","host":"s3://npm-registry-packages-npm-production"}},"0.1.3":{"name":"@b-jones-rfd/nice-api-tasks","version":"0.1.3","keywords":[],"author":{"name":"B-Jones-RFD"},"license":"MIT","_id":"@b-jones-rfd/nice-api-tasks@0.1.3","maintainers":[{"name":"b-jones-rfd","email":"b.jones.rfd.82@gmail.com"}],"dist":{"shasum":"33b8c0c346f2009bb837760ac2190a3934a28f4b","tarball":"https://registry.npmjs.org/@b-jones-rfd/nice-api-tasks/-/nice-api-tasks-0.1.3.tgz","fileCount":10,"integrity":"sha512-yj4NQtDaZACb8Ulcmj4MB2k4omPp3szhsMVcuowuWZo7On6BfpdEKc5uBgZBp6fjGkVgiO1ARXFLG2mqarTGEA==","signatures":[{"sig":"MEYCIQDUqmzyURHwFgqnZQoNVR6VQZnEPN9P4xs3Mn+oz5oN3gIhANNUHzaj9nzOQ2qpQ989pMiJ3nC31fsHLwf/PxRGRMrE","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":24005},"main":"./dist/index.js","_from":"file:b-jones-rfd-nice-api-tasks-0.1.3.tgz","types":"./dist/index.d.ts","module":"./dist/index.mjs","engines":{"node":">=18"},"private":false,"scripts":{"ci":"pnpm run lint && pnpm run test && pnpm run build","dev":"vitest","lint":"tsc","test":"vitest run","build":"tsup src/index.ts --format cjs,esm --dts","release":"pnpm run lint && pnpm run test && pnpm run build && changeset publish"},"_npmUser":{"name":"b-jones-rfd","actor":{"name":"b-jones-rfd","type":"user","email":"b.jones.rfd.82@gmail.com"},"email":"b.jones.rfd.82@gmail.com"},"_resolved":"/tmp/e033e1ee84b04252a59cffed99f0b721/b-jones-rfd-nice-api-tasks-0.1.3.tgz","_integrity":"sha512-yj4NQtDaZACb8Ulcmj4MB2k4omPp3szhsMVcuowuWZo7On6BfpdEKc5uBgZBp6fjGkVgiO1ARXFLG2mqarTGEA==","_npmVersion":"10.9.2","description":"Perform common tasks using the Nice InContact API","directories":{},"_nodeVersion":"23.11.1","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.0","vitest":"^3.2.4","prettier":"^3.5.3","typescript":"^5.8.3","@types/node":"^24.0.3","@changesets/cli":"^2.29.4"},"_npmOperationalInternal":{"tmp":"tmp/nice-api-tasks_0.1.3_1751731761260_0.3736446331758825","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@b-jones-rfd/nice-api-tasks","version":"0.2.0","keywords":[],"author":{"name":"B-Jones-RFD"},"license":"MIT","_id":"@b-jones-rfd/nice-api-tasks@0.2.0","maintainers":[{"name":"b-jones-rfd","email":"b.jones.rfd.82@gmail.com"}],"dist":{"shasum":"c218d52e5855d439c258c7c1c03f1dc3e569604e","tarball":"https://registry.npmjs.org/@b-jones-rfd/nice-api-tasks/-/nice-api-tasks-0.2.0.tgz","fileCount":10,"integrity":"sha512-5IivZkAIfaHp2oEdeGY2bMiX/rRORyLt+wbkNxvQScW3JI1iMI0SBxxbha/My8o7B5e3zRubFE88EYkFFJOevQ==","signatures":[{"sig":"MEUCIQD/rlBuzh5nXL9M44mFjXkvWavYYhTOLl9mFZDroyPeZQIgGYNR6lYmOWms0sgw4rI/76d8oxsV2gp6yCY7cyUnQbM=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":27046},"main":"./dist/index.js","_from":"file:b-jones-rfd-nice-api-tasks-0.2.0.tgz","types":"./dist/index.d.ts","module":"./dist/index.mjs","engines":{"node":">=18"},"private":false,"scripts":{"ci":"pnpm run lint && pnpm run test && pnpm run build","dev":"vitest","lint":"tsc","test":"vitest run","build":"tsup src/index.ts --format cjs,esm --dts","release":"pnpm run lint && pnpm run test && pnpm run build && changeset publish"},"_npmUser":{"name":"b-jones-rfd","actor":{"name":"b-jones-rfd","type":"user","email":"b.jones.rfd.82@gmail.com"},"email":"b.jones.rfd.82@gmail.com"},"_resolved":"/tmp/c7beac47f140bff58f9f91f344ad1654/b-jones-rfd-nice-api-tasks-0.2.0.tgz","_integrity":"sha512-5IivZkAIfaHp2oEdeGY2bMiX/rRORyLt+wbkNxvQScW3JI1iMI0SBxxbha/My8o7B5e3zRubFE88EYkFFJOevQ==","_npmVersion":"10.9.2","description":"Perform common tasks using the Nice InContact API","directories":{},"_nodeVersion":"23.11.1","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.0","vitest":"^3.2.4","prettier":"^3.5.3","typescript":"^5.8.3","@types/node":"^24.0.3","@changesets/cli":"^2.29.4"},"_npmOperationalInternal":{"tmp":"tmp/nice-api-tasks_0.2.0_1751803090039_0.6333395358043545","host":"s3://npm-registry-packages-npm-production"}},"0.2.5":{"name":"@b-jones-rfd/nice-api-tasks","version":"0.2.5","description":"Perform common tasks using the Nice InContact API","private":false,"main":"./dist/index.js","module":"./dist/index.mjs","types":"./dist/index.d.ts","keywords":[],"author":{"name":"B-Jones-RFD"},"license":"MIT","engines":{"node":">=18"},"publishConfig":{"access":"public"},"repository":{"type":"git","url":"git+https://github.com/B-Jones-RFD/nice-api-tasks.git"},"devDependencies":{"@changesets/cli":"^2.29.4","@types/node":"^24.0.3","prettier":"^3.5.3","tsup":"^8.5.0","typescript":"^5.8.3","vitest":"^3.2.4"},"scripts":{"dev":"vitest","test":"vitest run","build":"tsup src/index.ts --format cjs,esm --dts","lint":"tsc","ci":"pnpm run lint && pnpm run test && pnpm run build","release":"pnpm run build && pnpm publish -r --no-git-checks"},"_id":"@b-jones-rfd/nice-api-tasks@0.2.5","bugs":{"url":"https://github.com/B-Jones-RFD/nice-api-tasks/issues"},"homepage":"https://github.com/B-Jones-RFD/nice-api-tasks#readme","_integrity":"sha512-1ITties/6pE2Uota7+ZeeobVMYpeujOrVOMWO0p2dnlWZoB8Ldwmc/pW9lbWHLlcPIbxDXoRuTYbNiEiDXhwkw==","_resolved":"/tmp/cfc9013edbe776f832073dab88b914e3/b-jones-rfd-nice-api-tasks-0.2.5.tgz","_from":"file:b-jones-rfd-nice-api-tasks-0.2.5.tgz","_nodeVersion":"24.18.0","_npmVersion":"12.0.1","dist":{"integrity":"sha512-1ITties/6pE2Uota7+ZeeobVMYpeujOrVOMWO0p2dnlWZoB8Ldwmc/pW9lbWHLlcPIbxDXoRuTYbNiEiDXhwkw==","shasum":"7727d6048bff8b74664b010b01b87f427951f582","tarball":"https://registry.npmjs.org/@b-jones-rfd/nice-api-tasks/-/nice-api-tasks-0.2.5.tgz","fileCount":11,"unpackedSize":27569,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@b-jones-rfd%2fnice-api-tasks@0.2.5","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCu2gDRgnxduXlHAAvyez8MwqLaFJqq8j59UzC6TSeXwgIgKISlzrhCfqVzoZkaI5nLjjnoaf14d71+quA1u6S7Qtk="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:162d317d-6d51-4592-8d3a-e0c2fad05652"}},"directories":{},"maintainers":[{"name":"b-jones-rfd","email":"b.jones.rfd.82@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/nice-api-tasks_0.2.5_1783989083598_0.7698913400549103"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-18T22:15:06.671Z","modified":"2026-07-14T00:31:24.110Z","0.0.4":"2025-06-18T22:15:06.982Z","0.1.0":"2025-07-05T13:19:37.391Z","0.1.1":"2025-07-05T14:26:53.329Z","0.1.2":"2025-07-05T15:36:08.646Z","0.1.3":"2025-07-05T16:09:21.454Z","0.2.0":"2025-07-06T11:58:10.220Z","0.2.5":"2026-07-14T00:31:23.782Z"},"author":{"name":"B-Jones-RFD"},"license":"MIT","keywords":[],"description":"Perform common tasks using the Nice InContact API","maintainers":[{"name":"b-jones-rfd","email":"b.jones.rfd.82@gmail.com"}],"readme":"![GitHub Actions CI](https://github.com/B-Jones-RFD/nice-api-tasks/actions/workflows/main.yml/badge.svg)\n[![npm version](https://img.shields.io/npm/v/@b-jones-rfd/nice-api-tasks.svg?style=flat-square)](https://www.npmjs.com/package/@b-jones-rfd/nice-api-tasks)\n[![npm bundle size](https://img.shields.io/bundlephobia/min/%40b-jones-rfd%2Fnice-api-tasks)](https://bundlephobia.com/package/@b-jones-rfd/nice-api-tasks)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n\n# Nice API Tasks\n\nHelpers to perform common tasks using the [Nice InContact API](https://developer.niceincontact.com/API). This is an exercise to avoid code reuse in my own projects. Use at your own risk.\n\n## Prerequisites\n\nThis project requires NodeJS (version >= 18) and NPM.\n[Node](http://nodejs.org/) and [NPM](https://npmjs.org/) are really easy to install.\nTo make sure you have them available on your machine,\ntry running the following command.\n\n```sh\n$ npm -v && node -v\n10.2.4\nv20.11.1\n```\n\n[PNPM](https://pnpm.io/) is a awesome alternative to NPM and is recommended.\n\n## Table of contents\n\n- [nice API Tasks](#nice-api-tasks)\n  - [Prerequisites](#prerequisites)\n  - [Table of contents](#table-of-contents)\n  - [Getting Started](#getting-started)\n  - [Installation](#installation)\n  - [Usage](#usage)\n  - [API](#api)\n    - [Authentication](#authentication)\n    - [Extracts](#extracts)\n  - [Contributing](#contributing)\n  - [Versioning](#versioning)\n  - [Authors](#authors)\n  - [License](#license)\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.\n\n## Installation\n\n**BEFORE YOU INSTALL:** please read the [prerequisites](#prerequisites)\n\nTo install and set up the library, run:\n\n```sh\n$ npm i @b-jones-rfd/nice-api-tasks\n```\n\nOr if you prefer using Yarn:\n\n```sh\n$ yarn add @b-jones-rfd/nice-api-tasks\n```\n\nOr for PNPM:\n\n```sh\n$ pnpm add @b-jones-rfd/nice-api-tasks\n```\n\n## Usage\n\nTBD\n\n## API\n\n### Authentication\n\n#### getToken(options)\n\nImplements [OAuth Authentication (Post Authentication)](https://developer.niceincontact.com/API/AuthenticationAPI#/Token/getToken) and returns the access token as the result data.\n\n`options`\n\n| Property     | Type   | Description          | Required |\n| ------------ | ------ | -------------------- | -------- |\n| clientId     | string | Nice Client ID       | Y        |\n| clientSecret | string | Nice Client Password | Y        |\n| username     | string | Nice Access Key      | Y        |\n| password     | string | Nice Access Secret   | Y        |\n\n### Extracts\n\n#### getExtractData(options)\n\nImplements [Data Extraction](https://developer.niceincontact.com/API/DataExtractionAPI) and returns the extract text. For available extracts review [Data Extraction APIs](https://help.nice-incontact.com/content/recording/dataextractionapi.htm) online help. This is a multistep process running the following actions:\n\n1. [Start data extract](#startDataExtractoptions)\n2. Polls [Get data extract status](#getExtractStatusoptions) until error or complete\n3. Returns the file text as string\n\n`options`\n\n| Property    | Type   | Description         | Format     | Required |\n| ----------- | ------ | ------------------- | ---------- | -------- |\n| entityName  | string | Extract entity name |            | Y        |\n| version     | string | Extract version     |            | Y        |\n| startDate   | string | Extract start date  | YYYY-MM-DD | Y        |\n| endDate     | string | Extract end date    | YYYY-MM-DD | Y        |\n| accessToken | string | Bearer token        |            | Y        |\n\n#### getExtractStatus(options)\n\nImplements [Data Extraction (Get a specific job status)](https://developer.niceincontact.com/API/DataExtractionAPI#/ExtractingData/getJobStatus) and returns the status of the job. For available extracts review [Data Extraction APIs](https://help.nice-incontact.com/content/recording/dataextractionapi.htm) online help.\n\n`options`\n\n| Property    | Type   | Description  | Required |\n| ----------- | ------ | ------------ | -------- |\n| jobId       | string | Job ID       | Y        |\n| accessToken | string | Bearer token | Y        |\n\n#### runExtracts(options)\n\nImplements [Data Extraction](https://developer.niceincontact.com/API/DataExtractionAPI) and returns the status of the completed job. For available extracts review [Data Extraction APIs](https://help.nice-incontact.com/content/recording/dataextractionapi.htm) online help. This is a multistep process running the following actions:\n\n1. [Start data extract](#startDataExtractoptions)\n2. Polls [Get data extract status](#getExtractStatusoptions) until error or complete\n\n`options`\n\n| Property    | Type   | Description         | Format     | Required |\n| ----------- | ------ | ------------------- | ---------- | -------- |\n| entityName  | string | Extract entity name |            | Y        |\n| version     | string | Extract version     |            | Y        |\n| startDate   | string | Extract start date  | YYYY-MM-DD | Y        |\n| endDate     | string | Extract end date    | YYYY-MM-DD | Y        |\n| accessToken | string | Bearer token        |            | Y        |\n\n#### startExtract(options)\n\nImplements [Data Extraction (Prepares data for extraction)](https://developer.niceincontact.com/API/DataExtractionAPI#/ExtractingData/extractData) and returns the job id as the result data. For available extracts review [Data Extraction APIs](https://help.nice-incontact.com/content/recording/dataextractionapi.htm) online help.\n\n`options`\n\n| Property    | Type   | Description         | Format     | Required |\n| ----------- | ------ | ------------------- | ---------- | -------- |\n| entityName  | string | Extract entity name |            | Y        |\n| version     | string | Extract version     |            | Y        |\n| startDate   | string | Extract start date  | YYYY-MM-DD | Y        |\n| endDate     | string | Extract end date    | YYYY-MM-DD | Y        |\n| accessToken | string | Bearer token        |            | Y        |\n\n## Contributing\n\nThis is a pet project to save me time at work. It is still under development and you should use at your own risk.\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/B-Jones-RFD/nice-api-tasks/tags).\n\n## Authors\n\n- **B Jones RFD** - _Package Noob_ - [B-Jones-RFD](https://github.com/B-Jones-RFD)\n\n## License\n\n[MIT License](https://github.com/B-Jones-RFD/nice-api-tasks/blob/main/LICENSE)\n","readmeFilename":"README.md","homepage":"https://github.com/B-Jones-RFD/nice-api-tasks#readme","repository":{"type":"git","url":"git+https://github.com/B-Jones-RFD/nice-api-tasks.git"},"bugs":{"url":"https://github.com/B-Jones-RFD/nice-api-tasks/issues"}}