bmlt-server-semantic-client 1.0.0

package/dist/models/ServerInfoAggregatorModeEnabled.js

@@ -0,0 +1,49 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * BMLT Semantic API
+ * OpenAPI description of the Basic Meeting List Toolbox (BMLT) Semantic Interface 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  - **PHP array syntax** — repeatable array parameters use trailing `[]` in the name (`weekdays[]=2&weekdays[]=3`). The parameter names in this spec preserve the brackets so generated clients emit them. - **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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerInfoAggregatorModeEnabledFromJSON = ServerInfoAggregatorModeEnabledFromJSON;
+exports.ServerInfoAggregatorModeEnabledFromJSONTyped = ServerInfoAggregatorModeEnabledFromJSONTyped;
+exports.ServerInfoAggregatorModeEnabledToJSON = ServerInfoAggregatorModeEnabledToJSON;
+exports.ServerInfoAggregatorModeEnabledToJSONTyped = ServerInfoAggregatorModeEnabledToJSONTyped;
+function ServerInfoAggregatorModeEnabledFromJSON(json) {
+    return ServerInfoAggregatorModeEnabledFromJSONTyped(json, false);
+}
+function ServerInfoAggregatorModeEnabledFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    if (typeof json === 'string') {
+        return json;
+    }
+    if (typeof json === 'boolean') {
+        return json;
+    }
+    return {};
+}
+function ServerInfoAggregatorModeEnabledToJSON(json) {
+    return ServerInfoAggregatorModeEnabledToJSONTyped(json, false);
+}
+function ServerInfoAggregatorModeEnabledToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    if (typeof value === 'string') {
+        return value;
+    }
+    if (typeof value === 'boolean') {
+        return value;
+    }
+    return {};
+}

package/dist/models/ServiceBody.d.ts

@@ -0,0 +1,87 @@
+/**
+ * BMLT Semantic API
+ * OpenAPI description of the Basic Meeting List Toolbox (BMLT) Semantic Interface 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  - **PHP array syntax** — repeatable array parameters use trailing `[]` in the name (`weekdays[]=2&weekdays[]=3`). The parameter names in this spec preserve the brackets so generated clients emit them. - **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.
+ */
+/**
+ *
+ * @export
+ * @interface ServiceBody
+ */
+export interface ServiceBody {
+    [key: string]: any | any;
+    /**
+     *
+     * @type {string}
+     * @memberof ServiceBody
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ServiceBody
+     */
+    parentId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ServiceBody
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ServiceBody
+     */
+    description?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ServiceBody
+     */
+    type?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ServiceBody
+     */
+    url?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ServiceBody
+     */
+    helpline?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ServiceBody
+     */
+    worldId?: string;
+    /**
+     * Aggregator mode only.
+     * @type {string}
+     * @memberof ServiceBody
+     */
+    rootServerId?: string;
+    /**
+     * Aggregator mode only.
+     * @type {string}
+     * @memberof ServiceBody
+     */
+    rootServerUri?: string;
+}
+/**
+ * Check if a given object implements the ServiceBody interface.
+ */
+export declare function instanceOfServiceBody(value: object): value is ServiceBody;
+export declare function ServiceBodyFromJSON(json: any): ServiceBody;
+export declare function ServiceBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ServiceBody;
+export declare function ServiceBodyToJSON(json: any): ServiceBody;
+export declare function ServiceBodyToJSONTyped(value?: ServiceBody | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ServiceBody.js

@@ -0,0 +1,44 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * BMLT Semantic API
+ * OpenAPI description of the Basic Meeting List Toolbox (BMLT) Semantic Interface 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  - **PHP array syntax** — repeatable array parameters use trailing `[]` in the name (`weekdays[]=2&weekdays[]=3`). The parameter names in this spec preserve the brackets so generated clients emit them. - **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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfServiceBody = instanceOfServiceBody;
+exports.ServiceBodyFromJSON = ServiceBodyFromJSON;
+exports.ServiceBodyFromJSONTyped = ServiceBodyFromJSONTyped;
+exports.ServiceBodyToJSON = ServiceBodyToJSON;
+exports.ServiceBodyToJSONTyped = ServiceBodyToJSONTyped;
+/**
+ * Check if a given object implements the ServiceBody interface.
+ */
+function instanceOfServiceBody(value) {
+    return true;
+}
+function ServiceBodyFromJSON(json) {
+    return ServiceBodyFromJSONTyped(json, false);
+}
+function ServiceBodyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return Object.assign(Object.assign({}, json), { 'id': json['id'] == null ? undefined : json['id'], 'parentId': json['parent_id'] == null ? undefined : json['parent_id'], 'name': json['name'] == null ? undefined : json['name'], 'description': json['description'] == null ? undefined : json['description'], 'type': json['type'] == null ? undefined : json['type'], 'url': json['url'] == null ? undefined : json['url'], 'helpline': json['helpline'] == null ? undefined : json['helpline'], 'worldId': json['world_id'] == null ? undefined : json['world_id'], 'rootServerId': json['root_server_id'] == null ? undefined : json['root_server_id'], 'rootServerUri': json['root_server_uri'] == null ? undefined : json['root_server_uri'] });
+}
+function ServiceBodyToJSON(json) {
+    return ServiceBodyToJSONTyped(json, false);
+}
+function ServiceBodyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return Object.assign(Object.assign({}, value), { 'id': value['id'], 'parent_id': value['parentId'], 'name': value['name'], 'description': value['description'], 'type': value['type'], 'url': value['url'], 'helpline': value['helpline'], 'world_id': value['worldId'], 'root_server_id': value['rootServerId'], 'root_server_uri': value['rootServerUri'] });
+}

package/dist/models/index.d.ts

@@ -0,0 +1,12 @@
+export * from './GetCoverageArea200Response';
+export * from './GetFieldKeys200ResponseInner';
+export * from './GetFieldValues200ResponseInner';
+export * from './GetSearchResults200Response';
+export * from './GetSearchResults200ResponseOneOf';
+export * from './SemanticError';
+export * from './SemanticFormat';
+export * from './SemanticMeeting';
+export * from './SemanticMeetingChange';
+export * from './SemanticServerInfo';
+export * from './SemanticServerInfoAggregatorModeEnabled';
+export * from './SemanticServiceBody';

package/dist/models/index.js

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./GetCoverageArea200Response"), exports);
+__exportStar(require("./GetFieldKeys200ResponseInner"), exports);
+__exportStar(require("./GetFieldValues200ResponseInner"), exports);
+__exportStar(require("./GetSearchResults200Response"), exports);
+__exportStar(require("./GetSearchResults200ResponseOneOf"), exports);
+__exportStar(require("./SemanticError"), exports);
+__exportStar(require("./SemanticFormat"), exports);
+__exportStar(require("./SemanticMeeting"), exports);
+__exportStar(require("./SemanticMeetingChange"), exports);
+__exportStar(require("./SemanticServerInfo"), exports);
+__exportStar(require("./SemanticServerInfoAggregatorModeEnabled"), exports);
+__exportStar(require("./SemanticServiceBody"), exports);

package/dist/runtime.d.ts

@@ -0,0 +1,184 @@
+/**
+ * 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.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * 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.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function mapValues(data: any, fn: (item: any) => any): {
+    [key: string]: any;
+};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}