@digital8/lighting-illusions-ts-sdk 0.0.1842 → 0.0.1843

package/docs/IndexCartRequest.md

@@ -0,0 +1,66 @@
+
+# IndexCartRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`siteId` | Array<string>
+`source` | Array<string>
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
+`beforeExpiryDate` | Date
+`afterExpiryDate` | Date
+`beforeCheckoutCompletedAt` | Date
+`afterCheckoutCompletedAt` | Date
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+`status` | Array<string>
+
+## Example
+
+```typescript
+import type { IndexCartRequest } 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,
+  "source": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": null,
+  "beforeExpiryDate": null,
+  "afterExpiryDate": null,
+  "beforeCheckoutCompletedAt": null,
+  "afterCheckoutCompletedAt": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+  "status": null,
+} satisfies IndexCartRequest
+
+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 IndexCartRequest
+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/IndexCustomerRequest.md

@@ -0,0 +1,50 @@
+
+# IndexCustomerRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`siteId` | Array<string>
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { IndexCustomerRequest } 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,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies IndexCustomerRequest
+
+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 IndexCustomerRequest
+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/LiAddressResource.md

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

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

@@ -0,0 +1,48 @@
+
+# LineItemListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`quantity` | number
+`productPrice` | number
+`productDiscount` | number
+`totalDiscount` | number
+`lineSubtotal` | number
+`discounts` | Array<boolean>
+`productChild` | [ProductChildCartLiteResource](ProductChildCartLiteResource.md)
+
+## Example
+
+```typescript
+import type { LineItemListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "quantity": null,
+  "productPrice": null,
+  "productDiscount": null,
+  "totalDiscount": null,
+  "lineSubtotal": null,
+  "discounts": null,
+  "productChild": null,
+} satisfies LineItemListResource
+
+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 LineItemListResource
+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/LineItemListResourceArrayResponse.md

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

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

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

@@ -0,0 +1,46 @@
+
+# ProductChildCartLiteResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`parentId` | number
+`sku` | string
+`model` | string
+`name` | string
+`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
+`label` | [LabelResource](LabelResource.md)
+
+## Example
+
+```typescript
+import type { ProductChildCartLiteResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "parentId": null,
+  "sku": null,
+  "model": null,
+  "name": null,
+  "thumbnail": null,
+  "label": null,
+} satisfies ProductChildCartLiteResource
+
+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 ProductChildCartLiteResource
+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/ProductChildCartLiteResourceArrayResponse.md

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

@@ -13,6 +13,7 @@ Name | Type
 `rrpPrice` | number
 `salePrice` | number
 `isDisabled` | boolean
+`label` | [LabelResource](LabelResource.md)
 
 ## Example
 
@@ -28,6 +29,7 @@ const example = {
   "rrpPrice": null,
   "salePrice": null,
   "isDisabled": null,
+  "label": null,
 } satisfies ProductChildSiteDetailLiteResource
 
 console.log(example)

package/docs/ShippingType.md

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

@@ -16,6 +16,7 @@ Name | Type
 `acCouponValue` | number
 `acCouponDiscountType` | string
 `acCouponExpiryDays` | number
+`cartExpiryDays` | number
 `acCouponEnabled` | boolean
 
 ## Example
@@ -35,6 +36,7 @@ const example = {
   "acCouponValue": null,
   "acCouponDiscountType": null,
   "acCouponExpiryDays": null,
+  "cartExpiryDays": null,
   "acCouponEnabled": null,
 } satisfies SitePaymentConfigResource
 

package/docs/StoreAssetForAssetableRequest.md

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

package/docs/StoreCartRequest.md

@@ -0,0 +1,62 @@
+
+# StoreCartRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`customerId` | number
+`siteId` | number
+`sessionToken` | string
+`paymentToken` | string
+`source` | string
+`items` | [Array<StoreCartRequestItemsInner>](StoreCartRequestItemsInner.md)
+`customer` | [StoreCartRequestCustomer](StoreCartRequestCustomer.md)
+`shippingType` | string
+`shippingSubtotal` | number
+`overrideShipping` | boolean
+`insuranceAmount` | number
+`overrideInsurance` | boolean
+`useAsBillingAddress` | boolean
+`shippingAddress` | [StoreCartRequestShippingAddress](StoreCartRequestShippingAddress.md)
+`billingAddress` | [StoreCartRequestShippingAddress](StoreCartRequestShippingAddress.md)
+
+## Example
+
+```typescript
+import type { StoreCartRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "customerId": null,
+  "siteId": null,
+  "sessionToken": null,
+  "paymentToken": null,
+  "source": null,
+  "items": null,
+  "customer": null,
+  "shippingType": null,
+  "shippingSubtotal": null,
+  "overrideShipping": null,
+  "insuranceAmount": null,
+  "overrideInsurance": null,
+  "useAsBillingAddress": null,
+  "shippingAddress": null,
+  "billingAddress": null,
+} satisfies StoreCartRequest
+
+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 StoreCartRequest
+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/StoreCartRequestCustomer.md

@@ -0,0 +1,40 @@
+
+# StoreCartRequestCustomer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
+
+## Example
+
+```typescript
+import type { StoreCartRequestCustomer } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "phone": null,
+} satisfies StoreCartRequestCustomer
+
+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 StoreCartRequestCustomer
+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/StoreCartRequestItemsInner.md

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