npm.io
0.2.1 • Published 8 years ago

behavioralsignals-uapi-client

Licence
Commercial
Version
0.2.1
Deps
1
Size
526 kB
Vulns
1
Weekly
0
SummaryDependencyVersions

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 project:

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

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:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your behavioralsignals-uapi-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. 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):

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:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

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 GET /aggregator/agents/ Returns a list of all agents
BehavioralsignalsUapiClient.AgentsApi getAgentsAgentId GET /aggregator/agents/{agent_id}/ Returns a list of all agents
BehavioralsignalsUapiClient.AgentsApi getAgentsList GET /agents/
BehavioralsignalsUapiClient.CallsApi getCalls GET /calls/ Returns a list of calls.
BehavioralsignalsUapiClient.CallsApi getCallsCallId GET /calls/{call_id}/ Returns details for call with id call_id.
BehavioralsignalsUapiClient.CampaignsApi getCampaigns GET /aggregator/campaigns/ Returns a list of campaigns.
BehavioralsignalsUapiClient.CampaignsApi getCampaignsCampaignId GET /aggregator/campaigns/{campaign_id}/ Returns details for a campaign.
BehavioralsignalsUapiClient.CampaignsApi getCampaignsList GET /campaigns/
BehavioralsignalsUapiClient.CompaniesApi getCompanies GET /companies/ Returns a list of company objects.
BehavioralsignalsUapiClient.EmployeesApi getEmployeeDetails GET /employees/{employee_id}/ Returns details for employee with id employee_id.
BehavioralsignalsUapiClient.EmployeesApi 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 GET /jobs/{job_id}/streamaudio/ Get stream audio for job with id job_id
BehavioralsignalsUapiClient.JobsApi getJobJobId GET /jobs/{job_id}/ Returns details for job with id job_id.
BehavioralsignalsUapiClient.JobsApi getJobResults GET /jobs/{job_id}/results/ Get call, frame, asr or highlight results for job with id job_id
BehavioralsignalsUapiClient.JobsApi getJobs GET /jobs/ Returns a list of jobs.
BehavioralsignalsUapiClient.JobsApi postJob POST /jobs/create/ Create a new Job
BehavioralsignalsUapiClient.JobsApi postJobCreate POST /jobs/create/process/{process_id} Creates new job from service process id.
BehavioralsignalsUapiClient.ProcessesApi getProcessAudioStream GET /processes/{process_id}/streamaudio/ Get stream audio for process with id process_id
BehavioralsignalsUapiClient.ProcessesApi getProcessResults GET /processes/{process_id}/results/ Get call, frame, asr or highlight results for process with id process_id
BehavioralsignalsUapiClient.UsersApi 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 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 POST /users/register/ Registers a new user

Documentation for Models

Documentation for Authorization

OAuth2