@behavioralsignals/behavioralsignals-aimc-client

BehavioralSignalsAIMCClient - JavaScript client for @behavioralsignals/behavioralsignals-aimc-client AI Mediated Conversations API. Find out more about the AI-MC APP API at https://behavioralsignals.com/ This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.5
Package version: 1.0.5
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

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-aimc-client --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your @behavioralsignals/behavioralsignals-aimc-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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

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 BehavioralSignalsAIMCClient = require('@behavioralsignals/behavioralsignals-aimc-client');

var defaultClient = BehavioralSignalsAIMCClient.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new BehavioralSignalsAIMCClient.AgentsApi()
api.getAgents().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://test.behavioralsignals.com/oliver

Class	Method	HTTP request	Description
BehavioralSignalsAIMCClient.AgentsApi	getAgents	GET /agents/	Returns a list of agents
BehavioralSignalsAIMCClient.AggregationsApi	getAggregatedAgents	GET /aggregator/agents/	Returns agents aggregations
BehavioralSignalsAIMCClient.AggregationsApi	getAggregatedAgentsAgentId	GET /aggregator/agents/{agent_id}/	Returns aggregations for an agent
BehavioralSignalsAIMCClient.AggregationsApi	getAggregatedCalls	GET /aggregator/calls/	Returns aggregations for a group of calls.
BehavioralSignalsAIMCClient.AggregationsApi	getAggregatedCampaign	GET /aggregator/campaigns/{id}/	Returns aggregations of a campaign.
BehavioralSignalsAIMCClient.AggregationsApi	getAggregatedCampaigns	GET /aggregator/campaigns/	Returns list of campaigns aggregations.
BehavioralSignalsAIMCClient.AggregationsApi	getAggregatedLegacyCampaign	GET /aggregator/campaignslegacy/{campaign_id}/	Returns aggregations for a legacy campaign.
BehavioralSignalsAIMCClient.AggregationsApi	getAggregatedLegacyCampaigns	GET /aggregator/campaignslegacy/	Returns an aggregated list of legacy campaigns.
BehavioralSignalsAIMCClient.AnnotationsApi	removeCallLock	DELETE /calls/{id}/lock/	Removes the annotation lock of a call
BehavioralSignalsAIMCClient.AnnotationsApi	updateCallAnnotation	PUT /calls/{call_id}/annotations/	Annotate highlights for a call
BehavioralSignalsAIMCClient.AnnotationsApi	updateCallLock	PUT /calls/{id}/lock/	Sets or removes an annotation lock of a call
BehavioralSignalsAIMCClient.AuthApi	getAuthToken	POST /o/token/	Get a new auth token
BehavioralSignalsAIMCClient.AuthApi	revokeAuthToken	POST /o/revoke-token/	Revoke auth token
BehavioralSignalsAIMCClient.BookmarksApi	addBookmark	POST /bookmarks/	Assigns a call to a bookmark category
BehavioralSignalsAIMCClient.BookmarksApi	deleteBookmarkCategory	DELETE /bookmark-categories/{id}/	Delete a Bookmark Category
BehavioralSignalsAIMCClient.BookmarksApi	getBookmarkCategories	GET /bookmark-categories/	Returns a list of bookmark categories.
BehavioralSignalsAIMCClient.BookmarksApi	getBookmarkCategory	GET /bookmark-categories/{id}/	Get the data of a bookmark category
BehavioralSignalsAIMCClient.BookmarksApi	postBookmarkCategory	POST /bookmark-categories/	Create a new Bookmark Category
BehavioralSignalsAIMCClient.BookmarksApi	removeBookmark	PUT /bookmarks/	Removes a call from a bookmark category
BehavioralSignalsAIMCClient.BookmarksApi	updateBookmarkCategory	PUT /bookmark-categories/{id}/	Update a Bookmark Category
BehavioralSignalsAIMCClient.CallsApi	getCalls	GET /calls/	Returns a list of calls with details.
BehavioralSignalsAIMCClient.CallsApi	getCallsCallId	GET /calls/{call_id}/	Returns details for a call
BehavioralSignalsAIMCClient.CampaignsApi	createCampaign	POST /campaigns/	Create a new campaign
BehavioralSignalsAIMCClient.CampaignsApi	deleteCampaign	DELETE /campaigns/{id}/	Delete a campaign
BehavioralSignalsAIMCClient.CampaignsApi	getCampaign	GET /campaigns/{id}/	Get a campaign
BehavioralSignalsAIMCClient.CampaignsApi	getCampaigns	GET /campaigns/	Returns a list of campaigns
BehavioralSignalsAIMCClient.CampaignsApi	updateCampaign	PUT /campaigns/{id}/	Update a campaign
BehavioralSignalsAIMCClient.CampaignslegacyApi	getLegacyCampaigns	GET /campaignslegacy/	Returns a list of legacy campaigns
BehavioralSignalsAIMCClient.EmployeesApi	getEmployeeDetails	GET /employees/{employee_id}/	Returns details for an employee
BehavioralSignalsAIMCClient.EmployeesApi	getEmployeesList	GET /employees/	Returns list of tenant's employees.
BehavioralSignalsAIMCClient.JobsApi	getJobAudioStream	GET /jobs/{job_id}/streamaudio/	Get stream audio for job identified by id
BehavioralSignalsAIMCClient.JobsApi	getJobHighlights	GET /jobs/{job_id}/highlights/	Get highlights for an audio associated with a job
BehavioralSignalsAIMCClient.JobsApi	getJobJobId	GET /jobs/{job_id}/	Returns details for job identified by id.
BehavioralSignalsAIMCClient.JobsApi	getJobResults	GET /jobs/{job_id}/results/	Get behavioral results for and audio associated with a job
BehavioralSignalsAIMCClient.JobsApi	getJobs	GET /jobs/	Returns a list of jobs.
BehavioralSignalsAIMCClient.JobsApi	postJob	POST /jobs/create/	Endpoint not functional
BehavioralSignalsAIMCClient.JobsApi	uploadJobBundle	POST /jobs/upload/	Upload a new job bundle
BehavioralSignalsAIMCClient.MatchesApi	getAgentCustomerMatches	GET /matches/	Get agent-customer best matches
BehavioralSignalsAIMCClient.MetricsApi	getAgentsMetrics	GET /agents/metrics/	Returns agent-related metrics
BehavioralSignalsAIMCClient.MetricsApi	getCallMetrics	GET /calls/metrics/	Returns call-related metrics
BehavioralSignalsAIMCClient.MetricsApi	getCounts	GET /counts/	Returns the number of items for specific resources
BehavioralSignalsAIMCClient.NotificationsApi	postJobCreate	POST /jobs/create/process/{process_id}	Schedule a new job creation after receiving notification from an internal service
BehavioralSignalsAIMCClient.NotificationsApi	updateUserNotify	PUT /me/notify/	Updates the notified property of the user
BehavioralSignalsAIMCClient.ProcessesApi	getProcessAudioStream	GET /processes/{process_id}/streamaudio/	Get audio stream for a call associated with a process
BehavioralSignalsAIMCClient.ProcessesApi	getProcessResults	GET /processes/{process_id}/results/	Get behavioral results for and audio associated with a process
BehavioralSignalsAIMCClient.StatusApi	getApiStatus	GET /status/	Get the status of the API
BehavioralSignalsAIMCClient.TenantApi	createTenant	POST /tenant/	Create a new tenant
BehavioralSignalsAIMCClient.TenantApi	revokeTenant	DELETE /tenant/	Revoke access for all users of a tenant
BehavioralSignalsAIMCClient.UsersApi	getMe	GET /me/	Returns self details for an authenticated user.
BehavioralSignalsAIMCClient.UsersApi	getUserDetails	GET /users/{user_id}/	Returns user details
BehavioralSignalsAIMCClient.UsersApi	getUserList	GET /users/	Returns a list of users with details depending on permissions
BehavioralSignalsAIMCClient.UsersApi	registerUser	POST /users/register/	Registers a new user

Documentation for Models

Documentation for Authorization

bearerAuth

Type: Bearer authentication (JWT)

@behavioralsignals/behavioralsignals-aimc-client

@behavioralsignals/behavioralsignals-aimc-client

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

bearerAuth