bmlt-server-semantic-client 1.0.0

package/dist/runtime.js

@@ -0,0 +1,365 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * BMLT Semantic API
+ * OpenAPI description of the BMLT Semantic Interface (the read-only meeting-query API) for the JSON data format.  The semantic interface dispatches all operations from a single endpoint (`/client_interface/json/`) using a `switcher` query parameter. To keep each operation discoverable, this spec models each `switcher` value as a distinct path key with the query string baked in. Tools such as Swagger UI, Redoc, and openapi-generator handle these path keys correctly even though the OpenAPI spec technically expects unique URL paths.  ### Things that do not map cleanly onto OpenAPI  - **Sign-as-operator** — many filters (`formats`, `services`, `weekdays`, `venue_types`, `meeting_ids`, `root_server_ids`, `format_ids`) use *positive* values to include and *negative* values to exclude. JSON Schema cannot enforce that semantics; it is documented per parameter. - **Cross-parameter constraints** — in aggregator mode `GetSearchResults` requires at least one filter parameter. Invalid combinations typically return an empty array `[]` instead of an HTTP error. - **Empty-array errors** — many endpoints return `[]` for invalid input rather than a 4xx response body.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextApiResponse = exports.BlobApiResponse = exports.VoidApiResponse = exports.JSONApiResponse = exports.COLLECTION_FORMATS = exports.RequiredError = exports.FetchError = exports.ResponseError = exports.BaseAPI = exports.DefaultConfig = exports.Configuration = exports.BASE_PATH = void 0;
+exports.querystring = querystring;
+exports.exists = exists;
+exports.mapValues = mapValues;
+exports.canConsumeForm = canConsumeForm;
+exports.BASE_PATH = "http://localhost:8000/main_server".replace(/\/+$/, "");
+class Configuration {
+    constructor(configuration = {}) {
+        this.configuration = configuration;
+    }
+    set config(configuration) {
+        this.configuration = configuration;
+    }
+    get basePath() {
+        return this.configuration.basePath != null ? this.configuration.basePath : exports.BASE_PATH;
+    }
+    get fetchApi() {
+        return this.configuration.fetchApi;
+    }
+    get middleware() {
+        return this.configuration.middleware || [];
+    }
+    get queryParamsStringify() {
+        return this.configuration.queryParamsStringify || querystring;
+    }
+    get username() {
+        return this.configuration.username;
+    }
+    get password() {
+        return this.configuration.password;
+    }
+    get apiKey() {
+        const apiKey = this.configuration.apiKey;
+        if (apiKey) {
+            return typeof apiKey === 'function' ? apiKey : () => apiKey;
+        }
+        return undefined;
+    }
+    get accessToken() {
+        const accessToken = this.configuration.accessToken;
+        if (accessToken) {
+            return typeof accessToken === 'function' ? accessToken : () => __awaiter(this, void 0, void 0, function* () { return accessToken; });
+        }
+        return undefined;
+    }
+    get headers() {
+        return this.configuration.headers;
+    }
+    get credentials() {
+        return this.configuration.credentials;
+    }
+}
+exports.Configuration = Configuration;
+exports.DefaultConfig = new Configuration();
+/**
+ * This is the base class for all generated API classes.
+ */
+class BaseAPI {
+    constructor(configuration = exports.DefaultConfig) {
+        this.configuration = configuration;
+        this.fetchApi = (url, init) => __awaiter(this, void 0, void 0, function* () {
+            let fetchParams = { url, init };
+            for (const middleware of this.middleware) {
+                if (middleware.pre) {
+                    fetchParams = (yield middleware.pre(Object.assign({ fetch: this.fetchApi }, fetchParams))) || fetchParams;
+                }
+            }
+            let response = undefined;
+            try {
+                response = yield (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+            }
+            catch (e) {
+                for (const middleware of this.middleware) {
+                    if (middleware.onError) {
+                        response = (yield middleware.onError({
+                            fetch: this.fetchApi,
+                            url: fetchParams.url,
+                            init: fetchParams.init,
+                            error: e,
+                            response: response ? response.clone() : undefined,
+                        })) || response;
+                    }
+                }
+                if (response === undefined) {
+                    if (e instanceof Error) {
+                        throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
+                    }
+                    else {
+                        throw e;
+                    }
+                }
+            }
+            for (const middleware of this.middleware) {
+                if (middleware.post) {
+                    response = (yield middleware.post({
+                        fetch: this.fetchApi,
+                        url: fetchParams.url,
+                        init: fetchParams.init,
+                        response: response.clone(),
+                    })) || response;
+                }
+            }
+            return response;
+        });
+        this.middleware = configuration.middleware;
+    }
+    withMiddleware(...middlewares) {
+        const next = this.clone();
+        next.middleware = next.middleware.concat(...middlewares);
+        return next;
+    }
+    withPreMiddleware(...preMiddlewares) {
+        const middlewares = preMiddlewares.map((pre) => ({ pre }));
+        return this.withMiddleware(...middlewares);
+    }
+    withPostMiddleware(...postMiddlewares) {
+        const middlewares = postMiddlewares.map((post) => ({ post }));
+        return this.withMiddleware(...middlewares);
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        if (!mime) {
+            return false;
+        }
+        return BaseAPI.jsonRegex.test(mime);
+    }
+    request(context, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { url, init } = yield this.createFetchParams(context, initOverrides);
+            const response = yield this.fetchApi(url, init);
+            if (response && (response.status >= 200 && response.status < 300)) {
+                return response;
+            }
+            throw new ResponseError(response, 'Response returned an error code');
+        });
+    }
+    createFetchParams(context, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = this.configuration.basePath + context.path;
+            if (context.query !== undefined && Object.keys(context.query).length !== 0) {
+                // only add the querystring to the URL if there are query parameters.
+                // this is done to avoid urls ending with a "?" character which buggy webservers
+                // do not handle correctly sometimes.
+                url += (context.path.indexOf('?') >= 0 ? '&' : '?') + this.configuration.queryParamsStringify(context.query);
+            }
+            const headers = Object.assign({}, this.configuration.headers, context.headers);
+            Object.keys(headers).forEach(key => headers[key] === undefined ? delete headers[key] : {});
+            const initOverrideFn = typeof initOverrides === "function"
+                ? initOverrides
+                : () => __awaiter(this, void 0, void 0, function* () { return initOverrides; });
+            const initParams = {
+                method: context.method,
+                headers,
+                body: context.body,
+                credentials: this.configuration.credentials,
+            };
+            const overriddenInit = Object.assign(Object.assign({}, initParams), (yield initOverrideFn({
+                init: initParams,
+                context,
+            })));
+            let body;
+            if (isFormData(overriddenInit.body)
+                || (overriddenInit.body instanceof URLSearchParams)
+                || isBlob(overriddenInit.body)) {
+                body = overriddenInit.body;
+            }
+            else if (this.isJsonMime(headers['Content-Type'])) {
+                body = JSON.stringify(overriddenInit.body);
+            }
+            else {
+                body = overriddenInit.body;
+            }
+            const init = Object.assign(Object.assign({}, overriddenInit), { body });
+            return { url, init };
+        });
+    }
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    clone() {
+        const constructor = this.constructor;
+        const next = new constructor(this.configuration);
+        next.middleware = this.middleware.slice();
+        return next;
+    }
+}
+exports.BaseAPI = BaseAPI;
+BaseAPI.jsonRegex = /^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$/i;
+;
+function isBlob(value) {
+    return typeof Blob !== 'undefined' && value instanceof Blob;
+}
+function isFormData(value) {
+    return typeof FormData !== "undefined" && value instanceof FormData;
+}
+class ResponseError extends Error {
+    constructor(response, msg) {
+        super(msg);
+        this.response = response;
+        this.name = "ResponseError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
+    }
+}
+exports.ResponseError = ResponseError;
+class FetchError extends Error {
+    constructor(cause, msg) {
+        super(msg);
+        this.cause = cause;
+        this.name = "FetchError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
+    }
+}
+exports.FetchError = FetchError;
+class RequiredError extends Error {
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        this.name = "RequiredError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
+    }
+}
+exports.RequiredError = RequiredError;
+exports.COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+function querystring(params, prefix = '') {
+    return Object.keys(params)
+        .map(key => querystringSingleKey(key, params[key], prefix))
+        .filter(part => part.length > 0)
+        .join('&');
+}
+function querystringSingleKey(key, value, keyPrefix = '') {
+    const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
+    if (value instanceof Array) {
+        const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
+            .join(`&${encodeURIComponent(fullKey)}=`);
+        return `${encodeURIComponent(fullKey)}=${multiValue}`;
+    }
+    if (value instanceof Set) {
+        const valueAsArray = Array.from(value);
+        return querystringSingleKey(key, valueAsArray, keyPrefix);
+    }
+    if (value instanceof Date) {
+        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+    }
+    if (value instanceof Object) {
+        return querystring(value, fullKey);
+    }
+    return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
+}
+function exists(json, key) {
+    const value = json[key];
+    return value !== null && value !== undefined;
+}
+function mapValues(data, fn) {
+    const result = {};
+    for (const key of Object.keys(data)) {
+        result[key] = fn(data[key]);
+    }
+    return result;
+}
+function canConsumeForm(consumes) {
+    for (const consume of consumes) {
+        if ('multipart/form-data' === consume.contentType) {
+            return true;
+        }
+    }
+    return false;
+}
+class JSONApiResponse {
+    constructor(raw, transformer = (jsonValue) => jsonValue) {
+        this.raw = raw;
+        this.transformer = transformer;
+    }
+    value() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.transformer(yield this.raw.json());
+        });
+    }
+}
+exports.JSONApiResponse = JSONApiResponse;
+class VoidApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    value() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return undefined;
+        });
+    }
+}
+exports.VoidApiResponse = VoidApiResponse;
+class BlobApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    value() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.raw.blob();
+        });
+    }
+    ;
+}
+exports.BlobApiResponse = BlobApiResponse;
+class TextApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    value() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.raw.text();
+        });
+    }
+    ;
+}
+exports.TextApiResponse = TextApiResponse;

package/docs/FieldsApi.md

@@ -0,0 +1,139 @@
+# FieldsApi
+
+All URIs are relative to *http://localhost:8000/main_server*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getFieldKeys**](FieldsApi.md#getfieldkeys) | **GET** /client_interface/json/?switcher=GetFieldKeys | Get all available field keys |
+| [**getFieldValues**](FieldsApi.md#getfieldvalues) | **GET** /client_interface/json/?switcher=GetFieldValues | Get distinct values for a field |
+
+
+
+## getFieldKeys
+
+> Array<GetFieldKeys200ResponseInner> getFieldKeys()
+
+Get all available field keys
+
+### Example
+
+```ts
+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);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<GetFieldKeys200ResponseInner>**](GetFieldKeys200ResponseInner.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of field key descriptors |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getFieldValues
+
+> Array<GetFieldValues200ResponseInner> getFieldValues(meetingKey, specificFormats, allFormats)
+
+Get distinct values for a field
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FieldsApi,
+} from 'bmlt-server-semantic-client';
+import type { GetFieldValuesRequest } from 'bmlt-server-semantic-client';
+
+async function example() {
+  console.log("🚀 Testing bmlt-server-semantic-client SDK...");
+  const api = new FieldsApi();
+
+  const body = {
+    // string | Field key whose distinct values should be returned.
+    meetingKey: location_municipality,
+    // string | Comma-separated list of format IDs to limit the field values to. (optional)
+    specificFormats: specificFormats_example,
+    // '0' | '1' | Set to `1` to include all formats (not just `specific_formats`). (optional)
+    allFormats: allFormats_example,
+  } satisfies GetFieldValuesRequest;
+
+  try {
+    const data = await api.getFieldValues(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **meetingKey** | `string` | Field key whose distinct values should be returned. | [Defaults to `undefined`] |
+| **specificFormats** | `string` | Comma-separated list of format IDs to limit the field values to. | [Optional] [Defaults to `undefined`] |
+| **allFormats** | `0`, `1` | Set to `1` to include all formats (not just `specific_formats`). | [Optional] [Defaults to `undefined`] [Enum: 0, 1] |
+
+### Return type
+
+[**Array<GetFieldValues200ResponseInner>**](GetFieldValues200ResponseInner.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of distinct values with usage counts |  -  |
+| **400** | Bad request — usually a missing required parameter. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/Format.md

@@ -0,0 +1,50 @@
+
+# Format
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`keyString` | string
+`nameString` | string
+`descriptionString` | string
+`lang` | string
+`id` | string
+`worldId` | string
+`rootServerId` | string
+`rootServerUri` | string
+`formatTypeEnum` | string
+
+## Example
+
+```typescript
+import type { Format } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "keyString": null,
+  "nameString": null,
+  "descriptionString": null,
+  "lang": null,
+  "id": null,
+  "worldId": null,
+  "rootServerId": null,
+  "rootServerUri": null,
+  "formatTypeEnum": null,
+} satisfies Format
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Format
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FormatsApi.md

@@ -0,0 +1,83 @@
+# FormatsApi
+
+All URIs are relative to *http://localhost:8000/main_server*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getSemanticFormats**](FormatsApi.md#getsemanticformats) | **GET** /client_interface/json/?switcher=GetFormats | Get meeting formats |
+
+
+
+## getSemanticFormats
+
+> Array<SemanticFormat> getSemanticFormats(langEnum, showAll, formatIds, keyStrings)
+
+Get meeting formats
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FormatsApi,
+} from 'bmlt-server-semantic-client';
+import type { GetSemanticFormatsRequest } from 'bmlt-server-semantic-client';
+
+async function example() {
+  console.log("🚀 Testing bmlt-server-semantic-client SDK...");
+  const api = new FormatsApi();
+
+  const body = {
+    // string | Language code for translated format names (en, de, fr, es, it, pl, pt, sv, dk, fa). (optional)
+    langEnum: langEnum_example,
+    // '0' | '1' | Set to `1` to include all formats (including ones not currently used by any meeting). (optional)
+    showAll: showAll_example,
+    // string | Format IDs to include (positive) or exclude (negative). Comma-separated. (optional)
+    formatIds: 1,2,-3,
+    // string | Format key strings to filter by. Comma-separated. (optional)
+    keyStrings: O,C,
+  } satisfies GetSemanticFormatsRequest;
+
+  try {
+    const data = await api.getSemanticFormats(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **langEnum** | `string` | Language code for translated format names (en, de, fr, es, it, pl, pt, sv, dk, fa). | [Optional] [Defaults to `undefined`] |
+| **showAll** | `0`, `1` | Set to `1` to include all formats (including ones not currently used by any meeting). | [Optional] [Defaults to `undefined`] [Enum: 0, 1] |
+| **formatIds** | `string` | Format IDs to include (positive) or exclude (negative). Comma-separated. | [Optional] [Defaults to `undefined`] |
+| **keyStrings** | `string` | Format key strings to filter by. Comma-separated. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<SemanticFormat>**](SemanticFormat.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of formats |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/GetCoverageArea200Response.md

@@ -0,0 +1,40 @@
+
+# GetCoverageArea200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`nwCornerLongitude` | number
+`nwCornerLatitude` | number
+`seCornerLongitude` | number
+`seCornerLatitude` | number
+
+## Example
+
+```typescript
+import type { GetCoverageArea200Response } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "nwCornerLongitude": null,
+  "nwCornerLatitude": null,
+  "seCornerLongitude": null,
+  "seCornerLatitude": null,
+} satisfies GetCoverageArea200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetCoverageArea200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+