# behavioralsignals-uapi-client > Behavioral_Signal_Technologies_API_enables_third_party_applications_or_processes_to_process_collected_data_in_the_cloud_and_provides_emotional_and_demographic_insights_for_consumption_ Latest version **0.2.1** (published 2018-06-14) · Commercial license · 0 weekly downloads ## Install ```sh npm install behavioralsignals-uapi-client pnpm add behavioralsignals-uapi-client yarn add behavioralsignals-uapi-client bun add behavioralsignals-uapi-client ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.2.1 | | Published | 2018-06-14 | | First published | 2018-05-02 | | Weekly downloads | 0 | | License | Commercial | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 525.6 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | Maintainers | sdim | ## Links - npm: https://www.npmjs.com/package/behavioralsignals-uapi-client - npm.io page: https://npm.io/package/behavioralsignals-uapi-client ## Dependencies (1) - [superagent](https://npm.io/package/superagent.md) 3.5.2 ## Recent versions - 0.2.1 (latest) — 2018-06-14 - 0.1.4 — 2018-05-02 - 0.1.3 — 2018-05-02 - 0.1.2 — 2018-05-02 - 0.1.1 — 2018-05-02 ## README # behavioralsignals-uapi-client BehavioralsignalsUapiClient - JavaScript client for behavioralsignals-uapi-client Behavioral Signal Technologies' API enables third party applications or processes to process collected data in the cloud and provides emotional and demographic insights for consumption. This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: 0.2.1 - Package version: 0.2.1 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit [http://uapi1.behavioralsignals.com/contact/](http://uapi1.behavioralsignals.com/contact/) ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell npm install behavioralsignals-uapi-client --save ``` ##### Local development To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` Finally, switch to the directory you want to use your behavioralsignals-uapi-client from, and run: ```shell npm link /path/to/ ``` You should now be able to `require('behavioralsignals-uapi-client')` in javascript files from the directory you ran the last command above from. #### git # If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via: ```shell npm install GIT_USER_ID/GIT_REPO_ID --save ``` ### 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, that's to say your javascript file where you actually use this library): ```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 BehavioralsignalsUapiClient = require('behavioralsignals-uapi-client'); var defaultClient = BehavioralsignalsUapiClient.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = "YOUR ACCESS TOKEN" var api = new BehavioralsignalsUapiClient.AgentsApi() var opts = { 'sortBy': "size", // {String} Sorting option 'campaignId': "campaignId_example", // {String} Filter calls by campaign and calculate aggregates per agent 'page': 1, // {Number} Page number 'limit': 10, // {Number} The maximum size of the page entries 'startDate': new Date("2013-10-20T19:20:30+01:00"), // {Date} Aggregates agents based on the start of a date range 'endDate': new Date("2013-10-20T19:20:30+01:00") // {Date} Aggregates agents based on the end of a date range }; api.getAgents(opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); }); ``` ## Documentation for API Endpoints All URIs are relative to *https://uapi1.behavioralsignals.com* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *BehavioralsignalsUapiClient.AgentsApi* | [**getAgents**](docs/AgentsApi.md#getAgents) | **GET** /aggregator/agents/ | Returns a list of all agents *BehavioralsignalsUapiClient.AgentsApi* | [**getAgentsAgentId**](docs/AgentsApi.md#getAgentsAgentId) | **GET** /aggregator/agents/{agent_id}/ | Returns a list of all agents *BehavioralsignalsUapiClient.AgentsApi* | [**getAgentsList**](docs/AgentsApi.md#getAgentsList) | **GET** /agents/ | *BehavioralsignalsUapiClient.CallsApi* | [**getCalls**](docs/CallsApi.md#getCalls) | **GET** /calls/ | Returns a list of calls. *BehavioralsignalsUapiClient.CallsApi* | [**getCallsCallId**](docs/CallsApi.md#getCallsCallId) | **GET** /calls/{call_id}/ | Returns details for call with id call_id. *BehavioralsignalsUapiClient.CampaignsApi* | [**getCampaigns**](docs/CampaignsApi.md#getCampaigns) | **GET** /aggregator/campaigns/ | Returns a list of campaigns. *BehavioralsignalsUapiClient.CampaignsApi* | [**getCampaignsCampaignId**](docs/CampaignsApi.md#getCampaignsCampaignId) | **GET** /aggregator/campaigns/{campaign_id}/ | Returns details for a campaign. *BehavioralsignalsUapiClient.CampaignsApi* | [**getCampaignsList**](docs/CampaignsApi.md#getCampaignsList) | **GET** /campaigns/ | *BehavioralsignalsUapiClient.CompaniesApi* | [**getCompanies**](docs/CompaniesApi.md#getCompanies) | **GET** /companies/ | Returns a list of company objects. *BehavioralsignalsUapiClient.EmployeesApi* | [**getEmployeeDetails**](docs/EmployeesApi.md#getEmployeeDetails) | **GET** /employees/{employee_id}/ | Returns details for employee with id employee_id. *BehavioralsignalsUapiClient.EmployeesApi* | [**getEmployeesList**](docs/EmployeesApi.md#getEmployeesList) | **GET** /employees/ | Returns list of all employees, if role param is provided returns list of all employees with the specific role. *BehavioralsignalsUapiClient.JobsApi* | [**getJobAudioStream**](docs/JobsApi.md#getJobAudioStream) | **GET** /jobs/{job_id}/streamaudio/ | Get stream audio for job with id job_id *BehavioralsignalsUapiClient.JobsApi* | [**getJobJobId**](docs/JobsApi.md#getJobJobId) | **GET** /jobs/{job_id}/ | Returns details for job with id job_id. *BehavioralsignalsUapiClient.JobsApi* | [**getJobResults**](docs/JobsApi.md#getJobResults) | **GET** /jobs/{job_id}/results/ | Get call, frame, asr or highlight results for job with id job_id *BehavioralsignalsUapiClient.JobsApi* | [**getJobs**](docs/JobsApi.md#getJobs) | **GET** /jobs/ | Returns a list of jobs. *BehavioralsignalsUapiClient.JobsApi* | [**postJob**](docs/JobsApi.md#postJob) | **POST** /jobs/create/ | Create a new Job *BehavioralsignalsUapiClient.JobsApi* | [**postJobCreate**](docs/JobsApi.md#postJobCreate) | **POST** /jobs/create/process/{process_id} | Creates new job from service process id. *BehavioralsignalsUapiClient.ProcessesApi* | [**getProcessAudioStream**](docs/ProcessesApi.md#getProcessAudioStream) | **GET** /processes/{process_id}/streamaudio/ | Get stream audio for process with id process_id *BehavioralsignalsUapiClient.ProcessesApi* | [**getProcessResults**](docs/ProcessesApi.md#getProcessResults) | **GET** /processes/{process_id}/results/ | Get call, frame, asr or highlight results for process with id process_id *BehavioralsignalsUapiClient.UsersApi* | [**getUserDetails**](docs/UsersApi.md#getUserDetails) | **GET** /users/{user_id}/ | Returns details for user with id user_id depending on permissions. If has admin permissions returns details for any user else returns only his own details. *BehavioralsignalsUapiClient.UsersApi* | [**getUserList**](docs/UsersApi.md#getUserList) | **GET** /users/ | Returns list of users details depending on permissions. if user returns his own details if admin returns list of details for all users. *BehavioralsignalsUapiClient.UsersApi* | [**registerUser**](docs/UsersApi.md#registerUser) | **POST** /users/register/ | Registers a new user ## Documentation for Models - [BehavioralsignalsUapiClient.Agent](docs/Agent.md) - [BehavioralsignalsUapiClient.AgentBehaviors](docs/AgentBehaviors.md) - [BehavioralsignalsUapiClient.AgentTrends](docs/AgentTrends.md) - [BehavioralsignalsUapiClient.Behavior](docs/Behavior.md) - [BehavioralsignalsUapiClient.BehaviorInner](docs/BehaviorInner.md) - [BehavioralsignalsUapiClient.BehaviorInnerValue](docs/BehaviorInnerValue.md) - [BehavioralsignalsUapiClient.CalculationModel](docs/CalculationModel.md) - [BehavioralsignalsUapiClient.Call](docs/Call.md) - [BehavioralsignalsUapiClient.Campaign](docs/Campaign.md) - [BehavioralsignalsUapiClient.Company](docs/Company.md) - [BehavioralsignalsUapiClient.Employee](docs/Employee.md) - [BehavioralsignalsUapiClient.EmployeesErrorModel](docs/EmployeesErrorModel.md) - [BehavioralsignalsUapiClient.ErrorModel](docs/ErrorModel.md) - [BehavioralsignalsUapiClient.IndicatorType](docs/IndicatorType.md) - [BehavioralsignalsUapiClient.Job](docs/Job.md) - [BehavioralsignalsUapiClient.JobCreationModel](docs/JobCreationModel.md) - [BehavioralsignalsUapiClient.JobErrorModel](docs/JobErrorModel.md) - [BehavioralsignalsUapiClient.JobJobStatus](docs/JobJobStatus.md) - [BehavioralsignalsUapiClient.JobMediaMetadata](docs/JobMediaMetadata.md) - [BehavioralsignalsUapiClient.JobsErrorModel](docs/JobsErrorModel.md) - [BehavioralsignalsUapiClient.PaginationModel](docs/PaginationModel.md) - [BehavioralsignalsUapiClient.ResponseCampaignsListResults](docs/ResponseCampaignsListResults.md) - [BehavioralsignalsUapiClient.ResponseCompanies](docs/ResponseCompanies.md) - [BehavioralsignalsUapiClient.UserCreation](docs/UserCreation.md) - [BehavioralsignalsUapiClient.UserDetails](docs/UserDetails.md) - [BehavioralsignalsUapiClient.UserDetailsDetails](docs/UserDetailsDetails.md) - [BehavioralsignalsUapiClient.CallDetails](docs/CallDetails.md) - [BehavioralsignalsUapiClient.ResponseAggregatorAgents](docs/ResponseAggregatorAgents.md) - [BehavioralsignalsUapiClient.ResponseAggregatorCampaigns](docs/ResponseAggregatorCampaigns.md) - [BehavioralsignalsUapiClient.ResponseCallsList](docs/ResponseCallsList.md) - [BehavioralsignalsUapiClient.ResponseCampaignsList](docs/ResponseCampaignsList.md) - [BehavioralsignalsUapiClient.ResponseEmployeesList](docs/ResponseEmployeesList.md) - [BehavioralsignalsUapiClient.ResponseJobList](docs/ResponseJobList.md) - [BehavioralsignalsUapiClient.ResponseUserList](docs/ResponseUserList.md) - [BehavioralsignalsUapiClient.ScoredIndicatorType](docs/ScoredIndicatorType.md) ## Documentation for Authorization ### OAuth2 - **Type**: OAuth - **Flow**: accessCode - **Authorization URL**: https://uapi1.behavioralsignals.com/oauth/authorize - **Scopes**: - read: Grants read access - write: Grants write access --- _Source: https://npm.io/package/behavioralsignals-uapi-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._