@digital8/lighting-illusions-ts-sdk 0.0.2004 → 0.0.2005

package/docs/PaginatedAdminNoteResourceResponse.md

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

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

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

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

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

@@ -0,0 +1,32 @@
+
+# PaymentStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { PaymentStatus } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies PaymentStatus
+
+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 PaymentStatus
+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,52 @@
+
+# ProductChildCartLiteResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`parentId` | number
+`sku` | string
+`model` | string
+`modelNumber` | string
+`name` | string
+`stock` | number
+`salePrice` | number
+`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,
+  "modelNumber": null,
+  "name": null,
+  "stock": null,
+  "salePrice": 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/RefundTransactionRequest.md

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

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

@@ -0,0 +1,52 @@
+
+# SearchAllOrdersRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+`siteId` | Array<string>
+`source` | Array<string>
+`statusId` | Array<string>
+`customerId` | Array<string>
+
+## Example
+
+```typescript
+import type { SearchAllOrdersRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "search": null,
+  "sortBy": null,
+  "sortDirection": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+  "siteId": null,
+  "source": null,
+  "statusId": null,
+  "customerId": null,
+} satisfies SearchAllOrdersRequest
+
+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 SearchAllOrdersRequest
+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/SearchCartsRequest.md

@@ -0,0 +1,66 @@
+
+# SearchCartsRequest
+
+
+## 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 { SearchCartsRequest } 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 SearchCartsRequest
+
+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 SearchCartsRequest
+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/SearchCustomersRequest.md

@@ -0,0 +1,50 @@
+
+# SearchCustomersRequest
+
+
+## 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 { SearchCustomersRequest } 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 SearchCustomersRequest
+
+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 SearchCustomersRequest
+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)
+
+