{"_id":"@byteraven/screening-ai","_rev":"2-3b1d24bd37b9a03847a43a6d77dd2deb","name":"@byteraven/screening-ai","dist-tags":{"latest":"0.1.2"},"versions":{"0.1.0":{"name":"@byteraven/screening-ai","version":"0.1.0","keywords":["screening","ai","api"],"author":{"name":"akshit@byteraven.ai"},"license":"MIT","_id":"@byteraven/screening-ai@0.1.0","maintainers":[{"name":"akshitmadan","email":"akshit@byteraven.ai"}],"dist":{"shasum":"3a501655e9a7b033321bd04b3150f2cc098eebf9","tarball":"https://registry.npmjs.org/@byteraven/screening-ai/-/screening-ai-0.1.0.tgz","fileCount":80,"integrity":"sha512-CpBFiFqlYsn/QokxEYNy9qGdD0avLS7++lRrmv2M3RXlTUkijHhhItaveddmQ2DO8W/pIzr1O087f+HjTVTUZw==","signatures":[{"sig":"MEYCIQDrNTq9sCCMMDPjAUJw2wQaCWgAKDTueKce40KAsCJ9/wIhAN1kbIGK/pD3T1O5L5pskOZrT/CLoglyf7G4q66QNHyI","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":322059},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"692a028b6b7914d686bc48050d9f2a912c4a4223","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc"},"_npmUser":{"name":"akshitmadan","email":"akshit@byteraven.ai"},"_npmVersion":"10.7.0","description":"A TypeScript SDK for the Screening AI API","directories":{},"_nodeVersion":"20.15.0","dependencies":{"axios":"^1.5.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/screening-ai_0.1.0_1737730962877_0.7708287626980699","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@byteraven/screening-ai","version":"0.1.1","keywords":["screening","ai","api"],"author":{"name":"akshit@byteraven.ai"},"license":"MIT","_id":"@byteraven/screening-ai@0.1.1","maintainers":[{"name":"akshitmadan","email":"akshit@byteraven.ai"}],"dist":{"shasum":"c03a932e4467533279aa442371d915e4e04c8d74","tarball":"https://registry.npmjs.org/@byteraven/screening-ai/-/screening-ai-0.1.1.tgz","fileCount":80,"integrity":"sha512-xfutdbd8aOmTDjCxz0j5iIAnn+C8OkYMQf49znKUyhvVcKsMZRZJRNhkBDtBy275LWA/j31quVKrMjw1G2Jz9A==","signatures":[{"sig":"MEYCIQD8kdUpjiGt5nCHnAW/02LAhV9yCNSGB21u9mX0AEs2SgIhALXGu1rNd9PzmHdBRdwF++fB0ROtRvos3bxpgCDn6sR+","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":326890},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"8a66ebe3df7d752fcdd9e918d563a7dfa934fc90","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc"},"_npmUser":{"name":"akshitmadan","email":"akshit@byteraven.ai"},"_npmVersion":"10.7.0","description":"A TypeScript SDK for the Screening AI API","directories":{},"_nodeVersion":"20.15.0","dependencies":{"axios":"^1.5.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/screening-ai_0.1.1_1737731636960_0.6953265548744036","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@byteraven/screening-ai","version":"0.1.2","description":"A TypeScript SDK for the Screening AI API","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc","test":"echo 'No tests yet'"},"repository":{"type":"git","url":"git+https://github.com/Resumepal/screening_ai_node.git"},"bugs":{"url":"https://github.com/Resumepal/screening_ai_node/issues"},"homepage":"https://github.com/Resumepal/screening_ai_node#readme","keywords":["screening","ai","api"],"author":{"name":"akshit@byteraven.ai"},"license":"MIT","dependencies":{"axios":"^1.5.0"},"devDependencies":{"typescript":"^5.0.0"},"_id":"@byteraven/screening-ai@0.1.2","gitHead":"bdf010ab1abd76915feb57871010d894ca11cd77","_nodeVersion":"18.20.5","_npmVersion":"10.8.2","dist":{"integrity":"sha512-p3lY6qpNzOrrs3o8KJwhGDRftOR0EqBx9RnYT9d113kd7sWkDZL2wfinej80X7aXLdnKMQI3Ko+7sZFEJCgWug==","shasum":"05a3740ef6f2b0f0cebebe8239e79b43bbf04912","tarball":"https://registry.npmjs.org/@byteraven/screening-ai/-/screening-ai-0.1.2.tgz","fileCount":44,"unpackedSize":178100,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIA8D87DtDqtiHMOtMuIl7m0lKMUGYU4kLpLMEYutf7wHAiEA4z4xa9ZJdhSIws1BgQfJy9HhyCPtmX6U9/VMhDqiI2Q="}]},"_npmUser":{"name":"akshitmadan","email":"akshit@byteraven.ai"},"directories":{},"maintainers":[{"name":"akshitmadan","email":"akshit@byteraven.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/screening-ai_0.1.2_1737736384466_0.05219269589980624"},"_hasShrinkwrap":false}},"time":{"created":"2025-01-24T15:02:42.776Z","modified":"2025-01-24T16:33:04.903Z","0.1.0":"2025-01-24T15:02:43.062Z","0.1.1":"2025-01-24T15:13:57.200Z","0.1.2":"2025-01-24T16:33:04.667Z"},"author":{"name":"akshit@byteraven.ai"},"license":"MIT","keywords":["screening","ai","api"],"description":"A TypeScript SDK for the Screening AI API","maintainers":[{"name":"akshitmadan","email":"akshit@byteraven.ai"}],"readme":"# Screening AI Typescript API Client\n\n[![npm version](https://img.shields.io/npm/v/@byteraven/screening-ai.svg)](https://www.npmjs.com/package/@byteraven/screening-ai)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n[![CI/CD Pipeline](https://github.com/Resumepal/screening_ai_node/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/Resumepal/screening_ai_node/actions/workflows/ci-cd.yml)\n\nThe `ScreeningAI` client SDK is a powerful and user-friendly TypeScript library designed to interact with the ScreeningAI platform. It provides seamless integration with APIs for managing screening jobs, templates, and submissions, making it easy to build and scale HR and talent management solutions.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [API Documentation](#api-documentation)\n - [Screening Jobs API](#screening-jobs-api)\n - [Screening Templates API](#screening-templates-api)\n - [Screening Submissions API](#screening-submissions-api)\n- [Error Handling](#error-handling)\n- [Contributing](#contributing)\n- [License](#license)\n\n---\n\n## Features\n\n- **Screening Jobs Management**: Create, retrieve, and manage screening jobs for your organization.\n- **Screening Templates**: Design and manage reusable screening templates.\n- **Screening Submissions**: Manage submissions, convert audio to text, and create stream rooms for live interviews.\n- **Built-in Error Handling**: Clear error messages and exceptions for a smooth developer experience.\n\n---\n\n## Installation\n\nInstall the library via npm or yarn:\n\n```bash\nnpm install screening-ai-sdk\n```\n\nor\n\n```bash\nyarn add screening-ai-sdk\n```\n\n---\n\n## Getting Started\n\nFollow these steps to set up and use the ScreeningAI client in your project:\n\n### 1. Import the SDK\n\n```typescript\nimport { ScreeningAI } from \"screening-ai-sdk\";\n```\n\n### 2. Initialize the Client\n\nCreate an instance of the `ScreeningAI` class with your API key:\nNote - You can keep basePath empty if you are using ByteRaven managed Screening Server, you can provide your own managed server URL too.\n\n```typescript\nconst screeningAI = new ScreeningAI({\n orgApiKey: \"your-organization-api-key\",\n basePath: \"https://api.your-screening-platform.com\", // Optional, defaults to an empty string\n});\n```\n\n### 3. Use the API Methods\n\nExample: Creating a screening job.\n\n```typescript\nimport { PlatformCreateScreeningJobDto } from \"screening-ai-sdk/src/models\";\n\nconst newJob: PlatformCreateScreeningJobDto = {\n title: \"Software Engineer Screening\",\n description: \"Screening job for evaluating software engineering candidates\",\n // Add other required fields here\n};\n\nasync function createJob() {\n try {\n const job = await screeningAI.createScreeningJob(newJob);\n console.log(\"Created Job:\", job);\n } catch (error) {\n console.error(\"Error:\", error.message);\n }\n}\n\ncreateJob();\n```\n\n---\n\n## API Documentation\n\n### Screening Jobs API\n\n#### Create a Screening Job\n\n```typescript\nscreeningAI.createScreeningJob(platformCreateScreeningJobDto: PlatformCreateScreeningJobDto): Promise\n```\n\nCreates a new screening job.\n\n#### Get a Screening Job by ID\n\n```typescript\nscreeningAI.getScreeningJobById(screeningJobId: string): Promise\n```\n\nFetches details of a screening job using its ID.\n\n#### Get All Screening Jobs of an Organization\n\n```typescript\nscreeningAI.getScreeningJobsOfOrg(): Promise\n```\n\nRetrieves a list of all screening jobs associated with your organization.\n\n---\n\n### Screening Templates API\n\n#### Create a Screening Template\n\n```typescript\nscreeningAI.createScreeningTemplate(createScreeningTemplateDto: CreateScreeningTemplateDto): Promise\n```\n\nCreates a reusable template for screening.\n\n#### Generate Questions for a Template\n\n```typescript\nscreeningAI.generateScreeningTemplateQuestions(generateScreeningTemplateQuestionsDto: GenerateScreeningTemplateQuestionsDto): Promise\n```\n\nGenerates a list of questions based on the template.\n\n#### Get All Screening Templates\n\n```typescript\nscreeningAI.getScreeningTemplates(): Promise\n```\n\nFetches all templates associated with your organization.\n\n---\n\n### Screening Submissions API\n\n#### Convert Audio to Text\n\n```typescript\nscreeningAI.convertAudioToText(\n orgId: string,\n screeningSubmissionId: string,\n index: number,\n file: Blob,\n fileType: string\n): Promise\n```\n\nConverts an audio file to text for a specific submission.\n\n#### Create a Screening Submission\n\n```typescript\nscreeningAI.createScreeningSubmission(createPlatformScreeningFormSubmissionDto: CreatePlatformScreeningFormSubmissionDto): Promise\n```\n\nCreates a new screening submission.\n\n#### Get Screening Submissions of an Organization\n\n```typescript\nscreeningAI.getScreeningSubmissionsOfOrg(getPlatformScreeningSubmissionsOfOrgDto: GetPlatformScreeningSubmissionsOfOrgDto): Promise\n```\n\nFetches submissions for the organization.\n\n---\n\n## Error Handling\n\nAll methods in the SDK provide built-in error handling. Errors are logged to the console with a descriptive message. Example:\n\n```typescript\ntry {\n const job = await screeningAI.createScreeningJob(newJob);\n} catch (error) {\n console.error(\"Error creating screening job:\", error.message);\n}\n```\n\n---\n\n## Contributing\n\nWe welcome contributions! Please follow the guidelines in the [CONTRIBUTING.md](CONTRIBUTING.md) file.\n\n---\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","readmeFilename":"README.md","homepage":"https://github.com/Resumepal/screening_ai_node#readme","repository":{"type":"git","url":"git+https://github.com/Resumepal/screening_ai_node.git"},"bugs":{"url":"https://github.com/Resumepal/screening_ai_node/issues"}}