@digital8/lighting-illusions-ts-sdk 0.0.1582 → 0.0.1584

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.
Files changed (145) hide show
  1. package/.openapi-generator/FILES +0 -56
  2. package/README.md +2 -41
  3. package/dist/apis/index.d.ts +0 -2
  4. package/dist/apis/index.js +0 -2
  5. package/dist/models/AddressResource.d.ts +1 -1
  6. package/dist/models/AddressResource.js +1 -3
  7. package/dist/models/IndexRedirectRequest.d.ts +12 -0
  8. package/dist/models/IndexRedirectRequest.js +4 -0
  9. package/dist/models/StoreAssetForAssetableRequest.d.ts +0 -2
  10. package/dist/models/StoreAssetForAssetableRequest.js +1 -3
  11. package/dist/models/StoreFrontendResource.d.ts +1 -1
  12. package/dist/models/StoreFrontendResource.js +1 -3
  13. package/dist/models/StoreResource.d.ts +1 -1
  14. package/dist/models/StoreResource.js +1 -3
  15. package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
  16. package/dist/models/StoreSpecialDateFrontendResource.js +3 -1
  17. package/dist/models/StoreSpecialDateResource.d.ts +2 -2
  18. package/dist/models/StoreSpecialDateResource.js +1 -3
  19. package/dist/models/index.d.ts +0 -26
  20. package/dist/models/index.js +0 -26
  21. package/docs/IndexRedirectRequest.md +4 -0
  22. package/docs/StoreSpecialDateFrontendResource.md +1 -1
  23. package/docs/StoreSpecialDateResource.md +1 -1
  24. package/package.json +1 -1
  25. package/src/apis/index.ts +0 -2
  26. package/src/models/AddressResource.ts +2 -3
  27. package/src/models/IndexRedirectRequest.ts +16 -0
  28. package/src/models/StoreAssetForAssetableRequest.ts +1 -3
  29. package/src/models/StoreFrontendResource.ts +2 -3
  30. package/src/models/StoreResource.ts +2 -3
  31. package/src/models/StoreSpecialDateFrontendResource.ts +4 -3
  32. package/src/models/StoreSpecialDateResource.ts +3 -4
  33. package/src/models/index.ts +0 -26
  34. package/dist/apis/MenuApi.d.ts +0 -109
  35. package/dist/apis/MenuApi.js +0 -433
  36. package/dist/apis/MenuItemsApi.d.ts +0 -124
  37. package/dist/apis/MenuItemsApi.js +0 -491
  38. package/dist/models/GetAllMenuItemRequest.d.ts +0 -93
  39. package/dist/models/GetAllMenuItemRequest.js +0 -81
  40. package/dist/models/GetAllMenuRequest.d.ts +0 -93
  41. package/dist/models/GetAllMenuRequest.js +0 -81
  42. package/dist/models/GetHierarchyMenuItemRequest.d.ts +0 -32
  43. package/dist/models/GetHierarchyMenuItemRequest.js +0 -51
  44. package/dist/models/IndexMenuRequest.d.ts +0 -105
  45. package/dist/models/IndexMenuRequest.js +0 -85
  46. package/dist/models/MenuItemHierarchyResource.d.ts +0 -81
  47. package/dist/models/MenuItemHierarchyResource.js +0 -80
  48. package/dist/models/MenuItemHierarchyResourceArrayResponse.d.ts +0 -33
  49. package/dist/models/MenuItemHierarchyResourceArrayResponse.js +0 -50
  50. package/dist/models/MenuItemLinkResource.d.ts +0 -68
  51. package/dist/models/MenuItemLinkResource.js +0 -67
  52. package/dist/models/MenuItemLinkResourceArrayResponse.d.ts +0 -33
  53. package/dist/models/MenuItemLinkResourceArrayResponse.js +0 -50
  54. package/dist/models/MenuItemLiteResource.d.ts +0 -62
  55. package/dist/models/MenuItemLiteResource.js +0 -67
  56. package/dist/models/MenuItemLiteResourceArrayResponse.d.ts +0 -33
  57. package/dist/models/MenuItemLiteResourceArrayResponse.js +0 -50
  58. package/dist/models/MenuItemResource.d.ts +0 -106
  59. package/dist/models/MenuItemResource.js +0 -91
  60. package/dist/models/MenuItemResourceArrayResponse.d.ts +0 -33
  61. package/dist/models/MenuItemResourceArrayResponse.js +0 -50
  62. package/dist/models/MenuItemType.d.ts +0 -27
  63. package/dist/models/MenuItemType.js +0 -53
  64. package/dist/models/MenuListResource.d.ts +0 -64
  65. package/dist/models/MenuListResource.js +0 -73
  66. package/dist/models/MenuListResourceArrayResponse.d.ts +0 -33
  67. package/dist/models/MenuListResourceArrayResponse.js +0 -50
  68. package/dist/models/MenuPosition.d.ts +0 -27
  69. package/dist/models/MenuPosition.js +0 -53
  70. package/dist/models/MenuResource.d.ts +0 -63
  71. package/dist/models/MenuResource.js +0 -70
  72. package/dist/models/MenuResourceArrayResponse.d.ts +0 -33
  73. package/dist/models/MenuResourceArrayResponse.js +0 -50
  74. package/dist/models/PaginatedMenuListResourceResponse.d.ts +0 -40
  75. package/dist/models/PaginatedMenuListResourceResponse.js +0 -57
  76. package/dist/models/SearchLinkablesMenuItemRequest.d.ts +0 -54
  77. package/dist/models/SearchLinkablesMenuItemRequest.js +0 -65
  78. package/dist/models/StoreMenuItemRequest.d.ts +0 -97
  79. package/dist/models/StoreMenuItemRequest.js +0 -84
  80. package/dist/models/StoreMenuItemRequestMenuItemLink.d.ts +0 -60
  81. package/dist/models/StoreMenuItemRequestMenuItemLink.js +0 -65
  82. package/dist/models/StoreMenuRequest.d.ts +0 -54
  83. package/dist/models/StoreMenuRequest.js +0 -69
  84. package/dist/models/UpdateMenuItemRequest.d.ts +0 -97
  85. package/dist/models/UpdateMenuItemRequest.js +0 -78
  86. package/dist/models/UpdateMenuRequest.d.ts +0 -61
  87. package/dist/models/UpdateMenuRequest.js +0 -66
  88. package/dist/models/UpdateMenuRequestMenuItemOrderInner.d.ts +0 -44
  89. package/dist/models/UpdateMenuRequestMenuItemOrderInner.js +0 -53
  90. package/docs/GetAllMenuItemRequest.md +0 -48
  91. package/docs/GetAllMenuRequest.md +0 -48
  92. package/docs/GetHierarchyMenuItemRequest.md +0 -34
  93. package/docs/IndexMenuRequest.md +0 -52
  94. package/docs/MenuApi.md +0 -407
  95. package/docs/MenuItemHierarchyResource.md +0 -50
  96. package/docs/MenuItemHierarchyResourceArrayResponse.md +0 -34
  97. package/docs/MenuItemLinkResource.md +0 -46
  98. package/docs/MenuItemLinkResourceArrayResponse.md +0 -34
  99. package/docs/MenuItemLiteResource.md +0 -44
  100. package/docs/MenuItemLiteResourceArrayResponse.md +0 -34
  101. package/docs/MenuItemResource.md +0 -58
  102. package/docs/MenuItemResourceArrayResponse.md +0 -34
  103. package/docs/MenuItemType.md +0 -32
  104. package/docs/MenuItemsApi.md +0 -473
  105. package/docs/MenuListResource.md +0 -44
  106. package/docs/MenuListResourceArrayResponse.md +0 -34
  107. package/docs/MenuPosition.md +0 -32
  108. package/docs/MenuResource.md +0 -44
  109. package/docs/MenuResourceArrayResponse.md +0 -34
  110. package/docs/PaginatedMenuListResourceResponse.md +0 -36
  111. package/docs/SearchLinkablesMenuItemRequest.md +0 -38
  112. package/docs/StoreMenuItemRequest.md +0 -52
  113. package/docs/StoreMenuItemRequestMenuItemLink.md +0 -40
  114. package/docs/StoreMenuRequest.md +0 -38
  115. package/docs/UpdateMenuItemRequest.md +0 -52
  116. package/docs/UpdateMenuRequest.md +0 -40
  117. package/docs/UpdateMenuRequestMenuItemOrderInner.md +0 -38
  118. package/src/apis/MenuApi.ts +0 -334
  119. package/src/apis/MenuItemsApi.ts +0 -381
  120. package/src/models/GetAllMenuItemRequest.ts +0 -144
  121. package/src/models/GetAllMenuRequest.ts +0 -144
  122. package/src/models/GetHierarchyMenuItemRequest.ts +0 -66
  123. package/src/models/IndexMenuRequest.ts +0 -160
  124. package/src/models/MenuItemHierarchyResource.ts +0 -144
  125. package/src/models/MenuItemHierarchyResourceArrayResponse.ts +0 -73
  126. package/src/models/MenuItemLinkResource.ts +0 -116
  127. package/src/models/MenuItemLinkResourceArrayResponse.ts +0 -73
  128. package/src/models/MenuItemLiteResource.ts +0 -109
  129. package/src/models/MenuItemLiteResourceArrayResponse.ts +0 -73
  130. package/src/models/MenuItemResource.ts +0 -184
  131. package/src/models/MenuItemResourceArrayResponse.ts +0 -73
  132. package/src/models/MenuItemType.ts +0 -55
  133. package/src/models/MenuListResource.ts +0 -126
  134. package/src/models/MenuListResourceArrayResponse.ts +0 -73
  135. package/src/models/MenuPosition.ts +0 -55
  136. package/src/models/MenuResource.ts +0 -118
  137. package/src/models/MenuResourceArrayResponse.ts +0 -73
  138. package/src/models/PaginatedMenuListResourceResponse.ts +0 -90
  139. package/src/models/SearchLinkablesMenuItemRequest.ts +0 -95
  140. package/src/models/StoreMenuItemRequest.ts +0 -161
  141. package/src/models/StoreMenuItemRequestMenuItemLink.ts +0 -102
  142. package/src/models/StoreMenuRequest.ts +0 -97
  143. package/src/models/UpdateMenuItemRequest.ts +0 -158
  144. package/src/models/UpdateMenuRequest.ts +0 -110
  145. package/src/models/UpdateMenuRequestMenuItemOrderInner.ts +0 -81
@@ -1,34 +0,0 @@
1
-
2
- # MenuResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<MenuResource>](MenuResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { MenuResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies MenuResourceArrayResponse
20
-
21
- console.log(example)
22
-
23
- // Convert the instance to a JSON string
24
- const exampleJSON: string = JSON.stringify(example)
25
- console.log(exampleJSON)
26
-
27
- // Parse the JSON string back to an object
28
- const exampleParsed = JSON.parse(exampleJSON) as MenuResourceArrayResponse
29
- console.log(exampleParsed)
30
- ```
31
-
32
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
-
34
-
@@ -1,36 +0,0 @@
1
-
2
- # PaginatedMenuListResourceResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<MenuListResource>](MenuListResource.md)
10
- `meta` | [PagingMetadata](PagingMetadata.md)
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import type { PaginatedMenuListResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "data": null,
20
- "meta": null,
21
- } satisfies PaginatedMenuListResourceResponse
22
-
23
- console.log(example)
24
-
25
- // Convert the instance to a JSON string
26
- const exampleJSON: string = JSON.stringify(example)
27
- console.log(exampleJSON)
28
-
29
- // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as PaginatedMenuListResourceResponse
31
- console.log(exampleParsed)
32
- ```
33
-
34
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
-
36
-
@@ -1,38 +0,0 @@
1
-
2
- # SearchLinkablesMenuItemRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `search` | string
10
- `types` | Array<string>
11
- `siteId` | number
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import type { SearchLinkablesMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "search": null,
21
- "types": null,
22
- "siteId": null,
23
- } satisfies SearchLinkablesMenuItemRequest
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 SearchLinkablesMenuItemRequest
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
-
@@ -1,52 +0,0 @@
1
-
2
- # StoreMenuItemRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `menuId` | number
10
- `parentId` | number
11
- `type` | string
12
- `heading` | string
13
- `subheading` | string
14
- `css` | string
15
- `cssMobile` | string
16
- `javascript` | string
17
- `index` | number
18
- `menuItemLink` | [StoreMenuItemRequestMenuItemLink](StoreMenuItemRequestMenuItemLink.md)
19
-
20
- ## Example
21
-
22
- ```typescript
23
- import type { StoreMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk'
24
-
25
- // TODO: Update the object below with actual values
26
- const example = {
27
- "menuId": null,
28
- "parentId": null,
29
- "type": null,
30
- "heading": null,
31
- "subheading": null,
32
- "css": null,
33
- "cssMobile": null,
34
- "javascript": null,
35
- "index": null,
36
- "menuItemLink": null,
37
- } satisfies StoreMenuItemRequest
38
-
39
- console.log(example)
40
-
41
- // Convert the instance to a JSON string
42
- const exampleJSON: string = JSON.stringify(example)
43
- console.log(exampleJSON)
44
-
45
- // Parse the JSON string back to an object
46
- const exampleParsed = JSON.parse(exampleJSON) as StoreMenuItemRequest
47
- console.log(exampleParsed)
48
- ```
49
-
50
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
51
-
52
-
@@ -1,40 +0,0 @@
1
-
2
- # StoreMenuItemRequestMenuItemLink
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `linkableType` | string
10
- `linkableId` | number
11
- `link` | string
12
- `isExternalLink` | boolean
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import type { StoreMenuItemRequestMenuItemLink } from '@digital8/lighting-illusions-ts-sdk'
18
-
19
- // TODO: Update the object below with actual values
20
- const example = {
21
- "linkableType": null,
22
- "linkableId": null,
23
- "link": null,
24
- "isExternalLink": null,
25
- } satisfies StoreMenuItemRequestMenuItemLink
26
-
27
- console.log(example)
28
-
29
- // Convert the instance to a JSON string
30
- const exampleJSON: string = JSON.stringify(example)
31
- console.log(exampleJSON)
32
-
33
- // Parse the JSON string back to an object
34
- const exampleParsed = JSON.parse(exampleJSON) as StoreMenuItemRequestMenuItemLink
35
- console.log(exampleParsed)
36
- ```
37
-
38
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
-
40
-
@@ -1,38 +0,0 @@
1
-
2
- # StoreMenuRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `siteId` | number
10
- `position` | string
11
- `name` | string
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import type { StoreMenuRequest } from '@digital8/lighting-illusions-ts-sdk'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "siteId": null,
21
- "position": null,
22
- "name": null,
23
- } satisfies StoreMenuRequest
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 StoreMenuRequest
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
-
@@ -1,52 +0,0 @@
1
-
2
- # UpdateMenuItemRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `menuId` | number
10
- `parentId` | number
11
- `type` | string
12
- `heading` | string
13
- `subheading` | string
14
- `css` | string
15
- `cssMobile` | string
16
- `javascript` | string
17
- `index` | number
18
- `menuItemLink` | [StoreMenuItemRequestMenuItemLink](StoreMenuItemRequestMenuItemLink.md)
19
-
20
- ## Example
21
-
22
- ```typescript
23
- import type { UpdateMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk'
24
-
25
- // TODO: Update the object below with actual values
26
- const example = {
27
- "menuId": null,
28
- "parentId": null,
29
- "type": null,
30
- "heading": null,
31
- "subheading": null,
32
- "css": null,
33
- "cssMobile": null,
34
- "javascript": null,
35
- "index": null,
36
- "menuItemLink": null,
37
- } satisfies UpdateMenuItemRequest
38
-
39
- console.log(example)
40
-
41
- // Convert the instance to a JSON string
42
- const exampleJSON: string = JSON.stringify(example)
43
- console.log(exampleJSON)
44
-
45
- // Parse the JSON string back to an object
46
- const exampleParsed = JSON.parse(exampleJSON) as UpdateMenuItemRequest
47
- console.log(exampleParsed)
48
- ```
49
-
50
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
51
-
52
-
@@ -1,40 +0,0 @@
1
-
2
- # UpdateMenuRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `siteId` | number
10
- `position` | string
11
- `name` | string
12
- `menuItemOrder` | [Array<UpdateMenuRequestMenuItemOrderInner>](UpdateMenuRequestMenuItemOrderInner.md)
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import type { UpdateMenuRequest } from '@digital8/lighting-illusions-ts-sdk'
18
-
19
- // TODO: Update the object below with actual values
20
- const example = {
21
- "siteId": null,
22
- "position": null,
23
- "name": null,
24
- "menuItemOrder": null,
25
- } satisfies UpdateMenuRequest
26
-
27
- console.log(example)
28
-
29
- // Convert the instance to a JSON string
30
- const exampleJSON: string = JSON.stringify(example)
31
- console.log(exampleJSON)
32
-
33
- // Parse the JSON string back to an object
34
- const exampleParsed = JSON.parse(exampleJSON) as UpdateMenuRequest
35
- console.log(exampleParsed)
36
- ```
37
-
38
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
-
40
-
@@ -1,38 +0,0 @@
1
-
2
- # UpdateMenuRequestMenuItemOrderInner
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `id` | number
10
- `index` | number
11
- `parentId` | number
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import type { UpdateMenuRequestMenuItemOrderInner } from '@digital8/lighting-illusions-ts-sdk'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "id": null,
21
- "index": null,
22
- "parentId": null,
23
- } satisfies UpdateMenuRequestMenuItemOrderInner
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 UpdateMenuRequestMenuItemOrderInner
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
-