bmlt-server-client 2.0.0 → 2.0.1

package/docs/MeetingCreate.md

@@ -0,0 +1,106 @@
+
+# MeetingCreate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`serviceBodyId` | number
+`formatIds` | Array<number>
+`venueType` | number
+`temporarilyVirtual` | boolean
+`day` | number
+`startTime` | string
+`duration` | string
+`timeZone` | string
+`latitude` | number
+`longitude` | number
+`published` | boolean
+`email` | string
+`worldId` | string
+`name` | string
+`locationText` | string
+`locationInfo` | string
+`locationStreet` | string
+`locationNeighborhood` | string
+`locationCitySubsection` | string
+`locationMunicipality` | string
+`locationSubProvince` | string
+`locationProvince` | string
+`locationPostalCode1` | string
+`locationNation` | string
+`phoneMeetingNumber` | string
+`virtualMeetingLink` | string
+`virtualMeetingAdditionalInfo` | string
+`contactName1` | string
+`contactName2` | string
+`contactPhone1` | string
+`contactPhone2` | string
+`contactEmail1` | string
+`contactEmail2` | string
+`busLines` | string
+`trainLines` | string
+`comments` | string
+`customFields` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { MeetingCreate } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "serviceBodyId": 0,
+  "formatIds": null,
+  "venueType": 1,
+  "temporarilyVirtual": false,
+  "day": 0,
+  "startTime": string,
+  "duration": 01:00,
+  "timeZone": America/New_York,
+  "latitude": 35.698741,
+  "longitude": -81.26273,
+  "published": true,
+  "email": string,
+  "worldId": string,
+  "name": string,
+  "locationText": string,
+  "locationInfo": string,
+  "locationStreet": string,
+  "locationNeighborhood": string,
+  "locationCitySubsection": string,
+  "locationMunicipality": string,
+  "locationSubProvince": string,
+  "locationProvince": string,
+  "locationPostalCode1": string,
+  "locationNation": string,
+  "phoneMeetingNumber": string,
+  "virtualMeetingLink": string,
+  "virtualMeetingAdditionalInfo": string,
+  "contactName1": string,
+  "contactName2": string,
+  "contactPhone1": string,
+  "contactPhone2": string,
+  "contactEmail1": string,
+  "contactEmail2": string,
+  "busLines": string,
+  "trainLines": string,
+  "comments": string,
+  "customFields": {key1=value1, key2=value2},
+} satisfies MeetingCreate
+
+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 MeetingCreate
+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/MeetingPartialUpdate.md

@@ -0,0 +1,106 @@
+
+# MeetingPartialUpdate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`serviceBodyId` | number
+`formatIds` | Array<number>
+`venueType` | number
+`temporarilyVirtual` | boolean
+`day` | number
+`startTime` | string
+`duration` | string
+`timeZone` | string
+`latitude` | number
+`longitude` | number
+`published` | boolean
+`email` | string
+`worldId` | string
+`name` | string
+`locationText` | string
+`locationInfo` | string
+`locationStreet` | string
+`locationNeighborhood` | string
+`locationCitySubsection` | string
+`locationMunicipality` | string
+`locationSubProvince` | string
+`locationProvince` | string
+`locationPostalCode1` | string
+`locationNation` | string
+`phoneMeetingNumber` | string
+`virtualMeetingLink` | string
+`virtualMeetingAdditionalInfo` | string
+`contactName1` | string
+`contactName2` | string
+`contactPhone1` | string
+`contactPhone2` | string
+`contactEmail1` | string
+`contactEmail2` | string
+`busLines` | string
+`trainLines` | string
+`comments` | string
+`customFields` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { MeetingPartialUpdate } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "serviceBodyId": 0,
+  "formatIds": null,
+  "venueType": 1,
+  "temporarilyVirtual": false,
+  "day": 0,
+  "startTime": string,
+  "duration": 01:00,
+  "timeZone": America/New_York,
+  "latitude": 35.698741,
+  "longitude": -81.26273,
+  "published": true,
+  "email": string,
+  "worldId": string,
+  "name": string,
+  "locationText": string,
+  "locationInfo": string,
+  "locationStreet": string,
+  "locationNeighborhood": string,
+  "locationCitySubsection": string,
+  "locationMunicipality": string,
+  "locationSubProvince": string,
+  "locationProvince": string,
+  "locationPostalCode1": string,
+  "locationNation": string,
+  "phoneMeetingNumber": string,
+  "virtualMeetingLink": string,
+  "virtualMeetingAdditionalInfo": string,
+  "contactName1": string,
+  "contactName2": string,
+  "contactPhone1": string,
+  "contactPhone2": string,
+  "contactEmail1": string,
+  "contactEmail2": string,
+  "busLines": string,
+  "trainLines": string,
+  "comments": string,
+  "customFields": {key1=value1, key2=value2},
+} satisfies MeetingPartialUpdate
+
+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 MeetingPartialUpdate
+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/MeetingUpdate.md

@@ -0,0 +1,106 @@
+
+# MeetingUpdate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`serviceBodyId` | number
+`formatIds` | Array<number>
+`venueType` | number
+`temporarilyVirtual` | boolean
+`day` | number
+`startTime` | string
+`duration` | string
+`timeZone` | string
+`latitude` | number
+`longitude` | number
+`published` | boolean
+`email` | string
+`worldId` | string
+`name` | string
+`locationText` | string
+`locationInfo` | string
+`locationStreet` | string
+`locationNeighborhood` | string
+`locationCitySubsection` | string
+`locationMunicipality` | string
+`locationSubProvince` | string
+`locationProvince` | string
+`locationPostalCode1` | string
+`locationNation` | string
+`phoneMeetingNumber` | string
+`virtualMeetingLink` | string
+`virtualMeetingAdditionalInfo` | string
+`contactName1` | string
+`contactName2` | string
+`contactPhone1` | string
+`contactPhone2` | string
+`contactEmail1` | string
+`contactEmail2` | string
+`busLines` | string
+`trainLines` | string
+`comments` | string
+`customFields` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { MeetingUpdate } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "serviceBodyId": 0,
+  "formatIds": null,
+  "venueType": 1,
+  "temporarilyVirtual": false,
+  "day": 0,
+  "startTime": string,
+  "duration": 01:00,
+  "timeZone": America/New_York,
+  "latitude": 35.698741,
+  "longitude": -81.26273,
+  "published": true,
+  "email": string,
+  "worldId": string,
+  "name": string,
+  "locationText": string,
+  "locationInfo": string,
+  "locationStreet": string,
+  "locationNeighborhood": string,
+  "locationCitySubsection": string,
+  "locationMunicipality": string,
+  "locationSubProvince": string,
+  "locationProvince": string,
+  "locationPostalCode1": string,
+  "locationNation": string,
+  "phoneMeetingNumber": string,
+  "virtualMeetingLink": string,
+  "virtualMeetingAdditionalInfo": string,
+  "contactName1": string,
+  "contactName2": string,
+  "contactPhone1": string,
+  "contactPhone2": string,
+  "contactEmail1": string,
+  "contactEmail2": string,
+  "busLines": string,
+  "trainLines": string,
+  "comments": string,
+  "customFields": {key1=value1, key2=value2},
+} satisfies MeetingUpdate
+
+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 MeetingUpdate
+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/NotFoundError.md

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

@@ -0,0 +1,46 @@
+
+# RootServer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sourceId` | number
+`name` | string
+`url` | string
+`statistics` | [RootServerBaseStatistics](RootServerBaseStatistics.md)
+`serverInfo` | string
+`lastSuccessfulImport` | Date
+`id` | number
+
+## Example
+
+```typescript
+import type { RootServer } 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,
+  "id": 0,
+} satisfies RootServer
+
+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 RootServer
+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)
+
+