@digital8/lighting-illusions-ts-sdk 0.0.1887 → 0.0.1889
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 +48 -2
- package/README.md +33 -3
- package/dist/apis/ReviewApi.d.ts +139 -0
- package/dist/apis/ReviewApi.js +566 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/models/AddressResource.d.ts +1 -1
- package/dist/models/AddressResource.js +1 -3
- package/dist/models/AdminUserLiteResource.d.ts +50 -0
- package/dist/models/AdminUserLiteResource.js +61 -0
- package/dist/models/AdminUserLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminUserLiteResourceArrayResponse.js +50 -0
- package/dist/models/AssetFrontendResource.d.ts +0 -12
- package/dist/models/AssetFrontendResource.js +0 -6
- package/dist/models/AssetLiteResource.d.ts +2 -14
- package/dist/models/AssetLiteResource.js +0 -6
- package/dist/models/AssetResource.d.ts +2 -14
- package/dist/models/AssetResource.js +0 -6
- package/dist/models/AssetWithOverlayLinkResource.d.ts +2 -14
- package/dist/models/AssetWithOverlayLinkResource.js +0 -6
- package/dist/models/CustomerLiteResource.d.ts +50 -0
- package/dist/models/CustomerLiteResource.js +61 -0
- package/dist/models/CustomerLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/CustomerLiteResourceArrayResponse.js +50 -0
- package/dist/models/CustomerReviewableItemFrontendResource.d.ts +44 -0
- package/dist/models/CustomerReviewableItemFrontendResource.js +59 -0
- package/dist/models/CustomerReviewableItemFrontendResourceArrayResponse.d.ts +33 -0
- package/dist/models/CustomerReviewableItemFrontendResourceArrayResponse.js +50 -0
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +3 -1
- package/dist/models/ExternalApiSyncStatus.d.ts +0 -1
- package/dist/models/ExternalApiSyncStatus.js +1 -2
- package/dist/models/IndexExternalApiLogRequest.d.ts +0 -6
- package/dist/models/IndexExternalApiLogRequest.js +0 -2
- package/dist/models/IndexReviewRequest.d.ts +110 -0
- package/dist/models/IndexReviewRequest.js +86 -0
- package/dist/models/MenuPosition.d.ts +1 -0
- package/dist/models/MenuPosition.js +2 -1
- package/dist/models/PaginatedCustomerReviewableItemFrontendResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedCustomerReviewableItemFrontendResourceResponse.js +57 -0
- package/dist/models/PaginatedReviewListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedReviewListResourceResponse.js +57 -0
- package/dist/models/PaginatedReviewLiteResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedReviewLiteResourceResponse.js +57 -0
- package/dist/models/PaginatedReviewResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedReviewResourceResponse.js +57 -0
- package/dist/models/ProductReviewsResource.d.ts +63 -0
- package/dist/models/ProductReviewsResource.js +70 -0
- package/dist/models/ProductReviewsResourceArrayResponse.d.ts +33 -0
- package/dist/models/ProductReviewsResourceArrayResponse.js +50 -0
- package/dist/models/ReviewListResource.d.ts +94 -0
- package/dist/models/ReviewListResource.js +87 -0
- package/dist/models/ReviewListResourceArrayResponse.d.ts +33 -0
- package/dist/models/ReviewListResourceArrayResponse.js +50 -0
- package/dist/models/ReviewLiteResource.d.ts +44 -0
- package/dist/models/ReviewLiteResource.js +59 -0
- package/dist/models/ReviewLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/ReviewLiteResourceArrayResponse.js +50 -0
- package/dist/models/ReviewPublicResource.d.ts +68 -0
- package/dist/models/ReviewPublicResource.js +73 -0
- package/dist/models/ReviewPublicResourceArrayResponse.d.ts +33 -0
- package/dist/models/ReviewPublicResourceArrayResponse.js +50 -0
- package/dist/models/ReviewResource.d.ts +126 -0
- package/dist/models/ReviewResource.js +107 -0
- package/dist/models/ReviewResourceArrayResponse.d.ts +33 -0
- package/dist/models/ReviewResourceArrayResponse.js +50 -0
- package/dist/models/StoreAssetForAssetableRequest.d.ts +2 -14
- package/dist/models/StoreAssetForAssetableRequest.js +6 -6
- package/dist/models/StoreFrontendResource.d.ts +2 -2
- package/dist/models/StoreFrontendResource.js +6 -2
- package/dist/models/StoreListResource.d.ts +2 -14
- package/dist/models/StoreListResource.js +6 -14
- package/dist/models/StoreMenuRequest.d.ts +1 -0
- package/dist/models/StoreMenuRequest.js +2 -1
- package/dist/models/StoreOverlayTemplateAssetRequest.d.ts +2 -14
- package/dist/models/StoreOverlayTemplateAssetRequest.js +6 -6
- package/dist/models/StoreProductCategoryRequest.d.ts +0 -12
- package/dist/models/StoreProductCategoryRequest.js +0 -4
- package/dist/models/StoreProductChildRequestAssetsInner.d.ts +2 -14
- package/dist/models/StoreProductChildRequestAssetsInner.js +6 -6
- package/dist/models/StoreResource.d.ts +2 -14
- package/dist/models/StoreResource.js +10 -14
- package/dist/models/StoreReviewRequest.d.ts +80 -0
- package/dist/models/StoreReviewRequest.js +79 -0
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateFrontendResource.js +3 -1
- package/dist/models/StoreSpecialDateResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateResource.js +5 -7
- package/dist/models/StoreStoreRequest.d.ts +0 -12
- package/dist/models/StoreStoreRequest.js +0 -4
- package/dist/models/StoreSupplierRequest.d.ts +2 -14
- package/dist/models/StoreSupplierRequest.js +6 -6
- package/dist/models/UpdateAssetForAssetableRequest.d.ts +0 -12
- package/dist/models/UpdateAssetForAssetableRequest.js +0 -4
- package/dist/models/UpdateMenuRequest.d.ts +1 -0
- package/dist/models/UpdateMenuRequest.js +2 -1
- package/dist/models/UpdateOverlayTemplateAssetRequest.d.ts +2 -14
- package/dist/models/UpdateOverlayTemplateAssetRequest.js +6 -6
- package/dist/models/UpdateProductCategoryRequest.d.ts +0 -12
- package/dist/models/UpdateProductCategoryRequest.js +0 -4
- package/dist/models/UpdateProductChildRequestAssetsInner.d.ts +2 -14
- package/dist/models/UpdateProductChildRequestAssetsInner.js +6 -6
- package/dist/models/UpdateReviewRequest.d.ts +68 -0
- package/dist/models/UpdateReviewRequest.js +71 -0
- package/dist/models/UpdateStoreRequest.d.ts +0 -12
- package/dist/models/UpdateStoreRequest.js +0 -4
- package/dist/models/UpdateSupplierRequest.d.ts +2 -14
- package/dist/models/UpdateSupplierRequest.js +6 -6
- package/dist/models/index.d.ts +23 -1
- package/dist/models/index.js +23 -1
- package/docs/AdminUserLiteResource.md +40 -0
- package/docs/AdminUserLiteResourceArrayResponse.md +34 -0
- package/docs/AssetFrontendResource.md +0 -4
- package/docs/AssetLiteResource.md +1 -5
- package/docs/AssetResource.md +1 -5
- package/docs/AssetWithOverlayLinkResource.md +1 -5
- package/docs/CustomerLiteResource.md +40 -0
- package/docs/CustomerLiteResourceArrayResponse.md +34 -0
- package/docs/CustomerReviewableItemFrontendResource.md +38 -0
- package/docs/CustomerReviewableItemFrontendResourceArrayResponse.md +34 -0
- package/docs/IndexExternalApiLogRequest.md +0 -2
- package/docs/IndexReviewRequest.md +54 -0
- package/docs/PaginatedCustomerReviewableItemFrontendResourceResponse.md +36 -0
- package/docs/PaginatedReviewListResourceResponse.md +36 -0
- package/docs/PaginatedReviewLiteResourceResponse.md +36 -0
- package/docs/PaginatedReviewResourceResponse.md +36 -0
- package/docs/ProductReviewsResource.md +44 -0
- package/docs/ProductReviewsResourceArrayResponse.md +34 -0
- package/docs/ReviewApi.md +539 -0
- package/docs/ReviewListResource.md +54 -0
- package/docs/ReviewListResourceArrayResponse.md +34 -0
- package/docs/ReviewLiteResource.md +38 -0
- package/docs/ReviewLiteResourceArrayResponse.md +34 -0
- package/docs/ReviewPublicResource.md +46 -0
- package/docs/ReviewPublicResourceArrayResponse.md +34 -0
- package/docs/ReviewResource.md +64 -0
- package/docs/{StoreStockType.md → ReviewResourceArrayResponse.md} +6 -4
- package/docs/StoreAssetForAssetableRequest.md +0 -4
- package/docs/StoreListResource.md +0 -4
- package/docs/StoreOverlayTemplateAssetRequest.md +0 -4
- package/docs/StoreProductCategoryRequest.md +0 -4
- package/docs/StoreProductChildRequestAssetsInner.md +0 -4
- package/docs/StoreResource.md +0 -4
- package/docs/StoreReviewRequest.md +50 -0
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/docs/StoreSpecialDateResource.md +1 -1
- package/docs/StoreStoreRequest.md +0 -4
- package/docs/StoreSupplierRequest.md +0 -4
- package/docs/UpdateAssetForAssetableRequest.md +0 -4
- package/docs/UpdateOverlayTemplateAssetRequest.md +0 -4
- package/docs/UpdateProductCategoryRequest.md +0 -4
- package/docs/UpdateProductChildRequestAssetsInner.md +0 -4
- package/docs/UpdateReviewRequest.md +46 -0
- package/docs/UpdateStoreRequest.md +0 -4
- package/docs/UpdateSupplierRequest.md +0 -4
- package/package.json +1 -1
- package/src/apis/ReviewApi.ts +444 -0
- package/src/apis/index.ts +1 -0
- package/src/models/AddressResource.ts +2 -3
- package/src/models/AdminUserLiteResource.ts +92 -0
- package/src/models/AdminUserLiteResourceArrayResponse.ts +73 -0
- package/src/models/AssetFrontendResource.ts +0 -17
- package/src/models/AssetLiteResource.ts +2 -19
- package/src/models/AssetResource.ts +2 -19
- package/src/models/AssetWithOverlayLinkResource.ts +2 -19
- package/src/models/CustomerLiteResource.ts +92 -0
- package/src/models/CustomerLiteResourceArrayResponse.ts +73 -0
- package/src/models/CustomerReviewableItemFrontendResource.ts +84 -0
- package/src/models/CustomerReviewableItemFrontendResourceArrayResponse.ts +73 -0
- package/src/models/ExternalApiLogResource.ts +3 -2
- package/src/models/ExternalApiSyncStatus.ts +1 -2
- package/src/models/IndexExternalApiLogRequest.ts +0 -8
- package/src/models/IndexReviewRequest.ts +167 -0
- package/src/models/MenuPosition.ts +2 -1
- package/src/models/PaginatedCustomerReviewableItemFrontendResourceResponse.ts +90 -0
- package/src/models/PaginatedReviewListResourceResponse.ts +90 -0
- package/src/models/PaginatedReviewLiteResourceResponse.ts +90 -0
- package/src/models/PaginatedReviewResourceResponse.ts +90 -0
- package/src/models/ProductReviewsResource.ts +118 -0
- package/src/models/ProductReviewsResourceArrayResponse.ts +73 -0
- package/src/models/ReviewListResource.ts +168 -0
- package/src/models/ReviewListResourceArrayResponse.ts +73 -0
- package/src/models/ReviewLiteResource.ts +84 -0
- package/src/models/ReviewLiteResourceArrayResponse.ts +73 -0
- package/src/models/ReviewPublicResource.ts +119 -0
- package/src/models/ReviewPublicResourceArrayResponse.ts +73 -0
- package/src/models/ReviewResource.ts +226 -0
- package/src/models/ReviewResourceArrayResponse.ts +73 -0
- package/src/models/StoreAssetForAssetableRequest.ts +6 -20
- package/src/models/StoreFrontendResource.ts +6 -4
- package/src/models/StoreListResource.ts +8 -26
- package/src/models/StoreMenuRequest.ts +2 -1
- package/src/models/StoreOverlayTemplateAssetRequest.ts +6 -20
- package/src/models/StoreProductCategoryRequest.ts +0 -16
- package/src/models/StoreProductChildRequestAssetsInner.ts +6 -20
- package/src/models/StoreResource.ts +11 -27
- package/src/models/StoreReviewRequest.ts +136 -0
- package/src/models/StoreSpecialDateFrontendResource.ts +4 -3
- package/src/models/StoreSpecialDateResource.ts +7 -8
- package/src/models/StoreStoreRequest.ts +0 -16
- package/src/models/StoreSupplierRequest.ts +6 -20
- package/src/models/UpdateAssetForAssetableRequest.ts +0 -16
- package/src/models/UpdateMenuRequest.ts +2 -1
- package/src/models/UpdateOverlayTemplateAssetRequest.ts +6 -20
- package/src/models/UpdateProductCategoryRequest.ts +0 -16
- package/src/models/UpdateProductChildRequestAssetsInner.ts +6 -20
- package/src/models/UpdateReviewRequest.ts +118 -0
- package/src/models/UpdateStoreRequest.ts +0 -16
- package/src/models/UpdateSupplierRequest.ts +6 -20
- package/src/models/index.ts +23 -1
- package/dist/models/StoreStockType.d.ts +0 -25
- package/dist/models/StoreStockType.js +0 -51
- package/src/models/StoreStockType.ts +0 -53
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# ReviewListResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<ReviewListResource>](ReviewListResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ReviewListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies ReviewListResourceArrayResponse
|
|
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 ReviewListResourceArrayResponse
|
|
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,38 @@
|
|
|
1
|
+
|
|
2
|
+
# ReviewLiteResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`reviewerName` | string
|
|
11
|
+
`rating` | number
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { ReviewLiteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"id": null,
|
|
21
|
+
"reviewerName": null,
|
|
22
|
+
"rating": null,
|
|
23
|
+
} satisfies ReviewLiteResource
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as ReviewLiteResource
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# ReviewLiteResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<ReviewLiteResource>](ReviewLiteResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ReviewLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies ReviewLiteResourceArrayResponse
|
|
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 ReviewLiteResourceArrayResponse
|
|
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,46 @@
|
|
|
1
|
+
|
|
2
|
+
# ReviewPublicResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`overallRating` | number
|
|
11
|
+
`comment` | string
|
|
12
|
+
`replyText` | string
|
|
13
|
+
`reviewerName` | string
|
|
14
|
+
`location` | string
|
|
15
|
+
`reviewDate` | Date
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { ReviewPublicResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"id": null,
|
|
25
|
+
"overallRating": null,
|
|
26
|
+
"comment": null,
|
|
27
|
+
"replyText": null,
|
|
28
|
+
"reviewerName": null,
|
|
29
|
+
"location": null,
|
|
30
|
+
"reviewDate": null,
|
|
31
|
+
} satisfies ReviewPublicResource
|
|
32
|
+
|
|
33
|
+
console.log(example)
|
|
34
|
+
|
|
35
|
+
// Convert the instance to a JSON string
|
|
36
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
37
|
+
console.log(exampleJSON)
|
|
38
|
+
|
|
39
|
+
// Parse the JSON string back to an object
|
|
40
|
+
const exampleParsed = JSON.parse(exampleJSON) as ReviewPublicResource
|
|
41
|
+
console.log(exampleParsed)
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
45
|
+
|
|
46
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# ReviewPublicResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<ReviewPublicResource>](ReviewPublicResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ReviewPublicResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies ReviewPublicResourceArrayResponse
|
|
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 ReviewPublicResourceArrayResponse
|
|
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,64 @@
|
|
|
1
|
+
|
|
2
|
+
# ReviewResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`reviewerName` | string
|
|
11
|
+
`rating` | number
|
|
12
|
+
`comment` | string
|
|
13
|
+
`replyFromAdmin` | string
|
|
14
|
+
`location` | string
|
|
15
|
+
`createdByAdmin` | boolean
|
|
16
|
+
`approvedAt` | Date
|
|
17
|
+
`reviewDate` | Date
|
|
18
|
+
`createdAt` | Date
|
|
19
|
+
`updatedAt` | Date
|
|
20
|
+
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
21
|
+
`productChild` | [ProductChildLiteResource](ProductChildLiteResource.md)
|
|
22
|
+
`customer` | [CustomerLiteResource](CustomerLiteResource.md)
|
|
23
|
+
`admin` | [AdminUserLiteResource](AdminUserLiteResource.md)
|
|
24
|
+
`approver` | [AdminUserLiteResource](AdminUserLiteResource.md)
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import type { ReviewResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
30
|
+
|
|
31
|
+
// TODO: Update the object below with actual values
|
|
32
|
+
const example = {
|
|
33
|
+
"id": null,
|
|
34
|
+
"reviewerName": null,
|
|
35
|
+
"rating": null,
|
|
36
|
+
"comment": null,
|
|
37
|
+
"replyFromAdmin": null,
|
|
38
|
+
"location": null,
|
|
39
|
+
"createdByAdmin": null,
|
|
40
|
+
"approvedAt": null,
|
|
41
|
+
"reviewDate": null,
|
|
42
|
+
"createdAt": null,
|
|
43
|
+
"updatedAt": null,
|
|
44
|
+
"site": null,
|
|
45
|
+
"productChild": null,
|
|
46
|
+
"customer": null,
|
|
47
|
+
"admin": null,
|
|
48
|
+
"approver": null,
|
|
49
|
+
} satisfies ReviewResource
|
|
50
|
+
|
|
51
|
+
console.log(example)
|
|
52
|
+
|
|
53
|
+
// Convert the instance to a JSON string
|
|
54
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
55
|
+
console.log(exampleJSON)
|
|
56
|
+
|
|
57
|
+
// Parse the JSON string back to an object
|
|
58
|
+
const exampleParsed = JSON.parse(exampleJSON) as ReviewResource
|
|
59
|
+
console.log(exampleParsed)
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
63
|
+
|
|
64
|
+
|
|
@@ -1,20 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# ReviewResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`data` | [Array<ReviewResource>](ReviewResource.md)
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
12
13
|
```typescript
|
|
13
|
-
import type {
|
|
14
|
+
import type { ReviewResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
14
15
|
|
|
15
16
|
// TODO: Update the object below with actual values
|
|
16
17
|
const example = {
|
|
17
|
-
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies ReviewResourceArrayResponse
|
|
18
20
|
|
|
19
21
|
console.log(example)
|
|
20
22
|
|
|
@@ -23,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
23
25
|
console.log(exampleJSON)
|
|
24
26
|
|
|
25
27
|
// Parse the JSON string back to an object
|
|
26
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as ReviewResourceArrayResponse
|
|
27
29
|
console.log(exampleParsed)
|
|
28
30
|
```
|
|
29
31
|
|
|
@@ -11,8 +11,6 @@ Name | Type
|
|
|
11
11
|
`altText` | string
|
|
12
12
|
`mimeType` | string
|
|
13
13
|
`fileId` | number
|
|
14
|
-
`isExternal` | boolean
|
|
15
|
-
`externalUrl` | string
|
|
16
14
|
`isLifestyleImage` | boolean
|
|
17
15
|
`index` | number
|
|
18
16
|
`overlayTemplateIds` | Array<number>
|
|
@@ -29,8 +27,6 @@ const example = {
|
|
|
29
27
|
"altText": null,
|
|
30
28
|
"mimeType": null,
|
|
31
29
|
"fileId": null,
|
|
32
|
-
"isExternal": null,
|
|
33
|
-
"externalUrl": null,
|
|
34
30
|
"isLifestyleImage": null,
|
|
35
31
|
"index": null,
|
|
36
32
|
"overlayTemplateIds": null,
|
|
@@ -15,8 +15,6 @@ Name | Type
|
|
|
15
15
|
`tagLine` | string
|
|
16
16
|
`email` | string
|
|
17
17
|
`website` | string
|
|
18
|
-
`netsuiteId` | number
|
|
19
|
-
`displayNetsuiteId` | number
|
|
20
18
|
`openingHours` | string
|
|
21
19
|
|
|
22
20
|
## Example
|
|
@@ -35,8 +33,6 @@ const example = {
|
|
|
35
33
|
"tagLine": null,
|
|
36
34
|
"email": null,
|
|
37
35
|
"website": null,
|
|
38
|
-
"netsuiteId": null,
|
|
39
|
-
"displayNetsuiteId": null,
|
|
40
36
|
"openingHours": null,
|
|
41
37
|
} satisfies StoreListResource
|
|
42
38
|
|
|
@@ -14,8 +14,6 @@ Name | Type
|
|
|
14
14
|
`altText` | string
|
|
15
15
|
`mimeType` | string
|
|
16
16
|
`fileId` | number
|
|
17
|
-
`isExternal` | boolean
|
|
18
|
-
`externalUrl` | string
|
|
19
17
|
|
|
20
18
|
## Example
|
|
21
19
|
|
|
@@ -32,8 +30,6 @@ const example = {
|
|
|
32
30
|
"altText": null,
|
|
33
31
|
"mimeType": null,
|
|
34
32
|
"fileId": null,
|
|
35
|
-
"isExternal": null,
|
|
36
|
-
"externalUrl": null,
|
|
37
33
|
} satisfies StoreOverlayTemplateAssetRequest
|
|
38
34
|
|
|
39
35
|
console.log(example)
|
|
@@ -19,8 +19,6 @@ Name | Type
|
|
|
19
19
|
`altText` | string
|
|
20
20
|
`mimeType` | string
|
|
21
21
|
`fileId` | number
|
|
22
|
-
`isExternal` | boolean
|
|
23
|
-
`externalUrl` | string
|
|
24
22
|
`seo` | [Array<StoreProductCategoryRequestSeoInner>](StoreProductCategoryRequestSeoInner.md)
|
|
25
23
|
`descriptions` | [Array<StoreProductCategoryRequestDescriptionsInner>](StoreProductCategoryRequestDescriptionsInner.md)
|
|
26
24
|
|
|
@@ -44,8 +42,6 @@ const example = {
|
|
|
44
42
|
"altText": null,
|
|
45
43
|
"mimeType": null,
|
|
46
44
|
"fileId": null,
|
|
47
|
-
"isExternal": null,
|
|
48
|
-
"externalUrl": null,
|
|
49
45
|
"seo": null,
|
|
50
46
|
"descriptions": null,
|
|
51
47
|
} satisfies StoreProductCategoryRequest
|
|
@@ -9,8 +9,6 @@ Name | Type
|
|
|
9
9
|
`altText` | string
|
|
10
10
|
`mimeType` | string
|
|
11
11
|
`fileId` | number
|
|
12
|
-
`isExternal` | boolean
|
|
13
|
-
`externalUrl` | string
|
|
14
12
|
`isLifestyleImage` | boolean
|
|
15
13
|
`index` | number
|
|
16
14
|
`overlayTemplateIds` | Array<number>
|
|
@@ -25,8 +23,6 @@ const example = {
|
|
|
25
23
|
"altText": null,
|
|
26
24
|
"mimeType": null,
|
|
27
25
|
"fileId": null,
|
|
28
|
-
"isExternal": null,
|
|
29
|
-
"externalUrl": null,
|
|
30
26
|
"isLifestyleImage": null,
|
|
31
27
|
"index": null,
|
|
32
28
|
"overlayTemplateIds": null,
|
package/docs/StoreResource.md
CHANGED
|
@@ -15,8 +15,6 @@ Name | Type
|
|
|
15
15
|
`tagLine` | string
|
|
16
16
|
`email` | string
|
|
17
17
|
`website` | string
|
|
18
|
-
`netsuiteId` | number
|
|
19
|
-
`displayNetsuiteId` | number
|
|
20
18
|
`openingHours` | string
|
|
21
19
|
`suppliers` | [Array<SupplierLiteResource>](SupplierLiteResource.md)
|
|
22
20
|
`address` | [AddressResource](AddressResource.md)
|
|
@@ -38,8 +36,6 @@ const example = {
|
|
|
38
36
|
"tagLine": null,
|
|
39
37
|
"email": null,
|
|
40
38
|
"website": null,
|
|
41
|
-
"netsuiteId": null,
|
|
42
|
-
"displayNetsuiteId": null,
|
|
43
39
|
"openingHours": null,
|
|
44
40
|
"suppliers": null,
|
|
45
41
|
"address": null,
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
|
|
2
|
+
# StoreReviewRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`productChildId` | number
|
|
10
|
+
`siteId` | number
|
|
11
|
+
`customerId` | number
|
|
12
|
+
`invoiceItemId` | number
|
|
13
|
+
`reviewerName` | string
|
|
14
|
+
`rating` | number
|
|
15
|
+
`comment` | string
|
|
16
|
+
`location` | string
|
|
17
|
+
`reviewDate` | Date
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { StoreReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"productChildId": null,
|
|
27
|
+
"siteId": null,
|
|
28
|
+
"customerId": null,
|
|
29
|
+
"invoiceItemId": null,
|
|
30
|
+
"reviewerName": null,
|
|
31
|
+
"rating": null,
|
|
32
|
+
"comment": null,
|
|
33
|
+
"location": null,
|
|
34
|
+
"reviewDate": null,
|
|
35
|
+
} satisfies StoreReviewRequest
|
|
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 StoreReviewRequest
|
|
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
|
+
|
|
@@ -15,8 +15,6 @@ Name | Type
|
|
|
15
15
|
`email` | string
|
|
16
16
|
`website` | string
|
|
17
17
|
`openingHours` | Array<string | null>
|
|
18
|
-
`netsuiteId` | number
|
|
19
|
-
`displayNetsuiteId` | number
|
|
20
18
|
`supplierIds` | Array<number>
|
|
21
19
|
`specialDates` | [Array<StoreStoreRequestSpecialDatesInner>](StoreStoreRequestSpecialDatesInner.md)
|
|
22
20
|
`address` | [StoreStoreRequestAddress](StoreStoreRequestAddress.md)
|
|
@@ -37,8 +35,6 @@ const example = {
|
|
|
37
35
|
"email": null,
|
|
38
36
|
"website": null,
|
|
39
37
|
"openingHours": null,
|
|
40
|
-
"netsuiteId": null,
|
|
41
|
-
"displayNetsuiteId": null,
|
|
42
38
|
"supplierIds": null,
|
|
43
39
|
"specialDates": null,
|
|
44
40
|
"address": null,
|
|
@@ -13,8 +13,6 @@ Name | Type
|
|
|
13
13
|
`altText` | string
|
|
14
14
|
`mimeType` | string
|
|
15
15
|
`fileId` | number
|
|
16
|
-
`isExternal` | boolean
|
|
17
|
-
`externalUrl` | string
|
|
18
16
|
`descriptions` | [Array<StoreProductCategoryRequestDescriptionsInner>](StoreProductCategoryRequestDescriptionsInner.md)
|
|
19
17
|
|
|
20
18
|
## Example
|
|
@@ -31,8 +29,6 @@ const example = {
|
|
|
31
29
|
"altText": null,
|
|
32
30
|
"mimeType": null,
|
|
33
31
|
"fileId": null,
|
|
34
|
-
"isExternal": null,
|
|
35
|
-
"externalUrl": null,
|
|
36
32
|
"descriptions": null,
|
|
37
33
|
} satisfies StoreSupplierRequest
|
|
38
34
|
|
|
@@ -9,8 +9,6 @@ Name | Type
|
|
|
9
9
|
`altText` | string
|
|
10
10
|
`mimeType` | string
|
|
11
11
|
`fileId` | number
|
|
12
|
-
`isExternal` | boolean
|
|
13
|
-
`externalUrl` | string
|
|
14
12
|
`isLifestyleImage` | boolean
|
|
15
13
|
`index` | number
|
|
16
14
|
`overlayTemplateIds` | Array<number>
|
|
@@ -25,8 +23,6 @@ const example = {
|
|
|
25
23
|
"altText": null,
|
|
26
24
|
"mimeType": null,
|
|
27
25
|
"fileId": null,
|
|
28
|
-
"isExternal": null,
|
|
29
|
-
"externalUrl": null,
|
|
30
26
|
"isLifestyleImage": null,
|
|
31
27
|
"index": null,
|
|
32
28
|
"overlayTemplateIds": null,
|
|
@@ -13,8 +13,6 @@ Name | Type
|
|
|
13
13
|
`altText` | string
|
|
14
14
|
`mimeType` | string
|
|
15
15
|
`fileId` | number
|
|
16
|
-
`isExternal` | boolean
|
|
17
|
-
`externalUrl` | string
|
|
18
16
|
|
|
19
17
|
## Example
|
|
20
18
|
|
|
@@ -30,8 +28,6 @@ const example = {
|
|
|
30
28
|
"altText": null,
|
|
31
29
|
"mimeType": null,
|
|
32
30
|
"fileId": null,
|
|
33
|
-
"isExternal": null,
|
|
34
|
-
"externalUrl": null,
|
|
35
31
|
} satisfies UpdateOverlayTemplateAssetRequest
|
|
36
32
|
|
|
37
33
|
console.log(example)
|
|
@@ -19,8 +19,6 @@ Name | Type
|
|
|
19
19
|
`altText` | string
|
|
20
20
|
`mimeType` | string
|
|
21
21
|
`fileId` | number
|
|
22
|
-
`isExternal` | boolean
|
|
23
|
-
`externalUrl` | string
|
|
24
22
|
`seo` | [Array<StoreProductCategoryRequestSeoInner>](StoreProductCategoryRequestSeoInner.md)
|
|
25
23
|
`descriptions` | [Array<StoreProductCategoryRequestDescriptionsInner>](StoreProductCategoryRequestDescriptionsInner.md)
|
|
26
24
|
|
|
@@ -44,8 +42,6 @@ const example = {
|
|
|
44
42
|
"altText": null,
|
|
45
43
|
"mimeType": null,
|
|
46
44
|
"fileId": null,
|
|
47
|
-
"isExternal": null,
|
|
48
|
-
"externalUrl": null,
|
|
49
45
|
"seo": null,
|
|
50
46
|
"descriptions": null,
|
|
51
47
|
} satisfies UpdateProductCategoryRequest
|
|
@@ -9,8 +9,6 @@ Name | Type
|
|
|
9
9
|
`altText` | string
|
|
10
10
|
`mimeType` | string
|
|
11
11
|
`fileId` | number
|
|
12
|
-
`isExternal` | boolean
|
|
13
|
-
`externalUrl` | string
|
|
14
12
|
`index` | number
|
|
15
13
|
|
|
16
14
|
## Example
|
|
@@ -23,8 +21,6 @@ const example = {
|
|
|
23
21
|
"altText": null,
|
|
24
22
|
"mimeType": null,
|
|
25
23
|
"fileId": null,
|
|
26
|
-
"isExternal": null,
|
|
27
|
-
"externalUrl": null,
|
|
28
24
|
"index": null,
|
|
29
25
|
} satisfies UpdateProductChildRequestAssetsInner
|
|
30
26
|
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
|
|
2
|
+
# UpdateReviewRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`reviewerName` | string
|
|
10
|
+
`rating` | number
|
|
11
|
+
`comment` | string
|
|
12
|
+
`replyFromAdmin` | string
|
|
13
|
+
`location` | string
|
|
14
|
+
`approved` | boolean
|
|
15
|
+
`reviewDate` | Date
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { UpdateReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"reviewerName": null,
|
|
25
|
+
"rating": null,
|
|
26
|
+
"comment": null,
|
|
27
|
+
"replyFromAdmin": null,
|
|
28
|
+
"location": null,
|
|
29
|
+
"approved": null,
|
|
30
|
+
"reviewDate": null,
|
|
31
|
+
} satisfies UpdateReviewRequest
|
|
32
|
+
|
|
33
|
+
console.log(example)
|
|
34
|
+
|
|
35
|
+
// Convert the instance to a JSON string
|
|
36
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
37
|
+
console.log(exampleJSON)
|
|
38
|
+
|
|
39
|
+
// Parse the JSON string back to an object
|
|
40
|
+
const exampleParsed = JSON.parse(exampleJSON) as UpdateReviewRequest
|
|
41
|
+
console.log(exampleParsed)
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
45
|
+
|
|
46
|
+
|
|
@@ -15,8 +15,6 @@ Name | Type
|
|
|
15
15
|
`email` | string
|
|
16
16
|
`website` | string
|
|
17
17
|
`openingHours` | Array<string | null>
|
|
18
|
-
`netsuiteId` | number
|
|
19
|
-
`displayNetsuiteId` | number
|
|
20
18
|
`supplierIds` | Array<number>
|
|
21
19
|
`specialDates` | [Array<UpdateStoreRequestSpecialDatesInner>](UpdateStoreRequestSpecialDatesInner.md)
|
|
22
20
|
`address` | [StoreStoreRequestAddress](StoreStoreRequestAddress.md)
|
|
@@ -37,8 +35,6 @@ const example = {
|
|
|
37
35
|
"email": null,
|
|
38
36
|
"website": null,
|
|
39
37
|
"openingHours": null,
|
|
40
|
-
"netsuiteId": null,
|
|
41
|
-
"displayNetsuiteId": null,
|
|
42
38
|
"supplierIds": null,
|
|
43
39
|
"specialDates": null,
|
|
44
40
|
"address": null,
|
|
@@ -13,8 +13,6 @@ Name | Type
|
|
|
13
13
|
`altText` | string
|
|
14
14
|
`mimeType` | string
|
|
15
15
|
`fileId` | number
|
|
16
|
-
`isExternal` | boolean
|
|
17
|
-
`externalUrl` | string
|
|
18
16
|
`descriptions` | [Array<StoreProductCategoryRequestDescriptionsInner>](StoreProductCategoryRequestDescriptionsInner.md)
|
|
19
17
|
|
|
20
18
|
## Example
|
|
@@ -31,8 +29,6 @@ const example = {
|
|
|
31
29
|
"altText": null,
|
|
32
30
|
"mimeType": null,
|
|
33
31
|
"fileId": null,
|
|
34
|
-
"isExternal": null,
|
|
35
|
-
"externalUrl": null,
|
|
36
32
|
"descriptions": null,
|
|
37
33
|
} satisfies UpdateSupplierRequest
|
|
38
34
|
|