@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.24
• 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 defaultClient = XfloorFloorMemorySdkJs.ApiClient.instance;
// Configure Bearer access token for authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.accessToken = "YOUR ACCESS TOKEN"

var api = new XfloorFloorMemorySdkJs.AuthApi()
var newEmailId = "newEmailId_example"; // {String} New Email ID
var activationCode = "activationCode_example"; // {String} Validation code
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.changeEmail(newEmailId, activationCode, callback);

Documentation for API Endpoints

| Class | Method | HTTP request | Description | | --- | --- | --- | --- | | XfloorFloorMemorySdkJs.AuthApi | changeEmail | POST /auth-service/change/email | Change email ID | | XfloorFloorMemorySdkJs.AuthApi | changeMobileNumber | POST /auth-service/change/mobile | Change Mobile number | | XfloorFloorMemorySdkJs.AuthApi | changePassword | POST /auth-service/password/change | Change Password | | XfloorFloorMemorySdkJs.AuthApi | resetPassword | POST /auth-service/password/reset | Reset Password | | XfloorFloorMemorySdkJs.AuthApi | sendValidationCode | POST /auth-service/send/validation/code | Send Validation code | | XfloorFloorMemorySdkJs.AuthApi | signInWithEmail | POST /auth-service/sign/in/with/email | Sign In with email ID | | XfloorFloorMemorySdkJs.AuthApi | signInWithMobileNumber | POST /auth-service/sign/in/with/mobile/number | Sign In with Mobile number | | XfloorFloorMemorySdkJs.AuthApi | signUp | POST /auth-service/sign/up | Sign Up | | XfloorFloorMemorySdkJs.AuthApi | validateCode | POST /auth-service/validate/activation/code | Validation | | XfloorFloorMemorySdkJs.EventApi | event | POST /api/memory/events | Create Event (Post Content) | | XfloorFloorMemorySdkJs.EventApi | getRecentEvents | GET /api/memory/recent/events | Recent Events | | XfloorFloorMemorySdkJs.FloorApi | editFloor | POST /api/memory/edit/floor/{floor_id} | Edit floor | | XfloorFloorMemorySdkJs.FloorApi | getFloorInformation | GET /api/memory/floor/info/{floor_id} | Basic information of a floor | | XfloorFloorMemorySdkJs.FloorApi | makeFloorPrivate | POST /api/memory/make/floor/private/{floor_id} | Make floor Private | | XfloorFloorMemorySdkJs.FloorApi | makeFloorPublic | POST /api/memory/make/floor/public/{floor_id} | Make floor public | | XfloorFloorMemorySdkJs.FloorApi | renameFloor | POST /api/memory/change/floor/id | Rename floor | | XfloorFloorMemorySdkJs.QueryApi | query | POST /agent/memory/query | Query (Primary API) |

Documentation for Models

• XfloorFloorMemorySdkJs.BlockDetails
• XfloorFloorMemorySdkJs.ChangePassword200Response
• XfloorFloorMemorySdkJs.EditFloor200Response
• XfloorFloorMemorySdkJs.EditFloor400Response
• XfloorFloorMemorySdkJs.EditFloor400ResponseError
• XfloorFloorMemorySdkJs.Event400Response
• XfloorFloorMemorySdkJs.Event400ResponseError
• XfloorFloorMemorySdkJs.EventResponse
• XfloorFloorMemorySdkJs.FloorInfo
• XfloorFloorMemorySdkJs.GetRecentEvents200Response
• XfloorFloorMemorySdkJs.GetRecentEvents200ResponseItemsInner
• XfloorFloorMemorySdkJs.GetRecentEvents200ResponseItemsInnerAuthor
• XfloorFloorMemorySdkJs.GetRecentEvents400Response
• XfloorFloorMemorySdkJs.GetRecentEvents400ResponseError
• XfloorFloorMemorySdkJs.Media
• XfloorFloorMemorySdkJs.Model400ErrorCode
• XfloorFloorMemorySdkJs.Query422Response
• XfloorFloorMemorySdkJs.Query422ResponseError
• XfloorFloorMemorySdkJs.QueryRequest
• XfloorFloorMemorySdkJs.QueryRequestFilters
• XfloorFloorMemorySdkJs.QueryResponse
• XfloorFloorMemorySdkJs.QueryResponseItemsInner
• XfloorFloorMemorySdkJs.Remaining
• XfloorFloorMemorySdkJs.ResetPassword200Response
• XfloorFloorMemorySdkJs.ResetPassword400Response
• XfloorFloorMemorySdkJs.SendValidationCode200Response
• XfloorFloorMemorySdkJs.SignInResponse
• XfloorFloorMemorySdkJs.SignUp200Response
• XfloorFloorMemorySdkJs.SignUpResponse
• XfloorFloorMemorySdkJs.UserDetails
• XfloorFloorMemorySdkJs.UserDetailsPodInfo
• XfloorFloorMemorySdkJs.UserDetailsProfile
• XfloorFloorMemorySdkJs.UserDetailsProfileAvatar
• XfloorFloorMemorySdkJs.ValidateCode400Response
• XfloorFloorMemorySdkJs.ValidateCode400ResponseError
• XfloorFloorMemorySdkJs.ValidateCode412Response

Documentation for Authorization

Authentication schemes defined for the API:

bearer

• Type: Bearer authentication

Platform Notes (macOS, Linux, Windows)

macOS / Linux

npm install
npm run build

Windows (PowerShell or CMD)

npm install
npm run build

The npm commands are the same across operating systems. For local path references, use OS-specific path formats:

• macOS/Linux: /path/to/project
• Windows: C:\path\to\project