bmlt-server-semantic-client 1.0.0

package/docs/SemanticFormat.md

@@ -0,0 +1,50 @@
+
+# SemanticFormat
+
+
+## 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 { SemanticFormat } 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 SemanticFormat
+
+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 SemanticFormat
+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/SemanticMeeting.md

@@ -0,0 +1,109 @@
+
+# SemanticMeeting
+
+A meeting record. The actual field set depends on the server\'s enabled fields and the `data_field_key` parameter.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`idBigint` | string
+`worldidMixed` | string
+`sharedGroupIdBigint` | string
+`serviceBodyBigint` | string
+`weekdayTinyint` | string
+`venueType` | string
+`startTime` | string
+`durationTime` | string
+`timeZone` | string
+`formats` | string
+`langEnum` | string
+`longitude` | string
+`latitude` | string
+`distanceInKm` | string
+`distanceInMiles` | string
+`meetingName` | string
+`locationText` | string
+`locationInfo` | string
+`locationStreet` | string
+`locationCitySubsection` | string
+`locationNeighborhood` | string
+`locationMunicipality` | string
+`locationSubProvince` | string
+`locationProvince` | string
+`locationPostalCode1` | string
+`locationNation` | string
+`comments` | string
+`trainLines` | string
+`busLines` | string
+`phoneMeetingNumber` | string
+`virtualMeetingLink` | string
+`virtualMeetingAdditionalInfo` | string
+`contactName1` | string
+`contactPhone1` | string
+`contactEmail1` | string
+`rootServerId` | string
+`rootServerUri` | string
+`formatSharedIdList` | string
+
+## Example
+
+```typescript
+import type { SemanticMeeting } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "idBigint": null,
+  "worldidMixed": null,
+  "sharedGroupIdBigint": null,
+  "serviceBodyBigint": null,
+  "weekdayTinyint": null,
+  "venueType": null,
+  "startTime": null,
+  "durationTime": null,
+  "timeZone": null,
+  "formats": null,
+  "langEnum": null,
+  "longitude": null,
+  "latitude": null,
+  "distanceInKm": null,
+  "distanceInMiles": null,
+  "meetingName": null,
+  "locationText": null,
+  "locationInfo": null,
+  "locationStreet": null,
+  "locationCitySubsection": null,
+  "locationNeighborhood": null,
+  "locationMunicipality": null,
+  "locationSubProvince": null,
+  "locationProvince": null,
+  "locationPostalCode1": null,
+  "locationNation": null,
+  "comments": null,
+  "trainLines": null,
+  "busLines": null,
+  "phoneMeetingNumber": null,
+  "virtualMeetingLink": null,
+  "virtualMeetingAdditionalInfo": null,
+  "contactName1": null,
+  "contactPhone1": null,
+  "contactEmail1": null,
+  "rootServerId": null,
+  "rootServerUri": null,
+  "formatSharedIdList": null,
+} satisfies SemanticMeeting
+
+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 SemanticMeeting
+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/SemanticMeetingChange.md

@@ -0,0 +1,52 @@
+
+# SemanticMeetingChange
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`dateInt` | string
+`dateString` | string
+`changeType` | string
+`meetingId` | string
+`meetingName` | string
+`userId` | string
+`userName` | string
+`serviceBodyId` | string
+`serviceBodyName` | string
+`details` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { SemanticMeetingChange } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "dateInt": null,
+  "dateString": null,
+  "changeType": null,
+  "meetingId": null,
+  "meetingName": null,
+  "userId": null,
+  "userName": null,
+  "serviceBodyId": null,
+  "serviceBodyName": null,
+  "details": null,
+} satisfies SemanticMeetingChange
+
+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 SemanticMeetingChange
+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/SemanticServerInfo.md

@@ -0,0 +1,72 @@
+
+# SemanticServerInfo
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`version` | string
+`versionInt` | string
+`langs` | string
+`nativeLang` | string
+`centerLongitude` | string
+`centerLatitude` | string
+`centerZoom` | string
+`defaultDuration` | string
+`regionBias` | string
+`charSet` | string
+`distanceUnits` | string
+`semanticAdmin` | string
+`emailEnabled` | string
+`emailIncludesServiceBodies` | string
+`changesPerMeeting` | string
+`meetingStatesAndProvinces` | string
+`meetingCountiesAndSubProvinces` | string
+`availableKeys` | string
+`googleApiKey` | string
+`aggregatorModeEnabled` | [SemanticServerInfoAggregatorModeEnabled](SemanticServerInfoAggregatorModeEnabled.md)
+
+## Example
+
+```typescript
+import type { SemanticServerInfo } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "version": null,
+  "versionInt": null,
+  "langs": null,
+  "nativeLang": null,
+  "centerLongitude": null,
+  "centerLatitude": null,
+  "centerZoom": null,
+  "defaultDuration": null,
+  "regionBias": null,
+  "charSet": null,
+  "distanceUnits": null,
+  "semanticAdmin": null,
+  "emailEnabled": null,
+  "emailIncludesServiceBodies": null,
+  "changesPerMeeting": null,
+  "meetingStatesAndProvinces": null,
+  "meetingCountiesAndSubProvinces": null,
+  "availableKeys": null,
+  "googleApiKey": null,
+  "aggregatorModeEnabled": null,
+} satisfies SemanticServerInfo
+
+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 SemanticServerInfo
+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/SemanticServerInfoAggregatorModeEnabled.md

@@ -0,0 +1,33 @@
+
+# SemanticServerInfoAggregatorModeEnabled
+
+`1` / `true` if this server is running in aggregator mode.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { SemanticServerInfoAggregatorModeEnabled } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies SemanticServerInfoAggregatorModeEnabled
+
+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 SemanticServerInfoAggregatorModeEnabled
+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/SemanticServiceBody.md

@@ -0,0 +1,52 @@
+
+# SemanticServiceBody
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`parentId` | string
+`name` | string
+`description` | string
+`type` | string
+`url` | string
+`helpline` | string
+`worldId` | string
+`rootServerId` | string
+`rootServerUri` | string
+
+## Example
+
+```typescript
+import type { SemanticServiceBody } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "parentId": null,
+  "name": null,
+  "description": null,
+  "type": null,
+  "url": null,
+  "helpline": null,
+  "worldId": null,
+  "rootServerId": null,
+  "rootServerUri": null,
+} satisfies SemanticServiceBody
+
+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 SemanticServiceBody
+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/ServerApi.md

@@ -0,0 +1,124 @@
+# ServerApi
+
+All URIs are relative to *http://localhost:8000/main_server*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getCoverageArea**](ServerApi.md#getcoveragearea) | **GET** /client_interface/json/?switcher=GetCoverageArea | Get the geographic coverage bounding box for this server |
+| [**getSemanticServerInfo**](ServerApi.md#getsemanticserverinfo) | **GET** /client_interface/json/?switcher=GetServerInfo | Get server information |
+
+
+
+## getCoverageArea
+
+> GetCoverageArea200Response getCoverageArea()
+
+Get the geographic coverage bounding box for this server
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServerApi,
+} from 'bmlt-server-semantic-client';
+import type { GetCoverageAreaRequest } from 'bmlt-server-semantic-client';
+
+async function example() {
+  console.log("🚀 Testing bmlt-server-semantic-client SDK...");
+  const api = new ServerApi();
+
+  try {
+    const data = await api.getCoverageArea();
+    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
+
+[**GetCoverageArea200Response**](GetCoverageArea200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Bounding box for the area covered by this server\'s meetings |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSemanticServerInfo
+
+> Array<SemanticServerInfo> getSemanticServerInfo()
+
+Get server information
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServerApi,
+} from 'bmlt-server-semantic-client';
+import type { GetSemanticServerInfoRequest } from 'bmlt-server-semantic-client';
+
+async function example() {
+  console.log("🚀 Testing bmlt-server-semantic-client SDK...");
+  const api = new ServerApi();
+
+  try {
+    const data = await api.getSemanticServerInfo();
+    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<SemanticServerInfo>**](SemanticServerInfo.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Server metadata such as version, language, semantic admin URL, etc. |  -  |
+
+[[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/ServerInfo.md

@@ -0,0 +1,72 @@
+
+# ServerInfo
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`version` | string
+`versionInt` | string
+`langs` | string
+`nativeLang` | string
+`centerLongitude` | string
+`centerLatitude` | string
+`centerZoom` | string
+`defaultDuration` | string
+`regionBias` | string
+`charSet` | string
+`distanceUnits` | string
+`semanticAdmin` | string
+`emailEnabled` | string
+`emailIncludesServiceBodies` | string
+`changesPerMeeting` | string
+`meetingStatesAndProvinces` | string
+`meetingCountiesAndSubProvinces` | string
+`availableKeys` | string
+`googleApiKey` | string
+`aggregatorModeEnabled` | [ServerInfoAggregatorModeEnabled](ServerInfoAggregatorModeEnabled.md)
+
+## Example
+
+```typescript
+import type { ServerInfo } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "version": null,
+  "versionInt": null,
+  "langs": null,
+  "nativeLang": null,
+  "centerLongitude": null,
+  "centerLatitude": null,
+  "centerZoom": null,
+  "defaultDuration": null,
+  "regionBias": null,
+  "charSet": null,
+  "distanceUnits": null,
+  "semanticAdmin": null,
+  "emailEnabled": null,
+  "emailIncludesServiceBodies": null,
+  "changesPerMeeting": null,
+  "meetingStatesAndProvinces": null,
+  "meetingCountiesAndSubProvinces": null,
+  "availableKeys": null,
+  "googleApiKey": null,
+  "aggregatorModeEnabled": null,
+} satisfies ServerInfo
+
+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 ServerInfo
+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/ServerInfoAggregatorModeEnabled.md

@@ -0,0 +1,33 @@
+
+# ServerInfoAggregatorModeEnabled
+
+1 / true if this server is running in aggregator mode.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ServerInfoAggregatorModeEnabled } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ServerInfoAggregatorModeEnabled
+
+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 ServerInfoAggregatorModeEnabled
+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/ServiceBodiesApi.md

@@ -0,0 +1,80 @@
+# ServiceBodiesApi
+
+All URIs are relative to *http://localhost:8000/main_server*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getSemanticServiceBodies**](ServiceBodiesApi.md#getsemanticservicebodies) | **GET** /client_interface/json/?switcher=GetServiceBodies | Get service bodies |
+
+
+
+## getSemanticServiceBodies
+
+> Array<SemanticServiceBody> getSemanticServiceBodies(services, recursive, parents)
+
+Get service bodies
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServiceBodiesApi,
+} from 'bmlt-server-semantic-client';
+import type { GetSemanticServiceBodiesRequest } from 'bmlt-server-semantic-client';
+
+async function example() {
+  console.log("🚀 Testing bmlt-server-semantic-client SDK...");
+  const api = new ServiceBodiesApi();
+
+  const body = {
+    // string | Service body IDs as comma-separated values. Positive includes, negative excludes. (optional)
+    services: services_example,
+    // '0' | '1' | Set to `1` to include child service bodies when filtering by `services`. (optional)
+    recursive: recursive_example,
+    // '0' | '1' | Set to `1` to include parent service bodies in the result. (optional)
+    parents: parents_example,
+  } satisfies GetSemanticServiceBodiesRequest;
+
+  try {
+    const data = await api.getSemanticServiceBodies(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **services** | `string` | Service body IDs as comma-separated values. Positive includes, negative excludes. | [Optional] [Defaults to `undefined`] |
+| **recursive** | `0`, `1` | Set to `1` to include child service bodies when filtering by `services`. | [Optional] [Defaults to `undefined`] [Enum: 0, 1] |
+| **parents** | `0`, `1` | Set to `1` to include parent service bodies in the result. | [Optional] [Defaults to `undefined`] [Enum: 0, 1] |
+
+### Return type
+
+[**Array<SemanticServiceBody>**](SemanticServiceBody.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 service bodies |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+