@digital8/lighting-illusions-ts-sdk 0.0.464 → 0.0.466

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 (79) hide show
  1. package/.openapi-generator/FILES +10 -10
  2. package/README.md +24 -18
  3. package/dist/apis/AttributeApi.d.ts +31 -31
  4. package/dist/apis/AttributeApi.js +92 -92
  5. package/dist/apis/OverlayTemplateApi.d.ts +37 -37
  6. package/dist/apis/OverlayTemplateApi.js +110 -110
  7. package/dist/apis/ProductApi.d.ts +73 -1
  8. package/dist/apis/ProductApi.js +292 -0
  9. package/dist/apis/ProductTypeApi.d.ts +31 -31
  10. package/dist/apis/ProductTypeApi.js +89 -89
  11. package/dist/apis/TagApi.d.ts +25 -25
  12. package/dist/apis/TagApi.js +81 -81
  13. package/dist/models/AssetLiteResource.d.ts +6 -0
  14. package/dist/models/AssetLiteResource.js +4 -0
  15. package/dist/models/AttachAccessoriesProductChildRequest.d.ts +32 -0
  16. package/dist/models/AttachAccessoriesProductChildRequest.js +51 -0
  17. package/dist/models/AttachAssetsOverlayTemplateRequest.d.ts +32 -0
  18. package/dist/models/AttachAssetsOverlayTemplateRequest.js +51 -0
  19. package/dist/models/AttachAttributeProductTypeRequest.d.ts +48 -0
  20. package/dist/models/AttachAttributeProductTypeRequest.js +65 -0
  21. package/dist/models/AttachProductTypeAttributeRequest.d.ts +48 -0
  22. package/dist/models/AttachProductTypeAttributeRequest.js +65 -0
  23. package/dist/models/DetachAssetableOverlayTemplateRequest.d.ts +51 -0
  24. package/dist/models/{UnlinkAssetableOverlayTemplateRequest.js → DetachAssetableOverlayTemplateRequest.js} +15 -15
  25. package/dist/models/OverlayTemplateListResource.d.ts +7 -0
  26. package/dist/models/OverlayTemplateListResource.js +5 -0
  27. package/dist/models/ProductChildListResource.d.ts +12 -0
  28. package/dist/models/ProductChildListResource.js +8 -0
  29. package/dist/models/ProductTypeListResource.d.ts +6 -0
  30. package/dist/models/ProductTypeListResource.js +4 -0
  31. package/dist/models/SiteNotificationListResource.d.ts +7 -0
  32. package/dist/models/SiteNotificationListResource.js +5 -0
  33. package/dist/models/index.d.ts +5 -5
  34. package/dist/models/index.js +5 -5
  35. package/docs/AssetLiteResource.md +2 -0
  36. package/docs/{LinkProductChildrenTagRequest.md → AttachAccessoriesProductChildRequest.md} +4 -4
  37. package/docs/{LinkAssetsOverlayTemplateRequest.md → AttachAssetsOverlayTemplateRequest.md} +4 -4
  38. package/docs/{LinkAttributeProductTypeRequest.md → AttachAttributeProductTypeRequest.md} +4 -4
  39. package/docs/{LinkProductTypeAttributeRequest.md → AttachProductTypeAttributeRequest.md} +4 -4
  40. package/docs/AttributeApi.md +117 -117
  41. package/docs/{UnlinkAssetableOverlayTemplateRequest.md → DetachAssetableOverlayTemplateRequest.md} +4 -4
  42. package/docs/OverlayTemplateApi.md +115 -115
  43. package/docs/OverlayTemplateListResource.md +2 -0
  44. package/docs/ProductApi.md +414 -0
  45. package/docs/ProductChildListResource.md +4 -0
  46. package/docs/ProductTypeApi.md +94 -94
  47. package/docs/ProductTypeListResource.md +2 -0
  48. package/docs/SiteNotificationListResource.md +2 -0
  49. package/docs/TagApi.md +84 -84
  50. package/package.json +1 -1
  51. package/src/apis/AttributeApi.ts +105 -105
  52. package/src/apis/OverlayTemplateApi.ts +138 -138
  53. package/src/apis/ProductApi.ts +283 -0
  54. package/src/apis/ProductTypeApi.ts +101 -101
  55. package/src/apis/TagApi.ts +91 -91
  56. package/src/models/AssetLiteResource.ts +9 -0
  57. package/src/models/AttachAccessoriesProductChildRequest.ts +66 -0
  58. package/src/models/AttachAssetsOverlayTemplateRequest.ts +66 -0
  59. package/src/models/AttachAttributeProductTypeRequest.ts +88 -0
  60. package/src/models/AttachProductTypeAttributeRequest.ts +88 -0
  61. package/src/models/{UnlinkAssetableOverlayTemplateRequest.ts → DetachAssetableOverlayTemplateRequest.ts} +16 -16
  62. package/src/models/OverlayTemplateListResource.ts +17 -0
  63. package/src/models/ProductChildListResource.ts +18 -0
  64. package/src/models/ProductTypeListResource.ts +9 -0
  65. package/src/models/SiteNotificationListResource.ts +17 -0
  66. package/src/models/index.ts +5 -5
  67. package/dist/models/LinkAssetsOverlayTemplateRequest.d.ts +0 -32
  68. package/dist/models/LinkAssetsOverlayTemplateRequest.js +0 -51
  69. package/dist/models/LinkAttributeProductTypeRequest.d.ts +0 -48
  70. package/dist/models/LinkAttributeProductTypeRequest.js +0 -65
  71. package/dist/models/LinkProductChildrenTagRequest.d.ts +0 -32
  72. package/dist/models/LinkProductChildrenTagRequest.js +0 -51
  73. package/dist/models/LinkProductTypeAttributeRequest.d.ts +0 -48
  74. package/dist/models/LinkProductTypeAttributeRequest.js +0 -65
  75. package/dist/models/UnlinkAssetableOverlayTemplateRequest.d.ts +0 -51
  76. package/src/models/LinkAssetsOverlayTemplateRequest.ts +0 -66
  77. package/src/models/LinkAttributeProductTypeRequest.ts +0 -88
  78. package/src/models/LinkProductChildrenTagRequest.ts +0 -66
  79. package/src/models/LinkProductTypeAttributeRequest.ts +0 -88
@@ -16,6 +16,7 @@
16
16
  import * as runtime from '../runtime';
17
17
  import type {
18
18
  AssetResourceArrayResponse,
19
+ AttachAccessoriesProductChildRequest,
19
20
  GenericResponse,
20
21
  GetAllProductChildRequest,
21
22
  GetAllProductRequest,
@@ -35,6 +36,8 @@ import type {
35
36
  import {
36
37
  AssetResourceArrayResponseFromJSON,
37
38
  AssetResourceArrayResponseToJSON,
39
+ AttachAccessoriesProductChildRequestFromJSON,
40
+ AttachAccessoriesProductChildRequestToJSON,
38
41
  GenericResponseFromJSON,
39
42
  GenericResponseToJSON,
40
43
  GetAllProductChildRequestFromJSON,
@@ -67,6 +70,16 @@ import {
67
70
  UpdateProductRequestToJSON,
68
71
  } from '../models/index';
69
72
 
73
+ export interface AttachAccessoriesProductChildOperationRequest {
74
+ productChild: number;
75
+ attachAccessoriesProductChildRequest?: AttachAccessoriesProductChildRequest;
76
+ }
77
+
78
+ export interface AttachCompatibleProductsProductChildRequest {
79
+ productChild: number;
80
+ attachAccessoriesProductChildRequest?: AttachAccessoriesProductChildRequest;
81
+ }
82
+
70
83
  export interface DestroyProductRequest {
71
84
  product: number;
72
85
  }
@@ -75,6 +88,21 @@ export interface DestroyProductChildRequest {
75
88
  productChild: number;
76
89
  }
77
90
 
91
+ export interface DetachAccessoryProductChildRequest {
92
+ productChild: number;
93
+ accessory: number;
94
+ }
95
+
96
+ export interface DetachCompatibleProductProductChildRequest {
97
+ productChild: number;
98
+ compatibleProduct: number;
99
+ }
100
+
101
+ export interface GetAccessoriesProductChildRequest {
102
+ productChild: number;
103
+ indexProductChildRequest?: IndexProductChildRequest;
104
+ }
105
+
78
106
  export interface GetAllProductOperationRequest {
79
107
  getAllProductRequest?: GetAllProductRequest;
80
108
  }
@@ -83,6 +111,11 @@ export interface GetAllProductChildOperationRequest {
83
111
  getAllProductChildRequest?: GetAllProductChildRequest;
84
112
  }
85
113
 
114
+ export interface GetCompatibleProductsProductChildRequest {
115
+ productChild: number;
116
+ indexProductChildRequest?: IndexProductChildRequest;
117
+ }
118
+
86
119
  export interface IndexProductOperationRequest {
87
120
  indexProductRequest?: IndexProductRequest;
88
121
  }
@@ -126,6 +159,86 @@ export interface UpdateProductChildOperationRequest {
126
159
  */
127
160
  export class ProductApi extends runtime.BaseAPI {
128
161
 
162
+ /**
163
+ * Auto-generated: attachAccessoriesProductChild
164
+ */
165
+ async attachAccessoriesProductChildRaw(requestParameters: AttachAccessoriesProductChildOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductChildListResourceResponse>> {
166
+ if (requestParameters['productChild'] == null) {
167
+ throw new runtime.RequiredError(
168
+ 'productChild',
169
+ 'Required parameter "productChild" was null or undefined when calling attachAccessoriesProductChild().'
170
+ );
171
+ }
172
+
173
+ const queryParameters: any = {};
174
+
175
+ const headerParameters: runtime.HTTPHeaders = {};
176
+
177
+ headerParameters['Content-Type'] = 'application/json';
178
+
179
+
180
+ let urlPath = `/admin-api/product/children/{productChild}/accessory/attach`;
181
+ urlPath = urlPath.replace(`{${"productChild"}}`, encodeURIComponent(String(requestParameters['productChild'])));
182
+
183
+ const response = await this.request({
184
+ path: urlPath,
185
+ method: 'POST',
186
+ headers: headerParameters,
187
+ query: queryParameters,
188
+ body: AttachAccessoriesProductChildRequestToJSON(requestParameters['attachAccessoriesProductChildRequest']),
189
+ }, initOverrides);
190
+
191
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedProductChildListResourceResponseFromJSON(jsonValue));
192
+ }
193
+
194
+ /**
195
+ * Auto-generated: attachAccessoriesProductChild
196
+ */
197
+ async attachAccessoriesProductChild(requestParameters: AttachAccessoriesProductChildOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductChildListResourceResponse> {
198
+ const response = await this.attachAccessoriesProductChildRaw(requestParameters, initOverrides);
199
+ return await response.value();
200
+ }
201
+
202
+ /**
203
+ * Auto-generated: attachCompatibleProductsProductChild
204
+ */
205
+ async attachCompatibleProductsProductChildRaw(requestParameters: AttachCompatibleProductsProductChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductChildListResourceResponse>> {
206
+ if (requestParameters['productChild'] == null) {
207
+ throw new runtime.RequiredError(
208
+ 'productChild',
209
+ 'Required parameter "productChild" was null or undefined when calling attachCompatibleProductsProductChild().'
210
+ );
211
+ }
212
+
213
+ const queryParameters: any = {};
214
+
215
+ const headerParameters: runtime.HTTPHeaders = {};
216
+
217
+ headerParameters['Content-Type'] = 'application/json';
218
+
219
+
220
+ let urlPath = `/admin-api/product/children/{productChild}/compatible-product/attach`;
221
+ urlPath = urlPath.replace(`{${"productChild"}}`, encodeURIComponent(String(requestParameters['productChild'])));
222
+
223
+ const response = await this.request({
224
+ path: urlPath,
225
+ method: 'POST',
226
+ headers: headerParameters,
227
+ query: queryParameters,
228
+ body: AttachAccessoriesProductChildRequestToJSON(requestParameters['attachAccessoriesProductChildRequest']),
229
+ }, initOverrides);
230
+
231
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedProductChildListResourceResponseFromJSON(jsonValue));
232
+ }
233
+
234
+ /**
235
+ * Auto-generated: attachCompatibleProductsProductChild
236
+ */
237
+ async attachCompatibleProductsProductChild(requestParameters: AttachCompatibleProductsProductChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductChildListResourceResponse> {
238
+ const response = await this.attachCompatibleProductsProductChildRaw(requestParameters, initOverrides);
239
+ return await response.value();
240
+ }
241
+
129
242
  /**
130
243
  * Auto-generated: destroyProduct
131
244
  */
@@ -200,6 +313,136 @@ export class ProductApi extends runtime.BaseAPI {
200
313
  return await response.value();
201
314
  }
202
315
 
316
+ /**
317
+ * Auto-generated: detachAccessoryProductChild
318
+ */
319
+ async detachAccessoryProductChildRaw(requestParameters: DetachAccessoryProductChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductChildListResourceResponse>> {
320
+ if (requestParameters['productChild'] == null) {
321
+ throw new runtime.RequiredError(
322
+ 'productChild',
323
+ 'Required parameter "productChild" was null or undefined when calling detachAccessoryProductChild().'
324
+ );
325
+ }
326
+
327
+ if (requestParameters['accessory'] == null) {
328
+ throw new runtime.RequiredError(
329
+ 'accessory',
330
+ 'Required parameter "accessory" was null or undefined when calling detachAccessoryProductChild().'
331
+ );
332
+ }
333
+
334
+ const queryParameters: any = {};
335
+
336
+ const headerParameters: runtime.HTTPHeaders = {};
337
+
338
+
339
+ let urlPath = `/admin-api/product/children/{productChild}/accessory/detach/{accessory}`;
340
+ urlPath = urlPath.replace(`{${"productChild"}}`, encodeURIComponent(String(requestParameters['productChild'])));
341
+ urlPath = urlPath.replace(`{${"accessory"}}`, encodeURIComponent(String(requestParameters['accessory'])));
342
+
343
+ const response = await this.request({
344
+ path: urlPath,
345
+ method: 'DELETE',
346
+ headers: headerParameters,
347
+ query: queryParameters,
348
+ }, initOverrides);
349
+
350
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedProductChildListResourceResponseFromJSON(jsonValue));
351
+ }
352
+
353
+ /**
354
+ * Auto-generated: detachAccessoryProductChild
355
+ */
356
+ async detachAccessoryProductChild(requestParameters: DetachAccessoryProductChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductChildListResourceResponse> {
357
+ const response = await this.detachAccessoryProductChildRaw(requestParameters, initOverrides);
358
+ return await response.value();
359
+ }
360
+
361
+ /**
362
+ * Auto-generated: detachCompatibleProductProductChild
363
+ */
364
+ async detachCompatibleProductProductChildRaw(requestParameters: DetachCompatibleProductProductChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductChildListResourceResponse>> {
365
+ if (requestParameters['productChild'] == null) {
366
+ throw new runtime.RequiredError(
367
+ 'productChild',
368
+ 'Required parameter "productChild" was null or undefined when calling detachCompatibleProductProductChild().'
369
+ );
370
+ }
371
+
372
+ if (requestParameters['compatibleProduct'] == null) {
373
+ throw new runtime.RequiredError(
374
+ 'compatibleProduct',
375
+ 'Required parameter "compatibleProduct" was null or undefined when calling detachCompatibleProductProductChild().'
376
+ );
377
+ }
378
+
379
+ const queryParameters: any = {};
380
+
381
+ const headerParameters: runtime.HTTPHeaders = {};
382
+
383
+
384
+ let urlPath = `/admin-api/product/children/{productChild}/compatible-product/detach/{compatibleProduct}`;
385
+ urlPath = urlPath.replace(`{${"productChild"}}`, encodeURIComponent(String(requestParameters['productChild'])));
386
+ urlPath = urlPath.replace(`{${"compatibleProduct"}}`, encodeURIComponent(String(requestParameters['compatibleProduct'])));
387
+
388
+ const response = await this.request({
389
+ path: urlPath,
390
+ method: 'DELETE',
391
+ headers: headerParameters,
392
+ query: queryParameters,
393
+ }, initOverrides);
394
+
395
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedProductChildListResourceResponseFromJSON(jsonValue));
396
+ }
397
+
398
+ /**
399
+ * Auto-generated: detachCompatibleProductProductChild
400
+ */
401
+ async detachCompatibleProductProductChild(requestParameters: DetachCompatibleProductProductChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductChildListResourceResponse> {
402
+ const response = await this.detachCompatibleProductProductChildRaw(requestParameters, initOverrides);
403
+ return await response.value();
404
+ }
405
+
406
+ /**
407
+ * Auto-generated: getAccessoriesProductChild
408
+ */
409
+ async getAccessoriesProductChildRaw(requestParameters: GetAccessoriesProductChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductChildListResourceResponse>> {
410
+ if (requestParameters['productChild'] == null) {
411
+ throw new runtime.RequiredError(
412
+ 'productChild',
413
+ 'Required parameter "productChild" was null or undefined when calling getAccessoriesProductChild().'
414
+ );
415
+ }
416
+
417
+ const queryParameters: any = {};
418
+
419
+ const headerParameters: runtime.HTTPHeaders = {};
420
+
421
+ headerParameters['Content-Type'] = 'application/json';
422
+
423
+
424
+ let urlPath = `/admin-api/product/children/{productChild}/accessory/list`;
425
+ urlPath = urlPath.replace(`{${"productChild"}}`, encodeURIComponent(String(requestParameters['productChild'])));
426
+
427
+ const response = await this.request({
428
+ path: urlPath,
429
+ method: 'POST',
430
+ headers: headerParameters,
431
+ query: queryParameters,
432
+ body: IndexProductChildRequestToJSON(requestParameters['indexProductChildRequest']),
433
+ }, initOverrides);
434
+
435
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedProductChildListResourceResponseFromJSON(jsonValue));
436
+ }
437
+
438
+ /**
439
+ * Auto-generated: getAccessoriesProductChild
440
+ */
441
+ async getAccessoriesProductChild(requestParameters: GetAccessoriesProductChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductChildListResourceResponse> {
442
+ const response = await this.getAccessoriesProductChildRaw(requestParameters, initOverrides);
443
+ return await response.value();
444
+ }
445
+
203
446
  /**
204
447
  * Auto-generated: getAllProduct
205
448
  */
@@ -264,6 +507,46 @@ export class ProductApi extends runtime.BaseAPI {
264
507
  return await response.value();
265
508
  }
266
509
 
510
+ /**
511
+ * Auto-generated: getCompatibleProductsProductChild
512
+ */
513
+ async getCompatibleProductsProductChildRaw(requestParameters: GetCompatibleProductsProductChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductChildListResourceResponse>> {
514
+ if (requestParameters['productChild'] == null) {
515
+ throw new runtime.RequiredError(
516
+ 'productChild',
517
+ 'Required parameter "productChild" was null or undefined when calling getCompatibleProductsProductChild().'
518
+ );
519
+ }
520
+
521
+ const queryParameters: any = {};
522
+
523
+ const headerParameters: runtime.HTTPHeaders = {};
524
+
525
+ headerParameters['Content-Type'] = 'application/json';
526
+
527
+
528
+ let urlPath = `/admin-api/product/children/{productChild}/compatible-product/list`;
529
+ urlPath = urlPath.replace(`{${"productChild"}}`, encodeURIComponent(String(requestParameters['productChild'])));
530
+
531
+ const response = await this.request({
532
+ path: urlPath,
533
+ method: 'POST',
534
+ headers: headerParameters,
535
+ query: queryParameters,
536
+ body: IndexProductChildRequestToJSON(requestParameters['indexProductChildRequest']),
537
+ }, initOverrides);
538
+
539
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedProductChildListResourceResponseFromJSON(jsonValue));
540
+ }
541
+
542
+ /**
543
+ * Auto-generated: getCompatibleProductsProductChild
544
+ */
545
+ async getCompatibleProductsProductChild(requestParameters: GetCompatibleProductsProductChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductChildListResourceResponse> {
546
+ const response = await this.getCompatibleProductsProductChildRaw(requestParameters, initOverrides);
547
+ return await response.value();
548
+ }
549
+
267
550
  /**
268
551
  * Auto-generated: indexProduct
269
552
  */