npm - @digital8/lighting-illusions-ts-sdk - Versions diffs - 0.0.1878 → 0.0.1879 - Mend

@digital8/lighting-illusions-ts-sdk 0.0.1878 → 0.0.1879

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (528) hide show

package/docs/{PageListResourceArrayResponse.md → ReviewLiteResourceArrayResponse.md} RENAMED Viewed

@@ -1,22 +1,22 @@
-# PageListResourceArrayResponse
+# ReviewLiteResourceArrayResponse
 ## Properties
 Name | Type
 ------------ | -------------
-`data` | [Array&lt;PageListResource&gt;](PageListResource.md)
+`data` | [Array&lt;ReviewLiteResource&gt;](ReviewLiteResource.md)
 ## Example
 ```typescript
-import type { PageListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { ReviewLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies PageListResourceArrayResponse
+} satisfies ReviewLiteResourceArrayResponse
 console.log(example)
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PageListResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as ReviewLiteResourceArrayResponse
 console.log(exampleParsed)
 ```

package/docs/ReviewResource.md ADDED Viewed

@@ -0,0 +1,64 @@
+# ReviewResource
+## Properties
+Name | Type
+------------ | -------------
+`id` | number
+`reviewerName` | string
+`rating` | number
+`comment` | string
+`replyFromAdmin` | string
+`location` | string
+`createdByAdmin` | boolean
+`approvedAt` | Date
+`reviewDate` | Date
+`createdAt` | Date
+`updatedAt` | Date
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`productChild` | [ProductChildLiteResource](ProductChildLiteResource.md)
+`customer` | [CustomerLiteResource](CustomerLiteResource.md)
+`admin` | [AdminUserLiteResource](AdminUserLiteResource.md)
+`approver` | [AdminUserLiteResource](AdminUserLiteResource.md)
+## Example
+```typescript
+import type { ReviewResource } from '@digital8/lighting-illusions-ts-sdk'
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "reviewerName": null,
+  "rating": null,
+  "comment": null,
+  "replyFromAdmin": null,
+  "location": null,
+  "createdByAdmin": null,
+  "approvedAt": null,
+  "reviewDate": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "site": null,
+  "productChild": null,
+  "customer": null,
+  "admin": null,
+  "approver": null,
+} satisfies ReviewResource
+console.log(example)
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ReviewResource
+console.log(exampleParsed)
+```
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/{PageResourceArrayResponse.md → ReviewResourceArrayResponse.md} RENAMED Viewed

@@ -1,22 +1,22 @@
-# PageResourceArrayResponse
+# ReviewResourceArrayResponse
 ## Properties
 Name | Type
 ------------ | -------------
-`data` | [Array&lt;PageResource&gt;](PageResource.md)
+`data` | [Array&lt;ReviewResource&gt;](ReviewResource.md)
 ## Example
 ```typescript
-import type { PageResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { ReviewResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies PageResourceArrayResponse
+} satisfies ReviewResourceArrayResponse
 console.log(example)
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PageResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as ReviewResourceArrayResponse
 console.log(exampleParsed)
 ```

package/docs/StoreAssetForAssetableRequest.md CHANGED Viewed

@@ -11,8 +11,6 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
 `isLifestyleImage` | boolean
 `index` | number
 `overlayTemplateIds` | Array&lt;number&gt;
@@ -29,8 +27,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
   "isLifestyleImage": null,
   "index": null,
   "overlayTemplateIds": null,

package/docs/{BlogResourceArrayResponse.md → StoreDocumentFileRequest.md} RENAMED Viewed

@@ -1,22 +1,24 @@
-# BlogResourceArrayResponse
+# StoreDocumentFileRequest
 ## Properties
 Name | Type
 ------------ | -------------
-`data` | [Array&lt;BlogResource&gt;](BlogResource.md)
+`fileName` | string
+`fileType` | string
 ## Example
 ```typescript
-import type { BlogResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { StoreDocumentFileRequest } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
-  "data": null,
-} satisfies BlogResourceArrayResponse
+  "fileName": null,
+  "fileType": null,
+} satisfies StoreDocumentFileRequest
 console.log(example)
@@ -25,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as BlogResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as StoreDocumentFileRequest
 console.log(exampleParsed)
 ```

package/docs/{BlogCategoryLiteResource.md → StoreDocumentRequest.md} RENAMED Viewed

@@ -1,26 +1,26 @@
-# BlogCategoryLiteResource
+# StoreDocumentRequest
 ## Properties
 Name | Type
 ------------ | -------------
-`id` | number
 `name` | string
-`slug` | string
+`fileId` | string
+`siteIds` | Array&lt;string&gt;
 ## Example
 ```typescript
-import type { BlogCategoryLiteResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { StoreDocumentRequest } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
   "name": null,
-  "slug": null,
-} satisfies BlogCategoryLiteResource
+  "fileId": null,
+  "siteIds": null,
+} satisfies StoreDocumentRequest
 console.log(example)
@@ -29,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as BlogCategoryLiteResource
+const exampleParsed = JSON.parse(exampleJSON) as StoreDocumentRequest
 console.log(exampleParsed)
 ```

package/docs/StoreListResource.md CHANGED Viewed

@@ -15,8 +15,6 @@ Name | Type
 `tagLine` | string
 `email` | string
 `website` | string
-`netsuiteId` | number
-`displayNetsuiteId` | number
 `openingHours` | string
 ## Example
@@ -35,8 +33,6 @@ const example = {
   "tagLine": null,
   "email": null,
   "website": null,
-  "netsuiteId": null,
-  "displayNetsuiteId": null,
   "openingHours": null,
 } satisfies StoreListResource

package/docs/StoreOverlayTemplateAssetRequest.md CHANGED Viewed

@@ -14,8 +14,6 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
 ## Example
@@ -32,8 +30,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
 } satisfies StoreOverlayTemplateAssetRequest
 console.log(example)

package/docs/StoreProductCategoryRequest.md CHANGED Viewed

@@ -19,10 +19,8 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
-`seo` | [Array&lt;StoreBlogCategoryRequestSeoInner&gt;](StoreBlogCategoryRequestSeoInner.md)
-`descriptions` | [Array&lt;StoreBlogCategoryRequestDescriptionsInner&gt;](StoreBlogCategoryRequestDescriptionsInner.md)
+`seo` | [Array&lt;StoreProductCategoryRequestSeoInner&gt;](StoreProductCategoryRequestSeoInner.md)
+`descriptions` | [Array&lt;StoreProductCategoryRequestDescriptionsInner&gt;](StoreProductCategoryRequestDescriptionsInner.md)
 ## Example
@@ -44,8 +42,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
   "seo": null,
   "descriptions": null,
 } satisfies StoreProductCategoryRequest

package/docs/{StoreBlogCategoryRequestDescriptionsInner.md → StoreProductCategoryRequestDescriptionsInner.md} RENAMED Viewed

@@ -1,5 +1,5 @@
-# StoreBlogCategoryRequestDescriptionsInner
+# StoreProductCategoryRequestDescriptionsInner
 ## Properties
@@ -13,14 +13,14 @@ Name | Type
 ## Example
 ```typescript
-import type { StoreBlogCategoryRequestDescriptionsInner } from '@digital8/lighting-illusions-ts-sdk'
+import type { StoreProductCategoryRequestDescriptionsInner } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "headerDescription": null,
   "footerDescription": null,
   "siteId": null,
-} satisfies StoreBlogCategoryRequestDescriptionsInner
+} satisfies StoreProductCategoryRequestDescriptionsInner
 console.log(example)
@@ -29,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as StoreBlogCategoryRequestDescriptionsInner
+const exampleParsed = JSON.parse(exampleJSON) as StoreProductCategoryRequestDescriptionsInner
 console.log(exampleParsed)
 ```

package/docs/{StoreBlogCategoryRequestSeoInner.md → StoreProductCategoryRequestSeoInner.md} RENAMED Viewed

@@ -1,5 +1,5 @@
-# StoreBlogCategoryRequestSeoInner
+# StoreProductCategoryRequestSeoInner
 ## Properties
@@ -13,14 +13,14 @@ Name | Type
 ## Example
 ```typescript
-import type { StoreBlogCategoryRequestSeoInner } from '@digital8/lighting-illusions-ts-sdk'
+import type { StoreProductCategoryRequestSeoInner } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "seoTitle": null,
   "seoDescription": null,
   "siteId": null,
-} satisfies StoreBlogCategoryRequestSeoInner
+} satisfies StoreProductCategoryRequestSeoInner
 console.log(example)
@@ -29,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as StoreBlogCategoryRequestSeoInner
+const exampleParsed = JSON.parse(exampleJSON) as StoreProductCategoryRequestSeoInner
 console.log(exampleParsed)
 ```

package/docs/StoreProductChildRequestAssetsInner.md CHANGED Viewed

@@ -9,8 +9,6 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
 `isLifestyleImage` | boolean
 `index` | number
 `overlayTemplateIds` | Array&lt;number&gt;
@@ -25,8 +23,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
   "isLifestyleImage": null,
   "index": null,
   "overlayTemplateIds": null,

package/docs/StoreResource.md CHANGED Viewed

@@ -15,8 +15,6 @@ Name | Type
 `tagLine` | string
 `email` | string
 `website` | string
-`netsuiteId` | number
-`displayNetsuiteId` | number
 `openingHours` | string
 `suppliers` | [Array&lt;SupplierLiteResource&gt;](SupplierLiteResource.md)
 `address` | [AddressResource](AddressResource.md)
@@ -38,8 +36,6 @@ const example = {
   "tagLine": null,
   "email": null,
   "website": null,
-  "netsuiteId": null,
-  "displayNetsuiteId": null,
   "openingHours": null,
   "suppliers": null,
   "address": null,

package/docs/{ProductRangeSiteDetailFrontendResource.md → StoreReviewRequest.md} RENAMED Viewed

@@ -1,34 +1,38 @@
-# ProductRangeSiteDetailFrontendResource
+# StoreReviewRequest
 ## Properties
 Name | Type
 ------------ | -------------
-`id` | number
+`productChildId` | number
 `siteId` | number
-`slug` | string
-`name` | string
-`description` | string
-`content` | string
-`thumbnail` | string
+`customerId` | number
+`invoiceItemId` | number
+`reviewerName` | string
+`rating` | number
+`comment` | string
+`location` | string
+`reviewDate` | Date
 ## Example
 ```typescript
-import type { ProductRangeSiteDetailFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { StoreReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
+  "productChildId": null,
   "siteId": null,
-  "slug": null,
-  "name": null,
-  "description": null,
-  "content": null,
-  "thumbnail": null,
-} satisfies ProductRangeSiteDetailFrontendResource
+  "customerId": null,
+  "invoiceItemId": null,
+  "reviewerName": null,
+  "rating": null,
+  "comment": null,
+  "location": null,
+  "reviewDate": null,
+} satisfies StoreReviewRequest
 console.log(example)
@@ -37,7 +41,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ProductRangeSiteDetailFrontendResource
+const exampleParsed = JSON.parse(exampleJSON) as StoreReviewRequest
 console.log(exampleParsed)
 ```

package/docs/StoreSpecialDateFrontendResource.md CHANGED Viewed

@@ -9,7 +9,7 @@ Name | Type
 `id` | number
 `name` | string
 `hours` | string
-`date` | string
+`date` | object
 `closed` | boolean
 `displayStartDate` | object
 `displayEndDate` | object

package/docs/StoreSpecialDateResource.md CHANGED Viewed

@@ -9,7 +9,7 @@ Name | Type
 `id` | number
 `name` | string
 `hours` | string
-`date` | object
+`date` | string
 `closed` | boolean
 `displayStartDate` | string
 `displayEndDate` | string

package/docs/StoreStoreRequest.md CHANGED Viewed

@@ -15,8 +15,6 @@ Name | Type
 `email` | string
 `website` | string
 `openingHours` | Array&lt;string | null&gt;
-`netsuiteId` | number
-`displayNetsuiteId` | number
 `supplierIds` | Array&lt;number&gt;
 `specialDates` | [Array&lt;StoreStoreRequestSpecialDatesInner&gt;](StoreStoreRequestSpecialDatesInner.md)
 `address` | [StoreStoreRequestAddress](StoreStoreRequestAddress.md)
@@ -37,8 +35,6 @@ const example = {
   "email": null,
   "website": null,
   "openingHours": null,
-  "netsuiteId": null,
-  "displayNetsuiteId": null,
   "supplierIds": null,
   "specialDates": null,
   "address": null,

package/docs/StoreSupplierRequest.md CHANGED Viewed

@@ -9,13 +9,11 @@ Name | Type
 `name` | string
 `slug` | string
 `supplierEta` | number
-`seo` | [Array&lt;StoreBlogCategoryRequestSeoInner&gt;](StoreBlogCategoryRequestSeoInner.md)
+`seo` | [Array&lt;StoreProductCategoryRequestSeoInner&gt;](StoreProductCategoryRequestSeoInner.md)
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
-`descriptions` | [Array&lt;StoreBlogCategoryRequestDescriptionsInner&gt;](StoreBlogCategoryRequestDescriptionsInner.md)
+`descriptions` | [Array&lt;StoreProductCategoryRequestDescriptionsInner&gt;](StoreProductCategoryRequestDescriptionsInner.md)
 ## Example
@@ -31,8 +29,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
   "descriptions": null,
 } satisfies StoreSupplierRequest

package/docs/UpdateAssetForAssetableRequest.md CHANGED Viewed

@@ -9,8 +9,6 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
 `isLifestyleImage` | boolean
 `index` | number
 `overlayTemplateIds` | Array&lt;number&gt;
@@ -25,8 +23,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
   "isLifestyleImage": null,
   "index": null,
   "overlayTemplateIds": null,

package/docs/{FrontendComponentLiteResource.md → UpdateDocumentRequest.md} RENAMED Viewed

@@ -1,26 +1,26 @@
-# FrontendComponentLiteResource
+# UpdateDocumentRequest
 ## Properties
 Name | Type
 ------------ | -------------
-`id` | number
 `name` | string
-`schema` | object
+`fileId` | string
+`siteIds` | Array&lt;string&gt;
 ## Example
 ```typescript
-import type { FrontendComponentLiteResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { UpdateDocumentRequest } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
   "name": null,
-  "schema": null,
-} satisfies FrontendComponentLiteResource
+  "fileId": null,
+  "siteIds": null,
+} satisfies UpdateDocumentRequest
 console.log(example)
@@ -29,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as FrontendComponentLiteResource
+const exampleParsed = JSON.parse(exampleJSON) as UpdateDocumentRequest
 console.log(exampleParsed)
 ```

package/docs/UpdateOverlayTemplateAssetRequest.md CHANGED Viewed

@@ -13,8 +13,6 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
 ## Example
@@ -30,8 +28,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
 } satisfies UpdateOverlayTemplateAssetRequest
 console.log(example)

package/docs/UpdateProductCategoryRequest.md CHANGED Viewed

@@ -19,10 +19,8 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
-`seo` | [Array&lt;StoreBlogCategoryRequestSeoInner&gt;](StoreBlogCategoryRequestSeoInner.md)
-`descriptions` | [Array&lt;StoreBlogCategoryRequestDescriptionsInner&gt;](StoreBlogCategoryRequestDescriptionsInner.md)
+`seo` | [Array&lt;StoreProductCategoryRequestSeoInner&gt;](StoreProductCategoryRequestSeoInner.md)
+`descriptions` | [Array&lt;StoreProductCategoryRequestDescriptionsInner&gt;](StoreProductCategoryRequestDescriptionsInner.md)
 ## Example
@@ -44,8 +42,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
   "seo": null,
   "descriptions": null,
 } satisfies UpdateProductCategoryRequest

package/docs/UpdateProductChildRequestAssetsInner.md CHANGED Viewed

@@ -9,8 +9,6 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
 `index` | number
 ## Example
@@ -23,8 +21,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
   "index": null,
 } satisfies UpdateProductChildRequestAssetsInner