https://github.com/merge-api/merge-ats-javascript

The Javascript API Client for the Merge ATS API.
https://github.com/merge-api/merge-ats-javascript
Last synced: 4 months ago
JSON representation
The Javascript API Client for the Merge ATS API.
Host: GitHub
URL: https://github.com/merge-api/merge-ats-javascript
Owner: merge-api
Created: 2021-03-12T18:17:30.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2023-01-24T05:15:36.000Z (over 3 years ago)
Last Synced: 2023-08-02T08:59:42.181Z (almost 3 years ago)
Language: JavaScript
Size: 294 KB
Stars: 1
Watchers: 11
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

          ## Deprecation Notice

Merge has released a new version of our [Typescript SDK](https://github.com/merge-api/merge-node-client/). As part of that release, we are providing a deprecation notice of our legacy SDKs.

To help give you time to plan your migration to our latest SDK:

- August 2023: SDK deprecation notice on our legacy Javascript SDKs.

- Until February 2024: we’ll support updates as needed and address bugs in priority order

- After February 2024: we’ll no longer make updates or bug fixes to the deprecated SDKs

For information about the deprecation notice see our [help center](https://help.merge.dev/en/collections/4258952-sdks) and for information about migrating to the Typescript SDK, see the [Typescript Migration Guide](https://help.merge.dev/en/articles/8229417-advanced-node-sdk-migration-guide).

# merge_ats_api

MergeAtsApi - JavaScript client for merge_ats_api

The unified API for building rich integrations with multiple Applicant Tracking System platforms.

This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0

- Package version: 1.0.5

- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

```shell

npm install @mergeapi/merge_ats_api

```

Finally, you need to build the module:

```shell

npm run build

```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following

the above steps with Node.js and installing browserify with `npm install -g browserify`,

perform the following (assuming *main.js* is your entry file):

```shell

browserify main.js > bundle.js

```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:

Cannot resolve module", most certainly you should disable AMD loader. Add/merge

the following section to your webpack config:

```javascript

module: {

  rules: [

    {

      parser: {

        amd: false

      }

    }

  ]

}

```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript

var MergeAtsApi = require('merge_ats_api');

var defaultClient = MergeAtsApi.ApiClient.instance;

// Configure API key authorization: tokenAuth

defaultClient.authentications['tokenAuth'] = {type: "bearer", accessToken: "YOUR_API_KEY"}

var api = new MergeAtsApi.AccountTokenApi()

var publicToken = "publicToken_example"; // {String} 

var callback = function(error, data, response) {

  if (error) {

    console.error(error);

  } else {

    console.log('API called successfully. Returned data: ' + data);

  }

};

api.accountTokenRetrieve(publicToken, callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://api.merge.dev/api/ats/v1*

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*MergeAtsApi.AccountTokenApi* | [**accountTokenRetrieve**](docs/AccountTokenApi.md#accountTokenRetrieve) | **GET** /account-token/{public_token} | 

*MergeAtsApi.ActivitiesApi* | [**activitiesList**](docs/ActivitiesApi.md#activitiesList) | **GET** /activities | 

*MergeAtsApi.ActivitiesApi* | [**activitiesRetrieve**](docs/ActivitiesApi.md#activitiesRetrieve) | **GET** /activities/{id} | 

*MergeAtsApi.ApplicationsApi* | [**applicationsCreate**](docs/ApplicationsApi.md#applicationsCreate) | **POST** /applications | 

*MergeAtsApi.ApplicationsApi* | [**applicationsList**](docs/ApplicationsApi.md#applicationsList) | **GET** /applications | 

*MergeAtsApi.ApplicationsApi* | [**applicationsRetrieve**](docs/ApplicationsApi.md#applicationsRetrieve) | **GET** /applications/{id} | 

*MergeAtsApi.AttachmentsApi* | [**attachmentsCreate**](docs/AttachmentsApi.md#attachmentsCreate) | **POST** /attachments | 

*MergeAtsApi.AttachmentsApi* | [**attachmentsList**](docs/AttachmentsApi.md#attachmentsList) | **GET** /attachments | 

*MergeAtsApi.AttachmentsApi* | [**attachmentsRetrieve**](docs/AttachmentsApi.md#attachmentsRetrieve) | **GET** /attachments/{id} | 

*MergeAtsApi.AvailableActionsApi* | [**availableActionsRetrieve**](docs/AvailableActionsApi.md#availableActionsRetrieve) | **GET** /available-actions | 

*MergeAtsApi.CandidatesApi* | [**candidatesCreate**](docs/CandidatesApi.md#candidatesCreate) | **POST** /candidates | 

*MergeAtsApi.CandidatesApi* | [**candidatesList**](docs/CandidatesApi.md#candidatesList) | **GET** /candidates | 

*MergeAtsApi.CandidatesApi* | [**candidatesRetrieve**](docs/CandidatesApi.md#candidatesRetrieve) | **GET** /candidates/{id} | 

*MergeAtsApi.DeleteAccountApi* | [**deleteAccountCreate**](docs/DeleteAccountApi.md#deleteAccountCreate) | **POST** /delete-account | 

*MergeAtsApi.DepartmentsApi* | [**departmentsList**](docs/DepartmentsApi.md#departmentsList) | **GET** /departments | 

*MergeAtsApi.DepartmentsApi* | [**departmentsRetrieve**](docs/DepartmentsApi.md#departmentsRetrieve) | **GET** /departments/{id} | 

*MergeAtsApi.EeocsApi* | [**eeocsList**](docs/EeocsApi.md#eeocsList) | **GET** /eeocs | 

*MergeAtsApi.EeocsApi* | [**eeocsRetrieve**](docs/EeocsApi.md#eeocsRetrieve) | **GET** /eeocs/{id} | 

*MergeAtsApi.GenerateKeyApi* | [**generateKeyCreate**](docs/GenerateKeyApi.md#generateKeyCreate) | **POST** /generate-key | 

*MergeAtsApi.InterviewsApi* | [**interviewsCreate**](docs/InterviewsApi.md#interviewsCreate) | **POST** /interviews | 

*MergeAtsApi.InterviewsApi* | [**interviewsList**](docs/InterviewsApi.md#interviewsList) | **GET** /interviews | 

*MergeAtsApi.InterviewsApi* | [**interviewsRetrieve**](docs/InterviewsApi.md#interviewsRetrieve) | **GET** /interviews/{id} | 

*MergeAtsApi.IssuesApi* | [**issuesList**](docs/IssuesApi.md#issuesList) | **GET** /issues | 

*MergeAtsApi.IssuesApi* | [**issuesRetrieve**](docs/IssuesApi.md#issuesRetrieve) | **GET** /issues/{id} | 

*MergeAtsApi.JobInterviewStagesApi* | [**jobInterviewStagesList**](docs/JobInterviewStagesApi.md#jobInterviewStagesList) | **GET** /job-interview-stages | 

*MergeAtsApi.JobInterviewStagesApi* | [**jobInterviewStagesRetrieve**](docs/JobInterviewStagesApi.md#jobInterviewStagesRetrieve) | **GET** /job-interview-stages/{id} | 

*MergeAtsApi.JobsApi* | [**jobsList**](docs/JobsApi.md#jobsList) | **GET** /jobs | 

*MergeAtsApi.JobsApi* | [**jobsRetrieve**](docs/JobsApi.md#jobsRetrieve) | **GET** /jobs/{id} | 

*MergeAtsApi.LinkTokenApi* | [**linkTokenCreate**](docs/LinkTokenApi.md#linkTokenCreate) | **POST** /link-token | 

*MergeAtsApi.OffersApi* | [**offersList**](docs/OffersApi.md#offersList) | **GET** /offers | 

*MergeAtsApi.OffersApi* | [**offersRetrieve**](docs/OffersApi.md#offersRetrieve) | **GET** /offers/{id} | 

*MergeAtsApi.OfficesApi* | [**officesList**](docs/OfficesApi.md#officesList) | **GET** /offices | 

*MergeAtsApi.OfficesApi* | [**officesRetrieve**](docs/OfficesApi.md#officesRetrieve) | **GET** /offices/{id} | 

*MergeAtsApi.PassthroughApi* | [**passthroughCreate**](docs/PassthroughApi.md#passthroughCreate) | **POST** /passthrough | 

*MergeAtsApi.RegenerateKeyApi* | [**regenerateKeyCreate**](docs/RegenerateKeyApi.md#regenerateKeyCreate) | **POST** /regenerate-key | 

*MergeAtsApi.RejectReasonsApi* | [**rejectReasonsList**](docs/RejectReasonsApi.md#rejectReasonsList) | **GET** /reject-reasons | 

*MergeAtsApi.RejectReasonsApi* | [**rejectReasonsRetrieve**](docs/RejectReasonsApi.md#rejectReasonsRetrieve) | **GET** /reject-reasons/{id} | 

*MergeAtsApi.ScorecardsApi* | [**scorecardsCreate**](docs/ScorecardsApi.md#scorecardsCreate) | **POST** /scorecards | 

*MergeAtsApi.ScorecardsApi* | [**scorecardsList**](docs/ScorecardsApi.md#scorecardsList) | **GET** /scorecards | 

*MergeAtsApi.ScorecardsApi* | [**scorecardsRetrieve**](docs/ScorecardsApi.md#scorecardsRetrieve) | **GET** /scorecards/{id} | 

*MergeAtsApi.SyncStatusApi* | [**syncStatusList**](docs/SyncStatusApi.md#syncStatusList) | **GET** /sync-status | 

*MergeAtsApi.SyncStatusApi* | [**syncStatusResyncCreate**](docs/SyncStatusApi.md#syncStatusResyncCreate) | **POST** /sync-status/resync | 

*MergeAtsApi.TagsApi* | [**tagsList**](docs/TagsApi.md#tagsList) | **GET** /tags | 

*MergeAtsApi.UsersApi* | [**usersCreate**](docs/UsersApi.md#usersCreate) | **POST** /users | 

*MergeAtsApi.UsersApi* | [**usersList**](docs/UsersApi.md#usersList) | **GET** /users | 

*MergeAtsApi.UsersApi* | [**usersRetrieve**](docs/UsersApi.md#usersRetrieve) | **GET** /users/{id} | 

## Documentation for Models

 - [MergeAtsApi.AccessRoleEnum](docs/AccessRoleEnum.md)

 - [MergeAtsApi.AccountIntegration](docs/AccountIntegration.md)

 - [MergeAtsApi.AccountToken](docs/AccountToken.md)

 - [MergeAtsApi.Activity](docs/Activity.md)

 - [MergeAtsApi.ActivityTypeEnum](docs/ActivityTypeEnum.md)

 - [MergeAtsApi.Application](docs/Application.md)

 - [MergeAtsApi.ApplicationRequest](docs/ApplicationRequest.md)

 - [MergeAtsApi.Attachment](docs/Attachment.md)

 - [MergeAtsApi.AttachmentRequest](docs/AttachmentRequest.md)

 - [MergeAtsApi.AttachmentTypeEnum](docs/AttachmentTypeEnum.md)

 - [MergeAtsApi.AvailableActions](docs/AvailableActions.md)

 - [MergeAtsApi.Candidate](docs/Candidate.md)

 - [MergeAtsApi.CandidateRequest](docs/CandidateRequest.md)

 - [MergeAtsApi.DataPassthroughRequest](docs/DataPassthroughRequest.md)

 - [MergeAtsApi.Department](docs/Department.md)

 - [MergeAtsApi.DisabilityStatusEnum](docs/DisabilityStatusEnum.md)

 - [MergeAtsApi.EEOC](docs/EEOC.md)

 - [MergeAtsApi.EmailAddress](docs/EmailAddress.md)

 - [MergeAtsApi.EmailAddressRequest](docs/EmailAddressRequest.md)

 - [MergeAtsApi.EmailAddressTypeEnum](docs/EmailAddressTypeEnum.md)

 - [MergeAtsApi.EndUserDetailsRequest](docs/EndUserDetailsRequest.md)

 - [MergeAtsApi.GenderEnum](docs/GenderEnum.md)

 - [MergeAtsApi.GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)

 - [MergeAtsApi.Issue](docs/Issue.md)

 - [MergeAtsApi.IssueStatusEnum](docs/IssueStatusEnum.md)

 - [MergeAtsApi.Job](docs/Job.md)

 - [MergeAtsApi.JobInterviewStage](docs/JobInterviewStage.md)

 - [MergeAtsApi.JobStatusEnum](docs/JobStatusEnum.md)

 - [MergeAtsApi.LinkToken](docs/LinkToken.md)

 - [MergeAtsApi.MethodEnum](docs/MethodEnum.md)

 - [MergeAtsApi.ModelOperation](docs/ModelOperation.md)

 - [MergeAtsApi.Offer](docs/Offer.md)

 - [MergeAtsApi.OfferStatusEnum](docs/OfferStatusEnum.md)

 - [MergeAtsApi.Office](docs/Office.md)

 - [MergeAtsApi.OverallRecommendationEnum](docs/OverallRecommendationEnum.md)

 - [MergeAtsApi.PaginatedActivityList](docs/PaginatedActivityList.md)

 - [MergeAtsApi.PaginatedApplicationList](docs/PaginatedApplicationList.md)

 - [MergeAtsApi.PaginatedAttachmentList](docs/PaginatedAttachmentList.md)

 - [MergeAtsApi.PaginatedCandidateList](docs/PaginatedCandidateList.md)

 - [MergeAtsApi.PaginatedDepartmentList](docs/PaginatedDepartmentList.md)

 - [MergeAtsApi.PaginatedEEOCList](docs/PaginatedEEOCList.md)

 - [MergeAtsApi.PaginatedIssueList](docs/PaginatedIssueList.md)

 - [MergeAtsApi.PaginatedJobInterviewStageList](docs/PaginatedJobInterviewStageList.md)

 - [MergeAtsApi.PaginatedJobList](docs/PaginatedJobList.md)

 - [MergeAtsApi.PaginatedOfferList](docs/PaginatedOfferList.md)

 - [MergeAtsApi.PaginatedOfficeList](docs/PaginatedOfficeList.md)

 - [MergeAtsApi.PaginatedRejectReasonList](docs/PaginatedRejectReasonList.md)

 - [MergeAtsApi.PaginatedRemoteUserList](docs/PaginatedRemoteUserList.md)

 - [MergeAtsApi.PaginatedScheduledInterviewList](docs/PaginatedScheduledInterviewList.md)

 - [MergeAtsApi.PaginatedScorecardList](docs/PaginatedScorecardList.md)

 - [MergeAtsApi.PaginatedSyncStatusList](docs/PaginatedSyncStatusList.md)

 - [MergeAtsApi.PaginatedTagList](docs/PaginatedTagList.md)

 - [MergeAtsApi.PhoneNumber](docs/PhoneNumber.md)

 - [MergeAtsApi.PhoneNumberRequest](docs/PhoneNumberRequest.md)

 - [MergeAtsApi.PhoneNumberTypeEnum](docs/PhoneNumberTypeEnum.md)

 - [MergeAtsApi.RaceEnum](docs/RaceEnum.md)

 - [MergeAtsApi.RejectReason](docs/RejectReason.md)

 - [MergeAtsApi.RemoteData](docs/RemoteData.md)

 - [MergeAtsApi.RemoteDataRequest](docs/RemoteDataRequest.md)

 - [MergeAtsApi.RemoteKey](docs/RemoteKey.md)

 - [MergeAtsApi.RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)

 - [MergeAtsApi.RemoteResponse](docs/RemoteResponse.md)

 - [MergeAtsApi.RemoteUser](docs/RemoteUser.md)

 - [MergeAtsApi.RemoteUserRequest](docs/RemoteUserRequest.md)

 - [MergeAtsApi.ScheduledInterview](docs/ScheduledInterview.md)

 - [MergeAtsApi.ScheduledInterviewRequest](docs/ScheduledInterviewRequest.md)

 - [MergeAtsApi.ScheduledInterviewStatusEnum](docs/ScheduledInterviewStatusEnum.md)

 - [MergeAtsApi.Scorecard](docs/Scorecard.md)

 - [MergeAtsApi.ScorecardRequest](docs/ScorecardRequest.md)

 - [MergeAtsApi.SyncStatus](docs/SyncStatus.md)

 - [MergeAtsApi.SyncStatusStatusEnum](docs/SyncStatusStatusEnum.md)

 - [MergeAtsApi.Tag](docs/Tag.md)

 - [MergeAtsApi.Url](docs/Url.md)

 - [MergeAtsApi.UrlRequest](docs/UrlRequest.md)

 - [MergeAtsApi.UrlTypeEnum](docs/UrlTypeEnum.md)

 - [MergeAtsApi.VeteranStatusEnum](docs/VeteranStatusEnum.md)

 - [MergeAtsApi.VisibilityEnum](docs/VisibilityEnum.md)

## Documentation for Authorization

### tokenAuth

- **Type**: API key

- **API key parameter name**: Authorization

- **Location**: HTTP header
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/merge-api/merge-ats-javascript

Awesome Lists containing this project

README
