@xfloor/floor-memory-sdk-ts

v1.0.24

Published

a month ago

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

Downloads

215

0High
0Medium
0Low

xfloor

@xfloor/[email protected]

A TypeScript SDK client for the appfloor.in API.

Usage

First, install the SDK from npm.

npm install @xfloor/floor-memory-sdk-ts --save

Next, try it out.

import {
  Configuration,
  AuthApi,
} from '@xfloor/floor-memory-sdk-ts';
import type { ChangeEmailRequest } from '@xfloor/floor-memory-sdk-ts';

async function example() {
  console.log("🚀 Testing @xfloor/floor-memory-sdk-ts SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new AuthApi(config);

  const body = {
    // string | New Email ID
    newEmailId: newEmailId_example,
    // string | Validation code
    activationCode: activationCode_example,
  } satisfies ChangeEmailRequest;

  try {
    const data = await api.changeEmail(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://appfloor.in

| Class | Method | HTTP request |

Description | ----- | ------ | ------------ |

AuthApi

| changeEmail | POST /auth-service/change/email |

Change email ID AuthApi

| changeMobileNumber | POST /auth-service/change/mobile |

Change Mobile number AuthApi

| changePassword | POST /auth-service/password/change |

Change Password AuthApi

| resetPassword | POST /auth-service/password/reset |

Reset Password AuthApi

| sendValidationCode | POST /auth-service/send/validation/code |

Send Validation code AuthApi

| signInWithEmail | POST /auth-service/sign/in/with/email |

| signInWithMobileNumber | POST /auth-service/sign/in/with/mobile/number |

| signUp | POST /auth-service/sign/up |

| validateCode | POST /auth-service/validate/activation/code |

Validation EventApi

| event | POST /api/memory/events |

Create Event (Post Content) EventApi

| getRecentEvents | GET /api/memory/recent/events |

Recent Events FloorApi

| editFloor | POST /api/memory/edit/floor/{floor_id} |

Edit floor FloorApi

| getFloorInformation | GET /api/memory/floor/info/{floor_id} |

Basic information of a floor FloorApi

| makeFloorPrivate | POST /api/memory/make/floor/private/{floor_id} |

Make floor Private FloorApi

| makeFloorPublic | POST /api/memory/make/floor/public/{floor_id} |

Make floor public FloorApi

| renameFloor | POST /api/memory/change/floor/id |

Rename floor QueryApi

| query | POST /agent/memory/query |

Query (Primary API)

Models

Authorization

Authentication schemes defined for the API:

bearer

Type: HTTP Bearer Token authentication

About

This TypeScript SDK client supports the Fetch API and 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.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

For more information, please visit https://xfloor.ai/ipomo/blog1551084548304/

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

MIT

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