@digital8/lighting-illusions-ts-sdk 0.0.1854 → 0.0.1855

package/docs/SitesUpdateSiteRequest.md

@@ -1,76 +0,0 @@
-
-# SitesUpdateSiteRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`senderName` | string
-`senderEmail` | string
-`phoneNumber` | string
-`tollFreeNumber` | string
-`fullAddress` | string
-`shortAddress` | string
-`invoiceHeader` | string
-`googleMaps` | string
-`facebook` | string
-`instagram` | string
-`pinterest` | string
-`abn` | string
-`shippingAmount` | number
-`freeShippingThreshold` | number
-`insuranceThreshold` | number
-`insuranceBase` | number
-`insuranceAdditional` | number
-`amexSurcharge` | number
-`acCouponValue` | number
-`acCouponDiscountType` | string
-`acCouponExpiryDays` | number
-`acCouponEnabled` | boolean
-
-## Example
-
-```typescript
-import type { SitesUpdateSiteRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "senderName": null,
-  "senderEmail": null,
-  "phoneNumber": null,
-  "tollFreeNumber": null,
-  "fullAddress": null,
-  "shortAddress": null,
-  "invoiceHeader": null,
-  "googleMaps": null,
-  "facebook": null,
-  "instagram": null,
-  "pinterest": null,
-  "abn": null,
-  "shippingAmount": null,
-  "freeShippingThreshold": null,
-  "insuranceThreshold": null,
-  "insuranceBase": null,
-  "insuranceAdditional": null,
-  "amexSurcharge": null,
-  "acCouponValue": null,
-  "acCouponDiscountType": null,
-  "acCouponExpiryDays": null,
-  "acCouponEnabled": null,
-} satisfies SitesUpdateSiteRequest
-
-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 SitesUpdateSiteRequest
-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/StoresAttachSuppliersToStoreRequest.md

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

@@ -1,56 +0,0 @@
-
-# StoresCreateStoreRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`siteId` | number
-`name` | string
-`phone` | string
-`longitude` | number
-`latitude` | number
-`tagLine` | string
-`email` | string
-`website` | string
-`openingHours` | Array<string | null>
-`supplierIds` | Array<number>
-`specialDates` | [Array<StoresCreateStoreRequestSpecialDatesInner>](StoresCreateStoreRequestSpecialDatesInner.md)
-`address` | [StoresCreateStoreRequestAddress](StoresCreateStoreRequestAddress.md)
-
-## Example
-
-```typescript
-import type { StoresCreateStoreRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "siteId": null,
-  "name": null,
-  "phone": null,
-  "longitude": null,
-  "latitude": null,
-  "tagLine": null,
-  "email": null,
-  "website": null,
-  "openingHours": null,
-  "supplierIds": null,
-  "specialDates": null,
-  "address": null,
-} satisfies StoresCreateStoreRequest
-
-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 StoresCreateStoreRequest
-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/StoresCreateStoreRequestAddress.md

@@ -1,46 +0,0 @@
-
-# StoresCreateStoreRequestAddress
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`company` | string
-`line1` | string
-`line2` | string
-`postcode` | string
-`suburb` | string
-`country` | string
-`state` | string
-
-## Example
-
-```typescript
-import type { StoresCreateStoreRequestAddress } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "company": null,
-  "line1": null,
-  "line2": null,
-  "postcode": null,
-  "suburb": null,
-  "country": null,
-  "state": null,
-} satisfies StoresCreateStoreRequestAddress
-
-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 StoresCreateStoreRequestAddress
-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/StoresCreateStoreRequestSpecialDatesInner.md

@@ -1,44 +0,0 @@
-
-# StoresCreateStoreRequestSpecialDatesInner
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`name` | string
-`hours` | string
-`date` | Date
-`closed` | boolean
-`displayStartDate` | Date
-`displayEndDate` | Date
-
-## Example
-
-```typescript
-import type { StoresCreateStoreRequestSpecialDatesInner } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "name": null,
-  "hours": null,
-  "date": null,
-  "closed": null,
-  "displayStartDate": null,
-  "displayEndDate": null,
-} satisfies StoresCreateStoreRequestSpecialDatesInner
-
-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 StoresCreateStoreRequestSpecialDatesInner
-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/StoresDetachSuppliersFromStoreRequest.md

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

@@ -1,48 +0,0 @@
-
-# StoresSearchAllStoresRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`siteId` | Array<string>
-`suppliersId` | Array<string>
-
-## Example
-
-```typescript
-import type { StoresSearchAllStoresRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "siteId": null,
-  "suppliersId": null,
-} satisfies StoresSearchAllStoresRequest
-
-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 StoresSearchAllStoresRequest
-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/StoresSearchStoresRequest.md

@@ -1,52 +0,0 @@
-
-# StoresSearchStoresRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`siteId` | Array<string>
-`suppliersId` | Array<string>
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { StoresSearchStoresRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "siteId": null,
-  "suppliersId": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies StoresSearchStoresRequest
-
-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 StoresSearchStoresRequest
-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/StoresStoreSpecialDateRequest.md

@@ -1,44 +0,0 @@
-
-# StoresStoreSpecialDateRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`name` | string
-`hours` | string
-`date` | Date
-`closed` | boolean
-`displayStartDate` | Date
-`displayEndDate` | Date
-
-## Example
-
-```typescript
-import type { StoresStoreSpecialDateRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "name": null,
-  "hours": null,
-  "date": null,
-  "closed": null,
-  "displayStartDate": null,
-  "displayEndDate": null,
-} satisfies StoresStoreSpecialDateRequest
-
-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 StoresStoreSpecialDateRequest
-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/StoresUpdateStoreRequest.md

@@ -1,56 +0,0 @@
-
-# StoresUpdateStoreRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`siteId` | number
-`name` | string
-`phone` | string
-`longitude` | number
-`latitude` | number
-`tagLine` | string
-`email` | string
-`website` | string
-`openingHours` | Array<string | null>
-`supplierIds` | Array<number>
-`specialDates` | [Array<StoresUpdateStoreRequestSpecialDatesInner>](StoresUpdateStoreRequestSpecialDatesInner.md)
-`address` | [StoresCreateStoreRequestAddress](StoresCreateStoreRequestAddress.md)
-
-## Example
-
-```typescript
-import type { StoresUpdateStoreRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "siteId": null,
-  "name": null,
-  "phone": null,
-  "longitude": null,
-  "latitude": null,
-  "tagLine": null,
-  "email": null,
-  "website": null,
-  "openingHours": null,
-  "supplierIds": null,
-  "specialDates": null,
-  "address": null,
-} satisfies StoresUpdateStoreRequest
-
-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 StoresUpdateStoreRequest
-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/StoresUpdateStoreRequestSpecialDatesInner.md

@@ -1,42 +0,0 @@
-
-# StoresUpdateStoreRequestSpecialDatesInner
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`hours` | string
-`displayStart` | Date
-`displayEnd` | Date
-
-## Example
-
-```typescript
-import type { StoresUpdateStoreRequestSpecialDatesInner } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "hours": null,
-  "displayStart": null,
-  "displayEnd": null,
-} satisfies StoresUpdateStoreRequestSpecialDatesInner
-
-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 StoresUpdateStoreRequestSpecialDatesInner
-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/SuppliersAttachStoresToSupplierRequest.md

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

@@ -1,48 +0,0 @@
-
-# SuppliersCreateSupplierRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`name` | string
-`slug` | string
-`supplierEta` | number
-`seo` | [Array<BlogCategoriesCreateBlogCategoryRequestSeoInner>](BlogCategoriesCreateBlogCategoryRequestSeoInner.md)
-`altText` | string
-`mimeType` | string
-`fileId` | number
-`descriptions` | [Array<BlogCategoriesCreateBlogCategoryRequestDescriptionsInner>](BlogCategoriesCreateBlogCategoryRequestDescriptionsInner.md)
-
-## Example
-
-```typescript
-import type { SuppliersCreateSupplierRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "name": null,
-  "slug": null,
-  "supplierEta": null,
-  "seo": null,
-  "altText": null,
-  "mimeType": null,
-  "fileId": null,
-  "descriptions": null,
-} satisfies SuppliersCreateSupplierRequest
-
-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 SuppliersCreateSupplierRequest
-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/SuppliersDetachStoresFromSupplierRequest.md

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