bmlt-server-client 2.0.2 → 2.0.3-beta.1

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
@@ -1,4 +1,4 @@
1
- # bmlt-server-client@2.0.2
1
+ # bmlt-server-client@1.4.0
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -231,6 +231,12 @@ export interface Meeting {
231
231
  * @memberof Meeting
232
232
  */
233
233
  comments?: string;
234
+ /**
235
+ *
236
+ * @type {string}
237
+ * @memberof Meeting
238
+ */
239
+ adminNotes?: string;
234
240
  /**
235
241
  *
236
242
  * @type {{ [key: string]: string; }}
@@ -91,6 +91,7 @@ export function MeetingFromJSONTyped(json, ignoreDiscriminator) {
91
91
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
92
92
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
93
93
  'comments': json['comments'] == null ? undefined : json['comments'],
94
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
94
95
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
95
96
  'id': json['id'],
96
97
  };
@@ -139,6 +140,7 @@ export function MeetingToJSONTyped(value, ignoreDiscriminator = false) {
139
140
  'bus_lines': value['busLines'],
140
141
  'train_lines': value['trainLines'],
141
142
  'comments': value['comments'],
143
+ 'admin_notes': value['adminNotes'],
142
144
  'customFields': value['customFields'],
143
145
  'id': value['id'],
144
146
  };
@@ -231,6 +231,12 @@ export interface MeetingBase {
231
231
  * @memberof MeetingBase
232
232
  */
233
233
  comments?: string;
234
+ /**
235
+ *
236
+ * @type {string}
237
+ * @memberof MeetingBase
238
+ */
239
+ adminNotes?: string;
234
240
  /**
235
241
  *
236
242
  * @type {{ [key: string]: string; }}
@@ -61,6 +61,7 @@ export function MeetingBaseFromJSONTyped(json, ignoreDiscriminator) {
61
61
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
62
62
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
63
63
  'comments': json['comments'] == null ? undefined : json['comments'],
64
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
64
65
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
65
66
  };
66
67
  }
@@ -108,6 +109,7 @@ export function MeetingBaseToJSONTyped(value, ignoreDiscriminator = false) {
108
109
  'bus_lines': value['busLines'],
109
110
  'train_lines': value['trainLines'],
110
111
  'comments': value['comments'],
112
+ 'admin_notes': value['adminNotes'],
111
113
  'customFields': value['customFields'],
112
114
  };
113
115
  }
@@ -231,6 +231,12 @@ export interface MeetingCreate {
231
231
  * @memberof MeetingCreate
232
232
  */
233
233
  comments?: string;
234
+ /**
235
+ *
236
+ * @type {string}
237
+ * @memberof MeetingCreate
238
+ */
239
+ adminNotes?: string;
234
240
  /**
235
241
  *
236
242
  * @type {{ [key: string]: string; }}
@@ -81,6 +81,7 @@ export function MeetingCreateFromJSONTyped(json, ignoreDiscriminator) {
81
81
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
82
82
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
83
83
  'comments': json['comments'] == null ? undefined : json['comments'],
84
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
84
85
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
85
86
  };
86
87
  }
@@ -128,6 +129,7 @@ export function MeetingCreateToJSONTyped(value, ignoreDiscriminator = false) {
128
129
  'bus_lines': value['busLines'],
129
130
  'train_lines': value['trainLines'],
130
131
  'comments': value['comments'],
132
+ 'admin_notes': value['adminNotes'],
131
133
  'customFields': value['customFields'],
132
134
  };
133
135
  }
@@ -231,6 +231,12 @@ export interface MeetingPartialUpdate {
231
231
  * @memberof MeetingPartialUpdate
232
232
  */
233
233
  comments?: string;
234
+ /**
235
+ *
236
+ * @type {string}
237
+ * @memberof MeetingPartialUpdate
238
+ */
239
+ adminNotes?: string;
234
240
  /**
235
241
  *
236
242
  * @type {{ [key: string]: string; }}
@@ -61,6 +61,7 @@ export function MeetingPartialUpdateFromJSONTyped(json, ignoreDiscriminator) {
61
61
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
62
62
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
63
63
  'comments': json['comments'] == null ? undefined : json['comments'],
64
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
64
65
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
65
66
  };
66
67
  }
@@ -108,6 +109,7 @@ export function MeetingPartialUpdateToJSONTyped(value, ignoreDiscriminator = fal
108
109
  'bus_lines': value['busLines'],
109
110
  'train_lines': value['trainLines'],
110
111
  'comments': value['comments'],
112
+ 'admin_notes': value['adminNotes'],
111
113
  'customFields': value['customFields'],
112
114
  };
113
115
  }
@@ -231,6 +231,12 @@ export interface MeetingUpdate {
231
231
  * @memberof MeetingUpdate
232
232
  */
233
233
  comments?: string;
234
+ /**
235
+ *
236
+ * @type {string}
237
+ * @memberof MeetingUpdate
238
+ */
239
+ adminNotes?: string;
234
240
  /**
235
241
  *
236
242
  * @type {{ [key: string]: string; }}
@@ -81,6 +81,7 @@ export function MeetingUpdateFromJSONTyped(json, ignoreDiscriminator) {
81
81
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
82
82
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
83
83
  'comments': json['comments'] == null ? undefined : json['comments'],
84
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
84
85
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
85
86
  };
86
87
  }
@@ -128,6 +129,7 @@ export function MeetingUpdateToJSONTyped(value, ignoreDiscriminator = false) {
128
129
  'bus_lines': value['busLines'],
129
130
  'train_lines': value['trainLines'],
130
131
  'comments': value['comments'],
132
+ 'admin_notes': value['adminNotes'],
131
133
  'customFields': value['customFields'],
132
134
  };
133
135
  }
@@ -231,6 +231,12 @@ export interface Meeting {
231
231
  * @memberof Meeting
232
232
  */
233
233
  comments?: string;
234
+ /**
235
+ *
236
+ * @type {string}
237
+ * @memberof Meeting
238
+ */
239
+ adminNotes?: string;
234
240
  /**
235
241
  *
236
242
  * @type {{ [key: string]: string; }}
@@ -98,6 +98,7 @@ function MeetingFromJSONTyped(json, ignoreDiscriminator) {
98
98
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
99
99
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
100
100
  'comments': json['comments'] == null ? undefined : json['comments'],
101
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
101
102
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
102
103
  'id': json['id'],
103
104
  };
@@ -146,6 +147,7 @@ function MeetingToJSONTyped(value, ignoreDiscriminator = false) {
146
147
  'bus_lines': value['busLines'],
147
148
  'train_lines': value['trainLines'],
148
149
  'comments': value['comments'],
150
+ 'admin_notes': value['adminNotes'],
149
151
  'customFields': value['customFields'],
150
152
  'id': value['id'],
151
153
  };
@@ -231,6 +231,12 @@ export interface MeetingBase {
231
231
  * @memberof MeetingBase
232
232
  */
233
233
  comments?: string;
234
+ /**
235
+ *
236
+ * @type {string}
237
+ * @memberof MeetingBase
238
+ */
239
+ adminNotes?: string;
234
240
  /**
235
241
  *
236
242
  * @type {{ [key: string]: string; }}
@@ -68,6 +68,7 @@ function MeetingBaseFromJSONTyped(json, ignoreDiscriminator) {
68
68
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
69
69
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
70
70
  'comments': json['comments'] == null ? undefined : json['comments'],
71
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
71
72
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
72
73
  };
73
74
  }
@@ -115,6 +116,7 @@ function MeetingBaseToJSONTyped(value, ignoreDiscriminator = false) {
115
116
  'bus_lines': value['busLines'],
116
117
  'train_lines': value['trainLines'],
117
118
  'comments': value['comments'],
119
+ 'admin_notes': value['adminNotes'],
118
120
  'customFields': value['customFields'],
119
121
  };
120
122
  }
@@ -231,6 +231,12 @@ export interface MeetingCreate {
231
231
  * @memberof MeetingCreate
232
232
  */
233
233
  comments?: string;
234
+ /**
235
+ *
236
+ * @type {string}
237
+ * @memberof MeetingCreate
238
+ */
239
+ adminNotes?: string;
234
240
  /**
235
241
  *
236
242
  * @type {{ [key: string]: string; }}
@@ -88,6 +88,7 @@ function MeetingCreateFromJSONTyped(json, ignoreDiscriminator) {
88
88
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
89
89
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
90
90
  'comments': json['comments'] == null ? undefined : json['comments'],
91
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
91
92
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
92
93
  };
93
94
  }
@@ -135,6 +136,7 @@ function MeetingCreateToJSONTyped(value, ignoreDiscriminator = false) {
135
136
  'bus_lines': value['busLines'],
136
137
  'train_lines': value['trainLines'],
137
138
  'comments': value['comments'],
139
+ 'admin_notes': value['adminNotes'],
138
140
  'customFields': value['customFields'],
139
141
  };
140
142
  }
@@ -231,6 +231,12 @@ export interface MeetingPartialUpdate {
231
231
  * @memberof MeetingPartialUpdate
232
232
  */
233
233
  comments?: string;
234
+ /**
235
+ *
236
+ * @type {string}
237
+ * @memberof MeetingPartialUpdate
238
+ */
239
+ adminNotes?: string;
234
240
  /**
235
241
  *
236
242
  * @type {{ [key: string]: string; }}
@@ -68,6 +68,7 @@ function MeetingPartialUpdateFromJSONTyped(json, ignoreDiscriminator) {
68
68
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
69
69
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
70
70
  'comments': json['comments'] == null ? undefined : json['comments'],
71
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
71
72
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
72
73
  };
73
74
  }
@@ -115,6 +116,7 @@ function MeetingPartialUpdateToJSONTyped(value, ignoreDiscriminator = false) {
115
116
  'bus_lines': value['busLines'],
116
117
  'train_lines': value['trainLines'],
117
118
  'comments': value['comments'],
119
+ 'admin_notes': value['adminNotes'],
118
120
  'customFields': value['customFields'],
119
121
  };
120
122
  }
@@ -231,6 +231,12 @@ export interface MeetingUpdate {
231
231
  * @memberof MeetingUpdate
232
232
  */
233
233
  comments?: string;
234
+ /**
235
+ *
236
+ * @type {string}
237
+ * @memberof MeetingUpdate
238
+ */
239
+ adminNotes?: string;
234
240
  /**
235
241
  *
236
242
  * @type {{ [key: string]: string; }}
@@ -88,6 +88,7 @@ function MeetingUpdateFromJSONTyped(json, ignoreDiscriminator) {
88
88
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
89
89
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
90
90
  'comments': json['comments'] == null ? undefined : json['comments'],
91
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
91
92
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
92
93
  };
93
94
  }
@@ -135,6 +136,7 @@ function MeetingUpdateToJSONTyped(value, ignoreDiscriminator = false) {
135
136
  'bus_lines': value['busLines'],
136
137
  'train_lines': value['trainLines'],
137
138
  'comments': value['comments'],
139
+ 'admin_notes': value['adminNotes'],
138
140
  'customFields': value['customFields'],
139
141
  };
140
142
  }
package/docs/Meeting.md CHANGED
@@ -42,6 +42,7 @@ Name | Type
42
42
  `busLines` | string
43
43
  `trainLines` | string
44
44
  `comments` | string
45
+ `adminNotes` | string
45
46
  `customFields` | { [key: string]: string; }
46
47
  `id` | number
47
48
 
@@ -88,6 +89,7 @@ const example = {
88
89
  "busLines": string,
89
90
  "trainLines": string,
90
91
  "comments": string,
92
+ "adminNotes": string,
91
93
  "customFields": {key1=value1, key2=value2},
92
94
  "id": 0,
93
95
  } satisfies Meeting
@@ -42,6 +42,7 @@ Name | Type
42
42
  `busLines` | string
43
43
  `trainLines` | string
44
44
  `comments` | string
45
+ `adminNotes` | string
45
46
  `customFields` | { [key: string]: string; }
46
47
 
47
48
  ## Example
@@ -87,6 +88,7 @@ const example = {
87
88
  "busLines": string,
88
89
  "trainLines": string,
89
90
  "comments": string,
91
+ "adminNotes": string,
90
92
  "customFields": {"key1":"value1","key2":"value2"},
91
93
  } satisfies MeetingBase
92
94
 
@@ -42,6 +42,7 @@ Name | Type
42
42
  `busLines` | string
43
43
  `trainLines` | string
44
44
  `comments` | string
45
+ `adminNotes` | string
45
46
  `customFields` | { [key: string]: string; }
46
47
 
47
48
  ## Example
@@ -87,6 +88,7 @@ const example = {
87
88
  "busLines": string,
88
89
  "trainLines": string,
89
90
  "comments": string,
91
+ "adminNotes": string,
90
92
  "customFields": {key1=value1, key2=value2},
91
93
  } satisfies MeetingCreate
92
94
 
@@ -42,6 +42,7 @@ Name | Type
42
42
  `busLines` | string
43
43
  `trainLines` | string
44
44
  `comments` | string
45
+ `adminNotes` | string
45
46
  `customFields` | { [key: string]: string; }
46
47
 
47
48
  ## Example
@@ -87,6 +88,7 @@ const example = {
87
88
  "busLines": string,
88
89
  "trainLines": string,
89
90
  "comments": string,
91
+ "adminNotes": string,
90
92
  "customFields": {key1=value1, key2=value2},
91
93
  } satisfies MeetingPartialUpdate
92
94
 
@@ -42,6 +42,7 @@ Name | Type
42
42
  `busLines` | string
43
43
  `trainLines` | string
44
44
  `comments` | string
45
+ `adminNotes` | string
45
46
  `customFields` | { [key: string]: string; }
46
47
 
47
48
  ## Example
@@ -87,6 +88,7 @@ const example = {
87
88
  "busLines": string,
88
89
  "trainLines": string,
89
90
  "comments": string,
91
+ "adminNotes": string,
90
92
  "customFields": {key1=value1, key2=value2},
91
93
  } satisfies MeetingUpdate
92
94
 
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. If the service body has meetings, use force=true to delete them as well.","operationId":"deleteServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"},{"name":"force","in":"query","description":"Force deletion of service body and all associated meetings","required":false,"schema":{"type":"string","default":"false","enum":["true","false"]},"example":"false"}],"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 or meetings (when force=false).","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"},"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},"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. If the service body has meetings, use force=true to delete them as well.","operationId":"deleteServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"},{"name":"force","in":"query","description":"Force deletion of service body and all associated meetings","required":false,"schema":{"type":"string","default":"false","enum":["true","false"]},"example":"false"}],"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 or meetings (when force=false).","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"},"admin_notes":{"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"},"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},"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": "2.0.2",
3
+ "version": "2.0.3-beta.1",
4
4
  "description": "OpenAPI client for bmlt-server-client",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -235,6 +235,12 @@ export interface Meeting {
235
235
  * @memberof Meeting
236
236
  */
237
237
  comments?: string;
238
+ /**
239
+ *
240
+ * @type {string}
241
+ * @memberof Meeting
242
+ */
243
+ adminNotes?: string;
238
244
  /**
239
245
  *
240
246
  * @type {{ [key: string]: string; }}
@@ -317,6 +323,7 @@ export function MeetingFromJSONTyped(json: any, ignoreDiscriminator: boolean): M
317
323
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
318
324
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
319
325
  'comments': json['comments'] == null ? undefined : json['comments'],
326
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
320
327
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
321
328
  'id': json['id'],
322
329
  };
@@ -369,6 +376,7 @@ export function MeetingToJSONTyped(value?: Meeting | null, ignoreDiscriminator:
369
376
  'bus_lines': value['busLines'],
370
377
  'train_lines': value['trainLines'],
371
378
  'comments': value['comments'],
379
+ 'admin_notes': value['adminNotes'],
372
380
  'customFields': value['customFields'],
373
381
  'id': value['id'],
374
382
  };
@@ -235,6 +235,12 @@ export interface MeetingBase {
235
235
  * @memberof MeetingBase
236
236
  */
237
237
  comments?: string;
238
+ /**
239
+ *
240
+ * @type {string}
241
+ * @memberof MeetingBase
242
+ */
243
+ adminNotes?: string;
238
244
  /**
239
245
  *
240
246
  * @type {{ [key: string]: string; }}
@@ -296,6 +302,7 @@ export function MeetingBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean
296
302
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
297
303
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
298
304
  'comments': json['comments'] == null ? undefined : json['comments'],
305
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
299
306
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
300
307
  };
301
308
  }
@@ -347,6 +354,7 @@ export function MeetingBaseToJSONTyped(value?: MeetingBase | null, ignoreDiscrim
347
354
  'bus_lines': value['busLines'],
348
355
  'train_lines': value['trainLines'],
349
356
  'comments': value['comments'],
357
+ 'admin_notes': value['adminNotes'],
350
358
  'customFields': value['customFields'],
351
359
  };
352
360
  }
@@ -235,6 +235,12 @@ export interface MeetingCreate {
235
235
  * @memberof MeetingCreate
236
236
  */
237
237
  comments?: string;
238
+ /**
239
+ *
240
+ * @type {string}
241
+ * @memberof MeetingCreate
242
+ */
243
+ adminNotes?: string;
238
244
  /**
239
245
  *
240
246
  * @type {{ [key: string]: string; }}
@@ -306,6 +312,7 @@ export function MeetingCreateFromJSONTyped(json: any, ignoreDiscriminator: boole
306
312
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
307
313
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
308
314
  'comments': json['comments'] == null ? undefined : json['comments'],
315
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
309
316
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
310
317
  };
311
318
  }
@@ -357,6 +364,7 @@ export function MeetingCreateToJSONTyped(value?: MeetingCreate | null, ignoreDis
357
364
  'bus_lines': value['busLines'],
358
365
  'train_lines': value['trainLines'],
359
366
  'comments': value['comments'],
367
+ 'admin_notes': value['adminNotes'],
360
368
  'customFields': value['customFields'],
361
369
  };
362
370
  }
@@ -235,6 +235,12 @@ export interface MeetingPartialUpdate {
235
235
  * @memberof MeetingPartialUpdate
236
236
  */
237
237
  comments?: string;
238
+ /**
239
+ *
240
+ * @type {string}
241
+ * @memberof MeetingPartialUpdate
242
+ */
243
+ adminNotes?: string;
238
244
  /**
239
245
  *
240
246
  * @type {{ [key: string]: string; }}
@@ -296,6 +302,7 @@ export function MeetingPartialUpdateFromJSONTyped(json: any, ignoreDiscriminator
296
302
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
297
303
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
298
304
  'comments': json['comments'] == null ? undefined : json['comments'],
305
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
299
306
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
300
307
  };
301
308
  }
@@ -347,6 +354,7 @@ export function MeetingPartialUpdateToJSONTyped(value?: MeetingPartialUpdate | n
347
354
  'bus_lines': value['busLines'],
348
355
  'train_lines': value['trainLines'],
349
356
  'comments': value['comments'],
357
+ 'admin_notes': value['adminNotes'],
350
358
  'customFields': value['customFields'],
351
359
  };
352
360
  }
@@ -235,6 +235,12 @@ export interface MeetingUpdate {
235
235
  * @memberof MeetingUpdate
236
236
  */
237
237
  comments?: string;
238
+ /**
239
+ *
240
+ * @type {string}
241
+ * @memberof MeetingUpdate
242
+ */
243
+ adminNotes?: string;
238
244
  /**
239
245
  *
240
246
  * @type {{ [key: string]: string; }}
@@ -306,6 +312,7 @@ export function MeetingUpdateFromJSONTyped(json: any, ignoreDiscriminator: boole
306
312
  'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
307
313
  'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
308
314
  'comments': json['comments'] == null ? undefined : json['comments'],
315
+ 'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
309
316
  'customFields': json['customFields'] == null ? undefined : json['customFields'],
310
317
  };
311
318
  }
@@ -357,6 +364,7 @@ export function MeetingUpdateToJSONTyped(value?: MeetingUpdate | null, ignoreDis
357
364
  'bus_lines': value['busLines'],
358
365
  'train_lines': value['trainLines'],
359
366
  'comments': value['comments'],
367
+ 'admin_notes': value['adminNotes'],
360
368
  'customFields': value['customFields'],
361
369
  };
362
370
  }