bmlt-server-client 1.3.6 → 1.3.7-beta.1

package/docs/RootServerApi.md

@@ -26,6 +26,7 @@ All URIs are relative to *http://localhost:8000/main_server*
 | [**getRootServers**](RootServerApi.md#getrootservers) | **GET** /api/v1/rootservers | Retrieves root servers |
 | [**getServiceBodies**](RootServerApi.md#getservicebodies) | **GET** /api/v1/servicebodies | Retrieves service bodies |
 | [**getServiceBody**](RootServerApi.md#getservicebody) | **GET** /api/v1/servicebodies/{serviceBodyId} | Retrieves a service body |
+| [**getSettings**](RootServerApi.md#getsettings) | **GET** /api/v1/settings | Retrieves all settings |
 | [**getUser**](RootServerApi.md#getuser) | **GET** /api/v1/users/{userId} | Retrieves a single user |
 | [**getUsers**](RootServerApi.md#getusers) | **GET** /api/v1/users | Retrieves users |
 | [**partialUpdateUser**](RootServerApi.md#partialupdateuser) | **PATCH** /api/v1/users/{userId} | Patches a user |
@@ -35,6 +36,7 @@ All URIs are relative to *http://localhost:8000/main_server*
 | [**updateFormat**](RootServerApi.md#updateformat) | **PUT** /api/v1/formats/{formatId} | Updates a format |
 | [**updateMeeting**](RootServerApi.md#updatemeeting) | **PUT** /api/v1/meetings/{meetingId} | Updates a meeting |
 | [**updateServiceBody**](RootServerApi.md#updateservicebody) | **PUT** /api/v1/servicebodies/{serviceBodyId} | Updates a Service Body |
+| [**updateSettings**](RootServerApi.md#updatesettings) | **PUT** /api/v1/settings | Update settings |
 | [**updateUser**](RootServerApi.md#updateuser) | **PUT** /api/v1/users/{userId} | Update single user |
 
 
@@ -1608,6 +1610,71 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getSettings
+
+> SettingsObject getSettings()
+
+Retrieves all settings
+
+Retrieve all server settings. Only accessible to server administrators.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RootServerApi,
+} from 'bmlt-server-client';
+import type { GetSettingsRequest } from 'bmlt-server-client';
+
+async function example() {
+  console.log("🚀 Testing bmlt-server-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: bmltToken password
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new RootServerApi(config);
+
+  try {
+    const data = await api.getSettings();
+    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
+
+[**SettingsObject**](SettingsObject.md)
+
+### Authorization
+
+[bmltToken password](../README.md#bmltToken-password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Returns when user is authenticated as admin. |  -  |
+| **401** | Returns when not authenticated |  -  |
+| **403** | Returns when user is not an admin |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getUser
 
 > User getUser(userId)
@@ -2294,6 +2361,80 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## updateSettings
+
+> updateSettings(settingsUpdate)
+
+Update settings
+
+Updates one or more server settings. Only accessible to server administrators.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RootServerApi,
+} from 'bmlt-server-client';
+import type { UpdateSettingsRequest } from 'bmlt-server-client';
+
+async function example() {
+  console.log("🚀 Testing bmlt-server-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: bmltToken password
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new RootServerApi(config);
+
+  const body = {
+    // SettingsUpdate | Pass in settings object with values to update
+    settingsUpdate: ...,
+  } satisfies UpdateSettingsRequest;
+
+  try {
+    const data = await api.updateSettings(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **settingsUpdate** | [SettingsUpdate](SettingsUpdate.md) | Pass in settings object with values to update | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bmltToken password](../README.md#bmltToken-password)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Success. |  -  |
+| **401** | Returns when user is not authenticated. |  -  |
+| **403** | Returns when user is not an admin. |  -  |
+| **422** | Validation error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## updateUser
 
 > updateUser(userId, userUpdate)

package/docs/SettingsBase.md

@@ -0,0 +1,84 @@
+
+# SettingsBase
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`googleApiKey` | string
+`changeDepthForMeetings` | number
+`defaultSortKey` | string
+`language` | string
+`defaultDurationTime` | string
+`regionBias` | string
+`distanceUnits` | string
+`enableEmailContact` | boolean
+`includeServiceBodyAdminOnEmails` | boolean
+`meetingStatesAndProvinces` | Array<string>
+`meetingCountiesAndSubProvinces` | Array<string>
+`searchSpecMapCenterLongitude` | number
+`searchSpecMapCenterLatitude` | number
+`searchSpecMapCenterZoom` | number
+`numberOfMeetingsForAuto` | number
+`autoGeocodingEnabled` | boolean
+`countyAutoGeocodingEnabled` | boolean
+`zipAutoGeocodingEnabled` | boolean
+`defaultClosedStatus` | boolean
+`enableLanguageSelector` | boolean
+`aggregatorModeEnabled` | boolean
+`aggregatorMaxGeoWidthKm` | number
+`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,
+  "enableEmailContact": null,
+  "includeServiceBodyAdminOnEmails": null,
+  "meetingStatesAndProvinces": null,
+  "meetingCountiesAndSubProvinces": null,
+  "searchSpecMapCenterLongitude": null,
+  "searchSpecMapCenterLatitude": null,
+  "searchSpecMapCenterZoom": null,
+  "numberOfMeetingsForAuto": null,
+  "autoGeocodingEnabled": null,
+  "countyAutoGeocodingEnabled": null,
+  "zipAutoGeocodingEnabled": null,
+  "defaultClosedStatus": null,
+  "enableLanguageSelector": null,
+  "aggregatorModeEnabled": null,
+  "aggregatorMaxGeoWidthKm": 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,84 @@
+
+# SettingsObject
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`googleApiKey` | string
+`changeDepthForMeetings` | number
+`defaultSortKey` | string
+`language` | string
+`defaultDurationTime` | string
+`regionBias` | string
+`distanceUnits` | string
+`enableEmailContact` | boolean
+`includeServiceBodyAdminOnEmails` | boolean
+`meetingStatesAndProvinces` | Array<string>
+`meetingCountiesAndSubProvinces` | Array<string>
+`searchSpecMapCenterLongitude` | number
+`searchSpecMapCenterLatitude` | number
+`searchSpecMapCenterZoom` | number
+`numberOfMeetingsForAuto` | number
+`autoGeocodingEnabled` | boolean
+`countyAutoGeocodingEnabled` | boolean
+`zipAutoGeocodingEnabled` | boolean
+`defaultClosedStatus` | boolean
+`enableLanguageSelector` | boolean
+`aggregatorModeEnabled` | boolean
+`aggregatorMaxGeoWidthKm` | number
+`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,
+  "enableEmailContact": false,
+  "includeServiceBodyAdminOnEmails": false,
+  "meetingStatesAndProvinces": [],
+  "meetingCountiesAndSubProvinces": [],
+  "searchSpecMapCenterLongitude": -118.563659,
+  "searchSpecMapCenterLatitude": 34.235918,
+  "searchSpecMapCenterZoom": 6,
+  "numberOfMeetingsForAuto": 10,
+  "autoGeocodingEnabled": true,
+  "countyAutoGeocodingEnabled": false,
+  "zipAutoGeocodingEnabled": false,
+  "defaultClosedStatus": true,
+  "enableLanguageSelector": false,
+  "aggregatorModeEnabled": false,
+  "aggregatorMaxGeoWidthKm": 1000,
+  "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,85 @@
+
+# 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
+`enableEmailContact` | boolean
+`includeServiceBodyAdminOnEmails` | boolean
+`meetingStatesAndProvinces` | Array<string>
+`meetingCountiesAndSubProvinces` | Array<string>
+`searchSpecMapCenterLongitude` | number
+`searchSpecMapCenterLatitude` | number
+`searchSpecMapCenterZoom` | number
+`numberOfMeetingsForAuto` | number
+`autoGeocodingEnabled` | boolean
+`countyAutoGeocodingEnabled` | boolean
+`zipAutoGeocodingEnabled` | boolean
+`defaultClosedStatus` | boolean
+`enableLanguageSelector` | boolean
+`aggregatorModeEnabled` | boolean
+`aggregatorMaxGeoWidthKm` | number
+`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,
+  "enableEmailContact": null,
+  "includeServiceBodyAdminOnEmails": null,
+  "meetingStatesAndProvinces": null,
+  "meetingCountiesAndSubProvinces": null,
+  "searchSpecMapCenterLongitude": null,
+  "searchSpecMapCenterLatitude": null,
+  "searchSpecMapCenterZoom": null,
+  "numberOfMeetingsForAuto": null,
+  "autoGeocodingEnabled": null,
+  "countyAutoGeocodingEnabled": null,
+  "zipAutoGeocodingEnabled": null,
+  "defaultClosedStatus": null,
+  "enableLanguageSelector": null,
+  "aggregatorModeEnabled": null,
+  "aggregatorMaxGeoWidthKm": 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)
+
+