bmlt-server-client@1.4.0

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install bmlt-server-client --save

Next, try it out.

import {
  Configuration,
  RootServerApi,
} from 'bmlt-server-client';
import type { AuthLogoutRequest } from 'bmlt-server-client';

async function example() {
  console.log("🚀 Testing bmlt-server-client SDK...");
  const config = new Configuration({ 
    // To configure OAuth2 access token for authorization: bmltToken password
    accessToken: "YOUR ACCESS TOKEN",
  });
  const api = new RootServerApi(config);

  try {
    const data = await api.authLogout();
    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:8000/main_server

Class	Method	HTTP request	Description
RootServerApi	authLogout	POST /api/v1/auth/logout	Revokes a token
RootServerApi	authRefresh	POST /api/v1/auth/refresh	Revokes and issues a new token
RootServerApi	authToken	POST /api/v1/auth/token	Creates a token
RootServerApi	createErrorTest	POST /api/v1/errortest	Tests some errors
RootServerApi	createFormat	POST /api/v1/formats	Creates a format
RootServerApi	createMeeting	POST /api/v1/meetings	Creates a meeting
RootServerApi	createServiceBody	POST /api/v1/servicebodies	Creates a service body
RootServerApi	createUser	POST /api/v1/users	Creates a user
RootServerApi	deleteFormat	DELETE /api/v1/formats/{formatId}	Deletes a format
RootServerApi	deleteMeeting	DELETE /api/v1/meetings/{meetingId}	Deletes a meeting
RootServerApi	deleteServiceBody	DELETE /api/v1/servicebodies/{serviceBodyId}	Deletes a service body
RootServerApi	deleteUser	DELETE /api/v1/users/{userId}	Deletes a user
RootServerApi	getFormat	GET /api/v1/formats/{formatId}	Retrieves a format
RootServerApi	getFormats	GET /api/v1/formats	Retrieves formats
RootServerApi	getLaravelLog	GET /api/v1/logs/laravel	Retrieves laravel log
RootServerApi	getMeeting	GET /api/v1/meetings/{meetingId}	Retrieves a meeting
RootServerApi	getMeetingChanges	GET /api/v1/meetings/{meetingId}/changes	Retrieve changes for a meeting
RootServerApi	getMeetings	GET /api/v1/meetings	Retrieves meetings
RootServerApi	getRootServer	GET /api/v1/rootservers/{rootServerId}	Retrieves a root server
RootServerApi	getRootServers	GET /api/v1/rootservers	Retrieves root servers
RootServerApi	getServiceBodies	GET /api/v1/servicebodies	Retrieves service bodies
RootServerApi	getServiceBody	GET /api/v1/servicebodies/{serviceBodyId}	Retrieves a service body
RootServerApi	getSettings	GET /api/v1/settings	Retrieves all settings
RootServerApi	getUser	GET /api/v1/users/{userId}	Retrieves a single user
RootServerApi	getUsers	GET /api/v1/users	Retrieves users
RootServerApi	partialUpdateUser	PATCH /api/v1/users/{userId}	Patches a user
RootServerApi	patchFormat	PATCH /api/v1/formats/{formatId}	Patches a format
RootServerApi	patchMeeting	PATCH /api/v1/meetings/{meetingId}	Patches a meeting
RootServerApi	patchServiceBody	PATCH /api/v1/servicebodies/{serviceBodyId}	Patches a service body
RootServerApi	updateFormat	PUT /api/v1/formats/{formatId}	Updates a format
RootServerApi	updateMeeting	PUT /api/v1/meetings/{meetingId}	Updates a meeting
RootServerApi	updateServiceBody	PUT /api/v1/servicebodies/{serviceBodyId}	Updates a Service Body
RootServerApi	updateSettings	PATCH /api/v1/settings	Update settings
RootServerApi	updateUser	PUT /api/v1/users/{userId}	Update single user

Models

• AuthenticationError
• AuthorizationError
• ConflictError
• ErrorTest
• Format
• FormatBase
• FormatCreate
• FormatPartialUpdate
• FormatTranslation
• FormatUpdate
• Meeting
• MeetingBase
• MeetingChangeResource
• MeetingCreate
• MeetingPartialUpdate
• MeetingUpdate
• NotFoundError
• RootServer
• RootServerBase
• RootServerBaseStatistics
• RootServerBaseStatisticsMeetings
• RootServerBaseStatisticsServiceBodies
• ServerError
• ServiceBody
• ServiceBodyBase
• ServiceBodyCreate
• ServiceBodyPartialUpdate
• ServiceBodyUpdate
• SettingsBase
• SettingsObject
• SettingsUpdate
• Token
• TokenCredentials
• User
• UserBase
• UserCreate
• UserPartialUpdate
• UserUpdate
• ValidationError

Authorization

Authentication schemes defined for the API:

bmltToken password

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A

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.4.0
• Generator version: 7.19.0-SNAPSHOT
• 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

MIT