{"_id":"fatfinger-sdk","_rev":"48-412a5995a709ed6ff3b88c643c28da5f","name":"fatfinger-sdk","dist-tags":{"latest":"1.0.26"},"versions":{"1.0.25":{"name":"fatfinger-sdk","version":"1.0.25","author":"","license":"ISC","_id":"fatfinger-sdk@1.0.25","maintainers":[{"name":"fatfinger","email":"craig@fatfinger.io"}],"dist":{"shasum":"20e7da0f2fff076638f4b62a8a1b22d1f6df3cd4","tarball":"https://registry.npmjs.org/fatfinger-sdk/-/fatfinger-sdk-1.0.25.tgz","fileCount":11,"integrity":"sha512-Cv9PqdBBYDYsze0ev3bYHuRnNOpZllo/aUNMgDAp5uH6/0vHnlcUhto7uakKCxAeXKbVNQkwwKwzsmXQgWDSiA==","signatures":[{"sig":"MEUCIByaW5VyDnPFw81KMrQY8M96HmXKMaxoGMcN9ff9ZVZlAiEAv44XnZJK/asCQalXBjAtIRBQxoxl66pw8GAibud0biI=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":18278},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"ff099bb0a2409a407b249ee8add1e8dd40f41520","scripts":{"prod":"ts-node ./src/test_prod.ts","test":"ts-node ./src/test.ts","build":"tsc","npm:publish":"npm run build && npm publish --access public","npm:version:patch":"npm version patch"},"_npmUser":{"name":"fatfinger","email":"craig@fatfinger.io"},"_npmVersion":"9.8.1","description":"`fatfinger-sdk` is a Node.js module that provides easy integration with the FatFinger API. It allows developers to quickly implement FatFinger functionalities in their applications.","directories":{},"_nodeVersion":"18.18.2","dependencies":{"axios":"^1.7.7","ts-node":"^10.9.2","typescript":"^5.6.3"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/fatfinger-sdk_1.0.25_1737751853654_0.22000106587264634","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"1.0.26":{"name":"fatfinger-sdk","version":"1.0.26","author":"","license":"ISC","_id":"fatfinger-sdk@1.0.26","maintainers":[{"name":"fatfinger","email":"craig@fatfinger.io"}],"dist":{"shasum":"7d0afaada59704a34a382b63e1dd192b8d0f08d5","tarball":"https://registry.npmjs.org/fatfinger-sdk/-/fatfinger-sdk-1.0.26.tgz","fileCount":11,"integrity":"sha512-jVg0whBt3jQ1sML9LHUsABrghrU7QOMdX4HCuADRmIwR1I/eAMSrhBoPDexqXx5r7A5Tq6rrrx5OldivW0xC7g==","signatures":[{"sig":"MEYCIQCOPQ9u27lndNbA4ndh0j4Ymytf9zWUckhtqr6Z36v1SgIhANQNog+g0PSMG3MlcsLy/Zwtei3/Uy/JDvpdMcOhk+La","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":18209},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"a0cdad6760222e7bd3bbe49b7d97685488d1f4bd","scripts":{"prod":"ts-node ./src/test_prod.ts","test":"ts-node ./src/test.ts","build":"tsc","npm:publish":"npm run build && npm publish --access public","npm:version:patch":"npm version patch"},"_npmUser":{"name":"fatfinger","email":"craig@fatfinger.io"},"_npmVersion":"9.8.1","description":"`fatfinger-sdk` is a Node.js module that provides easy integration with the FatFinger API. It allows developers to quickly implement FatFinger functionalities in their applications.","directories":{},"_nodeVersion":"18.18.2","dependencies":{"axios":"^1.7.7","ts-node":"^10.9.2","typescript":"^5.6.3"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/fatfinger-sdk_1.0.26_1740670532009_0.3861347348288904","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2025-01-24T20:50:53.546Z","modified":"2025-03-07T18:12:24.750Z","1.0.0":"2024-11-21T22:34:11.096Z","1.0.1":"2024-11-21T22:56:30.043Z","1.0.2":"2024-11-21T23:10:53.442Z","1.0.3":"2024-11-21T23:11:52.620Z","1.0.4":"2024-11-21T23:14:02.734Z","1.0.5":"2024-11-21T23:15:41.456Z","1.0.6":"2024-11-21T23:15:46.028Z","1.0.7":"2024-11-21T23:15:50.760Z","1.0.8":"2024-11-21T23:15:55.292Z","1.0.9":"2024-11-21T23:15:59.941Z","1.0.10":"2024-11-21T23:17:21.666Z","1.0.11":"2024-11-22T00:24:29.188Z","1.0.12":"2024-11-22T00:31:20.545Z","1.0.13":"2024-11-22T00:36:30.127Z","1.0.14":"2024-11-22T00:39:05.138Z","1.0.15":"2024-11-22T00:40:46.182Z","1.0.16":"2024-11-22T00:42:13.357Z","1.0.17":"2024-11-22T01:07:06.792Z","1.0.19":"2024-12-09T15:28:47.571Z","1.0.21":"2024-12-26T17:02:50.828Z","1.0.23":"2025-01-23T14:41:13.750Z","1.0.24":"2025-01-23T14:49:03.027Z","1.0.22":"2025-01-23T14:50:46.606Z","1.0.25":"2025-01-24T20:50:53.822Z","1.0.26":"2025-02-27T15:35:32.188Z"},"license":"ISC","description":"`fatfinger-sdk` is a Node.js module that provides easy integration with the FatFinger API. It allows developers to quickly implement FatFinger functionalities in their applications.","maintainers":[{"name":"fatfinger","email":"craig@fatfinger.io"}],"readme":"# FatFinger SDK\n\n`fatfinger-sdk` is a Node.js module that provides easy integration with the FatFinger API. It allows developers to quickly implement FatFinger functionalities in their applications.\n\n## Installation\n\nInstall `fatfinger-sdk` using npm:\n\n```bash\nnpm install fatfinger-sdk\n```\n\nor\n\n```bash\nyarn add fatfinger-sdk\n```\n\n## Importing\n\nFirst, import the FatFingerClient from `fatfinger-sdk`:\n\n```typescript\n// CommonJS import\nconst { FatFingerClient } = require('fatfinger-sdk');\n\n// or using ES6 imports\nimport { FatFingerClient } from 'fatfinger-sdk';\n```\n\n## Creating an Instance\n\nCreate an instance of FatFingerClient by providing your API key:\n\n```typescript\nconst apiKey: string = 'your-api-key';\nconst userName: string = 'a valid fatfinger users email'\nconst companyId: string = 'valid fatfinger company id'\n\nconst client: FatFingerClient = new FatFingerClient(apiKey userName,compnayId);\n```\n\n## Making API Calls\n\nYou can now use the client to perform operations. For example, to retrieve a list of reports.\n\nNote that a datetime is required and is used to filter on how far back to pull reports.  this date is matched on reports that were added or updated on or after the date used.  This is useful in returning all reports added or modified since the last sync time. \n\n```typescript\n\n  const lastSyncTime = '2024-11-15T15:02:07.801Z';\n\n  const reports = await client.getReports(new Date(lastSyncTime));\n\n  // save the last time we ran as a utc string\n  const newLastSyncTime = new Date();\n  console.log('lastSyncTime:', newLastSyncTime.toISOString());\n\n\n  // loop through reports and find a specfic data for unique form field. \n  for (const report of reports) {\n    const reportItem = client.getItemsByFieldId(\n      report,\n      '12345678-142f-4746-9c26-713e17fd6f10',\n    );\n    if (reportItem) {\n      console.log(\n        report.Title,\n        // report.ReportItems.length,\n        // reportItem,\n        reportItem.FormFields.Label,\n        client.getItemValueAsString(reportItem),\n        // report.ReportItems[6].Field_ID,\n      );\n    } else {\n      console.log('reportItem is null');\n    }\n  }\n\n  const forms: Form[] = await client.getForms();\n  for (const form of forms) {\n    console.log(form.FormName, form.ID);\n  }\n\n  // discover your form names and ID's\n  await client.logFormNames();\n\n  // discover your form fields and ID's for a given form\n  await client.logFormFields('12345678-775a-4ce6-b586-b8ebf5f56970');\n\n\n\n```\n","readmeFilename":"README.md"}