oip-common 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/fesm2022/oip-common.mjs +0 -122
- package/fesm2022/oip-common.mjs.map +1 -1
- package/index.d.ts +0 -153
- package/package.json +1 -1
- package/scripts/generate-api.mjs +3 -2
- package/templates/data-contract-jsdoc.ejs +2 -0
- package/templates/object-field-jsdoc.ejs +2 -0
- package/templates/procedure-call.ejs +4 -1
- package/templates/route-type.ejs +4 -1
package/fesm2022/oip-common.mjs
CHANGED
|
@@ -2471,16 +2471,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.16", ngImpo
|
|
|
2471
2471
|
class MenuApi extends HttpClient {
|
|
2472
2472
|
constructor() {
|
|
2473
2473
|
super(...arguments);
|
|
2474
|
-
/**
|
|
2475
|
-
* @description Retrieves the menu available to the current authenticated user.
|
|
2476
|
-
*
|
|
2477
|
-
* @tags Menu
|
|
2478
|
-
* @name get
|
|
2479
|
-
* @summary Retrieves the menu available to the current authenticated user.
|
|
2480
|
-
* @request GET:/api/menu/get
|
|
2481
|
-
* @secure
|
|
2482
|
-
* @response `200` `(ModuleInstanceDto)[]` OK
|
|
2483
|
-
*/
|
|
2484
2474
|
this.get = (params = {}) => this.request({
|
|
2485
2475
|
path: `/api/menu/get`,
|
|
2486
2476
|
method: "GET",
|
|
@@ -2488,16 +2478,6 @@ class MenuApi extends HttpClient {
|
|
|
2488
2478
|
format: "json",
|
|
2489
2479
|
...params,
|
|
2490
2480
|
});
|
|
2491
|
-
/**
|
|
2492
|
-
* @description Retrieves the admin-specific menu.
|
|
2493
|
-
*
|
|
2494
|
-
* @tags Menu
|
|
2495
|
-
* @name getAdminMenu
|
|
2496
|
-
* @summary Retrieves the admin-specific menu.
|
|
2497
|
-
* @request GET:/api/menu/get-admin-menu
|
|
2498
|
-
* @secure
|
|
2499
|
-
* @response `200` `(ModuleInstanceDto)[]` OK
|
|
2500
|
-
*/
|
|
2501
2481
|
this.getAdminMenu = (params = {}) => this.request({
|
|
2502
2482
|
path: `/api/menu/get-admin-menu`,
|
|
2503
2483
|
method: "GET",
|
|
@@ -2505,16 +2485,6 @@ class MenuApi extends HttpClient {
|
|
|
2505
2485
|
format: "json",
|
|
2506
2486
|
...params,
|
|
2507
2487
|
});
|
|
2508
|
-
/**
|
|
2509
|
-
* @description Retrieves all available modules in the system.
|
|
2510
|
-
*
|
|
2511
|
-
* @tags Menu
|
|
2512
|
-
* @name getModules
|
|
2513
|
-
* @summary Retrieves all available modules in the system.
|
|
2514
|
-
* @request GET:/api/menu/get-modules
|
|
2515
|
-
* @secure
|
|
2516
|
-
* @response `200` `(IntKeyValueDto)[]` OK
|
|
2517
|
-
*/
|
|
2518
2488
|
this.getModules = (params = {}) => this.request({
|
|
2519
2489
|
path: `/api/menu/get-modules`,
|
|
2520
2490
|
method: "GET",
|
|
@@ -2522,17 +2492,6 @@ class MenuApi extends HttpClient {
|
|
|
2522
2492
|
format: "json",
|
|
2523
2493
|
...params,
|
|
2524
2494
|
});
|
|
2525
|
-
/**
|
|
2526
|
-
* @description Adds a new module instance to the system.
|
|
2527
|
-
*
|
|
2528
|
-
* @tags Menu
|
|
2529
|
-
* @name addModuleInstance
|
|
2530
|
-
* @summary Adds a new module instance to the system.
|
|
2531
|
-
* @request POST:/api/menu/add-module-instance
|
|
2532
|
-
* @secure
|
|
2533
|
-
* @response `200` `void` OK
|
|
2534
|
-
* @response `500` `ApiExceptionResponse` Internal Server Error
|
|
2535
|
-
*/
|
|
2536
2495
|
this.addModuleInstance = (data, params = {}) => this.request({
|
|
2537
2496
|
path: `/api/menu/add-module-instance`,
|
|
2538
2497
|
method: "POST",
|
|
@@ -2541,17 +2500,6 @@ class MenuApi extends HttpClient {
|
|
|
2541
2500
|
type: ContentType.Json,
|
|
2542
2501
|
...params,
|
|
2543
2502
|
});
|
|
2544
|
-
/**
|
|
2545
|
-
* @description Edits an existing module instance.
|
|
2546
|
-
*
|
|
2547
|
-
* @tags Menu
|
|
2548
|
-
* @name editModuleInstance
|
|
2549
|
-
* @summary Edits an existing module instance.
|
|
2550
|
-
* @request POST:/api/menu/edit-module-instance
|
|
2551
|
-
* @secure
|
|
2552
|
-
* @response `200` `void` OK
|
|
2553
|
-
* @response `500` `ApiExceptionResponse` Internal Server Error
|
|
2554
|
-
*/
|
|
2555
2503
|
this.editModuleInstance = (data, params = {}) => this.request({
|
|
2556
2504
|
path: `/api/menu/edit-module-instance`,
|
|
2557
2505
|
method: "POST",
|
|
@@ -2560,17 +2508,6 @@ class MenuApi extends HttpClient {
|
|
|
2560
2508
|
type: ContentType.Json,
|
|
2561
2509
|
...params,
|
|
2562
2510
|
});
|
|
2563
|
-
/**
|
|
2564
|
-
* @description Deletes a module instance by its identifier.
|
|
2565
|
-
*
|
|
2566
|
-
* @tags Menu
|
|
2567
|
-
* @name deleteModuleInstance
|
|
2568
|
-
* @summary Deletes a module instance by its identifier.
|
|
2569
|
-
* @request DELETE:/api/menu/delete-module-instance
|
|
2570
|
-
* @secure
|
|
2571
|
-
* @response `200` `void` OK
|
|
2572
|
-
* @response `500` `ApiExceptionResponse` Internal Server Error
|
|
2573
|
-
*/
|
|
2574
2511
|
this.deleteModuleInstance = (query, params = {}) => this.request({
|
|
2575
2512
|
path: `/api/menu/delete-module-instance`,
|
|
2576
2513
|
method: "DELETE",
|
|
@@ -2578,17 +2515,6 @@ class MenuApi extends HttpClient {
|
|
|
2578
2515
|
secure: true,
|
|
2579
2516
|
...params,
|
|
2580
2517
|
});
|
|
2581
|
-
/**
|
|
2582
|
-
* @description Swaps the order positions of two modules in the menu structure.
|
|
2583
|
-
*
|
|
2584
|
-
* @tags Menu
|
|
2585
|
-
* @name changeOrder
|
|
2586
|
-
* @summary Swaps the order positions of two modules in the menu structure.
|
|
2587
|
-
* @request POST:/api/menu/change-order
|
|
2588
|
-
* @secure
|
|
2589
|
-
* @response `200` `void` OK
|
|
2590
|
-
* @response `500` `ApiExceptionResponse` Internal Server Error
|
|
2591
|
-
*/
|
|
2592
2518
|
this.changeOrder = (query, params = {}) => this.request({
|
|
2593
2519
|
path: `/api/menu/change-order`,
|
|
2594
2520
|
method: "POST",
|
|
@@ -4463,18 +4389,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.16", ngImpo
|
|
|
4463
4389
|
class ModuleApi extends HttpClient {
|
|
4464
4390
|
constructor() {
|
|
4465
4391
|
super(...arguments);
|
|
4466
|
-
/**
|
|
4467
|
-
* @description Retrieves all modules stored in the system.
|
|
4468
|
-
*
|
|
4469
|
-
* @tags Module
|
|
4470
|
-
* @name getAll
|
|
4471
|
-
* @summary Retrieves all modules stored in the system.
|
|
4472
|
-
* @request GET:/api/module/get-all
|
|
4473
|
-
* @secure
|
|
4474
|
-
* @response `200` `(ModuleDto)[]` OK
|
|
4475
|
-
* @response `401` `ApiExceptionResponse` Unauthorized
|
|
4476
|
-
* @response `403` `ApiExceptionResponse` Forbidden
|
|
4477
|
-
*/
|
|
4478
4392
|
this.getAll = (params = {}) => this.request({
|
|
4479
4393
|
path: `/api/module/get-all`,
|
|
4480
4394
|
method: "GET",
|
|
@@ -4482,18 +4396,6 @@ class ModuleApi extends HttpClient {
|
|
|
4482
4396
|
format: "json",
|
|
4483
4397
|
...params,
|
|
4484
4398
|
});
|
|
4485
|
-
/**
|
|
4486
|
-
* @description Inserts a new module into the system.
|
|
4487
|
-
*
|
|
4488
|
-
* @tags Module
|
|
4489
|
-
* @name insert
|
|
4490
|
-
* @summary Inserts a new module into the system.
|
|
4491
|
-
* @request POST:/api/module/insert
|
|
4492
|
-
* @secure
|
|
4493
|
-
* @response `200` `void` OK
|
|
4494
|
-
* @response `401` `ApiExceptionResponse` Unauthorized
|
|
4495
|
-
* @response `403` `ApiExceptionResponse` Forbidden
|
|
4496
|
-
*/
|
|
4497
4399
|
this.insert = (data, params = {}) => this.request({
|
|
4498
4400
|
path: `/api/module/insert`,
|
|
4499
4401
|
method: "POST",
|
|
@@ -4502,18 +4404,6 @@ class ModuleApi extends HttpClient {
|
|
|
4502
4404
|
type: ContentType.Json,
|
|
4503
4405
|
...params,
|
|
4504
4406
|
});
|
|
4505
|
-
/**
|
|
4506
|
-
* @description Deletes a module by its identifier.
|
|
4507
|
-
*
|
|
4508
|
-
* @tags Module
|
|
4509
|
-
* @name delete
|
|
4510
|
-
* @summary Deletes a module by its identifier.
|
|
4511
|
-
* @request DELETE:/api/module/delete
|
|
4512
|
-
* @secure
|
|
4513
|
-
* @response `200` `void` OK
|
|
4514
|
-
* @response `401` `ApiExceptionResponse` Unauthorized
|
|
4515
|
-
* @response `403` `ApiExceptionResponse` Forbidden
|
|
4516
|
-
*/
|
|
4517
4407
|
this.delete = (data, params = {}) => this.request({
|
|
4518
4408
|
path: `/api/module/delete`,
|
|
4519
4409
|
method: "DELETE",
|
|
@@ -4522,18 +4412,6 @@ class ModuleApi extends HttpClient {
|
|
|
4522
4412
|
type: ContentType.Json,
|
|
4523
4413
|
...params,
|
|
4524
4414
|
});
|
|
4525
|
-
/**
|
|
4526
|
-
* @description Returns all registered modules and indicates whether each one is currently loaded into the application.
|
|
4527
|
-
*
|
|
4528
|
-
* @tags Module
|
|
4529
|
-
* @name getModulesWithLoadStatus
|
|
4530
|
-
* @summary Returns all registered modules and indicates whether each one is currently loaded into the application.
|
|
4531
|
-
* @request GET:/api/module/get-modules-with-load-status
|
|
4532
|
-
* @secure
|
|
4533
|
-
* @response `200` `(ExistModuleDto)[]` OK
|
|
4534
|
-
* @response `401` `ApiExceptionResponse` Unauthorized
|
|
4535
|
-
* @response `403` `ApiExceptionResponse` Forbidden
|
|
4536
|
-
*/
|
|
4537
4415
|
this.getModulesWithLoadStatus = (params = {}) => this.request({
|
|
4538
4416
|
path: `/api/module/get-modules-with-load-status`,
|
|
4539
4417
|
method: "GET",
|