@digital8/lighting-illusions-ts-sdk 0.0.1439 → 0.0.1441

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 (282) hide show
  1. package/.openapi-generator/FILES +108 -2
  2. package/README.md +78 -4
  3. package/dist/apis/AttributeApi.d.ts +16 -1
  4. package/dist/apis/AttributeApi.js +58 -0
  5. package/dist/apis/LabelApi.d.ts +109 -0
  6. package/dist/apis/LabelApi.js +433 -0
  7. package/dist/apis/ProductApi.js +1 -1
  8. package/dist/apis/ProductRangeApi.d.ts +269 -0
  9. package/dist/apis/ProductRangeApi.js +1043 -0
  10. package/dist/apis/index.d.ts +2 -0
  11. package/dist/apis/index.js +2 -0
  12. package/dist/models/AssetLiteResource.d.ts +12 -0
  13. package/dist/models/AssetLiteResource.js +6 -0
  14. package/dist/models/AttachAccessoriesProductRangeRequest.d.ts +32 -0
  15. package/dist/models/AttachAccessoriesProductRangeRequest.js +51 -0
  16. package/dist/models/AttachAttributesProductRangeRequest.d.ts +33 -0
  17. package/dist/models/AttachAttributesProductRangeRequest.js +52 -0
  18. package/dist/models/AttachAttributesProductRangeRequestAttributesInner.d.ts +38 -0
  19. package/dist/models/AttachAttributesProductRangeRequestAttributesInner.js +53 -0
  20. package/dist/models/AttachDocumentablesDocumentRequestDocumentablesInner.d.ts +2 -1
  21. package/dist/models/AttachDocumentablesDocumentRequestDocumentablesInner.js +2 -1
  22. package/dist/models/AttachDocumentsProductRangeRequest.d.ts +33 -0
  23. package/dist/models/AttachDocumentsProductRangeRequest.js +52 -0
  24. package/dist/models/DetachAccessoriesProductRangeRequest.d.ts +32 -0
  25. package/dist/models/DetachAccessoriesProductRangeRequest.js +51 -0
  26. package/dist/models/DetachAttributesProductRangeRequest.d.ts +32 -0
  27. package/dist/models/DetachAttributesProductRangeRequest.js +51 -0
  28. package/dist/models/DetachDocumentablesDocumentRequestDocumentablesInner.d.ts +2 -1
  29. package/dist/models/DetachDocumentablesDocumentRequestDocumentablesInner.js +2 -1
  30. package/dist/models/DetachDocumentsProductRangeRequest.d.ts +32 -0
  31. package/dist/models/DetachDocumentsProductRangeRequest.js +51 -0
  32. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  33. package/dist/models/ExternalApiLogResource.js +3 -1
  34. package/dist/models/GetAllDocumentRequest.d.ts +2 -1
  35. package/dist/models/GetAllDocumentRequest.js +2 -1
  36. package/dist/models/GetAllProductChildRequest.d.ts +1 -0
  37. package/dist/models/GetAllProductChildRequest.js +1 -0
  38. package/dist/models/GetAllProductRangeRequest.d.ts +98 -0
  39. package/dist/models/GetAllProductRangeRequest.js +82 -0
  40. package/dist/models/IndexAttributeRequest.d.ts +2 -0
  41. package/dist/models/IndexAttributeRequest.js +3 -1
  42. package/dist/models/IndexDocumentRequest.d.ts +2 -1
  43. package/dist/models/IndexDocumentRequest.js +2 -1
  44. package/dist/models/IndexLabelRequest.d.ts +109 -0
  45. package/dist/models/IndexLabelRequest.js +92 -0
  46. package/dist/models/IndexModelAttributeRequest.d.ts +118 -0
  47. package/dist/models/IndexModelAttributeRequest.js +93 -0
  48. package/dist/models/IndexProductChildRequest.d.ts +2 -0
  49. package/dist/models/IndexProductChildRequest.js +2 -0
  50. package/dist/models/IndexProductRangeRequest.d.ts +110 -0
  51. package/dist/models/IndexProductRangeRequest.js +86 -0
  52. package/dist/models/LabelListResource.d.ts +75 -0
  53. package/dist/models/LabelListResource.js +74 -0
  54. package/dist/models/LabelListResourceArrayResponse.d.ts +33 -0
  55. package/dist/models/LabelListResourceArrayResponse.js +50 -0
  56. package/dist/models/LabelLiteResource.d.ts +56 -0
  57. package/dist/models/LabelLiteResource.js +65 -0
  58. package/dist/models/LabelLiteResourceArrayResponse.d.ts +33 -0
  59. package/dist/models/LabelLiteResourceArrayResponse.js +50 -0
  60. package/dist/models/LabelResource.d.ts +23 -4
  61. package/dist/models/LabelResource.js +19 -8
  62. package/dist/models/ModelAttributeListResource.d.ts +64 -0
  63. package/dist/models/ModelAttributeListResource.js +71 -0
  64. package/dist/models/ModelAttributeListResourceArrayResponse.d.ts +33 -0
  65. package/dist/models/ModelAttributeListResourceArrayResponse.js +50 -0
  66. package/dist/models/ModelAttributeResource.d.ts +6 -0
  67. package/dist/models/ModelAttributeResource.js +2 -0
  68. package/dist/models/PaginatedLabelListResourceResponse.d.ts +40 -0
  69. package/dist/models/PaginatedLabelListResourceResponse.js +57 -0
  70. package/dist/models/PaginatedModelAttributeListResourceResponse.d.ts +40 -0
  71. package/dist/models/PaginatedModelAttributeListResourceResponse.js +57 -0
  72. package/dist/models/PaginatedProductRangeFrontendListResourceResponse.d.ts +40 -0
  73. package/dist/models/PaginatedProductRangeFrontendListResourceResponse.js +57 -0
  74. package/dist/models/PaginatedProductRangeListResourceResponse.d.ts +40 -0
  75. package/dist/models/PaginatedProductRangeListResourceResponse.js +57 -0
  76. package/dist/models/PaginatedProductRangeLiteResourceResponse.d.ts +40 -0
  77. package/dist/models/PaginatedProductRangeLiteResourceResponse.js +57 -0
  78. package/dist/models/PaginatedProductRangeResourceResponse.d.ts +40 -0
  79. package/dist/models/PaginatedProductRangeResourceResponse.js +57 -0
  80. package/dist/models/PaginatedProductRangeSearchResultResourceResponse.d.ts +40 -0
  81. package/dist/models/PaginatedProductRangeSearchResultResourceResponse.js +57 -0
  82. package/dist/models/ProductRangeAggregationResource.d.ts +44 -0
  83. package/dist/models/ProductRangeAggregationResource.js +59 -0
  84. package/dist/models/ProductRangeAggregationResourceArrayResponse.d.ts +33 -0
  85. package/dist/models/ProductRangeAggregationResourceArrayResponse.js +50 -0
  86. package/dist/models/ProductRangeFrontendListResource.d.ts +62 -0
  87. package/dist/models/ProductRangeFrontendListResource.js +71 -0
  88. package/dist/models/ProductRangeFrontendListResourceArrayResponse.d.ts +33 -0
  89. package/dist/models/ProductRangeFrontendListResourceArrayResponse.js +50 -0
  90. package/dist/models/ProductRangeFrontendResource.d.ts +117 -0
  91. package/dist/models/ProductRangeFrontendResource.js +106 -0
  92. package/dist/models/ProductRangeFrontendResourceArrayResponse.d.ts +33 -0
  93. package/dist/models/ProductRangeFrontendResourceArrayResponse.js +50 -0
  94. package/dist/models/ProductRangeListResource.d.ts +66 -0
  95. package/dist/models/ProductRangeListResource.js +75 -0
  96. package/dist/models/ProductRangeListResourceArrayResponse.d.ts +33 -0
  97. package/dist/models/ProductRangeListResourceArrayResponse.js +50 -0
  98. package/dist/models/ProductRangeLiteResource.d.ts +38 -0
  99. package/dist/models/ProductRangeLiteResource.js +55 -0
  100. package/dist/models/ProductRangeLiteResourceArrayResponse.d.ts +33 -0
  101. package/dist/models/ProductRangeLiteResourceArrayResponse.js +50 -0
  102. package/dist/models/ProductRangeResource.d.ts +89 -0
  103. package/dist/models/ProductRangeResource.js +86 -0
  104. package/dist/models/ProductRangeResourceArrayResponse.d.ts +33 -0
  105. package/dist/models/ProductRangeResourceArrayResponse.js +50 -0
  106. package/dist/models/ProductRangeSearchResponseResource.d.ts +47 -0
  107. package/dist/models/ProductRangeSearchResponseResource.js +62 -0
  108. package/dist/models/ProductRangeSearchResponseResourceArrayResponse.d.ts +33 -0
  109. package/dist/models/ProductRangeSearchResponseResourceArrayResponse.js +50 -0
  110. package/dist/models/ProductRangeSearchResponseResourceMeta.d.ts +50 -0
  111. package/dist/models/ProductRangeSearchResponseResourceMeta.js +63 -0
  112. package/dist/models/ProductRangeSearchResultResource.d.ts +80 -0
  113. package/dist/models/ProductRangeSearchResultResource.js +83 -0
  114. package/dist/models/ProductRangeSearchResultResourceArrayResponse.d.ts +33 -0
  115. package/dist/models/ProductRangeSearchResultResourceArrayResponse.js +50 -0
  116. package/dist/models/ProductRangeSiteDetailLiteResource.d.ts +44 -0
  117. package/dist/models/ProductRangeSiteDetailLiteResource.js +59 -0
  118. package/dist/models/ProductRangeSiteDetailLiteResourceArrayResponse.d.ts +33 -0
  119. package/dist/models/ProductRangeSiteDetailLiteResourceArrayResponse.js +50 -0
  120. package/dist/models/ProductRangeSiteDetailResource.d.ts +101 -0
  121. package/dist/models/ProductRangeSiteDetailResource.js +98 -0
  122. package/dist/models/ProductRangeSiteDetailResourceArrayResponse.d.ts +33 -0
  123. package/dist/models/ProductRangeSiteDetailResourceArrayResponse.js +50 -0
  124. package/dist/models/ProductRangeSortBy.d.ts +27 -0
  125. package/dist/models/ProductRangeSortBy.js +53 -0
  126. package/dist/models/ProductSearchResultResource.d.ts +6 -0
  127. package/dist/models/ProductSearchResultResource.js +4 -0
  128. package/dist/models/StoreAssetForAssetableRequest.d.ts +2 -0
  129. package/dist/models/StoreAssetForAssetableRequest.js +3 -1
  130. package/dist/models/StoreLabelRequest.d.ts +74 -0
  131. package/dist/models/StoreLabelRequest.js +71 -0
  132. package/dist/models/StoreProductRangeRequest.d.ts +52 -0
  133. package/dist/models/StoreProductRangeRequest.js +59 -0
  134. package/dist/models/StoreProductRangeRequestSitesInner.d.ts +92 -0
  135. package/dist/models/StoreProductRangeRequestSitesInner.js +75 -0
  136. package/dist/models/UpdateLabelRequest.d.ts +74 -0
  137. package/dist/models/UpdateLabelRequest.js +63 -0
  138. package/dist/models/UpdateProductRangeRequest.d.ts +59 -0
  139. package/dist/models/UpdateProductRangeRequest.js +62 -0
  140. package/dist/models/UpdateProductRangeRequestAttributesInner.d.ts +38 -0
  141. package/dist/models/UpdateProductRangeRequestAttributesInner.js +51 -0
  142. package/dist/models/UpdateProductTypeRequest.d.ts +9 -9
  143. package/dist/models/UpdateProductTypeRequest.js +9 -9
  144. package/dist/models/index.d.ts +52 -1
  145. package/dist/models/index.js +52 -1
  146. package/docs/AssetLiteResource.md +4 -0
  147. package/docs/AttachAccessoriesProductRangeRequest.md +34 -0
  148. package/docs/AttachAttributesProductRangeRequest.md +34 -0
  149. package/docs/AttachAttributesProductRangeRequestAttributesInner.md +36 -0
  150. package/docs/AttachDocumentsProductRangeRequest.md +34 -0
  151. package/docs/AttributeApi.md +66 -0
  152. package/docs/DetachAccessoriesProductRangeRequest.md +34 -0
  153. package/docs/DetachAttributesProductRangeRequest.md +34 -0
  154. package/docs/DetachDocumentsProductRangeRequest.md +34 -0
  155. package/docs/GetAllProductRangeRequest.md +50 -0
  156. package/docs/IndexLabelRequest.md +50 -0
  157. package/docs/IndexModelAttributeRequest.md +54 -0
  158. package/docs/IndexProductRangeRequest.md +54 -0
  159. package/docs/LabelApi.md +407 -0
  160. package/docs/LabelListResource.md +48 -0
  161. package/docs/LabelListResourceArrayResponse.md +34 -0
  162. package/docs/LabelLiteResource.md +42 -0
  163. package/docs/LabelLiteResourceArrayResponse.md +34 -0
  164. package/docs/LabelResource.md +12 -6
  165. package/docs/ModelAttributeListResource.md +44 -0
  166. package/docs/ModelAttributeListResourceArrayResponse.md +34 -0
  167. package/docs/ModelAttributeResource.md +2 -0
  168. package/docs/PaginatedLabelListResourceResponse.md +36 -0
  169. package/docs/PaginatedModelAttributeListResourceResponse.md +36 -0
  170. package/docs/PaginatedProductRangeFrontendListResourceResponse.md +36 -0
  171. package/docs/PaginatedProductRangeListResourceResponse.md +36 -0
  172. package/docs/PaginatedProductRangeLiteResourceResponse.md +36 -0
  173. package/docs/PaginatedProductRangeResourceResponse.md +36 -0
  174. package/docs/PaginatedProductRangeSearchResultResourceResponse.md +36 -0
  175. package/docs/ProductApi.md +1 -1
  176. package/docs/ProductRangeAggregationResource.md +38 -0
  177. package/docs/ProductRangeAggregationResourceArrayResponse.md +34 -0
  178. package/docs/ProductRangeApi.md +1097 -0
  179. package/docs/ProductRangeFrontendListResource.md +44 -0
  180. package/docs/ProductRangeFrontendListResourceArrayResponse.md +34 -0
  181. package/docs/ProductRangeFrontendResource.md +62 -0
  182. package/docs/ProductRangeFrontendResourceArrayResponse.md +34 -0
  183. package/docs/ProductRangeListResource.md +44 -0
  184. package/docs/ProductRangeListResourceArrayResponse.md +34 -0
  185. package/docs/ProductRangeLiteResource.md +36 -0
  186. package/docs/ProductRangeLiteResourceArrayResponse.md +34 -0
  187. package/docs/ProductRangeResource.md +52 -0
  188. package/docs/ProductRangeResourceArrayResponse.md +34 -0
  189. package/docs/ProductRangeSearchResponseResource.md +38 -0
  190. package/docs/ProductRangeSearchResponseResourceArrayResponse.md +34 -0
  191. package/docs/ProductRangeSearchResponseResourceMeta.md +40 -0
  192. package/docs/ProductRangeSearchResultResource.md +50 -0
  193. package/docs/ProductRangeSearchResultResourceArrayResponse.md +34 -0
  194. package/docs/ProductRangeSiteDetailLiteResource.md +38 -0
  195. package/docs/ProductRangeSiteDetailLiteResourceArrayResponse.md +34 -0
  196. package/docs/ProductRangeSiteDetailResource.md +56 -0
  197. package/docs/ProductRangeSiteDetailResourceArrayResponse.md +34 -0
  198. package/docs/ProductRangeSortBy.md +32 -0
  199. package/docs/ProductSearchResultResource.md +2 -0
  200. package/docs/StoreLabelRequest.md +48 -0
  201. package/docs/StoreProductRangeRequest.md +40 -0
  202. package/docs/StoreProductRangeRequestSitesInner.md +54 -0
  203. package/docs/UpdateLabelRequest.md +48 -0
  204. package/docs/UpdateProductRangeRequest.md +42 -0
  205. package/docs/{UpdateProductTypeRequestPerformanceValuesInner.md → UpdateProductRangeRequestAttributesInner.md} +4 -4
  206. package/docs/UpdateProductTypeRequest.md +4 -4
  207. package/package.json +1 -1
  208. package/src/apis/AttributeApi.ts +50 -0
  209. package/src/apis/LabelApi.ts +328 -0
  210. package/src/apis/ProductApi.ts +1 -1
  211. package/src/apis/ProductRangeApi.ts +888 -0
  212. package/src/apis/index.ts +2 -0
  213. package/src/models/AssetLiteResource.ts +17 -0
  214. package/src/models/AttachAccessoriesProductRangeRequest.ts +66 -0
  215. package/src/models/AttachAttributesProductRangeRequest.ts +74 -0
  216. package/src/models/AttachAttributesProductRangeRequestAttributesInner.ts +74 -0
  217. package/src/models/AttachDocumentablesDocumentRequestDocumentablesInner.ts +2 -1
  218. package/src/models/AttachDocumentsProductRangeRequest.ts +74 -0
  219. package/src/models/DetachAccessoriesProductRangeRequest.ts +66 -0
  220. package/src/models/DetachAttributesProductRangeRequest.ts +66 -0
  221. package/src/models/DetachDocumentablesDocumentRequestDocumentablesInner.ts +2 -1
  222. package/src/models/DetachDocumentsProductRangeRequest.ts +66 -0
  223. package/src/models/ExternalApiLogResource.ts +3 -2
  224. package/src/models/GetAllDocumentRequest.ts +2 -1
  225. package/src/models/GetAllProductChildRequest.ts +1 -0
  226. package/src/models/GetAllProductRangeRequest.ts +151 -0
  227. package/src/models/IndexAttributeRequest.ts +3 -1
  228. package/src/models/IndexDocumentRequest.ts +2 -1
  229. package/src/models/IndexLabelRequest.ts +163 -0
  230. package/src/models/IndexModelAttributeRequest.ts +176 -0
  231. package/src/models/IndexProductChildRequest.ts +2 -0
  232. package/src/models/IndexProductRangeRequest.ts +167 -0
  233. package/src/models/LabelListResource.ts +134 -0
  234. package/src/models/LabelListResourceArrayResponse.ts +73 -0
  235. package/src/models/LabelLiteResource.ts +101 -0
  236. package/src/models/LabelLiteResourceArrayResponse.ts +73 -0
  237. package/src/models/LabelResource.ts +46 -12
  238. package/src/models/ModelAttributeListResource.ts +125 -0
  239. package/src/models/ModelAttributeListResourceArrayResponse.ts +73 -0
  240. package/src/models/ModelAttributeResource.ts +8 -0
  241. package/src/models/PaginatedLabelListResourceResponse.ts +90 -0
  242. package/src/models/PaginatedModelAttributeListResourceResponse.ts +90 -0
  243. package/src/models/PaginatedProductRangeFrontendListResourceResponse.ts +90 -0
  244. package/src/models/PaginatedProductRangeListResourceResponse.ts +90 -0
  245. package/src/models/PaginatedProductRangeLiteResourceResponse.ts +90 -0
  246. package/src/models/PaginatedProductRangeResourceResponse.ts +90 -0
  247. package/src/models/PaginatedProductRangeSearchResultResourceResponse.ts +90 -0
  248. package/src/models/ProductRangeAggregationResource.ts +84 -0
  249. package/src/models/ProductRangeAggregationResourceArrayResponse.ts +73 -0
  250. package/src/models/ProductRangeFrontendListResource.ts +111 -0
  251. package/src/models/ProductRangeFrontendListResourceArrayResponse.ts +73 -0
  252. package/src/models/ProductRangeFrontendResource.ts +199 -0
  253. package/src/models/ProductRangeFrontendResourceArrayResponse.ts +73 -0
  254. package/src/models/ProductRangeListResource.ts +140 -0
  255. package/src/models/ProductRangeListResourceArrayResponse.ts +73 -0
  256. package/src/models/ProductRangeLiteResource.ts +75 -0
  257. package/src/models/ProductRangeLiteResourceArrayResponse.ts +73 -0
  258. package/src/models/ProductRangeResource.ts +167 -0
  259. package/src/models/ProductRangeResourceArrayResponse.ts +73 -0
  260. package/src/models/ProductRangeSearchResponseResource.ts +106 -0
  261. package/src/models/ProductRangeSearchResponseResourceArrayResponse.ts +73 -0
  262. package/src/models/ProductRangeSearchResponseResourceMeta.ts +93 -0
  263. package/src/models/ProductRangeSearchResultResource.ts +138 -0
  264. package/src/models/ProductRangeSearchResultResourceArrayResponse.ts +73 -0
  265. package/src/models/ProductRangeSiteDetailLiteResource.ts +84 -0
  266. package/src/models/ProductRangeSiteDetailLiteResourceArrayResponse.ts +73 -0
  267. package/src/models/ProductRangeSiteDetailResource.ts +187 -0
  268. package/src/models/ProductRangeSiteDetailResourceArrayResponse.ts +73 -0
  269. package/src/models/ProductRangeSortBy.ts +55 -0
  270. package/src/models/ProductSearchResultResource.ts +9 -0
  271. package/src/models/StoreAssetForAssetableRequest.ts +3 -1
  272. package/src/models/StoreLabelRequest.ts +125 -0
  273. package/src/models/StoreProductRangeRequest.ts +105 -0
  274. package/src/models/StoreProductRangeRequestSitesInner.ts +148 -0
  275. package/src/models/UpdateLabelRequest.ts +121 -0
  276. package/src/models/UpdateProductRangeRequest.ts +120 -0
  277. package/src/models/UpdateProductRangeRequestAttributesInner.ts +73 -0
  278. package/src/models/UpdateProductTypeRequest.ts +22 -22
  279. package/src/models/index.ts +52 -1
  280. package/dist/models/UpdateProductTypeRequestPerformanceValuesInner.d.ts +0 -38
  281. package/dist/models/UpdateProductTypeRequestPerformanceValuesInner.js +0 -51
  282. package/src/models/UpdateProductTypeRequestPerformanceValuesInner.ts +0 -73
@@ -0,0 +1,34 @@
1
+
2
+ # LabelListResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<LabelListResource>](LabelListResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { LabelListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies LabelListResourceArrayResponse
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 LabelListResourceArrayResponse
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
+
@@ -0,0 +1,42 @@
1
+
2
+ # LabelLiteResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | number
10
+ `shortName` | string
11
+ `longName` | string
12
+ `colour` | string
13
+ `textColour` | string
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { LabelLiteResource } from '@digital8/lighting-illusions-ts-sdk'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "id": null,
23
+ "shortName": null,
24
+ "longName": null,
25
+ "colour": null,
26
+ "textColour": null,
27
+ } satisfies LabelLiteResource
28
+
29
+ console.log(example)
30
+
31
+ // Convert the instance to a JSON string
32
+ const exampleJSON: string = JSON.stringify(example)
33
+ console.log(exampleJSON)
34
+
35
+ // Parse the JSON string back to an object
36
+ const exampleParsed = JSON.parse(exampleJSON) as LabelLiteResource
37
+ console.log(exampleParsed)
38
+ ```
39
+
40
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
41
+
42
+
@@ -0,0 +1,34 @@
1
+
2
+ # LabelLiteResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<LabelLiteResource>](LabelLiteResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { LabelLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies LabelLiteResourceArrayResponse
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 LabelLiteResourceArrayResponse
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
+
@@ -9,9 +9,12 @@ Name | Type
9
9
  `id` | number
10
10
  `shortName` | string
11
11
  `longName` | string
12
- `siteId` | number
13
- `color` | string
14
- `textColor` | string
12
+ `site` | [SiteLiteResource](SiteLiteResource.md)
13
+ `cartButtonText` | string
14
+ `colour` | string
15
+ `textColour` | string
16
+ `startDate` | string
17
+ `endDate` | string
15
18
 
16
19
  ## Example
17
20
 
@@ -23,9 +26,12 @@ const example = {
23
26
  "id": null,
24
27
  "shortName": null,
25
28
  "longName": null,
26
- "siteId": null,
27
- "color": null,
28
- "textColor": null,
29
+ "site": null,
30
+ "cartButtonText": null,
31
+ "colour": null,
32
+ "textColour": null,
33
+ "startDate": null,
34
+ "endDate": null,
29
35
  } satisfies LabelResource
30
36
 
31
37
  console.log(example)
@@ -0,0 +1,44 @@
1
+
2
+ # ModelAttributeListResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | number
10
+ `value` | string
11
+ `attribute` | [AttributeLiteResource](AttributeLiteResource.md)
12
+ `attributeValues` | [Array<AttributeValueResource>](AttributeValueResource.md)
13
+ `selectedValues` | [Array<AttributeValueResource>](AttributeValueResource.md)
14
+ `order` | string
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import type { ModelAttributeListResource } from '@digital8/lighting-illusions-ts-sdk'
20
+
21
+ // TODO: Update the object below with actual values
22
+ const example = {
23
+ "id": null,
24
+ "value": null,
25
+ "attribute": null,
26
+ "attributeValues": null,
27
+ "selectedValues": null,
28
+ "order": null,
29
+ } satisfies ModelAttributeListResource
30
+
31
+ console.log(example)
32
+
33
+ // Convert the instance to a JSON string
34
+ const exampleJSON: string = JSON.stringify(example)
35
+ console.log(exampleJSON)
36
+
37
+ // Parse the JSON string back to an object
38
+ const exampleParsed = JSON.parse(exampleJSON) as ModelAttributeListResource
39
+ console.log(exampleParsed)
40
+ ```
41
+
42
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
43
+
44
+
@@ -0,0 +1,34 @@
1
+
2
+ # ModelAttributeListResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ModelAttributeListResource>](ModelAttributeListResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { ModelAttributeListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies ModelAttributeListResourceArrayResponse
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 ModelAttributeListResourceArrayResponse
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
+
@@ -7,6 +7,7 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `id` | number
10
+ `order` | string
10
11
  `value` | string
11
12
  `attribute` | [AttributeLiteResource](AttributeLiteResource.md)
12
13
  `attributeValues` | [Array<AttributeValueResource>](AttributeValueResource.md)
@@ -19,6 +20,7 @@ import type { ModelAttributeResource } from '@digital8/lighting-illusions-ts-sdk
19
20
  // TODO: Update the object below with actual values
20
21
  const example = {
21
22
  "id": null,
23
+ "order": null,
22
24
  "value": null,
23
25
  "attribute": null,
24
26
  "attributeValues": null,
@@ -0,0 +1,36 @@
1
+
2
+ # PaginatedLabelListResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<LabelListResource>](LabelListResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedLabelListResourceResponse } 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 PaginatedLabelListResourceResponse
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 PaginatedLabelListResourceResponse
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
+
@@ -0,0 +1,36 @@
1
+
2
+ # PaginatedModelAttributeListResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ModelAttributeListResource>](ModelAttributeListResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedModelAttributeListResourceResponse } 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 PaginatedModelAttributeListResourceResponse
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 PaginatedModelAttributeListResourceResponse
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
+
@@ -0,0 +1,36 @@
1
+
2
+ # PaginatedProductRangeFrontendListResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductRangeFrontendListResource>](ProductRangeFrontendListResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedProductRangeFrontendListResourceResponse } 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 PaginatedProductRangeFrontendListResourceResponse
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 PaginatedProductRangeFrontendListResourceResponse
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
+
@@ -0,0 +1,36 @@
1
+
2
+ # PaginatedProductRangeListResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductRangeListResource>](ProductRangeListResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedProductRangeListResourceResponse } 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 PaginatedProductRangeListResourceResponse
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 PaginatedProductRangeListResourceResponse
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
+
@@ -0,0 +1,36 @@
1
+
2
+ # PaginatedProductRangeLiteResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductRangeLiteResource>](ProductRangeLiteResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedProductRangeLiteResourceResponse } 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 PaginatedProductRangeLiteResourceResponse
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 PaginatedProductRangeLiteResourceResponse
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
+
@@ -0,0 +1,36 @@
1
+
2
+ # PaginatedProductRangeResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductRangeResource>](ProductRangeResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedProductRangeResourceResponse } 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 PaginatedProductRangeResourceResponse
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 PaginatedProductRangeResourceResponse
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
+
@@ -0,0 +1,36 @@
1
+
2
+ # PaginatedProductRangeSearchResultResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductRangeSearchResultResource>](ProductRangeSearchResultResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedProductRangeSearchResultResourceResponse } 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 PaginatedProductRangeSearchResultResourceResponse
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 PaginatedProductRangeSearchResultResourceResponse
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
+
@@ -18,7 +18,7 @@ All URIs are relative to *http://localhost/api*
18
18
  | [**getCompatibleProductsProductChild**](ProductApi.md#getcompatibleproductsproductchild) | **POST** /admin-api/product/children/{productChild}/compatible-product/list | Auto-generated: getCompatibleProductsProductChild |
19
19
  | [**indexProduct**](ProductApi.md#indexproductoperation) | **POST** /admin-api/product/parent/list | Auto-generated: indexProduct |
20
20
  | [**indexProductChild**](ProductApi.md#indexproductchildoperation) | **POST** /admin-api/product/children/list | Auto-generated: indexProductChild |
21
- | [**showAssetsProductChild**](ProductApi.md#showassetsproductchildoperation) | **GET** /admin-api/product/children/{productChild}/assets | Auto-generated: showAssetsProductChild |
21
+ | [**showAssetsProductChild**](ProductApi.md#showassetsproductchildoperation) | **POST** /admin-api/product/children/{productChild}/assets | Auto-generated: showAssetsProductChild |
22
22
  | [**showAttributesProductChild**](ProductApi.md#showattributesproductchildoperation) | **POST** /admin-api/product/children/{productChild}/attributes | Auto-generated: showAttributesProductChild |
23
23
  | [**showProduct**](ProductApi.md#showproduct) | **GET** /admin-api/product/parent/{product} | Auto-generated: showProduct |
24
24
  | [**showProductChild**](ProductApi.md#showproductchild) | **GET** /admin-api/product/children/{productChild} | Auto-generated: showProductChild |
@@ -0,0 +1,38 @@
1
+
2
+ # ProductRangeAggregationResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `attributes` | Array<object>
10
+ `brands` | Array<object>
11
+ `categories` | Array<object>
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { ProductRangeAggregationResource } from '@digital8/lighting-illusions-ts-sdk'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "attributes": null,
21
+ "brands": null,
22
+ "categories": null,
23
+ } satisfies ProductRangeAggregationResource
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 ProductRangeAggregationResource
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
+
@@ -0,0 +1,34 @@
1
+
2
+ # ProductRangeAggregationResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductRangeAggregationResource>](ProductRangeAggregationResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { ProductRangeAggregationResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies ProductRangeAggregationResourceArrayResponse
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 ProductRangeAggregationResourceArrayResponse
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
+