bmlt-server-client 2.0.0 → 2.0.1

package/docs/AuthenticationError.md

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

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

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

@@ -0,0 +1,38 @@
+
+# ErrorTest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`arbitraryString` | string
+`arbitraryInt` | number
+`forceServerError` | boolean
+
+## Example
+
+```typescript
+import type { ErrorTest } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "arbitraryString": string,
+  "arbitraryInt": 123,
+  "forceServerError": true,
+} satisfies ErrorTest
+
+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 ErrorTest
+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/Format.md

@@ -0,0 +1,40 @@
+
+# Format
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`worldId` | string
+`type` | string
+`translations` | [Array<FormatTranslation>](FormatTranslation.md)
+`id` | number
+
+## Example
+
+```typescript
+import type { Format } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "worldId": string,
+  "type": string,
+  "translations": null,
+  "id": 0,
+} satisfies Format
+
+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 Format
+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/FormatBase.md

@@ -0,0 +1,38 @@
+
+# FormatBase
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`worldId` | string
+`type` | string
+`translations` | [Array<FormatTranslation>](FormatTranslation.md)
+
+## Example
+
+```typescript
+import type { FormatBase } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "worldId": string,
+  "type": string,
+  "translations": null,
+} satisfies FormatBase
+
+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 FormatBase
+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/FormatCreate.md

@@ -0,0 +1,38 @@
+
+# FormatCreate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`worldId` | string
+`type` | string
+`translations` | [Array<FormatTranslation>](FormatTranslation.md)
+
+## Example
+
+```typescript
+import type { FormatCreate } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "worldId": string,
+  "type": string,
+  "translations": null,
+} satisfies FormatCreate
+
+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 FormatCreate
+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/FormatPartialUpdate.md

@@ -0,0 +1,38 @@
+
+# FormatPartialUpdate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`worldId` | string
+`type` | string
+`translations` | [Array<FormatTranslation>](FormatTranslation.md)
+
+## Example
+
+```typescript
+import type { FormatPartialUpdate } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "worldId": string,
+  "type": string,
+  "translations": null,
+} satisfies FormatPartialUpdate
+
+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 FormatPartialUpdate
+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/FormatTranslation.md

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

@@ -0,0 +1,38 @@
+
+# FormatUpdate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`worldId` | string
+`type` | string
+`translations` | [Array<FormatTranslation>](FormatTranslation.md)
+
+## Example
+
+```typescript
+import type { FormatUpdate } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "worldId": string,
+  "type": string,
+  "translations": null,
+} satisfies FormatUpdate
+
+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 FormatUpdate
+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,108 @@
+
+# Meeting
+
+
+## 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; }
+`id` | number
+
+## Example
+
+```typescript
+import type { Meeting } 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},
+  "id": 0,
+} 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/MeetingBase.md

@@ -0,0 +1,106 @@
+
+# MeetingBase
+
+
+## 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 { MeetingBase } 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 MeetingBase
+
+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 MeetingBase
+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/MeetingChangeResource.md

@@ -0,0 +1,40 @@
+
+# MeetingChangeResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`dateString` | string
+`userName` | string
+`serviceBodyName` | string
+`details` | Array<string>
+
+## Example
+
+```typescript
+import type { MeetingChangeResource } from 'bmlt-server-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "dateString": 3:35 PM, 10/14/2024,
+  "userName": Greater New York Regional Administrator,
+  "serviceBodyName": Bronx Area Service,
+  "details": null,
+} satisfies MeetingChangeResource
+
+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 MeetingChangeResource
+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)
+
+