@intellex/shared-client

v0.1.1

Published

Intellex API TypeScript client (generated from OpenAPI)

Downloads

90

Readme

@intellex/[email protected]

TypeScript SDK client for the Intellex API (generated from OpenAPI).

Usage

First, install the SDK from npm.

npm install @intellex/shared-client --save

Next, try it out.

import {
  Configuration,
  AuthApi,
} from '@intellex/shared-client';
import type { CurrentUserAuthMeGetRequest } from 'intellex-shared-client';

async function example() {
  console.log("🚀 Testing intellex-shared-client SDK...");
  const api = new AuthApi();

  const body = {
    // string | Email to fetch a specific user (optional)
    email: email_example,
    // string | Supabase auth/user id to fetch a specific user (optional)
    userId: userId_example,
    // boolean (optional)
    skipRevokedCheck: true,
    // string (optional)
    authorization: authorization_example,
    // string (optional)
    xDeviceId: xDeviceId_example,
  } satisfies CurrentUserAuthMeGetRequest;

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

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

Documentation

API Endpoints

All URIs are relative to http://localhost

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AuthApi | currentUserAuthMeGet | GET /auth/me | Current User AuthApi | deleteAccountAuthAccountDelete | DELETE /auth/account | Delete Account AuthApi | deleteDeviceAuthDevicesDeviceIdDelete | DELETE /auth/devices/{deviceId} | Delete Device AuthApi | listDevicesAuthDevicesGet | GET /auth/devices | List Devices AuthApi | loginAuthLoginPost | POST /auth/login | Login AuthApi | revokeDevicesAuthDevicesRevokePost | POST /auth/devices/revoke | Revoke Devices AuthApi | upsertDeviceAuthDevicesPost | POST /auth/devices | Upsert Device DefaultApi | dbHealthHealthDbGet | GET /health/db | Db Health DefaultApi | healthCheckHealthGet | GET /health | Health Check DefaultApi | rootGet | GET / | Root DefaultApi | supabaseHealthHealthSupabaseGet | GET /health/supabase | Supabase Health ProjectsApi | createProjectProjectsPost | POST /projects | Create Project ProjectsApi | deleteProjectProjectsProjectIdDelete | DELETE /projects/{project_id} | Delete Project ProjectsApi | getMessagesProjectsProjectIdMessagesGet | GET /projects/{project_id}/messages | Get Messages ProjectsApi | getPlanProjectsProjectIdPlanGet | GET /projects/{project_id}/plan | Get Plan ProjectsApi | getProjectProjectsProjectIdGet | GET /projects/{project_id} | Get Project ProjectsApi | listProjectSharesProjectsProjectIdSharesGet | GET /projects/{project_id}/shares | List Project Shares ProjectsApi | listProjectsProjectsGet | GET /projects | List Projects ProjectsApi | projectStatsProjectsStatsGet | GET /projects/stats | Project Stats ProjectsApi | recentActivityProjectsActivityGet | GET /projects/activity | Recent Activity ProjectsApi | revokeProjectShareProjectsProjectIdSharesShareIdDelete | DELETE /projects/{project_id}/shares/{share_id} | Revoke Project Share ProjectsApi | sendMessageProjectsProjectIdMessagesPost | POST /projects/{project_id}/messages | Send Message ProjectsApi | shareProjectProjectsProjectIdSharesPost | POST /projects/{project_id}/shares | Share Project ProjectsApi | updateProjectProjectsProjectIdPatch | PATCH /projects/{project_id} | Update Project UsersApi | getApiKeysUsersApiKeysGet | GET /users/api-keys | Get Api Keys UsersApi | saveApiKeysUsersApiKeysPost | POST /users/api-keys | Save Api Keys

Models

Authorization

Endpoints do not require authorization.

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

  • API version: 0.2.0
  • Package version: 0.0.1-SNAPSHOT.202512112103
  • Generator version: 7.17.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

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