bmlt-server-semantic-client 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/release.yml +25 -0
- package/.openapi-generator/FILES +44 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/Makefile +31 -0
- package/README.md +125 -0
- package/dist/apis/FieldsApi.d.ts +56 -0
- package/dist/apis/FieldsApi.js +123 -0
- package/dist/apis/FormatsApi.d.ts +44 -0
- package/dist/apis/FormatsApi.js +87 -0
- package/dist/apis/MeetingsApi.d.ts +157 -0
- package/dist/apis/MeetingsApi.js +288 -0
- package/dist/apis/ServerApi.d.ts +43 -0
- package/dist/apis/ServerApi.js +104 -0
- package/dist/apis/ServiceBodiesApi.d.ts +51 -0
- package/dist/apis/ServiceBodiesApi.js +91 -0
- package/dist/apis/index.d.ts +5 -0
- package/dist/apis/index.js +23 -0
- package/dist/esm/apis/FieldsApi.d.ts +56 -0
- package/dist/esm/apis/FieldsApi.js +119 -0
- package/dist/esm/apis/FormatsApi.d.ts +44 -0
- package/dist/esm/apis/FormatsApi.js +83 -0
- package/dist/esm/apis/MeetingsApi.d.ts +157 -0
- package/dist/esm/apis/MeetingsApi.js +284 -0
- package/dist/esm/apis/ServerApi.d.ts +43 -0
- package/dist/esm/apis/ServerApi.js +100 -0
- package/dist/esm/apis/ServiceBodiesApi.d.ts +51 -0
- package/dist/esm/apis/ServiceBodiesApi.js +87 -0
- package/dist/esm/apis/index.d.ts +5 -0
- package/dist/esm/apis/index.js +7 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/models/Format.d.ts +81 -0
- package/dist/esm/models/Format.js +37 -0
- package/dist/esm/models/GetCoverageArea200Response.d.ts +50 -0
- package/dist/esm/models/GetCoverageArea200Response.js +47 -0
- package/dist/esm/models/GetFieldKeys200ResponseInner.d.ts +38 -0
- package/dist/esm/models/GetFieldKeys200ResponseInner.js +43 -0
- package/dist/esm/models/GetFieldValues200ResponseInner.d.ts +38 -0
- package/dist/esm/models/GetFieldValues200ResponseInner.js +43 -0
- package/dist/esm/models/GetSearchResults200Response.d.ts +24 -0
- package/dist/esm/models/GetSearchResults200Response.js +68 -0
- package/dist/esm/models/GetSearchResults200ResponseOneOf.d.ts +40 -0
- package/dist/esm/models/GetSearchResults200ResponseOneOf.js +45 -0
- package/dist/esm/models/Meeting.d.ts +255 -0
- package/dist/esm/models/Meeting.js +37 -0
- package/dist/esm/models/MeetingChange.d.ts +89 -0
- package/dist/esm/models/MeetingChange.js +37 -0
- package/dist/esm/models/ModelError.d.ts +33 -0
- package/dist/esm/models/ModelError.js +37 -0
- package/dist/esm/models/SemanticError.d.ts +33 -0
- package/dist/esm/models/SemanticError.js +37 -0
- package/dist/esm/models/SemanticFormat.d.ts +81 -0
- package/dist/esm/models/SemanticFormat.js +37 -0
- package/dist/esm/models/SemanticMeeting.d.ts +255 -0
- package/dist/esm/models/SemanticMeeting.js +37 -0
- package/dist/esm/models/SemanticMeetingChange.d.ts +89 -0
- package/dist/esm/models/SemanticMeetingChange.js +37 -0
- package/dist/esm/models/SemanticServerInfo.d.ts +156 -0
- package/dist/esm/models/SemanticServerInfo.js +45 -0
- package/dist/esm/models/SemanticServerInfoAggregatorModeEnabled.d.ts +21 -0
- package/dist/esm/models/SemanticServerInfoAggregatorModeEnabled.js +43 -0
- package/dist/esm/models/SemanticServiceBody.d.ts +87 -0
- package/dist/esm/models/SemanticServiceBody.js +37 -0
- package/dist/esm/models/ServerInfo.d.ts +156 -0
- package/dist/esm/models/ServerInfo.js +45 -0
- package/dist/esm/models/ServerInfoAggregatorModeEnabled.d.ts +21 -0
- package/dist/esm/models/ServerInfoAggregatorModeEnabled.js +43 -0
- package/dist/esm/models/ServiceBody.d.ts +87 -0
- package/dist/esm/models/ServiceBody.js +37 -0
- package/dist/esm/models/index.d.ts +12 -0
- package/dist/esm/models/index.js +14 -0
- package/dist/esm/runtime.d.ts +184 -0
- package/dist/esm/runtime.js +349 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +21 -0
- package/dist/models/Format.d.ts +81 -0
- package/dist/models/Format.js +44 -0
- package/dist/models/GetCoverageArea200Response.d.ts +50 -0
- package/dist/models/GetCoverageArea200Response.js +54 -0
- package/dist/models/GetFieldKeys200ResponseInner.d.ts +38 -0
- package/dist/models/GetFieldKeys200ResponseInner.js +50 -0
- package/dist/models/GetFieldValues200ResponseInner.d.ts +38 -0
- package/dist/models/GetFieldValues200ResponseInner.js +50 -0
- package/dist/models/GetSearchResults200Response.d.ts +24 -0
- package/dist/models/GetSearchResults200Response.js +74 -0
- package/dist/models/GetSearchResults200ResponseOneOf.d.ts +40 -0
- package/dist/models/GetSearchResults200ResponseOneOf.js +52 -0
- package/dist/models/Meeting.d.ts +255 -0
- package/dist/models/Meeting.js +44 -0
- package/dist/models/MeetingChange.d.ts +89 -0
- package/dist/models/MeetingChange.js +44 -0
- package/dist/models/ModelError.d.ts +33 -0
- package/dist/models/ModelError.js +44 -0
- package/dist/models/SemanticError.d.ts +33 -0
- package/dist/models/SemanticError.js +44 -0
- package/dist/models/SemanticFormat.d.ts +81 -0
- package/dist/models/SemanticFormat.js +44 -0
- package/dist/models/SemanticMeeting.d.ts +255 -0
- package/dist/models/SemanticMeeting.js +44 -0
- package/dist/models/SemanticMeetingChange.d.ts +89 -0
- package/dist/models/SemanticMeetingChange.js +44 -0
- package/dist/models/SemanticServerInfo.d.ts +156 -0
- package/dist/models/SemanticServerInfo.js +53 -0
- package/dist/models/SemanticServerInfoAggregatorModeEnabled.d.ts +21 -0
- package/dist/models/SemanticServerInfoAggregatorModeEnabled.js +49 -0
- package/dist/models/SemanticServiceBody.d.ts +87 -0
- package/dist/models/SemanticServiceBody.js +44 -0
- package/dist/models/ServerInfo.d.ts +156 -0
- package/dist/models/ServerInfo.js +53 -0
- package/dist/models/ServerInfoAggregatorModeEnabled.d.ts +21 -0
- package/dist/models/ServerInfoAggregatorModeEnabled.js +49 -0
- package/dist/models/ServiceBody.d.ts +87 -0
- package/dist/models/ServiceBody.js +44 -0
- package/dist/models/index.d.ts +12 -0
- package/dist/models/index.js +30 -0
- package/dist/runtime.d.ts +184 -0
- package/dist/runtime.js +365 -0
- package/docs/FieldsApi.md +139 -0
- package/docs/Format.md +50 -0
- package/docs/FormatsApi.md +83 -0
- package/docs/GetCoverageArea200Response.md +40 -0
- package/docs/GetFieldKeys200ResponseInner.md +36 -0
- package/docs/GetFieldValues200ResponseInner.md +36 -0
- package/docs/GetSearchResults200Response.md +36 -0
- package/docs/GetSearchResults200ResponseOneOf.md +36 -0
- package/docs/Meeting.md +109 -0
- package/docs/MeetingChange.md +52 -0
- package/docs/MeetingsApi.md +261 -0
- package/docs/ModelError.md +34 -0
- package/docs/SemanticError.md +34 -0
- package/docs/SemanticFormat.md +50 -0
- package/docs/SemanticMeeting.md +109 -0
- package/docs/SemanticMeetingChange.md +52 -0
- package/docs/SemanticServerInfo.md +72 -0
- package/docs/SemanticServerInfoAggregatorModeEnabled.md +33 -0
- package/docs/SemanticServiceBody.md +52 -0
- package/docs/ServerApi.md +124 -0
- package/docs/ServerInfo.md +72 -0
- package/docs/ServerInfoAggregatorModeEnabled.md +33 -0
- package/docs/ServiceBodiesApi.md +80 -0
- package/docs/ServiceBody.md +52 -0
- package/openapi.json +1 -0
- package/package.json +21 -0
- package/src/apis/FieldsApi.ts +145 -0
- package/src/apis/FormatsApi.ts +96 -0
- package/src/apis/MeetingsApi.ts +392 -0
- package/src/apis/ServerApi.ts +106 -0
- package/src/apis/ServiceBodiesApi.ts +99 -0
- package/src/apis/index.ts +7 -0
- package/src/index.ts +5 -0
- package/src/models/Format.ts +132 -0
- package/src/models/GetCoverageArea200Response.ts +89 -0
- package/src/models/GetFieldKeys200ResponseInner.ts +73 -0
- package/src/models/GetFieldValues200ResponseInner.ts +73 -0
- package/src/models/GetSearchResults200Response.ts +99 -0
- package/src/models/GetSearchResults200ResponseOneOf.ts +88 -0
- package/src/models/Meeting.ts +364 -0
- package/src/models/MeetingChange.ts +140 -0
- package/src/models/ModelError.ts +68 -0
- package/src/models/SemanticError.ts +68 -0
- package/src/models/SemanticFormat.ts +132 -0
- package/src/models/SemanticMeeting.ts +364 -0
- package/src/models/SemanticMeetingChange.ts +140 -0
- package/src/models/SemanticServerInfo.ts +239 -0
- package/src/models/SemanticServerInfoAggregatorModeEnabled.ts +55 -0
- package/src/models/SemanticServiceBody.ts +140 -0
- package/src/models/ServerInfo.ts +239 -0
- package/src/models/ServerInfoAggregatorModeEnabled.ts +55 -0
- package/src/models/ServiceBody.ts +140 -0
- package/src/models/index.ts +14 -0
- package/src/runtime.ts +449 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +16 -0
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
name: Publish to NPM
|
|
2
|
+
on:
|
|
3
|
+
push:
|
|
4
|
+
tags: ['*']
|
|
5
|
+
|
|
6
|
+
jobs:
|
|
7
|
+
build:
|
|
8
|
+
runs-on: ubuntu-24.04
|
|
9
|
+
steps:
|
|
10
|
+
- name: Checkout
|
|
11
|
+
uses: actions/checkout@v5
|
|
12
|
+
|
|
13
|
+
- name: Setup Node
|
|
14
|
+
uses: actions/setup-node@v6
|
|
15
|
+
with:
|
|
16
|
+
node-version: '20.x'
|
|
17
|
+
registry-url: 'https://registry.npmjs.org'
|
|
18
|
+
|
|
19
|
+
- name: Install dependencies and build 🔧
|
|
20
|
+
run: npm ci && npm run build && npm --no-git-tag-version version $GITHUB_REF_NAME
|
|
21
|
+
|
|
22
|
+
- name: Publish package on NPM 📦
|
|
23
|
+
run: npm publish
|
|
24
|
+
env:
|
|
25
|
+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
.gitignore
|
|
2
|
+
.npmignore
|
|
3
|
+
README.md
|
|
4
|
+
docs/FieldsApi.md
|
|
5
|
+
docs/FormatsApi.md
|
|
6
|
+
docs/GetCoverageArea200Response.md
|
|
7
|
+
docs/GetFieldKeys200ResponseInner.md
|
|
8
|
+
docs/GetFieldValues200ResponseInner.md
|
|
9
|
+
docs/GetSearchResults200Response.md
|
|
10
|
+
docs/GetSearchResults200ResponseOneOf.md
|
|
11
|
+
docs/MeetingsApi.md
|
|
12
|
+
docs/SemanticError.md
|
|
13
|
+
docs/SemanticFormat.md
|
|
14
|
+
docs/SemanticMeeting.md
|
|
15
|
+
docs/SemanticMeetingChange.md
|
|
16
|
+
docs/SemanticServerInfo.md
|
|
17
|
+
docs/SemanticServerInfoAggregatorModeEnabled.md
|
|
18
|
+
docs/SemanticServiceBody.md
|
|
19
|
+
docs/ServerApi.md
|
|
20
|
+
docs/ServiceBodiesApi.md
|
|
21
|
+
package.json
|
|
22
|
+
src/apis/FieldsApi.ts
|
|
23
|
+
src/apis/FormatsApi.ts
|
|
24
|
+
src/apis/MeetingsApi.ts
|
|
25
|
+
src/apis/ServerApi.ts
|
|
26
|
+
src/apis/ServiceBodiesApi.ts
|
|
27
|
+
src/apis/index.ts
|
|
28
|
+
src/index.ts
|
|
29
|
+
src/models/GetCoverageArea200Response.ts
|
|
30
|
+
src/models/GetFieldKeys200ResponseInner.ts
|
|
31
|
+
src/models/GetFieldValues200ResponseInner.ts
|
|
32
|
+
src/models/GetSearchResults200Response.ts
|
|
33
|
+
src/models/GetSearchResults200ResponseOneOf.ts
|
|
34
|
+
src/models/SemanticError.ts
|
|
35
|
+
src/models/SemanticFormat.ts
|
|
36
|
+
src/models/SemanticMeeting.ts
|
|
37
|
+
src/models/SemanticMeetingChange.ts
|
|
38
|
+
src/models/SemanticServerInfo.ts
|
|
39
|
+
src/models/SemanticServerInfoAggregatorModeEnabled.ts
|
|
40
|
+
src/models/SemanticServiceBody.ts
|
|
41
|
+
src/models/index.ts
|
|
42
|
+
src/runtime.ts
|
|
43
|
+
tsconfig.esm.json
|
|
44
|
+
tsconfig.json
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
7.23.0-SNAPSHOT
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# OpenAPI Generator Ignore
|
|
2
|
+
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
|
3
|
+
|
|
4
|
+
# Use this file to prevent files from being overwritten by the generator.
|
|
5
|
+
# The patterns follow closely to .gitignore or .dockerignore.
|
|
6
|
+
|
|
7
|
+
# As an example, the C# client generator defines ApiClient.cs.
|
|
8
|
+
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
|
9
|
+
#ApiClient.cs
|
|
10
|
+
|
|
11
|
+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
|
12
|
+
#foo/*/qux
|
|
13
|
+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
|
14
|
+
|
|
15
|
+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
|
16
|
+
#foo/**/qux
|
|
17
|
+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
|
18
|
+
|
|
19
|
+
# You can also negate patterns with an exclamation (!).
|
|
20
|
+
# For example, you can ignore all files in a docs folder with the file extension .md:
|
|
21
|
+
#docs/*.md
|
|
22
|
+
# Then explicitly reverse the ignore rule for a single file:
|
|
23
|
+
#!docs/README.md
|
package/Makefile
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
.PHONY: generate clean
|
|
2
|
+
|
|
3
|
+
# The semantic OpenAPI spec is exposed by bmlt-server when the `semantic`
|
|
4
|
+
# l5-swagger documentation is configured. To bootstrap locally before that
|
|
5
|
+
# endpoint exists, drop a spec at ./openapi.json and `make generate` will
|
|
6
|
+
# use it (the curl step only runs if openapi.json is missing).
|
|
7
|
+
openapi.json:
|
|
8
|
+
curl http://localhost:8000/main_server/api/v1/openapi-semantic.json > openapi.json
|
|
9
|
+
|
|
10
|
+
generate: openapi.json
|
|
11
|
+
rm -rf src/resources/npm/api-client
|
|
12
|
+
docker run --rm -v "$(shell pwd):/local" -w /local openapitools/openapi-generator-cli generate \
|
|
13
|
+
-i openapi.json \
|
|
14
|
+
-g typescript-fetch \
|
|
15
|
+
-p npmName=bmlt-server-semantic-client \
|
|
16
|
+
-p npmVersion=1.0.0 \
|
|
17
|
+
-p supportsES6=true \
|
|
18
|
+
--git-repo-id=bmlt-server-semantic-typescript-client \
|
|
19
|
+
--git-user-id=bmlt-enabled \
|
|
20
|
+
-o .
|
|
21
|
+
@# Patch runtime.ts so query params don't produce a double-`?` when the
|
|
22
|
+
@# operation path already contains one (the semantic API keys each
|
|
23
|
+
@# `switcher` operation by a path that embeds `?switcher=...`).
|
|
24
|
+
@sed -i.bak "s|url += '?' + this.configuration.queryParamsStringify|url += (context.path.indexOf('?') >= 0 ? '\\&' : '?') + this.configuration.queryParamsStringify|" src/runtime.ts
|
|
25
|
+
@rm -f src/runtime.ts.bak
|
|
26
|
+
@grep -q "context.path.indexOf" src/runtime.ts || (echo "ERROR: runtime.ts sed patch did not match — openapi-generator template may have changed" && exit 1)
|
|
27
|
+
@echo "runtime.ts patched for embedded query strings."
|
|
28
|
+
|
|
29
|
+
clean:
|
|
30
|
+
rm -f openapi.json
|
|
31
|
+
rm -rf src
|
package/README.md
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# bmlt-server-semantic-client@1.0.0
|
|
2
|
+
|
|
3
|
+
A TypeScript SDK client for the localhost API.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
First, install the SDK from npm.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install bmlt-server-semantic-client --save
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Next, try it out.
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
import {
|
|
18
|
+
Configuration,
|
|
19
|
+
FieldsApi,
|
|
20
|
+
} from 'bmlt-server-semantic-client';
|
|
21
|
+
import type { GetFieldKeysRequest } from 'bmlt-server-semantic-client';
|
|
22
|
+
|
|
23
|
+
async function example() {
|
|
24
|
+
console.log("🚀 Testing bmlt-server-semantic-client SDK...");
|
|
25
|
+
const api = new FieldsApi();
|
|
26
|
+
|
|
27
|
+
try {
|
|
28
|
+
const data = await api.getFieldKeys();
|
|
29
|
+
console.log(data);
|
|
30
|
+
} catch (error) {
|
|
31
|
+
console.error(error);
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
// Run the test
|
|
36
|
+
example().catch(console.error);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
## Documentation
|
|
41
|
+
|
|
42
|
+
### API Endpoints
|
|
43
|
+
|
|
44
|
+
All URIs are relative to *http://localhost:8000/main_server*
|
|
45
|
+
|
|
46
|
+
| Class | Method | HTTP request | Description
|
|
47
|
+
| ----- | ------ | ------------ | -------------
|
|
48
|
+
*FieldsApi* | [**getFieldKeys**](docs/FieldsApi.md#getfieldkeys) | **GET** /client_interface/json/?switcher=GetFieldKeys | Get all available field keys
|
|
49
|
+
*FieldsApi* | [**getFieldValues**](docs/FieldsApi.md#getfieldvalues) | **GET** /client_interface/json/?switcher=GetFieldValues | Get distinct values for a field
|
|
50
|
+
*FormatsApi* | [**getSemanticFormats**](docs/FormatsApi.md#getsemanticformats) | **GET** /client_interface/json/?switcher=GetFormats | Get meeting formats
|
|
51
|
+
*MeetingsApi* | [**getChanges**](docs/MeetingsApi.md#getchanges) | **GET** /client_interface/json/?switcher=GetChanges | Get meeting changes within a date range
|
|
52
|
+
*MeetingsApi* | [**getSearchResults**](docs/MeetingsApi.md#getsearchresults) | **GET** /client_interface/json/?switcher=GetSearchResults | Search for meetings
|
|
53
|
+
*ServerApi* | [**getCoverageArea**](docs/ServerApi.md#getcoveragearea) | **GET** /client_interface/json/?switcher=GetCoverageArea | Get the geographic coverage bounding box for this server
|
|
54
|
+
*ServerApi* | [**getSemanticServerInfo**](docs/ServerApi.md#getsemanticserverinfo) | **GET** /client_interface/json/?switcher=GetServerInfo | Get server information
|
|
55
|
+
*ServiceBodiesApi* | [**getSemanticServiceBodies**](docs/ServiceBodiesApi.md#getsemanticservicebodies) | **GET** /client_interface/json/?switcher=GetServiceBodies | Get service bodies
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
### Models
|
|
59
|
+
|
|
60
|
+
- [GetCoverageArea200Response](docs/GetCoverageArea200Response.md)
|
|
61
|
+
- [GetFieldKeys200ResponseInner](docs/GetFieldKeys200ResponseInner.md)
|
|
62
|
+
- [GetFieldValues200ResponseInner](docs/GetFieldValues200ResponseInner.md)
|
|
63
|
+
- [GetSearchResults200Response](docs/GetSearchResults200Response.md)
|
|
64
|
+
- [GetSearchResults200ResponseOneOf](docs/GetSearchResults200ResponseOneOf.md)
|
|
65
|
+
- [SemanticError](docs/SemanticError.md)
|
|
66
|
+
- [SemanticFormat](docs/SemanticFormat.md)
|
|
67
|
+
- [SemanticMeeting](docs/SemanticMeeting.md)
|
|
68
|
+
- [SemanticMeetingChange](docs/SemanticMeetingChange.md)
|
|
69
|
+
- [SemanticServerInfo](docs/SemanticServerInfo.md)
|
|
70
|
+
- [SemanticServerInfoAggregatorModeEnabled](docs/SemanticServerInfoAggregatorModeEnabled.md)
|
|
71
|
+
- [SemanticServiceBody](docs/SemanticServiceBody.md)
|
|
72
|
+
|
|
73
|
+
### Authorization
|
|
74
|
+
|
|
75
|
+
Endpoints do not require authorization.
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
## About
|
|
79
|
+
|
|
80
|
+
This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
|
|
81
|
+
and is automatically generated by the
|
|
82
|
+
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
83
|
+
|
|
84
|
+
- API version: `1.0.0`
|
|
85
|
+
- Package version: `1.0.0`
|
|
86
|
+
- Generator version: `7.23.0-SNAPSHOT`
|
|
87
|
+
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
88
|
+
|
|
89
|
+
The generated npm module supports the following:
|
|
90
|
+
|
|
91
|
+
- Environments
|
|
92
|
+
* Node.js
|
|
93
|
+
* Webpack
|
|
94
|
+
* Browserify
|
|
95
|
+
- Language levels
|
|
96
|
+
* ES5 - you must have a Promises/A+ library installed
|
|
97
|
+
* ES6
|
|
98
|
+
- Module systems
|
|
99
|
+
* CommonJS
|
|
100
|
+
* ES6 module system
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
## Development
|
|
104
|
+
|
|
105
|
+
### Building
|
|
106
|
+
|
|
107
|
+
To build the TypeScript source code, you need to have Node.js and npm installed.
|
|
108
|
+
After cloning the repository, navigate to the project directory and run:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
npm install
|
|
112
|
+
npm run build
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Publishing
|
|
116
|
+
|
|
117
|
+
Once you've built the package, you can publish it to npm:
|
|
118
|
+
|
|
119
|
+
```bash
|
|
120
|
+
npm publish
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## License
|
|
124
|
+
|
|
125
|
+
[]()
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* BMLT Semantic API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import { type GetFieldKeys200ResponseInner } from '../models/GetFieldKeys200ResponseInner';
|
|
14
|
+
import { type GetFieldValues200ResponseInner } from '../models/GetFieldValues200ResponseInner';
|
|
15
|
+
export interface GetFieldValuesRequest {
|
|
16
|
+
meetingKey: string;
|
|
17
|
+
specificFormats?: string;
|
|
18
|
+
allFormats?: GetFieldValuesAllFormatsEnum;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
*/
|
|
23
|
+
export declare class FieldsApi extends runtime.BaseAPI {
|
|
24
|
+
/**
|
|
25
|
+
* Creates request options for getFieldKeys without sending the request
|
|
26
|
+
*/
|
|
27
|
+
getFieldKeysRequestOpts(): Promise<runtime.RequestOpts>;
|
|
28
|
+
/**
|
|
29
|
+
* Get all available field keys
|
|
30
|
+
*/
|
|
31
|
+
getFieldKeysRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetFieldKeys200ResponseInner>>>;
|
|
32
|
+
/**
|
|
33
|
+
* Get all available field keys
|
|
34
|
+
*/
|
|
35
|
+
getFieldKeys(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetFieldKeys200ResponseInner>>;
|
|
36
|
+
/**
|
|
37
|
+
* Creates request options for getFieldValues without sending the request
|
|
38
|
+
*/
|
|
39
|
+
getFieldValuesRequestOpts(requestParameters: GetFieldValuesRequest): Promise<runtime.RequestOpts>;
|
|
40
|
+
/**
|
|
41
|
+
* Get distinct values for a field
|
|
42
|
+
*/
|
|
43
|
+
getFieldValuesRaw(requestParameters: GetFieldValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetFieldValues200ResponseInner>>>;
|
|
44
|
+
/**
|
|
45
|
+
* Get distinct values for a field
|
|
46
|
+
*/
|
|
47
|
+
getFieldValues(requestParameters: GetFieldValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetFieldValues200ResponseInner>>;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* @export
|
|
51
|
+
*/
|
|
52
|
+
export declare const GetFieldValuesAllFormatsEnum: {
|
|
53
|
+
readonly _0: "0";
|
|
54
|
+
readonly _1: "1";
|
|
55
|
+
};
|
|
56
|
+
export type GetFieldValuesAllFormatsEnum = typeof GetFieldValuesAllFormatsEnum[keyof typeof GetFieldValuesAllFormatsEnum];
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* BMLT Semantic API
|
|
6
|
+
* 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.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.GetFieldValuesAllFormatsEnum = exports.FieldsApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const GetFieldKeys200ResponseInner_1 = require("../models/GetFieldKeys200ResponseInner");
|
|
28
|
+
const GetFieldValues200ResponseInner_1 = require("../models/GetFieldValues200ResponseInner");
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
*/
|
|
32
|
+
class FieldsApi extends runtime.BaseAPI {
|
|
33
|
+
/**
|
|
34
|
+
* Creates request options for getFieldKeys without sending the request
|
|
35
|
+
*/
|
|
36
|
+
getFieldKeysRequestOpts() {
|
|
37
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
38
|
+
const queryParameters = {};
|
|
39
|
+
const headerParameters = {};
|
|
40
|
+
let urlPath = `/client_interface/json/?switcher=GetFieldKeys`;
|
|
41
|
+
return {
|
|
42
|
+
path: urlPath,
|
|
43
|
+
method: 'GET',
|
|
44
|
+
headers: headerParameters,
|
|
45
|
+
query: queryParameters,
|
|
46
|
+
};
|
|
47
|
+
});
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Get all available field keys
|
|
51
|
+
*/
|
|
52
|
+
getFieldKeysRaw(initOverrides) {
|
|
53
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
54
|
+
const requestOptions = yield this.getFieldKeysRequestOpts();
|
|
55
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
56
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetFieldKeys200ResponseInner_1.GetFieldKeys200ResponseInnerFromJSON));
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Get all available field keys
|
|
61
|
+
*/
|
|
62
|
+
getFieldKeys(initOverrides) {
|
|
63
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
64
|
+
const response = yield this.getFieldKeysRaw(initOverrides);
|
|
65
|
+
return yield response.value();
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Creates request options for getFieldValues without sending the request
|
|
70
|
+
*/
|
|
71
|
+
getFieldValuesRequestOpts(requestParameters) {
|
|
72
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
73
|
+
if (requestParameters['meetingKey'] == null) {
|
|
74
|
+
throw new runtime.RequiredError('meetingKey', 'Required parameter "meetingKey" was null or undefined when calling getFieldValues().');
|
|
75
|
+
}
|
|
76
|
+
const queryParameters = {};
|
|
77
|
+
if (requestParameters['meetingKey'] != null) {
|
|
78
|
+
queryParameters['meeting_key'] = requestParameters['meetingKey'];
|
|
79
|
+
}
|
|
80
|
+
if (requestParameters['specificFormats'] != null) {
|
|
81
|
+
queryParameters['specific_formats'] = requestParameters['specificFormats'];
|
|
82
|
+
}
|
|
83
|
+
if (requestParameters['allFormats'] != null) {
|
|
84
|
+
queryParameters['all_formats'] = requestParameters['allFormats'];
|
|
85
|
+
}
|
|
86
|
+
const headerParameters = {};
|
|
87
|
+
let urlPath = `/client_interface/json/?switcher=GetFieldValues`;
|
|
88
|
+
return {
|
|
89
|
+
path: urlPath,
|
|
90
|
+
method: 'GET',
|
|
91
|
+
headers: headerParameters,
|
|
92
|
+
query: queryParameters,
|
|
93
|
+
};
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Get distinct values for a field
|
|
98
|
+
*/
|
|
99
|
+
getFieldValuesRaw(requestParameters, initOverrides) {
|
|
100
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
101
|
+
const requestOptions = yield this.getFieldValuesRequestOpts(requestParameters);
|
|
102
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
103
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetFieldValues200ResponseInner_1.GetFieldValues200ResponseInnerFromJSON));
|
|
104
|
+
});
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Get distinct values for a field
|
|
108
|
+
*/
|
|
109
|
+
getFieldValues(requestParameters, initOverrides) {
|
|
110
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
111
|
+
const response = yield this.getFieldValuesRaw(requestParameters, initOverrides);
|
|
112
|
+
return yield response.value();
|
|
113
|
+
});
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
exports.FieldsApi = FieldsApi;
|
|
117
|
+
/**
|
|
118
|
+
* @export
|
|
119
|
+
*/
|
|
120
|
+
exports.GetFieldValuesAllFormatsEnum = {
|
|
121
|
+
_0: '0',
|
|
122
|
+
_1: '1'
|
|
123
|
+
};
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* BMLT Semantic API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import { type SemanticFormat } from '../models/SemanticFormat';
|
|
14
|
+
export interface GetSemanticFormatsRequest {
|
|
15
|
+
langEnum?: string;
|
|
16
|
+
showAll?: GetSemanticFormatsShowAllEnum;
|
|
17
|
+
formatIds?: string;
|
|
18
|
+
keyStrings?: string;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
*/
|
|
23
|
+
export declare class FormatsApi extends runtime.BaseAPI {
|
|
24
|
+
/**
|
|
25
|
+
* Creates request options for getSemanticFormats without sending the request
|
|
26
|
+
*/
|
|
27
|
+
getSemanticFormatsRequestOpts(requestParameters: GetSemanticFormatsRequest): Promise<runtime.RequestOpts>;
|
|
28
|
+
/**
|
|
29
|
+
* Get meeting formats
|
|
30
|
+
*/
|
|
31
|
+
getSemanticFormatsRaw(requestParameters: GetSemanticFormatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SemanticFormat>>>;
|
|
32
|
+
/**
|
|
33
|
+
* Get meeting formats
|
|
34
|
+
*/
|
|
35
|
+
getSemanticFormats(requestParameters?: GetSemanticFormatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SemanticFormat>>;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export declare const GetSemanticFormatsShowAllEnum: {
|
|
41
|
+
readonly _0: "0";
|
|
42
|
+
readonly _1: "1";
|
|
43
|
+
};
|
|
44
|
+
export type GetSemanticFormatsShowAllEnum = typeof GetSemanticFormatsShowAllEnum[keyof typeof GetSemanticFormatsShowAllEnum];
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* BMLT Semantic API
|
|
6
|
+
* 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.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.GetSemanticFormatsShowAllEnum = exports.FormatsApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const SemanticFormat_1 = require("../models/SemanticFormat");
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
class FormatsApi extends runtime.BaseAPI {
|
|
32
|
+
/**
|
|
33
|
+
* Creates request options for getSemanticFormats without sending the request
|
|
34
|
+
*/
|
|
35
|
+
getSemanticFormatsRequestOpts(requestParameters) {
|
|
36
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
37
|
+
const queryParameters = {};
|
|
38
|
+
if (requestParameters['langEnum'] != null) {
|
|
39
|
+
queryParameters['lang_enum'] = requestParameters['langEnum'];
|
|
40
|
+
}
|
|
41
|
+
if (requestParameters['showAll'] != null) {
|
|
42
|
+
queryParameters['show_all'] = requestParameters['showAll'];
|
|
43
|
+
}
|
|
44
|
+
if (requestParameters['formatIds'] != null) {
|
|
45
|
+
queryParameters['format_ids'] = requestParameters['formatIds'];
|
|
46
|
+
}
|
|
47
|
+
if (requestParameters['keyStrings'] != null) {
|
|
48
|
+
queryParameters['key_strings'] = requestParameters['keyStrings'];
|
|
49
|
+
}
|
|
50
|
+
const headerParameters = {};
|
|
51
|
+
let urlPath = `/client_interface/json/?switcher=GetFormats`;
|
|
52
|
+
return {
|
|
53
|
+
path: urlPath,
|
|
54
|
+
method: 'GET',
|
|
55
|
+
headers: headerParameters,
|
|
56
|
+
query: queryParameters,
|
|
57
|
+
};
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Get meeting formats
|
|
62
|
+
*/
|
|
63
|
+
getSemanticFormatsRaw(requestParameters, initOverrides) {
|
|
64
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
65
|
+
const requestOptions = yield this.getSemanticFormatsRequestOpts(requestParameters);
|
|
66
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
67
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(SemanticFormat_1.SemanticFormatFromJSON));
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Get meeting formats
|
|
72
|
+
*/
|
|
73
|
+
getSemanticFormats() {
|
|
74
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
75
|
+
const response = yield this.getSemanticFormatsRaw(requestParameters, initOverrides);
|
|
76
|
+
return yield response.value();
|
|
77
|
+
});
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
exports.FormatsApi = FormatsApi;
|
|
81
|
+
/**
|
|
82
|
+
* @export
|
|
83
|
+
*/
|
|
84
|
+
exports.GetSemanticFormatsShowAllEnum = {
|
|
85
|
+
_0: '0',
|
|
86
|
+
_1: '1'
|
|
87
|
+
};
|