@digital8/lighting-illusions-ts-sdk 0.0.2193 → 0.0.2194

package/docs/FrontendCartResourceCouponsInner.md

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

@@ -0,0 +1,50 @@
+
+# FrontendLineItemResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`quantity` | number
+`productPrice` | number
+`subtotalAmount` | number
+`totalAmount` | number
+`promotionalSaving` | number
+`isAvailable` | boolean
+`isInStock` | boolean
+`productChild` | [ProductChildLineItemLiteResource](ProductChildLineItemLiteResource.md)
+
+## Example
+
+```typescript
+import type { FrontendLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "quantity": null,
+  "productPrice": null,
+  "subtotalAmount": null,
+  "totalAmount": null,
+  "promotionalSaving": null,
+  "isAvailable": null,
+  "isInStock": null,
+  "productChild": null,
+} satisfies FrontendLineItemResource
+
+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 FrontendLineItemResource
+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/FrontendLineItemResourceArrayResponse.md

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

@@ -0,0 +1,80 @@
+
+# FrontendOrderResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`cartId` | number
+`siteId` | number
+`placedAt` | Date
+`source` | string
+`paymentToken` | string
+`accessToken` | object
+`shippingType` | string
+`customer` | [CustomerListResource](CustomerListResource.md)
+`status` | object
+`shippingAddress` | [AddressResource](AddressResource.md)
+`billingAddress` | [AddressResource](AddressResource.md)
+`lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
+`coupons` | [Array<CartCouponLiteResource>](CartCouponLiteResource.md)
+`subtotal` | number
+`promotionalDiscount` | number
+`couponSubtotalDiscount` | number
+`couponShippingDiscount` | number
+`shipping` | number
+`transitInsurance` | number
+`gst` | number
+`grandTotal` | number
+`amountPaid` | number
+`amountDue` | number
+
+## Example
+
+```typescript
+import type { FrontendOrderResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "cartId": null,
+  "siteId": null,
+  "placedAt": null,
+  "source": null,
+  "paymentToken": null,
+  "accessToken": null,
+  "shippingType": null,
+  "customer": null,
+  "status": null,
+  "shippingAddress": null,
+  "billingAddress": null,
+  "lineItems": null,
+  "coupons": null,
+  "subtotal": null,
+  "promotionalDiscount": null,
+  "couponSubtotalDiscount": null,
+  "couponShippingDiscount": null,
+  "shipping": null,
+  "transitInsurance": null,
+  "gst": null,
+  "grandTotal": null,
+  "amountPaid": null,
+  "amountDue": null,
+} satisfies FrontendOrderResource
+
+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 FrontendOrderResource
+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/FrontendOrderResourceArrayResponse.md

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

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

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

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

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

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

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

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