@digital8/lighting-illusions-ts-sdk 0.0.1817 → 0.0.1819

package/docs/ReviewListResource.md

@@ -1,54 +0,0 @@
-
-# ReviewListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`reviewerName` | string
-`rating` | number
-`comment` | string
-`replyFromAdmin` | string
-`createdByAdmin` | boolean
-`approvedAt` | Date
-`reviewDate` | Date
-`createdAt` | Date
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`productChild` | [ProductChildLiteResource](ProductChildLiteResource.md)
-
-## Example
-
-```typescript
-import type { ReviewListResource } 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,
-  "createdByAdmin": null,
-  "approvedAt": null,
-  "reviewDate": null,
-  "createdAt": null,
-  "site": null,
-  "productChild": null,
-} satisfies ReviewListResource
-
-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 ReviewListResource
-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/ReviewListResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# ReviewListResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<ReviewListResource>](ReviewListResource.md)
-
-## Example
-
-```typescript
-import type { ReviewListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies ReviewListResourceArrayResponse
-
-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 ReviewListResourceArrayResponse
-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/ReviewLiteResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# ReviewLiteResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<ReviewLiteResource>](ReviewLiteResource.md)
-
-## Example
-
-```typescript
-import type { ReviewLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies ReviewLiteResourceArrayResponse
-
-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 ReviewLiteResourceArrayResponse
-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/ReviewPublicResource.md

@@ -1,46 +0,0 @@
-
-# ReviewPublicResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`overallRating` | number
-`comment` | string
-`replyText` | string
-`reviewerName` | string
-`location` | string
-`createdAt` | Date
-
-## Example
-
-```typescript
-import type { ReviewPublicResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "overallRating": null,
-  "comment": null,
-  "replyText": null,
-  "reviewerName": null,
-  "location": null,
-  "createdAt": null,
-} satisfies ReviewPublicResource
-
-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 ReviewPublicResource
-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/ReviewPublicResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# ReviewPublicResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<ReviewPublicResource>](ReviewPublicResource.md)
-
-## Example
-
-```typescript
-import type { ReviewPublicResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies ReviewPublicResourceArrayResponse
-
-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 ReviewPublicResourceArrayResponse
-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/ReviewResource.md

@@ -1,64 +0,0 @@
-
-# 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/SearchLinkablesMenuItemRequest.md

@@ -1,38 +0,0 @@
-
-# SearchLinkablesMenuItemRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`types` | Array<string>
-`siteId` | number
-
-## Example
-
-```typescript
-import type { SearchLinkablesMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "types": null,
-  "siteId": null,
-} satisfies SearchLinkablesMenuItemRequest
-
-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 SearchLinkablesMenuItemRequest
-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/StoreMenuItemRequest.md

@@ -1,52 +0,0 @@
-
-# StoreMenuItemRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`menuId` | number
-`parentId` | number
-`type` | string
-`heading` | string
-`subheading` | string
-`css` | string
-`cssMobile` | string
-`javascript` | string
-`index` | number
-`menuItemLink` | [StoreMenuItemRequestMenuItemLink](StoreMenuItemRequestMenuItemLink.md)
-
-## Example
-
-```typescript
-import type { StoreMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "menuId": null,
-  "parentId": null,
-  "type": null,
-  "heading": null,
-  "subheading": null,
-  "css": null,
-  "cssMobile": null,
-  "javascript": null,
-  "index": null,
-  "menuItemLink": null,
-} satisfies StoreMenuItemRequest
-
-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 StoreMenuItemRequest
-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/StoreMenuItemRequestMenuItemLink.md

@@ -1,40 +0,0 @@
-
-# StoreMenuItemRequestMenuItemLink
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`linkableType` | string
-`linkableId` | number
-`link` | string
-`isExternalLink` | boolean
-
-## Example
-
-```typescript
-import type { StoreMenuItemRequestMenuItemLink } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "linkableType": null,
-  "linkableId": null,
-  "link": null,
-  "isExternalLink": null,
-} satisfies StoreMenuItemRequestMenuItemLink
-
-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 StoreMenuItemRequestMenuItemLink
-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/StoreReviewRequest.md

@@ -1,50 +0,0 @@
-
-# StoreReviewRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`productChildId` | number
-`siteId` | number
-`customerId` | number
-`invoiceItemId` | number
-`reviewerName` | string
-`rating` | number
-`comment` | string
-`location` | string
-`reviewDate` | Date
-
-## Example
-
-```typescript
-import type { StoreReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "productChildId": null,
-  "siteId": null,
-  "customerId": null,
-  "invoiceItemId": null,
-  "reviewerName": null,
-  "rating": null,
-  "comment": null,
-  "location": null,
-  "reviewDate": null,
-} satisfies StoreReviewRequest
-
-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 StoreReviewRequest
-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/UpdateMenuItemRequest.md

@@ -1,52 +0,0 @@
-
-# UpdateMenuItemRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`menuId` | number
-`parentId` | number
-`type` | string
-`heading` | string
-`subheading` | string
-`css` | string
-`cssMobile` | string
-`javascript` | string
-`index` | number
-`menuItemLink` | [StoreMenuItemRequestMenuItemLink](StoreMenuItemRequestMenuItemLink.md)
-
-## Example
-
-```typescript
-import type { UpdateMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "menuId": null,
-  "parentId": null,
-  "type": null,
-  "heading": null,
-  "subheading": null,
-  "css": null,
-  "cssMobile": null,
-  "javascript": null,
-  "index": null,
-  "menuItemLink": null,
-} satisfies UpdateMenuItemRequest
-
-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 UpdateMenuItemRequest
-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/UpdateMenuRequestMenuItemOrderInner.md

@@ -1,38 +0,0 @@
-
-# UpdateMenuRequestMenuItemOrderInner
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`index` | number
-`parentId` | number
-
-## Example
-
-```typescript
-import type { UpdateMenuRequestMenuItemOrderInner } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "index": null,
-  "parentId": null,
-} satisfies UpdateMenuRequestMenuItemOrderInner
-
-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 UpdateMenuRequestMenuItemOrderInner
-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/UpdateReviewRequest.md

@@ -1,46 +0,0 @@
-
-# UpdateReviewRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`reviewerName` | string
-`rating` | number
-`comment` | string
-`replyFromAdmin` | string
-`location` | string
-`approved` | boolean
-`reviewDate` | Date
-
-## Example
-
-```typescript
-import type { UpdateReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "reviewerName": null,
-  "rating": null,
-  "comment": null,
-  "replyFromAdmin": null,
-  "location": null,
-  "approved": null,
-  "reviewDate": null,
-} satisfies UpdateReviewRequest
-
-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 UpdateReviewRequest
-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)
-
-