@digital8/lighting-illusions-ts-sdk 0.0.2199 → 0.0.2201

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

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

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

@@ -0,0 +1,54 @@
+
+# SearchAdminUsersRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`roleId` | Array<string>
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { SearchAdminUsersRequest } 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,
+  "roleId": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies SearchAdminUsersRequest
+
+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 SearchAdminUsersRequest
+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/SearchAllAdminUsersRequest.md

@@ -0,0 +1,44 @@
+
+# SearchAllAdminUsersRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { SearchAllAdminUsersRequest } 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,
+} satisfies SearchAllAdminUsersRequest
+
+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 SearchAllAdminUsersRequest
+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/SearchAllCustomersRequest.md

@@ -0,0 +1,50 @@
+
+# SearchAllCustomersRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+`siteId` | Array<string>
+`type` | Array<string>
+`signUpType` | Array<string>
+
+## Example
+
+```typescript
+import type { SearchAllCustomersRequest } 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,
+  "type": null,
+  "signUpType": null,
+} satisfies SearchAllCustomersRequest
+
+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 SearchAllCustomersRequest
+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>
+`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)
+
+

package/docs/SearchCustomersRequest.md

@@ -0,0 +1,58 @@
+
+# SearchCustomersRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`siteId` | Array<string>
+`type` | Array<string>
+`signUpType` | Array<string>
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
+`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,
+  "type": null,
+  "signUpType": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": 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)
+
+

package/docs/SearchOrderFulfillmentsRequest.md

@@ -0,0 +1,58 @@
+
+# SearchOrderFulfillmentsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`orderId` | Array<string>
+`beforeDateShipped` | Date
+`afterDateShipped` | Date
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { SearchOrderFulfillmentsRequest } 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,
+  "orderId": null,
+  "beforeDateShipped": null,
+  "afterDateShipped": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies SearchOrderFulfillmentsRequest
+
+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 SearchOrderFulfillmentsRequest
+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/SearchOrdersRequest.md

@@ -0,0 +1,68 @@
+
+# SearchOrdersRequest
+
+
+## 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
+`beforeUpdatedAt` | Date
+`afterUpdatedAt` | Date
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { SearchOrdersRequest } 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,
+  "beforeUpdatedAt": null,
+  "afterUpdatedAt": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies SearchOrdersRequest
+
+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 SearchOrdersRequest
+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/SearchTransactionsRequest.md

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