@behavioralsignals/behavioralsignals-uapi-client

    0.2.18 • Public • Published

    @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

    Class Method HTTP request Description
    BehavioralsignalsUapiClient.AccountsApi subscribeAccount POST /accounts/subscribe/ Subscribes for a new account
    BehavioralsignalsUapiClient.AgentsApi getAgents GET /agents/
    BehavioralsignalsUapiClient.AgentsApi getAggregatedAgents GET /aggregator/agents/ Returns a list of all agents
    BehavioralsignalsUapiClient.AgentsApi getAggregatedAgentsAgentId GET /aggregator/agents/{agent_id}/ Returns a list of all agents
    BehavioralsignalsUapiClient.AggregationsApi getAggregatedAgents GET /aggregator/agents/ Returns a list of all agents
    BehavioralsignalsUapiClient.AggregationsApi getAggregatedCalls GET /aggregator/calls/ Returns aggregations for a group of calls.
    BehavioralsignalsUapiClient.AggregationsApi getAggregatedCampaign GET /aggregator/campaigns/{id}/ Returns aggregations of a campaign.
    BehavioralsignalsUapiClient.AggregationsApi getAggregatedCampaigns GET /aggregator/campaigns/ Returns list of campaigns aggregations.
    BehavioralsignalsUapiClient.AggregationsApi getAggregatedLegacyCampaign GET /aggregator/campaignslegacy/{campaign_id}/ Returns details for a legacy campaign.
    BehavioralsignalsUapiClient.AggregationsApi getAggregatedLegacyCampaigns GET /aggregator/campaignslegacy/ Returns an aggregated list of legacy campaigns.
    BehavioralsignalsUapiClient.AnnotationsApi removeCallLock DELETE /calls/{id}/lock/ Removes the annotation lock of a call
    BehavioralsignalsUapiClient.AnnotationsApi updateCallAnnotation PUT /calls/{call_id}/annotations/ Annotate highlights for a call
    BehavioralsignalsUapiClient.AnnotationsApi updateCallLock PUT /calls/{id}/lock/ Locks or updates the annotation lock of a call
    BehavioralsignalsUapiClient.BookmarksApi addBookmark POST /bookmarks/ Assigns a specified call to a specific bookmark category
    BehavioralsignalsUapiClient.BookmarksApi deleteBookmarkCategory DELETE /bookmark-categories/{id}/ Delete a Bookmark Category
    BehavioralsignalsUapiClient.BookmarksApi getBookmarkCategories GET /bookmark-categories/ Returns a list of bookmark categories.
    BehavioralsignalsUapiClient.BookmarksApi getBookmarkCategory GET /bookmark-categories/{id}/ Get the data of a single bookmark category
    BehavioralsignalsUapiClient.BookmarksApi postBookmarkCategory POST /bookmark-categories/ Create a new Bookmark Category
    BehavioralsignalsUapiClient.BookmarksApi removeBookmark PUT /bookmarks/ Removes a specified call from a specific bookmark category
    BehavioralsignalsUapiClient.BookmarksApi updateBookmarkCategory PUT /bookmark-categories/{id}/ Update a Bookmark Category
    BehavioralsignalsUapiClient.CallsApi getAggregatedCalls GET /aggregator/calls/ Returns aggregations for a group of calls.
    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.CallsApi removeCallLock DELETE /calls/{id}/lock/ Removes the annotation lock of a call
    BehavioralsignalsUapiClient.CallsApi updateCallAnnotation PUT /calls/{call_id}/annotations/ Annotate highlights for a call
    BehavioralsignalsUapiClient.CallsApi updateCallLock PUT /calls/{id}/lock/ Locks or updates the annotation lock of a call
    BehavioralsignalsUapiClient.CampaignsApi createCampaign POST /campaigns/ Create a new campaign
    BehavioralsignalsUapiClient.CampaignsApi deleteCampaign DELETE /campaigns/{id}/ Delete a campaign
    BehavioralsignalsUapiClient.CampaignsApi getAggregatedCampaign GET /aggregator/campaigns/{id}/ Returns aggregations of a campaign.
    BehavioralsignalsUapiClient.CampaignsApi getAggregatedCampaigns GET /aggregator/campaigns/ Returns list of campaigns aggregations.
    BehavioralsignalsUapiClient.CampaignsApi getCampaign GET /campaigns/{id}/ Get a campaign
    BehavioralsignalsUapiClient.CampaignsApi getCampaigns GET /campaigns/
    BehavioralsignalsUapiClient.CampaignsApi updateCampaign PUT /campaigns/{id}/ Update a campaign
    BehavioralsignalsUapiClient.CampaignslegacyApi getAggregatedLegacyCampaign GET /aggregator/campaignslegacy/{campaign_id}/ Returns details for a legacy campaign.
    BehavioralsignalsUapiClient.CampaignslegacyApi getAggregatedLegacyCampaigns GET /aggregator/campaignslegacy/ Returns an aggregated list of legacy campaigns.
    BehavioralsignalsUapiClient.CampaignslegacyApi getLegacyCampaigns GET /campaignslegacy/
    BehavioralsignalsUapiClient.CompaniesApi getCompanies GET /aggregator/companies/ Returns a list of company objects.
    BehavioralsignalsUapiClient.ConfirmationApi confirmAccount GET /accounts/confirm/ Confirm subscription for the new account
    BehavioralsignalsUapiClient.EmployeesApi getEmployeeDetails GET /employees/{employee_id}/ Returns details for employee with id employee_id.
    BehavioralsignalsUapiClient.EmployeesApi getEmployeesList GET /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.JobsApi getJobAudioStream GET /jobs/{job_id}/streamaudio/ Get stream audio for job with id job_id
    BehavioralsignalsUapiClient.JobsApi getJobHighlights GET /jobs/{job_id}/highlights/ Get highlight results 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.JobsApi uploadJobBundle POST /jobs/upload/ Upload a new job bundle
    BehavioralsignalsUapiClient.MeApi getMe GET /me/ Returns self details for an authenticated user.
    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.ProfileApi updateUserNotify PUT /me/notify/ Updates the notified property of the user
    BehavioralsignalsUapiClient.TenantApi createTenant POST /tenant/ Creates a new tenant on all services
    BehavioralsignalsUapiClient.TenantApi revokeTenant DELETE /tenant/ Revokes a tenant from all services
    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
    BehavioralsignalsUapiClient.UsersApi updateUserNotify PUT /me/notify/ Updates the notified property of the user

    Documentation for Models

    Documentation for Authorization

    OAuth2

    Keywords

    none

    Install

    npm i @behavioralsignals/behavioralsignals-uapi-client

    DownloadsWeekly Downloads

    4

    Version

    0.2.18

    License

    Commercial

    Unpacked Size

    889 kB

    Total Files

    291

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar