0.2.18 • Published 6 years ago

@behavioralsignals/behavioralsignals-uapi-client v0.2.18

Weekly downloads
80
License
Commercial
Repository
-
Last release
6 years ago

@behavioralsignals/behavioralsignals-uapi-client

BehavioralsignalsUapiClient - JavaScript client for @behavioralsignals/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/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/behavioralsignals-uapi-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('@behavioralsignals/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/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.AccountsApi()

var subscriptionRequest = new BehavioralsignalsUapiClient.AccountSubscription(); // {AccountSubscription} Subscription object

api.subscribeAccount(subscriptionRequest).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://uapi1.behavioralsignals.com

ClassMethodHTTP requestDescription
BehavioralsignalsUapiClient.AccountsApisubscribeAccountPOST /accounts/subscribe/Subscribes for a new account
BehavioralsignalsUapiClient.AgentsApigetAgentsGET /agents/
BehavioralsignalsUapiClient.AgentsApigetAggregatedAgentsGET /aggregator/agents/Returns a list of all agents
BehavioralsignalsUapiClient.AgentsApigetAggregatedAgentsAgentIdGET /aggregator/agents/{agent_id}/Returns a list of all agents
BehavioralsignalsUapiClient.AggregationsApigetAggregatedAgentsGET /aggregator/agents/Returns a list of all agents
BehavioralsignalsUapiClient.AggregationsApigetAggregatedCallsGET /aggregator/calls/Returns aggregations for a group of calls.
BehavioralsignalsUapiClient.AggregationsApigetAggregatedCampaignGET /aggregator/campaigns/{id}/Returns aggregations of a campaign.
BehavioralsignalsUapiClient.AggregationsApigetAggregatedCampaignsGET /aggregator/campaigns/Returns list of campaigns aggregations.
BehavioralsignalsUapiClient.AggregationsApigetAggregatedLegacyCampaignGET /aggregator/campaignslegacy/{campaign_id}/Returns details for a legacy campaign.
BehavioralsignalsUapiClient.AggregationsApigetAggregatedLegacyCampaignsGET /aggregator/campaignslegacy/Returns an aggregated list of legacy campaigns.
BehavioralsignalsUapiClient.AnnotationsApiremoveCallLockDELETE /calls/{id}/lock/Removes the annotation lock of a call
BehavioralsignalsUapiClient.AnnotationsApiupdateCallAnnotationPUT /calls/{call_id}/annotations/Annotate highlights for a call
BehavioralsignalsUapiClient.AnnotationsApiupdateCallLockPUT /calls/{id}/lock/Locks or updates the annotation lock of a call
BehavioralsignalsUapiClient.BookmarksApiaddBookmarkPOST /bookmarks/Assigns a specified call to a specific bookmark category
BehavioralsignalsUapiClient.BookmarksApideleteBookmarkCategoryDELETE /bookmark-categories/{id}/Delete a Bookmark Category
BehavioralsignalsUapiClient.BookmarksApigetBookmarkCategoriesGET /bookmark-categories/Returns a list of bookmark categories.
BehavioralsignalsUapiClient.BookmarksApigetBookmarkCategoryGET /bookmark-categories/{id}/Get the data of a single bookmark category
BehavioralsignalsUapiClient.BookmarksApipostBookmarkCategoryPOST /bookmark-categories/Create a new Bookmark Category
BehavioralsignalsUapiClient.BookmarksApiremoveBookmarkPUT /bookmarks/Removes a specified call from a specific bookmark category
BehavioralsignalsUapiClient.BookmarksApiupdateBookmarkCategoryPUT /bookmark-categories/{id}/Update a Bookmark Category
BehavioralsignalsUapiClient.CallsApigetAggregatedCallsGET /aggregator/calls/Returns aggregations for a group of calls.
BehavioralsignalsUapiClient.CallsApigetCallsGET /calls/Returns a list of calls.
BehavioralsignalsUapiClient.CallsApigetCallsCallIdGET /calls/{call_id}/Returns details for call with id call_id.
BehavioralsignalsUapiClient.CallsApiremoveCallLockDELETE /calls/{id}/lock/Removes the annotation lock of a call
BehavioralsignalsUapiClient.CallsApiupdateCallAnnotationPUT /calls/{call_id}/annotations/Annotate highlights for a call
BehavioralsignalsUapiClient.CallsApiupdateCallLockPUT /calls/{id}/lock/Locks or updates the annotation lock of a call
BehavioralsignalsUapiClient.CampaignsApicreateCampaignPOST /campaigns/Create a new campaign
BehavioralsignalsUapiClient.CampaignsApideleteCampaignDELETE /campaigns/{id}/Delete a campaign
BehavioralsignalsUapiClient.CampaignsApigetAggregatedCampaignGET /aggregator/campaigns/{id}/Returns aggregations of a campaign.
BehavioralsignalsUapiClient.CampaignsApigetAggregatedCampaignsGET /aggregator/campaigns/Returns list of campaigns aggregations.
BehavioralsignalsUapiClient.CampaignsApigetCampaignGET /campaigns/{id}/Get a campaign
BehavioralsignalsUapiClient.CampaignsApigetCampaignsGET /campaigns/
BehavioralsignalsUapiClient.CampaignsApiupdateCampaignPUT /campaigns/{id}/Update a campaign
BehavioralsignalsUapiClient.CampaignslegacyApigetAggregatedLegacyCampaignGET /aggregator/campaignslegacy/{campaign_id}/Returns details for a legacy campaign.
BehavioralsignalsUapiClient.CampaignslegacyApigetAggregatedLegacyCampaignsGET /aggregator/campaignslegacy/Returns an aggregated list of legacy campaigns.
BehavioralsignalsUapiClient.CampaignslegacyApigetLegacyCampaignsGET /campaignslegacy/
BehavioralsignalsUapiClient.CompaniesApigetCompaniesGET /aggregator/companies/Returns a list of company objects.
BehavioralsignalsUapiClient.ConfirmationApiconfirmAccountGET /accounts/confirm/Confirm subscription for the new account
BehavioralsignalsUapiClient.EmployeesApigetEmployeeDetailsGET /employees/{employee_id}/Returns details for employee with id employee_id.
BehavioralsignalsUapiClient.EmployeesApigetEmployeesListGET /employees/Returns list of tenant employees. If param role is provided returns list of all employees with the specific role. If param campaign_id is provided returns list of all employees role agent that belong to the campaign.
BehavioralsignalsUapiClient.JobsApigetJobAudioStreamGET /jobs/{job_id}/streamaudio/Get stream audio for job with id job_id
BehavioralsignalsUapiClient.JobsApigetJobHighlightsGET /jobs/{job_id}/highlights/Get highlight results for job with id job_id
BehavioralsignalsUapiClient.JobsApigetJobJobIdGET /jobs/{job_id}/Returns details for job with id job_id.
BehavioralsignalsUapiClient.JobsApigetJobResultsGET /jobs/{job_id}/results/Get call, frame, asr or highlight results for job with id job_id
BehavioralsignalsUapiClient.JobsApigetJobsGET /jobs/Returns a list of jobs.
BehavioralsignalsUapiClient.JobsApipostJobPOST /jobs/create/Create a new Job
BehavioralsignalsUapiClient.JobsApipostJobCreatePOST /jobs/create/process/{process_id}Creates new job from service process id.
BehavioralsignalsUapiClient.JobsApiuploadJobBundlePOST /jobs/upload/Upload a new job bundle
BehavioralsignalsUapiClient.MeApigetMeGET /me/Returns self details for an authenticated user.
BehavioralsignalsUapiClient.ProcessesApigetProcessAudioStreamGET /processes/{process_id}/streamaudio/Get stream audio for process with id process_id
BehavioralsignalsUapiClient.ProcessesApigetProcessResultsGET /processes/{process_id}/results/Get call, frame, asr or highlight results for process with id process_id
BehavioralsignalsUapiClient.ProfileApiupdateUserNotifyPUT /me/notify/Updates the notified property of the user
BehavioralsignalsUapiClient.TenantApicreateTenantPOST /tenant/Creates a new tenant on all services
BehavioralsignalsUapiClient.TenantApirevokeTenantDELETE /tenant/Revokes a tenant from all services
BehavioralsignalsUapiClient.UsersApigetUserDetailsGET /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.UsersApigetUserListGET /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.UsersApiregisterUserPOST /users/register/Registers a new user
BehavioralsignalsUapiClient.UsersApiupdateUserNotifyPUT /me/notify/Updates the notified property of the user

Documentation for Models

Documentation for Authorization

OAuth2

0.2.18

6 years ago

0.2.17

6 years ago

0.2.16

6 years ago

0.2.15

6 years ago

0.2.14

6 years ago

0.2.13

6 years ago

0.2.12

6 years ago

0.2.11

6 years ago

0.2.10

6 years ago

0.2.9

6 years ago

0.2.8

7 years ago

0.2.7

7 years ago

0.2.6

7 years ago

0.2.5

7 years ago

0.2.4

7 years ago

0.2.3

7 years ago

0.2.2

7 years ago

0.2.1

7 years ago

0.2.0

7 years ago

0.1.4

7 years ago