@digital8/lighting-illusions-ts-sdk 0.0.1702 → 0.0.1703
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 +56 -34
- package/README.md +41 -26
- package/dist/apis/MenuApi.d.ts +109 -0
- package/dist/apis/MenuApi.js +433 -0
- package/dist/apis/MenuItemsApi.d.ts +124 -0
- package/dist/apis/{ReviewApi.js → MenuItemsApi.js} +89 -164
- package/dist/apis/index.d.ts +2 -1
- package/dist/apis/index.js +2 -1
- package/dist/models/GetAllMenuItemRequest.d.ts +93 -0
- package/dist/models/GetAllMenuItemRequest.js +81 -0
- package/dist/models/GetAllMenuRequest.d.ts +93 -0
- package/dist/models/GetAllMenuRequest.js +81 -0
- package/dist/models/GetHierarchyMenuItemRequest.d.ts +32 -0
- package/dist/models/GetHierarchyMenuItemRequest.js +51 -0
- package/dist/models/IndexMenuRequest.d.ts +105 -0
- package/dist/models/{IndexReviewRequest.js → IndexMenuRequest.js} +22 -23
- package/dist/models/MenuItemHierarchyResource.d.ts +81 -0
- package/dist/models/MenuItemHierarchyResource.js +80 -0
- package/dist/models/MenuItemHierarchyResourceArrayResponse.d.ts +33 -0
- package/dist/models/MenuItemHierarchyResourceArrayResponse.js +50 -0
- package/dist/models/MenuItemLinkResource.d.ts +68 -0
- package/dist/models/MenuItemLinkResource.js +67 -0
- package/dist/models/MenuItemLinkResourceArrayResponse.d.ts +33 -0
- package/dist/models/MenuItemLinkResourceArrayResponse.js +50 -0
- package/dist/models/MenuItemLiteResource.d.ts +62 -0
- package/dist/models/MenuItemLiteResource.js +67 -0
- package/dist/models/MenuItemLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/MenuItemLiteResourceArrayResponse.js +50 -0
- package/dist/models/MenuItemResource.d.ts +106 -0
- package/dist/models/MenuItemResource.js +91 -0
- package/dist/models/MenuItemResourceArrayResponse.d.ts +33 -0
- package/dist/models/MenuItemResourceArrayResponse.js +50 -0
- package/dist/models/MenuItemType.d.ts +27 -0
- package/dist/models/MenuItemType.js +53 -0
- package/dist/models/MenuListResource.d.ts +64 -0
- package/dist/models/MenuListResource.js +73 -0
- package/dist/models/MenuListResourceArrayResponse.d.ts +33 -0
- package/dist/models/MenuListResourceArrayResponse.js +50 -0
- package/dist/models/MenuPosition.d.ts +27 -0
- package/dist/models/MenuPosition.js +53 -0
- package/dist/models/MenuResource.d.ts +63 -0
- package/dist/models/MenuResource.js +70 -0
- package/dist/models/MenuResourceArrayResponse.d.ts +33 -0
- package/dist/models/MenuResourceArrayResponse.js +50 -0
- package/dist/models/PaginatedMenuListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedMenuListResourceResponse.js +57 -0
- package/dist/models/SearchLinkablesMenuItemRequest.d.ts +54 -0
- package/dist/models/SearchLinkablesMenuItemRequest.js +65 -0
- package/dist/models/StoreAssetForAssetableRequest.d.ts +2 -0
- package/dist/models/StoreAssetForAssetableRequest.js +3 -1
- package/dist/models/StoreFrontendResource.d.ts +1 -1
- package/dist/models/StoreFrontendResource.js +3 -1
- package/dist/models/StoreListResource.d.ts +2 -2
- package/dist/models/StoreListResource.js +6 -2
- package/dist/models/StoreMenuItemRequest.d.ts +97 -0
- package/dist/models/StoreMenuItemRequest.js +84 -0
- package/dist/models/StoreMenuItemRequestMenuItemLink.d.ts +60 -0
- package/dist/models/StoreMenuItemRequestMenuItemLink.js +65 -0
- package/dist/models/StoreMenuRequest.d.ts +54 -0
- package/dist/models/StoreMenuRequest.js +69 -0
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateFrontendResource.js +1 -3
- package/dist/models/UpdateMenuItemRequest.d.ts +97 -0
- package/dist/models/UpdateMenuItemRequest.js +78 -0
- package/dist/models/UpdateMenuRequest.d.ts +61 -0
- package/dist/models/UpdateMenuRequest.js +66 -0
- package/dist/models/UpdateMenuRequestMenuItemOrderInner.d.ts +44 -0
- package/dist/models/UpdateMenuRequestMenuItemOrderInner.js +53 -0
- package/dist/models/index.d.ts +26 -16
- package/dist/models/index.js +26 -16
- package/docs/GetAllMenuItemRequest.md +48 -0
- package/docs/GetAllMenuRequest.md +48 -0
- package/docs/{ReviewResourceArrayResponse.md → GetHierarchyMenuItemRequest.md} +6 -6
- package/docs/{IndexReviewRequest.md → IndexMenuRequest.md} +6 -8
- package/docs/MenuApi.md +407 -0
- package/docs/MenuItemHierarchyResource.md +50 -0
- package/docs/{AdminUserLiteResourceArrayResponse.md → MenuItemHierarchyResourceArrayResponse.md} +5 -5
- package/docs/MenuItemLinkResource.md +46 -0
- package/docs/{CustomerLiteResourceArrayResponse.md → MenuItemLinkResourceArrayResponse.md} +5 -5
- package/docs/{CustomerLiteResource.md → MenuItemLiteResource.md} +14 -10
- package/docs/MenuItemLiteResourceArrayResponse.md +34 -0
- package/docs/MenuItemResource.md +58 -0
- package/docs/{ReviewListResourceArrayResponse.md → MenuItemResourceArrayResponse.md} +5 -5
- package/docs/{ReviewLiteResource.md → MenuItemType.md} +4 -10
- package/docs/{ReviewApi.md → MenuItemsApi.md} +97 -163
- package/docs/MenuListResource.md +44 -0
- package/docs/{ReviewLiteResourceArrayResponse.md → MenuListResourceArrayResponse.md} +5 -5
- package/docs/MenuPosition.md +32 -0
- package/docs/MenuResource.md +44 -0
- package/docs/MenuResourceArrayResponse.md +34 -0
- package/docs/{PaginatedReviewResourceResponse.md → PaginatedMenuListResourceResponse.md} +5 -5
- package/docs/SearchLinkablesMenuItemRequest.md +38 -0
- package/docs/StoreMenuItemRequest.md +52 -0
- package/docs/StoreMenuItemRequestMenuItemLink.md +40 -0
- package/docs/StoreMenuRequest.md +38 -0
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/docs/UpdateMenuItemRequest.md +52 -0
- package/docs/UpdateMenuRequest.md +40 -0
- package/docs/{AdminUserLiteResource.md → UpdateMenuRequestMenuItemOrderInner.md} +8 -10
- package/package.json +1 -1
- package/src/apis/MenuApi.ts +334 -0
- package/src/apis/MenuItemsApi.ts +381 -0
- package/src/apis/index.ts +2 -1
- package/src/models/GetAllMenuItemRequest.ts +144 -0
- package/src/models/GetAllMenuRequest.ts +144 -0
- package/src/models/GetHierarchyMenuItemRequest.ts +66 -0
- package/src/models/{IndexReviewRequest.ts → IndexMenuRequest.ts} +35 -42
- package/src/models/MenuItemHierarchyResource.ts +144 -0
- package/src/models/MenuItemHierarchyResourceArrayResponse.ts +73 -0
- package/src/models/MenuItemLinkResource.ts +116 -0
- package/src/models/MenuItemLinkResourceArrayResponse.ts +73 -0
- package/src/models/MenuItemLiteResource.ts +109 -0
- package/src/models/MenuItemLiteResourceArrayResponse.ts +73 -0
- package/src/models/MenuItemResource.ts +184 -0
- package/src/models/MenuItemResourceArrayResponse.ts +73 -0
- package/src/models/MenuItemType.ts +55 -0
- package/src/models/MenuListResource.ts +126 -0
- package/src/models/MenuListResourceArrayResponse.ts +73 -0
- package/src/models/MenuPosition.ts +55 -0
- package/src/models/MenuResource.ts +118 -0
- package/src/models/MenuResourceArrayResponse.ts +73 -0
- package/src/models/PaginatedMenuListResourceResponse.ts +90 -0
- package/src/models/SearchLinkablesMenuItemRequest.ts +95 -0
- package/src/models/StoreAssetForAssetableRequest.ts +3 -1
- package/src/models/StoreFrontendResource.ts +3 -2
- package/src/models/StoreListResource.ts +6 -4
- package/src/models/StoreMenuItemRequest.ts +161 -0
- package/src/models/StoreMenuItemRequestMenuItemLink.ts +102 -0
- package/src/models/StoreMenuRequest.ts +97 -0
- package/src/models/StoreSpecialDateFrontendResource.ts +3 -4
- package/src/models/UpdateMenuItemRequest.ts +158 -0
- package/src/models/UpdateMenuRequest.ts +110 -0
- package/src/models/UpdateMenuRequestMenuItemOrderInner.ts +81 -0
- package/src/models/index.ts +26 -16
- package/dist/apis/ReviewApi.d.ts +0 -139
- package/dist/models/AdminUserLiteResource.d.ts +0 -50
- package/dist/models/AdminUserLiteResource.js +0 -61
- package/dist/models/AdminUserLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/AdminUserLiteResourceArrayResponse.js +0 -50
- package/dist/models/CustomerLiteResource.d.ts +0 -50
- package/dist/models/CustomerLiteResource.js +0 -61
- package/dist/models/CustomerLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/CustomerLiteResourceArrayResponse.js +0 -50
- package/dist/models/IndexReviewRequest.d.ts +0 -110
- package/dist/models/PaginatedReviewListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedReviewListResourceResponse.js +0 -57
- package/dist/models/PaginatedReviewLiteResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedReviewLiteResourceResponse.js +0 -57
- package/dist/models/PaginatedReviewResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedReviewResourceResponse.js +0 -57
- package/dist/models/ReviewListResource.d.ts +0 -88
- package/dist/models/ReviewListResource.js +0 -83
- package/dist/models/ReviewListResourceArrayResponse.d.ts +0 -33
- package/dist/models/ReviewListResourceArrayResponse.js +0 -50
- package/dist/models/ReviewLiteResource.d.ts +0 -44
- package/dist/models/ReviewLiteResource.js +0 -59
- package/dist/models/ReviewLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/ReviewLiteResourceArrayResponse.js +0 -50
- package/dist/models/ReviewResource.d.ts +0 -120
- package/dist/models/ReviewResource.js +0 -103
- package/dist/models/ReviewResourceArrayResponse.d.ts +0 -33
- package/dist/models/ReviewResourceArrayResponse.js +0 -50
- package/dist/models/StoreReviewRequest.d.ts +0 -74
- package/dist/models/StoreReviewRequest.js +0 -71
- package/dist/models/UpdateReviewRequest.d.ts +0 -62
- package/dist/models/UpdateReviewRequest.js +0 -63
- package/docs/PaginatedReviewListResourceResponse.md +0 -36
- package/docs/PaginatedReviewLiteResourceResponse.md +0 -36
- package/docs/ReviewListResource.md +0 -52
- package/docs/ReviewResource.md +0 -62
- package/docs/StoreReviewRequest.md +0 -48
- package/docs/UpdateReviewRequest.md +0 -44
- package/src/apis/ReviewApi.ts +0 -444
- package/src/models/AdminUserLiteResource.ts +0 -92
- package/src/models/AdminUserLiteResourceArrayResponse.ts +0 -73
- package/src/models/CustomerLiteResource.ts +0 -92
- package/src/models/CustomerLiteResourceArrayResponse.ts +0 -73
- package/src/models/PaginatedReviewListResourceResponse.ts +0 -90
- package/src/models/PaginatedReviewLiteResourceResponse.ts +0 -90
- package/src/models/PaginatedReviewResourceResponse.ts +0 -90
- package/src/models/ReviewListResource.ts +0 -159
- package/src/models/ReviewListResourceArrayResponse.ts +0 -73
- package/src/models/ReviewLiteResource.ts +0 -84
- package/src/models/ReviewLiteResourceArrayResponse.ts +0 -73
- package/src/models/ReviewResource.ts +0 -217
- package/src/models/ReviewResourceArrayResponse.ts +0 -73
- package/src/models/StoreReviewRequest.ts +0 -125
- package/src/models/UpdateReviewRequest.ts +0 -107
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
|
|
2
|
+
# MenuItemResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`menuId` | number
|
|
11
|
+
`parentId` | number
|
|
12
|
+
`type` | string
|
|
13
|
+
`heading` | string
|
|
14
|
+
`subheading` | string
|
|
15
|
+
`css` | string
|
|
16
|
+
`cssMobile` | string
|
|
17
|
+
`javascript` | string
|
|
18
|
+
`index` | number
|
|
19
|
+
`children` | [Array<MenuItemResource>](MenuItemResource.md)
|
|
20
|
+
`asset` | [AssetResource](AssetResource.md)
|
|
21
|
+
`menuItemLink` | [MenuItemLinkResource](MenuItemLinkResource.md)
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import type { MenuItemResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
27
|
+
|
|
28
|
+
// TODO: Update the object below with actual values
|
|
29
|
+
const example = {
|
|
30
|
+
"id": null,
|
|
31
|
+
"menuId": null,
|
|
32
|
+
"parentId": null,
|
|
33
|
+
"type": null,
|
|
34
|
+
"heading": null,
|
|
35
|
+
"subheading": null,
|
|
36
|
+
"css": null,
|
|
37
|
+
"cssMobile": null,
|
|
38
|
+
"javascript": null,
|
|
39
|
+
"index": null,
|
|
40
|
+
"children": null,
|
|
41
|
+
"asset": null,
|
|
42
|
+
"menuItemLink": null,
|
|
43
|
+
} satisfies MenuItemResource
|
|
44
|
+
|
|
45
|
+
console.log(example)
|
|
46
|
+
|
|
47
|
+
// Convert the instance to a JSON string
|
|
48
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
49
|
+
console.log(exampleJSON)
|
|
50
|
+
|
|
51
|
+
// Parse the JSON string back to an object
|
|
52
|
+
const exampleParsed = JSON.parse(exampleJSON) as MenuItemResource
|
|
53
|
+
console.log(exampleParsed)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
57
|
+
|
|
58
|
+
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# MenuItemResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<MenuItemResource>](MenuItemResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { MenuItemResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
18
|
"data": null,
|
|
19
|
-
} satisfies
|
|
19
|
+
} satisfies MenuItemResourceArrayResponse
|
|
20
20
|
|
|
21
21
|
console.log(example)
|
|
22
22
|
|
|
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
25
|
console.log(exampleJSON)
|
|
26
26
|
|
|
27
27
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as MenuItemResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -1,26 +1,20 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# MenuItemType
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`id` | number
|
|
10
|
-
`reviewerName` | string
|
|
11
|
-
`rating` | number
|
|
12
9
|
|
|
13
10
|
## Example
|
|
14
11
|
|
|
15
12
|
```typescript
|
|
16
|
-
import type {
|
|
13
|
+
import type { MenuItemType } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
14
|
|
|
18
15
|
// TODO: Update the object below with actual values
|
|
19
16
|
const example = {
|
|
20
|
-
|
|
21
|
-
"reviewerName": null,
|
|
22
|
-
"rating": null,
|
|
23
|
-
} satisfies ReviewLiteResource
|
|
17
|
+
} satisfies MenuItemType
|
|
24
18
|
|
|
25
19
|
console.log(example)
|
|
26
20
|
|
|
@@ -29,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
29
23
|
console.log(exampleJSON)
|
|
30
24
|
|
|
31
25
|
// Parse the JSON string back to an object
|
|
32
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
26
|
+
const exampleParsed = JSON.parse(exampleJSON) as MenuItemType
|
|
33
27
|
console.log(exampleParsed)
|
|
34
28
|
```
|
|
35
29
|
|
|
@@ -1,46 +1,45 @@
|
|
|
1
|
-
#
|
|
1
|
+
# MenuItemsApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *http://localhost/api*
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
14
|
-
| [**updateReview**](ReviewApi.md#updatereviewoperation) | **PUT** /admin-api/review/{review}/update | Auto-generated: updateReview |
|
|
7
|
+
| [**destroyMenuItem**](MenuItemsApi.md#destroymenuitem) | **DELETE** /admin-api/menu-items/{menuItem}/delete | Auto-generated: destroyMenuItem |
|
|
8
|
+
| [**getAllMenuItem**](MenuItemsApi.md#getallmenuitemoperation) | **POST** /admin-api/menu-items/all | Auto-generated: getAllMenuItem |
|
|
9
|
+
| [**getHierarchyMenuItem**](MenuItemsApi.md#gethierarchymenuitemoperation) | **POST** /admin-api/menu-items/hierarchy | Auto-generated: getHierarchyMenuItem |
|
|
10
|
+
| [**searchLinkablesMenuItem**](MenuItemsApi.md#searchlinkablesmenuitemoperation) | **POST** /admin-api/menu-items/linkables/search | Auto-generated: searchLinkablesMenuItem |
|
|
11
|
+
| [**showMenuItem**](MenuItemsApi.md#showmenuitem) | **GET** /admin-api/menu-items/{menuItem} | Auto-generated: showMenuItem |
|
|
12
|
+
| [**storeMenuItem**](MenuItemsApi.md#storemenuitemoperation) | **POST** /admin-api/menu-items/create | Auto-generated: storeMenuItem |
|
|
13
|
+
| [**updateMenuItem**](MenuItemsApi.md#updatemenuitemoperation) | **PUT** /admin-api/menu-items/{menuItem}/update | Auto-generated: updateMenuItem |
|
|
15
14
|
|
|
16
15
|
|
|
17
16
|
|
|
18
|
-
##
|
|
17
|
+
## destroyMenuItem
|
|
19
18
|
|
|
20
|
-
> GenericResponse
|
|
19
|
+
> GenericResponse destroyMenuItem(menuItem)
|
|
21
20
|
|
|
22
|
-
Auto-generated:
|
|
21
|
+
Auto-generated: destroyMenuItem
|
|
23
22
|
|
|
24
23
|
### Example
|
|
25
24
|
|
|
26
25
|
```ts
|
|
27
26
|
import {
|
|
28
27
|
Configuration,
|
|
29
|
-
|
|
28
|
+
MenuItemsApi,
|
|
30
29
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
31
|
-
import type {
|
|
30
|
+
import type { DestroyMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
32
31
|
|
|
33
32
|
async function example() {
|
|
34
33
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
35
|
-
const api = new
|
|
34
|
+
const api = new MenuItemsApi();
|
|
36
35
|
|
|
37
36
|
const body = {
|
|
38
|
-
// number | The id of the
|
|
39
|
-
|
|
40
|
-
} satisfies
|
|
37
|
+
// number | The id of the menuItem
|
|
38
|
+
menuItem: 56,
|
|
39
|
+
} satisfies DestroyMenuItemRequest;
|
|
41
40
|
|
|
42
41
|
try {
|
|
43
|
-
const data = await api.
|
|
42
|
+
const data = await api.destroyMenuItem(body);
|
|
44
43
|
console.log(data);
|
|
45
44
|
} catch (error) {
|
|
46
45
|
console.error(error);
|
|
@@ -56,7 +55,7 @@ example().catch(console.error);
|
|
|
56
55
|
|
|
57
56
|
| Name | Type | Description | Notes |
|
|
58
57
|
|------------- | ------------- | ------------- | -------------|
|
|
59
|
-
| **
|
|
58
|
+
| **menuItem** | `number` | The id of the menuItem | [Defaults to `undefined`] |
|
|
60
59
|
|
|
61
60
|
### Return type
|
|
62
61
|
|
|
@@ -75,37 +74,37 @@ No authorization required
|
|
|
75
74
|
### HTTP response details
|
|
76
75
|
| Status code | Description | Response headers |
|
|
77
76
|
|-------------|-------------|------------------|
|
|
78
|
-
| **200** | \\JsonResponse | - |
|
|
77
|
+
| **200** | \\JsonResponse<array{message: string}> | - |
|
|
79
78
|
|
|
80
79
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
81
80
|
|
|
82
81
|
|
|
83
|
-
##
|
|
82
|
+
## getAllMenuItem
|
|
84
83
|
|
|
85
|
-
>
|
|
84
|
+
> MenuItemLiteResourceArrayResponse getAllMenuItem(getAllMenuItemRequest)
|
|
86
85
|
|
|
87
|
-
Auto-generated:
|
|
86
|
+
Auto-generated: getAllMenuItem
|
|
88
87
|
|
|
89
88
|
### Example
|
|
90
89
|
|
|
91
90
|
```ts
|
|
92
91
|
import {
|
|
93
92
|
Configuration,
|
|
94
|
-
|
|
93
|
+
MenuItemsApi,
|
|
95
94
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
96
|
-
import type {
|
|
95
|
+
import type { GetAllMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
97
96
|
|
|
98
97
|
async function example() {
|
|
99
98
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
100
|
-
const api = new
|
|
99
|
+
const api = new MenuItemsApi();
|
|
101
100
|
|
|
102
101
|
const body = {
|
|
103
|
-
//
|
|
104
|
-
|
|
105
|
-
} satisfies
|
|
102
|
+
// GetAllMenuItemRequest (optional)
|
|
103
|
+
getAllMenuItemRequest: ...,
|
|
104
|
+
} satisfies GetAllMenuItemOperationRequest;
|
|
106
105
|
|
|
107
106
|
try {
|
|
108
|
-
const data = await api.
|
|
107
|
+
const data = await api.getAllMenuItem(body);
|
|
109
108
|
console.log(data);
|
|
110
109
|
} catch (error) {
|
|
111
110
|
console.error(error);
|
|
@@ -121,11 +120,11 @@ example().catch(console.error);
|
|
|
121
120
|
|
|
122
121
|
| Name | Type | Description | Notes |
|
|
123
122
|
|------------- | ------------- | ------------- | -------------|
|
|
124
|
-
| **
|
|
123
|
+
| **getAllMenuItemRequest** | [GetAllMenuItemRequest](GetAllMenuItemRequest.md) | | [Optional] |
|
|
125
124
|
|
|
126
125
|
### Return type
|
|
127
126
|
|
|
128
|
-
**
|
|
127
|
+
[**MenuItemLiteResourceArrayResponse**](MenuItemLiteResourceArrayResponse.md)
|
|
129
128
|
|
|
130
129
|
### Authorization
|
|
131
130
|
|
|
@@ -134,43 +133,43 @@ No authorization required
|
|
|
134
133
|
### HTTP request headers
|
|
135
134
|
|
|
136
135
|
- **Content-Type**: `application/json`
|
|
137
|
-
- **Accept**:
|
|
136
|
+
- **Accept**: `application/json`
|
|
138
137
|
|
|
139
138
|
|
|
140
139
|
### HTTP response details
|
|
141
140
|
| Status code | Description | Response headers |
|
|
142
141
|
|-------------|-------------|------------------|
|
|
143
|
-
| **200** |
|
|
142
|
+
| **200** | Successful resource response | - |
|
|
144
143
|
|
|
145
144
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
146
145
|
|
|
147
146
|
|
|
148
|
-
##
|
|
147
|
+
## getHierarchyMenuItem
|
|
149
148
|
|
|
150
|
-
>
|
|
149
|
+
> MenuItemHierarchyResourceArrayResponse getHierarchyMenuItem(getHierarchyMenuItemRequest)
|
|
151
150
|
|
|
152
|
-
Auto-generated:
|
|
151
|
+
Auto-generated: getHierarchyMenuItem
|
|
153
152
|
|
|
154
153
|
### Example
|
|
155
154
|
|
|
156
155
|
```ts
|
|
157
156
|
import {
|
|
158
157
|
Configuration,
|
|
159
|
-
|
|
158
|
+
MenuItemsApi,
|
|
160
159
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
161
|
-
import type {
|
|
160
|
+
import type { GetHierarchyMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
162
161
|
|
|
163
162
|
async function example() {
|
|
164
163
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
165
|
-
const api = new
|
|
164
|
+
const api = new MenuItemsApi();
|
|
166
165
|
|
|
167
166
|
const body = {
|
|
168
|
-
//
|
|
169
|
-
|
|
170
|
-
} satisfies
|
|
167
|
+
// GetHierarchyMenuItemRequest (optional)
|
|
168
|
+
getHierarchyMenuItemRequest: ...,
|
|
169
|
+
} satisfies GetHierarchyMenuItemOperationRequest;
|
|
171
170
|
|
|
172
171
|
try {
|
|
173
|
-
const data = await api.
|
|
172
|
+
const data = await api.getHierarchyMenuItem(body);
|
|
174
173
|
console.log(data);
|
|
175
174
|
} catch (error) {
|
|
176
175
|
console.error(error);
|
|
@@ -186,11 +185,11 @@ example().catch(console.error);
|
|
|
186
185
|
|
|
187
186
|
| Name | Type | Description | Notes |
|
|
188
187
|
|------------- | ------------- | ------------- | -------------|
|
|
189
|
-
| **
|
|
188
|
+
| **getHierarchyMenuItemRequest** | [GetHierarchyMenuItemRequest](GetHierarchyMenuItemRequest.md) | | [Optional] |
|
|
190
189
|
|
|
191
190
|
### Return type
|
|
192
191
|
|
|
193
|
-
[**
|
|
192
|
+
[**MenuItemHierarchyResourceArrayResponse**](MenuItemHierarchyResourceArrayResponse.md)
|
|
194
193
|
|
|
195
194
|
### Authorization
|
|
196
195
|
|
|
@@ -210,32 +209,32 @@ No authorization required
|
|
|
210
209
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
211
210
|
|
|
212
211
|
|
|
213
|
-
##
|
|
212
|
+
## searchLinkablesMenuItem
|
|
214
213
|
|
|
215
|
-
> GenericResponse
|
|
214
|
+
> GenericResponse searchLinkablesMenuItem(searchLinkablesMenuItemRequest)
|
|
216
215
|
|
|
217
|
-
Auto-generated:
|
|
216
|
+
Auto-generated: searchLinkablesMenuItem
|
|
218
217
|
|
|
219
218
|
### Example
|
|
220
219
|
|
|
221
220
|
```ts
|
|
222
221
|
import {
|
|
223
222
|
Configuration,
|
|
224
|
-
|
|
223
|
+
MenuItemsApi,
|
|
225
224
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
226
|
-
import type {
|
|
225
|
+
import type { SearchLinkablesMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
227
226
|
|
|
228
227
|
async function example() {
|
|
229
228
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
230
|
-
const api = new
|
|
229
|
+
const api = new MenuItemsApi();
|
|
231
230
|
|
|
232
231
|
const body = {
|
|
233
|
-
//
|
|
234
|
-
|
|
235
|
-
} satisfies
|
|
232
|
+
// SearchLinkablesMenuItemRequest (optional)
|
|
233
|
+
searchLinkablesMenuItemRequest: ...,
|
|
234
|
+
} satisfies SearchLinkablesMenuItemOperationRequest;
|
|
236
235
|
|
|
237
236
|
try {
|
|
238
|
-
const data = await api.
|
|
237
|
+
const data = await api.searchLinkablesMenuItem(body);
|
|
239
238
|
console.log(data);
|
|
240
239
|
} catch (error) {
|
|
241
240
|
console.error(error);
|
|
@@ -251,7 +250,7 @@ example().catch(console.error);
|
|
|
251
250
|
|
|
252
251
|
| Name | Type | Description | Notes |
|
|
253
252
|
|------------- | ------------- | ------------- | -------------|
|
|
254
|
-
| **
|
|
253
|
+
| **searchLinkablesMenuItemRequest** | [SearchLinkablesMenuItemRequest](SearchLinkablesMenuItemRequest.md) | | [Optional] |
|
|
255
254
|
|
|
256
255
|
### Return type
|
|
257
256
|
|
|
@@ -263,71 +262,6 @@ No authorization required
|
|
|
263
262
|
|
|
264
263
|
### HTTP request headers
|
|
265
264
|
|
|
266
|
-
- **Content-Type**: `application/x-www-form-urlencoded`
|
|
267
|
-
- **Accept**: `application/json`
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
### HTTP response details
|
|
271
|
-
| Status code | Description | Response headers |
|
|
272
|
-
|-------------|-------------|------------------|
|
|
273
|
-
| **200** | \\JsonResponse | - |
|
|
274
|
-
|
|
275
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
## indexReview
|
|
279
|
-
|
|
280
|
-
> PaginatedReviewListResourceResponse indexReview(indexReviewRequest)
|
|
281
|
-
|
|
282
|
-
Auto-generated: indexReview
|
|
283
|
-
|
|
284
|
-
### Example
|
|
285
|
-
|
|
286
|
-
```ts
|
|
287
|
-
import {
|
|
288
|
-
Configuration,
|
|
289
|
-
ReviewApi,
|
|
290
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
291
|
-
import type { IndexReviewOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
292
|
-
|
|
293
|
-
async function example() {
|
|
294
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
295
|
-
const api = new ReviewApi();
|
|
296
|
-
|
|
297
|
-
const body = {
|
|
298
|
-
// IndexReviewRequest (optional)
|
|
299
|
-
indexReviewRequest: ...,
|
|
300
|
-
} satisfies IndexReviewOperationRequest;
|
|
301
|
-
|
|
302
|
-
try {
|
|
303
|
-
const data = await api.indexReview(body);
|
|
304
|
-
console.log(data);
|
|
305
|
-
} catch (error) {
|
|
306
|
-
console.error(error);
|
|
307
|
-
}
|
|
308
|
-
}
|
|
309
|
-
|
|
310
|
-
// Run the test
|
|
311
|
-
example().catch(console.error);
|
|
312
|
-
```
|
|
313
|
-
|
|
314
|
-
### Parameters
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
| Name | Type | Description | Notes |
|
|
318
|
-
|------------- | ------------- | ------------- | -------------|
|
|
319
|
-
| **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) | | [Optional] |
|
|
320
|
-
|
|
321
|
-
### Return type
|
|
322
|
-
|
|
323
|
-
[**PaginatedReviewListResourceResponse**](PaginatedReviewListResourceResponse.md)
|
|
324
|
-
|
|
325
|
-
### Authorization
|
|
326
|
-
|
|
327
|
-
No authorization required
|
|
328
|
-
|
|
329
|
-
### HTTP request headers
|
|
330
|
-
|
|
331
265
|
- **Content-Type**: `application/json`
|
|
332
266
|
- **Accept**: `application/json`
|
|
333
267
|
|
|
@@ -335,37 +269,37 @@ No authorization required
|
|
|
335
269
|
### HTTP response details
|
|
336
270
|
| Status code | Description | Response headers |
|
|
337
271
|
|-------------|-------------|------------------|
|
|
338
|
-
| **200** |
|
|
272
|
+
| **200** | \\JsonResponse<array{data: array<int,array{id: int, slug: string|null, name: string, linkable_type: string}>}> | - |
|
|
339
273
|
|
|
340
274
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
341
275
|
|
|
342
276
|
|
|
343
|
-
##
|
|
277
|
+
## showMenuItem
|
|
344
278
|
|
|
345
|
-
>
|
|
279
|
+
> MenuItemResource showMenuItem(menuItem)
|
|
346
280
|
|
|
347
|
-
Auto-generated:
|
|
281
|
+
Auto-generated: showMenuItem
|
|
348
282
|
|
|
349
283
|
### Example
|
|
350
284
|
|
|
351
285
|
```ts
|
|
352
286
|
import {
|
|
353
287
|
Configuration,
|
|
354
|
-
|
|
288
|
+
MenuItemsApi,
|
|
355
289
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
356
|
-
import type {
|
|
290
|
+
import type { ShowMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
357
291
|
|
|
358
292
|
async function example() {
|
|
359
293
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
360
|
-
const api = new
|
|
294
|
+
const api = new MenuItemsApi();
|
|
361
295
|
|
|
362
296
|
const body = {
|
|
363
|
-
// number | The id of the
|
|
364
|
-
|
|
365
|
-
} satisfies
|
|
297
|
+
// number | The id of the menuItem
|
|
298
|
+
menuItem: 56,
|
|
299
|
+
} satisfies ShowMenuItemRequest;
|
|
366
300
|
|
|
367
301
|
try {
|
|
368
|
-
const data = await api.
|
|
302
|
+
const data = await api.showMenuItem(body);
|
|
369
303
|
console.log(data);
|
|
370
304
|
} catch (error) {
|
|
371
305
|
console.error(error);
|
|
@@ -381,11 +315,11 @@ example().catch(console.error);
|
|
|
381
315
|
|
|
382
316
|
| Name | Type | Description | Notes |
|
|
383
317
|
|------------- | ------------- | ------------- | -------------|
|
|
384
|
-
| **
|
|
318
|
+
| **menuItem** | `number` | The id of the menuItem | [Defaults to `undefined`] |
|
|
385
319
|
|
|
386
320
|
### Return type
|
|
387
321
|
|
|
388
|
-
[**
|
|
322
|
+
[**MenuItemResource**](MenuItemResource.md)
|
|
389
323
|
|
|
390
324
|
### Authorization
|
|
391
325
|
|
|
@@ -405,32 +339,32 @@ No authorization required
|
|
|
405
339
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
406
340
|
|
|
407
341
|
|
|
408
|
-
##
|
|
342
|
+
## storeMenuItem
|
|
409
343
|
|
|
410
|
-
>
|
|
344
|
+
> MenuItemResource storeMenuItem(storeMenuItemRequest)
|
|
411
345
|
|
|
412
|
-
Auto-generated:
|
|
346
|
+
Auto-generated: storeMenuItem
|
|
413
347
|
|
|
414
348
|
### Example
|
|
415
349
|
|
|
416
350
|
```ts
|
|
417
351
|
import {
|
|
418
352
|
Configuration,
|
|
419
|
-
|
|
353
|
+
MenuItemsApi,
|
|
420
354
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
421
|
-
import type {
|
|
355
|
+
import type { StoreMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
422
356
|
|
|
423
357
|
async function example() {
|
|
424
358
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
425
|
-
const api = new
|
|
359
|
+
const api = new MenuItemsApi();
|
|
426
360
|
|
|
427
361
|
const body = {
|
|
428
|
-
//
|
|
429
|
-
|
|
430
|
-
} satisfies
|
|
362
|
+
// StoreMenuItemRequest (optional)
|
|
363
|
+
storeMenuItemRequest: ...,
|
|
364
|
+
} satisfies StoreMenuItemOperationRequest;
|
|
431
365
|
|
|
432
366
|
try {
|
|
433
|
-
const data = await api.
|
|
367
|
+
const data = await api.storeMenuItem(body);
|
|
434
368
|
console.log(data);
|
|
435
369
|
} catch (error) {
|
|
436
370
|
console.error(error);
|
|
@@ -446,11 +380,11 @@ example().catch(console.error);
|
|
|
446
380
|
|
|
447
381
|
| Name | Type | Description | Notes |
|
|
448
382
|
|------------- | ------------- | ------------- | -------------|
|
|
449
|
-
| **
|
|
383
|
+
| **storeMenuItemRequest** | [StoreMenuItemRequest](StoreMenuItemRequest.md) | | [Optional] |
|
|
450
384
|
|
|
451
385
|
### Return type
|
|
452
386
|
|
|
453
|
-
[**
|
|
387
|
+
[**MenuItemResource**](MenuItemResource.md)
|
|
454
388
|
|
|
455
389
|
### Authorization
|
|
456
390
|
|
|
@@ -470,34 +404,34 @@ No authorization required
|
|
|
470
404
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
471
405
|
|
|
472
406
|
|
|
473
|
-
##
|
|
407
|
+
## updateMenuItem
|
|
474
408
|
|
|
475
|
-
>
|
|
409
|
+
> MenuItemResource updateMenuItem(menuItem, updateMenuItemRequest)
|
|
476
410
|
|
|
477
|
-
Auto-generated:
|
|
411
|
+
Auto-generated: updateMenuItem
|
|
478
412
|
|
|
479
413
|
### Example
|
|
480
414
|
|
|
481
415
|
```ts
|
|
482
416
|
import {
|
|
483
417
|
Configuration,
|
|
484
|
-
|
|
418
|
+
MenuItemsApi,
|
|
485
419
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
486
|
-
import type {
|
|
420
|
+
import type { UpdateMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
487
421
|
|
|
488
422
|
async function example() {
|
|
489
423
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
490
|
-
const api = new
|
|
424
|
+
const api = new MenuItemsApi();
|
|
491
425
|
|
|
492
426
|
const body = {
|
|
493
|
-
// number | The id of the
|
|
494
|
-
|
|
495
|
-
//
|
|
496
|
-
|
|
497
|
-
} satisfies
|
|
427
|
+
// number | The id of the menuItem
|
|
428
|
+
menuItem: 56,
|
|
429
|
+
// UpdateMenuItemRequest (optional)
|
|
430
|
+
updateMenuItemRequest: ...,
|
|
431
|
+
} satisfies UpdateMenuItemOperationRequest;
|
|
498
432
|
|
|
499
433
|
try {
|
|
500
|
-
const data = await api.
|
|
434
|
+
const data = await api.updateMenuItem(body);
|
|
501
435
|
console.log(data);
|
|
502
436
|
} catch (error) {
|
|
503
437
|
console.error(error);
|
|
@@ -513,12 +447,12 @@ example().catch(console.error);
|
|
|
513
447
|
|
|
514
448
|
| Name | Type | Description | Notes |
|
|
515
449
|
|------------- | ------------- | ------------- | -------------|
|
|
516
|
-
| **
|
|
517
|
-
| **
|
|
450
|
+
| **menuItem** | `number` | The id of the menuItem | [Defaults to `undefined`] |
|
|
451
|
+
| **updateMenuItemRequest** | [UpdateMenuItemRequest](UpdateMenuItemRequest.md) | | [Optional] |
|
|
518
452
|
|
|
519
453
|
### Return type
|
|
520
454
|
|
|
521
|
-
[**
|
|
455
|
+
[**MenuItemResource**](MenuItemResource.md)
|
|
522
456
|
|
|
523
457
|
### Authorization
|
|
524
458
|
|