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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -81,7 +81,7 @@ All URIs are relative to *http://localhost:8000/main_server*
81
81
  *RootServerApi* | [**updateFormat**](docs/RootServerApi.md#updateformat) | **PUT** /api/v1/formats/{formatId} | Updates a format
82
82
  *RootServerApi* | [**updateMeeting**](docs/RootServerApi.md#updatemeeting) | **PUT** /api/v1/meetings/{meetingId} | Updates a meeting
83
83
  *RootServerApi* | [**updateServiceBody**](docs/RootServerApi.md#updateservicebody) | **PUT** /api/v1/servicebodies/{serviceBodyId} | Updates a Service Body
84
- *RootServerApi* | [**updateSettings**](docs/RootServerApi.md#updatesettings) | **PUT** /api/v1/settings | Update settings
84
+ *RootServerApi* | [**updateSettings**](docs/RootServerApi.md#updatesettings) | **PATCH** /api/v1/settings | Update settings
85
85
  *RootServerApi* | [**updateUser**](docs/RootServerApi.md#updateuser) | **PUT** /api/v1/users/{userId} | Update single user
86
86
 
87
87
 
@@ -1196,7 +1196,7 @@ class RootServerApi extends runtime.BaseAPI {
1196
1196
  let urlPath = `/api/v1/settings`;
1197
1197
  const response = yield this.request({
1198
1198
  path: urlPath,
1199
- method: 'PUT',
1199
+ method: 'PATCH',
1200
1200
  headers: headerParameters,
1201
1201
  query: queryParameters,
1202
1202
  body: (0, index_1.SettingsUpdateToJSON)(requestParameters['settingsUpdate']),
@@ -1193,7 +1193,7 @@ export class RootServerApi extends runtime.BaseAPI {
1193
1193
  let urlPath = `/api/v1/settings`;
1194
1194
  const response = yield this.request({
1195
1195
  path: urlPath,
1196
- method: 'PUT',
1196
+ method: 'PATCH',
1197
1197
  headers: headerParameters,
1198
1198
  query: queryParameters,
1199
1199
  body: SettingsUpdateToJSON(requestParameters['settingsUpdate']),
@@ -57,18 +57,6 @@ export interface SettingsBase {
57
57
  * @memberof SettingsBase
58
58
  */
59
59
  distanceUnits?: string;
60
- /**
61
- *
62
- * @type {boolean}
63
- * @memberof SettingsBase
64
- */
65
- enableEmailContact?: boolean;
66
- /**
67
- *
68
- * @type {boolean}
69
- * @memberof SettingsBase
70
- */
71
- includeServiceBodyAdminOnEmails?: boolean;
72
60
  /**
73
61
  *
74
62
  * @type {Array<string>}
@@ -32,8 +32,6 @@ export function SettingsBaseFromJSONTyped(json, ignoreDiscriminator) {
32
32
  'defaultDurationTime': json['defaultDurationTime'] == null ? undefined : json['defaultDurationTime'],
33
33
  'regionBias': json['regionBias'] == null ? undefined : json['regionBias'],
34
34
  'distanceUnits': json['distanceUnits'] == null ? undefined : json['distanceUnits'],
35
- 'enableEmailContact': json['enableEmailContact'] == null ? undefined : json['enableEmailContact'],
36
- 'includeServiceBodyAdminOnEmails': json['includeServiceBodyAdminOnEmails'] == null ? undefined : json['includeServiceBodyAdminOnEmails'],
37
35
  'meetingStatesAndProvinces': json['meetingStatesAndProvinces'] == null ? undefined : json['meetingStatesAndProvinces'],
38
36
  'meetingCountiesAndSubProvinces': json['meetingCountiesAndSubProvinces'] == null ? undefined : json['meetingCountiesAndSubProvinces'],
39
37
  'searchSpecMapCenterLongitude': json['searchSpecMapCenterLongitude'] == null ? undefined : json['searchSpecMapCenterLongitude'],
@@ -68,8 +66,6 @@ export function SettingsBaseToJSONTyped(value, ignoreDiscriminator = false) {
68
66
  'defaultDurationTime': value['defaultDurationTime'],
69
67
  'regionBias': value['regionBias'],
70
68
  'distanceUnits': value['distanceUnits'],
71
- 'enableEmailContact': value['enableEmailContact'],
72
- 'includeServiceBodyAdminOnEmails': value['includeServiceBodyAdminOnEmails'],
73
69
  'meetingStatesAndProvinces': value['meetingStatesAndProvinces'],
74
70
  'meetingCountiesAndSubProvinces': value['meetingCountiesAndSubProvinces'],
75
71
  'searchSpecMapCenterLongitude': value['searchSpecMapCenterLongitude'],
@@ -57,18 +57,6 @@ export interface SettingsObject {
57
57
  * @memberof SettingsObject
58
58
  */
59
59
  distanceUnits?: string;
60
- /**
61
- *
62
- * @type {boolean}
63
- * @memberof SettingsObject
64
- */
65
- enableEmailContact?: boolean;
66
- /**
67
- *
68
- * @type {boolean}
69
- * @memberof SettingsObject
70
- */
71
- includeServiceBodyAdminOnEmails?: boolean;
72
60
  /**
73
61
  *
74
62
  * @type {Array<string>}
@@ -32,8 +32,6 @@ export function SettingsObjectFromJSONTyped(json, ignoreDiscriminator) {
32
32
  'defaultDurationTime': json['defaultDurationTime'] == null ? undefined : json['defaultDurationTime'],
33
33
  'regionBias': json['regionBias'] == null ? undefined : json['regionBias'],
34
34
  'distanceUnits': json['distanceUnits'] == null ? undefined : json['distanceUnits'],
35
- 'enableEmailContact': json['enableEmailContact'] == null ? undefined : json['enableEmailContact'],
36
- 'includeServiceBodyAdminOnEmails': json['includeServiceBodyAdminOnEmails'] == null ? undefined : json['includeServiceBodyAdminOnEmails'],
37
35
  'meetingStatesAndProvinces': json['meetingStatesAndProvinces'] == null ? undefined : json['meetingStatesAndProvinces'],
38
36
  'meetingCountiesAndSubProvinces': json['meetingCountiesAndSubProvinces'] == null ? undefined : json['meetingCountiesAndSubProvinces'],
39
37
  'searchSpecMapCenterLongitude': json['searchSpecMapCenterLongitude'] == null ? undefined : json['searchSpecMapCenterLongitude'],
@@ -68,8 +66,6 @@ export function SettingsObjectToJSONTyped(value, ignoreDiscriminator = false) {
68
66
  'defaultDurationTime': value['defaultDurationTime'],
69
67
  'regionBias': value['regionBias'],
70
68
  'distanceUnits': value['distanceUnits'],
71
- 'enableEmailContact': value['enableEmailContact'],
72
- 'includeServiceBodyAdminOnEmails': value['includeServiceBodyAdminOnEmails'],
73
69
  'meetingStatesAndProvinces': value['meetingStatesAndProvinces'],
74
70
  'meetingCountiesAndSubProvinces': value['meetingCountiesAndSubProvinces'],
75
71
  'searchSpecMapCenterLongitude': value['searchSpecMapCenterLongitude'],
@@ -57,18 +57,6 @@ export interface SettingsUpdate {
57
57
  * @memberof SettingsUpdate
58
58
  */
59
59
  distanceUnits?: string;
60
- /**
61
- *
62
- * @type {boolean}
63
- * @memberof SettingsUpdate
64
- */
65
- enableEmailContact?: boolean;
66
- /**
67
- *
68
- * @type {boolean}
69
- * @memberof SettingsUpdate
70
- */
71
- includeServiceBodyAdminOnEmails?: boolean;
72
60
  /**
73
61
  *
74
62
  * @type {Array<string>}
@@ -32,8 +32,6 @@ export function SettingsUpdateFromJSONTyped(json, ignoreDiscriminator) {
32
32
  'defaultDurationTime': json['defaultDurationTime'] == null ? undefined : json['defaultDurationTime'],
33
33
  'regionBias': json['regionBias'] == null ? undefined : json['regionBias'],
34
34
  'distanceUnits': json['distanceUnits'] == null ? undefined : json['distanceUnits'],
35
- 'enableEmailContact': json['enableEmailContact'] == null ? undefined : json['enableEmailContact'],
36
- 'includeServiceBodyAdminOnEmails': json['includeServiceBodyAdminOnEmails'] == null ? undefined : json['includeServiceBodyAdminOnEmails'],
37
35
  'meetingStatesAndProvinces': json['meetingStatesAndProvinces'] == null ? undefined : json['meetingStatesAndProvinces'],
38
36
  'meetingCountiesAndSubProvinces': json['meetingCountiesAndSubProvinces'] == null ? undefined : json['meetingCountiesAndSubProvinces'],
39
37
  'searchSpecMapCenterLongitude': json['searchSpecMapCenterLongitude'] == null ? undefined : json['searchSpecMapCenterLongitude'],
@@ -68,8 +66,6 @@ export function SettingsUpdateToJSONTyped(value, ignoreDiscriminator = false) {
68
66
  'defaultDurationTime': value['defaultDurationTime'],
69
67
  'regionBias': value['regionBias'],
70
68
  'distanceUnits': value['distanceUnits'],
71
- 'enableEmailContact': value['enableEmailContact'],
72
- 'includeServiceBodyAdminOnEmails': value['includeServiceBodyAdminOnEmails'],
73
69
  'meetingStatesAndProvinces': value['meetingStatesAndProvinces'],
74
70
  'meetingCountiesAndSubProvinces': value['meetingCountiesAndSubProvinces'],
75
71
  'searchSpecMapCenterLongitude': value['searchSpecMapCenterLongitude'],
@@ -57,18 +57,6 @@ export interface SettingsBase {
57
57
  * @memberof SettingsBase
58
58
  */
59
59
  distanceUnits?: string;
60
- /**
61
- *
62
- * @type {boolean}
63
- * @memberof SettingsBase
64
- */
65
- enableEmailContact?: boolean;
66
- /**
67
- *
68
- * @type {boolean}
69
- * @memberof SettingsBase
70
- */
71
- includeServiceBodyAdminOnEmails?: boolean;
72
60
  /**
73
61
  *
74
62
  * @type {Array<string>}
@@ -39,8 +39,6 @@ function SettingsBaseFromJSONTyped(json, ignoreDiscriminator) {
39
39
  'defaultDurationTime': json['defaultDurationTime'] == null ? undefined : json['defaultDurationTime'],
40
40
  'regionBias': json['regionBias'] == null ? undefined : json['regionBias'],
41
41
  'distanceUnits': json['distanceUnits'] == null ? undefined : json['distanceUnits'],
42
- 'enableEmailContact': json['enableEmailContact'] == null ? undefined : json['enableEmailContact'],
43
- 'includeServiceBodyAdminOnEmails': json['includeServiceBodyAdminOnEmails'] == null ? undefined : json['includeServiceBodyAdminOnEmails'],
44
42
  'meetingStatesAndProvinces': json['meetingStatesAndProvinces'] == null ? undefined : json['meetingStatesAndProvinces'],
45
43
  'meetingCountiesAndSubProvinces': json['meetingCountiesAndSubProvinces'] == null ? undefined : json['meetingCountiesAndSubProvinces'],
46
44
  'searchSpecMapCenterLongitude': json['searchSpecMapCenterLongitude'] == null ? undefined : json['searchSpecMapCenterLongitude'],
@@ -75,8 +73,6 @@ function SettingsBaseToJSONTyped(value, ignoreDiscriminator = false) {
75
73
  'defaultDurationTime': value['defaultDurationTime'],
76
74
  'regionBias': value['regionBias'],
77
75
  'distanceUnits': value['distanceUnits'],
78
- 'enableEmailContact': value['enableEmailContact'],
79
- 'includeServiceBodyAdminOnEmails': value['includeServiceBodyAdminOnEmails'],
80
76
  'meetingStatesAndProvinces': value['meetingStatesAndProvinces'],
81
77
  'meetingCountiesAndSubProvinces': value['meetingCountiesAndSubProvinces'],
82
78
  'searchSpecMapCenterLongitude': value['searchSpecMapCenterLongitude'],
@@ -57,18 +57,6 @@ export interface SettingsObject {
57
57
  * @memberof SettingsObject
58
58
  */
59
59
  distanceUnits?: string;
60
- /**
61
- *
62
- * @type {boolean}
63
- * @memberof SettingsObject
64
- */
65
- enableEmailContact?: boolean;
66
- /**
67
- *
68
- * @type {boolean}
69
- * @memberof SettingsObject
70
- */
71
- includeServiceBodyAdminOnEmails?: boolean;
72
60
  /**
73
61
  *
74
62
  * @type {Array<string>}
@@ -39,8 +39,6 @@ function SettingsObjectFromJSONTyped(json, ignoreDiscriminator) {
39
39
  'defaultDurationTime': json['defaultDurationTime'] == null ? undefined : json['defaultDurationTime'],
40
40
  'regionBias': json['regionBias'] == null ? undefined : json['regionBias'],
41
41
  'distanceUnits': json['distanceUnits'] == null ? undefined : json['distanceUnits'],
42
- 'enableEmailContact': json['enableEmailContact'] == null ? undefined : json['enableEmailContact'],
43
- 'includeServiceBodyAdminOnEmails': json['includeServiceBodyAdminOnEmails'] == null ? undefined : json['includeServiceBodyAdminOnEmails'],
44
42
  'meetingStatesAndProvinces': json['meetingStatesAndProvinces'] == null ? undefined : json['meetingStatesAndProvinces'],
45
43
  'meetingCountiesAndSubProvinces': json['meetingCountiesAndSubProvinces'] == null ? undefined : json['meetingCountiesAndSubProvinces'],
46
44
  'searchSpecMapCenterLongitude': json['searchSpecMapCenterLongitude'] == null ? undefined : json['searchSpecMapCenterLongitude'],
@@ -75,8 +73,6 @@ function SettingsObjectToJSONTyped(value, ignoreDiscriminator = false) {
75
73
  'defaultDurationTime': value['defaultDurationTime'],
76
74
  'regionBias': value['regionBias'],
77
75
  'distanceUnits': value['distanceUnits'],
78
- 'enableEmailContact': value['enableEmailContact'],
79
- 'includeServiceBodyAdminOnEmails': value['includeServiceBodyAdminOnEmails'],
80
76
  'meetingStatesAndProvinces': value['meetingStatesAndProvinces'],
81
77
  'meetingCountiesAndSubProvinces': value['meetingCountiesAndSubProvinces'],
82
78
  'searchSpecMapCenterLongitude': value['searchSpecMapCenterLongitude'],
@@ -57,18 +57,6 @@ export interface SettingsUpdate {
57
57
  * @memberof SettingsUpdate
58
58
  */
59
59
  distanceUnits?: string;
60
- /**
61
- *
62
- * @type {boolean}
63
- * @memberof SettingsUpdate
64
- */
65
- enableEmailContact?: boolean;
66
- /**
67
- *
68
- * @type {boolean}
69
- * @memberof SettingsUpdate
70
- */
71
- includeServiceBodyAdminOnEmails?: boolean;
72
60
  /**
73
61
  *
74
62
  * @type {Array<string>}
@@ -39,8 +39,6 @@ function SettingsUpdateFromJSONTyped(json, ignoreDiscriminator) {
39
39
  'defaultDurationTime': json['defaultDurationTime'] == null ? undefined : json['defaultDurationTime'],
40
40
  'regionBias': json['regionBias'] == null ? undefined : json['regionBias'],
41
41
  'distanceUnits': json['distanceUnits'] == null ? undefined : json['distanceUnits'],
42
- 'enableEmailContact': json['enableEmailContact'] == null ? undefined : json['enableEmailContact'],
43
- 'includeServiceBodyAdminOnEmails': json['includeServiceBodyAdminOnEmails'] == null ? undefined : json['includeServiceBodyAdminOnEmails'],
44
42
  'meetingStatesAndProvinces': json['meetingStatesAndProvinces'] == null ? undefined : json['meetingStatesAndProvinces'],
45
43
  'meetingCountiesAndSubProvinces': json['meetingCountiesAndSubProvinces'] == null ? undefined : json['meetingCountiesAndSubProvinces'],
46
44
  'searchSpecMapCenterLongitude': json['searchSpecMapCenterLongitude'] == null ? undefined : json['searchSpecMapCenterLongitude'],
@@ -75,8 +73,6 @@ function SettingsUpdateToJSONTyped(value, ignoreDiscriminator = false) {
75
73
  'defaultDurationTime': value['defaultDurationTime'],
76
74
  'regionBias': value['regionBias'],
77
75
  'distanceUnits': value['distanceUnits'],
78
- 'enableEmailContact': value['enableEmailContact'],
79
- 'includeServiceBodyAdminOnEmails': value['includeServiceBodyAdminOnEmails'],
80
76
  'meetingStatesAndProvinces': value['meetingStatesAndProvinces'],
81
77
  'meetingCountiesAndSubProvinces': value['meetingCountiesAndSubProvinces'],
82
78
  'searchSpecMapCenterLongitude': value['searchSpecMapCenterLongitude'],
@@ -36,7 +36,7 @@ All URIs are relative to *http://localhost:8000/main_server*
36
36
  | [**updateFormat**](RootServerApi.md#updateformat) | **PUT** /api/v1/formats/{formatId} | Updates a format |
37
37
  | [**updateMeeting**](RootServerApi.md#updatemeeting) | **PUT** /api/v1/meetings/{meetingId} | Updates a meeting |
38
38
  | [**updateServiceBody**](RootServerApi.md#updateservicebody) | **PUT** /api/v1/servicebodies/{serviceBodyId} | Updates a Service Body |
39
- | [**updateSettings**](RootServerApi.md#updatesettings) | **PUT** /api/v1/settings | Update settings |
39
+ | [**updateSettings**](RootServerApi.md#updatesettings) | **PATCH** /api/v1/settings | Update settings |
40
40
  | [**updateUser**](RootServerApi.md#updateuser) | **PUT** /api/v1/users/{userId} | Update single user |
41
41
 
42
42
 
@@ -13,8 +13,6 @@ Name | Type
13
13
  `defaultDurationTime` | string
14
14
  `regionBias` | string
15
15
  `distanceUnits` | string
16
- `enableEmailContact` | boolean
17
- `includeServiceBodyAdminOnEmails` | boolean
18
16
  `meetingStatesAndProvinces` | Array&lt;string&gt;
19
17
  `meetingCountiesAndSubProvinces` | Array&lt;string&gt;
20
18
  `searchSpecMapCenterLongitude` | number
@@ -47,8 +45,6 @@ const example = {
47
45
  "defaultDurationTime": null,
48
46
  "regionBias": null,
49
47
  "distanceUnits": null,
50
- "enableEmailContact": null,
51
- "includeServiceBodyAdminOnEmails": null,
52
48
  "meetingStatesAndProvinces": null,
53
49
  "meetingCountiesAndSubProvinces": null,
54
50
  "searchSpecMapCenterLongitude": null,
@@ -13,8 +13,6 @@ Name | Type
13
13
  `defaultDurationTime` | string
14
14
  `regionBias` | string
15
15
  `distanceUnits` | string
16
- `enableEmailContact` | boolean
17
- `includeServiceBodyAdminOnEmails` | boolean
18
16
  `meetingStatesAndProvinces` | Array&lt;string&gt;
19
17
  `meetingCountiesAndSubProvinces` | Array&lt;string&gt;
20
18
  `searchSpecMapCenterLongitude` | number
@@ -47,8 +45,6 @@ const example = {
47
45
  "defaultDurationTime": 01:00,
48
46
  "regionBias": us,
49
47
  "distanceUnits": mi,
50
- "enableEmailContact": false,
51
- "includeServiceBodyAdminOnEmails": false,
52
48
  "meetingStatesAndProvinces": [],
53
49
  "meetingCountiesAndSubProvinces": [],
54
50
  "searchSpecMapCenterLongitude": -118.563659,
@@ -14,8 +14,6 @@ Name | Type
14
14
  `defaultDurationTime` | string
15
15
  `regionBias` | string
16
16
  `distanceUnits` | string
17
- `enableEmailContact` | boolean
18
- `includeServiceBodyAdminOnEmails` | boolean
19
17
  `meetingStatesAndProvinces` | Array&lt;string&gt;
20
18
  `meetingCountiesAndSubProvinces` | Array&lt;string&gt;
21
19
  `searchSpecMapCenterLongitude` | number
@@ -48,8 +46,6 @@ const example = {
48
46
  "defaultDurationTime": null,
49
47
  "regionBias": null,
50
48
  "distanceUnits": null,
51
- "enableEmailContact": null,
52
- "includeServiceBodyAdminOnEmails": null,
53
49
  "meetingStatesAndProvinces": null,
54
50
  "meetingCountiesAndSubProvinces": null,
55
51
  "searchSpecMapCenterLongitude": null,
package/openapi.json CHANGED
@@ -1 +1 @@
1
- {"openapi":"3.0.0","info":{"title":"BMLT","description":"BMLT Admin API Documentation","license":{"name":"MIT","url":"https://github.com/bmlt-enabled/bmlt-root-server/blob/main/LICENSE"},"version":"1.0.0"},"paths":{"/api/v1/errortest":{"post":{"tags":["rootServer"],"summary":"Tests some errors","description":"Tests some errors.","operationId":"createErrorTest","requestBody":{"description":"Pass in error test object.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTest"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTest"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/formats":{"get":{"tags":["rootServer"],"summary":"Retrieves formats","description":"Retrieve formats","operationId":"getFormats","responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatCollection"}}}},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}}},"security":[{"bmltToken":[]}]},"post":{"tags":["rootServer"],"summary":"Creates a format","description":"Creates a format.","operationId":"createFormat","requestBody":{"description":"Pass in format object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatCreate"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Format"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/formats/{formatId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a format","description":"Retrieve a format","operationId":"getFormat","parameters":[{"name":"formatId","in":"path","description":"ID of format","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Format"}}}},"401":{"description":"Returns when not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"put":{"tags":["rootServer"],"summary":"Updates a format","description":"Updates a format.","operationId":"updateFormat","parameters":[{"name":"formatId","in":"path","description":"ID of format","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in format object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"delete":{"tags":["rootServer"],"summary":"Deletes a format","description":"Deletes a format by id.","operationId":"deleteFormat","parameters":[{"name":"formatId","in":"path","description":"ID of format","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"204":{"description":"Success."},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"409":{"description":"Returns when format has meetings assigned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"patch":{"tags":["rootServer"],"summary":"Patches a format","description":"Patches a single format by id.","operationId":"patchFormat","parameters":[{"name":"formatId","in":"path","description":"ID of format","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in fields you want to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatPartialUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/logs/laravel":{"get":{"tags":["rootServer"],"summary":"Retrieves laravel log","description":"Retrieve the laravel log if it exists.","operationId":"getLaravelLog","responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/gzip":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no laravel log file exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/meetings/{meetingId}/changes":{"get":{"tags":["rootServer"],"summary":"Retrieve changes for a meeting","description":"Retrieve all changes made to a specific meeting.","operationId":"getMeetingChanges","parameters":[{"name":"meetingId","in":"path","description":"ID of the meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"List of changes for the meeting.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MeetingChangeResource"}}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Meeting not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/meetings":{"get":{"tags":["rootServer"],"summary":"Retrieves meetings","description":"Retrieve meetings for authenticated user.","operationId":"getMeetings","parameters":[{"name":"meetingIds","in":"query","description":"comma delimited meeting ids","required":false,"schema":{"type":"string"},"example":"1,2"},{"name":"days","in":"query","description":"comma delimited day ids between 0-6","required":false,"schema":{"type":"string"},"example":"0,1"},{"name":"serviceBodyIds","in":"query","description":"comma delimited service body ids","required":false,"schema":{"type":"string"},"example":"3,4"},{"name":"searchString","in":"query","description":"string","required":false,"schema":{"type":"string"},"example":"Just for Today"}],"responses":{"200":{"description":"List of meetings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingCollection"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"post":{"tags":["rootServer"],"summary":"Creates a meeting","description":"Creates a meeting.","operationId":"createMeeting","requestBody":{"description":"Pass in meeting object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingCreate"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no meeting body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/meetings/{meetingId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a meeting","description":"Retrieve a meeting.","operationId":"getMeeting","parameters":[{"name":"meetingId","in":"path","description":"ID of meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no meeting exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"put":{"tags":["rootServer"],"summary":"Updates a meeting","description":"Updates a meeting.","operationId":"updateMeeting","parameters":[{"name":"meetingId","in":"path","description":"ID of meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in meeting object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no meeting exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"delete":{"tags":["rootServer"],"summary":"Deletes a meeting","description":"Deletes a meeting by id.","operationId":"deleteMeeting","parameters":[{"name":"meetingId","in":"path","description":"ID of meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no meeting exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"patch":{"tags":["rootServer"],"summary":"Patches a meeting","description":"Patches a meeting by id","operationId":"patchMeeting","parameters":[{"name":"meetingId","in":"path","description":"ID of meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"},{"name":"skipVenueTypeLocationValidation","in":"query","description":"specify true to skip venue type location validation","required":false,"schema":{"type":"boolean"},"example":"true"}],"requestBody":{"description":"Pass in fields you want to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingPartialUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no meeting exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/rootservers":{"get":{"tags":["rootServer"],"summary":"Retrieves root servers","description":"Retrieve root servers.","operationId":"getRootServers","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RootServerCollection"}}}},"404":{"description":"Returns when aggregator mode is disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}}}},"/api/v1/rootservers/{rootServerId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a root server","description":"Retrieve a single root server id.","operationId":"getRootServer","parameters":[{"name":"rootServerId","in":"path","description":"ID of root server","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RootServer"}}}},"404":{"description":"Returns when no root server exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}}}},"/api/v1/servicebodies":{"get":{"tags":["rootServer"],"summary":"Retrieves service bodies","description":"Retrieve service bodies for authenticated user.","operationId":"getServiceBodies","responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBodyCollection"}}}},"401":{"description":"Returns when not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}}},"security":[{"bmltToken":[]}]},"post":{"tags":["rootServer"],"summary":"Creates a service body","description":"Creates a service body.","operationId":"createServiceBody","requestBody":{"description":"Pass in service body object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBodyCreate"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBody"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/servicebodies/{serviceBodyId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a service body","description":"Retrieve a single service body by id.","operationId":"getServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBody"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"put":{"tags":["rootServer"],"summary":"Updates a Service Body","description":"Updates a single service body.","operationId":"updateServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in service body object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBodyUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"delete":{"tags":["rootServer"],"summary":"Deletes a service body","description":"Deletes a service body by id.","operationId":"deleteServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"409":{"description":"Returns when service body has children.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"security":[{"bmltToken":[]}]},"patch":{"tags":["rootServer"],"summary":"Patches a service body","description":"Patches a single service body by id.","operationId":"patchServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in fields you want to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBodyPartialUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/settings":{"get":{"tags":["rootServer"],"summary":"Retrieves all settings","description":"Retrieve all server settings. Only accessible to server administrators.","operationId":"getSettings","responses":{"200":{"description":"Returns when user is authenticated as admin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsObject"}}}},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is not an admin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}}},"security":[{"bmltToken":[]}]},"put":{"tags":["rootServer"],"summary":"Update settings","description":"Updates one or more server settings. Only accessible to server administrators.","operationId":"updateSettings","requestBody":{"description":"Pass in settings object with values to update","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is not an admin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/auth/token":{"post":{"tags":["rootServer"],"summary":"Creates a token","description":"Exchange credentials for a new token","operationId":"authToken","requestBody":{"description":"User credentials","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenCredentials"}}}},"responses":{"200":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"401":{"description":"Returns when credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}}}},"/api/v1/auth/refresh":{"post":{"tags":["rootServer"],"summary":"Revokes and issues a new token","description":"Refresh token.","operationId":"authRefresh","responses":{"200":{"description":"Returns when refresh is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"401":{"description":"Returns when request is unauthenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/auth/logout":{"post":{"tags":["rootServer"],"summary":"Revokes a token","description":"Revoke token and logout.","operationId":"authLogout","responses":{"200":{"description":"Returns when token was logged out."},"401":{"description":"Returns when request is unauthenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/users":{"get":{"tags":["rootServer"],"summary":"Retrieves users","description":"Retrieve users for authenticated user.","operationId":"getUsers","responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCollection"}}}},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}}},"security":[{"bmltToken":[]}]},"post":{"tags":["rootServer"],"summary":"Creates a user","description":"Creates a user.","operationId":"createUser","requestBody":{"description":"Pass in user object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no user exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/users/{userId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a single user","description":"Retrieve single user.","operationId":"getUser","parameters":[{"name":"userId","in":"path","description":"ID of user","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Returns when not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no user exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"put":{"tags":["rootServer"],"summary":"Update single user","description":"Updates a user.","operationId":"updateUser","parameters":[{"name":"userId","in":"path","description":"ID of user","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in user object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no user exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"delete":{"tags":["rootServer"],"summary":"Deletes a user","description":"Deletes a user by id","operationId":"deleteUser","parameters":[{"name":"userId","in":"path","description":"ID of user","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"204":{"description":"Success."},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no user exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"409":{"description":"Returns when user is still referenced by service bodies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"security":[{"bmltToken":[]}]},"patch":{"tags":["rootServer"],"summary":"Patches a user","description":"Patches a user by id.","operationId":"partialUpdateUser","parameters":[{"name":"userId","in":"path","description":"ID of user","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in fields you want to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPartialUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no user exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}}},"components":{"schemas":{"ErrorTest":{"properties":{"arbitrary_string":{"type":"string","example":"string"},"arbitrary_int":{"type":"integer","example":"123"},"force_server_error":{"type":"boolean","example":"true"}},"type":"object"},"AuthenticationError":{"required":["message"],"properties":{"message":{"type":"string","example":"Unauthenticated."}},"type":"object"},"AuthorizationError":{"required":["message"],"properties":{"message":{"type":"string","example":"This action is unauthorized."}},"type":"object"},"NotFoundError":{"required":["message"],"properties":{"message":{"type":"string","example":"The requested resource was not found."}},"type":"object"},"ConflictError":{"required":["message"],"properties":{"message":{"type":"string","example":"Conflict Error"}},"type":"object"},"ValidationError":{"required":["message","errors"],"properties":{"message":{"type":"string","example":"The field is required. (and 1 more error)"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","example":"error details"}}}},"type":"object"},"ServerError":{"required":["message"],"properties":{"message":{"type":"string","example":"Server Error"}},"type":"object"},"FormatBase":{"properties":{"worldId":{"type":"string","example":"string"},"type":{"type":"string","example":"string"},"translations":{"type":"array","items":{"$ref":"#/components/schemas/FormatTranslation"}}},"type":"object"},"FormatTranslation":{"required":["key","name","description","language"],"properties":{"key":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"language":{"type":"string"}},"type":"object"},"Format":{"required":["id","worldId","type","translations"],"type":"object","allOf":[{"$ref":"#/components/schemas/FormatBase"},{"properties":{"id":{"type":"integer","example":"0"}},"type":"object"}]},"FormatCreate":{"required":["translations"],"allOf":[{"$ref":"#/components/schemas/FormatBase"}]},"FormatUpdate":{"required":["translations"],"allOf":[{"$ref":"#/components/schemas/FormatBase"}]},"FormatPartialUpdate":{"allOf":[{"$ref":"#/components/schemas/FormatBase"}]},"FormatCollection":{"type":"array","items":{"$ref":"#/components/schemas/Format"}},"MeetingChangeResource":{"properties":{"dateString":{"description":"Human-readable date and time.","type":"string","example":"3:35 PM, 10/14/2024"},"userName":{"description":"Name of the user who made the change.","type":"string","example":"Greater New York Regional Administrator"},"serviceBodyName":{"description":"Name of the service body related to the meeting.","type":"string","example":"Bronx Area Service"},"details":{"description":"List of details about the changes.","type":"array","items":{"type":"string","example":"email_contact was deleted."}}},"type":"object"},"MeetingBase":{"properties":{"serviceBodyId":{"type":"integer","example":"0"},"formatIds":{"type":"array","items":{"type":"integer"}},"venueType":{"type":"integer","example":"1"},"temporarilyVirtual":{"type":"boolean","example":"false"},"day":{"type":"integer","example":"0"},"startTime":{"type":"string","example":"string"},"duration":{"type":"string","example":"01:00"},"timeZone":{"type":"string","example":"America/New_York"},"latitude":{"type":"number","format":"float","example":"35.698741"},"longitude":{"type":"number","format":"float","example":"-81.26273"},"published":{"type":"boolean","example":"true"},"email":{"type":"string","example":"string"},"worldId":{"type":"string","example":"string"},"name":{"type":"string","example":"string"},"location_text":{"type":"string","example":"string"},"location_info":{"type":"string","example":"string"},"location_street":{"type":"string","example":"string"},"location_neighborhood":{"type":"string","example":"string"},"location_city_subsection":{"type":"string","example":"string"},"location_municipality":{"type":"string","example":"string"},"location_sub_province":{"type":"string","example":"string"},"location_province":{"type":"string","example":"string"},"location_postal_code_1":{"type":"string","example":"string"},"location_nation":{"type":"string","example":"string"},"phone_meeting_number":{"type":"string","example":"string"},"virtual_meeting_link":{"type":"string","example":"string"},"virtual_meeting_additional_info":{"type":"string","example":"string"},"contact_name_1":{"type":"string","example":"string"},"contact_name_2":{"type":"string","example":"string"},"contact_phone_1":{"type":"string","example":"string"},"contact_phone_2":{"type":"string","example":"string"},"contact_email_1":{"type":"string","example":"string"},"contact_email_2":{"type":"string","example":"string"},"bus_lines":{"type":"string","example":"string"},"train_lines":{"type":"string","example":"string"},"comments":{"type":"string","example":"string"},"customFields":{"type":"object","example":{"key1":"value1","key2":"value2"},"additionalProperties":{"type":"string"}}},"type":"object"},"Meeting":{"required":["id","serviceBodyId","formatIds","venueType","temporarilyVirtual","day","startTime","duration","timeZone","latitude","longitude","published","email","worldId","name"],"type":"object","allOf":[{"$ref":"#/components/schemas/MeetingBase"},{"properties":{"id":{"type":"integer","example":"0"}},"type":"object"}]},"MeetingCreate":{"required":["serviceBodyId","formatIds","venueType","day","startTime","duration","latitude","longitude","published","name"],"allOf":[{"$ref":"#/components/schemas/MeetingBase"}]},"MeetingUpdate":{"required":["serviceBodyId","formatIds","venueType","day","startTime","duration","latitude","longitude","published","name"],"allOf":[{"$ref":"#/components/schemas/MeetingBase"}]},"MeetingPartialUpdate":{"allOf":[{"$ref":"#/components/schemas/MeetingBase"}]},"MeetingCollection":{"type":"array","items":{"$ref":"#/components/schemas/Meeting"}},"RootServerBase":{"properties":{"sourceId":{"type":"integer","example":"0"},"name":{"type":"string","example":"string"},"url":{"type":"string","example":"https://example.com/main_server"},"statistics":{"required":["serviceBodies","meetings"],"properties":{"serviceBodies":{"required":["numZones","numRegions","numAreas","numGroups"],"properties":{"numZones":{"type":"integer","example":"0"},"numRegions":{"type":"integer","example":"0"},"numAreas":{"type":"integer","example":"0"},"numGroups":{"type":"integer","example":"0"}},"type":"object"},"meetings":{"required":["numTotal","numInPerson","numVirtual","numHybrid","numUnknown"],"properties":{"numTotal":{"type":"integer","example":"0"},"numInPerson":{"type":"integer","example":"0"},"numVirtual":{"type":"integer","example":"0"},"numHybrid":{"type":"integer","example":"0"},"numUnknown":{"type":"integer","example":"0"}},"type":"object"}},"type":"object"},"serverInfo":{"type":"string","example":"string"},"lastSuccessfulImport":{"type":"string","format":"date-time","example":"2022-11-25 04:16:26"}},"type":"object"},"RootServer":{"required":["id","sourceId","name","url","lastSuccessfulImport"],"type":"object","allOf":[{"$ref":"#/components/schemas/RootServerBase"},{"properties":{"id":{"type":"integer","example":"0"}},"type":"object"}]},"RootServerCollection":{"type":"array","items":{"$ref":"#/components/schemas/RootServer"}},"ServiceBodyBase":{"properties":{"parentId":{"type":"integer","example":"0","nullable":"true"},"name":{"type":"string","example":"string"},"description":{"type":"string","example":"string"},"type":{"type":"string","example":"string"},"adminUserId":{"type":"integer","example":"0"},"assignedUserIds":{"type":"array","items":{"type":"integer","example":"0"}},"url":{"type":"string","example":"string"},"helpline":{"type":"string","example":"string"},"email":{"type":"string","example":"string"},"worldId":{"type":"string","example":"string"}},"type":"object"},"ServiceBody":{"required":["id","parentId","name","description","type","adminUserId","assignedUserIds","url","helpline","email","worldId"],"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceBodyBase"},{"properties":{"id":{"type":"integer","example":"0"}},"type":"object"}]},"ServiceBodyCreate":{"required":["parentId","name","description","type","adminUserId","assignedUserIds"],"allOf":[{"$ref":"#/components/schemas/ServiceBodyBase"}]},"ServiceBodyUpdate":{"required":["parentId","name","description","type","adminUserId","assignedUserIds"],"allOf":[{"$ref":"#/components/schemas/ServiceBodyBase"}]},"ServiceBodyPartialUpdate":{"allOf":[{"$ref":"#/components/schemas/ServiceBodyBase"}]},"ServiceBodyCollection":{"type":"array","items":{"$ref":"#/components/schemas/ServiceBody"}},"SettingsBase":{"properties":{"googleApiKey":{"type":"string"},"changeDepthForMeetings":{"type":"integer"},"defaultSortKey":{"type":"string","nullable":true},"language":{"type":"string"},"defaultDurationTime":{"type":"string"},"regionBias":{"type":"string"},"distanceUnits":{"type":"string"},"enableEmailContact":{"type":"boolean"},"includeServiceBodyAdminOnEmails":{"type":"boolean"},"meetingStatesAndProvinces":{"type":"array","items":{"type":"string"}},"meetingCountiesAndSubProvinces":{"type":"array","items":{"type":"string"}},"searchSpecMapCenterLongitude":{"type":"number","format":"float"},"searchSpecMapCenterLatitude":{"type":"number","format":"float"},"searchSpecMapCenterZoom":{"type":"integer"},"numberOfMeetingsForAuto":{"type":"integer"},"autoGeocodingEnabled":{"type":"boolean"},"countyAutoGeocodingEnabled":{"type":"boolean"},"zipAutoGeocodingEnabled":{"type":"boolean"},"defaultClosedStatus":{"type":"boolean"},"enableLanguageSelector":{"type":"boolean"},"aggregatorModeEnabled":{"type":"boolean"},"aggregatorMaxGeoWidthKm":{"type":"number","format":"float"},"includeServiceBodyEmailInSemantic":{"type":"boolean"},"bmltTitle":{"type":"string"},"bmltNotice":{"type":"string"},"formatLangNames":{"type":"object"}},"type":"object"},"SettingsObject":{"properties":{"googleApiKey":{"type":"string","example":""},"changeDepthForMeetings":{"type":"integer","example":0},"defaultSortKey":{"type":"string","example":null,"nullable":true},"language":{"type":"string","example":"en"},"defaultDurationTime":{"type":"string","example":"01:00"},"regionBias":{"type":"string","example":"us"},"distanceUnits":{"type":"string","example":"mi"},"enableEmailContact":{"type":"boolean","example":false},"includeServiceBodyAdminOnEmails":{"type":"boolean","example":false},"meetingStatesAndProvinces":{"type":"array","items":{"type":"string"},"example":[]},"meetingCountiesAndSubProvinces":{"type":"array","items":{"type":"string"},"example":[]},"searchSpecMapCenterLongitude":{"type":"number","format":"float","example":-118.563659},"searchSpecMapCenterLatitude":{"type":"number","format":"float","example":34.235918},"searchSpecMapCenterZoom":{"type":"integer","example":6},"numberOfMeetingsForAuto":{"type":"integer","example":10},"autoGeocodingEnabled":{"type":"boolean","example":true},"countyAutoGeocodingEnabled":{"type":"boolean","example":false},"zipAutoGeocodingEnabled":{"type":"boolean","example":false},"defaultClosedStatus":{"type":"boolean","example":true},"enableLanguageSelector":{"type":"boolean","example":false},"aggregatorModeEnabled":{"type":"boolean","example":false},"aggregatorMaxGeoWidthKm":{"type":"number","format":"float","example":1000},"includeServiceBodyEmailInSemantic":{"type":"boolean","example":false},"bmltTitle":{"type":"string","example":""},"bmltNotice":{"type":"string","example":""},"formatLangNames":{"type":"object","example":[]}},"type":"object"},"SettingsUpdate":{"description":"Partial update object - include only the settings you want to update","allOf":[{"$ref":"#/components/schemas/SettingsBase"}]},"Token":{"required":["access_token","expires_at","token_type","user_id"],"properties":{"access_token":{"type":"string","example":"2|tR6PIqa8tiBJWMu4zyb3qw4eECuERjLd7xeLKgBu"},"expires_at":{"type":"integer","example":"1667342171"},"token_type":{"type":"string","example":"bearer"},"user_id":{"type":"integer","example":"1"}},"type":"object"},"TokenCredentials":{"required":["username","password"],"properties":{"username":{"type":"string","format":"username","example":"MyUsername"},"password":{"type":"string","format":"password","example":"PassWord12345"}},"type":"object"},"UserBase":{"properties":{"username":{"type":"string","example":"string"},"type":{"type":"string","example":"string"},"displayName":{"type":"string","example":"string"},"description":{"type":"string","example":"string"},"email":{"type":"string","example":"string"},"ownerId":{"type":"integer","example":"0"}},"type":"object"},"User":{"required":["id","username","type","displayName","description","email","ownerId"],"type":"object","allOf":[{"$ref":"#/components/schemas/UserBase"},{"properties":{"id":{"type":"integer","example":"0"},"lastLoginAt":{"type":"string","format":"date-time","example":"2019-05-02T05:05:00.000000Z","nullable":true}},"type":"object"}]},"UserCreate":{"required":["username","password","type","displayName"],"type":"object","allOf":[{"$ref":"#/components/schemas/UserBase"},{"properties":{"password":{"type":"string","example":"string"}},"type":"object"}]},"UserUpdate":{"required":["username","type","displayName"],"type":"object","allOf":[{"$ref":"#/components/schemas/UserBase"},{"properties":{"password":{"type":"string","example":"string"}},"type":"object"}]},"UserPartialUpdate":{"type":"object","allOf":[{"$ref":"#/components/schemas/UserBase"},{"properties":{"password":{"type":"string","example":"string"}},"type":"object"}]},"UserCollection":{"type":"array","items":{"$ref":"#/components/schemas/User"}}},"securitySchemes":{"bmltToken":{"type":"oauth2","flows":{"password":{"tokenUrl":"api/v1/auth/token","refreshUrl":"api/v1/auth/refresh","scopes":{}}}}}},"tags":[{"name":"rootServer","description":"rootServer"}],"servers":[{"url":"http://localhost:8000/main_server/","description":"this server"}]}
1
+ {"openapi":"3.0.0","info":{"title":"BMLT","description":"BMLT Admin API Documentation","license":{"name":"MIT","url":"https://github.com/bmlt-enabled/bmlt-root-server/blob/main/LICENSE"},"version":"1.0.0"},"paths":{"/api/v1/errortest":{"post":{"tags":["rootServer"],"summary":"Tests some errors","description":"Tests some errors.","operationId":"createErrorTest","requestBody":{"description":"Pass in error test object.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTest"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTest"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/formats":{"get":{"tags":["rootServer"],"summary":"Retrieves formats","description":"Retrieve formats","operationId":"getFormats","responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatCollection"}}}},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}}},"security":[{"bmltToken":[]}]},"post":{"tags":["rootServer"],"summary":"Creates a format","description":"Creates a format.","operationId":"createFormat","requestBody":{"description":"Pass in format object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatCreate"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Format"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/formats/{formatId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a format","description":"Retrieve a format","operationId":"getFormat","parameters":[{"name":"formatId","in":"path","description":"ID of format","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Format"}}}},"401":{"description":"Returns when not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"put":{"tags":["rootServer"],"summary":"Updates a format","description":"Updates a format.","operationId":"updateFormat","parameters":[{"name":"formatId","in":"path","description":"ID of format","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in format object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"delete":{"tags":["rootServer"],"summary":"Deletes a format","description":"Deletes a format by id.","operationId":"deleteFormat","parameters":[{"name":"formatId","in":"path","description":"ID of format","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"204":{"description":"Success."},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"409":{"description":"Returns when format has meetings assigned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"patch":{"tags":["rootServer"],"summary":"Patches a format","description":"Patches a single format by id.","operationId":"patchFormat","parameters":[{"name":"formatId","in":"path","description":"ID of format","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in fields you want to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatPartialUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/logs/laravel":{"get":{"tags":["rootServer"],"summary":"Retrieves laravel log","description":"Retrieve the laravel log if it exists.","operationId":"getLaravelLog","responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/gzip":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no laravel log file exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/meetings/{meetingId}/changes":{"get":{"tags":["rootServer"],"summary":"Retrieve changes for a meeting","description":"Retrieve all changes made to a specific meeting.","operationId":"getMeetingChanges","parameters":[{"name":"meetingId","in":"path","description":"ID of the meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"List of changes for the meeting.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MeetingChangeResource"}}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Meeting not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/meetings":{"get":{"tags":["rootServer"],"summary":"Retrieves meetings","description":"Retrieve meetings for authenticated user.","operationId":"getMeetings","parameters":[{"name":"meetingIds","in":"query","description":"comma delimited meeting ids","required":false,"schema":{"type":"string"},"example":"1,2"},{"name":"days","in":"query","description":"comma delimited day ids between 0-6","required":false,"schema":{"type":"string"},"example":"0,1"},{"name":"serviceBodyIds","in":"query","description":"comma delimited service body ids","required":false,"schema":{"type":"string"},"example":"3,4"},{"name":"searchString","in":"query","description":"string","required":false,"schema":{"type":"string"},"example":"Just for Today"}],"responses":{"200":{"description":"List of meetings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingCollection"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"post":{"tags":["rootServer"],"summary":"Creates a meeting","description":"Creates a meeting.","operationId":"createMeeting","requestBody":{"description":"Pass in meeting object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingCreate"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no meeting body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/meetings/{meetingId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a meeting","description":"Retrieve a meeting.","operationId":"getMeeting","parameters":[{"name":"meetingId","in":"path","description":"ID of meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no meeting exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"put":{"tags":["rootServer"],"summary":"Updates a meeting","description":"Updates a meeting.","operationId":"updateMeeting","parameters":[{"name":"meetingId","in":"path","description":"ID of meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in meeting object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no meeting exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"delete":{"tags":["rootServer"],"summary":"Deletes a meeting","description":"Deletes a meeting by id.","operationId":"deleteMeeting","parameters":[{"name":"meetingId","in":"path","description":"ID of meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no meeting exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"patch":{"tags":["rootServer"],"summary":"Patches a meeting","description":"Patches a meeting by id","operationId":"patchMeeting","parameters":[{"name":"meetingId","in":"path","description":"ID of meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"},{"name":"skipVenueTypeLocationValidation","in":"query","description":"specify true to skip venue type location validation","required":false,"schema":{"type":"boolean"},"example":"true"}],"requestBody":{"description":"Pass in fields you want to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingPartialUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no meeting exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/rootservers":{"get":{"tags":["rootServer"],"summary":"Retrieves root servers","description":"Retrieve root servers.","operationId":"getRootServers","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RootServerCollection"}}}},"404":{"description":"Returns when aggregator mode is disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}}}},"/api/v1/rootservers/{rootServerId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a root server","description":"Retrieve a single root server id.","operationId":"getRootServer","parameters":[{"name":"rootServerId","in":"path","description":"ID of root server","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RootServer"}}}},"404":{"description":"Returns when no root server exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}}}},"/api/v1/servicebodies":{"get":{"tags":["rootServer"],"summary":"Retrieves service bodies","description":"Retrieve service bodies for authenticated user.","operationId":"getServiceBodies","responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBodyCollection"}}}},"401":{"description":"Returns when not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}}},"security":[{"bmltToken":[]}]},"post":{"tags":["rootServer"],"summary":"Creates a service body","description":"Creates a service body.","operationId":"createServiceBody","requestBody":{"description":"Pass in service body object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBodyCreate"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBody"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/servicebodies/{serviceBodyId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a service body","description":"Retrieve a single service body by id.","operationId":"getServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBody"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"put":{"tags":["rootServer"],"summary":"Updates a Service Body","description":"Updates a single service body.","operationId":"updateServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in service body object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBodyUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"delete":{"tags":["rootServer"],"summary":"Deletes a service body","description":"Deletes a service body by id.","operationId":"deleteServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"409":{"description":"Returns when service body has children.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"security":[{"bmltToken":[]}]},"patch":{"tags":["rootServer"],"summary":"Patches a service body","description":"Patches a single service body by id.","operationId":"patchServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in fields you want to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBodyPartialUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/settings":{"get":{"tags":["rootServer"],"summary":"Retrieves all settings","description":"Retrieve all server settings. Only accessible to server administrators.","operationId":"getSettings","responses":{"200":{"description":"Returns when user is authenticated as admin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsObject"}}}},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is not an admin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}}},"security":[{"bmltToken":[]}]},"patch":{"tags":["rootServer"],"summary":"Update settings","description":"Updates one or more server settings. Only accessible to server administrators.","operationId":"updateSettings","requestBody":{"description":"Pass in settings object with values to update","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is not an admin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/auth/token":{"post":{"tags":["rootServer"],"summary":"Creates a token","description":"Exchange credentials for a new token","operationId":"authToken","requestBody":{"description":"User credentials","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenCredentials"}}}},"responses":{"200":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"401":{"description":"Returns when credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}}}},"/api/v1/auth/refresh":{"post":{"tags":["rootServer"],"summary":"Revokes and issues a new token","description":"Refresh token.","operationId":"authRefresh","responses":{"200":{"description":"Returns when refresh is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"401":{"description":"Returns when request is unauthenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/auth/logout":{"post":{"tags":["rootServer"],"summary":"Revokes a token","description":"Revoke token and logout.","operationId":"authLogout","responses":{"200":{"description":"Returns when token was logged out."},"401":{"description":"Returns when request is unauthenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/users":{"get":{"tags":["rootServer"],"summary":"Retrieves users","description":"Retrieve users for authenticated user.","operationId":"getUsers","responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCollection"}}}},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}}},"security":[{"bmltToken":[]}]},"post":{"tags":["rootServer"],"summary":"Creates a user","description":"Creates a user.","operationId":"createUser","requestBody":{"description":"Pass in user object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no user exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/users/{userId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a single user","description":"Retrieve single user.","operationId":"getUser","parameters":[{"name":"userId","in":"path","description":"ID of user","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Returns when not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no user exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"put":{"tags":["rootServer"],"summary":"Update single user","description":"Updates a user.","operationId":"updateUser","parameters":[{"name":"userId","in":"path","description":"ID of user","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in user object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no user exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"delete":{"tags":["rootServer"],"summary":"Deletes a user","description":"Deletes a user by id","operationId":"deleteUser","parameters":[{"name":"userId","in":"path","description":"ID of user","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"204":{"description":"Success."},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no user exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"409":{"description":"Returns when user is still referenced by service bodies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"security":[{"bmltToken":[]}]},"patch":{"tags":["rootServer"],"summary":"Patches a user","description":"Patches a user by id.","operationId":"partialUpdateUser","parameters":[{"name":"userId","in":"path","description":"ID of user","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in fields you want to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPartialUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no user exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}}},"components":{"schemas":{"ErrorTest":{"properties":{"arbitrary_string":{"type":"string","example":"string"},"arbitrary_int":{"type":"integer","example":"123"},"force_server_error":{"type":"boolean","example":"true"}},"type":"object"},"AuthenticationError":{"required":["message"],"properties":{"message":{"type":"string","example":"Unauthenticated."}},"type":"object"},"AuthorizationError":{"required":["message"],"properties":{"message":{"type":"string","example":"This action is unauthorized."}},"type":"object"},"NotFoundError":{"required":["message"],"properties":{"message":{"type":"string","example":"The requested resource was not found."}},"type":"object"},"ConflictError":{"required":["message"],"properties":{"message":{"type":"string","example":"Conflict Error"}},"type":"object"},"ValidationError":{"required":["message","errors"],"properties":{"message":{"type":"string","example":"The field is required. (and 1 more error)"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","example":"error details"}}}},"type":"object"},"ServerError":{"required":["message"],"properties":{"message":{"type":"string","example":"Server Error"}},"type":"object"},"FormatBase":{"properties":{"worldId":{"type":"string","example":"string"},"type":{"type":"string","example":"string"},"translations":{"type":"array","items":{"$ref":"#/components/schemas/FormatTranslation"}}},"type":"object"},"FormatTranslation":{"required":["key","name","description","language"],"properties":{"key":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"language":{"type":"string"}},"type":"object"},"Format":{"required":["id","worldId","type","translations"],"type":"object","allOf":[{"$ref":"#/components/schemas/FormatBase"},{"properties":{"id":{"type":"integer","example":"0"}},"type":"object"}]},"FormatCreate":{"required":["translations"],"allOf":[{"$ref":"#/components/schemas/FormatBase"}]},"FormatUpdate":{"required":["translations"],"allOf":[{"$ref":"#/components/schemas/FormatBase"}]},"FormatPartialUpdate":{"allOf":[{"$ref":"#/components/schemas/FormatBase"}]},"FormatCollection":{"type":"array","items":{"$ref":"#/components/schemas/Format"}},"MeetingChangeResource":{"properties":{"dateString":{"description":"Human-readable date and time.","type":"string","example":"3:35 PM, 10/14/2024"},"userName":{"description":"Name of the user who made the change.","type":"string","example":"Greater New York Regional Administrator"},"serviceBodyName":{"description":"Name of the service body related to the meeting.","type":"string","example":"Bronx Area Service"},"details":{"description":"List of details about the changes.","type":"array","items":{"type":"string","example":"email_contact was deleted."}}},"type":"object"},"MeetingBase":{"properties":{"serviceBodyId":{"type":"integer","example":"0"},"formatIds":{"type":"array","items":{"type":"integer"}},"venueType":{"type":"integer","example":"1"},"temporarilyVirtual":{"type":"boolean","example":"false"},"day":{"type":"integer","example":"0"},"startTime":{"type":"string","example":"string"},"duration":{"type":"string","example":"01:00"},"timeZone":{"type":"string","example":"America/New_York"},"latitude":{"type":"number","format":"float","example":"35.698741"},"longitude":{"type":"number","format":"float","example":"-81.26273"},"published":{"type":"boolean","example":"true"},"email":{"type":"string","example":"string"},"worldId":{"type":"string","example":"string"},"name":{"type":"string","example":"string"},"location_text":{"type":"string","example":"string"},"location_info":{"type":"string","example":"string"},"location_street":{"type":"string","example":"string"},"location_neighborhood":{"type":"string","example":"string"},"location_city_subsection":{"type":"string","example":"string"},"location_municipality":{"type":"string","example":"string"},"location_sub_province":{"type":"string","example":"string"},"location_province":{"type":"string","example":"string"},"location_postal_code_1":{"type":"string","example":"string"},"location_nation":{"type":"string","example":"string"},"phone_meeting_number":{"type":"string","example":"string"},"virtual_meeting_link":{"type":"string","example":"string"},"virtual_meeting_additional_info":{"type":"string","example":"string"},"contact_name_1":{"type":"string","example":"string"},"contact_name_2":{"type":"string","example":"string"},"contact_phone_1":{"type":"string","example":"string"},"contact_phone_2":{"type":"string","example":"string"},"contact_email_1":{"type":"string","example":"string"},"contact_email_2":{"type":"string","example":"string"},"bus_lines":{"type":"string","example":"string"},"train_lines":{"type":"string","example":"string"},"comments":{"type":"string","example":"string"},"customFields":{"type":"object","example":{"key1":"value1","key2":"value2"},"additionalProperties":{"type":"string"}}},"type":"object"},"Meeting":{"required":["id","serviceBodyId","formatIds","venueType","temporarilyVirtual","day","startTime","duration","timeZone","latitude","longitude","published","email","worldId","name"],"type":"object","allOf":[{"$ref":"#/components/schemas/MeetingBase"},{"properties":{"id":{"type":"integer","example":"0"}},"type":"object"}]},"MeetingCreate":{"required":["serviceBodyId","formatIds","venueType","day","startTime","duration","latitude","longitude","published","name"],"allOf":[{"$ref":"#/components/schemas/MeetingBase"}]},"MeetingUpdate":{"required":["serviceBodyId","formatIds","venueType","day","startTime","duration","latitude","longitude","published","name"],"allOf":[{"$ref":"#/components/schemas/MeetingBase"}]},"MeetingPartialUpdate":{"allOf":[{"$ref":"#/components/schemas/MeetingBase"}]},"MeetingCollection":{"type":"array","items":{"$ref":"#/components/schemas/Meeting"}},"RootServerBase":{"properties":{"sourceId":{"type":"integer","example":"0"},"name":{"type":"string","example":"string"},"url":{"type":"string","example":"https://example.com/main_server"},"statistics":{"required":["serviceBodies","meetings"],"properties":{"serviceBodies":{"required":["numZones","numRegions","numAreas","numGroups"],"properties":{"numZones":{"type":"integer","example":"0"},"numRegions":{"type":"integer","example":"0"},"numAreas":{"type":"integer","example":"0"},"numGroups":{"type":"integer","example":"0"}},"type":"object"},"meetings":{"required":["numTotal","numInPerson","numVirtual","numHybrid","numUnknown"],"properties":{"numTotal":{"type":"integer","example":"0"},"numInPerson":{"type":"integer","example":"0"},"numVirtual":{"type":"integer","example":"0"},"numHybrid":{"type":"integer","example":"0"},"numUnknown":{"type":"integer","example":"0"}},"type":"object"}},"type":"object"},"serverInfo":{"type":"string","example":"string"},"lastSuccessfulImport":{"type":"string","format":"date-time","example":"2022-11-25 04:16:26"}},"type":"object"},"RootServer":{"required":["id","sourceId","name","url","lastSuccessfulImport"],"type":"object","allOf":[{"$ref":"#/components/schemas/RootServerBase"},{"properties":{"id":{"type":"integer","example":"0"}},"type":"object"}]},"RootServerCollection":{"type":"array","items":{"$ref":"#/components/schemas/RootServer"}},"ServiceBodyBase":{"properties":{"parentId":{"type":"integer","example":"0","nullable":"true"},"name":{"type":"string","example":"string"},"description":{"type":"string","example":"string"},"type":{"type":"string","example":"string"},"adminUserId":{"type":"integer","example":"0"},"assignedUserIds":{"type":"array","items":{"type":"integer","example":"0"}},"url":{"type":"string","example":"string"},"helpline":{"type":"string","example":"string"},"email":{"type":"string","example":"string"},"worldId":{"type":"string","example":"string"}},"type":"object"},"ServiceBody":{"required":["id","parentId","name","description","type","adminUserId","assignedUserIds","url","helpline","email","worldId"],"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceBodyBase"},{"properties":{"id":{"type":"integer","example":"0"}},"type":"object"}]},"ServiceBodyCreate":{"required":["parentId","name","description","type","adminUserId","assignedUserIds"],"allOf":[{"$ref":"#/components/schemas/ServiceBodyBase"}]},"ServiceBodyUpdate":{"required":["parentId","name","description","type","adminUserId","assignedUserIds"],"allOf":[{"$ref":"#/components/schemas/ServiceBodyBase"}]},"ServiceBodyPartialUpdate":{"allOf":[{"$ref":"#/components/schemas/ServiceBodyBase"}]},"ServiceBodyCollection":{"type":"array","items":{"$ref":"#/components/schemas/ServiceBody"}},"SettingsBase":{"properties":{"googleApiKey":{"type":"string"},"changeDepthForMeetings":{"type":"integer"},"defaultSortKey":{"type":"string","nullable":true},"language":{"type":"string"},"defaultDurationTime":{"type":"string"},"regionBias":{"type":"string"},"distanceUnits":{"type":"string"},"meetingStatesAndProvinces":{"type":"array","items":{"type":"string"}},"meetingCountiesAndSubProvinces":{"type":"array","items":{"type":"string"}},"searchSpecMapCenterLongitude":{"type":"number","format":"float"},"searchSpecMapCenterLatitude":{"type":"number","format":"float"},"searchSpecMapCenterZoom":{"type":"integer"},"numberOfMeetingsForAuto":{"type":"integer"},"autoGeocodingEnabled":{"type":"boolean"},"countyAutoGeocodingEnabled":{"type":"boolean"},"zipAutoGeocodingEnabled":{"type":"boolean"},"defaultClosedStatus":{"type":"boolean"},"enableLanguageSelector":{"type":"boolean"},"aggregatorModeEnabled":{"type":"boolean"},"aggregatorMaxGeoWidthKm":{"type":"number","format":"float"},"includeServiceBodyEmailInSemantic":{"type":"boolean"},"bmltTitle":{"type":"string"},"bmltNotice":{"type":"string"},"formatLangNames":{"type":"object"}},"type":"object"},"SettingsObject":{"properties":{"googleApiKey":{"type":"string","example":""},"changeDepthForMeetings":{"type":"integer","example":0},"defaultSortKey":{"type":"string","example":null,"nullable":true},"language":{"type":"string","example":"en"},"defaultDurationTime":{"type":"string","example":"01:00"},"regionBias":{"type":"string","example":"us"},"distanceUnits":{"type":"string","example":"mi"},"meetingStatesAndProvinces":{"type":"array","items":{"type":"string"},"example":[]},"meetingCountiesAndSubProvinces":{"type":"array","items":{"type":"string"},"example":[]},"searchSpecMapCenterLongitude":{"type":"number","format":"float","example":-118.563659},"searchSpecMapCenterLatitude":{"type":"number","format":"float","example":34.235918},"searchSpecMapCenterZoom":{"type":"integer","example":6},"numberOfMeetingsForAuto":{"type":"integer","example":10},"autoGeocodingEnabled":{"type":"boolean","example":true},"countyAutoGeocodingEnabled":{"type":"boolean","example":false},"zipAutoGeocodingEnabled":{"type":"boolean","example":false},"defaultClosedStatus":{"type":"boolean","example":true},"enableLanguageSelector":{"type":"boolean","example":false},"aggregatorModeEnabled":{"type":"boolean","example":false},"aggregatorMaxGeoWidthKm":{"type":"number","format":"float","example":1000},"includeServiceBodyEmailInSemantic":{"type":"boolean","example":false},"bmltTitle":{"type":"string","example":""},"bmltNotice":{"type":"string","example":""},"formatLangNames":{"type":"object","example":[]}},"type":"object"},"SettingsUpdate":{"description":"Partial update object - include only the settings you want to update","allOf":[{"$ref":"#/components/schemas/SettingsBase"}]},"Token":{"required":["access_token","expires_at","token_type","user_id"],"properties":{"access_token":{"type":"string","example":"2|tR6PIqa8tiBJWMu4zyb3qw4eECuERjLd7xeLKgBu"},"expires_at":{"type":"integer","example":"1667342171"},"token_type":{"type":"string","example":"bearer"},"user_id":{"type":"integer","example":"1"}},"type":"object"},"TokenCredentials":{"required":["username","password"],"properties":{"username":{"type":"string","format":"username","example":"MyUsername"},"password":{"type":"string","format":"password","example":"PassWord12345"}},"type":"object"},"UserBase":{"properties":{"username":{"type":"string","example":"string"},"type":{"type":"string","example":"string"},"displayName":{"type":"string","example":"string"},"description":{"type":"string","example":"string"},"email":{"type":"string","example":"string"},"ownerId":{"type":"integer","example":"0"}},"type":"object"},"User":{"required":["id","username","type","displayName","description","email","ownerId"],"type":"object","allOf":[{"$ref":"#/components/schemas/UserBase"},{"properties":{"id":{"type":"integer","example":"0"},"lastLoginAt":{"type":"string","format":"date-time","example":"2019-05-02T05:05:00.000000Z","nullable":true}},"type":"object"}]},"UserCreate":{"required":["username","password","type","displayName"],"type":"object","allOf":[{"$ref":"#/components/schemas/UserBase"},{"properties":{"password":{"type":"string","example":"string"}},"type":"object"}]},"UserUpdate":{"required":["username","type","displayName"],"type":"object","allOf":[{"$ref":"#/components/schemas/UserBase"},{"properties":{"password":{"type":"string","example":"string"}},"type":"object"}]},"UserPartialUpdate":{"type":"object","allOf":[{"$ref":"#/components/schemas/UserBase"},{"properties":{"password":{"type":"string","example":"string"}},"type":"object"}]},"UserCollection":{"type":"array","items":{"$ref":"#/components/schemas/User"}}},"securitySchemes":{"bmltToken":{"type":"oauth2","flows":{"password":{"tokenUrl":"api/v1/auth/token","refreshUrl":"api/v1/auth/refresh","scopes":{}}}}}},"tags":[{"name":"rootServer","description":"rootServer"}],"servers":[{"url":"http://localhost:8000/main_server/","description":"this server"}]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bmlt-server-client",
3
- "version": "1.3.7-beta.1",
3
+ "version": "1.3.7-beta.3",
4
4
  "description": "OpenAPI client for bmlt-server-client",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -1666,7 +1666,7 @@ export class RootServerApi extends runtime.BaseAPI {
1666
1666
 
1667
1667
  const response = await this.request({
1668
1668
  path: urlPath,
1669
- method: 'PUT',
1669
+ method: 'PATCH',
1670
1670
  headers: headerParameters,
1671
1671
  query: queryParameters,
1672
1672
  body: SettingsUpdateToJSON(requestParameters['settingsUpdate']),
@@ -61,18 +61,6 @@ export interface SettingsBase {
61
61
  * @memberof SettingsBase
62
62
  */
63
63
  distanceUnits?: string;
64
- /**
65
- *
66
- * @type {boolean}
67
- * @memberof SettingsBase
68
- */
69
- enableEmailContact?: boolean;
70
- /**
71
- *
72
- * @type {boolean}
73
- * @memberof SettingsBase
74
- */
75
- includeServiceBodyAdminOnEmails?: boolean;
76
64
  /**
77
65
  *
78
66
  * @type {Array<string>}
@@ -201,8 +189,6 @@ export function SettingsBaseFromJSONTyped(json: any, ignoreDiscriminator: boolea
201
189
  'defaultDurationTime': json['defaultDurationTime'] == null ? undefined : json['defaultDurationTime'],
202
190
  'regionBias': json['regionBias'] == null ? undefined : json['regionBias'],
203
191
  'distanceUnits': json['distanceUnits'] == null ? undefined : json['distanceUnits'],
204
- 'enableEmailContact': json['enableEmailContact'] == null ? undefined : json['enableEmailContact'],
205
- 'includeServiceBodyAdminOnEmails': json['includeServiceBodyAdminOnEmails'] == null ? undefined : json['includeServiceBodyAdminOnEmails'],
206
192
  'meetingStatesAndProvinces': json['meetingStatesAndProvinces'] == null ? undefined : json['meetingStatesAndProvinces'],
207
193
  'meetingCountiesAndSubProvinces': json['meetingCountiesAndSubProvinces'] == null ? undefined : json['meetingCountiesAndSubProvinces'],
208
194
  'searchSpecMapCenterLongitude': json['searchSpecMapCenterLongitude'] == null ? undefined : json['searchSpecMapCenterLongitude'],
@@ -241,8 +227,6 @@ export function SettingsBaseToJSONTyped(value?: SettingsBase | null, ignoreDiscr
241
227
  'defaultDurationTime': value['defaultDurationTime'],
242
228
  'regionBias': value['regionBias'],
243
229
  'distanceUnits': value['distanceUnits'],
244
- 'enableEmailContact': value['enableEmailContact'],
245
- 'includeServiceBodyAdminOnEmails': value['includeServiceBodyAdminOnEmails'],
246
230
  'meetingStatesAndProvinces': value['meetingStatesAndProvinces'],
247
231
  'meetingCountiesAndSubProvinces': value['meetingCountiesAndSubProvinces'],
248
232
  'searchSpecMapCenterLongitude': value['searchSpecMapCenterLongitude'],
@@ -61,18 +61,6 @@ export interface SettingsObject {
61
61
  * @memberof SettingsObject
62
62
  */
63
63
  distanceUnits?: string;
64
- /**
65
- *
66
- * @type {boolean}
67
- * @memberof SettingsObject
68
- */
69
- enableEmailContact?: boolean;
70
- /**
71
- *
72
- * @type {boolean}
73
- * @memberof SettingsObject
74
- */
75
- includeServiceBodyAdminOnEmails?: boolean;
76
64
  /**
77
65
  *
78
66
  * @type {Array<string>}
@@ -201,8 +189,6 @@ export function SettingsObjectFromJSONTyped(json: any, ignoreDiscriminator: bool
201
189
  'defaultDurationTime': json['defaultDurationTime'] == null ? undefined : json['defaultDurationTime'],
202
190
  'regionBias': json['regionBias'] == null ? undefined : json['regionBias'],
203
191
  'distanceUnits': json['distanceUnits'] == null ? undefined : json['distanceUnits'],
204
- 'enableEmailContact': json['enableEmailContact'] == null ? undefined : json['enableEmailContact'],
205
- 'includeServiceBodyAdminOnEmails': json['includeServiceBodyAdminOnEmails'] == null ? undefined : json['includeServiceBodyAdminOnEmails'],
206
192
  'meetingStatesAndProvinces': json['meetingStatesAndProvinces'] == null ? undefined : json['meetingStatesAndProvinces'],
207
193
  'meetingCountiesAndSubProvinces': json['meetingCountiesAndSubProvinces'] == null ? undefined : json['meetingCountiesAndSubProvinces'],
208
194
  'searchSpecMapCenterLongitude': json['searchSpecMapCenterLongitude'] == null ? undefined : json['searchSpecMapCenterLongitude'],
@@ -241,8 +227,6 @@ export function SettingsObjectToJSONTyped(value?: SettingsObject | null, ignoreD
241
227
  'defaultDurationTime': value['defaultDurationTime'],
242
228
  'regionBias': value['regionBias'],
243
229
  'distanceUnits': value['distanceUnits'],
244
- 'enableEmailContact': value['enableEmailContact'],
245
- 'includeServiceBodyAdminOnEmails': value['includeServiceBodyAdminOnEmails'],
246
230
  'meetingStatesAndProvinces': value['meetingStatesAndProvinces'],
247
231
  'meetingCountiesAndSubProvinces': value['meetingCountiesAndSubProvinces'],
248
232
  'searchSpecMapCenterLongitude': value['searchSpecMapCenterLongitude'],
@@ -61,18 +61,6 @@ export interface SettingsUpdate {
61
61
  * @memberof SettingsUpdate
62
62
  */
63
63
  distanceUnits?: string;
64
- /**
65
- *
66
- * @type {boolean}
67
- * @memberof SettingsUpdate
68
- */
69
- enableEmailContact?: boolean;
70
- /**
71
- *
72
- * @type {boolean}
73
- * @memberof SettingsUpdate
74
- */
75
- includeServiceBodyAdminOnEmails?: boolean;
76
64
  /**
77
65
  *
78
66
  * @type {Array<string>}
@@ -201,8 +189,6 @@ export function SettingsUpdateFromJSONTyped(json: any, ignoreDiscriminator: bool
201
189
  'defaultDurationTime': json['defaultDurationTime'] == null ? undefined : json['defaultDurationTime'],
202
190
  'regionBias': json['regionBias'] == null ? undefined : json['regionBias'],
203
191
  'distanceUnits': json['distanceUnits'] == null ? undefined : json['distanceUnits'],
204
- 'enableEmailContact': json['enableEmailContact'] == null ? undefined : json['enableEmailContact'],
205
- 'includeServiceBodyAdminOnEmails': json['includeServiceBodyAdminOnEmails'] == null ? undefined : json['includeServiceBodyAdminOnEmails'],
206
192
  'meetingStatesAndProvinces': json['meetingStatesAndProvinces'] == null ? undefined : json['meetingStatesAndProvinces'],
207
193
  'meetingCountiesAndSubProvinces': json['meetingCountiesAndSubProvinces'] == null ? undefined : json['meetingCountiesAndSubProvinces'],
208
194
  'searchSpecMapCenterLongitude': json['searchSpecMapCenterLongitude'] == null ? undefined : json['searchSpecMapCenterLongitude'],
@@ -241,8 +227,6 @@ export function SettingsUpdateToJSONTyped(value?: SettingsUpdate | null, ignoreD
241
227
  'defaultDurationTime': value['defaultDurationTime'],
242
228
  'regionBias': value['regionBias'],
243
229
  'distanceUnits': value['distanceUnits'],
244
- 'enableEmailContact': value['enableEmailContact'],
245
- 'includeServiceBodyAdminOnEmails': value['includeServiceBodyAdminOnEmails'],
246
230
  'meetingStatesAndProvinces': value['meetingStatesAndProvinces'],
247
231
  'meetingCountiesAndSubProvinces': value['meetingCountiesAndSubProvinces'],
248
232
  'searchSpecMapCenterLongitude': value['searchSpecMapCenterLongitude'],