@digital8/lighting-illusions-ts-sdk 0.0.708 → 0.0.710

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 (149) hide show
  1. package/.openapi-generator/FILES +56 -0
  2. package/README.md +43 -2
  3. package/dist/apis/ProductRangeApi.d.ts +181 -0
  4. package/dist/apis/ProductRangeApi.js +739 -0
  5. package/dist/apis/index.d.ts +1 -0
  6. package/dist/apis/index.js +1 -0
  7. package/dist/models/AttachAccessoriesProductRangeRequest.d.ts +32 -0
  8. package/dist/models/AttachAccessoriesProductRangeRequest.js +51 -0
  9. package/dist/models/AttachAttributesProductRangeRequest.d.ts +32 -0
  10. package/dist/models/AttachAttributesProductRangeRequest.js +51 -0
  11. package/dist/models/AttachDocumentablesDocumentRequestDocumentablesInner.d.ts +1 -0
  12. package/dist/models/AttachDocumentablesDocumentRequestDocumentablesInner.js +1 -0
  13. package/dist/models/AttachDocumentsProductRangeRequest.d.ts +33 -0
  14. package/dist/models/AttachDocumentsProductRangeRequest.js +52 -0
  15. package/dist/models/DetachAccessoriesProductRangeRequest.d.ts +32 -0
  16. package/dist/models/DetachAccessoriesProductRangeRequest.js +51 -0
  17. package/dist/models/DetachAttributesProductRangeRequest.d.ts +32 -0
  18. package/dist/models/DetachAttributesProductRangeRequest.js +51 -0
  19. package/dist/models/DetachDocumentablesDocumentRequestDocumentablesInner.d.ts +1 -0
  20. package/dist/models/DetachDocumentablesDocumentRequestDocumentablesInner.js +1 -0
  21. package/dist/models/DetachDocumentsProductRangeRequest.d.ts +32 -0
  22. package/dist/models/DetachDocumentsProductRangeRequest.js +51 -0
  23. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  24. package/dist/models/ExternalApiLogResource.js +1 -3
  25. package/dist/models/GetAllDocumentRequest.d.ts +1 -0
  26. package/dist/models/GetAllDocumentRequest.js +1 -0
  27. package/dist/models/GetAllProductChildRequest.d.ts +1 -0
  28. package/dist/models/GetAllProductChildRequest.js +1 -0
  29. package/dist/models/GetAllProductRangeRequest.d.ts +98 -0
  30. package/dist/models/GetAllProductRangeRequest.js +82 -0
  31. package/dist/models/IndexAttributeRequest.d.ts +2 -0
  32. package/dist/models/IndexAttributeRequest.js +3 -1
  33. package/dist/models/IndexDocumentRequest.d.ts +1 -0
  34. package/dist/models/IndexDocumentRequest.js +1 -0
  35. package/dist/models/IndexProductChildRequest.d.ts +1 -0
  36. package/dist/models/IndexProductChildRequest.js +1 -0
  37. package/dist/models/IndexProductRangeRequest.d.ts +110 -0
  38. package/dist/models/IndexProductRangeRequest.js +86 -0
  39. package/dist/models/PaginatedProductRangeFrontendListResourceResponse.d.ts +40 -0
  40. package/dist/models/PaginatedProductRangeFrontendListResourceResponse.js +57 -0
  41. package/dist/models/PaginatedProductRangeListResourceResponse.d.ts +40 -0
  42. package/dist/models/PaginatedProductRangeListResourceResponse.js +57 -0
  43. package/dist/models/PaginatedProductRangeLiteResourceResponse.d.ts +40 -0
  44. package/dist/models/PaginatedProductRangeLiteResourceResponse.js +57 -0
  45. package/dist/models/PaginatedProductRangeResourceResponse.d.ts +40 -0
  46. package/dist/models/PaginatedProductRangeResourceResponse.js +57 -0
  47. package/dist/models/ProductChildResource.d.ts +7 -1
  48. package/dist/models/ProductChildResource.js +4 -2
  49. package/dist/models/ProductRangeFrontendListResource.d.ts +62 -0
  50. package/dist/models/ProductRangeFrontendListResource.js +71 -0
  51. package/dist/models/ProductRangeFrontendListResourceArrayResponse.d.ts +33 -0
  52. package/dist/models/ProductRangeFrontendListResourceArrayResponse.js +50 -0
  53. package/dist/models/ProductRangeFrontendResource.d.ts +118 -0
  54. package/dist/models/ProductRangeFrontendResource.js +109 -0
  55. package/dist/models/ProductRangeFrontendResourceArrayResponse.d.ts +33 -0
  56. package/dist/models/ProductRangeFrontendResourceArrayResponse.js +50 -0
  57. package/dist/models/ProductRangeListResource.d.ts +52 -0
  58. package/dist/models/ProductRangeListResource.js +65 -0
  59. package/dist/models/ProductRangeListResourceArrayResponse.d.ts +33 -0
  60. package/dist/models/ProductRangeListResourceArrayResponse.js +50 -0
  61. package/dist/models/ProductRangeLiteResource.d.ts +38 -0
  62. package/dist/models/ProductRangeLiteResource.js +55 -0
  63. package/dist/models/ProductRangeLiteResourceArrayResponse.d.ts +33 -0
  64. package/dist/models/ProductRangeLiteResourceArrayResponse.js +50 -0
  65. package/dist/models/ProductRangeResource.d.ts +83 -0
  66. package/dist/models/ProductRangeResource.js +82 -0
  67. package/dist/models/ProductRangeResourceArrayResponse.d.ts +33 -0
  68. package/dist/models/ProductRangeResourceArrayResponse.js +50 -0
  69. package/dist/models/ProductRangeSiteDetailResource.d.ts +94 -0
  70. package/dist/models/ProductRangeSiteDetailResource.js +93 -0
  71. package/dist/models/ProductRangeSiteDetailResourceArrayResponse.d.ts +33 -0
  72. package/dist/models/ProductRangeSiteDetailResourceArrayResponse.js +50 -0
  73. package/dist/models/StoreProductRangeRequest.d.ts +52 -0
  74. package/dist/models/StoreProductRangeRequest.js +59 -0
  75. package/dist/models/StoreProductRangeRequestSitesInner.d.ts +92 -0
  76. package/dist/models/StoreProductRangeRequestSitesInner.js +75 -0
  77. package/dist/models/UpdateProductRangeRequest.d.ts +52 -0
  78. package/dist/models/UpdateProductRangeRequest.js +59 -0
  79. package/dist/models/index.d.ts +27 -0
  80. package/dist/models/index.js +27 -0
  81. package/docs/AttachAccessoriesProductRangeRequest.md +34 -0
  82. package/docs/AttachAttributesProductRangeRequest.md +34 -0
  83. package/docs/AttachDocumentsProductRangeRequest.md +34 -0
  84. package/docs/DetachAccessoriesProductRangeRequest.md +34 -0
  85. package/docs/DetachAttributesProductRangeRequest.md +34 -0
  86. package/docs/DetachDocumentsProductRangeRequest.md +34 -0
  87. package/docs/GetAllProductRangeRequest.md +50 -0
  88. package/docs/IndexProductRangeRequest.md +54 -0
  89. package/docs/PaginatedProductRangeFrontendListResourceResponse.md +36 -0
  90. package/docs/PaginatedProductRangeListResourceResponse.md +36 -0
  91. package/docs/PaginatedProductRangeLiteResourceResponse.md +36 -0
  92. package/docs/PaginatedProductRangeResourceResponse.md +36 -0
  93. package/docs/ProductChildResource.md +4 -2
  94. package/docs/ProductRangeApi.md +959 -0
  95. package/docs/ProductRangeFrontendListResource.md +44 -0
  96. package/docs/ProductRangeFrontendListResourceArrayResponse.md +34 -0
  97. package/docs/ProductRangeFrontendResource.md +62 -0
  98. package/docs/ProductRangeFrontendResourceArrayResponse.md +34 -0
  99. package/docs/ProductRangeListResource.md +40 -0
  100. package/docs/ProductRangeListResourceArrayResponse.md +34 -0
  101. package/docs/ProductRangeLiteResource.md +36 -0
  102. package/docs/ProductRangeLiteResourceArrayResponse.md +34 -0
  103. package/docs/ProductRangeResource.md +50 -0
  104. package/docs/ProductRangeResourceArrayResponse.md +34 -0
  105. package/docs/ProductRangeSiteDetailResource.md +54 -0
  106. package/docs/ProductRangeSiteDetailResourceArrayResponse.md +34 -0
  107. package/docs/StoreProductRangeRequest.md +40 -0
  108. package/docs/StoreProductRangeRequestSitesInner.md +54 -0
  109. package/docs/UpdateProductRangeRequest.md +40 -0
  110. package/package.json +1 -1
  111. package/src/apis/ProductRangeApi.ts +664 -0
  112. package/src/apis/index.ts +1 -0
  113. package/src/models/AttachAccessoriesProductRangeRequest.ts +66 -0
  114. package/src/models/AttachAttributesProductRangeRequest.ts +66 -0
  115. package/src/models/AttachDocumentablesDocumentRequestDocumentablesInner.ts +1 -0
  116. package/src/models/AttachDocumentsProductRangeRequest.ts +74 -0
  117. package/src/models/DetachAccessoriesProductRangeRequest.ts +66 -0
  118. package/src/models/DetachAttributesProductRangeRequest.ts +66 -0
  119. package/src/models/DetachDocumentablesDocumentRequestDocumentablesInner.ts +1 -0
  120. package/src/models/DetachDocumentsProductRangeRequest.ts +66 -0
  121. package/src/models/ExternalApiLogResource.ts +2 -3
  122. package/src/models/GetAllDocumentRequest.ts +1 -0
  123. package/src/models/GetAllProductChildRequest.ts +1 -0
  124. package/src/models/GetAllProductRangeRequest.ts +151 -0
  125. package/src/models/IndexAttributeRequest.ts +3 -1
  126. package/src/models/IndexDocumentRequest.ts +1 -0
  127. package/src/models/IndexProductChildRequest.ts +1 -0
  128. package/src/models/IndexProductRangeRequest.ts +167 -0
  129. package/src/models/PaginatedProductRangeFrontendListResourceResponse.ts +90 -0
  130. package/src/models/PaginatedProductRangeListResourceResponse.ts +90 -0
  131. package/src/models/PaginatedProductRangeLiteResourceResponse.ts +90 -0
  132. package/src/models/PaginatedProductRangeResourceResponse.ts +90 -0
  133. package/src/models/ProductChildResource.ts +11 -3
  134. package/src/models/ProductRangeFrontendListResource.ts +111 -0
  135. package/src/models/ProductRangeFrontendListResourceArrayResponse.ts +73 -0
  136. package/src/models/ProductRangeFrontendResource.ts +207 -0
  137. package/src/models/ProductRangeFrontendResourceArrayResponse.ts +73 -0
  138. package/src/models/ProductRangeListResource.ts +108 -0
  139. package/src/models/ProductRangeListResourceArrayResponse.ts +73 -0
  140. package/src/models/ProductRangeLiteResource.ts +75 -0
  141. package/src/models/ProductRangeLiteResourceArrayResponse.ts +73 -0
  142. package/src/models/ProductRangeResource.ts +158 -0
  143. package/src/models/ProductRangeResourceArrayResponse.ts +73 -0
  144. package/src/models/ProductRangeSiteDetailResource.ts +171 -0
  145. package/src/models/ProductRangeSiteDetailResourceArrayResponse.ts +73 -0
  146. package/src/models/StoreProductRangeRequest.ts +105 -0
  147. package/src/models/StoreProductRangeRequestSitesInner.ts +148 -0
  148. package/src/models/UpdateProductRangeRequest.ts +105 -0
  149. package/src/models/index.ts +27 -0
@@ -0,0 +1,959 @@
1
+ # ProductRangeApi
2
+
3
+ All URIs are relative to *http://localhost/api*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**attachAccessoriesProductRange**](ProductRangeApi.md#attachaccessoriesproductrangeoperation) | **POST** /admin-api/product-range/{productRange}/attach-accessories | Auto-generated: attachAccessoriesProductRange |
8
+ | [**attachAttributesProductRange**](ProductRangeApi.md#attachattributesproductrangeoperation) | **POST** /admin-api/product-range/{productRange}/attach-attributes | Auto-generated: attachAttributesProductRange |
9
+ | [**attachDocumentsProductRange**](ProductRangeApi.md#attachdocumentsproductrangeoperation) | **POST** /admin-api/product-range/{productRange}/attach-documents | Auto-generated: attachDocumentsProductRange |
10
+ | [**attachProductChildrenProductRange**](ProductRangeApi.md#attachproductchildrenproductrange) | **POST** /admin-api/product-range/{productRange}/attach-products | Auto-generated: attachProductChildrenProductRange |
11
+ | [**destroyProductRange**](ProductRangeApi.md#destroyproductrange) | **DELETE** /admin-api/product-range/{productRange}/delete | Auto-generated: destroyProductRange |
12
+ | [**detachAccessoriesProductRange**](ProductRangeApi.md#detachaccessoriesproductrangeoperation) | **POST** /admin-api/product-range/{productRange}/detach-accessories | Auto-generated: detachAccessoriesProductRange |
13
+ | [**detachAttributesProductRange**](ProductRangeApi.md#detachattributesproductrangeoperation) | **POST** /admin-api/product-range/{productRange}/detach-attributes | Auto-generated: detachAttributesProductRange |
14
+ | [**detachDocumentsProductRange**](ProductRangeApi.md#detachdocumentsproductrangeoperation) | **POST** /admin-api/product-range/{productRange}/detach-documents | Auto-generated: detachDocumentsProductRange |
15
+ | [**detachProductChildrenProductRange**](ProductRangeApi.md#detachproductchildrenproductrange) | **POST** /admin-api/product-range/{productRange}/detach-products | Auto-generated: detachProductChildrenProductRange |
16
+ | [**getAllProductRange**](ProductRangeApi.md#getallproductrangeoperation) | **POST** /admin-api/product-range/all | Auto-generated: getAllProductRange |
17
+ | [**indexProductRange**](ProductRangeApi.md#indexproductrangeoperation) | **POST** /admin-api/product-range/list | Auto-generated: indexProductRange |
18
+ | [**showProductRange**](ProductRangeApi.md#showproductrange) | **GET** /admin-api/product-range/{productRange} | Auto-generated: showProductRange |
19
+ | [**storeProductRange**](ProductRangeApi.md#storeproductrangeoperation) | **POST** /admin-api/product-range/create | Auto-generated: storeProductRange |
20
+ | [**updateProductRange**](ProductRangeApi.md#updateproductrangeoperation) | **PUT** /admin-api/product-range/{productRange}/update | Auto-generated: updateProductRange |
21
+
22
+
23
+
24
+ ## attachAccessoriesProductRange
25
+
26
+ > ProductRangeResource attachAccessoriesProductRange(productRange, attachAccessoriesProductRangeRequest)
27
+
28
+ Auto-generated: attachAccessoriesProductRange
29
+
30
+ ### Example
31
+
32
+ ```ts
33
+ import {
34
+ Configuration,
35
+ ProductRangeApi,
36
+ } from '@digital8/lighting-illusions-ts-sdk';
37
+ import type { AttachAccessoriesProductRangeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
38
+
39
+ async function example() {
40
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
41
+ const api = new ProductRangeApi();
42
+
43
+ const body = {
44
+ // number | The id of the productRange
45
+ productRange: 56,
46
+ // AttachAccessoriesProductRangeRequest (optional)
47
+ attachAccessoriesProductRangeRequest: ...,
48
+ } satisfies AttachAccessoriesProductRangeOperationRequest;
49
+
50
+ try {
51
+ const data = await api.attachAccessoriesProductRange(body);
52
+ console.log(data);
53
+ } catch (error) {
54
+ console.error(error);
55
+ }
56
+ }
57
+
58
+ // Run the test
59
+ example().catch(console.error);
60
+ ```
61
+
62
+ ### Parameters
63
+
64
+
65
+ | Name | Type | Description | Notes |
66
+ |------------- | ------------- | ------------- | -------------|
67
+ | **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
68
+ | **attachAccessoriesProductRangeRequest** | [AttachAccessoriesProductRangeRequest](AttachAccessoriesProductRangeRequest.md) | | [Optional] |
69
+
70
+ ### Return type
71
+
72
+ [**ProductRangeResource**](ProductRangeResource.md)
73
+
74
+ ### Authorization
75
+
76
+ No authorization required
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: `application/json`
81
+ - **Accept**: `application/json`
82
+
83
+
84
+ ### HTTP response details
85
+ | Status code | Description | Response headers |
86
+ |-------------|-------------|------------------|
87
+ | **200** | Successful resource response | - |
88
+
89
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
90
+
91
+
92
+ ## attachAttributesProductRange
93
+
94
+ > ProductRangeResource attachAttributesProductRange(productRange, attachAttributesProductRangeRequest)
95
+
96
+ Auto-generated: attachAttributesProductRange
97
+
98
+ ### Example
99
+
100
+ ```ts
101
+ import {
102
+ Configuration,
103
+ ProductRangeApi,
104
+ } from '@digital8/lighting-illusions-ts-sdk';
105
+ import type { AttachAttributesProductRangeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
106
+
107
+ async function example() {
108
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
109
+ const api = new ProductRangeApi();
110
+
111
+ const body = {
112
+ // number | The id of the productRange
113
+ productRange: 56,
114
+ // AttachAttributesProductRangeRequest (optional)
115
+ attachAttributesProductRangeRequest: ...,
116
+ } satisfies AttachAttributesProductRangeOperationRequest;
117
+
118
+ try {
119
+ const data = await api.attachAttributesProductRange(body);
120
+ console.log(data);
121
+ } catch (error) {
122
+ console.error(error);
123
+ }
124
+ }
125
+
126
+ // Run the test
127
+ example().catch(console.error);
128
+ ```
129
+
130
+ ### Parameters
131
+
132
+
133
+ | Name | Type | Description | Notes |
134
+ |------------- | ------------- | ------------- | -------------|
135
+ | **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
136
+ | **attachAttributesProductRangeRequest** | [AttachAttributesProductRangeRequest](AttachAttributesProductRangeRequest.md) | | [Optional] |
137
+
138
+ ### Return type
139
+
140
+ [**ProductRangeResource**](ProductRangeResource.md)
141
+
142
+ ### Authorization
143
+
144
+ No authorization required
145
+
146
+ ### HTTP request headers
147
+
148
+ - **Content-Type**: `application/json`
149
+ - **Accept**: `application/json`
150
+
151
+
152
+ ### HTTP response details
153
+ | Status code | Description | Response headers |
154
+ |-------------|-------------|------------------|
155
+ | **200** | Successful resource response | - |
156
+
157
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
158
+
159
+
160
+ ## attachDocumentsProductRange
161
+
162
+ > ProductRangeResource attachDocumentsProductRange(productRange, attachDocumentsProductRangeRequest)
163
+
164
+ Auto-generated: attachDocumentsProductRange
165
+
166
+ ### Example
167
+
168
+ ```ts
169
+ import {
170
+ Configuration,
171
+ ProductRangeApi,
172
+ } from '@digital8/lighting-illusions-ts-sdk';
173
+ import type { AttachDocumentsProductRangeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
174
+
175
+ async function example() {
176
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
177
+ const api = new ProductRangeApi();
178
+
179
+ const body = {
180
+ // number | The id of the productRange
181
+ productRange: 56,
182
+ // AttachDocumentsProductRangeRequest (optional)
183
+ attachDocumentsProductRangeRequest: ...,
184
+ } satisfies AttachDocumentsProductRangeOperationRequest;
185
+
186
+ try {
187
+ const data = await api.attachDocumentsProductRange(body);
188
+ console.log(data);
189
+ } catch (error) {
190
+ console.error(error);
191
+ }
192
+ }
193
+
194
+ // Run the test
195
+ example().catch(console.error);
196
+ ```
197
+
198
+ ### Parameters
199
+
200
+
201
+ | Name | Type | Description | Notes |
202
+ |------------- | ------------- | ------------- | -------------|
203
+ | **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
204
+ | **attachDocumentsProductRangeRequest** | [AttachDocumentsProductRangeRequest](AttachDocumentsProductRangeRequest.md) | | [Optional] |
205
+
206
+ ### Return type
207
+
208
+ [**ProductRangeResource**](ProductRangeResource.md)
209
+
210
+ ### Authorization
211
+
212
+ No authorization required
213
+
214
+ ### HTTP request headers
215
+
216
+ - **Content-Type**: `application/json`
217
+ - **Accept**: `application/json`
218
+
219
+
220
+ ### HTTP response details
221
+ | Status code | Description | Response headers |
222
+ |-------------|-------------|------------------|
223
+ | **200** | Successful resource response | - |
224
+
225
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
226
+
227
+
228
+ ## attachProductChildrenProductRange
229
+
230
+ > ProductRangeResource attachProductChildrenProductRange(productRange, attachAccessoriesProductRangeRequest)
231
+
232
+ Auto-generated: attachProductChildrenProductRange
233
+
234
+ ### Example
235
+
236
+ ```ts
237
+ import {
238
+ Configuration,
239
+ ProductRangeApi,
240
+ } from '@digital8/lighting-illusions-ts-sdk';
241
+ import type { AttachProductChildrenProductRangeRequest } from '@digital8/lighting-illusions-ts-sdk';
242
+
243
+ async function example() {
244
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
245
+ const api = new ProductRangeApi();
246
+
247
+ const body = {
248
+ // number | The id of the productRange
249
+ productRange: 56,
250
+ // AttachAccessoriesProductRangeRequest (optional)
251
+ attachAccessoriesProductRangeRequest: ...,
252
+ } satisfies AttachProductChildrenProductRangeRequest;
253
+
254
+ try {
255
+ const data = await api.attachProductChildrenProductRange(body);
256
+ console.log(data);
257
+ } catch (error) {
258
+ console.error(error);
259
+ }
260
+ }
261
+
262
+ // Run the test
263
+ example().catch(console.error);
264
+ ```
265
+
266
+ ### Parameters
267
+
268
+
269
+ | Name | Type | Description | Notes |
270
+ |------------- | ------------- | ------------- | -------------|
271
+ | **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
272
+ | **attachAccessoriesProductRangeRequest** | [AttachAccessoriesProductRangeRequest](AttachAccessoriesProductRangeRequest.md) | | [Optional] |
273
+
274
+ ### Return type
275
+
276
+ [**ProductRangeResource**](ProductRangeResource.md)
277
+
278
+ ### Authorization
279
+
280
+ No authorization required
281
+
282
+ ### HTTP request headers
283
+
284
+ - **Content-Type**: `application/json`
285
+ - **Accept**: `application/json`
286
+
287
+
288
+ ### HTTP response details
289
+ | Status code | Description | Response headers |
290
+ |-------------|-------------|------------------|
291
+ | **200** | Successful resource response | - |
292
+
293
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
294
+
295
+
296
+ ## destroyProductRange
297
+
298
+ > GenericResponse destroyProductRange(productRange)
299
+
300
+ Auto-generated: destroyProductRange
301
+
302
+ ### Example
303
+
304
+ ```ts
305
+ import {
306
+ Configuration,
307
+ ProductRangeApi,
308
+ } from '@digital8/lighting-illusions-ts-sdk';
309
+ import type { DestroyProductRangeRequest } from '@digital8/lighting-illusions-ts-sdk';
310
+
311
+ async function example() {
312
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
313
+ const api = new ProductRangeApi();
314
+
315
+ const body = {
316
+ // number | The id of the productRange
317
+ productRange: 56,
318
+ } satisfies DestroyProductRangeRequest;
319
+
320
+ try {
321
+ const data = await api.destroyProductRange(body);
322
+ console.log(data);
323
+ } catch (error) {
324
+ console.error(error);
325
+ }
326
+ }
327
+
328
+ // Run the test
329
+ example().catch(console.error);
330
+ ```
331
+
332
+ ### Parameters
333
+
334
+
335
+ | Name | Type | Description | Notes |
336
+ |------------- | ------------- | ------------- | -------------|
337
+ | **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
338
+
339
+ ### Return type
340
+
341
+ [**GenericResponse**](GenericResponse.md)
342
+
343
+ ### Authorization
344
+
345
+ No authorization required
346
+
347
+ ### HTTP request headers
348
+
349
+ - **Content-Type**: Not defined
350
+ - **Accept**: `application/json`
351
+
352
+
353
+ ### HTTP response details
354
+ | Status code | Description | Response headers |
355
+ |-------------|-------------|------------------|
356
+ | **200** | \\JsonResponse | - |
357
+
358
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
359
+
360
+
361
+ ## detachAccessoriesProductRange
362
+
363
+ > ProductRangeResource detachAccessoriesProductRange(productRange, detachAccessoriesProductRangeRequest)
364
+
365
+ Auto-generated: detachAccessoriesProductRange
366
+
367
+ ### Example
368
+
369
+ ```ts
370
+ import {
371
+ Configuration,
372
+ ProductRangeApi,
373
+ } from '@digital8/lighting-illusions-ts-sdk';
374
+ import type { DetachAccessoriesProductRangeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
375
+
376
+ async function example() {
377
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
378
+ const api = new ProductRangeApi();
379
+
380
+ const body = {
381
+ // number | The id of the productRange
382
+ productRange: 56,
383
+ // DetachAccessoriesProductRangeRequest (optional)
384
+ detachAccessoriesProductRangeRequest: ...,
385
+ } satisfies DetachAccessoriesProductRangeOperationRequest;
386
+
387
+ try {
388
+ const data = await api.detachAccessoriesProductRange(body);
389
+ console.log(data);
390
+ } catch (error) {
391
+ console.error(error);
392
+ }
393
+ }
394
+
395
+ // Run the test
396
+ example().catch(console.error);
397
+ ```
398
+
399
+ ### Parameters
400
+
401
+
402
+ | Name | Type | Description | Notes |
403
+ |------------- | ------------- | ------------- | -------------|
404
+ | **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
405
+ | **detachAccessoriesProductRangeRequest** | [DetachAccessoriesProductRangeRequest](DetachAccessoriesProductRangeRequest.md) | | [Optional] |
406
+
407
+ ### Return type
408
+
409
+ [**ProductRangeResource**](ProductRangeResource.md)
410
+
411
+ ### Authorization
412
+
413
+ No authorization required
414
+
415
+ ### HTTP request headers
416
+
417
+ - **Content-Type**: `application/json`
418
+ - **Accept**: `application/json`
419
+
420
+
421
+ ### HTTP response details
422
+ | Status code | Description | Response headers |
423
+ |-------------|-------------|------------------|
424
+ | **200** | Successful resource response | - |
425
+
426
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
427
+
428
+
429
+ ## detachAttributesProductRange
430
+
431
+ > ProductRangeResource detachAttributesProductRange(productRange, detachAttributesProductRangeRequest)
432
+
433
+ Auto-generated: detachAttributesProductRange
434
+
435
+ ### Example
436
+
437
+ ```ts
438
+ import {
439
+ Configuration,
440
+ ProductRangeApi,
441
+ } from '@digital8/lighting-illusions-ts-sdk';
442
+ import type { DetachAttributesProductRangeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
443
+
444
+ async function example() {
445
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
446
+ const api = new ProductRangeApi();
447
+
448
+ const body = {
449
+ // number | The id of the productRange
450
+ productRange: 56,
451
+ // DetachAttributesProductRangeRequest (optional)
452
+ detachAttributesProductRangeRequest: ...,
453
+ } satisfies DetachAttributesProductRangeOperationRequest;
454
+
455
+ try {
456
+ const data = await api.detachAttributesProductRange(body);
457
+ console.log(data);
458
+ } catch (error) {
459
+ console.error(error);
460
+ }
461
+ }
462
+
463
+ // Run the test
464
+ example().catch(console.error);
465
+ ```
466
+
467
+ ### Parameters
468
+
469
+
470
+ | Name | Type | Description | Notes |
471
+ |------------- | ------------- | ------------- | -------------|
472
+ | **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
473
+ | **detachAttributesProductRangeRequest** | [DetachAttributesProductRangeRequest](DetachAttributesProductRangeRequest.md) | | [Optional] |
474
+
475
+ ### Return type
476
+
477
+ [**ProductRangeResource**](ProductRangeResource.md)
478
+
479
+ ### Authorization
480
+
481
+ No authorization required
482
+
483
+ ### HTTP request headers
484
+
485
+ - **Content-Type**: `application/json`
486
+ - **Accept**: `application/json`
487
+
488
+
489
+ ### HTTP response details
490
+ | Status code | Description | Response headers |
491
+ |-------------|-------------|------------------|
492
+ | **200** | Successful resource response | - |
493
+
494
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
495
+
496
+
497
+ ## detachDocumentsProductRange
498
+
499
+ > ProductRangeResource detachDocumentsProductRange(productRange, detachDocumentsProductRangeRequest)
500
+
501
+ Auto-generated: detachDocumentsProductRange
502
+
503
+ ### Example
504
+
505
+ ```ts
506
+ import {
507
+ Configuration,
508
+ ProductRangeApi,
509
+ } from '@digital8/lighting-illusions-ts-sdk';
510
+ import type { DetachDocumentsProductRangeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
511
+
512
+ async function example() {
513
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
514
+ const api = new ProductRangeApi();
515
+
516
+ const body = {
517
+ // number | The id of the productRange
518
+ productRange: 56,
519
+ // DetachDocumentsProductRangeRequest (optional)
520
+ detachDocumentsProductRangeRequest: ...,
521
+ } satisfies DetachDocumentsProductRangeOperationRequest;
522
+
523
+ try {
524
+ const data = await api.detachDocumentsProductRange(body);
525
+ console.log(data);
526
+ } catch (error) {
527
+ console.error(error);
528
+ }
529
+ }
530
+
531
+ // Run the test
532
+ example().catch(console.error);
533
+ ```
534
+
535
+ ### Parameters
536
+
537
+
538
+ | Name | Type | Description | Notes |
539
+ |------------- | ------------- | ------------- | -------------|
540
+ | **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
541
+ | **detachDocumentsProductRangeRequest** | [DetachDocumentsProductRangeRequest](DetachDocumentsProductRangeRequest.md) | | [Optional] |
542
+
543
+ ### Return type
544
+
545
+ [**ProductRangeResource**](ProductRangeResource.md)
546
+
547
+ ### Authorization
548
+
549
+ No authorization required
550
+
551
+ ### HTTP request headers
552
+
553
+ - **Content-Type**: `application/json`
554
+ - **Accept**: `application/json`
555
+
556
+
557
+ ### HTTP response details
558
+ | Status code | Description | Response headers |
559
+ |-------------|-------------|------------------|
560
+ | **200** | Successful resource response | - |
561
+
562
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
563
+
564
+
565
+ ## detachProductChildrenProductRange
566
+
567
+ > ProductRangeResource detachProductChildrenProductRange(productRange, detachAccessoriesProductRangeRequest)
568
+
569
+ Auto-generated: detachProductChildrenProductRange
570
+
571
+ ### Example
572
+
573
+ ```ts
574
+ import {
575
+ Configuration,
576
+ ProductRangeApi,
577
+ } from '@digital8/lighting-illusions-ts-sdk';
578
+ import type { DetachProductChildrenProductRangeRequest } from '@digital8/lighting-illusions-ts-sdk';
579
+
580
+ async function example() {
581
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
582
+ const api = new ProductRangeApi();
583
+
584
+ const body = {
585
+ // number | The id of the productRange
586
+ productRange: 56,
587
+ // DetachAccessoriesProductRangeRequest (optional)
588
+ detachAccessoriesProductRangeRequest: ...,
589
+ } satisfies DetachProductChildrenProductRangeRequest;
590
+
591
+ try {
592
+ const data = await api.detachProductChildrenProductRange(body);
593
+ console.log(data);
594
+ } catch (error) {
595
+ console.error(error);
596
+ }
597
+ }
598
+
599
+ // Run the test
600
+ example().catch(console.error);
601
+ ```
602
+
603
+ ### Parameters
604
+
605
+
606
+ | Name | Type | Description | Notes |
607
+ |------------- | ------------- | ------------- | -------------|
608
+ | **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
609
+ | **detachAccessoriesProductRangeRequest** | [DetachAccessoriesProductRangeRequest](DetachAccessoriesProductRangeRequest.md) | | [Optional] |
610
+
611
+ ### Return type
612
+
613
+ [**ProductRangeResource**](ProductRangeResource.md)
614
+
615
+ ### Authorization
616
+
617
+ No authorization required
618
+
619
+ ### HTTP request headers
620
+
621
+ - **Content-Type**: `application/json`
622
+ - **Accept**: `application/json`
623
+
624
+
625
+ ### HTTP response details
626
+ | Status code | Description | Response headers |
627
+ |-------------|-------------|------------------|
628
+ | **200** | Successful resource response | - |
629
+
630
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
631
+
632
+
633
+ ## getAllProductRange
634
+
635
+ > ProductRangeLiteResourceArrayResponse getAllProductRange(getAllProductRangeRequest)
636
+
637
+ Auto-generated: getAllProductRange
638
+
639
+ ### Example
640
+
641
+ ```ts
642
+ import {
643
+ Configuration,
644
+ ProductRangeApi,
645
+ } from '@digital8/lighting-illusions-ts-sdk';
646
+ import type { GetAllProductRangeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
647
+
648
+ async function example() {
649
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
650
+ const api = new ProductRangeApi();
651
+
652
+ const body = {
653
+ // GetAllProductRangeRequest (optional)
654
+ getAllProductRangeRequest: ...,
655
+ } satisfies GetAllProductRangeOperationRequest;
656
+
657
+ try {
658
+ const data = await api.getAllProductRange(body);
659
+ console.log(data);
660
+ } catch (error) {
661
+ console.error(error);
662
+ }
663
+ }
664
+
665
+ // Run the test
666
+ example().catch(console.error);
667
+ ```
668
+
669
+ ### Parameters
670
+
671
+
672
+ | Name | Type | Description | Notes |
673
+ |------------- | ------------- | ------------- | -------------|
674
+ | **getAllProductRangeRequest** | [GetAllProductRangeRequest](GetAllProductRangeRequest.md) | | [Optional] |
675
+
676
+ ### Return type
677
+
678
+ [**ProductRangeLiteResourceArrayResponse**](ProductRangeLiteResourceArrayResponse.md)
679
+
680
+ ### Authorization
681
+
682
+ No authorization required
683
+
684
+ ### HTTP request headers
685
+
686
+ - **Content-Type**: `application/json`
687
+ - **Accept**: `application/json`
688
+
689
+
690
+ ### HTTP response details
691
+ | Status code | Description | Response headers |
692
+ |-------------|-------------|------------------|
693
+ | **200** | Successful resource response | - |
694
+
695
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
696
+
697
+
698
+ ## indexProductRange
699
+
700
+ > PaginatedProductRangeListResourceResponse indexProductRange(indexProductRangeRequest)
701
+
702
+ Auto-generated: indexProductRange
703
+
704
+ ### Example
705
+
706
+ ```ts
707
+ import {
708
+ Configuration,
709
+ ProductRangeApi,
710
+ } from '@digital8/lighting-illusions-ts-sdk';
711
+ import type { IndexProductRangeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
712
+
713
+ async function example() {
714
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
715
+ const api = new ProductRangeApi();
716
+
717
+ const body = {
718
+ // IndexProductRangeRequest (optional)
719
+ indexProductRangeRequest: ...,
720
+ } satisfies IndexProductRangeOperationRequest;
721
+
722
+ try {
723
+ const data = await api.indexProductRange(body);
724
+ console.log(data);
725
+ } catch (error) {
726
+ console.error(error);
727
+ }
728
+ }
729
+
730
+ // Run the test
731
+ example().catch(console.error);
732
+ ```
733
+
734
+ ### Parameters
735
+
736
+
737
+ | Name | Type | Description | Notes |
738
+ |------------- | ------------- | ------------- | -------------|
739
+ | **indexProductRangeRequest** | [IndexProductRangeRequest](IndexProductRangeRequest.md) | | [Optional] |
740
+
741
+ ### Return type
742
+
743
+ [**PaginatedProductRangeListResourceResponse**](PaginatedProductRangeListResourceResponse.md)
744
+
745
+ ### Authorization
746
+
747
+ No authorization required
748
+
749
+ ### HTTP request headers
750
+
751
+ - **Content-Type**: `application/json`
752
+ - **Accept**: `application/json`
753
+
754
+
755
+ ### HTTP response details
756
+ | Status code | Description | Response headers |
757
+ |-------------|-------------|------------------|
758
+ | **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductRangeListResource[]>> | - |
759
+
760
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
761
+
762
+
763
+ ## showProductRange
764
+
765
+ > ProductRangeResource showProductRange(productRange)
766
+
767
+ Auto-generated: showProductRange
768
+
769
+ ### Example
770
+
771
+ ```ts
772
+ import {
773
+ Configuration,
774
+ ProductRangeApi,
775
+ } from '@digital8/lighting-illusions-ts-sdk';
776
+ import type { ShowProductRangeRequest } from '@digital8/lighting-illusions-ts-sdk';
777
+
778
+ async function example() {
779
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
780
+ const api = new ProductRangeApi();
781
+
782
+ const body = {
783
+ // number | The id of the productRange
784
+ productRange: 56,
785
+ } satisfies ShowProductRangeRequest;
786
+
787
+ try {
788
+ const data = await api.showProductRange(body);
789
+ console.log(data);
790
+ } catch (error) {
791
+ console.error(error);
792
+ }
793
+ }
794
+
795
+ // Run the test
796
+ example().catch(console.error);
797
+ ```
798
+
799
+ ### Parameters
800
+
801
+
802
+ | Name | Type | Description | Notes |
803
+ |------------- | ------------- | ------------- | -------------|
804
+ | **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
805
+
806
+ ### Return type
807
+
808
+ [**ProductRangeResource**](ProductRangeResource.md)
809
+
810
+ ### Authorization
811
+
812
+ No authorization required
813
+
814
+ ### HTTP request headers
815
+
816
+ - **Content-Type**: Not defined
817
+ - **Accept**: `application/json`
818
+
819
+
820
+ ### HTTP response details
821
+ | Status code | Description | Response headers |
822
+ |-------------|-------------|------------------|
823
+ | **200** | Successful resource response | - |
824
+
825
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
826
+
827
+
828
+ ## storeProductRange
829
+
830
+ > ProductRangeResource storeProductRange(storeProductRangeRequest)
831
+
832
+ Auto-generated: storeProductRange
833
+
834
+ ### Example
835
+
836
+ ```ts
837
+ import {
838
+ Configuration,
839
+ ProductRangeApi,
840
+ } from '@digital8/lighting-illusions-ts-sdk';
841
+ import type { StoreProductRangeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
842
+
843
+ async function example() {
844
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
845
+ const api = new ProductRangeApi();
846
+
847
+ const body = {
848
+ // StoreProductRangeRequest (optional)
849
+ storeProductRangeRequest: ...,
850
+ } satisfies StoreProductRangeOperationRequest;
851
+
852
+ try {
853
+ const data = await api.storeProductRange(body);
854
+ console.log(data);
855
+ } catch (error) {
856
+ console.error(error);
857
+ }
858
+ }
859
+
860
+ // Run the test
861
+ example().catch(console.error);
862
+ ```
863
+
864
+ ### Parameters
865
+
866
+
867
+ | Name | Type | Description | Notes |
868
+ |------------- | ------------- | ------------- | -------------|
869
+ | **storeProductRangeRequest** | [StoreProductRangeRequest](StoreProductRangeRequest.md) | | [Optional] |
870
+
871
+ ### Return type
872
+
873
+ [**ProductRangeResource**](ProductRangeResource.md)
874
+
875
+ ### Authorization
876
+
877
+ No authorization required
878
+
879
+ ### HTTP request headers
880
+
881
+ - **Content-Type**: `application/json`
882
+ - **Accept**: `application/json`
883
+
884
+
885
+ ### HTTP response details
886
+ | Status code | Description | Response headers |
887
+ |-------------|-------------|------------------|
888
+ | **200** | Successful resource response | - |
889
+
890
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
891
+
892
+
893
+ ## updateProductRange
894
+
895
+ > ProductRangeResource updateProductRange(productRange, updateProductRangeRequest)
896
+
897
+ Auto-generated: updateProductRange
898
+
899
+ ### Example
900
+
901
+ ```ts
902
+ import {
903
+ Configuration,
904
+ ProductRangeApi,
905
+ } from '@digital8/lighting-illusions-ts-sdk';
906
+ import type { UpdateProductRangeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
907
+
908
+ async function example() {
909
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
910
+ const api = new ProductRangeApi();
911
+
912
+ const body = {
913
+ // number | The id of the productRange
914
+ productRange: 56,
915
+ // UpdateProductRangeRequest (optional)
916
+ updateProductRangeRequest: ...,
917
+ } satisfies UpdateProductRangeOperationRequest;
918
+
919
+ try {
920
+ const data = await api.updateProductRange(body);
921
+ console.log(data);
922
+ } catch (error) {
923
+ console.error(error);
924
+ }
925
+ }
926
+
927
+ // Run the test
928
+ example().catch(console.error);
929
+ ```
930
+
931
+ ### Parameters
932
+
933
+
934
+ | Name | Type | Description | Notes |
935
+ |------------- | ------------- | ------------- | -------------|
936
+ | **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
937
+ | **updateProductRangeRequest** | [UpdateProductRangeRequest](UpdateProductRangeRequest.md) | | [Optional] |
938
+
939
+ ### Return type
940
+
941
+ [**ProductRangeResource**](ProductRangeResource.md)
942
+
943
+ ### Authorization
944
+
945
+ No authorization required
946
+
947
+ ### HTTP request headers
948
+
949
+ - **Content-Type**: `application/json`
950
+ - **Accept**: `application/json`
951
+
952
+
953
+ ### HTTP response details
954
+ | Status code | Description | Response headers |
955
+ |-------------|-------------|------------------|
956
+ | **200** | Successful resource response | - |
957
+
958
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
959
+