{"_id":"@cookd/harvest-sdk","_rev":"2-1b67d5c3f743bdb6d4ae30800aae7eba","name":"@cookd/harvest-sdk","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@cookd/harvest-sdk","version":"1.0.0","keywords":["greenhouse","harvest","api","sdk","typescript"],"author":{"name":"Cookd Engineering"},"license":"MIT","_id":"@cookd/harvest-sdk@1.0.0","maintainers":[{"name":"alialobaidi","email":"alinawar2000@gmail.com"}],"homepage":"https://github.com/cookd-eng/greenhouse-harvest-sdk#readme","bugs":{"url":"https://github.com/cookd-eng/greenhouse-harvest-sdk/issues"},"dist":{"shasum":"c51497ecb291ae0c1123c499187a54f51e767f43","tarball":"https://registry.npmjs.org/@cookd/harvest-sdk/-/harvest-sdk-1.0.0.tgz","fileCount":21,"integrity":"sha512-kclKh1yB5c9ZHLLoqoq+iB/hjH/FsP/78M2IWCwYhn95FDIMwQBNrXyrggZdpog3KUDW0BKBZW6dklfgSXeIDA==","signatures":[{"sig":"MEUCIQDOH1JnB0JRz3UthLgxUdquoI3jzJpvsxtwUWsSziJEVgIgH/Q4giSHykaFv9El7DtlVHyRzyk41o+bpK/CLmD9p/I=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":78974},"main":"lib/index.js","types":"lib/index.d.ts","gitHead":"2f7a5bfe21ff2c7d5dc7ed4999706a9cc570855c","scripts":{"build":"tsc","prepublishOnly":"npm run build"},"_npmUser":{"name":"alialobaidi","email":"alinawar2000@gmail.com"},"repository":{"url":"git+https://github.com/cookd-eng/greenhouse-harvest-sdk.git","type":"git"},"_npmVersion":"9.6.4","description":"SDK for interacting with the Greenhouse Harvest API","directories":{"lib":"lib"},"_nodeVersion":"20.0.0","dependencies":{"lib":"^5.1.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-jest":"^29.0.0","typescript":"^5.5.4","@types/node":"^22.2.0"},"peerDependencies":{"axios":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/harvest-sdk_1.0.0_1723590160146_0.15933108886644476","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@cookd/harvest-sdk","version":"1.0.1","description":"SDK for interacting with the Greenhouse Harvest API","main":"lib/index.js","types":"lib/index.d.ts","scripts":{"build":"tsc","prepublishOnly":"npm run build"},"keywords":["greenhouse","harvest","api","sdk","typescript"],"author":{"name":"Cookd Engineering"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/cookd-eng/greenhouse-harvest-sdk.git"},"bugs":{"url":"https://github.com/cookd-eng/greenhouse-harvest-sdk/issues"},"homepage":"https://github.com/cookd-eng/greenhouse-harvest-sdk#readme","devDependencies":{"@types/node":"^22.2.0","ts-jest":"^29.0.0","typescript":"^5.5.4"},"peerDependencies":{"axios":"^1.0.0"},"dependencies":{"lib":"^5.1.0"},"directories":{"lib":"lib"},"gitHead":"613a55810affa36e1825574a684f009879ed47e5","_id":"@cookd/harvest-sdk@1.0.1","_nodeVersion":"20.0.0","_npmVersion":"9.6.4","dist":{"integrity":"sha512-ccPLFoI4gnIWpCe+QgbPpJ8dGBFcW7PuToh3CUIwLLtTZM9iqTgY6ii+5r99t5nMHdZH0Y7eoZj2MacJiFc89g==","shasum":"1c82b718a97bd4958e6ef257e143e83d8a4ae579","tarball":"https://registry.npmjs.org/@cookd/harvest-sdk/-/harvest-sdk-1.0.1.tgz","fileCount":28,"unpackedSize":114574,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCtgIZ9ncKpqoQ7HCeKNtHIFOJ/O9QpI3YoGnou/LU4uwIhAJlmgXWfY63T4ZO53oR7eEndnQz7Mqg8TwaCH2mcpLRq"}]},"_npmUser":{"name":"alialobaidi","email":"alinawar2000@gmail.com"},"maintainers":[{"name":"alialobaidi","email":"alinawar2000@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/harvest-sdk_1.0.1_1723736406560_0.38818161401651485"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-13T23:02:40.145Z","modified":"2024-08-15T15:40:06.876Z","1.0.0":"2024-08-13T23:02:40.334Z","1.0.1":"2024-08-15T15:40:06.681Z"},"bugs":{"url":"https://github.com/cookd-eng/greenhouse-harvest-sdk/issues"},"author":{"name":"Cookd Engineering"},"license":"MIT","homepage":"https://github.com/cookd-eng/greenhouse-harvest-sdk#readme","keywords":["greenhouse","harvest","api","sdk","typescript"],"repository":{"type":"git","url":"git+https://github.com/cookd-eng/greenhouse-harvest-sdk.git"},"description":"SDK for interacting with the Greenhouse Harvest API","maintainers":[{"name":"alialobaidi","email":"alinawar2000@gmail.com"}],"readme":"\n# Greenhouse Harvest SDK\n\n## Description\n\nThe Greenhouse Harvest SDK is a TypeScript library for interacting with the Greenhouse Harvest API. It provides an easy-to-use interface for managing candidates, applications, custom fields, and more within your Greenhouse recruitment system.\n\n## Installation\n\nTo install the Greenhouse Harvest SDK, use npm:\n\n```bash\nnpm install @cookd/harvest-sdk\n```\n\n## Usage\n\nFirst, import the SDK and create an instance:\n\n```typescript\nimport GreenhouseHarvestSDK from '@cookd/harvest-sdk';\n\nconst sdk = new GreenhouseHarvestSDK('your-api-key');\n```\n\n### Examples\n\n#### Working with Applications\n\n```typescript\n// List applications\nconst applications = await sdk.applications.listApplications('user-id', { per_page: 10 });\n\n// Get a specific application\nconst application = await sdk.applications.getApplication('user-id', 12345);\n\n// Add an application\nconst newApplication = await sdk.applications.addApplication('user-id', 67890, {\n  job_id: 54321,\n  prospect: false\n});\n\n// Update an application\nconst updatedApplication = await sdk.applications.updateApplication('user-id', 12345, {\n  source_id: 100\n});\n```\n\n#### Working with Candidates\n\n```typescript\n// List candidates\nconst candidates = await sdk.candidates.listCandidates({ per_page: 20 });\n\n// Get a specific candidate\nconst candidate = await sdk.candidates.getCandidate(12345);\n\n// Add a candidate\nconst newCandidate = await sdk.candidates.addCandidate({\n  first_name: 'John',\n  last_name: 'Doe',\n  email_addresses: [{ value: 'john.doe@example.com', type: 'personal' }]\n});\n\n// Update a candidate\nconst updatedCandidate = await sdk.candidates.updateCandidate(12345, {\n  company: 'New Company Inc.'\n});\n```\n\n#### Working with Custom Fields\n\n```typescript\n// List custom fields\nconst customFields = await sdk.customFields.listCustomFields('job', 'user-id');\n\n// Get a specific custom field\nconst customField = await sdk.customFields.getCustomField(12345, 'user-id');\n\n// Create a custom field\nconst newCustomField = await sdk.customFields.createCustomField({\n  name: 'New Custom Field',\n  field_type: 'candidate',\n  value_type: 'short_text'\n}, 'user-id');\n\n// Update a custom field\nconst updatedCustomField = await sdk.customFields.updateCustomField(12345, {\n  name: 'Updated Custom Field'\n}, 'user-id');\n```\n\n## API Reference\n\nThe SDK is divided into several modules:\n\n- `applications`: Methods for managing job applications\n- `candidates`: Methods for managing candidates\n- `customFields`: Methods for managing custom fields\n\nEach module contains methods that correspond to Greenhouse Harvest API endpoints. For full details on available methods and their parameters, please refer to the source code or generated TypeScript definitions.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License.","readmeFilename":"README.md"}