@pulse-ai/pulse-ai-client
v0.0.15
Published
'JSclientlibraryforpulse-ai'
Downloads
1
Readme
@pulse-ai/pulse-ai-client
@PulseAiPulseAiClient - JavaScript client for @pulse-ai/pulse-ai-client API for building Pulse AI This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.15
- Package version: 0.0.15
- Build package: io.swagger.codegen.v3.generators.javascript.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 @pulse-ai/pulse-ai-client --save
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 @PulseAiPulseAiClient = require('@pulse-ai/pulse-ai-client');
var defaultClient = @PulseAiPulseAiClient.ApiClient.instance;
var api = new @PulseAiPulseAiClient.AccountApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.account(callback);
Documentation for API Endpoints
All URIs are relative to https://api.pulse-app.ai
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- @PulseAiPulseAiClient.AccountApi | account | GET /account | Get Account @PulseAiPulseAiClient.AccountApi | createAccount | POST /account | Create Account @PulseAiPulseAiClient.AccountApi | register | POST /register | @PulseAiPulseAiClient.AuthenticationApi | login | POST /signin | Authenticate User @PulseAiPulseAiClient.MoodApi | createMood | POST /mood | Create Mood @PulseAiPulseAiClient.MoodApi | getMoodHistogram | GET /mood/histogram | Get Mood Histogram @PulseAiPulseAiClient.SessionApi | createSession | POST /session | Create Session @PulseAiPulseAiClient.SessionApi | createSessionDeprecated | POST /session/create | @PulseAiPulseAiClient.SessionApi | deleteSession | DELETE /session/{id} | Delete Session @PulseAiPulseAiClient.SessionApi | endSession | PATCH /session/{id}/end | End Session @PulseAiPulseAiClient.SessionApi | endSessionDeprecated | POST /session/end/{sessionId} | @PulseAiPulseAiClient.SessionApi | getAllSessions | GET /session/all | @PulseAiPulseAiClient.SessionApi | getSession | GET /session/{id} | Get Session @PulseAiPulseAiClient.SessionApi | getSessionHistory | GET /session/session-history/{sessionId} | @PulseAiPulseAiClient.SessionApi | listSessionMessages | GET /session/{id}/messages | List Session Messages @PulseAiPulseAiClient.SessionApi | listSessions | GET /session | List Sessions @PulseAiPulseAiClient.SessionApi | patchSession | PATCH /session/{id} | Patch Session @PulseAiPulseAiClient.SessionHistogramApi | getSessionDurationHistogram | GET /session/histogram/duration | Get Session Duration Histogram @PulseAiPulseAiClient.SessionHistogramApi | getSessionEmotionsHistogram | GET /session/histogram/emotion | Get Session Emotion Histogram @PulseAiPulseAiClient.SessionHistogramApi | getSessionPeopleHistogram | GET /session/histogram/people | Get Session People Histogram
Documentation for Models
- @PulseAiPulseAiClient.AccountRequest
- @PulseAiPulseAiClient.AccountResponse
- @PulseAiPulseAiClient.AuthRequest
- @PulseAiPulseAiClient.AuthResponse
- @PulseAiPulseAiClient.ChatMessageResponse
- @PulseAiPulseAiClient.ChatSessionPatchRequest
- @PulseAiPulseAiClient.ChatSessionResponse
- @PulseAiPulseAiClient.ErrorResponse
- @PulseAiPulseAiClient.HistogramResponse
- @PulseAiPulseAiClient.MoodResponse