bmlt-server-client 2.0.2-beta.1 → 2.0.2-beta.2
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/dist/apis/RootServerApi.d.ts +11 -2
- package/dist/apis/RootServerApi.js +13 -3
- package/dist/esm/apis/RootServerApi.d.ts +11 -2
- package/dist/esm/apis/RootServerApi.js +12 -2
- package/dist/esm/models/Meeting.d.ts +0 -6
- package/dist/esm/models/Meeting.js +0 -2
- package/dist/esm/models/MeetingBase.d.ts +0 -6
- package/dist/esm/models/MeetingBase.js +0 -2
- package/dist/esm/models/MeetingCreate.d.ts +0 -6
- package/dist/esm/models/MeetingCreate.js +0 -2
- package/dist/esm/models/MeetingPartialUpdate.d.ts +0 -6
- package/dist/esm/models/MeetingPartialUpdate.js +0 -2
- package/dist/esm/models/MeetingUpdate.d.ts +0 -6
- package/dist/esm/models/MeetingUpdate.js +0 -2
- package/dist/models/Meeting.d.ts +0 -6
- package/dist/models/Meeting.js +0 -2
- package/dist/models/MeetingBase.d.ts +0 -6
- package/dist/models/MeetingBase.js +0 -2
- package/dist/models/MeetingCreate.d.ts +0 -6
- package/dist/models/MeetingCreate.js +0 -2
- package/dist/models/MeetingPartialUpdate.d.ts +0 -6
- package/dist/models/MeetingPartialUpdate.js +0 -2
- package/dist/models/MeetingUpdate.d.ts +0 -6
- package/dist/models/MeetingUpdate.js +0 -2
- package/docs/Meeting.md +0 -2
- package/docs/MeetingBase.md +0 -2
- package/docs/MeetingCreate.md +0 -2
- package/docs/MeetingPartialUpdate.md +0 -2
- package/docs/MeetingUpdate.md +0 -2
- package/docs/RootServerApi.md +6 -3
- package/openapi.json +1 -1
- package/package.json +1 -1
- package/src/apis/RootServerApi.ts +16 -2
- package/src/models/Meeting.ts +0 -8
- package/src/models/MeetingBase.ts +0 -8
- package/src/models/MeetingCreate.ts +0 -8
- package/src/models/MeetingPartialUpdate.ts +0 -8
- package/src/models/MeetingUpdate.ts +0 -8
|
@@ -37,6 +37,7 @@ export interface DeleteMeetingRequest {
|
|
|
37
37
|
}
|
|
38
38
|
export interface DeleteServiceBodyRequest {
|
|
39
39
|
serviceBodyId: number;
|
|
40
|
+
force?: DeleteServiceBodyForceEnum;
|
|
40
41
|
}
|
|
41
42
|
export interface DeleteUserRequest {
|
|
42
43
|
userId: number;
|
|
@@ -206,12 +207,12 @@ export declare class RootServerApi extends runtime.BaseAPI {
|
|
|
206
207
|
*/
|
|
207
208
|
deleteMeeting(requestParameters: DeleteMeetingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
208
209
|
/**
|
|
209
|
-
* Deletes a service body by id.
|
|
210
|
+
* Deletes a service body by id. If the service body has meetings, use force=true to delete them as well.
|
|
210
211
|
* Deletes a service body
|
|
211
212
|
*/
|
|
212
213
|
deleteServiceBodyRaw(requestParameters: DeleteServiceBodyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
213
214
|
/**
|
|
214
|
-
* Deletes a service body by id.
|
|
215
|
+
* Deletes a service body by id. If the service body has meetings, use force=true to delete them as well.
|
|
215
216
|
* Deletes a service body
|
|
216
217
|
*/
|
|
217
218
|
deleteServiceBody(requestParameters: DeleteServiceBodyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -446,3 +447,11 @@ export declare class RootServerApi extends runtime.BaseAPI {
|
|
|
446
447
|
*/
|
|
447
448
|
updateUser(requestParameters: UpdateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
448
449
|
}
|
|
450
|
+
/**
|
|
451
|
+
* @export
|
|
452
|
+
*/
|
|
453
|
+
export declare const DeleteServiceBodyForceEnum: {
|
|
454
|
+
readonly True: "true";
|
|
455
|
+
readonly False: "false";
|
|
456
|
+
};
|
|
457
|
+
export type DeleteServiceBodyForceEnum = typeof DeleteServiceBodyForceEnum[keyof typeof DeleteServiceBodyForceEnum];
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.RootServerApi = void 0;
|
|
25
|
+
exports.DeleteServiceBodyForceEnum = exports.RootServerApi = void 0;
|
|
26
26
|
const runtime = require("../runtime");
|
|
27
27
|
const index_1 = require("../models/index");
|
|
28
28
|
/**
|
|
@@ -381,7 +381,7 @@ class RootServerApi extends runtime.BaseAPI {
|
|
|
381
381
|
});
|
|
382
382
|
}
|
|
383
383
|
/**
|
|
384
|
-
* Deletes a service body by id.
|
|
384
|
+
* Deletes a service body by id. If the service body has meetings, use force=true to delete them as well.
|
|
385
385
|
* Deletes a service body
|
|
386
386
|
*/
|
|
387
387
|
deleteServiceBodyRaw(requestParameters, initOverrides) {
|
|
@@ -390,6 +390,9 @@ class RootServerApi extends runtime.BaseAPI {
|
|
|
390
390
|
throw new runtime.RequiredError('serviceBodyId', 'Required parameter "serviceBodyId" was null or undefined when calling deleteServiceBody().');
|
|
391
391
|
}
|
|
392
392
|
const queryParameters = {};
|
|
393
|
+
if (requestParameters['force'] != null) {
|
|
394
|
+
queryParameters['force'] = requestParameters['force'];
|
|
395
|
+
}
|
|
393
396
|
const headerParameters = {};
|
|
394
397
|
if (this.configuration && this.configuration.accessToken) {
|
|
395
398
|
// oauth required
|
|
@@ -407,7 +410,7 @@ class RootServerApi extends runtime.BaseAPI {
|
|
|
407
410
|
});
|
|
408
411
|
}
|
|
409
412
|
/**
|
|
410
|
-
* Deletes a service body by id.
|
|
413
|
+
* Deletes a service body by id. If the service body has meetings, use force=true to delete them as well.
|
|
411
414
|
* Deletes a service body
|
|
412
415
|
*/
|
|
413
416
|
deleteServiceBody(requestParameters, initOverrides) {
|
|
@@ -1255,3 +1258,10 @@ class RootServerApi extends runtime.BaseAPI {
|
|
|
1255
1258
|
}
|
|
1256
1259
|
}
|
|
1257
1260
|
exports.RootServerApi = RootServerApi;
|
|
1261
|
+
/**
|
|
1262
|
+
* @export
|
|
1263
|
+
*/
|
|
1264
|
+
exports.DeleteServiceBodyForceEnum = {
|
|
1265
|
+
True: 'true',
|
|
1266
|
+
False: 'false'
|
|
1267
|
+
};
|
|
@@ -37,6 +37,7 @@ export interface DeleteMeetingRequest {
|
|
|
37
37
|
}
|
|
38
38
|
export interface DeleteServiceBodyRequest {
|
|
39
39
|
serviceBodyId: number;
|
|
40
|
+
force?: DeleteServiceBodyForceEnum;
|
|
40
41
|
}
|
|
41
42
|
export interface DeleteUserRequest {
|
|
42
43
|
userId: number;
|
|
@@ -206,12 +207,12 @@ export declare class RootServerApi extends runtime.BaseAPI {
|
|
|
206
207
|
*/
|
|
207
208
|
deleteMeeting(requestParameters: DeleteMeetingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
208
209
|
/**
|
|
209
|
-
* Deletes a service body by id.
|
|
210
|
+
* Deletes a service body by id. If the service body has meetings, use force=true to delete them as well.
|
|
210
211
|
* Deletes a service body
|
|
211
212
|
*/
|
|
212
213
|
deleteServiceBodyRaw(requestParameters: DeleteServiceBodyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
213
214
|
/**
|
|
214
|
-
* Deletes a service body by id.
|
|
215
|
+
* Deletes a service body by id. If the service body has meetings, use force=true to delete them as well.
|
|
215
216
|
* Deletes a service body
|
|
216
217
|
*/
|
|
217
218
|
deleteServiceBody(requestParameters: DeleteServiceBodyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -446,3 +447,11 @@ export declare class RootServerApi extends runtime.BaseAPI {
|
|
|
446
447
|
*/
|
|
447
448
|
updateUser(requestParameters: UpdateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
448
449
|
}
|
|
450
|
+
/**
|
|
451
|
+
* @export
|
|
452
|
+
*/
|
|
453
|
+
export declare const DeleteServiceBodyForceEnum: {
|
|
454
|
+
readonly True: "true";
|
|
455
|
+
readonly False: "false";
|
|
456
|
+
};
|
|
457
|
+
export type DeleteServiceBodyForceEnum = typeof DeleteServiceBodyForceEnum[keyof typeof DeleteServiceBodyForceEnum];
|
|
@@ -378,7 +378,7 @@ export class RootServerApi extends runtime.BaseAPI {
|
|
|
378
378
|
});
|
|
379
379
|
}
|
|
380
380
|
/**
|
|
381
|
-
* Deletes a service body by id.
|
|
381
|
+
* Deletes a service body by id. If the service body has meetings, use force=true to delete them as well.
|
|
382
382
|
* Deletes a service body
|
|
383
383
|
*/
|
|
384
384
|
deleteServiceBodyRaw(requestParameters, initOverrides) {
|
|
@@ -387,6 +387,9 @@ export class RootServerApi extends runtime.BaseAPI {
|
|
|
387
387
|
throw new runtime.RequiredError('serviceBodyId', 'Required parameter "serviceBodyId" was null or undefined when calling deleteServiceBody().');
|
|
388
388
|
}
|
|
389
389
|
const queryParameters = {};
|
|
390
|
+
if (requestParameters['force'] != null) {
|
|
391
|
+
queryParameters['force'] = requestParameters['force'];
|
|
392
|
+
}
|
|
390
393
|
const headerParameters = {};
|
|
391
394
|
if (this.configuration && this.configuration.accessToken) {
|
|
392
395
|
// oauth required
|
|
@@ -404,7 +407,7 @@ export class RootServerApi extends runtime.BaseAPI {
|
|
|
404
407
|
});
|
|
405
408
|
}
|
|
406
409
|
/**
|
|
407
|
-
* Deletes a service body by id.
|
|
410
|
+
* Deletes a service body by id. If the service body has meetings, use force=true to delete them as well.
|
|
408
411
|
* Deletes a service body
|
|
409
412
|
*/
|
|
410
413
|
deleteServiceBody(requestParameters, initOverrides) {
|
|
@@ -1251,3 +1254,10 @@ export class RootServerApi extends runtime.BaseAPI {
|
|
|
1251
1254
|
});
|
|
1252
1255
|
}
|
|
1253
1256
|
}
|
|
1257
|
+
/**
|
|
1258
|
+
* @export
|
|
1259
|
+
*/
|
|
1260
|
+
export const DeleteServiceBodyForceEnum = {
|
|
1261
|
+
True: 'true',
|
|
1262
|
+
False: 'false'
|
|
1263
|
+
};
|
|
@@ -91,7 +91,6 @@ 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'],
|
|
95
94
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
96
95
|
'id': json['id'],
|
|
97
96
|
};
|
|
@@ -140,7 +139,6 @@ export function MeetingToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
140
139
|
'bus_lines': value['busLines'],
|
|
141
140
|
'train_lines': value['trainLines'],
|
|
142
141
|
'comments': value['comments'],
|
|
143
|
-
'admin_notes': value['adminNotes'],
|
|
144
142
|
'customFields': value['customFields'],
|
|
145
143
|
'id': value['id'],
|
|
146
144
|
};
|
|
@@ -61,7 +61,6 @@ 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'],
|
|
65
64
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
66
65
|
};
|
|
67
66
|
}
|
|
@@ -109,7 +108,6 @@ export function MeetingBaseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
109
108
|
'bus_lines': value['busLines'],
|
|
110
109
|
'train_lines': value['trainLines'],
|
|
111
110
|
'comments': value['comments'],
|
|
112
|
-
'admin_notes': value['adminNotes'],
|
|
113
111
|
'customFields': value['customFields'],
|
|
114
112
|
};
|
|
115
113
|
}
|
|
@@ -231,12 +231,6 @@ 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;
|
|
240
234
|
/**
|
|
241
235
|
*
|
|
242
236
|
* @type {{ [key: string]: string; }}
|
|
@@ -81,7 +81,6 @@ 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'],
|
|
85
84
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
86
85
|
};
|
|
87
86
|
}
|
|
@@ -129,7 +128,6 @@ export function MeetingCreateToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
129
128
|
'bus_lines': value['busLines'],
|
|
130
129
|
'train_lines': value['trainLines'],
|
|
131
130
|
'comments': value['comments'],
|
|
132
|
-
'admin_notes': value['adminNotes'],
|
|
133
131
|
'customFields': value['customFields'],
|
|
134
132
|
};
|
|
135
133
|
}
|
|
@@ -231,12 +231,6 @@ 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;
|
|
240
234
|
/**
|
|
241
235
|
*
|
|
242
236
|
* @type {{ [key: string]: string; }}
|
|
@@ -61,7 +61,6 @@ 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'],
|
|
65
64
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
66
65
|
};
|
|
67
66
|
}
|
|
@@ -109,7 +108,6 @@ export function MeetingPartialUpdateToJSONTyped(value, ignoreDiscriminator = fal
|
|
|
109
108
|
'bus_lines': value['busLines'],
|
|
110
109
|
'train_lines': value['trainLines'],
|
|
111
110
|
'comments': value['comments'],
|
|
112
|
-
'admin_notes': value['adminNotes'],
|
|
113
111
|
'customFields': value['customFields'],
|
|
114
112
|
};
|
|
115
113
|
}
|
|
@@ -231,12 +231,6 @@ 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;
|
|
240
234
|
/**
|
|
241
235
|
*
|
|
242
236
|
* @type {{ [key: string]: string; }}
|
|
@@ -81,7 +81,6 @@ 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'],
|
|
85
84
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
86
85
|
};
|
|
87
86
|
}
|
|
@@ -129,7 +128,6 @@ export function MeetingUpdateToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
129
128
|
'bus_lines': value['busLines'],
|
|
130
129
|
'train_lines': value['trainLines'],
|
|
131
130
|
'comments': value['comments'],
|
|
132
|
-
'admin_notes': value['adminNotes'],
|
|
133
131
|
'customFields': value['customFields'],
|
|
134
132
|
};
|
|
135
133
|
}
|
package/dist/models/Meeting.d.ts
CHANGED
package/dist/models/Meeting.js
CHANGED
|
@@ -98,7 +98,6 @@ 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'],
|
|
102
101
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
103
102
|
'id': json['id'],
|
|
104
103
|
};
|
|
@@ -147,7 +146,6 @@ function MeetingToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
147
146
|
'bus_lines': value['busLines'],
|
|
148
147
|
'train_lines': value['trainLines'],
|
|
149
148
|
'comments': value['comments'],
|
|
150
|
-
'admin_notes': value['adminNotes'],
|
|
151
149
|
'customFields': value['customFields'],
|
|
152
150
|
'id': value['id'],
|
|
153
151
|
};
|
|
@@ -68,7 +68,6 @@ 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'],
|
|
72
71
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
73
72
|
};
|
|
74
73
|
}
|
|
@@ -116,7 +115,6 @@ function MeetingBaseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
116
115
|
'bus_lines': value['busLines'],
|
|
117
116
|
'train_lines': value['trainLines'],
|
|
118
117
|
'comments': value['comments'],
|
|
119
|
-
'admin_notes': value['adminNotes'],
|
|
120
118
|
'customFields': value['customFields'],
|
|
121
119
|
};
|
|
122
120
|
}
|
|
@@ -231,12 +231,6 @@ 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;
|
|
240
234
|
/**
|
|
241
235
|
*
|
|
242
236
|
* @type {{ [key: string]: string; }}
|
|
@@ -88,7 +88,6 @@ 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'],
|
|
92
91
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
93
92
|
};
|
|
94
93
|
}
|
|
@@ -136,7 +135,6 @@ function MeetingCreateToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
136
135
|
'bus_lines': value['busLines'],
|
|
137
136
|
'train_lines': value['trainLines'],
|
|
138
137
|
'comments': value['comments'],
|
|
139
|
-
'admin_notes': value['adminNotes'],
|
|
140
138
|
'customFields': value['customFields'],
|
|
141
139
|
};
|
|
142
140
|
}
|
|
@@ -231,12 +231,6 @@ 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;
|
|
240
234
|
/**
|
|
241
235
|
*
|
|
242
236
|
* @type {{ [key: string]: string; }}
|
|
@@ -68,7 +68,6 @@ 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'],
|
|
72
71
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
73
72
|
};
|
|
74
73
|
}
|
|
@@ -116,7 +115,6 @@ function MeetingPartialUpdateToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
116
115
|
'bus_lines': value['busLines'],
|
|
117
116
|
'train_lines': value['trainLines'],
|
|
118
117
|
'comments': value['comments'],
|
|
119
|
-
'admin_notes': value['adminNotes'],
|
|
120
118
|
'customFields': value['customFields'],
|
|
121
119
|
};
|
|
122
120
|
}
|
|
@@ -231,12 +231,6 @@ 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;
|
|
240
234
|
/**
|
|
241
235
|
*
|
|
242
236
|
* @type {{ [key: string]: string; }}
|
|
@@ -88,7 +88,6 @@ 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'],
|
|
92
91
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
93
92
|
};
|
|
94
93
|
}
|
|
@@ -136,7 +135,6 @@ function MeetingUpdateToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
136
135
|
'bus_lines': value['busLines'],
|
|
137
136
|
'train_lines': value['trainLines'],
|
|
138
137
|
'comments': value['comments'],
|
|
139
|
-
'admin_notes': value['adminNotes'],
|
|
140
138
|
'customFields': value['customFields'],
|
|
141
139
|
};
|
|
142
140
|
}
|
package/docs/Meeting.md
CHANGED
|
@@ -42,7 +42,6 @@ Name | Type
|
|
|
42
42
|
`busLines` | string
|
|
43
43
|
`trainLines` | string
|
|
44
44
|
`comments` | string
|
|
45
|
-
`adminNotes` | string
|
|
46
45
|
`customFields` | { [key: string]: string; }
|
|
47
46
|
`id` | number
|
|
48
47
|
|
|
@@ -89,7 +88,6 @@ const example = {
|
|
|
89
88
|
"busLines": string,
|
|
90
89
|
"trainLines": string,
|
|
91
90
|
"comments": string,
|
|
92
|
-
"adminNotes": string,
|
|
93
91
|
"customFields": {key1=value1, key2=value2},
|
|
94
92
|
"id": 0,
|
|
95
93
|
} satisfies Meeting
|
package/docs/MeetingBase.md
CHANGED
|
@@ -42,7 +42,6 @@ Name | Type
|
|
|
42
42
|
`busLines` | string
|
|
43
43
|
`trainLines` | string
|
|
44
44
|
`comments` | string
|
|
45
|
-
`adminNotes` | string
|
|
46
45
|
`customFields` | { [key: string]: string; }
|
|
47
46
|
|
|
48
47
|
## Example
|
|
@@ -88,7 +87,6 @@ const example = {
|
|
|
88
87
|
"busLines": string,
|
|
89
88
|
"trainLines": string,
|
|
90
89
|
"comments": string,
|
|
91
|
-
"adminNotes": string,
|
|
92
90
|
"customFields": {"key1":"value1","key2":"value2"},
|
|
93
91
|
} satisfies MeetingBase
|
|
94
92
|
|
package/docs/MeetingCreate.md
CHANGED
|
@@ -42,7 +42,6 @@ Name | Type
|
|
|
42
42
|
`busLines` | string
|
|
43
43
|
`trainLines` | string
|
|
44
44
|
`comments` | string
|
|
45
|
-
`adminNotes` | string
|
|
46
45
|
`customFields` | { [key: string]: string; }
|
|
47
46
|
|
|
48
47
|
## Example
|
|
@@ -88,7 +87,6 @@ const example = {
|
|
|
88
87
|
"busLines": string,
|
|
89
88
|
"trainLines": string,
|
|
90
89
|
"comments": string,
|
|
91
|
-
"adminNotes": string,
|
|
92
90
|
"customFields": {key1=value1, key2=value2},
|
|
93
91
|
} satisfies MeetingCreate
|
|
94
92
|
|
|
@@ -42,7 +42,6 @@ Name | Type
|
|
|
42
42
|
`busLines` | string
|
|
43
43
|
`trainLines` | string
|
|
44
44
|
`comments` | string
|
|
45
|
-
`adminNotes` | string
|
|
46
45
|
`customFields` | { [key: string]: string; }
|
|
47
46
|
|
|
48
47
|
## Example
|
|
@@ -88,7 +87,6 @@ const example = {
|
|
|
88
87
|
"busLines": string,
|
|
89
88
|
"trainLines": string,
|
|
90
89
|
"comments": string,
|
|
91
|
-
"adminNotes": string,
|
|
92
90
|
"customFields": {key1=value1, key2=value2},
|
|
93
91
|
} satisfies MeetingPartialUpdate
|
|
94
92
|
|
package/docs/MeetingUpdate.md
CHANGED
|
@@ -42,7 +42,6 @@ Name | Type
|
|
|
42
42
|
`busLines` | string
|
|
43
43
|
`trainLines` | string
|
|
44
44
|
`comments` | string
|
|
45
|
-
`adminNotes` | string
|
|
46
45
|
`customFields` | { [key: string]: string; }
|
|
47
46
|
|
|
48
47
|
## Example
|
|
@@ -88,7 +87,6 @@ const example = {
|
|
|
88
87
|
"busLines": string,
|
|
89
88
|
"trainLines": string,
|
|
90
89
|
"comments": string,
|
|
91
|
-
"adminNotes": string,
|
|
92
90
|
"customFields": {key1=value1, key2=value2},
|
|
93
91
|
} satisfies MeetingUpdate
|
|
94
92
|
|
package/docs/RootServerApi.md
CHANGED
|
@@ -765,11 +765,11 @@ example().catch(console.error);
|
|
|
765
765
|
|
|
766
766
|
## deleteServiceBody
|
|
767
767
|
|
|
768
|
-
> deleteServiceBody(serviceBodyId)
|
|
768
|
+
> deleteServiceBody(serviceBodyId, force)
|
|
769
769
|
|
|
770
770
|
Deletes a service body
|
|
771
771
|
|
|
772
|
-
Deletes a service body by id.
|
|
772
|
+
Deletes a service body by id. If the service body has meetings, use force=true to delete them as well.
|
|
773
773
|
|
|
774
774
|
### Example
|
|
775
775
|
|
|
@@ -791,6 +791,8 @@ async function example() {
|
|
|
791
791
|
const body = {
|
|
792
792
|
// number | ID of service body
|
|
793
793
|
serviceBodyId: 1,
|
|
794
|
+
// 'true' | 'false' | Force deletion of service body and all associated meetings (optional)
|
|
795
|
+
force: false,
|
|
794
796
|
} satisfies DeleteServiceBodyRequest;
|
|
795
797
|
|
|
796
798
|
try {
|
|
@@ -811,6 +813,7 @@ example().catch(console.error);
|
|
|
811
813
|
| Name | Type | Description | Notes |
|
|
812
814
|
|------------- | ------------- | ------------- | -------------|
|
|
813
815
|
| **serviceBodyId** | `number` | ID of service body | [Defaults to `undefined`] |
|
|
816
|
+
| **force** | `true`, `false` | Force deletion of service body and all associated meetings | [Optional] [Defaults to `'false'`] [Enum: true, false] |
|
|
814
817
|
|
|
815
818
|
### Return type
|
|
816
819
|
|
|
@@ -833,7 +836,7 @@ example().catch(console.error);
|
|
|
833
836
|
| **401** | Returns when user is not authenticated. | - |
|
|
834
837
|
| **403** | Returns when user is unauthorized to perform action. | - |
|
|
835
838
|
| **404** | Returns when no service body exists. | - |
|
|
836
|
-
| **409** | Returns when service body has children. | - |
|
|
839
|
+
| **409** | Returns when service body has children or meetings (when force=false). | - |
|
|
837
840
|
|
|
838
841
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
839
842
|
|
package/openapi.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"openapi":"3.0.0","info":{"title":"BMLT","description":"BMLT Admin API Documentation","license":{"name":"MIT","url":"https://github.com/bmlt-enabled/bmlt-root-server/blob/main/LICENSE"},"version":"1.0.0"},"paths":{"/api/v1/errortest":{"post":{"tags":["rootServer"],"summary":"Tests some errors","description":"Tests some errors.","operationId":"createErrorTest","requestBody":{"description":"Pass in error test object.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTest"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTest"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"Server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/formats":{"get":{"tags":["rootServer"],"summary":"Retrieves formats","description":"Retrieve formats","operationId":"getFormats","responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatCollection"}}}},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}}},"security":[{"bmltToken":[]}]},"post":{"tags":["rootServer"],"summary":"Creates a format","description":"Creates a format.","operationId":"createFormat","requestBody":{"description":"Pass in format object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatCreate"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Format"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/formats/{formatId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a format","description":"Retrieve a format","operationId":"getFormat","parameters":[{"name":"formatId","in":"path","description":"ID of format","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Format"}}}},"401":{"description":"Returns when not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"put":{"tags":["rootServer"],"summary":"Updates a format","description":"Updates a format.","operationId":"updateFormat","parameters":[{"name":"formatId","in":"path","description":"ID of format","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in format object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"delete":{"tags":["rootServer"],"summary":"Deletes a format","description":"Deletes a format by id.","operationId":"deleteFormat","parameters":[{"name":"formatId","in":"path","description":"ID of format","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"204":{"description":"Success."},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"409":{"description":"Returns when format has meetings assigned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"patch":{"tags":["rootServer"],"summary":"Patches a format","description":"Patches a single format by id.","operationId":"patchFormat","parameters":[{"name":"formatId","in":"path","description":"ID of format","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in fields you want to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatPartialUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no format exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/logs/laravel":{"get":{"tags":["rootServer"],"summary":"Retrieves laravel log","description":"Retrieve the laravel log if it exists.","operationId":"getLaravelLog","responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/gzip":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no laravel log file exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/meetings/{meetingId}/changes":{"get":{"tags":["rootServer"],"summary":"Retrieve changes for a meeting","description":"Retrieve all changes made to a specific meeting.","operationId":"getMeetingChanges","parameters":[{"name":"meetingId","in":"path","description":"ID of the meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"List of changes for the meeting.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MeetingChangeResource"}}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Meeting not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/meetings":{"get":{"tags":["rootServer"],"summary":"Retrieves meetings","description":"Retrieve meetings for authenticated user.","operationId":"getMeetings","parameters":[{"name":"meetingIds","in":"query","description":"comma delimited meeting ids","required":false,"schema":{"type":"string"},"example":"1,2"},{"name":"days","in":"query","description":"comma delimited day ids between 0-6","required":false,"schema":{"type":"string"},"example":"0,1"},{"name":"serviceBodyIds","in":"query","description":"comma delimited service body ids","required":false,"schema":{"type":"string"},"example":"3,4"},{"name":"searchString","in":"query","description":"string","required":false,"schema":{"type":"string"},"example":"Just for Today"}],"responses":{"200":{"description":"List of meetings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingCollection"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"post":{"tags":["rootServer"],"summary":"Creates a meeting","description":"Creates a meeting.","operationId":"createMeeting","requestBody":{"description":"Pass in meeting object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingCreate"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no meeting body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/meetings/{meetingId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a meeting","description":"Retrieve a meeting.","operationId":"getMeeting","parameters":[{"name":"meetingId","in":"path","description":"ID of meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no meeting exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"put":{"tags":["rootServer"],"summary":"Updates a meeting","description":"Updates a meeting.","operationId":"updateMeeting","parameters":[{"name":"meetingId","in":"path","description":"ID of meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in meeting object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no meeting exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"delete":{"tags":["rootServer"],"summary":"Deletes a meeting","description":"Deletes a meeting by id.","operationId":"deleteMeeting","parameters":[{"name":"meetingId","in":"path","description":"ID of meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no meeting exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"patch":{"tags":["rootServer"],"summary":"Patches a meeting","description":"Patches a meeting by id","operationId":"patchMeeting","parameters":[{"name":"meetingId","in":"path","description":"ID of meeting","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"},{"name":"skipVenueTypeLocationValidation","in":"query","description":"specify true to skip venue type location validation","required":false,"schema":{"type":"boolean"},"example":"true"}],"requestBody":{"description":"Pass in fields you want to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingPartialUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no meeting exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/rootservers":{"get":{"tags":["rootServer"],"summary":"Retrieves root servers","description":"Retrieve root servers.","operationId":"getRootServers","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RootServerCollection"}}}},"404":{"description":"Returns when aggregator mode is disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}}}},"/api/v1/rootservers/{rootServerId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a root server","description":"Retrieve a single root server id.","operationId":"getRootServer","parameters":[{"name":"rootServerId","in":"path","description":"ID of root server","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RootServer"}}}},"404":{"description":"Returns when no root server exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}}}},"/api/v1/servicebodies":{"get":{"tags":["rootServer"],"summary":"Retrieves service bodies","description":"Retrieve service bodies for authenticated user.","operationId":"getServiceBodies","responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBodyCollection"}}}},"401":{"description":"Returns when not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}}},"security":[{"bmltToken":[]}]},"post":{"tags":["rootServer"],"summary":"Creates a service body","description":"Creates a service body.","operationId":"createServiceBody","requestBody":{"description":"Pass in service body object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBodyCreate"}}}},"responses":{"201":{"description":"Returns when POST is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBody"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/servicebodies/{serviceBodyId}":{"get":{"tags":["rootServer"],"summary":"Retrieves a service body","description":"Retrieve a single service body by id.","operationId":"getServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"200":{"description":"Returns when user is authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBody"}}}},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"security":[{"bmltToken":[]}]},"put":{"tags":["rootServer"],"summary":"Updates a Service Body","description":"Updates a single service body.","operationId":"updateServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in service body object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBodyUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]},"delete":{"tags":["rootServer"],"summary":"Deletes a service body","description":"Deletes a service body by id.","operationId":"deleteServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"409":{"description":"Returns when service body has children.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"security":[{"bmltToken":[]}]},"patch":{"tags":["rootServer"],"summary":"Patches a service body","description":"Patches a single service body by id.","operationId":"patchServiceBody","parameters":[{"name":"serviceBodyId","in":"path","description":"ID of service body","required":true,"schema":{"type":"integer","format":"int64"},"example":"1"}],"requestBody":{"description":"Pass in fields you want to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceBodyPartialUpdate"}}}},"responses":{"204":{"description":"Success."},"401":{"description":"Returns when user is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is unauthorized to perform action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"Returns when no service body exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"422":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}},"security":[{"bmltToken":[]}]}},"/api/v1/settings":{"get":{"tags":["rootServer"],"summary":"Retrieves all settings","description":"Retrieve all server settings. Only accessible to server administrators.","operationId":"getSettings","responses":{"200":{"description":"Returns when user is authenticated as admin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsObject"}}}},"401":{"description":"Returns when not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationError"}}}},"403":{"description":"Returns when user is not an admin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}}},"security":[{"bmltToken":[]}]},"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"}]}
|
|
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"}]}
|
package/package.json
CHANGED
|
@@ -140,6 +140,7 @@ export interface DeleteMeetingRequest {
|
|
|
140
140
|
|
|
141
141
|
export interface DeleteServiceBodyRequest {
|
|
142
142
|
serviceBodyId: number;
|
|
143
|
+
force?: DeleteServiceBodyForceEnum;
|
|
143
144
|
}
|
|
144
145
|
|
|
145
146
|
export interface DeleteUserRequest {
|
|
@@ -656,7 +657,7 @@ export class RootServerApi extends runtime.BaseAPI {
|
|
|
656
657
|
}
|
|
657
658
|
|
|
658
659
|
/**
|
|
659
|
-
* Deletes a service body by id.
|
|
660
|
+
* Deletes a service body by id. If the service body has meetings, use force=true to delete them as well.
|
|
660
661
|
* Deletes a service body
|
|
661
662
|
*/
|
|
662
663
|
async deleteServiceBodyRaw(requestParameters: DeleteServiceBodyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
@@ -669,6 +670,10 @@ export class RootServerApi extends runtime.BaseAPI {
|
|
|
669
670
|
|
|
670
671
|
const queryParameters: any = {};
|
|
671
672
|
|
|
673
|
+
if (requestParameters['force'] != null) {
|
|
674
|
+
queryParameters['force'] = requestParameters['force'];
|
|
675
|
+
}
|
|
676
|
+
|
|
672
677
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
673
678
|
|
|
674
679
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -691,7 +696,7 @@ export class RootServerApi extends runtime.BaseAPI {
|
|
|
691
696
|
}
|
|
692
697
|
|
|
693
698
|
/**
|
|
694
|
-
* Deletes a service body by id.
|
|
699
|
+
* Deletes a service body by id. If the service body has meetings, use force=true to delete them as well.
|
|
695
700
|
* Deletes a service body
|
|
696
701
|
*/
|
|
697
702
|
async deleteServiceBody(requestParameters: DeleteServiceBodyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
@@ -1737,3 +1742,12 @@ export class RootServerApi extends runtime.BaseAPI {
|
|
|
1737
1742
|
}
|
|
1738
1743
|
|
|
1739
1744
|
}
|
|
1745
|
+
|
|
1746
|
+
/**
|
|
1747
|
+
* @export
|
|
1748
|
+
*/
|
|
1749
|
+
export const DeleteServiceBodyForceEnum = {
|
|
1750
|
+
True: 'true',
|
|
1751
|
+
False: 'false'
|
|
1752
|
+
} as const;
|
|
1753
|
+
export type DeleteServiceBodyForceEnum = typeof DeleteServiceBodyForceEnum[keyof typeof DeleteServiceBodyForceEnum];
|
package/src/models/Meeting.ts
CHANGED
|
@@ -235,12 +235,6 @@ 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;
|
|
244
238
|
/**
|
|
245
239
|
*
|
|
246
240
|
* @type {{ [key: string]: string; }}
|
|
@@ -323,7 +317,6 @@ export function MeetingFromJSONTyped(json: any, ignoreDiscriminator: boolean): M
|
|
|
323
317
|
'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
|
|
324
318
|
'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
|
|
325
319
|
'comments': json['comments'] == null ? undefined : json['comments'],
|
|
326
|
-
'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
|
|
327
320
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
328
321
|
'id': json['id'],
|
|
329
322
|
};
|
|
@@ -376,7 +369,6 @@ export function MeetingToJSONTyped(value?: Meeting | null, ignoreDiscriminator:
|
|
|
376
369
|
'bus_lines': value['busLines'],
|
|
377
370
|
'train_lines': value['trainLines'],
|
|
378
371
|
'comments': value['comments'],
|
|
379
|
-
'admin_notes': value['adminNotes'],
|
|
380
372
|
'customFields': value['customFields'],
|
|
381
373
|
'id': value['id'],
|
|
382
374
|
};
|
|
@@ -235,12 +235,6 @@ 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;
|
|
244
238
|
/**
|
|
245
239
|
*
|
|
246
240
|
* @type {{ [key: string]: string; }}
|
|
@@ -302,7 +296,6 @@ export function MeetingBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean
|
|
|
302
296
|
'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
|
|
303
297
|
'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
|
|
304
298
|
'comments': json['comments'] == null ? undefined : json['comments'],
|
|
305
|
-
'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
|
|
306
299
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
307
300
|
};
|
|
308
301
|
}
|
|
@@ -354,7 +347,6 @@ export function MeetingBaseToJSONTyped(value?: MeetingBase | null, ignoreDiscrim
|
|
|
354
347
|
'bus_lines': value['busLines'],
|
|
355
348
|
'train_lines': value['trainLines'],
|
|
356
349
|
'comments': value['comments'],
|
|
357
|
-
'admin_notes': value['adminNotes'],
|
|
358
350
|
'customFields': value['customFields'],
|
|
359
351
|
};
|
|
360
352
|
}
|
|
@@ -235,12 +235,6 @@ 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;
|
|
244
238
|
/**
|
|
245
239
|
*
|
|
246
240
|
* @type {{ [key: string]: string; }}
|
|
@@ -312,7 +306,6 @@ export function MeetingCreateFromJSONTyped(json: any, ignoreDiscriminator: boole
|
|
|
312
306
|
'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
|
|
313
307
|
'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
|
|
314
308
|
'comments': json['comments'] == null ? undefined : json['comments'],
|
|
315
|
-
'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
|
|
316
309
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
317
310
|
};
|
|
318
311
|
}
|
|
@@ -364,7 +357,6 @@ export function MeetingCreateToJSONTyped(value?: MeetingCreate | null, ignoreDis
|
|
|
364
357
|
'bus_lines': value['busLines'],
|
|
365
358
|
'train_lines': value['trainLines'],
|
|
366
359
|
'comments': value['comments'],
|
|
367
|
-
'admin_notes': value['adminNotes'],
|
|
368
360
|
'customFields': value['customFields'],
|
|
369
361
|
};
|
|
370
362
|
}
|
|
@@ -235,12 +235,6 @@ 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;
|
|
244
238
|
/**
|
|
245
239
|
*
|
|
246
240
|
* @type {{ [key: string]: string; }}
|
|
@@ -302,7 +296,6 @@ export function MeetingPartialUpdateFromJSONTyped(json: any, ignoreDiscriminator
|
|
|
302
296
|
'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
|
|
303
297
|
'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
|
|
304
298
|
'comments': json['comments'] == null ? undefined : json['comments'],
|
|
305
|
-
'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
|
|
306
299
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
307
300
|
};
|
|
308
301
|
}
|
|
@@ -354,7 +347,6 @@ export function MeetingPartialUpdateToJSONTyped(value?: MeetingPartialUpdate | n
|
|
|
354
347
|
'bus_lines': value['busLines'],
|
|
355
348
|
'train_lines': value['trainLines'],
|
|
356
349
|
'comments': value['comments'],
|
|
357
|
-
'admin_notes': value['adminNotes'],
|
|
358
350
|
'customFields': value['customFields'],
|
|
359
351
|
};
|
|
360
352
|
}
|
|
@@ -235,12 +235,6 @@ 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;
|
|
244
238
|
/**
|
|
245
239
|
*
|
|
246
240
|
* @type {{ [key: string]: string; }}
|
|
@@ -312,7 +306,6 @@ export function MeetingUpdateFromJSONTyped(json: any, ignoreDiscriminator: boole
|
|
|
312
306
|
'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
|
|
313
307
|
'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
|
|
314
308
|
'comments': json['comments'] == null ? undefined : json['comments'],
|
|
315
|
-
'adminNotes': json['admin_notes'] == null ? undefined : json['admin_notes'],
|
|
316
309
|
'customFields': json['customFields'] == null ? undefined : json['customFields'],
|
|
317
310
|
};
|
|
318
311
|
}
|
|
@@ -364,7 +357,6 @@ export function MeetingUpdateToJSONTyped(value?: MeetingUpdate | null, ignoreDis
|
|
|
364
357
|
'bus_lines': value['busLines'],
|
|
365
358
|
'train_lines': value['trainLines'],
|
|
366
359
|
'comments': value['comments'],
|
|
367
|
-
'admin_notes': value['adminNotes'],
|
|
368
360
|
'customFields': value['customFields'],
|
|
369
361
|
};
|
|
370
362
|
}
|