Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
myinterview
Advanced tools
myinterview - npm Package Compare versions
Comparing version 1.2.8 to 1.2.9
| { | ||
| "name": "myinterview", | ||
| "version": "1.2.008", | ||
| "version": "1.2.009", | ||
| "description": "Build and integrate myInterview with ease via our node.js npm package and connect to the myInterview API.", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
206
README.md
@@ -572,105 +572,3 @@ # MyInterview-node # | ||
| ## Companies | ||
| ```js | ||
| const { Companies } = require('myinterview') | ||
| ``` | ||
| #### Description | ||
| The Company Model consolidates all information about your company, making it an excellent starting point for retrieving your company's details in JSON format using the `getCompanyInfo` API endpoint. | ||
| Additionally, you can set up templates to avoid rewriting questions repeatedly. Simply use the template_id when creating a job. For an example, refer to the Job Model section. | ||
| > **Note**: You can also configure templates within the myInterview dashboard and reuse them by calling the `getCompanyTemplates` API endpoint. | ||
| ### getCompanyInfo | ||
| ```ts | ||
| const res = await Companies.getCompanyInfo(); | ||
| const companyInfo = res.data; | ||
| ``` | ||
| ### getCompanyTemplates | ||
| Returns an array of job questionnaire templates. | ||
| ```ts | ||
| const res = await Companies.getCompanyTemplates(); | ||
| const templates = res.data; | ||
| ``` | ||
| ### createCompanyTemplateBulk | ||
| Create job questionnaire templates. These questions will be displayed to the candidates when they apply during the video recording session. | ||
| ```ts | ||
| const body = [{ | ||
| id: "template_id", | ||
| name: "template_name", | ||
| questions: [{ | ||
| numOfRetakes: 1, | ||
| partDuration: 30, | ||
| question: "How are you today?" | ||
| }], | ||
| introVideo: 'youtube.com/watch' | ||
| }, | ||
| { | ||
| id: "template_id", | ||
| name: "template_name", | ||
| questions: [{ | ||
| numOfRetakes: 1, | ||
| partDuration: 30, | ||
| question: "How are you today?", | ||
| description: "This is a description", | ||
| thinkingTime: 30 | ||
| }], | ||
| introVideo: 'youtube.com/watch' | ||
| }] | ||
| await Companies.createCompanyTemplateBulk(body); | ||
| ``` | ||
| ### createCompanyTemplateBulk Params | ||
| | Field | Type | Description | | ||
| | --- | --- |-------------------------------------------------------| | ||
| | *id | string | ID of the company template | | ||
| | hideQuestions | boolean | questions will not be displayed upfront | | ||
| | *name | string | Name of the template | | ||
| | introVideo | string | Url of the introduction video on the application page | | ||
| | *questions | Array of job questions | Array of job questions objects | | ||
| *required field | ||
| ### updateCompanyTemplate | ||
| ```ts | ||
| const body = { | ||
| id: "template_id", | ||
| name: "template_name", | ||
| questions: [{ | ||
| numOfRetakes: 1, | ||
| partDuration: 30, | ||
| question: "How are you today?", | ||
| description: "This is a description", | ||
| thinkingTime: 30 | ||
| }], | ||
| introVideo: 'youtube.com/watch' | ||
| }; | ||
| await Companies.updateCompanyTemplate(body); | ||
| ``` | ||
| ### updateCompanyTemplate Params | ||
| | Field | Type | Description | | ||
| | --- | --- |-------------------------------------------------------| | ||
| | *id | string | ID of the company template | | ||
| | hideQuestions | boolean | questions will not be displayed upfront | | ||
| | name | string | Name of the template | | ||
| | introVideo | string | Url of the introduction video on the application page | | ||
| | *questions | Array of job questions | Array of job questions objects | | ||
| *required field | ||
| ## Videos | ||
@@ -815,2 +713,106 @@ ```js | ||
| ## Companies | ||
| ```js | ||
| const { Companies } = require('myinterview') | ||
| ``` | ||
| #### Description | ||
| The Company Model consolidates all information about your company, making it an excellent starting point for retrieving your company's details in JSON format using the `getCompanyInfo` API endpoint. | ||
| Additionally, you can set up templates to avoid rewriting questions repeatedly. Simply use the template_id when creating a job. For an example, refer to the Job Model section. | ||
| > **Note**: You can also configure templates within the myInterview dashboard and reuse them by calling the `getCompanyTemplates` API endpoint. | ||
| ### getCompanyInfo | ||
| ```ts | ||
| const res = await Companies.getCompanyInfo(); | ||
| const companyInfo = res.data; | ||
| ``` | ||
| ### getCompanyTemplates | ||
| Returns an array of job questionnaire templates. | ||
| ```ts | ||
| const res = await Companies.getCompanyTemplates(); | ||
| const templates = res.data; | ||
| ``` | ||
| ### createCompanyTemplateBulk | ||
| Create job questionnaire templates. These questions will be displayed to the candidates when they apply during the video recording session. | ||
| ```ts | ||
| const body = [{ | ||
| id: "template_id", | ||
| name: "template_name", | ||
| questions: [{ | ||
| numOfRetakes: 1, | ||
| partDuration: 30, | ||
| question: "How are you today?" | ||
| }], | ||
| introVideo: 'youtube.com/watch' | ||
| }, | ||
| { | ||
| id: "template_id", | ||
| name: "template_name", | ||
| questions: [{ | ||
| numOfRetakes: 1, | ||
| partDuration: 30, | ||
| question: "How are you today?", | ||
| description: "This is a description", | ||
| thinkingTime: 30 | ||
| }], | ||
| introVideo: 'youtube.com/watch' | ||
| }] | ||
| await Companies.createCompanyTemplateBulk(body); | ||
| ``` | ||
| ### createCompanyTemplateBulk Params | ||
| | Field | Type | Description | | ||
| | --- | --- |-------------------------------------------------------| | ||
| | *id | string | ID of the company template | | ||
| | hideQuestions | boolean | questions will not be displayed upfront | | ||
| | *name | string | Name of the template | | ||
| | introVideo | string | Url of the introduction video on the application page | | ||
| | *questions | Array of job questions | Array of job questions objects | | ||
| *required field | ||
| ### updateCompanyTemplate | ||
| ```ts | ||
| const body = { | ||
| id: "template_id", | ||
| name: "template_name", | ||
| questions: [{ | ||
| numOfRetakes: 1, | ||
| partDuration: 30, | ||
| question: "How are you today?", | ||
| description: "This is a description", | ||
| thinkingTime: 30 | ||
| }], | ||
| introVideo: 'youtube.com/watch' | ||
| }; | ||
| await Companies.updateCompanyTemplate(body); | ||
| ``` | ||
| ### updateCompanyTemplate Params | ||
| | Field | Type | Description | | ||
| | --- | --- |-------------------------------------------------------| | ||
| | *id | string | ID of the company template | | ||
| | hideQuestions | boolean | questions will not be displayed upfront | | ||
| | name | string | Name of the template | | ||
| | introVideo | string | Url of the introduction video on the application page | | ||
| | *questions | Array of job questions | Array of job questions objects | | ||
| *required field | ||
| ## Shares | ||
@@ -817,0 +819,0 @@ ```js |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Manifest confusion
Supply chain riskThis package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Manifest confusion
Supply chain riskThis package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
112705
- Number of lines in readme file
- increased by0.2%
981
No dependency changes