bmlt-server-semantic-client 1.0.0

package/docs/GetFieldKeys200ResponseInner.md

@@ -0,0 +1,36 @@
+
+# GetFieldKeys200ResponseInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { GetFieldKeys200ResponseInner } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "description": null,
+} satisfies GetFieldKeys200ResponseInner
+
+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 GetFieldKeys200ResponseInner
+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/GetFieldValues200ResponseInner.md

@@ -0,0 +1,36 @@
+
+# GetFieldValues200ResponseInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ids` | string
+`meetingKeyValue` | string
+
+## Example
+
+```typescript
+import type { GetFieldValues200ResponseInner } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ids": null,
+  "meetingKeyValue": null,
+} satisfies GetFieldValues200ResponseInner
+
+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 GetFieldValues200ResponseInner
+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/GetSearchResults200Response.md

@@ -0,0 +1,36 @@
+
+# GetSearchResults200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`meetings` | [Array<SemanticMeeting>](SemanticMeeting.md)
+`formats` | [Array<SemanticFormat>](SemanticFormat.md)
+
+## Example
+
+```typescript
+import type { GetSearchResults200Response } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "meetings": null,
+  "formats": null,
+} satisfies GetSearchResults200Response
+
+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 GetSearchResults200Response
+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/GetSearchResults200ResponseOneOf.md

@@ -0,0 +1,36 @@
+
+# GetSearchResults200ResponseOneOf
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`meetings` | [Array<SemanticMeeting>](SemanticMeeting.md)
+`formats` | [Array<SemanticFormat>](SemanticFormat.md)
+
+## Example
+
+```typescript
+import type { GetSearchResults200ResponseOneOf } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "meetings": null,
+  "formats": null,
+} satisfies GetSearchResults200ResponseOneOf
+
+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 GetSearchResults200ResponseOneOf
+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/Meeting.md

@@ -0,0 +1,109 @@
+
+# Meeting
+
+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 { Meeting } 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 Meeting
+
+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 Meeting
+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/MeetingChange.md

@@ -0,0 +1,52 @@
+
+# MeetingChange
+
+
+## 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 { MeetingChange } 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 MeetingChange
+
+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 MeetingChange
+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/MeetingsApi.md

@@ -0,0 +1,261 @@
+# MeetingsApi
+
+All URIs are relative to *http://localhost:8000/main_server*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getChanges**](MeetingsApi.md#getchanges) | **GET** /client_interface/json/?switcher=GetChanges | Get meeting changes within a date range |
+| [**getSearchResults**](MeetingsApi.md#getsearchresults) | **GET** /client_interface/json/?switcher=GetSearchResults | Search for meetings |
+
+
+
+## getChanges
+
+> Array<SemanticMeetingChange> getChanges(startDate, endDate, meetingId, serviceBodyId)
+
+Get meeting changes within a date range
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MeetingsApi,
+} from 'bmlt-server-semantic-client';
+import type { GetChangesRequest } from 'bmlt-server-semantic-client';
+
+async function example() {
+  console.log("🚀 Testing bmlt-server-semantic-client SDK...");
+  const api = new MeetingsApi();
+
+  const body = {
+    // Date | Start date (inclusive) in YYYY-MM-DD format. (optional)
+    startDate: 2013-10-20,
+    // Date | End date (inclusive) in YYYY-MM-DD format. (optional)
+    endDate: 2013-10-20,
+    // number | Restrict to changes for a single meeting. (optional)
+    meetingId: 56,
+    // number | Restrict to changes within a single service body. (optional)
+    serviceBodyId: 56,
+  } satisfies GetChangesRequest;
+
+  try {
+    const data = await api.getChanges(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **startDate** | `Date` | Start date (inclusive) in YYYY-MM-DD format. | [Optional] [Defaults to `undefined`] |
+| **endDate** | `Date` | End date (inclusive) in YYYY-MM-DD format. | [Optional] [Defaults to `undefined`] |
+| **meetingId** | `number` | Restrict to changes for a single meeting. | [Optional] [Defaults to `undefined`] |
+| **serviceBodyId** | `number` | Restrict to changes within a single service body. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<SemanticMeetingChange>**](SemanticMeetingChange.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 meeting changes |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSearchResults
+
+> GetSearchResults200Response getSearchResults(meetingIds, weekdays, venueTypes, formats, formatsComparisonOperator, services, recursive, getUsedFormats, getFormatsOnly, searchString, stringSearchIsAnAddress, searchStringRadius, startsAfterH, startsAfterM, startsBeforeH, startsBeforeM, endsBeforeH, endsBeforeM, minDurationH, minDurationM, maxDurationH, maxDurationM, latVal, longVal, geoWidth, geoWidthKm, sortResultsByDistance, meetingKey, meetingKeyValue, dataFieldKey, sortKeys, sortKey, pageSize, pageNum, advancedPublished, langEnum, rootServerIds)
+
+Search for meetings
+
+Search meetings with extensive filtering (location, day, time, format, service body, text). In aggregator mode at least one filter parameter is required, otherwise the response will be an empty array.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MeetingsApi,
+} from 'bmlt-server-semantic-client';
+import type { GetSearchResultsRequest } from 'bmlt-server-semantic-client';
+
+async function example() {
+  console.log("🚀 Testing bmlt-server-semantic-client SDK...");
+  const api = new MeetingsApi();
+
+  const body = {
+    // string | Comma-separated meeting IDs. Positive values include, negative values exclude (e.g. `123,456,-789`). (optional)
+    meetingIds: meetingIds_example,
+    // string | Days of week as comma-separated values. 1=Sunday … 7=Saturday. Negative values exclude. (optional)
+    weekdays: 2,3,4,
+    // string | Venue type filter, comma-separated. 1=In-person, 2=Virtual, 3=Hybrid. Negative values exclude. (optional)
+    venueTypes: venueTypes_example,
+    // string | Format IDs as comma-separated values. Positive includes, negative excludes. (optional)
+    formats: formats_example,
+    // 'AND' | 'OR' | Logical operator for combining multiple `formats` values. Defaults to AND. (optional)
+    formatsComparisonOperator: formatsComparisonOperator_example,
+    // 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 also return the formats used by the matched meetings (alters response shape to `{meetings, formats}`). (optional)
+    getUsedFormats: getUsedFormats_example,
+    // '0' | '1' | Set to `1` to return only the formats and omit the meetings (requires `get_used_formats=1`). (optional)
+    getFormatsOnly: getFormatsOnly_example,
+    // string | Free-text search string. URL-encode the value. (optional)
+    searchString: searchString_example,
+    // '0' | '1' | Set to `1` to interpret `SearchString` as an address to geocode. Requires a Google API key on the server. (optional)
+    stringSearchIsAnAddress: stringSearchIsAnAddress_example,
+    // number | Radius for address searches. Positive = distance (miles or km depending on server). Negative integer = auto-radius. (optional)
+    searchStringRadius: 8.14,
+    // number | Earliest start hour (0–23). (optional)
+    startsAfterH: 56,
+    // number | Earliest start minute (0–59). (optional)
+    startsAfterM: 56,
+    // number | Latest start hour (0–23). (optional)
+    startsBeforeH: 56,
+    // number | Latest start minute (0–59). (optional)
+    startsBeforeM: 56,
+    // number | Latest end hour (0–23). (optional)
+    endsBeforeH: 56,
+    // number | Latest end minute (0–59). (optional)
+    endsBeforeM: 56,
+    // number | Minimum duration, hours portion. (optional)
+    minDurationH: 56,
+    // number | Minimum duration, minutes portion (0–59). (optional)
+    minDurationM: 56,
+    // number | Maximum duration, hours portion. (optional)
+    maxDurationH: 56,
+    // number | Maximum duration, minutes portion (0–59). (optional)
+    maxDurationM: 56,
+    // number | Latitude for geographic search. (optional)
+    latVal: 3.4,
+    // number | Longitude for geographic search. (optional)
+    longVal: 3.4,
+    // number | Search radius in miles. Negative integer = auto-radius. (optional)
+    geoWidth: 8.14,
+    // number | Search radius in kilometers. Negative integer = auto-radius. (optional)
+    geoWidthKm: 8.14,
+    // '0' | '1' | Set to `1` to sort results by distance from `lat_val`/`long_val`. (optional)
+    sortResultsByDistance: sortResultsByDistance_example,
+    // string | Field key to filter on (used with `meeting_key_value`). (optional)
+    meetingKey: meetingKey_example,
+    // string | Value to match against the field named by `meeting_key`. (optional)
+    meetingKeyValue: meetingKeyValue_example,
+    // string | Comma-separated list of fields to include in each returned meeting (whitelist). (optional)
+    dataFieldKey: id_bigint,meeting_name,weekday_tinyint,start_time,
+    // string | Comma-separated list of fields to sort by. (optional)
+    sortKeys: sortKeys_example,
+    // 'weekday' | 'time' | 'town' | 'state' | 'weekday_state' | Predefined sort alias. (optional)
+    sortKey: sortKey_example,
+    // number | Number of results per page. (optional)
+    pageSize: 56,
+    // number | Page number, 1-based. Only meaningful when `page_size` is set. (optional)
+    pageNum: 56,
+    // -1 | 0 | Published-status filter. Omit to return only published meetings. `0` returns both. `-1` returns only unpublished (requires authentication). (optional)
+    advancedPublished: 56,
+    // string | Language code for translated format names (en, de, fr, es, it, pl, pt, sv, dk, fa). (optional)
+    langEnum: langEnum_example,
+    // string | Aggregator mode only. Comma-separated root server IDs. Positive includes, negative excludes. (optional)
+    rootServerIds: rootServerIds_example,
+  } satisfies GetSearchResultsRequest;
+
+  try {
+    const data = await api.getSearchResults(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **meetingIds** | `string` | Comma-separated meeting IDs. Positive values include, negative values exclude (e.g. `123,456,-789`). | [Optional] [Defaults to `undefined`] |
+| **weekdays** | `string` | Days of week as comma-separated values. 1=Sunday … 7=Saturday. Negative values exclude. | [Optional] [Defaults to `undefined`] |
+| **venueTypes** | `string` | Venue type filter, comma-separated. 1=In-person, 2=Virtual, 3=Hybrid. Negative values exclude. | [Optional] [Defaults to `undefined`] |
+| **formats** | `string` | Format IDs as comma-separated values. Positive includes, negative excludes. | [Optional] [Defaults to `undefined`] |
+| **formatsComparisonOperator** | `AND`, `OR` | Logical operator for combining multiple `formats` values. Defaults to AND. | [Optional] [Defaults to `'AND'`] [Enum: AND, OR] |
+| **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] |
+| **getUsedFormats** | `0`, `1` | Set to `1` to also return the formats used by the matched meetings (alters response shape to `{meetings, formats}`). | [Optional] [Defaults to `undefined`] [Enum: 0, 1] |
+| **getFormatsOnly** | `0`, `1` | Set to `1` to return only the formats and omit the meetings (requires `get_used_formats=1`). | [Optional] [Defaults to `undefined`] [Enum: 0, 1] |
+| **searchString** | `string` | Free-text search string. URL-encode the value. | [Optional] [Defaults to `undefined`] |
+| **stringSearchIsAnAddress** | `0`, `1` | Set to `1` to interpret `SearchString` as an address to geocode. Requires a Google API key on the server. | [Optional] [Defaults to `undefined`] [Enum: 0, 1] |
+| **searchStringRadius** | `number` | Radius for address searches. Positive = distance (miles or km depending on server). Negative integer = auto-radius. | [Optional] [Defaults to `undefined`] |
+| **startsAfterH** | `number` | Earliest start hour (0–23). | [Optional] [Defaults to `undefined`] |
+| **startsAfterM** | `number` | Earliest start minute (0–59). | [Optional] [Defaults to `undefined`] |
+| **startsBeforeH** | `number` | Latest start hour (0–23). | [Optional] [Defaults to `undefined`] |
+| **startsBeforeM** | `number` | Latest start minute (0–59). | [Optional] [Defaults to `undefined`] |
+| **endsBeforeH** | `number` | Latest end hour (0–23). | [Optional] [Defaults to `undefined`] |
+| **endsBeforeM** | `number` | Latest end minute (0–59). | [Optional] [Defaults to `undefined`] |
+| **minDurationH** | `number` | Minimum duration, hours portion. | [Optional] [Defaults to `undefined`] |
+| **minDurationM** | `number` | Minimum duration, minutes portion (0–59). | [Optional] [Defaults to `undefined`] |
+| **maxDurationH** | `number` | Maximum duration, hours portion. | [Optional] [Defaults to `undefined`] |
+| **maxDurationM** | `number` | Maximum duration, minutes portion (0–59). | [Optional] [Defaults to `undefined`] |
+| **latVal** | `number` | Latitude for geographic search. | [Optional] [Defaults to `undefined`] |
+| **longVal** | `number` | Longitude for geographic search. | [Optional] [Defaults to `undefined`] |
+| **geoWidth** | `number` | Search radius in miles. Negative integer = auto-radius. | [Optional] [Defaults to `undefined`] |
+| **geoWidthKm** | `number` | Search radius in kilometers. Negative integer = auto-radius. | [Optional] [Defaults to `undefined`] |
+| **sortResultsByDistance** | `0`, `1` | Set to `1` to sort results by distance from `lat_val`/`long_val`. | [Optional] [Defaults to `undefined`] [Enum: 0, 1] |
+| **meetingKey** | `string` | Field key to filter on (used with `meeting_key_value`). | [Optional] [Defaults to `undefined`] |
+| **meetingKeyValue** | `string` | Value to match against the field named by `meeting_key`. | [Optional] [Defaults to `undefined`] |
+| **dataFieldKey** | `string` | Comma-separated list of fields to include in each returned meeting (whitelist). | [Optional] [Defaults to `undefined`] |
+| **sortKeys** | `string` | Comma-separated list of fields to sort by. | [Optional] [Defaults to `undefined`] |
+| **sortKey** | `weekday`, `time`, `town`, `state`, `weekday_state` | Predefined sort alias. | [Optional] [Defaults to `undefined`] [Enum: weekday, time, town, state, weekday_state] |
+| **pageSize** | `number` | Number of results per page. | [Optional] [Defaults to `undefined`] |
+| **pageNum** | `number` | Page number, 1-based. Only meaningful when `page_size` is set. | [Optional] [Defaults to `1`] |
+| **advancedPublished** | `-1`, `0` | Published-status filter. Omit to return only published meetings. `0` returns both. `-1` returns only unpublished (requires authentication). | [Optional] [Defaults to `undefined`] [Enum: -1, 0] |
+| **langEnum** | `string` | Language code for translated format names (en, de, fr, es, it, pl, pt, sv, dk, fa). | [Optional] [Defaults to `undefined`] |
+| **rootServerIds** | `string` | Aggregator mode only. Comma-separated root server IDs. Positive includes, negative excludes. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**GetSearchResults200Response**](GetSearchResults200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Meeting search results. May be a bare array of meetings, an array of formats when `get_formats_only=1`, or a `{meetings, formats}` envelope when `get_used_formats=1`. |  -  |
+| **400** | Bad request — usually a missing required parameter. |  -  |
+| **500** | Internal server error — for example, a geocoding failure when `StringSearchIsAnAddress=1`. |  -  |
+
+[[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/ModelError.md

@@ -0,0 +1,34 @@
+
+# ModelError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+
+## Example
+
+```typescript
+import type { ModelError } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+} satisfies ModelError
+
+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 ModelError
+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/SemanticError.md

@@ -0,0 +1,34 @@
+
+# SemanticError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+
+## Example
+
+```typescript
+import type { SemanticError } from 'bmlt-server-semantic-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+} satisfies SemanticError
+
+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 SemanticError
+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)
+
+