@myinterview/global-api-sdk

myInterview - GlobalAPI SDK

You can see the full typed documentation here.

Prerequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
6.4.1
v8.16.0

Install

npm i @myinterview/global-api-sdk

Usage

Basic configuration

import { GlobalApi } from '@myinterview/global-api-sdk';

GlobalApi.setConfig({
  secret: 'yoursecret',
  companyId: 'yourcompanyid',
  accessKey: 'youraccesskey',
});

To use the SDK you have to set the configuration with the keys provided by myinterview prior use of the classes.

Authentication Helper for API

populateHeaders

This call will populate the headers you need to connect to the global API service it will return an object that you can use in you request.

import { GlobalApi } from '@myinterview/global-api-sdk';

GlobalApi.populateHeaders({
  secret: 'yoursecret',
  companyId: 'yourcompanyid',
  accessKey: 'youraccesskey',
});

It will return:

{
    'x-myinterview-timestamp': 'headTimestamp', 
    'x-myinterview-key': 'headKey',
    'x-myinterview-signed': 'headSigned'
}

Responses (Regular/Error)

Standard Response

interface IApiResponseObj<T = any> {
  statusCode: number;
  errorCode: number;
  statusReason: string;
  callId: string;
  data?: T;
  time: Date | number;
}

IApiResponseObj

Type	Field	Description
number	statusCode	Status code of the response
number	errorCode	Internal error code
string	statusReason	Info message of the response
string	callId	Internal call ID
any	data	This field contain the data required based on the request
Date / number	time	Timestamp

This is the response object you will receive from the SDK the content of data will change based on your request.

Standard Error Response

interface IApiErrorObj {
  errorMessage: string | ValidationError[];
  errorDetails?: string;
  statusCode: number;
  errorCode: number;
  statusReason: string;
  callId?: string;
  time: Date | number;
}

IApiResponseObj

Type	Field	Description
string	errorMessage	Error message
string / undefined	errorDetails	Error message details
number	statusCode	Status code of the response
number	errorCode	Internal error code
string	statusReason	Info message of the response
string	callId	Internal call ID
Date / number	time	Timestamp

This is the error response object you will receive from the SDK.

Error Handling

You can catch the error the same way you catch error normally.

Async/Await

try {
  const res = await GAVideos.getVideoPersonality("");
} catch (error) {
  // The error will be of type IApiErrorObj the definition is above.
  console.log(error)
}

Callback

GAVideos.getVideoPersonality("").then((res) => {
  // Type IApiResponseObj 
}).catch((error) => {
  // The error will be of type IApiErrorObj the definition is above.
  console.log(error)
})

GACandidates

import { GACandidates } from '@myinterview/global-api-sdk';

createBulkCandidates

interface IBody {
  job_id: string;
  communication?: boolean;
  deadlineDate?: Date | string | number;
  timezoneForInvite?: string;
  candidates: {
    username?: string;
    email: string;
    phone?: string;
    status?: string;
    reminders?: {
      Content: string;
      companyName: string;
      greetings?: string;
      isSent: boolean;
      reminderDate: Date | string;
      timezone: string;
    }[];
    type?: string;
    candidate_id?: string;
    apiKey?: string;
    jobTitle?: string;
    urlStart?: string;
  }[];
};

await GACandidates.createBulkCandidates(body);

createBulkCandidates Params

createBulkCandidatesBody

Type	Field	Description
string	job_id	ID of the job to connect the candidate
boolean / undefined	communication	Flag to send mails with the creation
Date / string / number / undefined	deadlineDate	Deadline date for the candidate/s
string / undefined	timezoneForInvite	Timezone for the deadline
Array of candidate object	candidates	Array of candidate objects definition is above in the interface

This call will create one or more candidates and connect them to your Job.

updateCandidate

interface IBody {
  id: string; // You have to provide the id of the candidate
  status?: string;
  username?: string;
  deadline?: string | Date | number;
  timezoneForInvite?: string;
};

await GACandidates.updateCandidate(body);

updateCandidate Params

updateCandidateBody

Type	Field	Description
string	id	ID of the candidate
string / undefined	status	Status of the candidate
string / undefined	username	Username of the candidate
Date / string / number / undefined	deadline	Deadline date for the candidate/s
string / undefined	timezoneForInvite	Timezone for the deadline

GACompanies

import { GACompanies } from '@myinterview/global-api-sdk';

getCompanyInfo

const res: IApiResponseObj<ICompany> = await GACompanies.getCompanyInfo();

const companyInfo = res.data;

getCompanyTemplates

const res: IApiResponseObj<ITemplate[]> = await GACompanies.getCompanyTemplates();

const templates = res.data;

createCompanyTemplateBulk

interface IBody {
  id?: string | number;
  hideQuestions?: boolean;
  name: string;
  questions: {
    numOfRetakes: number;
    partDuration: number;
    question: string;
    timeLimit?: number;
    videoQuestion?: string;
  }[];
  intoductionURL?: string;
}[]

await GACompanies.createCompanyTemplateBulk(body);

createCompanyTemplateBulk Params

createCompanyTemplateBulkBody

Type	Field	Description
string	id	ID of the company template
boolean / undefined	hideQuestions	hideQuestions flag
string	name	Name of the template
string / undefined	intoductionURL	Url of the introduction video on the application page
Array of job questions	questions	Array of job questions objects definition is above in the interface

GAJobs

import { GAJobs } from '@myinterview/global-api-sdk';

getCompanyInfo

const res: IApiResponseObj<IJob[]> = await GAJobs.getJobs();

const jobs = res.data;

getJobsWithIds

const ids: string[];

const res: IApiResponseObj<IJob[]> = await GAJobs.getJobsWithIds(ids);

const jobs = res.data;

getJob

const id: string;

const res: IApiResponseObj<IJob> = await GAJobs.getJob(id);

const job = res.data;

createJob

interface IBody {
  title: string;
  language?: string;
  overlay?: string;
  termsUrl?: string;
  privacyUrl?: string;
  backgroundImage?: string;
  transcriptLanguage?: string;
  config?: IJobConfig;
  deadlineDate?: string | Date | number;
  experience?: string;
  jobDescription?: string;
  logo?: string;
  questions?: IQuestion[];
  skills?: string[];
  introVideo?: string;
}

await GAJobs.createJob(body);

createJob Params

createJobBody

Type	Field	Description
string	title	Title of the job
string / undefined	language	Language of the job
string / undefined	overlay	Overlay of the of the application page (Value in Color Hexa #000000)
string / undefined	termsUrl	Url of the Terms of Service
string / undefined	privacyUrl	Url of the Privacy
string / undefined	backgroundImage	Background Image of the of the application page
string / undefined	transcriptLanguage	Language of the transcript video
Config Object	config	Configuration object definition is above in the interface
Date / string / number / undefined	deadlineDate	Deadline date for the job
string / undefined	experience	experience of the job
string / undefined	jobDescription	Job description
string / undefined	logo	Logo
Array of job questions	questions	Array of job questions objects definition is above in the interface
Array of string / undefined	skills	skills
string / undefined	introVideo	introduction video for application page

updateJob

interface IBody {
  job_id: string; // REQUIRED !
  language?: string;
  overlay?: string;
  termsUrl?: string;
  privacyUrl?: string;
  backgroundImage?: string;
  transcriptLanguage?: string;
  title?: string;
  config?: IJobConfig;
  deadlineDate?: string | Date | number;
  experience?: string;
  jobDescription?: string;
  logo?: string;
  questions?: IQuestion[];
  skills?: string[];
  introVideo?: string;
}

await GAJobs.updateJob(body);

updateJob Params

updateJobBody

Type	Field	Description
string	job_id	ID of the job
string	title	Title of the job
string / undefined	language	Language of the job
string / undefined	overlay	Overlay of the of the application page (Value in Color Hexa #000000)
string / undefined	termsUrl	Url of the Terms of Service
string / undefined	privacyUrl	Url of the Privacy
string / undefined	backgroundImage	Background Image of the of the application page
string / undefined	transcriptLanguage	Language of the transcript video
Config Object	config	Configuration object definition is above in the interface
Date / string / number / undefined	deadlineDate	Deadline date for the job
string / undefined	experience	experience of the job
string / undefined	jobDescription	Job description
string / undefined	logo	Logo
Array of job questions	questions	Array of job questions objects definition is above in the interface
Array of string / undefined	skills	skills
string / undefined	introVideo	introduction video for application page

GAVideos

import { GAVideos } from '@myinterview/global-api-sdk';

getVideo

const id: string;

const res: IApiResponseObj<IVideo> = await GAVideos.getVideo(id);

const video = res.data;

getVideoPersonality

const id: string;

const res: IApiResponseObj<IPersonality> = await GAVideos.getVideoPersonality(id);

const personality = res.data;

Authors

• Dvd1109