@digital8/lighting-illusions-ts-sdk 0.0.2156 → 0.0.2157

package/docs/PaginatedAdminNoteResourceResponse.md

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

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

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

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

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

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

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

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

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

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

@@ -1,52 +0,0 @@
-
-# ProductChildLineItemLiteResource
-
-
-## 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 { ProductChildLineItemLiteResource } 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 ProductChildLineItemLiteResource
-
-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 ProductChildLineItemLiteResource
-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/ProductChildLineItemLiteResourceArrayResponse.md

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

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

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

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

@@ -1,66 +0,0 @@
-
-# SearchCartsRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`siteId` | Array<string>
-`source` | Array<string>
-`status` | Array<string>
-`beforeCreatedAt` | Date
-`afterCreatedAt` | Date
-`beforeExpiryDate` | Date
-`afterExpiryDate` | Date
-`beforeCheckoutCompletedAt` | Date
-`afterCheckoutCompletedAt` | Date
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## 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,
-  "status": null,
-  "beforeCreatedAt": null,
-  "afterCreatedAt": null,
-  "beforeExpiryDate": null,
-  "afterExpiryDate": null,
-  "beforeCheckoutCompletedAt": null,
-  "afterCheckoutCompletedAt": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": 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)
-
-