bmlt-server-client 2.0.0 → 2.0.1

package/docs/RootServerBase.md

@@ -0,0 +1,44 @@
+
+# RootServerBase
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sourceId` | number
+`name` | string
+`url` | string
+`statistics` | [RootServerBaseStatistics](RootServerBaseStatistics.md)
+`serverInfo` | string
+`lastSuccessfulImport` | Date
+
+## Example
+
+```typescript
+import type { RootServerBase } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sourceId": 0,
+  "name": string,
+  "url": https://example.com/main_server,
+  "statistics": null,
+  "serverInfo": string,
+  "lastSuccessfulImport": null,
+} satisfies RootServerBase
+
+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 RootServerBase
+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/RootServerBaseStatistics.md

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

@@ -0,0 +1,42 @@
+
+# RootServerBaseStatisticsMeetings
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`numTotal` | number
+`numInPerson` | number
+`numVirtual` | number
+`numHybrid` | number
+`numUnknown` | number
+
+## Example
+
+```typescript
+import type { RootServerBaseStatisticsMeetings } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "numTotal": 0,
+  "numInPerson": 0,
+  "numVirtual": 0,
+  "numHybrid": 0,
+  "numUnknown": 0,
+} satisfies RootServerBaseStatisticsMeetings
+
+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 RootServerBaseStatisticsMeetings
+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/RootServerBaseStatisticsServiceBodies.md

@@ -0,0 +1,40 @@
+
+# RootServerBaseStatisticsServiceBodies
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`numZones` | number
+`numRegions` | number
+`numAreas` | number
+`numGroups` | number
+
+## Example
+
+```typescript
+import type { RootServerBaseStatisticsServiceBodies } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "numZones": 0,
+  "numRegions": 0,
+  "numAreas": 0,
+  "numGroups": 0,
+} satisfies RootServerBaseStatisticsServiceBodies
+
+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 RootServerBaseStatisticsServiceBodies
+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/ServerError.md

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

@@ -0,0 +1,54 @@
+
+# ServiceBody
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`parentId` | number
+`name` | string
+`description` | string
+`type` | string
+`adminUserId` | number
+`assignedUserIds` | Array<number>
+`url` | string
+`helpline` | string
+`email` | string
+`worldId` | string
+`id` | number
+
+## Example
+
+```typescript
+import type { ServiceBody } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "parentId": 0,
+  "name": string,
+  "description": string,
+  "type": string,
+  "adminUserId": 0,
+  "assignedUserIds": null,
+  "url": string,
+  "helpline": string,
+  "email": string,
+  "worldId": string,
+  "id": 0,
+} satisfies ServiceBody
+
+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 ServiceBody
+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/ServiceBodyBase.md

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

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

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

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

@@ -0,0 +1,76 @@
+
+# SettingsBase
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`googleApiKey` | string
+`changeDepthForMeetings` | number
+`defaultSortKey` | string
+`language` | string
+`defaultDurationTime` | string
+`regionBias` | string
+`distanceUnits` | string
+`meetingStatesAndProvinces` | Array<string>
+`meetingCountiesAndSubProvinces` | Array<string>
+`searchSpecMapCenterLongitude` | number
+`searchSpecMapCenterLatitude` | number
+`searchSpecMapCenterZoom` | number
+`numberOfMeetingsForAuto` | number
+`autoGeocodingEnabled` | boolean
+`countyAutoGeocodingEnabled` | boolean
+`zipAutoGeocodingEnabled` | boolean
+`defaultClosedStatus` | boolean
+`enableLanguageSelector` | boolean
+`includeServiceBodyEmailInSemantic` | boolean
+`bmltTitle` | string
+`bmltNotice` | string
+`formatLangNames` | object
+
+## Example
+
+```typescript
+import type { SettingsBase } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "googleApiKey": null,
+  "changeDepthForMeetings": null,
+  "defaultSortKey": null,
+  "language": null,
+  "defaultDurationTime": null,
+  "regionBias": null,
+  "distanceUnits": null,
+  "meetingStatesAndProvinces": null,
+  "meetingCountiesAndSubProvinces": null,
+  "searchSpecMapCenterLongitude": null,
+  "searchSpecMapCenterLatitude": null,
+  "searchSpecMapCenterZoom": null,
+  "numberOfMeetingsForAuto": null,
+  "autoGeocodingEnabled": null,
+  "countyAutoGeocodingEnabled": null,
+  "zipAutoGeocodingEnabled": null,
+  "defaultClosedStatus": null,
+  "enableLanguageSelector": null,
+  "includeServiceBodyEmailInSemantic": null,
+  "bmltTitle": null,
+  "bmltNotice": null,
+  "formatLangNames": null,
+} satisfies SettingsBase
+
+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 SettingsBase
+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/SettingsObject.md

@@ -0,0 +1,76 @@
+
+# SettingsObject
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`googleApiKey` | string
+`changeDepthForMeetings` | number
+`defaultSortKey` | string
+`language` | string
+`defaultDurationTime` | string
+`regionBias` | string
+`distanceUnits` | string
+`meetingStatesAndProvinces` | Array<string>
+`meetingCountiesAndSubProvinces` | Array<string>
+`searchSpecMapCenterLongitude` | number
+`searchSpecMapCenterLatitude` | number
+`searchSpecMapCenterZoom` | number
+`numberOfMeetingsForAuto` | number
+`autoGeocodingEnabled` | boolean
+`countyAutoGeocodingEnabled` | boolean
+`zipAutoGeocodingEnabled` | boolean
+`defaultClosedStatus` | boolean
+`enableLanguageSelector` | boolean
+`includeServiceBodyEmailInSemantic` | boolean
+`bmltTitle` | string
+`bmltNotice` | string
+`formatLangNames` | object
+
+## Example
+
+```typescript
+import type { SettingsObject } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "googleApiKey": ,
+  "changeDepthForMeetings": 0,
+  "defaultSortKey": null,
+  "language": en,
+  "defaultDurationTime": 01:00,
+  "regionBias": us,
+  "distanceUnits": mi,
+  "meetingStatesAndProvinces": [],
+  "meetingCountiesAndSubProvinces": [],
+  "searchSpecMapCenterLongitude": -118.563659,
+  "searchSpecMapCenterLatitude": 34.235918,
+  "searchSpecMapCenterZoom": 6,
+  "numberOfMeetingsForAuto": 10,
+  "autoGeocodingEnabled": true,
+  "countyAutoGeocodingEnabled": false,
+  "zipAutoGeocodingEnabled": false,
+  "defaultClosedStatus": true,
+  "enableLanguageSelector": false,
+  "includeServiceBodyEmailInSemantic": false,
+  "bmltTitle": ,
+  "bmltNotice": ,
+  "formatLangNames": [],
+} satisfies SettingsObject
+
+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 SettingsObject
+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/SettingsUpdate.md

@@ -0,0 +1,77 @@
+
+# SettingsUpdate
+
+Partial update object - include only the settings you want to update
+
+## Properties
+
+Name | Type
+------------ | -------------
+`googleApiKey` | string
+`changeDepthForMeetings` | number
+`defaultSortKey` | string
+`language` | string
+`defaultDurationTime` | string
+`regionBias` | string
+`distanceUnits` | string
+`meetingStatesAndProvinces` | Array<string>
+`meetingCountiesAndSubProvinces` | Array<string>
+`searchSpecMapCenterLongitude` | number
+`searchSpecMapCenterLatitude` | number
+`searchSpecMapCenterZoom` | number
+`numberOfMeetingsForAuto` | number
+`autoGeocodingEnabled` | boolean
+`countyAutoGeocodingEnabled` | boolean
+`zipAutoGeocodingEnabled` | boolean
+`defaultClosedStatus` | boolean
+`enableLanguageSelector` | boolean
+`includeServiceBodyEmailInSemantic` | boolean
+`bmltTitle` | string
+`bmltNotice` | string
+`formatLangNames` | object
+
+## Example
+
+```typescript
+import type { SettingsUpdate } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "googleApiKey": null,
+  "changeDepthForMeetings": null,
+  "defaultSortKey": null,
+  "language": null,
+  "defaultDurationTime": null,
+  "regionBias": null,
+  "distanceUnits": null,
+  "meetingStatesAndProvinces": null,
+  "meetingCountiesAndSubProvinces": null,
+  "searchSpecMapCenterLongitude": null,
+  "searchSpecMapCenterLatitude": null,
+  "searchSpecMapCenterZoom": null,
+  "numberOfMeetingsForAuto": null,
+  "autoGeocodingEnabled": null,
+  "countyAutoGeocodingEnabled": null,
+  "zipAutoGeocodingEnabled": null,
+  "defaultClosedStatus": null,
+  "enableLanguageSelector": null,
+  "includeServiceBodyEmailInSemantic": null,
+  "bmltTitle": null,
+  "bmltNotice": null,
+  "formatLangNames": null,
+} satisfies SettingsUpdate
+
+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 SettingsUpdate
+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)
+
+