bmlt-server-client 2.0.4 → 2.0.5
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/.openapi-generator/FILES +2 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +3 -1
- package/dist/apis/RootServerApi.d.ts +177 -1
- package/dist/apis/RootServerApi.js +597 -223
- package/dist/esm/apis/RootServerApi.d.ts +177 -1
- package/dist/esm/apis/RootServerApi.js +563 -189
- package/dist/esm/models/ServiceBodyEditor.d.ts +44 -0
- package/dist/esm/models/ServiceBodyEditor.js +51 -0
- package/dist/esm/models/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/esm/runtime.js +16 -1
- package/dist/models/ServiceBodyEditor.d.ts +44 -0
- package/dist/models/ServiceBodyEditor.js +58 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/runtime.js +16 -1
- package/docs/RootServerApi.md +75 -0
- package/docs/ServiceBodyEditor.md +38 -0
- package/openapi.json +1 -1
- package/package.json +1 -1
- package/src/apis/RootServerApi.ts +607 -221
- package/src/models/ServiceBodyEditor.ts +84 -0
- package/src/models/index.ts +1 -0
- package/src/runtime.ts +19 -2
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* BMLT
|
|
3
|
+
* BMLT Admin API Documentation
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ServiceBodyEditor
|
|
16
|
+
*/
|
|
17
|
+
export interface ServiceBodyEditor {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof ServiceBodyEditor
|
|
22
|
+
*/
|
|
23
|
+
userId: number;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ServiceBodyEditor
|
|
28
|
+
*/
|
|
29
|
+
displayName: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {boolean}
|
|
33
|
+
* @memberof ServiceBodyEditor
|
|
34
|
+
*/
|
|
35
|
+
readOnly: boolean;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Check if a given object implements the ServiceBodyEditor interface.
|
|
39
|
+
*/
|
|
40
|
+
export declare function instanceOfServiceBodyEditor(value: object): value is ServiceBodyEditor;
|
|
41
|
+
export declare function ServiceBodyEditorFromJSON(json: any): ServiceBodyEditor;
|
|
42
|
+
export declare function ServiceBodyEditorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ServiceBodyEditor;
|
|
43
|
+
export declare function ServiceBodyEditorToJSON(json: any): ServiceBodyEditor;
|
|
44
|
+
export declare function ServiceBodyEditorToJSONTyped(value?: ServiceBodyEditor | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* BMLT
|
|
5
|
+
* BMLT Admin API Documentation
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the ServiceBodyEditor interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfServiceBodyEditor(value) {
|
|
18
|
+
if (!('userId' in value) || value['userId'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('displayName' in value) || value['displayName'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('readOnly' in value) || value['readOnly'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
return true;
|
|
25
|
+
}
|
|
26
|
+
export function ServiceBodyEditorFromJSON(json) {
|
|
27
|
+
return ServiceBodyEditorFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
export function ServiceBodyEditorFromJSONTyped(json, ignoreDiscriminator) {
|
|
30
|
+
if (json == null) {
|
|
31
|
+
return json;
|
|
32
|
+
}
|
|
33
|
+
return {
|
|
34
|
+
'userId': json['userId'],
|
|
35
|
+
'displayName': json['displayName'],
|
|
36
|
+
'readOnly': json['readOnly'],
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
export function ServiceBodyEditorToJSON(json) {
|
|
40
|
+
return ServiceBodyEditorToJSONTyped(json, false);
|
|
41
|
+
}
|
|
42
|
+
export function ServiceBodyEditorToJSONTyped(value, ignoreDiscriminator = false) {
|
|
43
|
+
if (value == null) {
|
|
44
|
+
return value;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
'userId': value['userId'],
|
|
48
|
+
'displayName': value['displayName'],
|
|
49
|
+
'readOnly': value['readOnly'],
|
|
50
|
+
};
|
|
51
|
+
}
|
|
@@ -24,6 +24,7 @@ export * from './ServerError';
|
|
|
24
24
|
export * from './ServiceBody';
|
|
25
25
|
export * from './ServiceBodyBase';
|
|
26
26
|
export * from './ServiceBodyCreate';
|
|
27
|
+
export * from './ServiceBodyEditor';
|
|
27
28
|
export * from './ServiceBodyPartialUpdate';
|
|
28
29
|
export * from './ServiceBodyUpdate';
|
|
29
30
|
export * from './SettingsBase';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -26,6 +26,7 @@ export * from './ServerError';
|
|
|
26
26
|
export * from './ServiceBody';
|
|
27
27
|
export * from './ServiceBodyBase';
|
|
28
28
|
export * from './ServiceBodyCreate';
|
|
29
|
+
export * from './ServiceBodyEditor';
|
|
29
30
|
export * from './ServiceBodyPartialUpdate';
|
|
30
31
|
export * from './ServiceBodyUpdate';
|
|
31
32
|
export * from './SettingsBase';
|
package/dist/esm/runtime.js
CHANGED
|
@@ -210,7 +210,7 @@ export class BaseAPI {
|
|
|
210
210
|
return next;
|
|
211
211
|
}
|
|
212
212
|
}
|
|
213
|
-
BaseAPI.jsonRegex =
|
|
213
|
+
BaseAPI.jsonRegex = /^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$/i;
|
|
214
214
|
;
|
|
215
215
|
function isBlob(value) {
|
|
216
216
|
return typeof Blob !== 'undefined' && value instanceof Blob;
|
|
@@ -223,6 +223,11 @@ export class ResponseError extends Error {
|
|
|
223
223
|
super(msg);
|
|
224
224
|
this.response = response;
|
|
225
225
|
this.name = "ResponseError";
|
|
226
|
+
// restore prototype chain
|
|
227
|
+
const actualProto = new.target.prototype;
|
|
228
|
+
if (Object.setPrototypeOf) {
|
|
229
|
+
Object.setPrototypeOf(this, actualProto);
|
|
230
|
+
}
|
|
226
231
|
}
|
|
227
232
|
}
|
|
228
233
|
export class FetchError extends Error {
|
|
@@ -230,6 +235,11 @@ export class FetchError extends Error {
|
|
|
230
235
|
super(msg);
|
|
231
236
|
this.cause = cause;
|
|
232
237
|
this.name = "FetchError";
|
|
238
|
+
// restore prototype chain
|
|
239
|
+
const actualProto = new.target.prototype;
|
|
240
|
+
if (Object.setPrototypeOf) {
|
|
241
|
+
Object.setPrototypeOf(this, actualProto);
|
|
242
|
+
}
|
|
233
243
|
}
|
|
234
244
|
}
|
|
235
245
|
export class RequiredError extends Error {
|
|
@@ -237,6 +247,11 @@ export class RequiredError extends Error {
|
|
|
237
247
|
super(msg);
|
|
238
248
|
this.field = field;
|
|
239
249
|
this.name = "RequiredError";
|
|
250
|
+
// restore prototype chain
|
|
251
|
+
const actualProto = new.target.prototype;
|
|
252
|
+
if (Object.setPrototypeOf) {
|
|
253
|
+
Object.setPrototypeOf(this, actualProto);
|
|
254
|
+
}
|
|
240
255
|
}
|
|
241
256
|
}
|
|
242
257
|
export const COLLECTION_FORMATS = {
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* BMLT
|
|
3
|
+
* BMLT Admin API Documentation
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ServiceBodyEditor
|
|
16
|
+
*/
|
|
17
|
+
export interface ServiceBodyEditor {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof ServiceBodyEditor
|
|
22
|
+
*/
|
|
23
|
+
userId: number;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ServiceBodyEditor
|
|
28
|
+
*/
|
|
29
|
+
displayName: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {boolean}
|
|
33
|
+
* @memberof ServiceBodyEditor
|
|
34
|
+
*/
|
|
35
|
+
readOnly: boolean;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Check if a given object implements the ServiceBodyEditor interface.
|
|
39
|
+
*/
|
|
40
|
+
export declare function instanceOfServiceBodyEditor(value: object): value is ServiceBodyEditor;
|
|
41
|
+
export declare function ServiceBodyEditorFromJSON(json: any): ServiceBodyEditor;
|
|
42
|
+
export declare function ServiceBodyEditorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ServiceBodyEditor;
|
|
43
|
+
export declare function ServiceBodyEditorToJSON(json: any): ServiceBodyEditor;
|
|
44
|
+
export declare function ServiceBodyEditorToJSONTyped(value?: ServiceBodyEditor | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* BMLT
|
|
6
|
+
* BMLT Admin API Documentation
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfServiceBodyEditor = instanceOfServiceBodyEditor;
|
|
17
|
+
exports.ServiceBodyEditorFromJSON = ServiceBodyEditorFromJSON;
|
|
18
|
+
exports.ServiceBodyEditorFromJSONTyped = ServiceBodyEditorFromJSONTyped;
|
|
19
|
+
exports.ServiceBodyEditorToJSON = ServiceBodyEditorToJSON;
|
|
20
|
+
exports.ServiceBodyEditorToJSONTyped = ServiceBodyEditorToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the ServiceBodyEditor interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfServiceBodyEditor(value) {
|
|
25
|
+
if (!('userId' in value) || value['userId'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('displayName' in value) || value['displayName'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('readOnly' in value) || value['readOnly'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
function ServiceBodyEditorFromJSON(json) {
|
|
34
|
+
return ServiceBodyEditorFromJSONTyped(json, false);
|
|
35
|
+
}
|
|
36
|
+
function ServiceBodyEditorFromJSONTyped(json, ignoreDiscriminator) {
|
|
37
|
+
if (json == null) {
|
|
38
|
+
return json;
|
|
39
|
+
}
|
|
40
|
+
return {
|
|
41
|
+
'userId': json['userId'],
|
|
42
|
+
'displayName': json['displayName'],
|
|
43
|
+
'readOnly': json['readOnly'],
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
function ServiceBodyEditorToJSON(json) {
|
|
47
|
+
return ServiceBodyEditorToJSONTyped(json, false);
|
|
48
|
+
}
|
|
49
|
+
function ServiceBodyEditorToJSONTyped(value, ignoreDiscriminator = false) {
|
|
50
|
+
if (value == null) {
|
|
51
|
+
return value;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
'userId': value['userId'],
|
|
55
|
+
'displayName': value['displayName'],
|
|
56
|
+
'readOnly': value['readOnly'],
|
|
57
|
+
};
|
|
58
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -24,6 +24,7 @@ export * from './ServerError';
|
|
|
24
24
|
export * from './ServiceBody';
|
|
25
25
|
export * from './ServiceBodyBase';
|
|
26
26
|
export * from './ServiceBodyCreate';
|
|
27
|
+
export * from './ServiceBodyEditor';
|
|
27
28
|
export * from './ServiceBodyPartialUpdate';
|
|
28
29
|
export * from './ServiceBodyUpdate';
|
|
29
30
|
export * from './SettingsBase';
|
package/dist/models/index.js
CHANGED
|
@@ -42,6 +42,7 @@ __exportStar(require("./ServerError"), exports);
|
|
|
42
42
|
__exportStar(require("./ServiceBody"), exports);
|
|
43
43
|
__exportStar(require("./ServiceBodyBase"), exports);
|
|
44
44
|
__exportStar(require("./ServiceBodyCreate"), exports);
|
|
45
|
+
__exportStar(require("./ServiceBodyEditor"), exports);
|
|
45
46
|
__exportStar(require("./ServiceBodyPartialUpdate"), exports);
|
|
46
47
|
__exportStar(require("./ServiceBodyUpdate"), exports);
|
|
47
48
|
__exportStar(require("./SettingsBase"), exports);
|
package/dist/runtime.js
CHANGED
|
@@ -219,7 +219,7 @@ class BaseAPI {
|
|
|
219
219
|
}
|
|
220
220
|
}
|
|
221
221
|
exports.BaseAPI = BaseAPI;
|
|
222
|
-
BaseAPI.jsonRegex =
|
|
222
|
+
BaseAPI.jsonRegex = /^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$/i;
|
|
223
223
|
;
|
|
224
224
|
function isBlob(value) {
|
|
225
225
|
return typeof Blob !== 'undefined' && value instanceof Blob;
|
|
@@ -232,6 +232,11 @@ class ResponseError extends Error {
|
|
|
232
232
|
super(msg);
|
|
233
233
|
this.response = response;
|
|
234
234
|
this.name = "ResponseError";
|
|
235
|
+
// restore prototype chain
|
|
236
|
+
const actualProto = new.target.prototype;
|
|
237
|
+
if (Object.setPrototypeOf) {
|
|
238
|
+
Object.setPrototypeOf(this, actualProto);
|
|
239
|
+
}
|
|
235
240
|
}
|
|
236
241
|
}
|
|
237
242
|
exports.ResponseError = ResponseError;
|
|
@@ -240,6 +245,11 @@ class FetchError extends Error {
|
|
|
240
245
|
super(msg);
|
|
241
246
|
this.cause = cause;
|
|
242
247
|
this.name = "FetchError";
|
|
248
|
+
// restore prototype chain
|
|
249
|
+
const actualProto = new.target.prototype;
|
|
250
|
+
if (Object.setPrototypeOf) {
|
|
251
|
+
Object.setPrototypeOf(this, actualProto);
|
|
252
|
+
}
|
|
243
253
|
}
|
|
244
254
|
}
|
|
245
255
|
exports.FetchError = FetchError;
|
|
@@ -248,6 +258,11 @@ class RequiredError extends Error {
|
|
|
248
258
|
super(msg);
|
|
249
259
|
this.field = field;
|
|
250
260
|
this.name = "RequiredError";
|
|
261
|
+
// restore prototype chain
|
|
262
|
+
const actualProto = new.target.prototype;
|
|
263
|
+
if (Object.setPrototypeOf) {
|
|
264
|
+
Object.setPrototypeOf(this, actualProto);
|
|
265
|
+
}
|
|
251
266
|
}
|
|
252
267
|
}
|
|
253
268
|
exports.RequiredError = RequiredError;
|
package/docs/RootServerApi.md
CHANGED
|
@@ -26,6 +26,7 @@ All URIs are relative to *http://localhost:8000/main_server*
|
|
|
26
26
|
| [**getRootServers**](RootServerApi.md#getrootservers) | **GET** /api/v1/rootservers | Retrieves root servers |
|
|
27
27
|
| [**getServiceBodies**](RootServerApi.md#getservicebodies) | **GET** /api/v1/servicebodies | Retrieves service bodies |
|
|
28
28
|
| [**getServiceBody**](RootServerApi.md#getservicebody) | **GET** /api/v1/servicebodies/{serviceBodyId} | Retrieves a service body |
|
|
29
|
+
| [**getServiceBodyEditors**](RootServerApi.md#getservicebodyeditors) | **GET** /api/v1/servicebodies/{serviceBodyId}/editors | Retrieves the editors assigned to a service body |
|
|
29
30
|
| [**getSettings**](RootServerApi.md#getsettings) | **GET** /api/v1/settings | Retrieves all settings |
|
|
30
31
|
| [**getUser**](RootServerApi.md#getuser) | **GET** /api/v1/users/{userId} | Retrieves a single user |
|
|
31
32
|
| [**getUsers**](RootServerApi.md#getusers) | **GET** /api/v1/users | Retrieves users |
|
|
@@ -1613,6 +1614,80 @@ example().catch(console.error);
|
|
|
1613
1614
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1614
1615
|
|
|
1615
1616
|
|
|
1617
|
+
## getServiceBodyEditors
|
|
1618
|
+
|
|
1619
|
+
> Array<ServiceBodyEditor> getServiceBodyEditors(serviceBodyId)
|
|
1620
|
+
|
|
1621
|
+
Retrieves the editors assigned to a service body
|
|
1622
|
+
|
|
1623
|
+
Retrieve the meeting list editors assigned to a service body. Each editor includes a readOnly flag that is true when the calling user does not otherwise have access to manage that user via the users API.
|
|
1624
|
+
|
|
1625
|
+
### Example
|
|
1626
|
+
|
|
1627
|
+
```ts
|
|
1628
|
+
import {
|
|
1629
|
+
Configuration,
|
|
1630
|
+
RootServerApi,
|
|
1631
|
+
} from 'bmlt-server-client';
|
|
1632
|
+
import type { GetServiceBodyEditorsRequest } from 'bmlt-server-client';
|
|
1633
|
+
|
|
1634
|
+
async function example() {
|
|
1635
|
+
console.log("🚀 Testing bmlt-server-client SDK...");
|
|
1636
|
+
const config = new Configuration({
|
|
1637
|
+
// To configure OAuth2 access token for authorization: bmltToken password
|
|
1638
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1639
|
+
});
|
|
1640
|
+
const api = new RootServerApi(config);
|
|
1641
|
+
|
|
1642
|
+
const body = {
|
|
1643
|
+
// number | ID of service body
|
|
1644
|
+
serviceBodyId: 1,
|
|
1645
|
+
} satisfies GetServiceBodyEditorsRequest;
|
|
1646
|
+
|
|
1647
|
+
try {
|
|
1648
|
+
const data = await api.getServiceBodyEditors(body);
|
|
1649
|
+
console.log(data);
|
|
1650
|
+
} catch (error) {
|
|
1651
|
+
console.error(error);
|
|
1652
|
+
}
|
|
1653
|
+
}
|
|
1654
|
+
|
|
1655
|
+
// Run the test
|
|
1656
|
+
example().catch(console.error);
|
|
1657
|
+
```
|
|
1658
|
+
|
|
1659
|
+
### Parameters
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
| Name | Type | Description | Notes |
|
|
1663
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1664
|
+
| **serviceBodyId** | `number` | ID of service body | [Defaults to `undefined`] |
|
|
1665
|
+
|
|
1666
|
+
### Return type
|
|
1667
|
+
|
|
1668
|
+
[**Array<ServiceBodyEditor>**](ServiceBodyEditor.md)
|
|
1669
|
+
|
|
1670
|
+
### Authorization
|
|
1671
|
+
|
|
1672
|
+
[bmltToken password](../README.md#bmltToken-password)
|
|
1673
|
+
|
|
1674
|
+
### HTTP request headers
|
|
1675
|
+
|
|
1676
|
+
- **Content-Type**: Not defined
|
|
1677
|
+
- **Accept**: `application/json`
|
|
1678
|
+
|
|
1679
|
+
|
|
1680
|
+
### HTTP response details
|
|
1681
|
+
| Status code | Description | Response headers |
|
|
1682
|
+
|-------------|-------------|------------------|
|
|
1683
|
+
| **200** | Returns when user is authenticated. | - |
|
|
1684
|
+
| **401** | Returns when user is not authenticated. | - |
|
|
1685
|
+
| **403** | Returns when user is unauthorized to perform action. | - |
|
|
1686
|
+
| **404** | Returns when no service body exists. | - |
|
|
1687
|
+
|
|
1688
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1689
|
+
|
|
1690
|
+
|
|
1616
1691
|
## getSettings
|
|
1617
1692
|
|
|
1618
1693
|
> SettingsObject getSettings()
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# ServiceBodyEditor
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`userId` | number
|
|
10
|
+
`displayName` | string
|
|
11
|
+
`readOnly` | boolean
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { ServiceBodyEditor } from 'bmlt-server-client'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"userId": 0,
|
|
21
|
+
"displayName": string,
|
|
22
|
+
"readOnly": false,
|
|
23
|
+
} satisfies ServiceBodyEditor
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as ServiceBodyEditor
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|