@digital8/lighting-illusions-ts-sdk 0.0.1673 → 0.0.1675
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 +8 -8
- package/README.md +14 -14
- package/dist/apis/AdminApi.d.ts +8 -8
- package/dist/apis/AdminApi.js +3 -3
- package/dist/apis/OverlayTemplateApi.d.ts +6 -6
- package/dist/apis/OverlayTemplateApi.js +1 -1
- package/dist/apis/ProductApi.d.ts +7 -7
- package/dist/apis/ProductApi.js +2 -2
- package/dist/apis/ProductCategoryApi.d.ts +6 -6
- package/dist/apis/ProductCategoryApi.js +1 -1
- package/dist/apis/ProductRangeApi.d.ts +3 -3
- package/dist/apis/ProductRangeApi.js +2 -2
- package/dist/models/AddressFrontendResource.d.ts +1 -1
- package/dist/models/AddressFrontendResource.js +3 -1
- package/dist/models/AddressResource.d.ts +1 -1
- package/dist/models/AddressResource.js +3 -1
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +3 -1
- package/dist/models/GenerateGoogleFeedAdminRequest.d.ts +32 -0
- package/dist/models/GenerateGoogleFeedAdminRequest.js +51 -0
- package/dist/models/GetProductChildrenOverlayTemplateRequest.d.ts +192 -0
- package/dist/models/{IndexProductChildRequest.js → GetProductChildrenOverlayTemplateRequest.js} +17 -17
- package/dist/models/StoreBlogCategoryRequest.d.ts +3 -3
- package/dist/models/StoreBlogCategoryRequest.js +3 -3
- package/dist/models/StoreBlogCategoryRequestDescriptionsInner.d.ts +44 -0
- package/dist/models/StoreBlogCategoryRequestDescriptionsInner.js +55 -0
- package/dist/models/StoreFrontendResource.d.ts +1 -1
- package/dist/models/StoreFrontendResource.js +3 -1
- package/dist/models/StorePageRequest.d.ts +3 -3
- package/dist/models/StorePageRequest.js +3 -3
- package/dist/models/StorePageRequestSeoInner.d.ts +44 -0
- package/dist/models/StorePageRequestSeoInner.js +55 -0
- package/dist/models/StoreProductCategoryRequest.d.ts +6 -6
- package/dist/models/StoreProductCategoryRequest.js +6 -6
- package/dist/models/StoreResource.d.ts +2 -2
- package/dist/models/StoreResource.js +4 -4
- package/dist/models/StoreSpecialDateResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateResource.js +1 -3
- package/dist/models/StoreSupplierRequest.d.ts +6 -6
- package/dist/models/StoreSupplierRequest.js +6 -6
- package/dist/models/UpdateBlogCategoryRequest.d.ts +3 -3
- package/dist/models/UpdateBlogCategoryRequest.js +3 -3
- package/dist/models/UpdatePageRequest.d.ts +3 -3
- package/dist/models/UpdatePageRequest.js +3 -3
- package/dist/models/UpdateProductCategoryRequest.d.ts +6 -6
- package/dist/models/UpdateProductCategoryRequest.js +6 -6
- package/dist/models/UpdateSupplierRequest.d.ts +6 -6
- package/dist/models/UpdateSupplierRequest.js +6 -6
- package/dist/models/index.d.ts +4 -4
- package/dist/models/index.js +4 -4
- package/docs/AdminApi.md +15 -15
- package/docs/{GetHierarchyProductCategoryRequest.md → GenerateGoogleFeedAdminRequest.md} +4 -4
- package/docs/{IndexProductChildRequest.md → GetProductChildrenOverlayTemplateRequest.md} +4 -4
- package/docs/OverlayTemplateApi.md +7 -7
- package/docs/ProductApi.md +11 -11
- package/docs/ProductCategoryApi.md +7 -7
- package/docs/ProductRangeApi.md +8 -8
- package/docs/StoreBlogCategoryRequest.md +1 -1
- package/docs/{StoreProductCategoryRequestDescriptionsInner.md → StoreBlogCategoryRequestDescriptionsInner.md} +4 -4
- package/docs/StorePageRequest.md +1 -1
- package/docs/{StoreProductCategoryRequestSeoInner.md → StorePageRequestSeoInner.md} +4 -4
- package/docs/StoreProductCategoryRequest.md +2 -2
- package/docs/StoreSpecialDateResource.md +1 -1
- package/docs/StoreSupplierRequest.md +2 -2
- package/docs/UpdateBlogCategoryRequest.md +1 -1
- package/docs/UpdatePageRequest.md +1 -1
- package/docs/UpdateProductCategoryRequest.md +2 -2
- package/docs/UpdateSupplierRequest.md +2 -2
- package/package.json +1 -1
- package/src/apis/AdminApi.ts +13 -13
- package/src/apis/OverlayTemplateApi.ts +9 -9
- package/src/apis/ProductApi.ts +11 -11
- package/src/apis/ProductCategoryApi.ts +9 -9
- package/src/apis/ProductRangeApi.ts +7 -7
- package/src/models/AddressFrontendResource.ts +3 -2
- package/src/models/AddressResource.ts +3 -2
- package/src/models/ExternalApiLogResource.ts +3 -2
- package/src/models/GenerateGoogleFeedAdminRequest.ts +66 -0
- package/src/models/{IndexProductChildRequest.ts → GetProductChildrenOverlayTemplateRequest.ts} +42 -42
- package/src/models/StoreBlogCategoryRequest.ts +10 -10
- package/src/models/StoreBlogCategoryRequestDescriptionsInner.ts +82 -0
- package/src/models/StoreFrontendResource.ts +3 -2
- package/src/models/StorePageRequest.ts +10 -10
- package/src/models/{StoreProductCategoryRequestSeoInner.ts → StorePageRequestSeoInner.ts} +13 -13
- package/src/models/StoreProductCategoryRequest.ts +20 -20
- package/src/models/StoreResource.ts +5 -5
- package/src/models/StoreSpecialDateResource.ts +3 -4
- package/src/models/StoreSupplierRequest.ts +20 -20
- package/src/models/UpdateBlogCategoryRequest.ts +10 -10
- package/src/models/UpdatePageRequest.ts +10 -10
- package/src/models/UpdateProductCategoryRequest.ts +20 -20
- package/src/models/UpdateSupplierRequest.ts +20 -20
- package/src/models/index.ts +4 -4
- package/dist/models/GetHierarchyProductCategoryRequest.d.ts +0 -32
- package/dist/models/GetHierarchyProductCategoryRequest.js +0 -51
- package/dist/models/IndexProductChildRequest.d.ts +0 -192
- package/dist/models/StoreProductCategoryRequestDescriptionsInner.d.ts +0 -44
- package/dist/models/StoreProductCategoryRequestDescriptionsInner.js +0 -55
- package/dist/models/StoreProductCategoryRequestSeoInner.d.ts +0 -44
- package/dist/models/StoreProductCategoryRequestSeoInner.js +0 -55
- package/src/models/GetHierarchyProductCategoryRequest.ts +0 -66
- package/src/models/StoreProductCategoryRequestDescriptionsInner.ts +0 -82
package/docs/AdminApi.md
CHANGED
|
@@ -4,7 +4,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**generateGoogleFeedAdmin**](AdminApi.md#
|
|
7
|
+
| [**generateGoogleFeedAdmin**](AdminApi.md#generategooglefeedadminoperation) | **POST** /admin-api/admin/feeds/google/generate | Auto-generated: generateGoogleFeedAdmin |
|
|
8
8
|
| [**generateSocialFeedAdmin**](AdminApi.md#generatesocialfeedadmin) | **POST** /admin-api/admin/feeds/social/generate | Auto-generated: generateSocialFeedAdmin |
|
|
9
9
|
| [**generateTGNDataFeedAdmin**](AdminApi.md#generatetgndatafeedadmin) | **POST** /admin-api/admin/feeds/tgn-data/generate | Auto-generated: generateTGNDataFeedAdmin |
|
|
10
10
|
|
|
@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
12
12
|
|
|
13
13
|
## generateGoogleFeedAdmin
|
|
14
14
|
|
|
15
|
-
> GenericResponse generateGoogleFeedAdmin(
|
|
15
|
+
> GenericResponse generateGoogleFeedAdmin(generateGoogleFeedAdminRequest)
|
|
16
16
|
|
|
17
17
|
Auto-generated: generateGoogleFeedAdmin
|
|
18
18
|
|
|
@@ -23,16 +23,16 @@ import {
|
|
|
23
23
|
Configuration,
|
|
24
24
|
AdminApi,
|
|
25
25
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
26
|
-
import type {
|
|
26
|
+
import type { GenerateGoogleFeedAdminOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
27
27
|
|
|
28
28
|
async function example() {
|
|
29
29
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
30
30
|
const api = new AdminApi();
|
|
31
31
|
|
|
32
32
|
const body = {
|
|
33
|
-
//
|
|
34
|
-
|
|
35
|
-
} satisfies
|
|
33
|
+
// GenerateGoogleFeedAdminRequest (optional)
|
|
34
|
+
generateGoogleFeedAdminRequest: ...,
|
|
35
|
+
} satisfies GenerateGoogleFeedAdminOperationRequest;
|
|
36
36
|
|
|
37
37
|
try {
|
|
38
38
|
const data = await api.generateGoogleFeedAdmin(body);
|
|
@@ -51,7 +51,7 @@ example().catch(console.error);
|
|
|
51
51
|
|
|
52
52
|
| Name | Type | Description | Notes |
|
|
53
53
|
|------------- | ------------- | ------------- | -------------|
|
|
54
|
-
| **
|
|
54
|
+
| **generateGoogleFeedAdminRequest** | [GenerateGoogleFeedAdminRequest](GenerateGoogleFeedAdminRequest.md) | | [Optional] |
|
|
55
55
|
|
|
56
56
|
### Return type
|
|
57
57
|
|
|
@@ -77,7 +77,7 @@ No authorization required
|
|
|
77
77
|
|
|
78
78
|
## generateSocialFeedAdmin
|
|
79
79
|
|
|
80
|
-
> GenericResponse generateSocialFeedAdmin(
|
|
80
|
+
> GenericResponse generateSocialFeedAdmin(generateGoogleFeedAdminRequest)
|
|
81
81
|
|
|
82
82
|
Auto-generated: generateSocialFeedAdmin
|
|
83
83
|
|
|
@@ -95,8 +95,8 @@ async function example() {
|
|
|
95
95
|
const api = new AdminApi();
|
|
96
96
|
|
|
97
97
|
const body = {
|
|
98
|
-
//
|
|
99
|
-
|
|
98
|
+
// GenerateGoogleFeedAdminRequest (optional)
|
|
99
|
+
generateGoogleFeedAdminRequest: ...,
|
|
100
100
|
} satisfies GenerateSocialFeedAdminRequest;
|
|
101
101
|
|
|
102
102
|
try {
|
|
@@ -116,7 +116,7 @@ example().catch(console.error);
|
|
|
116
116
|
|
|
117
117
|
| Name | Type | Description | Notes |
|
|
118
118
|
|------------- | ------------- | ------------- | -------------|
|
|
119
|
-
| **
|
|
119
|
+
| **generateGoogleFeedAdminRequest** | [GenerateGoogleFeedAdminRequest](GenerateGoogleFeedAdminRequest.md) | | [Optional] |
|
|
120
120
|
|
|
121
121
|
### Return type
|
|
122
122
|
|
|
@@ -142,7 +142,7 @@ No authorization required
|
|
|
142
142
|
|
|
143
143
|
## generateTGNDataFeedAdmin
|
|
144
144
|
|
|
145
|
-
> GenericResponse generateTGNDataFeedAdmin(
|
|
145
|
+
> GenericResponse generateTGNDataFeedAdmin(generateGoogleFeedAdminRequest)
|
|
146
146
|
|
|
147
147
|
Auto-generated: generateTGNDataFeedAdmin
|
|
148
148
|
|
|
@@ -160,8 +160,8 @@ async function example() {
|
|
|
160
160
|
const api = new AdminApi();
|
|
161
161
|
|
|
162
162
|
const body = {
|
|
163
|
-
//
|
|
164
|
-
|
|
163
|
+
// GenerateGoogleFeedAdminRequest (optional)
|
|
164
|
+
generateGoogleFeedAdminRequest: ...,
|
|
165
165
|
} satisfies GenerateTGNDataFeedAdminRequest;
|
|
166
166
|
|
|
167
167
|
try {
|
|
@@ -181,7 +181,7 @@ example().catch(console.error);
|
|
|
181
181
|
|
|
182
182
|
| Name | Type | Description | Notes |
|
|
183
183
|
|------------- | ------------- | ------------- | -------------|
|
|
184
|
-
| **
|
|
184
|
+
| **generateGoogleFeedAdminRequest** | [GenerateGoogleFeedAdminRequest](GenerateGoogleFeedAdminRequest.md) | | [Optional] |
|
|
185
185
|
|
|
186
186
|
### Return type
|
|
187
187
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# GenerateGoogleFeedAdminRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -11,12 +11,12 @@ Name | Type
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { GenerateGoogleFeedAdminRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
18
|
"siteId": null,
|
|
19
|
-
} satisfies
|
|
19
|
+
} satisfies GenerateGoogleFeedAdminRequest
|
|
20
20
|
|
|
21
21
|
console.log(example)
|
|
22
22
|
|
|
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
25
|
console.log(exampleJSON)
|
|
26
26
|
|
|
27
27
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as GenerateGoogleFeedAdminRequest
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# GetProductChildrenOverlayTemplateRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -30,7 +30,7 @@ Name | Type
|
|
|
30
30
|
## Example
|
|
31
31
|
|
|
32
32
|
```typescript
|
|
33
|
-
import type {
|
|
33
|
+
import type { GetProductChildrenOverlayTemplateRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
34
34
|
|
|
35
35
|
// TODO: Update the object below with actual values
|
|
36
36
|
const example = {
|
|
@@ -54,7 +54,7 @@ const example = {
|
|
|
54
54
|
"relatedId": null,
|
|
55
55
|
"relatedType": null,
|
|
56
56
|
"includesRelations": null,
|
|
57
|
-
} satisfies
|
|
57
|
+
} satisfies GetProductChildrenOverlayTemplateRequest
|
|
58
58
|
|
|
59
59
|
console.log(example)
|
|
60
60
|
|
|
@@ -63,7 +63,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
63
63
|
console.log(exampleJSON)
|
|
64
64
|
|
|
65
65
|
// Parse the JSON string back to an object
|
|
66
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
66
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetProductChildrenOverlayTemplateRequest
|
|
67
67
|
console.log(exampleParsed)
|
|
68
68
|
```
|
|
69
69
|
|
|
@@ -10,7 +10,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
10
10
|
| [**detachAssetOverlayTemplate**](OverlayTemplateApi.md#detachassetoverlaytemplate) | **POST** /admin-api/overlay-template/{overlayTemplate}/detach-asset/{asset} | Auto-generated: detachAssetOverlayTemplate |
|
|
11
11
|
| [**detachAssetableOverlayTemplate**](OverlayTemplateApi.md#detachassetableoverlaytemplateoperation) | **POST** /admin-api/overlay-template/{overlayTemplate}/detach-assetable | Auto-generated: detachAssetableOverlayTemplate |
|
|
12
12
|
| [**getAllOverlayTemplate**](OverlayTemplateApi.md#getalloverlaytemplateoperation) | **POST** /admin-api/overlay-template/all | Auto-generated: getAllOverlayTemplate |
|
|
13
|
-
| [**getProductChildrenOverlayTemplate**](OverlayTemplateApi.md#
|
|
13
|
+
| [**getProductChildrenOverlayTemplate**](OverlayTemplateApi.md#getproductchildrenoverlaytemplateoperation) | **POST** /admin-api/overlay-template/{overlayTemplate}/product-children | Auto-generated: getProductChildrenOverlayTemplate |
|
|
14
14
|
| [**indexOverlayTemplate**](OverlayTemplateApi.md#indexoverlaytemplateoperation) | **POST** /admin-api/overlay-template/list | Auto-generated: indexOverlayTemplate |
|
|
15
15
|
| [**showOverlayTemplate**](OverlayTemplateApi.md#showoverlaytemplate) | **GET** /admin-api/overlay-template/{overlayTemplate} | Auto-generated: showOverlayTemplate |
|
|
16
16
|
| [**storeOverlayTemplate**](OverlayTemplateApi.md#storeoverlaytemplateoperation) | **POST** /admin-api/overlay-template/create | Auto-generated: storeOverlayTemplate |
|
|
@@ -421,7 +421,7 @@ No authorization required
|
|
|
421
421
|
|
|
422
422
|
## getProductChildrenOverlayTemplate
|
|
423
423
|
|
|
424
|
-
> PaginatedProductChildOverlayRelationResourceResponse getProductChildrenOverlayTemplate(overlayTemplate,
|
|
424
|
+
> PaginatedProductChildOverlayRelationResourceResponse getProductChildrenOverlayTemplate(overlayTemplate, getProductChildrenOverlayTemplateRequest)
|
|
425
425
|
|
|
426
426
|
Auto-generated: getProductChildrenOverlayTemplate
|
|
427
427
|
|
|
@@ -432,7 +432,7 @@ import {
|
|
|
432
432
|
Configuration,
|
|
433
433
|
OverlayTemplateApi,
|
|
434
434
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
435
|
-
import type {
|
|
435
|
+
import type { GetProductChildrenOverlayTemplateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
436
436
|
|
|
437
437
|
async function example() {
|
|
438
438
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
@@ -441,9 +441,9 @@ async function example() {
|
|
|
441
441
|
const body = {
|
|
442
442
|
// number | The id of the overlayTemplate
|
|
443
443
|
overlayTemplate: 56,
|
|
444
|
-
//
|
|
445
|
-
|
|
446
|
-
} satisfies
|
|
444
|
+
// GetProductChildrenOverlayTemplateRequest (optional)
|
|
445
|
+
getProductChildrenOverlayTemplateRequest: ...,
|
|
446
|
+
} satisfies GetProductChildrenOverlayTemplateOperationRequest;
|
|
447
447
|
|
|
448
448
|
try {
|
|
449
449
|
const data = await api.getProductChildrenOverlayTemplate(body);
|
|
@@ -463,7 +463,7 @@ example().catch(console.error);
|
|
|
463
463
|
| Name | Type | Description | Notes |
|
|
464
464
|
|------------- | ------------- | ------------- | -------------|
|
|
465
465
|
| **overlayTemplate** | `number` | The id of the overlayTemplate | [Defaults to `undefined`] |
|
|
466
|
-
| **
|
|
466
|
+
| **getProductChildrenOverlayTemplateRequest** | [GetProductChildrenOverlayTemplateRequest](GetProductChildrenOverlayTemplateRequest.md) | | [Optional] |
|
|
467
467
|
|
|
468
468
|
### Return type
|
|
469
469
|
|
package/docs/ProductApi.md
CHANGED
|
@@ -17,7 +17,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
17
17
|
| [**getAllProductChild**](ProductApi.md#getallproductchildoperation) | **POST** /admin-api/product/children/all | Auto-generated: getAllProductChild |
|
|
18
18
|
| [**getCompatibleProductsProductChild**](ProductApi.md#getcompatibleproductsproductchild) | **POST** /admin-api/product/children/{productChild}/compatible-product/list | Auto-generated: getCompatibleProductsProductChild |
|
|
19
19
|
| [**indexProduct**](ProductApi.md#indexproductoperation) | **POST** /admin-api/product/parent/list | Auto-generated: indexProduct |
|
|
20
|
-
| [**indexProductChild**](ProductApi.md#
|
|
20
|
+
| [**indexProductChild**](ProductApi.md#indexproductchild) | **POST** /admin-api/product/children/list | Auto-generated: indexProductChild |
|
|
21
21
|
| [**showAssetsProductChild**](ProductApi.md#showassetsproductchildoperation) | **POST** /admin-api/product/children/{productChild}/assets | Auto-generated: showAssetsProductChild |
|
|
22
22
|
| [**showAttributesProductChild**](ProductApi.md#showattributesproductchildoperation) | **POST** /admin-api/product/children/{productChild}/attributes | Auto-generated: showAttributesProductChild |
|
|
23
23
|
| [**showProduct**](ProductApi.md#showproduct) | **GET** /admin-api/product/parent/{product} | Auto-generated: showProduct |
|
|
@@ -767,7 +767,7 @@ No authorization required
|
|
|
767
767
|
|
|
768
768
|
## getCompatibleProductsProductChild
|
|
769
769
|
|
|
770
|
-
> PaginatedProductChildListResourceResponse getCompatibleProductsProductChild(productChild,
|
|
770
|
+
> PaginatedProductChildListResourceResponse getCompatibleProductsProductChild(productChild, getProductChildrenOverlayTemplateRequest)
|
|
771
771
|
|
|
772
772
|
Auto-generated: getCompatibleProductsProductChild
|
|
773
773
|
|
|
@@ -787,8 +787,8 @@ async function example() {
|
|
|
787
787
|
const body = {
|
|
788
788
|
// number | The id of the productChild
|
|
789
789
|
productChild: 56,
|
|
790
|
-
//
|
|
791
|
-
|
|
790
|
+
// GetProductChildrenOverlayTemplateRequest (optional)
|
|
791
|
+
getProductChildrenOverlayTemplateRequest: ...,
|
|
792
792
|
} satisfies GetCompatibleProductsProductChildRequest;
|
|
793
793
|
|
|
794
794
|
try {
|
|
@@ -809,7 +809,7 @@ example().catch(console.error);
|
|
|
809
809
|
| Name | Type | Description | Notes |
|
|
810
810
|
|------------- | ------------- | ------------- | -------------|
|
|
811
811
|
| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
|
|
812
|
-
| **
|
|
812
|
+
| **getProductChildrenOverlayTemplateRequest** | [GetProductChildrenOverlayTemplateRequest](GetProductChildrenOverlayTemplateRequest.md) | | [Optional] |
|
|
813
813
|
|
|
814
814
|
### Return type
|
|
815
815
|
|
|
@@ -900,7 +900,7 @@ No authorization required
|
|
|
900
900
|
|
|
901
901
|
## indexProductChild
|
|
902
902
|
|
|
903
|
-
> PaginatedProductChildListResourceResponse indexProductChild(
|
|
903
|
+
> PaginatedProductChildListResourceResponse indexProductChild(getProductChildrenOverlayTemplateRequest)
|
|
904
904
|
|
|
905
905
|
Auto-generated: indexProductChild
|
|
906
906
|
|
|
@@ -911,16 +911,16 @@ import {
|
|
|
911
911
|
Configuration,
|
|
912
912
|
ProductApi,
|
|
913
913
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
914
|
-
import type {
|
|
914
|
+
import type { IndexProductChildRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
915
915
|
|
|
916
916
|
async function example() {
|
|
917
917
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
918
918
|
const api = new ProductApi();
|
|
919
919
|
|
|
920
920
|
const body = {
|
|
921
|
-
//
|
|
922
|
-
|
|
923
|
-
} satisfies
|
|
921
|
+
// GetProductChildrenOverlayTemplateRequest (optional)
|
|
922
|
+
getProductChildrenOverlayTemplateRequest: ...,
|
|
923
|
+
} satisfies IndexProductChildRequest;
|
|
924
924
|
|
|
925
925
|
try {
|
|
926
926
|
const data = await api.indexProductChild(body);
|
|
@@ -939,7 +939,7 @@ example().catch(console.error);
|
|
|
939
939
|
|
|
940
940
|
| Name | Type | Description | Notes |
|
|
941
941
|
|------------- | ------------- | ------------- | -------------|
|
|
942
|
-
| **
|
|
942
|
+
| **getProductChildrenOverlayTemplateRequest** | [GetProductChildrenOverlayTemplateRequest](GetProductChildrenOverlayTemplateRequest.md) | | [Optional] |
|
|
943
943
|
|
|
944
944
|
### Return type
|
|
945
945
|
|
|
@@ -11,7 +11,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
11
11
|
| [**getAllChildrenProductCategory**](ProductCategoryApi.md#getallchildrenproductcategory) | **POST** /admin-api/product-category/{productCategory}/children/all | Auto-generated: getAllChildrenProductCategory |
|
|
12
12
|
| [**getAllProductCategory**](ProductCategoryApi.md#getallproductcategoryoperation) | **POST** /admin-api/product-category/all | Auto-generated: getAllProductCategory |
|
|
13
13
|
| [**getChildrenProductCategory**](ProductCategoryApi.md#getchildrenproductcategory) | **GET** /admin-api/product-category/{productCategory}/children | Auto-generated: getChildrenProductCategory |
|
|
14
|
-
| [**getHierarchyProductCategory**](ProductCategoryApi.md#
|
|
14
|
+
| [**getHierarchyProductCategory**](ProductCategoryApi.md#gethierarchyproductcategory) | **POST** /admin-api/product-category/hierarchy | Auto-generated: getHierarchyProductCategory |
|
|
15
15
|
| [**indexProductCategory**](ProductCategoryApi.md#indexproductcategoryoperation) | **POST** /admin-api/product-category/list | Auto-generated: indexProductCategory |
|
|
16
16
|
| [**previewAutomationRulesProductCategory**](ProductCategoryApi.md#previewautomationrulesproductcategoryoperation) | **POST** /admin-api/product-category/preview-automation-rules | Auto-generated: previewAutomationRulesProductCategory |
|
|
17
17
|
| [**showProductCategory**](ProductCategoryApi.md#showproductcategory) | **GET** /admin-api/product-category/{productCategory} | Auto-generated: showProductCategory |
|
|
@@ -489,7 +489,7 @@ No authorization required
|
|
|
489
489
|
|
|
490
490
|
## getHierarchyProductCategory
|
|
491
491
|
|
|
492
|
-
> ProductCategoryHierarchyResourceArrayResponse getHierarchyProductCategory(
|
|
492
|
+
> ProductCategoryHierarchyResourceArrayResponse getHierarchyProductCategory(generateGoogleFeedAdminRequest)
|
|
493
493
|
|
|
494
494
|
Auto-generated: getHierarchyProductCategory
|
|
495
495
|
|
|
@@ -500,16 +500,16 @@ import {
|
|
|
500
500
|
Configuration,
|
|
501
501
|
ProductCategoryApi,
|
|
502
502
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
503
|
-
import type {
|
|
503
|
+
import type { GetHierarchyProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
504
504
|
|
|
505
505
|
async function example() {
|
|
506
506
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
507
507
|
const api = new ProductCategoryApi();
|
|
508
508
|
|
|
509
509
|
const body = {
|
|
510
|
-
//
|
|
511
|
-
|
|
512
|
-
} satisfies
|
|
510
|
+
// GenerateGoogleFeedAdminRequest (optional)
|
|
511
|
+
generateGoogleFeedAdminRequest: ...,
|
|
512
|
+
} satisfies GetHierarchyProductCategoryRequest;
|
|
513
513
|
|
|
514
514
|
try {
|
|
515
515
|
const data = await api.getHierarchyProductCategory(body);
|
|
@@ -528,7 +528,7 @@ example().catch(console.error);
|
|
|
528
528
|
|
|
529
529
|
| Name | Type | Description | Notes |
|
|
530
530
|
|------------- | ------------- | ------------- | -------------|
|
|
531
|
-
| **
|
|
531
|
+
| **generateGoogleFeedAdminRequest** | [GenerateGoogleFeedAdminRequest](GenerateGoogleFeedAdminRequest.md) | | [Optional] |
|
|
532
532
|
|
|
533
533
|
### Return type
|
|
534
534
|
|
package/docs/ProductRangeApi.md
CHANGED
|
@@ -764,7 +764,7 @@ No authorization required
|
|
|
764
764
|
|
|
765
765
|
## listAccessoriesProductRange
|
|
766
766
|
|
|
767
|
-
> PaginatedProductChildListResourceResponse listAccessoriesProductRange(productRange,
|
|
767
|
+
> PaginatedProductChildListResourceResponse listAccessoriesProductRange(productRange, getProductChildrenOverlayTemplateRequest)
|
|
768
768
|
|
|
769
769
|
Auto-generated: listAccessoriesProductRange
|
|
770
770
|
|
|
@@ -784,8 +784,8 @@ async function example() {
|
|
|
784
784
|
const body = {
|
|
785
785
|
// number | The id of the productRange
|
|
786
786
|
productRange: 56,
|
|
787
|
-
//
|
|
788
|
-
|
|
787
|
+
// GetProductChildrenOverlayTemplateRequest (optional)
|
|
788
|
+
getProductChildrenOverlayTemplateRequest: ...,
|
|
789
789
|
} satisfies ListAccessoriesProductRangeRequest;
|
|
790
790
|
|
|
791
791
|
try {
|
|
@@ -806,7 +806,7 @@ example().catch(console.error);
|
|
|
806
806
|
| Name | Type | Description | Notes |
|
|
807
807
|
|------------- | ------------- | ------------- | -------------|
|
|
808
808
|
| **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
|
|
809
|
-
| **
|
|
809
|
+
| **getProductChildrenOverlayTemplateRequest** | [GetProductChildrenOverlayTemplateRequest](GetProductChildrenOverlayTemplateRequest.md) | | [Optional] |
|
|
810
810
|
|
|
811
811
|
### Return type
|
|
812
812
|
|
|
@@ -832,7 +832,7 @@ No authorization required
|
|
|
832
832
|
|
|
833
833
|
## listProductsProductRange
|
|
834
834
|
|
|
835
|
-
> PaginatedProductChildListResourceResponse listProductsProductRange(productRange,
|
|
835
|
+
> PaginatedProductChildListResourceResponse listProductsProductRange(productRange, getProductChildrenOverlayTemplateRequest)
|
|
836
836
|
|
|
837
837
|
Auto-generated: listProductsProductRange
|
|
838
838
|
|
|
@@ -852,8 +852,8 @@ async function example() {
|
|
|
852
852
|
const body = {
|
|
853
853
|
// number | The id of the productRange
|
|
854
854
|
productRange: 56,
|
|
855
|
-
//
|
|
856
|
-
|
|
855
|
+
// GetProductChildrenOverlayTemplateRequest (optional)
|
|
856
|
+
getProductChildrenOverlayTemplateRequest: ...,
|
|
857
857
|
} satisfies ListProductsProductRangeRequest;
|
|
858
858
|
|
|
859
859
|
try {
|
|
@@ -874,7 +874,7 @@ example().catch(console.error);
|
|
|
874
874
|
| Name | Type | Description | Notes |
|
|
875
875
|
|------------- | ------------- | ------------- | -------------|
|
|
876
876
|
| **productRange** | `number` | The id of the productRange | [Defaults to `undefined`] |
|
|
877
|
-
| **
|
|
877
|
+
| **getProductChildrenOverlayTemplateRequest** | [GetProductChildrenOverlayTemplateRequest](GetProductChildrenOverlayTemplateRequest.md) | | [Optional] |
|
|
878
878
|
|
|
879
879
|
### Return type
|
|
880
880
|
|
|
@@ -8,7 +8,7 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`name` | string
|
|
10
10
|
`slug` | string
|
|
11
|
-
`descriptions` | [Array<
|
|
11
|
+
`descriptions` | [Array<StoreBlogCategoryRequestDescriptionsInner>](StoreBlogCategoryRequestDescriptionsInner.md)
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# StoreBlogCategoryRequestDescriptionsInner
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -13,14 +13,14 @@ Name | Type
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import type {
|
|
16
|
+
import type { StoreBlogCategoryRequestDescriptionsInner } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
17
|
|
|
18
18
|
// TODO: Update the object below with actual values
|
|
19
19
|
const example = {
|
|
20
20
|
"headerDescription": null,
|
|
21
21
|
"footerDescription": null,
|
|
22
22
|
"siteId": null,
|
|
23
|
-
} satisfies
|
|
23
|
+
} satisfies StoreBlogCategoryRequestDescriptionsInner
|
|
24
24
|
|
|
25
25
|
console.log(example)
|
|
26
26
|
|
|
@@ -29,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
29
29
|
console.log(exampleJSON)
|
|
30
30
|
|
|
31
31
|
// Parse the JSON string back to an object
|
|
32
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as StoreBlogCategoryRequestDescriptionsInner
|
|
33
33
|
console.log(exampleParsed)
|
|
34
34
|
```
|
|
35
35
|
|
package/docs/StorePageRequest.md
CHANGED
|
@@ -13,7 +13,7 @@ Name | Type
|
|
|
13
13
|
`enabled` | boolean
|
|
14
14
|
`startDate` | Date
|
|
15
15
|
`blog` | [StorePageRequestBlog](StorePageRequestBlog.md)
|
|
16
|
-
`seo` | [Array<
|
|
16
|
+
`seo` | [Array<StorePageRequestSeoInner>](StorePageRequestSeoInner.md)
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# StorePageRequestSeoInner
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -13,14 +13,14 @@ Name | Type
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import type {
|
|
16
|
+
import type { StorePageRequestSeoInner } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
17
|
|
|
18
18
|
// TODO: Update the object below with actual values
|
|
19
19
|
const example = {
|
|
20
20
|
"seoTitle": null,
|
|
21
21
|
"seoDescription": null,
|
|
22
22
|
"siteId": null,
|
|
23
|
-
} satisfies
|
|
23
|
+
} satisfies StorePageRequestSeoInner
|
|
24
24
|
|
|
25
25
|
console.log(example)
|
|
26
26
|
|
|
@@ -29,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
29
29
|
console.log(exampleJSON)
|
|
30
30
|
|
|
31
31
|
// Parse the JSON string back to an object
|
|
32
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as StorePageRequestSeoInner
|
|
33
33
|
console.log(exampleParsed)
|
|
34
34
|
```
|
|
35
35
|
|
|
@@ -19,8 +19,8 @@ Name | Type
|
|
|
19
19
|
`altText` | string
|
|
20
20
|
`mimeType` | string
|
|
21
21
|
`fileId` | number
|
|
22
|
-
`seo` | [Array<
|
|
23
|
-
`descriptions` | [Array<
|
|
22
|
+
`seo` | [Array<StorePageRequestSeoInner>](StorePageRequestSeoInner.md)
|
|
23
|
+
`descriptions` | [Array<StoreBlogCategoryRequestDescriptionsInner>](StoreBlogCategoryRequestDescriptionsInner.md)
|
|
24
24
|
|
|
25
25
|
## Example
|
|
26
26
|
|
|
@@ -9,11 +9,11 @@ Name | Type
|
|
|
9
9
|
`name` | string
|
|
10
10
|
`slug` | string
|
|
11
11
|
`supplierEta` | number
|
|
12
|
-
`seo` | [Array<
|
|
12
|
+
`seo` | [Array<StorePageRequestSeoInner>](StorePageRequestSeoInner.md)
|
|
13
13
|
`altText` | string
|
|
14
14
|
`mimeType` | string
|
|
15
15
|
`fileId` | number
|
|
16
|
-
`descriptions` | [Array<
|
|
16
|
+
`descriptions` | [Array<StoreBlogCategoryRequestDescriptionsInner>](StoreBlogCategoryRequestDescriptionsInner.md)
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
@@ -8,7 +8,7 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`name` | string
|
|
10
10
|
`slug` | string
|
|
11
|
-
`descriptions` | [Array<
|
|
11
|
+
`descriptions` | [Array<StoreBlogCategoryRequestDescriptionsInner>](StoreBlogCategoryRequestDescriptionsInner.md)
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -12,7 +12,7 @@ Name | Type
|
|
|
12
12
|
`startDate` | Date
|
|
13
13
|
`blog` | [StorePageRequestBlog](StorePageRequestBlog.md)
|
|
14
14
|
`componentOrder` | Array<number>
|
|
15
|
-
`seo` | [Array<
|
|
15
|
+
`seo` | [Array<StorePageRequestSeoInner>](StorePageRequestSeoInner.md)
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -19,8 +19,8 @@ Name | Type
|
|
|
19
19
|
`altText` | string
|
|
20
20
|
`mimeType` | string
|
|
21
21
|
`fileId` | number
|
|
22
|
-
`seo` | [Array<
|
|
23
|
-
`descriptions` | [Array<
|
|
22
|
+
`seo` | [Array<StorePageRequestSeoInner>](StorePageRequestSeoInner.md)
|
|
23
|
+
`descriptions` | [Array<StoreBlogCategoryRequestDescriptionsInner>](StoreBlogCategoryRequestDescriptionsInner.md)
|
|
24
24
|
|
|
25
25
|
## Example
|
|
26
26
|
|
|
@@ -9,11 +9,11 @@ Name | Type
|
|
|
9
9
|
`name` | string
|
|
10
10
|
`slug` | string
|
|
11
11
|
`supplierEta` | number
|
|
12
|
-
`seo` | [Array<
|
|
12
|
+
`seo` | [Array<StorePageRequestSeoInner>](StorePageRequestSeoInner.md)
|
|
13
13
|
`altText` | string
|
|
14
14
|
`mimeType` | string
|
|
15
15
|
`fileId` | number
|
|
16
|
-
`descriptions` | [Array<
|
|
16
|
+
`descriptions` | [Array<StoreBlogCategoryRequestDescriptionsInner>](StoreBlogCategoryRequestDescriptionsInner.md)
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|