@xfloor/floor-memory-sdk-js

v1.0.7

Published

15 hours ago

JavaScript SDK for xFloor Memory APIs (Memory + Registration).

Downloads

442

0High
0Medium
0Low

xfloor

@xfloor/floor-memory-sdk-js

XfloorFloorMemorySdkJs - JavaScript client for @xfloor/floor-memory-sdk-js The set APIs are used to develop Floor pds which can be used as their personal assistants.

This set of APIs are divided into two parts.

Memory and
Registration.

The developer has two ways of using the APIs for the app development. Developer can choose to the Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor. This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.7
Generator version: 7.18.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://xfloor.ai/ipomo/blog1551084548304/

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 @xfloor/floor-memory-sdk-js --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 @xfloor/floor-memory-sdk-js 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 XfloorFloorMemorySdkJs = require('@xfloor/floor-memory-sdk-js');


var api = new XfloorFloorMemorySdkJs.DefaultApi()
var inputInfo = "inputInfo_example"; // {String} 
var opts = {
  'icon': "/path/to/file" // {File} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiDeveloperCreateAppPost(inputInfo, opts, callback);

Documentation for API Endpoints

| Class | Method | HTTP request | Description | | --- | --- | --- | --- | | XfloorFloorMemorySdkJs.DefaultApi | apiDeveloperCreateAppPost | POST /api/developer/create/app | Create App | | XfloorFloorMemorySdkJs.DefaultApi | apiDeveloperModifyAppPost | POST /api/developer/modify/app | Modify Floorpod App | | XfloorFloorMemorySdkJs.DefaultApi | changeEmail | POST /auth-service/change/email | Change email ID | | XfloorFloorMemorySdkJs.DefaultApi | changeMobileNumber | POST /auth-service/change/mobile | Change Mobile number | | XfloorFloorMemorySdkJs.DefaultApi | changePassword | POST /auth-service/password/change | Change Password | | XfloorFloorMemorySdkJs.DefaultApi | conversationThreads | GET /agent/memory/threads | Get the conversational threads | | XfloorFloorMemorySdkJs.DefaultApi | getConversations | GET /agent/memory/conversations | Conversations | | XfloorFloorMemorySdkJs.DefaultApi | makeFloorPrivate | POST /api/memory/make/floor/private | Make floor Private | | XfloorFloorMemorySdkJs.DefaultApi | makeFloorPublic | POST /api/memory/make/floor/public | Make floor public | | XfloorFloorMemorySdkJs.DefaultApi | registerExternalUserIdentity | POST /memory/identity/external-user | External User Registration | | XfloorFloorMemorySdkJs.DefaultApi | renameFloor | POST /api/memory/change/floor/id | Rename floor | | XfloorFloorMemorySdkJs.DefaultApi | resetPassword | POST /auth-service/password/reset | Reset Password | | XfloorFloorMemorySdkJs.DefaultApi | sendSignInValidationCode | POST /auth-service/send/sign/in/validation/code | Send Sign-In Validation Code (OTP) | | XfloorFloorMemorySdkJs.DefaultApi | sendValidationCode | POST /auth-service/send/validation/code | Send Validation code | | XfloorFloorMemorySdkJs.DefaultApi | signInWithEmail | POST /auth-service/sign/in/with/email | Sign In with email ID | | XfloorFloorMemorySdkJs.DefaultApi | signInWithMobileNumber | POST /auth-service/sign/in/with/mobile/number | Sign In with Mobile number | | XfloorFloorMemorySdkJs.DefaultApi | signUp | POST /auth-service/sign/up | Sign Up | | XfloorFloorMemorySdkJs.DefaultApi | validateCode | POST /auth-service/validate/activation/code | Validation | | XfloorFloorMemorySdkJs.EditFloorApi | editFloor | POST /api/memory/edit/floor/{floor_id} | Edit floor | | XfloorFloorMemorySdkJs.EventApi | event | POST /api/memory/events | Create Event (Post Content) | | XfloorFloorMemorySdkJs.GetFloorInformationApi | getFloorInformation | GET /api/memory/floor/info/{floor_id} | Basic information of a floor | | XfloorFloorMemorySdkJs.GetRecentEventsApi | getRecentEvents | GET /api/memory/recent/events | Recent Events | | XfloorFloorMemorySdkJs.QueryApi | query | POST /agent/memory/query | Query (Primary API) |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@xfloor/floor-memory-sdk-js

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

bearer