[email protected]

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install bmlt-server-semantic-client --save

Next, try it out.

import {
  Configuration,
  FieldsApi,
} from 'bmlt-server-semantic-client';
import type { GetFieldKeysRequest } from 'bmlt-server-semantic-client';

async function example() {
  console.log("🚀 Testing bmlt-server-semantic-client SDK...");
  const api = new FieldsApi();

  try {
    const data = await api.getFieldKeys();
    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 | ----- | ------ | ------------ | ------------- FieldsApi | getFieldKeys | GET /client_interface/json/?switcher=GetFieldKeys | Get all available field keys FieldsApi | getFieldValues | GET /client_interface/json/?switcher=GetFieldValues | Get distinct values for a field FormatsApi | getSemanticFormats | GET /client_interface/json/?switcher=GetFormats | Get meeting formats MeetingsApi | getChanges | GET /client_interface/json/?switcher=GetChanges | Get meeting changes within a date range MeetingsApi | getSearchResults | GET /client_interface/json/?switcher=GetSearchResults | Search for meetings ServerApi | getCoverageArea | GET /client_interface/json/?switcher=GetCoverageArea | Get the geographic coverage bounding box for this server ServerApi | getSemanticServerInfo | GET /client_interface/json/?switcher=GetServerInfo | Get server information ServiceBodiesApi | getSemanticServiceBodies | GET /client_interface/json/?switcher=GetServiceBodies | Get service bodies

Models

• GetCoverageArea200Response
• GetFieldKeys200ResponseInner
• GetFieldValues200ResponseInner
• GetSearchResults200Response
• GetSearchResults200ResponseOneOf
• SemanticError
• SemanticFormat
• SemanticMeeting
• SemanticMeetingChange
• SemanticServerInfo
• SemanticServerInfoAggregatorModeEnabled
• SemanticServiceBody

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: 1.0.0
• Package version: 1.0.0
• Generator version: 7.23.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