@digital8/lighting-illusions-ts-sdk 0.0.1922 → 0.0.1924

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/IndexOrderRequest.md

@@ -0,0 +1,64 @@
+
+# IndexOrderRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`siteId` | Array<string>
+`source` | Array<string>
+`statusId` | Array<string>
+`customerId` | Array<string>
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
+`beforePlacedAt` | Date
+`afterPlacedAt` | Date
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { IndexOrderRequest } 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,
+  "statusId": null,
+  "customerId": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": null,
+  "beforePlacedAt": null,
+  "afterPlacedAt": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies IndexOrderRequest
+
+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 IndexOrderRequest
+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/IndexTransactionRequest.md

@@ -0,0 +1,60 @@
+
+# IndexTransactionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`paymentSource` | Array<string>
+`type` | Array<string>
+`paymentMethod` | Array<string>
+`status` | Array<string>
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { IndexTransactionRequest } 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,
+  "paymentSource": null,
+  "type": null,
+  "paymentMethod": null,
+  "status": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies IndexTransactionRequest
+
+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 IndexTransactionRequest
+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/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,50 @@
+
+# LineItemListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`quantity` | number
+`productPrice` | number
+`labelId` | number
+`productDiscount` | number
+`totalDiscount` | number
+`lineSubtotal` | number
+`discounts` | [Array<LineItemDiscountResource>](LineItemDiscountResource.md)
+`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,
+  "labelId": 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/OrderListResource.md

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

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

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

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

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

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