@digital8/lighting-illusions-ts-sdk 0.0.2172 → 0.0.2174

package/docs/CreateCartRequest.md

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

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

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

@@ -1,48 +0,0 @@
-
-# CreateTransactionRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`cartId` | number
-`orderId` | number
-`amount` | number
-`surcharge` | number
-`paymentMethod` | string
-`description` | string
-`nonce` | string
-`deviceData` | string
-
-## Example
-
-```typescript
-import type { CreateTransactionRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "cartId": null,
-  "orderId": null,
-  "amount": null,
-  "surcharge": null,
-  "paymentMethod": null,
-  "description": null,
-  "nonce": null,
-  "deviceData": null,
-} satisfies CreateTransactionRequest
-
-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 CreateTransactionRequest
-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/DetachCouponRequest.md

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

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

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

@@ -1,70 +0,0 @@
-
-# FrontendCartResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`lifecycleStatus` | string
-`siteId` | number
-`sessionToken` | string
-`guestEmail` | string
-`customer` | [CustomerListResource](CustomerListResource.md)
-`shippingType` | string
-`shippingAddress` | [AddressResource](AddressResource.md)
-`billingAddress` | [AddressResource](AddressResource.md)
-`lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
-`coupons` | [Array<FrontendCartResourceCouponsInner>](FrontendCartResourceCouponsInner.md)
-`subtotal` | number
-`promotionalDiscount` | number
-`couponSubtotalDiscount` | number
-`couponShippingDiscount` | number
-`shipping` | number
-`transitInsurance` | number
-`gst` | number
-`grandTotal` | number
-
-## Example
-
-```typescript
-import type { FrontendCartResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "lifecycleStatus": null,
-  "siteId": null,
-  "sessionToken": null,
-  "guestEmail": null,
-  "customer": null,
-  "shippingType": 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,
-} satisfies FrontendCartResource
-
-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 FrontendCartResource
-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/FrontendCartResourceArrayResponse.md

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

@@ -1,42 +0,0 @@
-
-# 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

@@ -1,50 +0,0 @@
-
-# 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

@@ -1,34 +0,0 @@
-
-# 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

@@ -1,80 +0,0 @@
-
-# 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

@@ -1,34 +0,0 @@
-
-# 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)
-
-