@digital8/lighting-illusions-ts-sdk 0.0.982 → 0.0.983

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 (64) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +5 -3
  3. package/dist/apis/ProductCategoryApi.d.ts +23 -4
  4. package/dist/apis/ProductCategoryApi.js +71 -7
  5. package/dist/models/CategoryAutomationRuleResource.d.ts +3 -3
  6. package/dist/models/CategoryAutomationRuleResource.js +3 -5
  7. package/dist/models/GetAllProductChildRequest.d.ts +6 -0
  8. package/dist/models/GetAllProductChildRequest.js +2 -0
  9. package/dist/models/GetHierarchyProductCategoryRequest.d.ts +32 -0
  10. package/dist/models/GetHierarchyProductCategoryRequest.js +51 -0
  11. package/dist/models/IndexProductCategoryRequest.d.ts +2 -0
  12. package/dist/models/IndexProductCategoryRequest.js +3 -1
  13. package/dist/models/IndexProductChildRequest.d.ts +6 -0
  14. package/dist/models/IndexProductChildRequest.js +2 -0
  15. package/dist/models/PreviewAutomationRulesResource.d.ts +0 -6
  16. package/dist/models/PreviewAutomationRulesResource.js +0 -2
  17. package/dist/models/ProductAggregationResource.d.ts +2 -2
  18. package/dist/models/ProductCategoryResource.d.ts +6 -0
  19. package/dist/models/ProductCategoryResource.js +4 -0
  20. package/dist/models/ProductChildResource.d.ts +6 -0
  21. package/dist/models/ProductChildResource.js +4 -0
  22. package/dist/models/ProductChildSiteDetailResource.d.ts +18 -0
  23. package/dist/models/ProductChildSiteDetailResource.js +12 -0
  24. package/dist/models/StoreProductCategoryRequestAutomationRulesInner.d.ts +3 -3
  25. package/dist/models/StoreProductCategoryRequestAutomationRulesInner.js +3 -5
  26. package/dist/models/StoreProductChildRequest.d.ts +7 -1
  27. package/dist/models/StoreProductChildRequest.js +6 -4
  28. package/dist/models/StoreProductChildRequestSitesInner.d.ts +18 -0
  29. package/dist/models/StoreProductChildRequestSitesInner.js +12 -0
  30. package/dist/models/UpdateProductChildRequest.d.ts +6 -0
  31. package/dist/models/UpdateProductChildRequest.js +4 -0
  32. package/dist/models/index.d.ts +1 -0
  33. package/dist/models/index.js +1 -0
  34. package/docs/CategoryAutomationRuleResource.md +3 -3
  35. package/docs/GetAllProductChildRequest.md +2 -0
  36. package/docs/GetHierarchyProductCategoryRequest.md +34 -0
  37. package/docs/IndexProductChildRequest.md +2 -0
  38. package/docs/PreviewAutomationRulesResource.md +0 -2
  39. package/docs/ProductAggregationResource.md +1 -1
  40. package/docs/ProductCategoryApi.md +83 -6
  41. package/docs/ProductCategoryResource.md +2 -0
  42. package/docs/ProductChildResource.md +2 -0
  43. package/docs/ProductChildSiteDetailResource.md +6 -0
  44. package/docs/StoreProductCategoryRequestAutomationRulesInner.md +2 -2
  45. package/docs/StoreProductChildRequest.md +2 -0
  46. package/docs/StoreProductChildRequestSitesInner.md +6 -0
  47. package/docs/UpdateProductChildRequest.md +2 -0
  48. package/package.json +1 -1
  49. package/src/apis/ProductCategoryApi.ts +72 -6
  50. package/src/models/CategoryAutomationRuleResource.ts +6 -7
  51. package/src/models/GetAllProductChildRequest.ts +8 -0
  52. package/src/models/GetHierarchyProductCategoryRequest.ts +66 -0
  53. package/src/models/IndexProductCategoryRequest.ts +3 -1
  54. package/src/models/IndexProductChildRequest.ts +8 -0
  55. package/src/models/PreviewAutomationRulesResource.ts +0 -8
  56. package/src/models/ProductAggregationResource.ts +2 -2
  57. package/src/models/ProductCategoryResource.ts +9 -0
  58. package/src/models/ProductChildResource.ts +9 -0
  59. package/src/models/ProductChildSiteDetailResource.ts +27 -0
  60. package/src/models/StoreProductCategoryRequestAutomationRulesInner.ts +6 -7
  61. package/src/models/StoreProductChildRequest.ts +12 -4
  62. package/src/models/StoreProductChildRequestSitesInner.ts +27 -0
  63. package/src/models/UpdateProductChildRequest.ts +9 -0
  64. package/src/models/index.ts +1 -0
@@ -30,12 +30,18 @@ function instanceOfProductChildSiteDetailResource(value) {
30
30
  return false;
31
31
  if (!('name' in value) || value['name'] === undefined)
32
32
  return false;
33
+ if (!('isNameOverridden' in value) || value['isNameOverridden'] === undefined)
34
+ return false;
33
35
  if (!('slug' in value) || value['slug'] === undefined)
34
36
  return false;
37
+ if (!('isSlugOverridden' in value) || value['isSlugOverridden'] === undefined)
38
+ return false;
35
39
  if (!('description' in value) || value['description'] === undefined)
36
40
  return false;
37
41
  if (!('displayName' in value) || value['displayName'] === undefined)
38
42
  return false;
43
+ if (!('isDisplayNameOverridden' in value) || value['isDisplayNameOverridden'] === undefined)
44
+ return false;
39
45
  if (!('rrpPrice' in value) || value['rrpPrice'] === undefined)
40
46
  return false;
41
47
  if (!('salePrice' in value) || value['salePrice'] === undefined)
@@ -57,9 +63,12 @@ function ProductChildSiteDetailResourceFromJSONTyped(json, ignoreDiscriminator)
57
63
  'id': json['id'],
58
64
  'site': (0, SiteLiteResource_1.SiteLiteResourceFromJSON)(json['site']),
59
65
  'name': json['name'],
66
+ 'isNameOverridden': json['isNameOverridden'],
60
67
  'slug': json['slug'],
68
+ 'isSlugOverridden': json['isSlugOverridden'],
61
69
  'description': json['description'],
62
70
  'displayName': json['displayName'],
71
+ 'isDisplayNameOverridden': json['isDisplayNameOverridden'],
63
72
  'rrpPrice': json['rrpPrice'],
64
73
  'salePrice': json['salePrice'],
65
74
  'isDisabled': json['isDisabled'],
@@ -80,9 +89,12 @@ function ProductChildSiteDetailResourceToJSONTyped(value, ignoreDiscriminator) {
80
89
  'id': value['id'],
81
90
  'site': (0, SiteLiteResource_1.SiteLiteResourceToJSON)(value['site']),
82
91
  'name': value['name'],
92
+ 'isNameOverridden': value['isNameOverridden'],
83
93
  'slug': value['slug'],
94
+ 'isSlugOverridden': value['isSlugOverridden'],
84
95
  'description': value['description'],
85
96
  'displayName': value['displayName'],
97
+ 'isDisplayNameOverridden': value['isDisplayNameOverridden'],
86
98
  'rrpPrice': value['rrpPrice'],
87
99
  'salePrice': value['salePrice'],
88
100
  'isDisabled': value['isDisabled'],
@@ -32,7 +32,7 @@ export interface StoreProductCategoryRequestAutomationRulesInner {
32
32
  * @type {number}
33
33
  * @memberof StoreProductCategoryRequestAutomationRulesInner
34
34
  */
35
- groupId: number;
35
+ groupId?: number;
36
36
  /**
37
37
  *
38
38
  * @type {string}
@@ -47,10 +47,10 @@ export interface StoreProductCategoryRequestAutomationRulesInner {
47
47
  value?: string;
48
48
  /**
49
49
  *
50
- * @type {Array<number>}
50
+ * @type {number}
51
51
  * @memberof StoreProductCategoryRequestAutomationRulesInner
52
52
  */
53
- valueIds?: Array<number>;
53
+ valueId?: number;
54
54
  }
55
55
  /**
56
56
  * @export
@@ -50,8 +50,6 @@ function instanceOfStoreProductCategoryRequestAutomationRulesInner(value) {
50
50
  return false;
51
51
  if (!('comparisonType' in value) || value['comparisonType'] === undefined)
52
52
  return false;
53
- if (!('groupId' in value) || value['groupId'] === undefined)
54
- return false;
55
53
  return true;
56
54
  }
57
55
  function StoreProductCategoryRequestAutomationRulesInnerFromJSON(json) {
@@ -64,10 +62,10 @@ function StoreProductCategoryRequestAutomationRulesInnerFromJSONTyped(json, igno
64
62
  return {
65
63
  'fieldType': json['field_type'],
66
64
  'comparisonType': json['comparison_type'],
67
- 'groupId': json['group_id'],
65
+ 'groupId': json['group_id'] == null ? undefined : json['group_id'],
68
66
  'relatedId': json['related_id'] == null ? undefined : json['related_id'],
69
67
  'value': json['value'] == null ? undefined : json['value'],
70
- 'valueIds': json['value_ids'] == null ? undefined : json['value_ids'],
68
+ 'valueId': json['value_id'] == null ? undefined : json['value_id'],
71
69
  };
72
70
  }
73
71
  function StoreProductCategoryRequestAutomationRulesInnerToJSON(json) {
@@ -84,6 +82,6 @@ function StoreProductCategoryRequestAutomationRulesInnerToJSONTyped(value, ignor
84
82
  'group_id': value['groupId'],
85
83
  'related_id': value['relatedId'],
86
84
  'value': value['value'],
87
- 'value_ids': value['valueIds'],
85
+ 'value_id': value['valueId'],
88
86
  };
89
87
  }
@@ -60,6 +60,12 @@ export interface StoreProductChildRequest {
60
60
  * @memberof StoreProductChildRequest
61
61
  */
62
62
  warranty?: string;
63
+ /**
64
+ *
65
+ * @type {boolean}
66
+ * @memberof StoreProductChildRequest
67
+ */
68
+ isWarrantyOverridden: boolean;
63
69
  /**
64
70
  *
65
71
  * @type {boolean}
@@ -119,7 +125,7 @@ export interface StoreProductChildRequest {
119
125
  * @type {Array<StoreProductChildRequestAttributeValuesInner>}
120
126
  * @memberof StoreProductChildRequest
121
127
  */
122
- attributeValues: Array<StoreProductChildRequestAttributeValuesInner>;
128
+ attributeValues?: Array<StoreProductChildRequestAttributeValuesInner>;
123
129
  /**
124
130
  *
125
131
  * @type {Array<StoreProductChildRequestAssetsInner>}
@@ -33,6 +33,8 @@ function instanceOfStoreProductChildRequest(value) {
33
33
  return false;
34
34
  if (!('model' in value) || value['model'] === undefined)
35
35
  return false;
36
+ if (!('isWarrantyOverridden' in value) || value['isWarrantyOverridden'] === undefined)
37
+ return false;
36
38
  if (!('hideFromFrontend' in value) || value['hideFromFrontend'] === undefined)
37
39
  return false;
38
40
  if (!('excludeFromSearch' in value) || value['excludeFromSearch'] === undefined)
@@ -45,8 +47,6 @@ function instanceOfStoreProductChildRequest(value) {
45
47
  return false;
46
48
  if (!('sites' in value) || value['sites'] === undefined)
47
49
  return false;
48
- if (!('attributeValues' in value) || value['attributeValues'] === undefined)
49
- return false;
50
50
  if (!('assets' in value) || value['assets'] === undefined)
51
51
  return false;
52
52
  return true;
@@ -66,6 +66,7 @@ function StoreProductChildRequestFromJSONTyped(json, ignoreDiscriminator) {
66
66
  'newArrivalStartDate': json['new_arrival_start_date'] == null ? undefined : (new Date(json['new_arrival_start_date'])),
67
67
  'newArrivalEndDate': json['new_arrival_end_date'] == null ? undefined : (new Date(json['new_arrival_end_date'])),
68
68
  'warranty': json['warranty'] == null ? undefined : json['warranty'],
69
+ 'isWarrantyOverridden': json['is_warranty_overridden'],
69
70
  'hideFromFrontend': json['hide_from_frontend'],
70
71
  'excludeFromSearch': json['exclude_from_search'],
71
72
  'allowOversell': json['allow_oversell'],
@@ -75,7 +76,7 @@ function StoreProductChildRequestFromJSONTyped(json, ignoreDiscriminator) {
75
76
  'sites': (json['sites'].map(StoreProductChildRequestSitesInner_1.StoreProductChildRequestSitesInnerFromJSON)),
76
77
  'accessories': json['accessories'] == null ? undefined : json['accessories'],
77
78
  'compatibleProducts': json['compatible_products'] == null ? undefined : json['compatible_products'],
78
- 'attributeValues': (json['attribute_values'].map(StoreProductChildRequestAttributeValuesInner_1.StoreProductChildRequestAttributeValuesInnerFromJSON)),
79
+ 'attributeValues': json['attribute_values'] == null ? undefined : (json['attribute_values'].map(StoreProductChildRequestAttributeValuesInner_1.StoreProductChildRequestAttributeValuesInnerFromJSON)),
79
80
  'assets': (json['assets'].map(StoreProductChildRequestAssetsInner_1.StoreProductChildRequestAssetsInnerFromJSON)),
80
81
  };
81
82
  }
@@ -95,6 +96,7 @@ function StoreProductChildRequestToJSONTyped(value, ignoreDiscriminator) {
95
96
  'new_arrival_start_date': value['newArrivalStartDate'] == null ? value['newArrivalStartDate'] : value['newArrivalStartDate'].toISOString(),
96
97
  'new_arrival_end_date': value['newArrivalEndDate'] == null ? value['newArrivalEndDate'] : value['newArrivalEndDate'].toISOString(),
97
98
  'warranty': value['warranty'],
99
+ 'is_warranty_overridden': value['isWarrantyOverridden'],
98
100
  'hide_from_frontend': value['hideFromFrontend'],
99
101
  'exclude_from_search': value['excludeFromSearch'],
100
102
  'allow_oversell': value['allowOversell'],
@@ -104,7 +106,7 @@ function StoreProductChildRequestToJSONTyped(value, ignoreDiscriminator) {
104
106
  'sites': (value['sites'].map(StoreProductChildRequestSitesInner_1.StoreProductChildRequestSitesInnerToJSON)),
105
107
  'accessories': value['accessories'],
106
108
  'compatible_products': value['compatibleProducts'],
107
- 'attribute_values': (value['attributeValues'].map(StoreProductChildRequestAttributeValuesInner_1.StoreProductChildRequestAttributeValuesInnerToJSON)),
109
+ 'attribute_values': value['attributeValues'] == null ? undefined : (value['attributeValues'].map(StoreProductChildRequestAttributeValuesInner_1.StoreProductChildRequestAttributeValuesInnerToJSON)),
108
110
  'assets': (value['assets'].map(StoreProductChildRequestAssetsInner_1.StoreProductChildRequestAssetsInnerToJSON)),
109
111
  };
110
112
  }
@@ -27,12 +27,24 @@ export interface StoreProductChildRequestSitesInner {
27
27
  * @memberof StoreProductChildRequestSitesInner
28
28
  */
29
29
  name: string;
30
+ /**
31
+ *
32
+ * @type {boolean}
33
+ * @memberof StoreProductChildRequestSitesInner
34
+ */
35
+ isNameOverridden: boolean;
30
36
  /**
31
37
  *
32
38
  * @type {string}
33
39
  * @memberof StoreProductChildRequestSitesInner
34
40
  */
35
41
  displayName?: string;
42
+ /**
43
+ *
44
+ * @type {boolean}
45
+ * @memberof StoreProductChildRequestSitesInner
46
+ */
47
+ isDisplayNameOverridden: boolean;
36
48
  /**
37
49
  *
38
50
  * @type {string}
@@ -57,6 +69,12 @@ export interface StoreProductChildRequestSitesInner {
57
69
  * @memberof StoreProductChildRequestSitesInner
58
70
  */
59
71
  slug: string;
72
+ /**
73
+ *
74
+ * @type {boolean}
75
+ * @memberof StoreProductChildRequestSitesInner
76
+ */
77
+ isSlugOverridden: boolean;
60
78
  /**
61
79
  *
62
80
  * @type {Array<number>}
@@ -26,6 +26,10 @@ function instanceOfStoreProductChildRequestSitesInner(value) {
26
26
  return false;
27
27
  if (!('name' in value) || value['name'] === undefined)
28
28
  return false;
29
+ if (!('isNameOverridden' in value) || value['isNameOverridden'] === undefined)
30
+ return false;
31
+ if (!('isDisplayNameOverridden' in value) || value['isDisplayNameOverridden'] === undefined)
32
+ return false;
29
33
  if (!('description' in value) || value['description'] === undefined)
30
34
  return false;
31
35
  if (!('rrpPrice' in value) || value['rrpPrice'] === undefined)
@@ -34,6 +38,8 @@ function instanceOfStoreProductChildRequestSitesInner(value) {
34
38
  return false;
35
39
  if (!('slug' in value) || value['slug'] === undefined)
36
40
  return false;
41
+ if (!('isSlugOverridden' in value) || value['isSlugOverridden'] === undefined)
42
+ return false;
37
43
  if (!('documents' in value) || value['documents'] === undefined)
38
44
  return false;
39
45
  return true;
@@ -48,11 +54,14 @@ function StoreProductChildRequestSitesInnerFromJSONTyped(json, ignoreDiscriminat
48
54
  return {
49
55
  'siteId': json['site_id'],
50
56
  'name': json['name'],
57
+ 'isNameOverridden': json['is_name_overridden'],
51
58
  'displayName': json['display_name'] == null ? undefined : json['display_name'],
59
+ 'isDisplayNameOverridden': json['is_display_name_overridden'],
52
60
  'description': json['description'],
53
61
  'rrpPrice': json['rrp_price'],
54
62
  'salePrice': json['sale_price'],
55
63
  'slug': json['slug'],
64
+ 'isSlugOverridden': json['is_slug_overridden'],
56
65
  'documents': json['documents'],
57
66
  'seoTitle': json['seo_title'] == null ? undefined : json['seo_title'],
58
67
  'seoDescription': json['seo_description'] == null ? undefined : json['seo_description'],
@@ -69,11 +78,14 @@ function StoreProductChildRequestSitesInnerToJSONTyped(value, ignoreDiscriminato
69
78
  return {
70
79
  'site_id': value['siteId'],
71
80
  'name': value['name'],
81
+ 'is_name_overridden': value['isNameOverridden'],
72
82
  'display_name': value['displayName'],
83
+ 'is_display_name_overridden': value['isDisplayNameOverridden'],
73
84
  'description': value['description'],
74
85
  'rrp_price': value['rrpPrice'],
75
86
  'sale_price': value['salePrice'],
76
87
  'slug': value['slug'],
88
+ 'is_slug_overridden': value['isSlugOverridden'],
77
89
  'documents': value['documents'],
78
90
  'seo_title': value['seoTitle'],
79
91
  'seo_description': value['seoDescription'],
@@ -53,6 +53,12 @@ export interface UpdateProductChildRequest {
53
53
  * @memberof UpdateProductChildRequest
54
54
  */
55
55
  warranty?: string;
56
+ /**
57
+ *
58
+ * @type {boolean}
59
+ * @memberof UpdateProductChildRequest
60
+ */
61
+ isWarrantyOverridden: boolean;
56
62
  /**
57
63
  *
58
64
  * @type {boolean}
@@ -30,6 +30,8 @@ function instanceOfUpdateProductChildRequest(value) {
30
30
  return false;
31
31
  if (!('model' in value) || value['model'] === undefined)
32
32
  return false;
33
+ if (!('isWarrantyOverridden' in value) || value['isWarrantyOverridden'] === undefined)
34
+ return false;
33
35
  if (!('hideFromFrontend' in value) || value['hideFromFrontend'] === undefined)
34
36
  return false;
35
37
  if (!('excludeFromSearch' in value) || value['excludeFromSearch'] === undefined)
@@ -60,6 +62,7 @@ function UpdateProductChildRequestFromJSONTyped(json, ignoreDiscriminator) {
60
62
  'newArrivalStartDate': json['new_arrival_start_date'] == null ? undefined : (new Date(json['new_arrival_start_date'])),
61
63
  'newArrivalEndDate': json['new_arrival_end_date'] == null ? undefined : (new Date(json['new_arrival_end_date'])),
62
64
  'warranty': json['warranty'] == null ? undefined : json['warranty'],
65
+ 'isWarrantyOverridden': json['is_warranty_overridden'],
63
66
  'hideFromFrontend': json['hide_from_frontend'],
64
67
  'excludeFromSearch': json['exclude_from_search'],
65
68
  'allowOversell': json['allow_oversell'],
@@ -85,6 +88,7 @@ function UpdateProductChildRequestToJSONTyped(value, ignoreDiscriminator) {
85
88
  'new_arrival_start_date': value['newArrivalStartDate'] == null ? value['newArrivalStartDate'] : value['newArrivalStartDate'].toISOString(),
86
89
  'new_arrival_end_date': value['newArrivalEndDate'] == null ? value['newArrivalEndDate'] : value['newArrivalEndDate'].toISOString(),
87
90
  'warranty': value['warranty'],
91
+ 'is_warranty_overridden': value['isWarrantyOverridden'],
88
92
  'hide_from_frontend': value['hideFromFrontend'],
89
93
  'exclude_from_search': value['excludeFromSearch'],
90
94
  'allow_oversell': value['allowOversell'],
@@ -74,6 +74,7 @@ export * from './GetAllProductChildRequest';
74
74
  export * from './GetAllProductRequest';
75
75
  export * from './GetAllProductTypeRequest';
76
76
  export * from './GetAllSupplierRequest';
77
+ export * from './GetHierarchyProductCategoryRequest';
77
78
  export * from './GlobalSearchCategoryResource';
78
79
  export * from './GlobalSearchCategoryResourceArrayResponse';
79
80
  export * from './GlobalSearchProductResource';
@@ -92,6 +92,7 @@ __exportStar(require("./GetAllProductChildRequest"), exports);
92
92
  __exportStar(require("./GetAllProductRequest"), exports);
93
93
  __exportStar(require("./GetAllProductTypeRequest"), exports);
94
94
  __exportStar(require("./GetAllSupplierRequest"), exports);
95
+ __exportStar(require("./GetHierarchyProductCategoryRequest"), exports);
95
96
  __exportStar(require("./GlobalSearchCategoryResource"), exports);
96
97
  __exportStar(require("./GlobalSearchCategoryResourceArrayResponse"), exports);
97
98
  __exportStar(require("./GlobalSearchProductResource"), exports);
@@ -9,10 +9,10 @@ Name | Type
9
9
  `id` | number
10
10
  `fieldType` | object
11
11
  `comparisonType` | object
12
- `groupId` | number
12
+ `groupId` | string
13
13
  `relatedId` | string
14
14
  `value` | string
15
- `valueIds` | string
15
+ `valueId` | string
16
16
 
17
17
  ## Example
18
18
 
@@ -27,7 +27,7 @@ const example = {
27
27
  "groupId": null,
28
28
  "relatedId": null,
29
29
  "value": null,
30
- "valueIds": null,
30
+ "valueId": null,
31
31
  } satisfies CategoryAutomationRuleResource
32
32
 
33
33
  console.log(example)
@@ -18,6 +18,7 @@ Name | Type
18
18
  `categoryId` | Array&lt;string&gt;
19
19
  `supplierId` | Array&lt;string&gt;
20
20
  `productTypeId` | Array&lt;string&gt;
21
+ `parentIsAccessory` | Array&lt;string&gt;
21
22
 
22
23
  ## Example
23
24
 
@@ -38,6 +39,7 @@ const example = {
38
39
  "categoryId": null,
39
40
  "supplierId": null,
40
41
  "productTypeId": null,
42
+ "parentIsAccessory": null,
41
43
  } satisfies GetAllProductChildRequest
42
44
 
43
45
  console.log(example)
@@ -0,0 +1,34 @@
1
+
2
+ # GetHierarchyProductCategoryRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `siteId` | number
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { GetHierarchyProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "siteId": null,
19
+ } satisfies GetHierarchyProductCategoryRequest
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 GetHierarchyProductCategoryRequest
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
+
@@ -17,6 +17,7 @@ Name | Type
17
17
  `categoryId` | Array&lt;string&gt;
18
18
  `supplierId` | Array&lt;string&gt;
19
19
  `productTypeId` | Array&lt;string&gt;
20
+ `parentIsAccessory` | Array&lt;string&gt;
20
21
  `relatedId` | number
21
22
  `relatedType` | string
22
23
  `includesRelations` | boolean
@@ -39,6 +40,7 @@ const example = {
39
40
  "categoryId": null,
40
41
  "supplierId": null,
41
42
  "productTypeId": null,
43
+ "parentIsAccessory": null,
42
44
  "relatedId": null,
43
45
  "relatedType": null,
44
46
  "includesRelations": null,
@@ -8,7 +8,6 @@ Name | Type
8
8
  ------------ | -------------
9
9
  `count` | number
10
10
  `tooComplex` | boolean
11
- `query` | string
12
11
 
13
12
  ## Example
14
13
 
@@ -19,7 +18,6 @@ import type { PreviewAutomationRulesResource } from '@digital8/lighting-illusion
19
18
  const example = {
20
19
  "count": null,
21
20
  "tooComplex": null,
22
- "query": null,
23
21
  } satisfies PreviewAutomationRulesResource
24
22
 
25
23
  console.log(example)
@@ -6,7 +6,7 @@
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `attributes` | object
9
+ `attributes` | Array&lt;object&gt;
10
10
  `priceRanges` | Array&lt;object&gt;
11
11
  `brands` | Array&lt;object&gt;
12
12
  `ratings` | Array&lt;object&gt;
@@ -8,9 +8,10 @@ All URIs are relative to *http://localhost/api*
8
8
  | [**bulkDetachProductsProductCategory**](ProductCategoryApi.md#bulkdetachproductsproductcategory) | **DELETE** /admin-api/product-category/{productCategory}/bulk-detach-products | Auto-generated: bulkDetachProductsProductCategory |
9
9
  | [**destroyProductCategory**](ProductCategoryApi.md#destroyproductcategory) | **DELETE** /admin-api/product-category/{productCategory}/delete | Auto-generated: destroyProductCategory |
10
10
  | [**detachProductsProductCategory**](ProductCategoryApi.md#detachproductsproductcategoryoperation) | **POST** /admin-api/product-category/{productCategory}/detach-products | Auto-generated: detachProductsProductCategory |
11
+ | [**getAllChildrenProductCategory**](ProductCategoryApi.md#getallchildrenproductcategory) | **POST** /admin-api/product-category/{productCategory}/children/all | Auto-generated: getAllChildrenProductCategory |
11
12
  | [**getAllProductCategory**](ProductCategoryApi.md#getallproductcategoryoperation) | **POST** /admin-api/product-category/all | Auto-generated: getAllProductCategory |
12
13
  | [**getChildrenProductCategory**](ProductCategoryApi.md#getchildrenproductcategory) | **GET** /admin-api/product-category/{productCategory}/children | Auto-generated: getChildrenProductCategory |
13
- | [**getHierarchyProductCategory**](ProductCategoryApi.md#gethierarchyproductcategory) | **GET** /admin-api/product-category/hierarchy | Auto-generated: getHierarchyProductCategory |
14
+ | [**getHierarchyProductCategory**](ProductCategoryApi.md#gethierarchyproductcategoryoperation) | **POST** /admin-api/product-category/hierarchy | Auto-generated: getHierarchyProductCategory |
14
15
  | [**indexProductCategory**](ProductCategoryApi.md#indexproductcategoryoperation) | **POST** /admin-api/product-category/list | Auto-generated: indexProductCategory |
15
16
  | [**previewAutomationRulesProductCategory**](ProductCategoryApi.md#previewautomationrulesproductcategoryoperation) | **POST** /admin-api/product-category/preview-automation-rules | Auto-generated: previewAutomationRulesProductCategory |
16
17
  | [**showProductCategory**](ProductCategoryApi.md#showproductcategory) | **GET** /admin-api/product-category/{productCategory} | Auto-generated: showProductCategory |
@@ -285,6 +286,74 @@ No authorization required
285
286
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
286
287
 
287
288
 
289
+ ## getAllChildrenProductCategory
290
+
291
+ > ProductCategoryListResourceArrayResponse getAllChildrenProductCategory(productCategory, getAllProductCategoryRequest)
292
+
293
+ Auto-generated: getAllChildrenProductCategory
294
+
295
+ ### Example
296
+
297
+ ```ts
298
+ import {
299
+ Configuration,
300
+ ProductCategoryApi,
301
+ } from '@digital8/lighting-illusions-ts-sdk';
302
+ import type { GetAllChildrenProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
303
+
304
+ async function example() {
305
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
306
+ const api = new ProductCategoryApi();
307
+
308
+ const body = {
309
+ // number | The id of the productCategory
310
+ productCategory: 56,
311
+ // GetAllProductCategoryRequest (optional)
312
+ getAllProductCategoryRequest: ...,
313
+ } satisfies GetAllChildrenProductCategoryRequest;
314
+
315
+ try {
316
+ const data = await api.getAllChildrenProductCategory(body);
317
+ console.log(data);
318
+ } catch (error) {
319
+ console.error(error);
320
+ }
321
+ }
322
+
323
+ // Run the test
324
+ example().catch(console.error);
325
+ ```
326
+
327
+ ### Parameters
328
+
329
+
330
+ | Name | Type | Description | Notes |
331
+ |------------- | ------------- | ------------- | -------------|
332
+ | **productCategory** | `number` | The id of the productCategory | [Defaults to `undefined`] |
333
+ | **getAllProductCategoryRequest** | [GetAllProductCategoryRequest](GetAllProductCategoryRequest.md) | | [Optional] |
334
+
335
+ ### Return type
336
+
337
+ [**ProductCategoryListResourceArrayResponse**](ProductCategoryListResourceArrayResponse.md)
338
+
339
+ ### Authorization
340
+
341
+ No authorization required
342
+
343
+ ### HTTP request headers
344
+
345
+ - **Content-Type**: `application/json`
346
+ - **Accept**: `application/json`
347
+
348
+
349
+ ### HTTP response details
350
+ | Status code | Description | Response headers |
351
+ |-------------|-------------|------------------|
352
+ | **200** | Successful resource response | - |
353
+
354
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
355
+
356
+
288
357
  ## getAllProductCategory
289
358
 
290
359
  > ProductCategoryLiteResourceArrayResponse getAllProductCategory(getAllProductCategoryRequest)
@@ -420,7 +489,7 @@ No authorization required
420
489
 
421
490
  ## getHierarchyProductCategory
422
491
 
423
- > ProductCategoryHierarchyResourceArrayResponse getHierarchyProductCategory()
492
+ > ProductCategoryHierarchyResourceArrayResponse getHierarchyProductCategory(getHierarchyProductCategoryRequest)
424
493
 
425
494
  Auto-generated: getHierarchyProductCategory
426
495
 
@@ -431,14 +500,19 @@ import {
431
500
  Configuration,
432
501
  ProductCategoryApi,
433
502
  } from '@digital8/lighting-illusions-ts-sdk';
434
- import type { GetHierarchyProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
503
+ import type { GetHierarchyProductCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
435
504
 
436
505
  async function example() {
437
506
  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
438
507
  const api = new ProductCategoryApi();
439
508
 
509
+ const body = {
510
+ // GetHierarchyProductCategoryRequest (optional)
511
+ getHierarchyProductCategoryRequest: ...,
512
+ } satisfies GetHierarchyProductCategoryOperationRequest;
513
+
440
514
  try {
441
- const data = await api.getHierarchyProductCategory();
515
+ const data = await api.getHierarchyProductCategory(body);
442
516
  console.log(data);
443
517
  } catch (error) {
444
518
  console.error(error);
@@ -451,7 +525,10 @@ example().catch(console.error);
451
525
 
452
526
  ### Parameters
453
527
 
454
- This endpoint does not need any parameter.
528
+
529
+ | Name | Type | Description | Notes |
530
+ |------------- | ------------- | ------------- | -------------|
531
+ | **getHierarchyProductCategoryRequest** | [GetHierarchyProductCategoryRequest](GetHierarchyProductCategoryRequest.md) | | [Optional] |
455
532
 
456
533
  ### Return type
457
534
 
@@ -463,7 +540,7 @@ No authorization required
463
540
 
464
541
  ### HTTP request headers
465
542
 
466
- - **Content-Type**: Not defined
543
+ - **Content-Type**: `application/json`
467
544
  - **Accept**: `application/json`
468
545
 
469
546
 
@@ -21,6 +21,7 @@ Name | Type
21
21
  `site` | [SiteLiteResource](SiteLiteResource.md)
22
22
  `seo` | [Array&lt;SEOResource&gt;](SEOResource.md)
23
23
  `descriptions` | [Array&lt;DescriptionResource&gt;](DescriptionResource.md)
24
+ `linkedProductsCount` | number
24
25
 
25
26
  ## Example
26
27
 
@@ -44,6 +45,7 @@ const example = {
44
45
  "site": null,
45
46
  "seo": null,
46
47
  "descriptions": null,
48
+ "linkedProductsCount": null,
47
49
  } satisfies ProductCategoryResource
48
50
 
49
51
  console.log(example)
@@ -12,6 +12,7 @@ Name | Type
12
12
  `modelNumber` | string
13
13
  `weight` | number
14
14
  `warranty` | string
15
+ `isWarrantyOverridden` | boolean
15
16
  `stock` | number
16
17
  `sku` | number
17
18
  `buyPrice` | number
@@ -46,6 +47,7 @@ const example = {
46
47
  "modelNumber": null,
47
48
  "weight": null,
48
49
  "warranty": null,
50
+ "isWarrantyOverridden": null,
49
51
  "stock": null,
50
52
  "sku": null,
51
53
  "buyPrice": null,
@@ -9,9 +9,12 @@ Name | Type
9
9
  `id` | number
10
10
  `site` | [SiteLiteResource](SiteLiteResource.md)
11
11
  `name` | string
12
+ `isNameOverridden` | boolean
12
13
  `slug` | string
14
+ `isSlugOverridden` | boolean
13
15
  `description` | string
14
16
  `displayName` | string
17
+ `isDisplayNameOverridden` | boolean
15
18
  `rrpPrice` | number
16
19
  `salePrice` | number
17
20
  `isDisabled` | boolean
@@ -29,9 +32,12 @@ const example = {
29
32
  "id": null,
30
33
  "site": null,
31
34
  "name": null,
35
+ "isNameOverridden": null,
32
36
  "slug": null,
37
+ "isSlugOverridden": null,
33
38
  "description": null,
34
39
  "displayName": null,
40
+ "isDisplayNameOverridden": null,
35
41
  "rrpPrice": null,
36
42
  "salePrice": null,
37
43
  "isDisabled": null,
@@ -11,7 +11,7 @@ Name | Type
11
11
  `groupId` | number
12
12
  `relatedId` | string
13
13
  `value` | string
14
- `valueIds` | Array&lt;number&gt;
14
+ `valueId` | number
15
15
 
16
16
  ## Example
17
17
 
@@ -25,7 +25,7 @@ const example = {
25
25
  "groupId": null,
26
26
  "relatedId": null,
27
27
  "value": null,
28
- "valueIds": null,
28
+ "valueId": null,
29
29
  } satisfies StoreProductCategoryRequestAutomationRulesInner
30
30
 
31
31
  console.log(example)