{"_id":"@truework/sdk","_rev":"43-8ab918df78974f473e07f855d1b1fa06","name":"@truework/sdk","dist-tags":{"next":"0.3.6","latest":"1.5.0"},"versions":{"0.1.0":{"name":"@truework/sdk","version":"0.1.0","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.1.0","maintainers":[{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"}],"homepage":"https://github.com/truework/truework-sdk-js#readme","bugs":{"url":"https://github.com/truework/truework-sdk-js/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"86cae24579922fde4602755ae53f4280f6fbcfd6","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.1.0.tgz","fileCount":25,"integrity":"sha512-J0XKHX0n9rxW8ZwyDlRfxRah1rYcW8Ilut4Qd5D1HbZae8C5CSBEqaqXUrzR7YjYPjYkTkiKSSoHA4ZRCEkLaQ==","signatures":[{"sig":"MEUCIQCJn2TKfL+G8L0hLsgKlwqLViK+9wOyZEB9tWepQ/FlbwIgPcrfo+zouPrO7H+K9+N6nHhTfqKVMwVZaFk4fZ8u1rQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":92136,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfH2ITCRA9TVsSAnZWagAAJI0P/3nLMorK4dsu9f82jqeJ\nnrNTk71COsTeLsWeEdLAG3P/JGlex73BFH7wPdgagWPQctovfQphkXwamGPc\n9E0JaX8rTmy3nNXAJBRd+bHgLFP8lOPUZepI1dh/1Ti1Z+azdi7Xz5L+Is7x\nIIVhTxarc/pis1lTpV1VBYXlVnXve0URB27d+tOzFhV61q8pZslzpEDV88Pz\nuQjrhc3QuNkbYJZ0El5U8p+xqcJNRA1nS8KOvC+7hZpojuGQGGIXmTeyb79g\ne774haJCamSN0Hto4erhDPyRwUzd+/O7hKtXG3Gs4xPqhM34TSMYHm/jjKon\nVP4QyhJpa4C67BrJPxRKsGvGK5n74HoZnP04+VQfXurZsvof48etFkZn+DMR\nZWl6tfN/Dmo3L6iWHocFUsIlhKi2MbSvDe+YLCRLpArevjhm0kqPzRZkA3iI\n/qj9ljUEIKaMR5/VOY5vTm7cjzWv3avgdkvJzVF5hyi/AKHMCC6NZ1Ie5x+J\nXVSQwD53cgtTwBTH/6Wk2KMKE16C4qTsDRFDCH4E0hzFliKAxn64gdM8vOwH\nh58BZ8vnSC7mcErKQ0PW+KNnaLnJbDOqNjuNhXtKidnPH05/PloDlDgvFwfS\nEhjhUK3DyWk3n/Xq6IGQt6TCR2r7vf6khJV3mISyzGshk4dFGPtpmKL10noY\nsa4l\r\n=bJLk\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged"}},"source":"./lib/index.ts","gitHead":"197fe390b85d875144d8f1a9f5b32415d90eaa6e","scripts":{"lint":"prettier-standard ./lib/*.ts --format","test":"ava ./lib/__test__/*.test.ts --verbose","build":"microbundle build","watch":"microbundle watch","publish":"np","postbuild":"npm run test","prepublish":"npm run build"},"_npmUser":{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-js.git","type":"git"},"_npmVersion":"6.7.0","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"11.15.0","dependencies":{"got":"^11.5.1","nanoassert":"^2.0.0","query-string":"^6.13.1"},"_hasShrinkwrap":false,"devDependencies":{"np":"^6.3.2","ava":"^3.10.1","nock":"^13.0.3","husky":"^4.2.5","sinon":"^9.0.2","dotenv":"^8.2.0","ts-node":"^8.10.2","@types/node":"^14.0.23","microbundle":"^0.12.3","@types/sinon":"^9.0.4","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.0_1595892242778_0.6095671501089919","host":"s3://npm-registry-packages"}},"0.1.1":{"name":"@truework/sdk","version":"0.1.1","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.1.1","maintainers":[{"name":"angelachang","email":"angela@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"}],"homepage":"https://github.com/truework/truework-sdk-js#readme","bugs":{"url":"https://github.com/truework/truework-sdk-js/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"b88bb37ca05062d12cf3f0b0874d2bf9f97e7a91","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.1.1.tgz","fileCount":26,"integrity":"sha512-Rh93vLTjgDTPLX8g9vjxhPVUm0e3JllhNB1o0toRim76KQ+reflydEskytnihOOGDXIWc88GSOL2DR3Fd7ww1A==","signatures":[{"sig":"MEYCIQDNF1UcmrfU0X3ocPcqkeLJlwTk/oGUnaS6KDz7Ht11wQIhAJLGV3Sxu7LnChNarnXKw56nOatZYLuR8i+YHediB4FS","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":95444,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfIEAsCRA9TVsSAnZWagAAiiwP/if8pYGvhLiafPo/b+Qm\nSCz5MBIN//DBKfyvyD/mhPzBKLNIuW3rB24yZ8lvBVhh9oC1c4/mVkWrNYb/\nvwj0YPz0XimVRsYfGBtZbleLcRRkFNto6TnnlKbeYKhYj4E8cX2sgGCDpTcP\nYPfOvQZEhdKdkwf+06Co0S/sSUnsD56zKpbyAuhLcjaW2bcIVoMuWLxJ3ery\nzBluAqONtXUzcySGTf0Y+8IsEdhS7JBnT0wFsG+KkoskObsL44cMJa63k+7G\nj7NfBv4aUbWreVLR9zuIxKol+WFBD6WLfx59Wh47HhBofpaqoMolgJNKg0TF\n+ZRSU4qEoKhsHoWC2+AQ98HPf12QgiLBT4UKsN5enbgBxMJISQ/5tn2QoB10\nwdDLkNE1/0HRMR2c66e494N5uX7e7xe5A0+ltXTxr0gdNC4qWft46akuVJJM\nPvAjBya2FUORzo3QB38I2AyOaMHpc6zvXU34Y0iRW4/MljmHz905/wrzIMTH\nU6K5jUyJuskS+lUdiqybEfZlXw/d+7mqQBBI0L+DG12yaKa8fMZFd3GVmtr8\nYlgcfRlxfaAMDM5vFedkGWN/pruFJln0c9fnDBmy59sjMugZx22csLg2U/Hm\nHZwLuNhPm6qNRSkMSV+FOttQRfOUWJUnsF3IdZYY1WYBh7f6wMswPgszrz7R\n7Mc9\r\n=n1Sw\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged"}},"source":"./lib/index.ts","gitHead":"c17ebf9c47f2193ca6e345eeb26125dad8c8acd0","scripts":{"lint":"prettier-standard ./lib/*.ts --format","test":"ava ./lib/__test__/*.test.ts --verbose","build":"microbundle build","watch":"microbundle watch","release":"np","postbuild":"npm run test","prerelease":"npm run build"},"_npmUser":{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-js.git","type":"git"},"_npmVersion":"6.14.5","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.18.1","dependencies":{"got":"^11.5.1","nanoassert":"^2.0.0","query-string":"^6.13.1"},"_hasShrinkwrap":false,"devDependencies":{"np":"^6.3.2","ava":"^3.10.1","nock":"^13.0.3","husky":"^4.2.5","sinon":"^9.0.2","dotenv":"^8.2.0","ts-node":"^8.10.2","@types/node":"^14.0.23","microbundle":"^0.12.3","@types/sinon":"^9.0.4","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.1_1595949100217_0.697165974631117","host":"s3://npm-registry-packages"}},"0.1.2":{"name":"@truework/sdk","version":"0.1.2","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.1.2","maintainers":[{"name":"angelachang","email":"angela@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"}],"homepage":"https://github.com/truework/truework-sdk-js#readme","bugs":{"url":"https://github.com/truework/truework-sdk-js/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"3b585586932c0a5e842713a26709e719bcd6025d","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.1.2.tgz","fileCount":26,"integrity":"sha512-k0Z7upFtas1K/K4pJVTJ0jgh1B/oANSYM8esJkCr5Le5ZQGAhH9ynvhc6jzoEBygV8kpeXoo8duf2vXJNQBfDQ==","signatures":[{"sig":"MEYCIQDoUNAuFNjGaJFUdBjogyqbBcm2JSdnuI3K1R46BK+xeAIhAJLVh2uLCEyi9v5grfPsGw2uH2R1oDltor94M3wKOU23","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":94867,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfIJLYCRA9TVsSAnZWagAASpcP/1CiB94byIsaH29er5wE\nCToq26eYaWzQMcl6spzbJBNEeR+3Mr9iNpY7cBNV9OONr8JgxePmFgM7OtMv\nHFS3CkvEagFpGIKy8tUO6lUbedGjrHO+Qi4HReJctPshjXom6+Ev/hL2wHtk\nTH5j7td6RiczfkPeKVPv1TchFc6u7czknXht4jPKF//ECfOJ2kvHm2JMBY2T\nJxkeoVnshTTw+9rJUmNSuQMXW5Kf5cKexqCL9FR19TSToWdOFOFynV9kEinW\n3vgUspU3KJD7JxdGEpFMHxMEUYpLjzwn6ZxrSM6W9GVAT/T36ZTBq+jFXGm1\nkx5+msvDz93eHV24GQ5B4ZvoA1LTl/OJNs7j5jfek/WMoRvxn/os4pTxmZvf\nLsmGJdgRC9M00Yy1DXJPY3G9i6ImvTNUFDSF6BMm0BxSm/GBe19bjYqXDu4J\nFM4cr0TywpPNOm/c0A/bMtJ+qfubb3rord59vDm5X/FGMzhPLbOB1L4uLFwN\nmole8cj+XbGJQLLS7dFkcsUApGY+3njeLqYLMFEC8uaEE4/7k72a3/M89//t\nSdvWsygMD8kvmEUgF4lBgPNpOKMOC1bxePZuKUT8IEOWubfzgIlValmtZy/R\nbfJd8MAH/2MmKaTXhgrIecjday9xbvC8XYLcrAqv9N5jKiv5VP8vbMwYBrYq\nJX86\r\n=zQ6Z\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged"}},"source":"./lib/index.ts","gitHead":"70495c35be6204321c0a72e745871b59aaac0772","scripts":{"lint":"prettier-standard ./lib/*.ts --format","test":"ava ./lib/__test__/*.test.ts --verbose","build":"microbundle build","watch":"microbundle watch","release":"np","postbuild":"npm run test","prerelease":"npm run build"},"_npmUser":{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-js.git","type":"git"},"_npmVersion":"6.14.5","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.18.1","dependencies":{"got":"^11.5.1","nanoassert":"^2.0.0","query-string":"^6.13.1"},"_hasShrinkwrap":false,"devDependencies":{"np":"^6.3.2","ava":"^3.10.1","nock":"^13.0.3","husky":"^4.2.5","sinon":"^9.0.2","dotenv":"^8.2.0","ts-node":"^8.10.2","@types/node":"^14.0.23","microbundle":"^0.12.3","@types/sinon":"^9.0.4","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.2_1595970263360_0.2968629399007756","host":"s3://npm-registry-packages"}},"0.1.3":{"name":"@truework/sdk","version":"0.1.3","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.1.3","maintainers":[{"name":"angelachang","email":"angela@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"c97e3a612b0eb401e53327d751afff67722298b0","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.1.3.tgz","fileCount":14,"integrity":"sha512-ks6rssfJZjJyv1mvn1QlNeXKEAvlhbB+E1QnZz0em43kOgARv5x7OEkcv10qXB7Sx7dFhIylGg0VH+VD6/1txQ==","signatures":[{"sig":"MEYCIQDzM4gFBkyhs4nG9IjSr/9Tu1MRUuV34Af4eL/TxOWzBQIhAJ9boG867JLCvMkFyxbf9gvgbeh1ePTExqNMVPYZR+xi","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":63215,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfKta4CRA9TVsSAnZWagAAZY8P+gOAA8cXp+0TV1nvCLjm\nv0ZxWfuv3laDnqQqk411OPDjW0xrmZQkKk7wUFb993cfbpmGF6c27VStfeE5\nFu+20UX9dDvHrvr48/V3recPwUCxtCKZ8fVVxXkLFSyilhE4MsCCfwAm+/fO\nAb6jp+v9SmDqWO8lkrJRp6uNUbwQpVVd4nyMoiFssAXKeNNk23J39293pQ6C\nF/+WUNX+OHfswGvWpXHbDMRGq7lviKyM/p4sxa8Ni4yE5nCbTCAgr/xO8y35\nn0tj/thlzi4INKyeBvVXOb3ci2HEfT7LGyG6nl7Q1ZpkvDhvGtIc4GCoFHyD\n9tcKPUuvoK4ySXWBi6OGOLa53PFtyreMexn1i6SDTNUdPtS95YqIHFiH+YAZ\nx/T2arOq4uf3FxaFdlRzMB2TRhYndSe1mewt7e5Hu4ZKbH/xuqvnvpJJucm3\nRoIbF/7RdC2uiP0g5BEg8JhnCOPSnrT4Cg2RjiK3zAcDEpyq8O9+1Vg8BjZF\nxSWyz5mE4Fwa0952rDCwVy+T9PQxE2TvgeOSiIQuxMgcvwIf8lSmuh2FAxLA\nSSf7itX8kG5Sc0rZMY7hscZFsrRfzk65AEsVphOZUNRp+JWopKLvaEhELIfN\n0opiad5MXZAsKHUJ5xcPM/yn3rzkXTuPgSwQUtx0JH+xaQdoJmht5+4Ji1KH\nUyEs\r\n=TWr8\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"module":"dist/index.m.js","source":"./lib/index.ts","gitHead":"f7f5456c79343770cd547dc7e2740810ae45404a","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"microbundle build -f modern,es,cjs","watch":"microbundle watch -f modern,es,cjs","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"esmodule":"dist/index.modern.js","deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.7","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.18.3","dependencies":{"got":"^11.5.1","nanoassert":"^2.0.0","query-string":"^6.13.1"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","nock":"^13.0.3","husky":"^4.2.5","sinon":"^9.0.2","dotenv":"^8.2.0","ts-node":"^8.10.2","commitizen":"^4.1.2","@types/node":"^14.0.23","microbundle":"^0.12.3","@types/sinon":"^9.0.4","semantic-release":"^17.1.1","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.3_1596642999937_0.7995516020288924","host":"s3://npm-registry-packages"}},"0.1.4":{"name":"@truework/sdk","version":"0.1.4","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.1.4","maintainers":[{"name":"angelachang","email":"angela@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"5754b8e78e6906c7e7bcb29c5d173bac32485d6f","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.1.4.tgz","fileCount":16,"integrity":"sha512-4FzSzEQpzqeOg04MeerUDaF8WVP3E20FtdwdSLacZdanrUo2LWSaD9jzSqFLvyzGP6Yi8GBXEmAGGI/Ht0aw6A==","signatures":[{"sig":"MEQCIGRb3LZDmUKa3miDI0bEwPRxgCZAke5q5GrGFCvYYvqhAiAZIDt1q17yTPDYdldbKQsAaMIuNR2P/7pleCxq6yKUTw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":63352,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfKu2hCRA9TVsSAnZWagAA1BsP/0vW6FMrG/npAgItt2UL\niqCztLXy6BkmtzwI1G6eM4BrafaOZesAQSzglk2cB7DcNR+O8lu23dYRWe9l\nv7z2V6mQKhXSPYECMXlIaFNb1XqUGRJnWi2qh4b4FzJdH4vqbs6emY5FwYhg\nL8/yLNnBMyQzhwYxrbjC/zAExKlfLR8bIlxydmWD8lGlG9MEdUG1f8efSIY3\nQofTf52I+cQ96U1D6DEp+Da9bJxKlNe5xSL8zvMHrDeLikr10fw7pyriJPOo\nzoaAfFlWcNlvAmDeFu9XkaDR9RI4uezBMVVhou6rWJXASZ8g0MsPocF6C5Oo\nWiVocPRCCqCazPbTP/ZksFmKN+i/GkK/kSVboTkJbhyswKJKh+vBO11mydC3\nrBCeUaR+1ZL3UPVwrZU+7BFdeN6iUJeHhodMWjNc++8p7MGD8GhO9WGMv9VA\ndV6sIwhQkT6MfoxMScUr1GRSy3TUWm2DaNzhXqjxtNEj7XQ0+kUOYPufP1hu\n9BglcPNd9pU6iKS9SRjg4bswBDwLyKGNF1nnK+JH/fB1KU6E8q6wai6B0I50\nb6YtdqKrqdN9vIsz/xxtgs0Lcr6y43N7ymGknZFiXfdiPBYLIRK55l5DaFPE\nDawgZZs1+IAYiF00zGz6ERFG7CZ3+3q2kje1HV0k/fL8iUA6QNPQGxQggeAY\nL493\r\n=Hdth\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"module":"dist/index.m.js","source":"./lib/index.ts","gitHead":"ec3459a7e569abebd2dc89643bdb47ba01265ade","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"microbundle build -f modern,es,cjs","watch":"microbundle watch -f modern,es,cjs","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"esmodule":"dist/index.modern.js","deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.7","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.18.3","dependencies":{"got":"^11.5.1","nanoassert":"^2.0.0","query-string":"^6.13.1"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","nock":"^13.0.3","husky":"^4.2.5","sinon":"^9.0.2","dotenv":"^8.2.0","ts-node":"^8.10.2","commitizen":"^4.1.2","@types/node":"^14.0.23","microbundle":"^0.12.0","@types/sinon":"^9.0.4","semantic-release":"^17.1.1","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.4_1596648864967_0.5609007317284378","host":"s3://npm-registry-packages"}},"0.1.5":{"name":"@truework/sdk","version":"0.1.5","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.1.5","maintainers":[{"name":"angelachang","email":"angela@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"2039e87822cc491cfa1244a592fd0831d01f4a10","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.1.5.tgz","fileCount":16,"integrity":"sha512-IOF2lodzpGsg694m+chU3pgyMMOtmfKdWKEVi9C8OVqazAYQte6ylt8TQPH0sRbKl81e4PBY6ixtG9+BpNcycA==","signatures":[{"sig":"MEQCIBia8NHDdFEwhV4uqdEntly7XSxetSp3k50bLNPqQZ4UAiBXZqBuS4RCm6bwGUx/uGq27lx2UnCKVld9KsWP1jXAkg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":63506,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfOsJwCRA9TVsSAnZWagAAiYIP/23IM/kw9LdYOPWB+HvC\nEaRt8Bo3fXdqCkCbEoRN5NMxTmu9jF3KyumKaJIDzKjnuNzyPtwxZi9DkeA4\nP7I+C3h99yIXiFLn5zlc1qGCCv/eFm7okBGxzkjjIavbXaQcXPge4L+oVV13\nghzPWsy28/I1jFVuzInA13H12xmBh0Rp9eQnPN8b7pBnoryaWs2UCQH65Ibb\nQrDrTULeA8K3YfeKHuuUCCz1GqcqdSS7/ALunnsTwOwuiITZAH0Ldvzv4oaD\nSVucva5CT+x0HsywhggpEiENrARugvCCHb4rY7V6USoUHDnR/5EQDEH1tcIn\n7ghjXUH2rWs5/GB1/iMzpCye+GhsWrpvEY+krnDyEP5X+Q+dnTnhKu9GUW8g\ntT5d171IaE2KgK8SZTF3P2LHU88z0FDJw0UUQhJwbvRVMN7p/Z1nDGZ9Tu94\nq21JRpZ0fHJ4WjlgLnuRTEwIzyhNF0NqUK90oNBQslmnhI9xBWU28OeUX5g0\nnS897+qdjq+aIUI5Lmt+x43ZVbmFz4XGUoQBkt96E+c/GIMIvvr5yIb/GCfL\nQi21UOY2Rc93Up4+4gZxVDrHGU+LbdkAoo7FVqm5oAzQlyHVQ4DfaL2fwrbY\nUtWVZIulro8oiVFSMO+KUj4x8aPQZVYTaEOBc6SLHrYcxipqIblRnGlAplsN\nHAel\r\n=LSCO\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"module":"dist/index.m.js","source":"./lib/index.ts","gitHead":"56cdbaf7b90c176ca96091cf868cbd9bf3f288fd","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"microbundle build -f modern,es,cjs","watch":"microbundle watch -f modern,es,cjs","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"esmodule":"dist/index.modern.js","deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.7","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.18.3","dependencies":{"got":"^11.5.1","nanoassert":"^2.0.0","query-string":"^6.13.1"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","nock":"^13.0.3","husky":"^4.2.5","sinon":"^9.0.2","dotenv":"^8.2.0","ts-node":"^8.10.2","commitizen":"^4.1.2","@types/node":"^14.0.23","microbundle":"^0.12.0","@types/sinon":"^9.0.4","semantic-release":"^17.1.1","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.5_1597686383779_0.34263954486949744","host":"s3://npm-registry-packages"}},"0.2.0":{"name":"@truework/sdk","version":"0.2.0","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.2.0","maintainers":[{"name":"angelachang","email":"angela@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"5d6a759e8437cd10ea4706fd79aaa823f2e40c96","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.2.0.tgz","fileCount":16,"integrity":"sha512-w4asVpaQPkGjJlE0n2CMsKrC7GsWuY2iONNU2KBCV/uTkhIXPZoT52uUwakWmdu6GmR6X/6tnwYBBW9qDsvO2Q==","signatures":[{"sig":"MEYCIQCu+P2Xa2V2KiOhfXT7zAKVJVhAeqtD39i4v5QKlhr0ogIhAM67K4/AjvYGemaipR8gl8EQmroRirT4F1GUWGG3Dnbs","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":34635,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfPDnoCRA9TVsSAnZWagAAIKkP/3/evdVDciH5MKD2a7vr\nYJtm7nAZSIFjZOV9tGe/CM5BN3mmBRDe0APRseNGViNFHQzlMuYgXkyiRlW+\nuXb3cD54aYh+Ska0wFuhr5EIh5B9j4cILnUjs/i/Gy8RgEC6x8S+BUnZEKQL\n/iWdZ6pXwhr4g82x7WfWvRY1WxdM7/m+orAiLff/tGkKjmbDfgum4L9CcpDG\nM1lqfG5Mw4gVHCCjvaiAqN8aiNGV/4C33/09k2mGI0/milqk2ozXvlRElt/N\nvw6LOJ9LG4xUuQksDX3QP818p79kk38TKA2x6rW5TsirvePrbpX8IB4yyGIr\nc4jrqsQgxtRUvgyWUxI1SfuqoYfNII+vYWg+buSvuHC/LaZTe6SutkCs/ZHB\ngSllmH7Vn8og2f3Arfib6edLqOjYxRhz7vIUpfrDK0O6FAPHMi7FTP5ty/Gw\neK8UNpG72QRftGNM2JMhEnPpFLIm0voXL231UkuaOLHlponnnnWfx2egSBC+\nkrnmYbotRE8+vyLoyV6ORJG4VTEIDfzHFVNWyIXXvPcbTIEgXCW2rzCWZDrv\nEhdKLCfzzzZKrwu1gS8dd7NBRnWdbr4JOrPAugBW3PKVNRB+SZWh/wIqWrQF\nJF7tpOvep1eg4MGkk6x1YChewnWGzQhO+QEoPea1P6p4naGQyaQ2h6J8AzEC\nde3A\r\n=YQ2/\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"readme":"# @truework/sdk ![npm](https://img.shields.io/npm/v/@truework/sdk) [![install size](https://packagephobia.com/badge?p=@truework/sdk)](https://packagephobia.com/result?p=@truework/sdk)\n\nThe official Truework API Node.js SDK.\n\n## Quick Links\n\n- [Getting Started](#getting-started)\n- [Terminology](#terminology)\n- [Usage](#getting-started)\n - [Verifications](#verifications)\n - [Companies](#companies)\n- [Testing](#testing)\n - [Verifications](#verification-mocks)\n - [Companies](#company-mocks)\n- [Contributing](#contributing)\n\n## Resources\n\n- 📚 [API Documentation](https://www.truework.com/docs/api)\n- 🏠 [Truework](https://www.truework.com)\n- 👷‍♀️ [Careers](https://www.truework.com/careers)\n\n# Getting Started\n\n```bash\nnpm i @truework/sdk --save\n```\n\n```ts\nconst { truework } = require('@truework/sdk');\n\nconst client = truework({ token: TRUEWORK_ACCESS_TOKEN });\n```\n\nBy default, the SDK will use the latest version of our API. To request a\ndifferent version, pass it when configuring your client.\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n version: '2019-10-15',\n});\n```\n\n# Terminology\n\nPlease review the [API Documentation](https://www.truework.com/docs/api) for all\nterminology. If you're using Typescript, have a look at the\n[types](https://github.com/truework/truework-sdk-node/blob/master/lib/types.ts).\n\n# Usage\n\nAll requests are made using [got](https://github.com/sindresorhus/got), and so\nresponses implement a got\n[response](https://github.com/sindresorhus/got#response) object.\n\n```ts\nconst {\n body: { count, results },\n} = await client.verifications.get();\n```\n\n## Verifications\n\n### `verifications.get([params])`\n\n**Request**\n\n- `params` - `object` - optional\n - `state` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Verification`s.\n\n**Example**\n\n```ts\nawait client.verifications.get();\nawait client.verifications.get({ limit: 10 });\n```\n\n### `verifications.getOne(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n\n**Response**\n\nReturns a `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.getOne({ id: 'abc123' });\n```\n\n### `verifications.create(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `type` - `VerificationType` - required\n - `permissible_purpose` - `PermissiblePurpose` - required\n - `target` - `Target` - required\n - `documents` - `Document`\n - `additional_information` - `string`\n\n**Response**\n\nReturns the full `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.create({\n type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n});\n```\n\n### `verifications.cancel(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n - `cancellationReason` - `CancellationReason` - required\n - `cancellationDetails` - `string`\n\n**Response**\n\nReturns status code `200` on success.\n\n**Example**\n\n```ts\nawait client.verifications.cancel({\n id: 'abc123',\n cancellationReason: 'other',\n});\n```\n\n### `verifications.getReport(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required, the ID of the Verification\n\n**Response**\n\nReturns the full `Report` object associated with the Verification.\n\n**Example**\n\n```ts\nawait client.verifications.getReport({ id: 'abc123' });\n```\n\n## Companies\n\n### `companies.get(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `query` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Company`s.\n\n**Example**\n\n```ts\nawait client.companies.get({ query: 'USWNT' });\n```\n\n# Testing\n\nThis SDK provides a naive \"mock\" mode that can be used for basic testing during\nCI, etc. It is _stateless_, meaning no data is persisted between API calls. When\nenabled, each SDK method will either return stub objects, or simple reflections\nof the data submitted.\n\nTo enable mock mode, initialize your SDK client like this:\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n mock: true,\n});\n```\n\n## Verification Mocks\n\n### `verifications.get`\n\nReturns a stubbed array of verifications, respective of all query params.\n\n```ts\nconst res = await client.verifications.get({ state: 'processing', limit: 5 });\n\nres.body.results.length; // => 5\nres.body.results[0].state; // => processing\n```\n\n### `verifications.getOne`\n\nReturns a stubbed verification object with the same `id` as is passed to\n`getOne({ id })`.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger a `404` error\nresponse.\n\n```ts\ntry {\n await client.verifications.getOne({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.create`\n\nReturns a stubbed verification object.\n\n#### Error States\n\nTo trigger an error response, do not pass a `type` property.\n\n```ts\ntry {\n await client.verifications.create(\n // type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n })\n} catch (e) {\n console.log(e.response) // error response body\n}\n```\n\n### `verifications.cancel`\n\nReturns `200` if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.cancel({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.getReport`\n\nReturns a stubbed report object if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.getReport({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n## Company Mocks\n\n### `companies.get`\n\nReturns a stubbed array of companies, respective of `limit` and `offset` query\nparams.\n\n```ts\nconst res = await client.companies.get({ limit: 5 });\n\nres.body.results.length; // => 5\n```\n\n## Contributing\n\n### Issues\n\nIf you run into problems, or simply have a question, feel free to [open an\nissue](https://github.com/truework/truework-sdk-node/issues/new)!\n\n### Commiting\n\nThis repo uses [commitizen](https://github.com/commitizen/cz-cli) to nicely\nformat commit messages. Upon making edits, stage your changes and simply run\n`git commit` to enter the commitizen UI in your terminal.\n\n### Releases\n\nThis project is versioned and published automatically using\n[semantic-release](https://github.com/semantic-release/semantic-release). Via a\nGitHub Action, `semantic-release` will use the commit message pattern provided\nby `commitizen` to automatically version the package. It will then publish to\nnpm, as well as create a new\n[release](https://github.com/truework/truework-sdk-node/releases) here in the\nmain repo.\n\n## License\n\nMIT License © [Truework](https://truework.com)\n","gitHead":"d0ba32e3573aa62b442a8deebbe1b8353d7a4c79","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.7","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.18.3","dependencies":{"got":"^11.5.2","nanoassert":"^2.0.0","query-string":"^6.13.1"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","nock":"^13.0.4","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.1.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.1.1","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0","rollup-plugin-typescript2":"^0.27.2"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.2.0_1597782503515_0.15784561287116983","host":"s3://npm-registry-packages"}},"0.2.1":{"name":"@truework/sdk","version":"0.2.1","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.2.1","maintainers":[{"name":"truework-team","email":"victor@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"7f6c8efc222db2ab21af08e0f4b1279d7fd1c826","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.2.1.tgz","fileCount":16,"integrity":"sha512-8pUMMoQUVq/l48Nc6L0B5u0+oPd+ZR1pp8Pn+N4sOd6FsVQt04iS8yMIKESEPaVdMpCEvgAUAKBUiqG0Ct5ObA==","signatures":[{"sig":"MEYCIQDs1QflDwyjomCg2tvxMGTBPaVTkliTbIHVUSXh5ePu5wIhAKHZ1ZfvKZDQO26cOYaY4WPU04BYQrz+fBnrxNBqgGaV","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":34763,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfu/B7CRA9TVsSAnZWagAATJQQAKSg3savjvfQncvBZWZU\nKXl90eTcsJhp+JntGwDQXbubonbBJpupyij9jJJMC3oEYxXEM6t+1jDEcL+u\nzYnkYaj1nSgtrVwxqvmTCWfB8tiGmXogBH/1m77ObOpYBlHtJ6fpFn+yimz1\nQdAHk74VHqRgB2TP3yUVeqKXauKUK6bG1cUcpsujgM6KQL4SubFjeztIu5av\nE56iaqkb2AL6qWNtlyjowv8KLlvxXACDMIgDSNyk924aroQYTeyAN0ImUl54\nUHrVsYMAj+3TZqnlvbBIg9iUA01oGVnccjbi9Jv8QIrBQlnByGtFNMm9zGNu\n69Sn8Na3jPVv6DPcmXcoj7oWqEYCW+8qedMrV+7YNmVOyX/dxRxwuRHNKPfi\nusQEKHzTOEqqVUcVyc3ZoYhGamjg7m7ROWEXi+6unkV/gHkh/K5IDdGlqH0e\nemhNQiQhY4SiEoLv0RF2XL+jZkDZ1a4cK+z0o8qIIym9QSiiPIjdssnj1piJ\nN8HmntYmExeCA4TR9ne87gR7sLdh1lsmGjDMo1ZK5z03lTCfkTw1AA5rNr9O\nS1QMw0ZmPRlHXeGWQLchHJsO7K4IiXI2gr35IVMlrrYm4sO5zlVTPVzpMxRj\n+FohJqRkL0vyiEkRmP/DhQMxWx6hJLzcfIX9vf0Cn1Bfn5VCd+n3ZITgiqL/\nAObv\r\n=CY2o\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"readme":"# @truework/sdk ![npm](https://img.shields.io/npm/v/@truework/sdk) [![install size](https://packagephobia.com/badge?p=@truework/sdk)](https://packagephobia.com/result?p=@truework/sdk)\n\nThe official Truework API Node.js SDK.\n\n## Quick Links\n\n- [Getting Started](#getting-started)\n- [Terminology](#terminology)\n- [Usage](#getting-started)\n - [Verifications](#verifications)\n - [Companies](#companies)\n- [Testing](#testing)\n - [Verifications](#verification-mocks)\n - [Companies](#company-mocks)\n- [Contributing](#contributing)\n\n## Resources\n\n- 📚 [API Documentation](https://www.truework.com/docs/api)\n- 🏠 [Truework](https://www.truework.com)\n- 👷‍♀️ [Careers](https://www.truework.com/careers)\n\n# Getting Started\n\n```bash\nnpm i @truework/sdk --save\n```\n\n```ts\nconst { truework } = require('@truework/sdk');\n\nconst client = truework({ token: TRUEWORK_ACCESS_TOKEN });\n```\n\nBy default, the SDK will use the latest version of our API. To request a\ndifferent version, pass it when configuring your client.\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n version: '2019-10-15',\n});\n```\n\n# Terminology\n\nPlease review the [API Documentation](https://www.truework.com/docs/api) for all\nterminology. If you're using Typescript, have a look at the\n[types](https://github.com/truework/truework-sdk-node/blob/master/lib/types.ts).\n\n# Usage\n\nAll requests are made using [got](https://github.com/sindresorhus/got), and so\nresponses implement a got\n[response](https://github.com/sindresorhus/got#response) object.\n\n```ts\nconst {\n body: { count, results },\n} = await client.verifications.get();\n```\n\n## Verifications\n\n### `verifications.get([params])`\n\n**Request**\n\n- `params` - `object` - optional\n - `state` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Verification`s.\n\n**Example**\n\n```ts\nawait client.verifications.get();\nawait client.verifications.get({ limit: 10 });\n```\n\n### `verifications.getOne(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n\n**Response**\n\nReturns a `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.getOne({ id: 'abc123' });\n```\n\n### `verifications.create(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `type` - `VerificationType` - required\n - `permissible_purpose` - `PermissiblePurpose` - required\n - `target` - `Target` - required\n - `documents` - `Document`\n - `additional_information` - `string`\n\n**Response**\n\nReturns the full `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.create({\n type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n});\n```\n\n### `verifications.cancel(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n - `cancellationReason` - `CancellationReason` - required\n - `cancellationDetails` - `string`\n\n**Response**\n\nReturns status code `200` on success.\n\n**Example**\n\n```ts\nawait client.verifications.cancel({\n id: 'abc123',\n cancellationReason: 'other',\n});\n```\n\n### `verifications.getReport(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required, the ID of the Verification\n\n**Response**\n\nReturns the full `Report` object associated with the Verification.\n\n**Example**\n\n```ts\nawait client.verifications.getReport({ id: 'abc123' });\n```\n\n## Companies\n\n### `companies.get(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `query` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Company`s.\n\n**Example**\n\n```ts\nawait client.companies.get({ query: 'USWNT' });\n```\n\n# Testing\n\nThis SDK provides a naive \"mock\" mode that can be used for basic testing during\nCI, etc. It is _stateless_, meaning no data is persisted between API calls. When\nenabled, each SDK method will either return stub objects, or simple reflections\nof the data submitted.\n\nTo enable mock mode, initialize your SDK client like this:\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n mock: true,\n});\n```\n\n## Verification Mocks\n\n### `verifications.get`\n\nReturns a stubbed array of verifications, respective of all query params.\n\n```ts\nconst res = await client.verifications.get({ state: 'processing', limit: 5 });\n\nres.body.results.length; // => 5\nres.body.results[0].state; // => processing\n```\n\n### `verifications.getOne`\n\nReturns a stubbed verification object with the same `id` as is passed to\n`getOne({ id })`.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger a `404` error\nresponse.\n\n```ts\ntry {\n await client.verifications.getOne({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.create`\n\nReturns a stubbed verification object.\n\n#### Error States\n\nTo trigger an error response, do not pass a `type` property.\n\n```ts\ntry {\n await client.verifications.create(\n // type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n })\n} catch (e) {\n console.log(e.response) // error response body\n}\n```\n\n### `verifications.cancel`\n\nReturns `200` if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.cancel({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.getReport`\n\nReturns a stubbed report object if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.getReport({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n## Company Mocks\n\n### `companies.get`\n\nReturns a stubbed array of companies, respective of `limit` and `offset` query\nparams.\n\n```ts\nconst res = await client.companies.get({ limit: 5 });\n\nres.body.results.length; // => 5\n```\n\n## Contributing\n\n### Issues\n\nIf you run into problems, or simply have a question, feel free to [open an\nissue](https://github.com/truework/truework-sdk-node/issues/new)!\n\n### Commiting\n\nThis repo uses [commitizen](https://github.com/commitizen/cz-cli) to nicely\nformat commit messages. Upon making edits, stage your changes and simply run\n`git commit` to enter the commitizen UI in your terminal.\n\n### Releases\n\nThis project is versioned and published automatically using\n[semantic-release](https://github.com/semantic-release/semantic-release). Via a\nGitHub Action, `semantic-release` will use the commit message pattern provided\nby `commitizen` to automatically version the package. It will then publish to\nnpm, as well as create a new\n[release](https://github.com/truework/truework-sdk-node/releases) here in the\nmain repo.\n\n## License\n\nMIT License © [Truework](https://truework.com)\n","gitHead":"8239a9bbb22156501a22b4ef9a58b3c679bcf25a","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.7","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.19.0","dependencies":{"got":"^11.5.2","nanoassert":"^2.0.0","query-string":"^6.13.1"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","nock":"^13.0.4","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.1.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.1.1","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0","rollup-plugin-typescript2":"^0.27.2"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.2.1_1606152314430_0.16151138532240572","host":"s3://npm-registry-packages"}},"0.1.6":{"name":"@truework/sdk","version":"0.1.6","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.1.6","maintainers":[{"name":"truework-team","email":"victor@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"69ab519914e2e36983f96c994d8990dca1a29174","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.1.6.tgz","fileCount":16,"integrity":"sha512-6yBaCjlKOPLKu7i209rSx5vOiazw0dJkM2kOb5bqKzpxjfA4PIEZpi17fyzasufT9DFG4LjF9zkXC7+XxbanRQ==","signatures":[{"sig":"MEQCICyXJJtIZGG6hnjQwlmUrnLixtCHV+FXPDO23b5Zhj/SAiAakvYYySoDfa8kXT3TpQOPjf6iXe2gHI09ZU9dwvEwzA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":34763,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfvUiSCRA9TVsSAnZWagAAywcP/A2XLbAIR1jreIUNlYAt\n2Zt9HBgQDDmpQrMfdaMIPPGqbeLrbBIWAhS8PiTZSJgF5CbWdhUlOUxtRJzX\n9JXwx5yw/gjPAZrFuHXVUTEBNdcsjdoPoHzcBASUWRSamAd0XGzWJB24Pfpx\nqGdzNPrCsRzmQzEBQ7mrmR3mz3uwC0eO4g54qUqb7ku+cPj8y/YxVtwKS0uW\nVzfJqauha9WK4jVqoI+OUFjZ62b5oBzTDvANhp9FaaZ3ooiUxkE2/g7339KR\nzhDJqjLzs05LxlmzgwWBSLNI1CrC+6jzknxhK6nt0gcbB4xprlcZiHqYTt/F\nxq0OuYVwCAoSHOxXR/5Ow+NhzSE/bhPCHqRXEEwH5O8jko61Rzp6DppWYGQT\nRW9GP4gqKivtXn9VLIP5ZtXOl0ObhYdMuvu9qWb19I48IepPKAXOcDwA16DB\nIxUjtgygNSiwKwPH9nP8JT8tLLmEKE+4G40F8ZWd4o/s0qpj94NFQF90wrmI\n20Yn0cF6naCcFtCJw1qeN57yEDGJtkChkIlO4BTIwcrWR7otCYlseNGogwq7\n2J6LcqGJ247nHKOBpYIgUvwcgb5dM/nrQOpvXOopWH6JUfT3PCZeCtGks1SJ\n0zZhlB9iBhBm3eya2HCfw1DJIGy24PZiZf3kCSofxNYAvnaAI6KiZENnXeC6\ncjs9\r\n=lWwC\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"f91d5d53d99abcf9f7d6f880567627df0329f7aa","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.9","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.19.0","dependencies":{"got":"^11.5.2","nanoassert":"^2.0.0","query-string":"^6.13.1"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","nock":"^13.0.4","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.3.0","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0","rollup-plugin-typescript2":"^0.27.2"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.6_1606240402084_0.5735243566669672","host":"s3://npm-registry-packages"}},"0.1.7":{"name":"@truework/sdk","version":"0.1.7","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.1.7","maintainers":[{"name":"truework-team","email":"victor@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"a4559e00f37cd63130417e00e2ff2a7a99ab7cf5","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.1.7.tgz","fileCount":16,"integrity":"sha512-yx9VgDayB1TIC6Z4g43J1fTO4F4ZZpTrZGDeWZ6mcUcy4tlfpWBbxQVJmuZHhK1jBwOOgCGyvU3L8aItKyI5LQ==","signatures":[{"sig":"MEYCIQCMFa/50b/8CTnE5JxGGCnoemTyN6u5fA+3xIqMCr5CugIhANQF8YrJtqwLRb6cVQud8BhWNyurDJ93ncTN83N63MkP","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":34791,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfvYq8CRA9TVsSAnZWagAArsMP/RYRau5WthYVfEo4VExp\nR64AQ/YT90aTty4Q8XYCx/Lre6boJLslbpPbQHGqLEyHiHfIsLq5SrLlXzLz\nMynPm5g0k76YuEEG3E2c8Xey1a50ZJyJk5gJl1lvh0kxcaFyfIWF7G49kaCN\nhd+U7W5t+ZJvdKQccij0YIxxbM/3LY7C/NebPytAJay+dAKbFTjEeixwD3A0\ndga6yj+m1E1CY7amiczYhvg5Qo2B0U3m8WP/X5J3T54oo39mPzZ32Nksd3yZ\nL7GaT8pYp69FTnyufgqve5LZlMKPlzD+2zmht8wB3LPlAM/nQAZ+799ODFA/\nwvbwkV5m3faTsjoKs6yA9l/ckw792SWqlLFygOfnfUghVV2uwmNr8xx8ONXU\nK31upCXF/vIUZLIx4l2w2k6k2usO4l2zWBocntlqhaGr//HGkXE9JvGjdcef\n+XRwM6enfclv417pSfFjSx78CgO8vDFD1pJM8fM7OeqlfIr8J2k2M+pTDbxA\nGSWdMtixVv7QY5NmR/CXfdueWOlkUMUrMuoYQ/ghahrh3KKRe5B4vV1UdaYH\ncmzv/iINbusm1BzfjKIdKLRzvjUTrJLCG4yUUYkX71v24AFy+A0/8V7leB68\nqDTYdwNZYtxd3/2FqdU6Cf9mz/hDMxFbEFKmAufGVy+c5hfNjdZsKb9LcbCk\n/bja\r\n=fCyc\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"44c2b6305bc28505475690675c66693af59eed09","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.9","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.19.0","dependencies":{"got":"^11.5.2","nanoassert":"^2.0.0","query-string":"^6.13.1"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","nock":"^13.0.4","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.3.0","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0","rollup-plugin-typescript2":"^0.27.2"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.7_1606257339533_0.4795775461073626","host":"s3://npm-registry-packages"}},"0.1.8":{"name":"@truework/sdk","version":"0.1.8","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.1.8","maintainers":[{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"59254c241c47dc98827b3ef5720476c5a64148ec","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.1.8.tgz","fileCount":16,"integrity":"sha512-69wyyccZsIVaGl6V2WHDKHkdXHsVUZqagPJgEJyRZ5tLx1QSLruj0pXn0PMdLnu8aR/PobGF5AdmTCzL3SN5yA==","signatures":[{"sig":"MEUCIQC5ynn8LUXnEzZ8QJWCCsLBz6aMqaq6//6EVZqU9S5n8QIgUezXiKGE7cKu6JiGYjr5dZhwm6MtjLRfLTKgHvYbCpo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":34791,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgHHWUCRA9TVsSAnZWagAApkoP/29kl5xURozURNaM2wTL\nPqbs0bssHJw94EK7vMs3VL2j6yAYIo20wP83MmyboIB2Xz7sAQaqZ4Zd4Ei8\n+jDBGa+1tDUDtLV/rrkd7GFS+aGzekHovD6ztbwkIkkEqrr9E2b+AAzbtUtq\n0szxVh65XRb9ShNHss65o1bZUdov3PVgmi1uw5189ZtqL33CJyTVXQ/vGKeu\ntJjuAYXhMblYxcjU218XEctor1tFMxFvb9nzQw+kWfYdYpMWKBanvi/cXUnd\nWri7mYKUugy5Fminkiymmp1+OQ57OsfqNIXyrK3He7YGkw/SWQjU7M87cRfu\nq8b7Bzgnk2e2V8qB4klz4vN7USz0T4nuugz1RHLjvtfzcas++3u3zynFrwr8\ncgjdB26X3j/wjyUyEaW3sCctYZfm5I0Qm3ZC6DqgC2xXmJMGrlNnJaSvbO8T\nLfpoYKRPXCD0ziO4UGDbSJKNqJtUzSS3gY8uYdOoEtZnzHKBzOyiRe5YESsk\nr/Jpvf9r12X4IPeZT0lirb9YXf6TNC4Mhihr0M3Z754rHPpCVDez3lf6L0Id\nX0GegdEDITVMoo2M8Y9ORM5xfqZ2Xrp6ZsROdojP9uYOK4dS4Yk/3yUdNvKO\nLMQ2ClRFpAbYT5h5wFZdsBbmvVTHrY6lAsXwLKbbNulTZTgEwcDfHm4T04NA\n83KU\r\n=sWhc\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"03a525c1e0f3e7c12743152cd48fbbe2fa50175c","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.9","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.20.1","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.3.0","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.8_1612477844387_0.27585331362984467","host":"s3://npm-registry-packages"}},"0.3.0":{"name":"@truework/sdk","version":"0.3.0","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.3.0","maintainers":[{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"044cf2aae796650599c5ddae4b848e651e7605d1","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.3.0.tgz","fileCount":23,"integrity":"sha512-cWhZ3oSAK6qwvAkn9Tq7WFrIHAxqhwrm6sZwiuQPT9zecYkNBsnAKfiDgR18vJpR4gWHg/ugeg5MZiXoXVAXmA==","signatures":[{"sig":"MEYCIQCg6kHwYhuqmDOzUahaUh4vqTWEgW/nyOAWgN9BOOoEoQIhAIR3NKoKyNk5wTM5YIk6/BC/AAZ2gqHWOpyiVwr2l1Xd","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":81790,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgW2xICRA9TVsSAnZWagAAXYcQAIYHJi4prftO68+0Bgwq\nTeo5SUtvMU7RpZRhvOpeSBpWp+PIuFrCi2eVbSIFy+s/3oU5XEBmcNxpA5qB\neky2ji2LOvX1LbEXKO714ZUZHtFNCFDqzCmb0u7aj01wW6JqPavmGzMR4YAb\nXpGQuGhjjcp+foWTQ91184a11t2LTHRzafMo09MqhVqUjtGyHD4H8wOoGZ89\nsc7YTvTBEQKyT4GaRJ1gnrzJQyr6htIQA2ruQGhPd7DsBcBujin+6ra77pgk\nZkjHInqcRuSYNu1LbRpPf9XdomjB33MWSRYYfeShXdHhhkXp7WqgsJW6kF4S\ntelBoS820ni2RdhQ/dEtQJrDnAvS4SUZgFxD1Qjz/BpGmNo4354qWGN0JdIb\nykRaTAIvOR94N4Vp8IISDHLWLX3TCm/grHxzOH3zfM0hz0Oy9ei64BqakqKS\nejegxMC0clU1fWkr+0Pie4FX65qG2TXdLrgOBuhjgjEituMBtsY4hsY450Dg\nsKXSCCMaLYKLEmNIO++DmHvKX1TyBIT4PPHGMs1xHqc1C6JXG8UrW85Xrivy\nOo59i3nUQb+dsqzPtzPqyGqP6YEEb7MZv8e7H8YBaPuW5KIC/S9b7fD9VCP2\nEl7kE4bzigNvAbZkMYI0QemkxqYzpI//9Grk5OZew3KvTwsj/Mj0Za1IzNty\nGmLG\r\n=SyY/\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"e88cd47fa26a9cec302a8aced4a0deb2a7acc11d","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.6","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.18.3","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.3.0","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.3.0_1616604231780_0.6863577035918198","host":"s3://npm-registry-packages"}},"0.3.1":{"name":"@truework/sdk","version":"0.3.1","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.3.1","maintainers":[{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"53777de6b55f3f4e9fcdad32e74d905ea3c1df97","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.3.1.tgz","fileCount":16,"integrity":"sha512-W7DUKN/P+Bf9+OHVIThdX6D5XqWK2JzlN7l3URIfqeMBUyqyHF9aPlR/8EIugN/qvmelO0iIBxZ3f0RuoJLCig==","signatures":[{"sig":"MEQCIGyQOfCUDTYYYiSnI13qSK65BRY+2b61ZmIOFoipLNKsAiAM0T+uk1Q+Vc+P4+/oNW8SwylXdUaP3Y+KKkimSMplSw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":35984,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgW20KCRA9TVsSAnZWagAANyEP/25wncKotR1eL5aLjHoe\n4fz7mVWIKzlfVVd6IYwN7dvgOUMgZhhqf2HqX7Fo/nV3KnEjA8EYiDsVE1Bx\nbRqIBAgg9U3wDkXZZL8kLjByiBEwz+ldowui7Nc4P709vaD2qoT87JzgQ/uQ\n2EXf5VZFvKKqGf2tfmZts74ntvRR1hX2OAN0nap9p5xIHLMQJq1DXtG4Gybm\n27oOteMZSbdOrninpZK7JWNwB1/ASV1xB1YgVKdx/wS5K426+wiyuNEU5e3X\nuRCqxsuCtTZZUnHyM3LTjS18BPuM7oXL0Zsq6lTBakaISV6Eafu04O+op4CS\nCV1P+MHJA4hMNfAtLrUl0J/l44jzqDmw4dikOTkEHexzUNTTrsiG9Sf+uL0V\nC+XnagOjY4RpkiU00Cqvj0VvKNsODw1iGhlesqKns6znX4k9jp2DTSpRFit5\n2k7jiVqp/9l32IRE3tleJm+N8iWJAFZpDiIZvpZR00+Xtg3CLYmS81RKZHQ2\nfugjHua1fEKTPauJlP+DXFrcFy8M5UAC3WZ39i3wUCWccTz+Id1KdHTqnB38\nQZaPF0Ad30HHeQooxCRxMfUbxLd82F11+Dm1VnHN9UMOe/bifgKVloYuIC1q\nmatZ7PRAhry4m6EjuISwPsgfNeUASv1N3xfnNDqsiyXgQmv8ec701bBbs20u\n18Nm\r\n=k5ST\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"readme":"# @truework/sdk ![npm](https://img.shields.io/npm/v/@truework/sdk) [![install size](https://packagephobia.com/badge?p=@truework/sdk)](https://packagephobia.com/result?p=@truework/sdk)\n\nThe official Truework API Node.js SDK.\n\n## Quick Links\n\n- [Getting Started](#getting-started)\n- [Terminology](#terminology)\n- [Usage](#getting-started)\n - [Verifications](#verifications)\n - [Companies](#companies)\n- [Testing](#testing)\n - [Verifications](#verification-mocks)\n - [Companies](#company-mocks)\n- [Contributing](#contributing)\n\n## Resources\n\n- 📚 [API Documentation](https://www.truework.com/docs/api)\n- 🏠 [Truework](https://www.truework.com)\n- 👷‍♀️ [Careers](https://www.truework.com/careers)\n\n# Getting Started\n\n```bash\nnpm i @truework/sdk --save\n```\n\n```ts\nconst { truework } = require('@truework/sdk');\n\nconst client = truework({ token: TRUEWORK_ACCESS_TOKEN });\n```\n\nBy default, the SDK will use the latest version of our API. To request a\ndifferent version, pass it when configuring your client.\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n version: '2019-10-15',\n});\n```\n\n# Terminology\n\nPlease review the [API Documentation](https://www.truework.com/docs/api) for all\nterminology. If you're using Typescript, have a look at the\n[types](https://github.com/truework/truework-sdk-node/blob/master/lib/types.ts).\n\n# Usage\n\nAll requests are made using [got](https://github.com/sindresorhus/got), and so\nresponses implement a got\n[response](https://github.com/sindresorhus/got#response) object.\n\n```ts\nconst {\n body: { count, results },\n} = await client.verifications.get();\n```\n\n## Verifications\n\n### `verifications.get([params])`\n\n**Request**\n\n- `params` - `object` - optional\n - `state` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Verification`s.\n\n**Example**\n\n```ts\nawait client.verifications.get();\nawait client.verifications.get({ limit: 10 });\n```\n\n### `verifications.getOne(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n\n**Response**\n\nReturns a `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.getOne({ id: 'abc123' });\n```\n\n### `verifications.create(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `type` - `VerificationType` - required\n - `permissible_purpose` - `PermissiblePurpose` - required\n - `target` - `Target` - required\n - `documents` - `Document`\n - `additional_information` - `string`\n\n**Response**\n\nReturns the full `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.create({\n type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n});\n```\n\n### `verifications.cancel(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n - `cancellationReason` - `CancellationReason` - required\n - `cancellationDetails` - `string`\n\n**Response**\n\nReturns status code `200` on success.\n\n**Example**\n\n```ts\nawait client.verifications.cancel({\n id: 'abc123',\n cancellationReason: 'other',\n});\n```\n\n### `verifications.getReport(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required, the ID of the Verification\n\n**Response**\n\nReturns the full `Report` object associated with the Verification.\n\n**Example**\n\n```ts\nawait client.verifications.getReport({ id: 'abc123' });\n```\n\n## Companies\n\n### `companies.get(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `query` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Company`s.\n\n**Example**\n\n```ts\nawait client.companies.get({ query: 'USWNT' });\n```\n\n# Testing\n\nThis SDK provides a naive \"mock\" mode that can be used for basic testing during\nCI, etc. It is _stateless_, meaning no data is persisted between API calls. When\nenabled, each SDK method will either return stub objects, or simple reflections\nof the data submitted.\n\nTo enable mock mode, initialize your SDK client like this:\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n mock: true,\n});\n```\n\n## Verification Mocks\n\n### `verifications.get`\n\nReturns a stubbed array of verifications, respective of all query params.\n\n```ts\nconst res = await client.verifications.get({ state: 'processing', limit: 5 });\n\nres.body.results.length; // => 5\nres.body.results[0].state; // => processing\n```\n\n### `verifications.getOne`\n\nReturns a stubbed verification object with the same `id` as is passed to\n`getOne({ id })`.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger a `404` error\nresponse.\n\n```ts\ntry {\n await client.verifications.getOne({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.create`\n\nReturns a stubbed verification object.\n\n#### Error States\n\nTo trigger an error response, do not pass a `type` property.\n\n```ts\ntry {\n await client.verifications.create(\n // type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n })\n} catch (e) {\n console.log(e.response) // error response body\n}\n```\n\n### `verifications.cancel`\n\nReturns `200` if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.cancel({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.getReport`\n\nReturns a stubbed report object if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.getReport({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n## Company Mocks\n\n### `companies.get`\n\nReturns a stubbed array of companies, respective of `limit` and `offset` query\nparams.\n\n```ts\nconst res = await client.companies.get({ limit: 5 });\n\nres.body.results.length; // => 5\n```\n\n## Contributing\n\n### Issues\n\nIf you run into problems, or simply have a question, feel free to [open an\nissue](https://github.com/truework/truework-sdk-node/issues/new)!\n\n### Commiting\n\nThis repo uses [commitizen](https://github.com/commitizen/cz-cli) to nicely\nformat commit messages. Upon making edits, stage your changes and simply run\n`git commit` to enter the commitizen UI in your terminal.\n\n**Note:** if you are not prompted with the commitizen UI, run `npm ci` to re-install\nand run `postinstall` hooks to set it up.\n\n### Releases\n\nThis project is versioned and published automatically using\n[semantic-release](https://github.com/semantic-release/semantic-release). Via a\nGitHub Action, `semantic-release` will use the commit message pattern provided\nby `commitizen` to automatically version the package. It will then publish to\nnpm, as well as create a new\n[release](https://github.com/truework/truework-sdk-node/releases) here in the\nmain repo.\n\n## License\n\nMIT License © [Truework](https://truework.com)\n","gitHead":"a994e24f2649e16c8ee28fbd12a971792db0ec3d","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.9","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.21.0","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.3.0","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.3.1_1616604425502_0.3371145044057431","host":"s3://npm-registry-packages"}},"0.3.2":{"name":"@truework/sdk","version":"0.3.2","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.3.2","maintainers":[{"name":"truework-team","email":"victor@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"495d6beef1f137d2d613f56ddfb7db51f7efb1ed","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.3.2.tgz","fileCount":16,"integrity":"sha512-a43LYi1F8rw3K+1Fag5ctT0LAsYAMaetGL89bd5eFIEbrIM4uZBRwCldX3zRelk3WHHWbVzsGLQfnQshu+8Fig==","signatures":[{"sig":"MEQCICFhW/3mroBGaAH0D5mnj+24Wbsomh8vZ1rqXWuS3OMMAiB3gTfmRHfTt7kks7fmqNtZIFQIgzIH362HitpqOClLdA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":35984,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgW3C6CRA9TVsSAnZWagAAm4kP/23NSmZ1/0X5jhtLfmWT\n+WJMKifYpHsgqGlGf4LNPIy2LbhqQltvBy447p1u+HnG1M9vGtWgrclzERH3\nrSit7mixfrHaC7/9NoxgIgFnTi41ofK+ItLBFEsDcOTyqJaMo7iiZpdKich+\nREcNrBCYBScPvjeIVcDJFdmjFX3wY8ayA2BdwjRTAyz+fywS5812EtOcGwA+\nb4kaMSqOQxod9wxhwMh6P2ARoOyQ76Un+CSK5yBfBn0jtfJR+rW13geRRw3e\n0LSBTdRbC4K0+e3CB0yz2I6xczgH6waGbbbRNK2bQqKV/thQi7ZGJlswYVIX\nTDFm4geVIF4g6tVPAhqTk5DIiI3mO9ij8styna/VDGcc4XH+9sbS6/7hW6Ev\nOxc9Ot4fhkHlioaA2rL2xZNjX5Zx6d2Gf7zEOdmOdtiLq4tEBe6RT13b8gvD\noS1PDIyS0o1e9YwIgzVigGVVOsfK9du3fq44E+aSemWmSVLnp7sFpNWMymxh\nPO6MaO0ogj9NSMjintdWDwocZjyk+t1K3uwN2TspJxip8Xf4GFZE9ijvbrQp\n2IkhjRouC7dpU0P96dPoNWqjlvMuCB5NZCrdURJ2HRwwHUnCGCA2dT4UVFJR\nTKBUU3IJdRPEvdd8580ZS4KPbodDNO1oL5i1uuBLBnSP62yzMfxIllSHFBg2\nRRjo\r\n=pZnJ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"readme":"# @truework/sdk ![npm](https://img.shields.io/npm/v/@truework/sdk) [![install size](https://packagephobia.com/badge?p=@truework/sdk)](https://packagephobia.com/result?p=@truework/sdk)\n\nThe official Truework API Node.js SDK.\n\n## Quick Links\n\n- [Getting Started](#getting-started)\n- [Terminology](#terminology)\n- [Usage](#getting-started)\n - [Verifications](#verifications)\n - [Companies](#companies)\n- [Testing](#testing)\n - [Verifications](#verification-mocks)\n - [Companies](#company-mocks)\n- [Contributing](#contributing)\n\n## Resources\n\n- 📚 [API Documentation](https://www.truework.com/docs/api)\n- 🏠 [Truework](https://www.truework.com)\n- 👷‍♀️ [Careers](https://www.truework.com/careers)\n\n# Getting Started\n\n```bash\nnpm i @truework/sdk --save\n```\n\n```ts\nconst { truework } = require('@truework/sdk');\n\nconst client = truework({ token: TRUEWORK_ACCESS_TOKEN });\n```\n\nBy default, the SDK will use the latest version of our API. To request a\ndifferent version, pass it when configuring your client.\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n version: '2019-10-15',\n});\n```\n\n# Terminology\n\nPlease review the [API Documentation](https://www.truework.com/docs/api) for all\nterminology. If you're using Typescript, have a look at the\n[types](https://github.com/truework/truework-sdk-node/blob/master/lib/types.ts).\n\n# Usage\n\nAll requests are made using [got](https://github.com/sindresorhus/got), and so\nresponses implement a got\n[response](https://github.com/sindresorhus/got#response) object.\n\n```ts\nconst {\n body: { count, results },\n} = await client.verifications.get();\n```\n\n## Verifications\n\n### `verifications.get([params])`\n\n**Request**\n\n- `params` - `object` - optional\n - `state` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Verification`s.\n\n**Example**\n\n```ts\nawait client.verifications.get();\nawait client.verifications.get({ limit: 10 });\n```\n\n### `verifications.getOne(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n\n**Response**\n\nReturns a `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.getOne({ id: 'abc123' });\n```\n\n### `verifications.create(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `type` - `VerificationType` - required\n - `permissible_purpose` - `PermissiblePurpose` - required\n - `target` - `Target` - required\n - `documents` - `Document`\n - `additional_information` - `string`\n\n**Response**\n\nReturns the full `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.create({\n type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n});\n```\n\n### `verifications.cancel(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n - `cancellationReason` - `CancellationReason` - required\n - `cancellationDetails` - `string`\n\n**Response**\n\nReturns status code `200` on success.\n\n**Example**\n\n```ts\nawait client.verifications.cancel({\n id: 'abc123',\n cancellationReason: 'other',\n});\n```\n\n### `verifications.getReport(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required, the ID of the Verification\n\n**Response**\n\nReturns the full `Report` object associated with the Verification.\n\n**Example**\n\n```ts\nawait client.verifications.getReport({ id: 'abc123' });\n```\n\n## Companies\n\n### `companies.get(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `query` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Company`s.\n\n**Example**\n\n```ts\nawait client.companies.get({ query: 'USWNT' });\n```\n\n# Testing\n\nThis SDK provides a naive \"mock\" mode that can be used for basic testing during\nCI, etc. It is _stateless_, meaning no data is persisted between API calls. When\nenabled, each SDK method will either return stub objects, or simple reflections\nof the data submitted.\n\nTo enable mock mode, initialize your SDK client like this:\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n mock: true,\n});\n```\n\n## Verification Mocks\n\n### `verifications.get`\n\nReturns a stubbed array of verifications, respective of all query params.\n\n```ts\nconst res = await client.verifications.get({ state: 'processing', limit: 5 });\n\nres.body.results.length; // => 5\nres.body.results[0].state; // => processing\n```\n\n### `verifications.getOne`\n\nReturns a stubbed verification object with the same `id` as is passed to\n`getOne({ id })`.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger a `404` error\nresponse.\n\n```ts\ntry {\n await client.verifications.getOne({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.create`\n\nReturns a stubbed verification object.\n\n#### Error States\n\nTo trigger an error response, do not pass a `type` property.\n\n```ts\ntry {\n await client.verifications.create(\n // type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n })\n} catch (e) {\n console.log(e.response) // error response body\n}\n```\n\n### `verifications.cancel`\n\nReturns `200` if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.cancel({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.getReport`\n\nReturns a stubbed report object if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.getReport({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n## Company Mocks\n\n### `companies.get`\n\nReturns a stubbed array of companies, respective of `limit` and `offset` query\nparams.\n\n```ts\nconst res = await client.companies.get({ limit: 5 });\n\nres.body.results.length; // => 5\n```\n\n## Contributing\n\n### Issues\n\nIf you run into problems, or simply have a question, feel free to [open an\nissue](https://github.com/truework/truework-sdk-node/issues/new)!\n\n### Commiting\n\nThis repo uses [commitizen](https://github.com/commitizen/cz-cli) to nicely\nformat commit messages. Upon making edits, stage your changes and simply run\n`git commit` to enter the commitizen UI in your terminal.\n\n**Note:** if you are not prompted with the commitizen UI, run `npm ci` to re-install\nand run `postinstall` hooks to set it up.\n\n### Releases\n\nThis project is versioned and published automatically using\n[semantic-release](https://github.com/semantic-release/semantic-release). Via a\nGitHub Action, `semantic-release` will use the commit message pattern provided\nby `commitizen` to automatically version the package. It will then publish to\nnpm, as well as create a new\n[release](https://github.com/truework/truework-sdk-node/releases) here in the\nmain repo.\n\n## License\n\nMIT License © [Truework](https://truework.com)\n","gitHead":"2da58f47160cfe1fa930135ef5934a48b98b109a","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.9","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.21.0","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.3.0","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.3.2_1616605369787_0.8339684369229534","host":"s3://npm-registry-packages"}},"0.3.3":{"name":"@truework/sdk","version":"0.3.3","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.3.3","maintainers":[{"name":"truework-team","email":"victor@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"d41537095f6838d8d810fabca5dcfbc50803d1e7","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.3.3.tgz","fileCount":16,"integrity":"sha512-8nuUN5ns74FjaTDo+12faddUVE9OrZDyCvV5VN9Li3nSpXt9+sTHp/mL89t/D3ebleSHT9IshICumRpTYIoVgQ==","signatures":[{"sig":"MEUCIQCutdtZOnkdpp4CX3nd6dCUEdDmlnuag6y+0LfvK3d2JAIgCv1FTf+16SsjKquxiUbBZOVSkk3WQLJnGkEuI2rkKeg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":35984,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgW3Z5CRA9TVsSAnZWagAAJ50P/1yfN1/0cQu8YehQvgVT\nQjnKGhrYxdBcDcsB4Zb56Qh9m+oVOJ07AEqgXoTLKXHeQ/E8gErlsS7Z/J9i\nLM2RhDX4Zoi6/lx9r1HbduaWkomLkLKYAd5B/i6IlgczauDQ5hVBxRM0euFw\npOsZg3BGsi2w6iVudkw6e5SO2iABPfj2o48LRuPSp1Geu7jvQQc1g50cNNBy\nPW0rmtDif8eBhhizmlEegzFc7z1czhLMtj3OYpA9d3chgOhS9UnUA+mSFYYv\nhcx72uhQlh6EkzNwj/WziRMhEWG3lGeCHbGxLH5FnYhnurM0oMHlEuk1OVTj\nBDuIItwqNvKykmP/S2vOKuUPIiO307wRTqe4ZyqoGTiV9HePAVC6gIIn0d8e\n7mhzyti53MnqXacHlnCDz9GVg2YAaLpQpbm/45V9bwXY60hakV43DnybAIex\nCGxnDqV3mPM5ByQXL1tvRHlk2BNGpVEm6NgWUFYUZQP6pH2wYnU4PNiMaxry\n5Ho+B+ww63bc6Gj0fOL+rO6TXw9woaD3KZiYuNVI/QBZ3d0jPbgUK1OvC46J\n5qwcQxEMj5AggqS3h93W5nJD13MQf1/B2jHHG71fPZ3R6YfLfIkaysJxUQd+\nFQ/teKDrKKk+Buh2+NWnIj8JN9+sLPhNtWqf20TVBYCzleloEKr2ZTpYjtZ+\nGHKD\r\n=CBgD\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"readme":"# @truework/sdk ![npm](https://img.shields.io/npm/v/@truework/sdk) [![install size](https://packagephobia.com/badge?p=@truework/sdk)](https://packagephobia.com/result?p=@truework/sdk)\n\nThe official Truework API Node.js SDK.\n\n## Quick Links\n\n- [Getting Started](#getting-started)\n- [Terminology](#terminology)\n- [Usage](#getting-started)\n - [Verifications](#verifications)\n - [Companies](#companies)\n- [Testing](#testing)\n - [Verifications](#verification-mocks)\n - [Companies](#company-mocks)\n- [Contributing](#contributing)\n\n## Resources\n\n- 📚 [API Documentation](https://www.truework.com/docs/api)\n- 🏠 [Truework](https://www.truework.com)\n- 👷‍♀️ [Careers](https://www.truework.com/careers)\n\n# Getting Started\n\n```bash\nnpm i @truework/sdk --save\n```\n\n```ts\nconst { truework } = require('@truework/sdk');\n\nconst client = truework({ token: TRUEWORK_ACCESS_TOKEN });\n```\n\nBy default, the SDK will use the latest version of our API. To request a\ndifferent version, pass it when configuring your client.\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n version: '2019-10-15',\n});\n```\n\n# Terminology\n\nPlease review the [API Documentation](https://www.truework.com/docs/api) for all\nterminology. If you're using Typescript, have a look at the\n[types](https://github.com/truework/truework-sdk-node/blob/master/lib/types.ts).\n\n# Usage\n\nAll requests are made using [got](https://github.com/sindresorhus/got), and so\nresponses implement a got\n[response](https://github.com/sindresorhus/got#response) object.\n\n```ts\nconst {\n body: { count, results },\n} = await client.verifications.get();\n```\n\n## Verifications\n\n### `verifications.get([params])`\n\n**Request**\n\n- `params` - `object` - optional\n - `state` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Verification`s.\n\n**Example**\n\n```ts\nawait client.verifications.get();\nawait client.verifications.get({ limit: 10 });\n```\n\n### `verifications.getOne(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n\n**Response**\n\nReturns a `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.getOne({ id: 'abc123' });\n```\n\n### `verifications.create(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `type` - `VerificationType` - required\n - `permissible_purpose` - `PermissiblePurpose` - required\n - `target` - `Target` - required\n - `documents` - `Document`\n - `additional_information` - `string`\n\n**Response**\n\nReturns the full `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.create({\n type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n});\n```\n\n### `verifications.cancel(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n - `cancellationReason` - `CancellationReason` - required\n - `cancellationDetails` - `string`\n\n**Response**\n\nReturns status code `200` on success.\n\n**Example**\n\n```ts\nawait client.verifications.cancel({\n id: 'abc123',\n cancellationReason: 'other',\n});\n```\n\n### `verifications.getReport(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required, the ID of the Verification\n\n**Response**\n\nReturns the full `Report` object associated with the Verification.\n\n**Example**\n\n```ts\nawait client.verifications.getReport({ id: 'abc123' });\n```\n\n## Companies\n\n### `companies.get(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `query` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Company`s.\n\n**Example**\n\n```ts\nawait client.companies.get({ query: 'USWNT' });\n```\n\n# Testing\n\nThis SDK provides a naive \"mock\" mode that can be used for basic testing during\nCI, etc. It is _stateless_, meaning no data is persisted between API calls. When\nenabled, each SDK method will either return stub objects, or simple reflections\nof the data submitted.\n\nTo enable mock mode, initialize your SDK client like this:\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n mock: true,\n});\n```\n\n## Verification Mocks\n\n### `verifications.get`\n\nReturns a stubbed array of verifications, respective of all query params.\n\n```ts\nconst res = await client.verifications.get({ state: 'processing', limit: 5 });\n\nres.body.results.length; // => 5\nres.body.results[0].state; // => processing\n```\n\n### `verifications.getOne`\n\nReturns a stubbed verification object with the same `id` as is passed to\n`getOne({ id })`.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger a `404` error\nresponse.\n\n```ts\ntry {\n await client.verifications.getOne({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.create`\n\nReturns a stubbed verification object.\n\n#### Error States\n\nTo trigger an error response, do not pass a `type` property.\n\n```ts\ntry {\n await client.verifications.create(\n // type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n })\n} catch (e) {\n console.log(e.response) // error response body\n}\n```\n\n### `verifications.cancel`\n\nReturns `200` if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.cancel({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.getReport`\n\nReturns a stubbed report object if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.getReport({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n## Company Mocks\n\n### `companies.get`\n\nReturns a stubbed array of companies, respective of `limit` and `offset` query\nparams.\n\n```ts\nconst res = await client.companies.get({ limit: 5 });\n\nres.body.results.length; // => 5\n```\n\n## Contributing\n\n### Issues\n\nIf you run into problems, or simply have a question, feel free to [open an\nissue](https://github.com/truework/truework-sdk-node/issues/new)!\n\n### Commiting\n\nThis repo uses [commitizen](https://github.com/commitizen/cz-cli) to nicely\nformat commit messages. Upon making edits, stage your changes and simply run\n`git commit` to enter the commitizen UI in your terminal.\n\n**Note:** if you are not prompted with the commitizen UI, run `npm ci` to re-install\nand run `postinstall` hooks to set it up.\n\n### Releases\n\nThis project is versioned and published automatically using\n[semantic-release](https://github.com/semantic-release/semantic-release). Via a\nGitHub Action, `semantic-release` will use the commit message pattern provided\nby `commitizen` to automatically version the package. It will then publish to\nnpm, as well as create a new\n[release](https://github.com/truework/truework-sdk-node/releases) here in the\nmain repo.\n\n## License\n\nMIT License © [Truework](https://truework.com)\n","gitHead":"46067fbfce649ed251202640566fb91a9284ebb4","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.11","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.21.0","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.4.2","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.3.3_1616606840919_0.9114091864034428","host":"s3://npm-registry-packages"}},"0.3.4":{"name":"@truework/sdk","version":"0.3.4","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.3.4","maintainers":[{"name":"truework-team","email":"victor@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"a84958e8e9902bdacbbc57c152b41d4e131b5853","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.3.4.tgz","fileCount":16,"integrity":"sha512-6oRoV7+itA9MK4YRTtst6ioynpOUzyGihTK1gTa5EjzI+TDZZt6NWLfZm4ECCUDIGGhLzaE0U4hjzt2tH4tjSQ==","signatures":[{"sig":"MEQCIC/f3kWtAZwJbnzzVAt1VtpOTkUSu5Maaa+ZEi2sQtBRAiAnOT2wIAHsNZ3Q1ZLm+FkljkWseOxgxZRbkhbRx5dRnQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":35984,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgW3nUCRA9TVsSAnZWagAApQYP/R0wWmCxkDhPUnkHj9UU\nkaC7UI5OXI8teVBtlKxzGF8FI9hk2s0Bay2sx668cOHygsnGjNZ3lh/5XPQO\nHtiuntBNjSGvHLEUVTTYSrqpiPqE8n3DkpPSj6CpUA6+ep0RMgIm2TvCcy+d\nbM0lKcQtL3GGYW6Kze1AEQvJdaHo7NOjRm3NNDIaDqphi82BtQW5qkjmC+P2\nrSUrb86HVyzsvvkDRXUlUhoMpZAgwJlCSwhLBNpccRc2Qz5CzRw3z22t9sE5\n+i7KB5v4kvB2hIc8VLfZYjvAbPgl1+X5NicgoA1BYAnVG+lQtaB1TbBjxyc4\nFC5KVwxhuz1bsb0h8ga9P0xSh4NBzATTUnQpZliAmBT5+RCQd60pckw6HhEj\n1yPe9594gHUxJWjak5KLx7W7ULMd5Ou8DFOAKvN+A7ADtiaXlFvexZpwIBtz\nvmSf8eE0wn58ygPvvq9ZPDsjZ7wJWOeP8SVMlAUOMJecVzvQCLJGO8QOGuzl\nDze3K3ggWHKKXqtJ/gxr9hHl+5QYa4+IoSbTsHAdqfsdMMhH1+1uL/SA3lfs\nrR3h4GTyi2aTglbExmEYdISHqJku4TakvB0EpQh4k8ao9Eq9QENyUFfOemD/\n9oPTYVA0nWKSY8g4QAEGgPuOOm3YWyrpFB1Nc3AIYcEEgFNC7dOynhjqN+S1\n1HWx\r\n=aGsg\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"readme":"# @truework/sdk ![npm](https://img.shields.io/npm/v/@truework/sdk) [![install size](https://packagephobia.com/badge?p=@truework/sdk)](https://packagephobia.com/result?p=@truework/sdk)\n\nThe official Truework API Node.js SDK.\n\n## Quick Links\n\n- [Getting Started](#getting-started)\n- [Terminology](#terminology)\n- [Usage](#getting-started)\n - [Verifications](#verifications)\n - [Companies](#companies)\n- [Testing](#testing)\n - [Verifications](#verification-mocks)\n - [Companies](#company-mocks)\n- [Contributing](#contributing)\n\n## Resources\n\n- 📚 [API Documentation](https://www.truework.com/docs/api)\n- 🏠 [Truework](https://www.truework.com)\n- 👷‍♀️ [Careers](https://www.truework.com/careers)\n\n# Getting Started\n\n```bash\nnpm i @truework/sdk --save\n```\n\n```ts\nconst { truework } = require('@truework/sdk');\n\nconst client = truework({ token: TRUEWORK_ACCESS_TOKEN });\n```\n\nBy default, the SDK will use the latest version of our API. To request a\ndifferent version, pass it when configuring your client.\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n version: '2019-10-15',\n});\n```\n\n# Terminology\n\nPlease review the [API Documentation](https://www.truework.com/docs/api) for all\nterminology. If you're using Typescript, have a look at the\n[types](https://github.com/truework/truework-sdk-node/blob/master/lib/types.ts).\n\n# Usage\n\nAll requests are made using [got](https://github.com/sindresorhus/got), and so\nresponses implement a got\n[response](https://github.com/sindresorhus/got#response) object.\n\n```ts\nconst {\n body: { count, results },\n} = await client.verifications.get();\n```\n\n## Verifications\n\n### `verifications.get([params])`\n\n**Request**\n\n- `params` - `object` - optional\n - `state` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Verification`s.\n\n**Example**\n\n```ts\nawait client.verifications.get();\nawait client.verifications.get({ limit: 10 });\n```\n\n### `verifications.getOne(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n\n**Response**\n\nReturns a `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.getOne({ id: 'abc123' });\n```\n\n### `verifications.create(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `type` - `VerificationType` - required\n - `permissible_purpose` - `PermissiblePurpose` - required\n - `target` - `Target` - required\n - `documents` - `Document`\n - `additional_information` - `string`\n\n**Response**\n\nReturns the full `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.create({\n type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n});\n```\n\n### `verifications.cancel(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n - `cancellationReason` - `CancellationReason` - required\n - `cancellationDetails` - `string`\n\n**Response**\n\nReturns status code `200` on success.\n\n**Example**\n\n```ts\nawait client.verifications.cancel({\n id: 'abc123',\n cancellationReason: 'other',\n});\n```\n\n### `verifications.getReport(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required, the ID of the Verification\n\n**Response**\n\nReturns the full `Report` object associated with the Verification.\n\n**Example**\n\n```ts\nawait client.verifications.getReport({ id: 'abc123' });\n```\n\n## Companies\n\n### `companies.get(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `query` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Company`s.\n\n**Example**\n\n```ts\nawait client.companies.get({ query: 'USWNT' });\n```\n\n# Testing\n\nThis SDK provides a naive \"mock\" mode that can be used for basic testing during\nCI, etc. It is _stateless_, meaning no data is persisted between API calls. When\nenabled, each SDK method will either return stub objects, or simple reflections\nof the data submitted.\n\nTo enable mock mode, initialize your SDK client like this:\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n mock: true,\n});\n```\n\n## Verification Mocks\n\n### `verifications.get`\n\nReturns a stubbed array of verifications, respective of all query params.\n\n```ts\nconst res = await client.verifications.get({ state: 'processing', limit: 5 });\n\nres.body.results.length; // => 5\nres.body.results[0].state; // => processing\n```\n\n### `verifications.getOne`\n\nReturns a stubbed verification object with the same `id` as is passed to\n`getOne({ id })`.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger a `404` error\nresponse.\n\n```ts\ntry {\n await client.verifications.getOne({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.create`\n\nReturns a stubbed verification object.\n\n#### Error States\n\nTo trigger an error response, do not pass a `type` property.\n\n```ts\ntry {\n await client.verifications.create(\n // type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n })\n} catch (e) {\n console.log(e.response) // error response body\n}\n```\n\n### `verifications.cancel`\n\nReturns `200` if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.cancel({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.getReport`\n\nReturns a stubbed report object if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.getReport({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n## Company Mocks\n\n### `companies.get`\n\nReturns a stubbed array of companies, respective of `limit` and `offset` query\nparams.\n\n```ts\nconst res = await client.companies.get({ limit: 5 });\n\nres.body.results.length; // => 5\n```\n\n## Contributing\n\n### Issues\n\nIf you run into problems, or simply have a question, feel free to [open an\nissue](https://github.com/truework/truework-sdk-node/issues/new)!\n\n### Commiting\n\nThis repo uses [commitizen](https://github.com/commitizen/cz-cli) to nicely\nformat commit messages. Upon making edits, stage your changes and simply run\n`git commit` to enter the commitizen UI in your terminal.\n\n**Note:** if you are not prompted with the commitizen UI, run `npm ci` to re-install\nand run `postinstall` hooks to set it up.\n\n### Releases\n\nThis project is versioned and published automatically using\n[semantic-release](https://github.com/semantic-release/semantic-release). Via a\nGitHub Action, `semantic-release` will use the commit message pattern provided\nby `commitizen` to automatically version the package. It will then publish to\nnpm, as well as create a new\n[release](https://github.com/truework/truework-sdk-node/releases) here in the\nmain repo.\n\n## License\n\nMIT License © [Truework](https://truework.com)\n","gitHead":"bdfbbd77dbeaba78d89b8283b2356dd745aaf3db","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.11","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.21.0","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.2.2","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.3.4_1616607699754_0.6489554890331353","host":"s3://npm-registry-packages"}},"0.3.5":{"name":"@truework/sdk","version":"0.3.5","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.3.5","maintainers":[{"name":"truework-team","email":"victor@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"1ea444c463876f38e9c11c442c342f8f945bbd5f","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.3.5.tgz","fileCount":16,"integrity":"sha512-R2DdU2sfmA37P/+jntraVNqI+Zecs/So8QI0JL6K+hDIMnKXXAIfueok6fTlzT+dM3c9ETk/8oxm9vo3qQnwjA==","signatures":[{"sig":"MEUCIHnGYCmh8nc/mhV5wI4rDGBHdI2z5ARZWFV0tBxJ1jLzAiEAuMQp7Fje/YXcxJOG93avQhNG6+7eQss/Rj3T9XiVfbc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":36044,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgW38YCRA9TVsSAnZWagAAlEMP/0ZbjtvDLCNBci5mDTLQ\nyAtdLiEyVL21tWsC8/M+KIToFQWaMpbaSCu/8RdDVMZxJyGoJ2qJ3LQFVIR8\n5NSfZPVYbYj9MLSMGuJ78oSp7ia1NE3z56nJlM38VF0WgsHib0yyyNWa4lQk\nXqR24pAx+z7xhGdqdKeWtJpqnKTymhF3KHthsN6dePRx/Z2e42ltLt4vt7tA\n2el4rfU4eaIDuougdgH84688d31kCKixiq8hTiofHfNuJPfuchktQUaODu/N\nFwbj3dZP0OcS7izSMd5Pv7Pntt2D1MfyrUf/8Lsm8DnbxaGeHsAGWhHUktW5\ncOjKrbLSJheWWSTRqXgmYzs3xvML75qw5fgRfvko4V13vNQudiinZ6Io0KxQ\nQZBxVh97ppyMGANf0WLyE4xjIf2Jfu5M1Nz7sO2R6aFS1oGFfQCn63GQH1f1\n3j/lc1sLoBLUTJ6VRGW8jmmJhYJ8RxAuLqzsuUdTEtnrysSuQnxJiK5R/TWn\nmPtySzVf4h6fx3sHdZJi1+mBcjnA8WZHnUrWV3idbgMl8SHnt2a3OV6JRihn\n30i5gsmBfITDNUSS4NurrpDIEIhbceGIqyrZcw1IRa2vQv5Ah33ZPGxGqlQV\nF5ZEiYQ+gpTXE7DjbmjcHvrsr7NtIGwT2Hi0VnCO57bN2oMTdLtSrIrU/q5p\n5Ss4\r\n=x0bw\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"8cc63902f64c437f71f9206719ce13f24b31131e","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.11","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.21.0","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.2.2","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.3.5_1616609047592_0.5914262281108373","host":"s3://npm-registry-packages"}},"0.3.6":{"name":"@truework/sdk","version":"0.3.6","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.3.6","maintainers":[{"name":"truework-team","email":"victor@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"8d3b1980841b534bb00db49535204bc708ec62ce","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.3.6.tgz","fileCount":16,"integrity":"sha512-V5bPEfjfJs2XFhv8zEKaf+qAYb628HiKVbIE3iCjMFudkc2orEHaGc3GjPLy29+66WI2GTABDsXviWed31AMdg==","signatures":[{"sig":"MEUCIGfOwiEcw63+brn6sZxQeKu9Vzo+OzF6Gqmnk3wE+n+HAiEAyOy5LxhiOWVDRyrJvmi1eB0LJlliNKXcaG8BCU8fhoA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":36049,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgW4ABCRA9TVsSAnZWagAAj/gQAIickG8O+CD9J7vSwYCH\nad9W7sOmM3FP9d1z0gXYXdYOx8AfppGdx6ijMEMRGLpP3pI5YuenmONmDXuZ\nEPDLBaqF+xTVCYS/Dy6H5gt+XDmBnHGtI57U4XMJ2kprlBCJ3lnEGpMT9NYb\nQfLaDaeThvAcIaS3dcwVkOyEDIvltE2PHi4xOG+kj6neCRB9tBFgYmUwhoLt\nWnVDtG6wH1TMyy7AiRk2/Ipm5142b0bbdAplAstt62VTHMLx5wxrZhZFCRz7\ngF+LDdAcPBMHcLjNLNYISD5iagosjgEKbBy9VfMHhP4+1DRCNto2TL3Gpdw7\n9Lnu5nilQVcn5rVFRpzUhGIMvq1iYLphv/8VhzjDBwahiggippZ702vR8Y4n\n7eTr4MfMnmAltMIbgFSuTjV7R0YrR5FXbODS/PYVC07ZO82z2Exac3heDEz8\nJ/JhwH2wUEhC4NNK0rDHKtumOVO6zeDfA6I3ZXwGBAy8tXVj0DjfzqG/W4k8\n18mXxXaLdLHiTP9HzHRElFSLPvwjbXRu73PgudB8VZuB6v7kig2FMGQNP5w/\ngZ6NrjGnPgP9N8av49kEDgc/wvo/skRlHv5dq8DA7ZAMTdVG1EkjPqMGaWCO\nDTvX3uiicMz9irPnkf0h3x+YBBIX4F4TLyvAXP61thunLdktllS3phtkjcWb\nJ/rp\r\n=Lw2C\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"readme":"# @truework/sdk ![npm](https://img.shields.io/npm/v/@truework/sdk) [![install size](https://packagephobia.com/badge?p=@truework/sdk)](https://packagephobia.com/result?p=@truework/sdk)\n\nThe official Truework API Node.js SDK.\n\n## Quick Links\n\n- [Getting Started](#getting-started)\n- [Terminology](#terminology)\n- [Usage](#getting-started)\n - [Verifications](#verifications)\n - [Companies](#companies)\n- [Testing](#testing)\n - [Verifications](#verification-mocks)\n - [Companies](#company-mocks)\n- [Contributing](#contributing)\n\n## Resources\n\n- 📚 [API Documentation](https://www.truework.com/docs/api)\n- 🏠 [Truework](https://www.truework.com)\n- 👷‍♀️ [Careers](https://www.truework.com/careers)\n\n# Getting Started\n\n```bash\nnpm i @truework/sdk --save\n```\n\n```ts\nconst { truework } = require('@truework/sdk');\n\nconst client = truework({ token: TRUEWORK_ACCESS_TOKEN });\n```\n\nBy default, the SDK will use the latest version of our API. To request a\ndifferent version, pass it when configuring your client.\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n version: '2019-10-15',\n});\n```\n\n# Terminology\n\nPlease review the [API Documentation](https://www.truework.com/docs/api) for all\nterminology. If you're using Typescript, have a look at the\n[types](https://github.com/truework/truework-sdk-node/blob/master/lib/types.ts).\n\n# Usage\n\nAll requests are made using [got](https://github.com/sindresorhus/got), and so\nresponses implement a got\n[response](https://github.com/sindresorhus/got#response) object.\n\n```ts\nconst {\n body: { count, results },\n} = await client.verifications.get();\n```\n\n## Verifications\n\n### `verifications.get([params])`\n\n**Request**\n\n- `params` - `object` - optional\n - `state` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Verification`s.\n\n**Example**\n\n```ts\nawait client.verifications.get();\nawait client.verifications.get({ limit: 10 });\n```\n\n### `verifications.getOne(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n\n**Response**\n\nReturns a `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.getOne({ id: 'abc123' });\n```\n\n### `verifications.create(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `type` - `VerificationType` - required\n - `permissible_purpose` - `PermissiblePurpose` - required\n - `target` - `Target` - required\n - `documents` - `Document`\n - `additional_information` - `string`\n\n**Response**\n\nReturns the full `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.create({\n type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n});\n```\n\n### `verifications.cancel(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n - `cancellationReason` - `CancellationReason` - required\n - `cancellationDetails` - `string`\n\n**Response**\n\nReturns status code `200` on success.\n\n**Example**\n\n```ts\nawait client.verifications.cancel({\n id: 'abc123',\n cancellationReason: 'other',\n});\n```\n\n### `verifications.getReport(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required, the ID of the Verification\n\n**Response**\n\nReturns the full `Report` object associated with the Verification.\n\n**Example**\n\n```ts\nawait client.verifications.getReport({ id: 'abc123' });\n```\n\n## Companies\n\n### `companies.get(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `query` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Company`s.\n\n**Example**\n\n```ts\nawait client.companies.get({ query: 'USWNT' });\n```\n\n# Testing\n\nThis SDK provides a naive \"mock\" mode that can be used for basic testing during\nCI, etc. It is _stateless_, meaning no data is persisted between API calls. When\nenabled, each SDK method will either return stub objects, or simple reflections\nof the data submitted.\n\nTo enable mock mode, initialize your SDK client like this:\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n mock: true,\n});\n```\n\n## Verification Mocks\n\n### `verifications.get`\n\nReturns a stubbed array of verifications, respective of all query params.\n\n```ts\nconst res = await client.verifications.get({ state: 'processing', limit: 5 });\n\nres.body.results.length; // => 5\nres.body.results[0].state; // => processing\n```\n\n### `verifications.getOne`\n\nReturns a stubbed verification object with the same `id` as is passed to\n`getOne({ id })`.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger a `404` error\nresponse.\n\n```ts\ntry {\n await client.verifications.getOne({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.create`\n\nReturns a stubbed verification object.\n\n#### Error States\n\nTo trigger an error response, do not pass a `type` property.\n\n```ts\ntry {\n await client.verifications.create(\n // type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n })\n} catch (e) {\n console.log(e.response) // error response body\n}\n```\n\n### `verifications.cancel`\n\nReturns `200` if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.cancel({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.getReport`\n\nReturns a stubbed report object if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.getReport({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n## Company Mocks\n\n### `companies.get`\n\nReturns a stubbed array of companies, respective of `limit` and `offset` query\nparams.\n\n```ts\nconst res = await client.companies.get({ limit: 5 });\n\nres.body.results.length; // => 5\n```\n\n## Contributing\n\n### Issues\n\nIf you run into problems, or simply have a question, feel free to [open an\nissue](https://github.com/truework/truework-sdk-node/issues/new)!\n\n### Commiting\n\nThis repo uses [commitizen](https://github.com/commitizen/cz-cli) to nicely\nformat commit messages. Upon making edits, stage your changes and simply run\n`git commit` to enter the commitizen UI in your terminal.\n\n**Note:** if you are not prompted with the commitizen UI, run `npm ci` to re-install\nand run `postinstall` hooks to set it up.\n\n### Releases\n\nThis project is versioned and published automatically using\n[semantic-release](https://github.com/semantic-release/semantic-release). Via a\nGitHub Action, `semantic-release` will use the commit message pattern provided\nby `commitizen` to automatically version the package. It will then publish to\nnpm, as well as create a new\n[release](https://github.com/truework/truework-sdk-node/releases) here in the\nmain repo.\n\n**Do not publish this library manually from the command line.**\n\n## License\n\nMIT License © [Truework](https://truework.com)\n","gitHead":"1234cb45263de75964a6a1dc5d8ab5da128479e2","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.11","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.21.0","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.2.2","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.3.6_1616609281207_0.7583808935948946","host":"s3://npm-registry-packages"}},"0.4.0":{"name":"@truework/sdk","version":"0.4.0","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@0.4.0","maintainers":[{"name":"truework-team","email":"victor@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"40b951daf6d9819c0ba6120e1f952d4ecf4988b8","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-0.4.0.tgz","fileCount":16,"integrity":"sha512-KAlImxwy7cOJbjI90jogZPOn/RLWthyRdN/ETZ6vUj630CD5WylZTUn2mf7lNW8hsP3iDVn9VbZfLxj8uzhFgA==","signatures":[{"sig":"MEQCICNW4Q+PKPGLM6+cb8O6L0hxSjZoI25i1mNj+fmrCXRGAiBNapyxj22yZocF6wVTerKQjU6eT2o0q1JxOa3pef+xrA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":36109,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgY0nhCRA9TVsSAnZWagAAJWcP/iWD6YrkGyTWW8Nmudi7\nUiBQ+6nSlluQ1OaTCDS5CsEu9YXyYm9XSFrJBBhONEgzP7iKkKB/Q7r6Qv9c\n/u7CTX0oA9EhzkBGEcQgca/UF/OyJVWRCUvhWtMM3VIT/SNjBr0skmTHLYFT\n1Q2gDFwKeTTcEKtWbRkPMRozfeT2rh+RlLyXCaosR4gEroMUgFeo7dgtKDxc\npnbqRy72fiNb6mSpUvempIcP5cMGDkPP/Fy4mgQy49oKYtU5q+BHwMfXDR5U\nIjH9PYPBI6COlQ2y66RUGBbS05vOrWQ9ALYuMSI4wynn69d1TT8haJBid7OJ\n0xNQykzfsi5wLpaD0Du7aSXp/BlKwVzkmnRkNBgzhAuNLTsZMyRilzCwd99P\nTY5TOOWdiVVuuqmrK02ZgilaTTO6XOUNeLOuCdCxJ9rnyRp1CGbFssddCyJh\nPTeEERM8874/HfKwPbpxdssvgA/flg4CUav59cOpih8eynsuD1JqfyCS+wg7\n9EmqETmMtAaxvmGSysNygRWJ4sR1C68VHq8XgYTwAyHjkHWKMkluzVYCa9IZ\nWwEwiGMbfK3hL6i3TfS7QvMWXd4CkqmSCPS20sXE+kPcZlf7UyQHLLcVCuOf\nNgoPo5+oks3mZCHQuFm7Sd61DjMqAQ9zYlLnZSFh8Npfv2JKahiIRv5VcUrQ\ncRJe\r\n=ispR\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"c24588d48f918e2f782a8761fc5af77a1c94422f","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.11","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.21.0","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.2.2","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.4.0_1617119712920_0.8169617710080392","host":"s3://npm-registry-packages"}},"1.0.0":{"name":"@truework/sdk","version":"1.0.0","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@1.0.0","maintainers":[{"name":"truework-team","email":"victor@truework.com"},{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"41533f818c15912d15794e906ef3a8fdefda712c","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-1.0.0.tgz","fileCount":16,"integrity":"sha512-8sWRkOA+WoG0tvIyDx9Zar0PBI59g/1exILtWIBqOiY5bl19nua9eVDXm38+UNMbAIkdEOhZsorJNIAOSYHF4Q==","signatures":[{"sig":"MEYCIQDGOS1Apf/A9vPljnpTthq25VfEier3pjsMNCNwH3IzBQIhAPg+dxt1aoBaQr7pjyJYPEy+/rohnKiKYynugEe/pXSp","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":37326,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg0NiECRA9TVsSAnZWagAAthkQAKL+X1eyBWoaMcoKm9Ld\nyX3NXc0LOzvAfHvqW0Fx7Ik9FHB5p/84vZnWaih7apS6iP9oZUadWBlP+b2j\nNfZrquR5Ka6iJe691YUskA2KHhqgXhSkGb9qj8hjr0siChiWwou/0X8W0K/J\nRk8uSJsHMhVcXtKqrU3Tz7bNrNgyHM7MBXqCsMsW2UHE0gjWrRilmj1dqWLs\n7Mi3j0BLTS+RhlOA/YbLHuk3199WGy2xjJbkxWDvJu0iUZGWPJwFmeL8MbcK\nDlXUBp9EG6l9uZtWXNlg36RbOcbYG/v33R8+NRjy+hQuMhqemYyeAdGmVkC/\nlDZ5PDULyh98BYI02oMlwXZLm6QbjizhEhoFj9x3J8E7+yqskP9mRAKhm1hO\nCvUKifvU426AvC5ZKLy8AczSSmi6LCLKWLTLlHGy45Wl7SmmwtdlT4HIRJaw\nCdppBv1K/R/Rxs1oHuHt/Z/HHbkBs5H0khPpmtkxWNXuoA0gol61609n6wKU\n4OWZXdQE4HxJnkP6inWIaZuddewj3Sf6m0CFVAumBzMbAbmMwe0Ib7pu0a7q\nPsk6VRk4FdZLHiQBIQvnbd5st5c3QGk21HB6Dr7yS4rPBhdsS0kSWm8G1vjK\nw1fJIRtZ/A7mDqMogbd2YRzQd/mnyPOR6zLtZHC2TP/MCHgsFme4BmXRgqNJ\nLTK8\r\n=FyKI\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"300e011c1706f7d9cdb138087f09d1be7c0f7158","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"This SDK version is deprecated. The SDK does work, but is not maintained and new features may not be supported. For now, we encourage our customers to integrate directly against the API using https://truework.com/docs.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.11","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.22.1","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.2.2","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_1.0.0_1624299652225_0.05060917035667978","host":"s3://npm-registry-packages"}},"1.1.0":{"name":"@truework/sdk","version":"1.1.0","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@1.1.0","maintainers":[{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"7ef9b433a47b7f832cca71f09b7efde6d89760b9","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-1.1.0.tgz","fileCount":16,"integrity":"sha512-XvO++xWIp1yrYjFUcCRVAlNV4c2KLaRu3pg+JMN/XyF4tx8Cf3/LTY13hsJv7UdZJg4+LxjIBfJHJ7YS2/zaUA==","signatures":[{"sig":"MEQCIC2eBahfCCTXG9e54KFN4PAcCPXKreYHBfNtquhGFS8JAiBiJhs3FEzjxG6oE2tM5ZTj4Zt3vMeoBKN6VW2C3yM/rA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":38215,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg+wumCRA9TVsSAnZWagAAX0QP/02Zjkpb4C2S2ZPnFeKb\nRpJjf6Y98gk3m5+hQZ1XpcHNRIFMC0TSWp/SqVwIHRXt8rMK1/ehduuadZYU\nTZ4K77yqaosu/0AqSzFIYg3LMskgnNmK/BPWBrZzjazLHPkwChlm3llKe2qD\ns9HgrsPfSO8iWFfIiA4OH+JeUvjwaBIceXi/llQYDSm7Ech2T1q+v924YLP/\n6vIb60SkkmCYJ9R+s8R/7E1MYvkNbAlZVopWdTPQRuJ1g1UE5RpNUaq6nNHf\nb3ibwYwnUJv7q2GjO5jZIqVsFx0IbNpUwgxWXLxYjuynjnHcFes/EjQUzJD7\nYAuB18xwuSKaXWp1KGQjHVPzdd02u90UD2vTT/mODI+rvOsUPj3V0uJFpE4L\nY2any4pjGaxqiyK7DoI7JDXgc5W9X06s352lqidkHAUog88P6APQBYEn2osL\nOJwN06Oc58FcqUp2aW4K+PXdlTHz1VToUyOUGKptfA7OlIsRNb56V7LrxjkJ\naAp2UgCQWGPBHJmFzGObz/0a/uZv5uaCIx81Nu+Sc6pSRxp04CMHgryRMelb\nVxRGW2iwr8AQ5nyEWGMFQRbF8Sr1vhdfHPe455pP+3XiuiFqV+DfeM7hQxeE\n6xmTqj26KjAaDzMWb3Rh8wEw7TwKIvfG0Yn0C4AjtoDxTCOsccxKgXdVADdZ\ntPEw\r\n=cvAw\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"7b03e3facb98069607a3d47e183f6d8626b7ef68","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"This SDK version is deprecated. The SDK does work, but is not maintained and new features may not be supported. For now, we encourage our customers to integrate directly against the API using https://truework.com/docs.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.11","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.22.3","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.2.2","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_1.1.0_1627065254295_0.07131303594871774","host":"s3://npm-registry-packages"}},"1.1.1":{"name":"@truework/sdk","version":"1.1.1","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@1.1.1","maintainers":[{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"f1e668e32daa8c1edb73152e33b1fcb1c0e4002f","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-1.1.1.tgz","fileCount":16,"integrity":"sha512-1si3a/9q7iTpHTb/rURwryZ1CRffE3vcgitubVrIj5rK2v/4oi9QY4Re7kiZuEaj6T7kPUOGl6kYJFAkypwDiA==","signatures":[{"sig":"MEUCIHy5GqgrfWpFujSzMzOIWKF7PUcMkIib3CuH6brErcaTAiEAxY9Nl19yiuOtfeAPgEcrjL/UD+pBnvqly8XRFGbSIqY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":38541,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhAurrCRA9TVsSAnZWagAATjIP/R1AAnQla1uuYU9lVzEL\nNvFFRp2t04din1FOv+fqu0omxHN22iUSVCxFEksUrZrSWaWv603RxKhu8pg/\nWTSVkhY2+/Q1EMH7w29NFrm3ZI5X9ybuU2IFYh2ahsLLFiJCjqJG7vESFTXn\nm4Qi60gDCgrzpsMBE+fQTgJvDhE7/HWMWAtcc3d+nRczDLqjS9gQOMyPcF/Z\nFPRNZZ1CwMTTfspKu3EwRZDtiTvUdrIGQEBNGmlfcooOdblnyiKb3F7anJQC\ntsvrGdPz6AjG4p78Uo4sN6RoAa9BpQ6uayKLul+b5doDZukq/OD3b+R3geBv\nVCVbK4g7XqRLeNt9MiH7/veIXF12Dj8PItWBZiGRVG0yDM2r0W3EspPTVr3K\n+nBBpRIa0SvyAJOcjvBY0496E1p45c84zeTUizaHTrsXLTa7N2Y6vUdRw6Ns\nafu7QTpb/YsPEWDIpks02OGT1LJt7u7VmAncUq+AvTgXw6vfjv6WT4mrHatM\nf7aR9flw2pSpRy/nZE4cQ1pRJFaAS0YV1M3gU92DSBCcy+TF1z8rgDtxla6R\nFslagMYGKButKkdBQhA6let7GxIXhIdHfmIUXo2BblzAHBIPQQpYDmGrKiy7\nFRKMS0X3sRRAaXjdrA9fb5Clb7may2kCI4selQEwaZ/KnNbKftzv6eW0AH5Y\n4bl4\r\n=ZsFw\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"bbca42af83f40e0fe76c065f2187a2d959201162","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"This SDK version is deprecated. The SDK does work, but is not maintained and new features may not be supported. For now, we encourage our customers to integrate directly against the API using https://truework.com/docs.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.11","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.22.3","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.2.2","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_1.1.1_1627581163721_0.27833148368473193","host":"s3://npm-registry-packages"}},"1.2.0":{"name":"@truework/sdk","version":"1.2.0","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@1.2.0","maintainers":[{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"c50bc31ba6910ad64fc9f9feb13ee98378623d04","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-1.2.0.tgz","fileCount":16,"integrity":"sha512-EDRmmjyEaGj4zOvVrtba/W1RpMGkADtNOpIzmBLefdk7ZA33bWiGSDHFWI7LFImon386JUWNJYgtnZRIhDQGXw==","signatures":[{"sig":"MEQCIDq2FqqYDrZsFN2elyWJQ3OCzcBZ6QGn6PktfSfjwj9iAiBwjN7fGKgP19FeGK4Ll2FShPsUaInGGBqlyvOcHoCvJg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":39912,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhBI0rCRA9TVsSAnZWagAA9IwP/0vQc9nXyrDlg4tQXlO+\nfRbGXa45cPkpX942DNLNJG8KeJ7CoXV8lWdCv7ofyl0AltgBs6PPKgKIanS7\ny2DRdpQ2m5XuUnwHf+8Avhlice/+CSWEblLanw5ySdHl+axsx8+heZ7Phkwn\n0WenpCa9KiQfLmmWxvtiJBtZLA6ApZsmJfjy8BY3lJswxLTeARzownoBHu2i\nZGh/rWF9HpJtpz6hVarFPE2cEczRx0Va/mEV/TsbHSodzg2fTX5UPJE98wM3\nlbGrL4Mt/DopB8H8k/xluQ6SXCFByJVmwNtZxS1cP2YH47gIb9TE0yBDpKH4\nVH0RBp4XhHhLLutP4AFQRByaLxedosMc0xmi2Gp2foN2Bk00ehNKw23pkkXL\nITYoxrdIJCeseYC+nL6w+i/EE7XIHafpA9ZvJ15Y0PMwXYtBGPNs9kELsCXE\nUGu8f3PnLQlTP3+N4eXYUxO7Y4hF1ajbyizEF64zznNifmUsp72kYewaF7u0\nGDRksWuCtsFMffZTA6OzOccyD0CYBwFsQ/7JgPIyL0PCbEC8jQOyTN0hg6Zl\nOiA1usFkn17JrezE3Epq8RWCNhHitt6VfcIJB0T9TCPGV/ioKsrSm4CqGKA2\nGk/fRHo0hkqn0lJBik+6npSLcP3deyWPgD+s3GJpgmpJnewPv44NITyKhxQB\nLRo+\r\n=BY0k\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"57dd02b5b2eceb7753256915e2d51ca7c98a7d47","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"This SDK version is deprecated. The SDK does work, but is not maintained and new features may not be supported. For now, we encourage our customers to integrate directly against the API using https://truework.com/docs.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.11","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.22.3","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.2.2","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_1.2.0_1627688235228_0.412761595356826","host":"s3://npm-registry-packages"}},"1.3.0":{"name":"@truework/sdk","version":"1.3.0","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@1.3.0","maintainers":[{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"bf7fd8f98944218dde82b7a6410403703ce63034","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-1.3.0.tgz","fileCount":16,"integrity":"sha512-tzOYRUhwbW6IcC4kxjaJjdJSO2pqNHL/8khyJvydiWRcgRHq2wr0J1kRS2MkN+RufEC0d9Hrpt6QmPhQdQZ9EA==","signatures":[{"sig":"MEUCIG7PDREbCbdAt29h5FEjuC9aCDNjLiHr8bklPCuNGnBvAiEAgOR1m1476YQ5YQWMzpaRBl2t61wBkeOTU4Dg8rvuqo8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":41520,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhCHwoCRA9TVsSAnZWagAAAq4QAIMOClmVb5KxfhlrZXZF\nY1Mt52WgPUr+pjq3P+5LPtx9zEal7pLwLaBAc0zCgzoMpTa/djb+dDbbBjaB\n7/wJc0DF7jorkmkw61eC4YaKFkwrfXc4dy6I/6ufgjTMSt1lMqWGdLtg51UA\nDNyjBIEJwscNmzeeuRwK0Jw9XcFKxv5ClHzSjetzvgsM4PG3vmpTvJAoAYCh\n6oWx9VKHTdfm+gvCVxYBwFBIMIZPtOTeYQaYRASdV5j0sLGmQL26SVhdA3JZ\nvENQWboh2JalRHqVPiiwPcJG1G6xJXDhSaMGgKxlW6NAmcO+53hiBUOvzZ+h\nHi/XU4+UrRe0dlX4ZKCN4Fd/9DxEy3pBxcbcGDN0KAGA/2/n65sz4MJFyIfw\nokLCs/FvelAVfnQ/dlV6+vz+nTorZo7aGxn3hANuUYUIbE25p7XIJQfV49ru\ne5b1Iy2yujY5Rr2jzuj9Uxug96P/qvIQGzWZUctQi37/aMBruZUOPERYf/m7\nsO4lLWqm6Vr45CmH2lfoP/ACHotjjFB34gwaGeYDBE2DNTIQW2ORWRFmrYho\nLDh7Fl0SKrPd35JCKOGbeFpY0fEZaT8w9gncEwupMJDgXOwSFp+CwQ9amm6o\nkqRAIjYxTH592NZgFO7kv4GY4eEVadore5dtaDEKXHRMhe+FJevm/Vnh+cOF\nRHLE\r\n=GKM0\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"f2aaba5411a583b91057279425b608aacb90d3fd","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"This SDK version is deprecated. The SDK does work, but is not maintained and new features may not be supported. For now, we encourage our customers to integrate directly against the API using https://truework.com/docs.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.11","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.22.3","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.2.2","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_1.3.0_1627946024278_0.4387649503012101","host":"s3://npm-registry-packages"}},"1.4.0":{"name":"@truework/sdk","version":"1.4.0","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@1.4.0","maintainers":[{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"694dbf478527808c32aad1ff7277ec4b2f0b8268","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-1.4.0.tgz","fileCount":16,"integrity":"sha512-wRHaZNZRs4rD+814oAmc8AyRc1SAy+eaDO1QoHF1d06aWtDDHD8e0hoXCkFGx9oXuuOCHzBN21U0/WdcdhgIfA==","signatures":[{"sig":"MEUCIQDNg2f6A2zPa2YNVlJ8qZJPm4XrPow+cOla4x8rIpZDKwIgKrmmCRRKmfGJxV1LH6rMaU8O44XCQqVIHBaLLSSh9rA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":43853,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh2e67CRA9TVsSAnZWagAAylMP/AqeCidgDSqQ9lbDsywH\nNwot9LZl/mOsxFOnWt4zRgcxEDG9L7mvuG/YqJCDGud87QhMDigy3EW7qV+r\nFtBDK7IzH+LOuVxZiMqTjaWEqIRBgMPUUZJOEC5hTo5KyxdEPIyIryasy+fH\nFTYFcL9aGAOl49RPau9Q+E5rVCmkvuj5UqVBy8KFG7wc8qhZu6Te5GkYK054\nW+b9BJ0CbP8Ahs1urzsAz02JlselN7ulkKHMLbKF4MxmrbtfE7+k75qFBLJ3\n5uQe6Et87SvgP0lS1uuCrkfCYdFZnYch8pfgBiQBYzEpP1RoTOTc//P0NazX\nOzCZBSbez/4N2dXzBA7h2/iEW4orMFVCeUzK4dXC7jldyrk11LIjNNf0UGqb\nKCuKLdJIhXXVVtCryLo3VbkGgB2hnbHuM7NyFieMHukSRSYAz6ePQIXyDibM\nbiMxG80IQ0F5DFKS4mlEH4KuWCWVlqotENuMl1f5pEZNkoSE8UoCeRnawn3I\nbJJwJaMk9+IIFuzQqBsSg7lKA8HhuNkTUtHjYxavE+v5L0wFwZfvzLzwNoMv\nwwoQein+OYAmzRRQHTVYafMwN3ObKI5BhhO+2g2hKVxcE0BTVpnqkNeHrBx8\nFi1s5VsUe0gylibvxGea/i+dMZV6TAc2T38TsNSGV9QfFLzyK2ByCWgOq3KT\nLDbC\r\n=u2cc\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"e0a751b08ee0cd592bfbc51efb38a3e8851cfa46","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"This SDK version is deprecated. The SDK does work, but is not maintained and new features may not be supported. For now, we encourage our customers to integrate directly against the API using https://truework.com/docs.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.11","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.22.6","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.2.2","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_1.4.0_1632503740895_0.5956886695571586","host":"s3://npm-registry-packages"}},"1.5.0":{"name":"@truework/sdk","version":"1.5.0","keywords":[],"author":{"name":"Truework"},"license":"MIT","_id":"@truework/sdk@1.5.0","maintainers":[{"name":"estrattonbailey","email":"ericstrattonbailey@gmail.com"},{"name":"nickbytes","email":"nick@nickbytes.com"},{"name":"angelachang","email":"angela@truework.com"},{"name":"lindseyhiltner","email":"lindsey.hiltner@gmail.com"},{"name":"truework-team","email":"victor@truework.com"}],"homepage":"https://github.com/truework/truework-sdk-node#readme","bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"ava":{"require":["ts-node/register"],"extensions":["ts"]},"dist":{"shasum":"5e51c1d5a0139899312a56a5bbdf86b4f20ad739","tarball":"https://registry.npmjs.org/@truework/sdk/-/sdk-1.5.0.tgz","fileCount":16,"integrity":"sha512-w6bg0D2coQ0plS1c0pwQE2+EgK0JXuUK9k/+5Ftag7DZDpzSQijBCHD0+tSFjWGbV1kUrJx2tXisOtigmdsFaw==","signatures":[{"sig":"MEQCICHe5ZL4hX1/DsZFC1+EsDchSwFV4UiUALMeNOUifsPgAiA/rRojI9VAvKNvpiLiLIfUF4iagCgW9wC+GNsUzo801Q==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":46122,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiOk2AACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoGdw//UgyugRBMdt2Qzvunc2d62SaYccbRY/n0XwfcN9fO5b/dGRSc\r\nZstuGZ/AJFhmHrgZ2IjnNw+wGNraCrnH33X+dtIxXekKunlkkmlFzN6X6g11\r\nDLSkE0a8+jsHn4rrYRNim9ULSEzDqKOD3skO3hbLnZbz9bdmY3IO89GUurn7\r\npcKjZcyTjtsW3o3hZUo1q9kPW6vnGEcygIRvT4pLMw3KIrBA3W8CSyUSpXl6\r\nnjDLHt7oaYgQs7arCHyQXETarQ0tI8PvKC0TsMnvA7fXWpKemuGdHAu8h3Ul\r\n5T8wUQYMwEUKPkxw0UBYRmREWvrITAGqO/MAW1p50y9GDi7tQ3pBexwuDdyP\r\nJr/4GpVTl7sjnNTfdy+BJS++acZUUeA8cMobiamvEvgkF1zz35uw1JYRpGwX\r\na3gYIkheVgg+BbsJfThuZloZX8MBoliejoS5tHVPLtFIZmOi4xHfOHGXPsHn\r\nWJzzBxLTkTI5/zNPCzBaYtSgqoVhvCpJxBCql+TpaLAHqk/BVWLgnnN1H5lj\r\nZSSdpa0EtPpV6ZMlBHgnFZfD3ZMXmuCqkpuO+AtrSzxsucH64Ol+Ge8mgKXw\r\n9EIO5IowSpOSxVS+AF0UtDlLIjIzzvohNCC62cR8zMYijYxdvFyaozfDZrkB\r\nQHjpa/yumGKshl0pOZMk43v7W1ARaHrhTwg=\r\n=bkzf\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"prettier-standard --format --staged","prepare-commit-msg":"exec < /dev/tty && git cz --hook || true"}},"types":"dist/lib/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"gitHead":"bcd4d5cbcc867cd1b5ee24036858f42d288fa3a8","scripts":{"lint":"prettier-standard ./lib/*.ts","test":"ava ./lib/__test__/*.test.ts --verbose","build":"bili lib/index.ts --format cjs","watch":"bili lib/index.ts --format cjs -w","format":"prettier-standard ./lib/*.ts --format"},"_npmUser":{"name":"truework-team","email":"victor@truework.com"},"deprecated":"This SDK version is deprecated. The SDK does work, but is not maintained and new features may not be supported. For now, we encourage our customers to integrate directly against the API using https://truework.com/docs.","repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"_npmVersion":"6.14.11","description":"Official Truework Node.js SDK","directories":{},"_nodeVersion":"12.22.10","dependencies":{"got":"^11.5.2","nock":"^13.0.4","nanoassert":"^2.0.0","query-string":"^6.13.1","rollup-plugin-typescript2":"^0.27.2"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.10.1","bili":"^5.0.5","husky":"^4.2.5","ts-node":"^8.10.2","commitizen":"^4.2.2","typescript":"^3.9.7","@types/node":"^14.0.27","semantic-release":"^17.2.2","@types/nanoassert":"^2.0.0","prettier-standard":"^16.4.1","cz-conventional-changelog":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_1.5.0_1647988096082_0.0831960207977589","host":"s3://npm-registry-packages"}}},"time":{"created":"2020-07-27T23:24:02.527Z","modified":"2024-09-30T23:37:42.123Z","0.1.0":"2020-07-27T23:24:02.903Z","0.1.1":"2020-07-28T15:11:40.317Z","0.1.2":"2020-07-28T21:04:23.489Z","0.1.3":"2020-08-05T15:56:40.077Z","0.1.4":"2020-08-05T17:34:25.086Z","0.1.5":"2020-08-17T17:46:23.883Z","0.2.0":"2020-08-18T20:28:23.686Z","0.2.1":"2020-11-23T17:25:14.579Z","0.1.6":"2020-11-24T17:53:22.208Z","0.1.7":"2020-11-24T22:35:39.676Z","0.1.8":"2021-02-04T22:30:44.568Z","0.3.0":"2021-03-24T16:43:51.918Z","0.3.1":"2021-03-24T16:47:05.679Z","0.3.2":"2021-03-24T17:02:49.991Z","0.3.3":"2021-03-24T17:27:21.113Z","0.3.4":"2021-03-24T17:41:39.937Z","0.3.5":"2021-03-24T18:04:07.879Z","0.3.6":"2021-03-24T18:08:01.476Z","0.4.0":"2021-03-30T15:55:13.051Z","1.0.0":"2021-06-21T18:20:52.396Z","1.1.0":"2021-07-23T18:34:14.508Z","1.1.1":"2021-07-29T17:52:43.859Z","1.2.0":"2021-07-30T23:37:15.399Z","1.3.0":"2021-08-02T23:13:44.402Z","1.4.0":"2021-09-24T17:15:41.026Z","1.5.0":"2022-03-22T22:28:16.238Z"},"bugs":{"url":"https://github.com/truework/truework-sdk-node/issues"},"author":{"name":"Truework"},"license":"MIT","homepage":"https://github.com/truework/truework-sdk-node#readme","keywords":[],"repository":{"url":"git+https://github.com/truework/truework-sdk-node.git","type":"git"},"description":"Official Truework Node.js SDK","maintainers":[{"email":"jason@truework.com","name":"js-truework"},{"email":"victor@truework.com","name":"truework-team"}],"readme":"# @truework/sdk ![npm](https://img.shields.io/npm/v/@truework/sdk) [![install size](https://packagephobia.com/badge?p=@truework/sdk)](https://packagephobia.com/result?p=@truework/sdk)\n\nThe official Truework API Node.js SDK.\n\n## Quick Links\n\n- [Getting Started](#getting-started)\n- [Terminology](#terminology)\n- [Usage](#getting-started)\n - [Verifications](#verifications)\n - [Companies](#companies)\n- [Testing](#testing)\n - [Verifications](#verification-mocks)\n - [Companies](#company-mocks)\n- [Contributing](#contributing)\n\n## Resources\n\n- 📚 [API Documentation](https://www.truework.com/docs/api)\n- 🏠 [Truework](https://www.truework.com)\n- 👷‍♀️ [Careers](https://www.truework.com/careers)\n\n# Getting Started\n\n```bash\nnpm i @truework/sdk --save\n```\n\n```ts\nconst { truework } = require('@truework/sdk');\n\nconst client = truework({ token: TRUEWORK_ACCESS_TOKEN });\n```\n\nBy default, the SDK will use the latest version of our API. To request a\ndifferent version, pass it when configuring your client.\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n version: '2019-10-15',\n});\n```\n\nTo set a timeout on requests, pass in the timeout value in milliseconds when configuring the client. If a request times\nout, it will abort with [got.TimeoutError](https://www.npmjs.com/package/got#gottimeouterror). Most applicable when\nused in conjunction with [synchronous creation of verifications](#verificationscreateparams-syncparams).\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n timeout: 6000,\n});\n```\n\nTo use the SDK to call the Truework Sandbox, configure the client for the sandbox environment.\n\n```ts\nconst { truework, ENVIRONMENT } = require('@truework/sdk');\n\nconst client = truework({\n token: TRUEWORK_SANDBOX_TOKEN,\n environment: ENVIRONMENT.SANDBOX,\n});\n```\n\n# Terminology\n\nPlease review the [API Documentation](https://www.truework.com/docs/api) for all\nterminology. If you're using Typescript, have a look at the\n[types](https://github.com/truework/truework-sdk-node/blob/master/lib/types.ts).\n\n# Usage\n\nAll requests are made using [got](https://github.com/sindresorhus/got), and so\nresponses implement a got\n[response](https://github.com/sindresorhus/got#response) object.\n\n```ts\nconst {\n body: { count, results },\n} = await client.verifications.get();\n```\n\n## Verifications\n\n### `verifications.get([params])`\n\n**Request**\n\n- `params` - `object` - optional\n - `state` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Verification`s.\n\n**Example**\n\n```ts\nawait client.verifications.get();\nawait client.verifications.get({ limit: 10 });\n```\n\n### `verifications.getOne(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n\n**Response**\n\nReturns a `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.getOne({ id: 'abc123' });\n```\n\n### `verifications.create(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `type` - `VerificationType` - required\n - `permissible_purpose` - `PermissiblePurpose` - required\n - `target` - `Target` - required\n - `documents` - `Document`\n - `additional_information` - `string`\n\n**Response**\n\nReturns the full `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.create({\n type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n});\n```\n\n### `verifications.create(params, syncParams)`\n\nExecutes the request synchronously, attempting to return the completed verification rather than sending a webhook on\ncompletion. It is recommended to use the [client](#getting-started) `timeout` param in conjunction with this method.\n\n**Request**\n\n- `params` - `object` - required\n - `type` - `VerificationType` - required\n - `permissible_purpose` - `PermissiblePurpose` - required\n - `target` - `Target` - required\n - `documents` - `Document`\n - `additional_information` - `string`\n- `syncParams` - `object`\n - `strategy` - `RequestSyncStrategy`\n\n**Response**\n\nReturns the full `Verification` object, with `reports` if successful.\n\n**Example**\n\n```ts\nconst {\n truework,\n REQUEST_SYNC_STRATEGIES,\n VERIFICATION_TYPES,\n PERMISSIBLE_PURPOSES,\n} = require('@truework/sdk');\n\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n timeout: 6000,\n});\n\nconst res = await client.verifications.create(\n {\n type: VERIFICATION_TYPES.EMPLOYMENT,\n permissible_purpose: PERMISSIBLE_PURPOSES.EMPLOYMENT,\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n date_of_birth: '1990-09-26',\n },\n additional_information: 'Lorem ipsum dolor...',\n },\n {\n strategy: REQUEST_SYNC_STRATEGIES.SYNC,\n }\n);\n\nif (res.body.reports?.length) {\n // verification completed synchronously\n}\n```\n\n### `verifications.cancel(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n - `cancellationReason` - `CancellationReason` - required\n - `cancellationDetails` - `string`\n\n**Response**\n\nReturns status code `200` on success.\n\n**Example**\n\n```ts\nawait client.verifications.cancel({\n id: 'abc123',\n cancellationReason: 'other',\n});\n```\n\n### `verifications.reverify(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required\n - `report_id` - `string` - required\n\n**Response**\n\nReturns the full `Verification` object.\n\n**Example**\n\n```ts\nawait client.verifications.reverify({\n id: 'abc123',\n rerport_id: 'def123',\n});\n```\n\n### `verifications.getReport(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `id` - `string` - required, the ID of the Verification\n\n**Response**\n\nReturns the full `Report` object associated with the Verification.\n\n**Example**\n\n```ts\nawait client.verifications.getReport({ id: 'abc123' });\n```\n\n## Companies\n\n### `companies.get(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `query` - `string` - required\n - `limit` - `number`\n - `offset` - `number`\n\n**Response**\n\nReturns a `PaginatedResponse` containing an array of `Company`s.\n\n**Example**\n\n```ts\nawait client.companies.get({ query: 'USWNT' });\n```\n\n## Credentials\n\n### `credentials.createSession(params)`\n\n**Request**\n\n- `params` - `object` - required\n - `type` - `VerificationType` - required\n - `permissible_purpose` - `PermissiblePurpose` - required\n - `use_case` - `UseCase` - required\n - `target` - `Target` - required\n\n**Response**\n\nReturns a `CredentialsSession`\n\n**Example**\n\n```ts\nawait client.credentials.createSession({\n type: 'employment',\n permissible_purpose: 'employment',\n use_case: 'mortgage',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n date_of_birth: '2020-02-02',\n company: {\n name: 'USWNT',\n },\n },\n});\n```\n\n# Testing\n\nThis SDK provides a naive \"mock\" mode that can be used for basic testing during\nCI, etc. It is _stateless_, meaning no data is persisted between API calls. When\nenabled, each SDK method will either return stub objects, or simple reflections\nof the data submitted.\n\nTo enable mock mode, initialize your SDK client like this:\n\n```ts\nconst client = truework({\n token: TRUEWORK_ACCESS_TOKEN,\n mock: true,\n});\n```\n\n## Verification Mocks\n\n### `verifications.get`\n\nReturns a stubbed array of verifications, respective of all query params.\n\n```ts\nconst res = await client.verifications.get({ state: 'processing', limit: 5 });\n\nres.body.results.length; // => 5\nres.body.results[0].state; // => processing\n```\n\n### `verifications.getOne`\n\nReturns a stubbed verification object with the same `id` as is passed to\n`getOne({ id })`.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger a `404` error\nresponse.\n\n```ts\ntry {\n await client.verifications.getOne({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.create`\n\nReturns a stubbed verification object.\n\n#### Error States\n\nTo trigger an error response, do not pass a `type` property.\n\n```ts\ntry {\n await client.verifications.create(\n // type: 'employment',\n permissible_purpose: 'employment',\n target: {\n first_name: 'Megan',\n last_name: 'Rapinoe',\n social_security_number: '123121234',\n company: {\n name: 'USWNT',\n },\n },\n additional_information: 'Lorem ipsum dolor...',\n })\n} catch (e) {\n console.log(e.response) // error response body\n}\n```\n\n### `verifications.cancel`\n\nReturns `200` if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.cancel({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n### `verifications.getReport`\n\nReturns a stubbed report object if successful.\n\n#### Error States\n\nAny `id` value is valid, except `\"AAAA\"`, which will trigger an error response.\n\n```ts\ntry {\n await client.verifications.getReport({ id: 'AAAA' });\n} catch (e) {\n console.log(e.response); // error response body\n}\n```\n\n## Company Mocks\n\n### `companies.get`\n\nReturns a stubbed array of companies, respective of `limit` and `offset` query\nparams.\n\n```ts\nconst res = await client.companies.get({ limit: 5 });\n\nres.body.results.length; // => 5\n```\n\n## Contributing\n\n### Issues\n\nIf you run into problems, or simply have a question, feel free to [open an\nissue](https://github.com/truework/truework-sdk-node/issues/new)!\n\n### Commiting\n\nThis repo uses [commitizen](https://github.com/commitizen/cz-cli) to nicely\nformat commit messages. Upon making edits, stage your changes and simply run\n`git commit` to enter the commitizen UI in your terminal.\n\n**Note:** if you are not prompted with the commitizen UI, run `npm ci` to re-install\nand run `postinstall` hooks to set it up.\n\n### Releases\n\nThis project is versioned and published automatically using\n[semantic-release](https://github.com/semantic-release/semantic-release). Via a\nGitHub Action, `semantic-release` will use the commit message pattern provided\nby `commitizen` to automatically version the package. It will then publish to\nnpm, as well as create a new\n[release](https://github.com/truework/truework-sdk-node/releases) here in the\nmain repo.\n\n**Do not publish this library manually from the command line.**\n\n## License\n\nMIT License © [Truework](https://truework.com)\n","readmeFilename":"README.md"}