@digital8/lighting-illusions-ts-sdk 0.0.992 → 0.0.994
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.
- package/.openapi-generator/FILES +6 -0
- package/README.md +8 -3
- package/dist/apis/AttributeApi.d.ts +16 -1
- package/dist/apis/AttributeApi.js +58 -0
- package/dist/apis/ProductCategoryApi.d.ts +23 -4
- package/dist/apis/ProductCategoryApi.js +71 -7
- package/dist/models/CategoryAutomationRuleResource.d.ts +3 -3
- package/dist/models/CategoryAutomationRuleResource.js +3 -5
- package/dist/models/GetAllProductChildRequest.d.ts +6 -0
- package/dist/models/GetAllProductChildRequest.js +2 -0
- package/dist/models/GetHierarchyProductCategoryRequest.d.ts +32 -0
- package/dist/models/GetHierarchyProductCategoryRequest.js +51 -0
- package/dist/models/IndexAttributeValueRequest.d.ts +105 -0
- package/dist/models/IndexAttributeValueRequest.js +88 -0
- package/dist/models/IndexProductCategoryRequest.d.ts +2 -0
- package/dist/models/IndexProductCategoryRequest.js +3 -1
- package/dist/models/IndexProductChildRequest.d.ts +6 -0
- package/dist/models/IndexProductChildRequest.js +2 -0
- package/dist/models/PaginatedAttributeValueResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedAttributeValueResourceResponse.js +57 -0
- package/dist/models/PreviewAutomationRulesResource.d.ts +0 -6
- package/dist/models/PreviewAutomationRulesResource.js +0 -2
- package/dist/models/ProductAggregationResource.d.ts +2 -2
- package/dist/models/ProductCategoryResource.d.ts +6 -0
- package/dist/models/ProductCategoryResource.js +4 -0
- package/dist/models/ProductChildResource.d.ts +6 -0
- package/dist/models/ProductChildResource.js +4 -0
- package/dist/models/ProductChildSiteDetailResource.d.ts +18 -0
- package/dist/models/ProductChildSiteDetailResource.js +12 -0
- package/dist/models/StoreProductCategoryRequestAutomationRulesInner.d.ts +3 -3
- package/dist/models/StoreProductCategoryRequestAutomationRulesInner.js +3 -5
- package/dist/models/StoreProductChildRequest.d.ts +7 -1
- package/dist/models/StoreProductChildRequest.js +6 -4
- package/dist/models/StoreProductChildRequestSitesInner.d.ts +18 -0
- package/dist/models/StoreProductChildRequestSitesInner.js +12 -0
- package/dist/models/UpdateProductChildRequest.d.ts +12 -0
- package/dist/models/UpdateProductChildRequest.js +6 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/docs/AttributeApi.md +66 -0
- package/docs/CategoryAutomationRuleResource.md +3 -3
- package/docs/GetAllProductChildRequest.md +2 -0
- package/docs/GetHierarchyProductCategoryRequest.md +34 -0
- package/docs/IndexAttributeValueRequest.md +50 -0
- package/docs/IndexProductChildRequest.md +2 -0
- package/docs/PaginatedAttributeValueResourceResponse.md +36 -0
- package/docs/PreviewAutomationRulesResource.md +0 -2
- package/docs/ProductAggregationResource.md +1 -1
- package/docs/ProductCategoryApi.md +83 -6
- package/docs/ProductCategoryResource.md +2 -0
- package/docs/ProductChildResource.md +2 -0
- package/docs/ProductChildSiteDetailResource.md +6 -0
- package/docs/StoreProductCategoryRequestAutomationRulesInner.md +2 -2
- package/docs/StoreProductChildRequest.md +2 -0
- package/docs/StoreProductChildRequestSitesInner.md +6 -0
- package/docs/UpdateProductChildRequest.md +4 -0
- package/package.json +1 -1
- package/src/apis/AttributeApi.ts +50 -0
- package/src/apis/ProductCategoryApi.ts +72 -6
- package/src/models/CategoryAutomationRuleResource.ts +6 -7
- package/src/models/GetAllProductChildRequest.ts +8 -0
- package/src/models/GetHierarchyProductCategoryRequest.ts +66 -0
- package/src/models/IndexAttributeValueRequest.ts +159 -0
- package/src/models/IndexProductCategoryRequest.ts +3 -1
- package/src/models/IndexProductChildRequest.ts +8 -0
- package/src/models/PaginatedAttributeValueResourceResponse.ts +90 -0
- package/src/models/PreviewAutomationRulesResource.ts +0 -8
- package/src/models/ProductAggregationResource.ts +2 -2
- package/src/models/ProductCategoryResource.ts +9 -0
- package/src/models/ProductChildResource.ts +9 -0
- package/src/models/ProductChildSiteDetailResource.ts +27 -0
- package/src/models/StoreProductCategoryRequestAutomationRulesInner.ts +6 -7
- package/src/models/StoreProductChildRequest.ts +12 -4
- package/src/models/StoreProductChildRequestSitesInner.ts +27 -0
- package/src/models/UpdateProductChildRequest.ts +17 -0
- package/src/models/index.ts +3 -0
|
@@ -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}
|
|
@@ -95,6 +101,12 @@ export interface UpdateProductChildRequest {
|
|
|
95
101
|
* @memberof UpdateProductChildRequest
|
|
96
102
|
*/
|
|
97
103
|
sites: Array<StoreProductChildRequestSitesInner>;
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @type {Array<number>}
|
|
107
|
+
* @memberof UpdateProductChildRequest
|
|
108
|
+
*/
|
|
109
|
+
accessories?: Array<number>;
|
|
98
110
|
/**
|
|
99
111
|
*
|
|
100
112
|
* @type {Array<UpdateProductChildRequestAssetsInner>}
|
|
@@ -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'],
|
|
@@ -67,6 +70,7 @@ function UpdateProductChildRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
67
70
|
'popularityScore': json['popularity_score'] == null ? undefined : json['popularity_score'],
|
|
68
71
|
'stock': json['stock'],
|
|
69
72
|
'sites': (json['sites'].map(StoreProductChildRequestSitesInner_1.StoreProductChildRequestSitesInnerFromJSON)),
|
|
73
|
+
'accessories': json['accessories'] == null ? undefined : json['accessories'],
|
|
70
74
|
'assets': (json['assets'].map(UpdateProductChildRequestAssetsInner_1.UpdateProductChildRequestAssetsInnerFromJSON)),
|
|
71
75
|
};
|
|
72
76
|
}
|
|
@@ -85,6 +89,7 @@ function UpdateProductChildRequestToJSONTyped(value, ignoreDiscriminator) {
|
|
|
85
89
|
'new_arrival_start_date': value['newArrivalStartDate'] == null ? value['newArrivalStartDate'] : value['newArrivalStartDate'].toISOString(),
|
|
86
90
|
'new_arrival_end_date': value['newArrivalEndDate'] == null ? value['newArrivalEndDate'] : value['newArrivalEndDate'].toISOString(),
|
|
87
91
|
'warranty': value['warranty'],
|
|
92
|
+
'is_warranty_overridden': value['isWarrantyOverridden'],
|
|
88
93
|
'hide_from_frontend': value['hideFromFrontend'],
|
|
89
94
|
'exclude_from_search': value['excludeFromSearch'],
|
|
90
95
|
'allow_oversell': value['allowOversell'],
|
|
@@ -92,6 +97,7 @@ function UpdateProductChildRequestToJSONTyped(value, ignoreDiscriminator) {
|
|
|
92
97
|
'popularity_score': value['popularityScore'],
|
|
93
98
|
'stock': value['stock'],
|
|
94
99
|
'sites': (value['sites'].map(StoreProductChildRequestSitesInner_1.StoreProductChildRequestSitesInnerToJSON)),
|
|
100
|
+
'accessories': value['accessories'],
|
|
95
101
|
'assets': (value['assets'].map(UpdateProductChildRequestAssetsInner_1.UpdateProductChildRequestAssetsInnerToJSON)),
|
|
96
102
|
};
|
|
97
103
|
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -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';
|
|
@@ -85,6 +86,7 @@ export * from './GlobalSearchResponseResourceArrayResponse';
|
|
|
85
86
|
export * from './GoogleCategoryResource';
|
|
86
87
|
export * from './GoogleCategoryResourceArrayResponse';
|
|
87
88
|
export * from './IndexAttributeRequest';
|
|
89
|
+
export * from './IndexAttributeValueRequest';
|
|
88
90
|
export * from './IndexDefinitionRequest';
|
|
89
91
|
export * from './IndexDocumentRequest';
|
|
90
92
|
export * from './IndexExternalApiLogRequest';
|
|
@@ -114,6 +116,7 @@ export * from './PaginatedAttributeListResourceResponse';
|
|
|
114
116
|
export * from './PaginatedAttributeLiteResourceResponse';
|
|
115
117
|
export * from './PaginatedAttributeProductTypeRelationResourceResponse';
|
|
116
118
|
export * from './PaginatedAttributeResourceResponse';
|
|
119
|
+
export * from './PaginatedAttributeValueResourceResponse';
|
|
117
120
|
export * from './PaginatedCategoryFrontendResourceResponse';
|
|
118
121
|
export * from './PaginatedDefinitionListResourceResponse';
|
|
119
122
|
export * from './PaginatedDefinitionResourceResponse';
|
package/dist/models/index.js
CHANGED
|
@@ -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);
|
|
@@ -103,6 +104,7 @@ __exportStar(require("./GlobalSearchResponseResourceArrayResponse"), exports);
|
|
|
103
104
|
__exportStar(require("./GoogleCategoryResource"), exports);
|
|
104
105
|
__exportStar(require("./GoogleCategoryResourceArrayResponse"), exports);
|
|
105
106
|
__exportStar(require("./IndexAttributeRequest"), exports);
|
|
107
|
+
__exportStar(require("./IndexAttributeValueRequest"), exports);
|
|
106
108
|
__exportStar(require("./IndexDefinitionRequest"), exports);
|
|
107
109
|
__exportStar(require("./IndexDocumentRequest"), exports);
|
|
108
110
|
__exportStar(require("./IndexExternalApiLogRequest"), exports);
|
|
@@ -132,6 +134,7 @@ __exportStar(require("./PaginatedAttributeListResourceResponse"), exports);
|
|
|
132
134
|
__exportStar(require("./PaginatedAttributeLiteResourceResponse"), exports);
|
|
133
135
|
__exportStar(require("./PaginatedAttributeProductTypeRelationResourceResponse"), exports);
|
|
134
136
|
__exportStar(require("./PaginatedAttributeResourceResponse"), exports);
|
|
137
|
+
__exportStar(require("./PaginatedAttributeValueResourceResponse"), exports);
|
|
135
138
|
__exportStar(require("./PaginatedCategoryFrontendResourceResponse"), exports);
|
|
136
139
|
__exportStar(require("./PaginatedDefinitionListResourceResponse"), exports);
|
|
137
140
|
__exportStar(require("./PaginatedDefinitionResourceResponse"), exports);
|
package/docs/AttributeApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
10
10
|
| [**detachProductTypeAttribute**](AttributeApi.md#detachproducttypeattribute) | **POST** /admin-api/attribute/{attribute}/detach-product-type/{productType} | Auto-generated: detachProductTypeAttribute |
|
|
11
11
|
| [**getAllAttribute**](AttributeApi.md#getallattributeoperation) | **POST** /admin-api/attribute/all | Auto-generated: getAllAttribute |
|
|
12
12
|
| [**indexAttribute**](AttributeApi.md#indexattributeoperation) | **POST** /admin-api/attribute/list | Auto-generated: indexAttribute |
|
|
13
|
+
| [**indexAttributeValue**](AttributeApi.md#indexattributevalueoperation) | **POST** /admin-api/attribute/value/list | Auto-generated: indexAttributeValue |
|
|
13
14
|
| [**showAttribute**](AttributeApi.md#showattribute) | **GET** /admin-api/attribute/{attribute} | Auto-generated: showAttribute |
|
|
14
15
|
| [**storeAttribute**](AttributeApi.md#storeattributeoperation) | **POST** /admin-api/attribute/create | Auto-generated: storeAttribute |
|
|
15
16
|
| [**storeAttributeValue**](AttributeApi.md#storeattributevalueoperation) | **POST** /admin-api/attribute/value/create | Auto-generated: storeAttributeValue |
|
|
@@ -420,6 +421,71 @@ No authorization required
|
|
|
420
421
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
421
422
|
|
|
422
423
|
|
|
424
|
+
## indexAttributeValue
|
|
425
|
+
|
|
426
|
+
> PaginatedAttributeValueResourceResponse indexAttributeValue(indexAttributeValueRequest)
|
|
427
|
+
|
|
428
|
+
Auto-generated: indexAttributeValue
|
|
429
|
+
|
|
430
|
+
### Example
|
|
431
|
+
|
|
432
|
+
```ts
|
|
433
|
+
import {
|
|
434
|
+
Configuration,
|
|
435
|
+
AttributeApi,
|
|
436
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
437
|
+
import type { IndexAttributeValueOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
438
|
+
|
|
439
|
+
async function example() {
|
|
440
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
441
|
+
const api = new AttributeApi();
|
|
442
|
+
|
|
443
|
+
const body = {
|
|
444
|
+
// IndexAttributeValueRequest (optional)
|
|
445
|
+
indexAttributeValueRequest: ...,
|
|
446
|
+
} satisfies IndexAttributeValueOperationRequest;
|
|
447
|
+
|
|
448
|
+
try {
|
|
449
|
+
const data = await api.indexAttributeValue(body);
|
|
450
|
+
console.log(data);
|
|
451
|
+
} catch (error) {
|
|
452
|
+
console.error(error);
|
|
453
|
+
}
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
// Run the test
|
|
457
|
+
example().catch(console.error);
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
### Parameters
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
| Name | Type | Description | Notes |
|
|
464
|
+
|------------- | ------------- | ------------- | -------------|
|
|
465
|
+
| **indexAttributeValueRequest** | [IndexAttributeValueRequest](IndexAttributeValueRequest.md) | | [Optional] |
|
|
466
|
+
|
|
467
|
+
### Return type
|
|
468
|
+
|
|
469
|
+
[**PaginatedAttributeValueResourceResponse**](PaginatedAttributeValueResourceResponse.md)
|
|
470
|
+
|
|
471
|
+
### Authorization
|
|
472
|
+
|
|
473
|
+
No authorization required
|
|
474
|
+
|
|
475
|
+
### HTTP request headers
|
|
476
|
+
|
|
477
|
+
- **Content-Type**: `application/json`
|
|
478
|
+
- **Accept**: `application/json`
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
### HTTP response details
|
|
482
|
+
| Status code | Description | Response headers |
|
|
483
|
+
|-------------|-------------|------------------|
|
|
484
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\AttributeValueResource[]>> | - |
|
|
485
|
+
|
|
486
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
487
|
+
|
|
488
|
+
|
|
423
489
|
## showAttribute
|
|
424
490
|
|
|
425
491
|
> AttributeResource showAttribute(attribute)
|
|
@@ -9,10 +9,10 @@ Name | Type
|
|
|
9
9
|
`id` | number
|
|
10
10
|
`fieldType` | object
|
|
11
11
|
`comparisonType` | object
|
|
12
|
-
`groupId` |
|
|
12
|
+
`groupId` | string
|
|
13
13
|
`relatedId` | string
|
|
14
14
|
`value` | string
|
|
15
|
-
`
|
|
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
|
-
"
|
|
30
|
+
"valueId": null,
|
|
31
31
|
} satisfies CategoryAutomationRuleResource
|
|
32
32
|
|
|
33
33
|
console.log(example)
|
|
@@ -18,6 +18,7 @@ Name | Type
|
|
|
18
18
|
`categoryId` | Array<string>
|
|
19
19
|
`supplierId` | Array<string>
|
|
20
20
|
`productTypeId` | Array<string>
|
|
21
|
+
`parentIsAccessory` | Array<string>
|
|
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
|
+
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
|
|
2
|
+
# IndexAttributeValueRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`search` | string
|
|
10
|
+
`sortBy` | string
|
|
11
|
+
`sortDirection` | string
|
|
12
|
+
`perPage` | number
|
|
13
|
+
`page` | number
|
|
14
|
+
`attributeId` | Array<string>
|
|
15
|
+
`relatedId` | number
|
|
16
|
+
`relatedType` | string
|
|
17
|
+
`includesRelations` | boolean
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { IndexAttributeValueRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"search": null,
|
|
27
|
+
"sortBy": null,
|
|
28
|
+
"sortDirection": null,
|
|
29
|
+
"perPage": null,
|
|
30
|
+
"page": null,
|
|
31
|
+
"attributeId": null,
|
|
32
|
+
"relatedId": null,
|
|
33
|
+
"relatedType": null,
|
|
34
|
+
"includesRelations": null,
|
|
35
|
+
} satisfies IndexAttributeValueRequest
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as IndexAttributeValueRequest
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
49
|
+
|
|
50
|
+
|
|
@@ -17,6 +17,7 @@ Name | Type
|
|
|
17
17
|
`categoryId` | Array<string>
|
|
18
18
|
`supplierId` | Array<string>
|
|
19
19
|
`productTypeId` | Array<string>
|
|
20
|
+
`parentIsAccessory` | Array<string>
|
|
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,
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedAttributeValueResourceResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<AttributeValueResource>](AttributeValueResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PaginatedAttributeValueResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"data": null,
|
|
20
|
+
"meta": null,
|
|
21
|
+
} satisfies PaginatedAttributeValueResourceResponse
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedAttributeValueResourceResponse
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -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)
|