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

package/docs/LiAddressResource.md

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

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

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

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

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

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

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

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

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

package/docs/OrderFulfillmentLineItemResourceArrayResponse.md

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

@@ -1,54 +0,0 @@
-
-# OrderFulfillmentResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`orderId` | number
-`dateShipped` | Date
-`trackingNumber` | string
-`trackingUrl` | string
-`trackingCompany` | string
-`docnum` | string
-`netsuiteId` | string
-`createdAt` | Date
-`updatedAt` | Date
-`orderFulfillmentLineItems` | [Array<OrderFulfillmentLineItemResource>](OrderFulfillmentLineItemResource.md)
-
-## Example
-
-```typescript
-import type { OrderFulfillmentResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "orderId": null,
-  "dateShipped": null,
-  "trackingNumber": null,
-  "trackingUrl": null,
-  "trackingCompany": null,
-  "docnum": null,
-  "netsuiteId": null,
-  "createdAt": null,
-  "updatedAt": null,
-  "orderFulfillmentLineItems": null,
-} satisfies OrderFulfillmentResource
-
-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 OrderFulfillmentResource
-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/OrderFulfillmentResourceArrayResponse.md

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

@@ -1,58 +0,0 @@
-
-# OrderListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`placedAt` | Date
-`createdAt` | Date
-`source` | string
-`netsuiteId` | string
-`subtotal` | number
-`finalTotalAmount` | number
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`customer` | [CustomerListResource](CustomerListResource.md)
-`status` | [OrderStatusLiteResource](OrderStatusLiteResource.md)
-`lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
-`latestTransaction` | [TransactionLiteResource](TransactionLiteResource.md)
-`transactionsCount` | number
-
-## Example
-
-```typescript
-import type { OrderListResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "placedAt": null,
-  "createdAt": null,
-  "source": null,
-  "netsuiteId": null,
-  "subtotal": null,
-  "finalTotalAmount": null,
-  "site": null,
-  "customer": null,
-  "status": null,
-  "lineItems": null,
-  "latestTransaction": null,
-  "transactionsCount": null,
-} satisfies OrderListResource
-
-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 OrderListResource
-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/OrderLiteResource.md

@@ -1,44 +0,0 @@
-
-# OrderLiteResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`placedAt` | Date
-`finalTotalAmount` | number
-`customerId` | number
-`siteId` | number
-`statusId` | number
-
-## Example
-
-```typescript
-import type { OrderLiteResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "placedAt": null,
-  "finalTotalAmount": null,
-  "customerId": null,
-  "siteId": null,
-  "statusId": null,
-} satisfies OrderLiteResource
-
-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 OrderLiteResource
-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/OrderLiteResourceArrayResponse.md

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

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

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