@digital8/lighting-illusions-ts-sdk 0.0.2149 → 0.0.2150

package/docs/SearchCustomersRequest.md

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

package/docs/SearchOrderFulfillmentsRequest.md

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

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

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

package/docs/ShippingType.md

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

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

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

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

@@ -1,62 +0,0 @@
-
-# TransactionListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`paymentSource` | string
-`paymentMethod` | string
-`type` | string
-`status` | string
-`totalAmount` | number
-`surcharge` | number
-`refundedAmount` | number
-`unrefundedAmount` | number
-`reference` | string
-`description` | string
-`extendedData` | string
-`riskScore` | string
-`fraudDecision` | string
-`createdAt` | Date
-
-## Example
-
-```typescript
-import type { TransactionListResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "paymentSource": null,
-  "paymentMethod": null,
-  "type": null,
-  "status": null,
-  "totalAmount": null,
-  "surcharge": null,
-  "refundedAmount": null,
-  "unrefundedAmount": null,
-  "reference": null,
-  "description": null,
-  "extendedData": null,
-  "riskScore": null,
-  "fraudDecision": null,
-  "createdAt": null,
-} satisfies TransactionListResource
-
-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 TransactionListResource
-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/TransactionListResourceArrayResponse.md

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

@@ -1,56 +0,0 @@
-
-# TransactionLiteResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`paymentSource` | string
-`paymentMethod` | string
-`paymentMethodThumbnail` | string
-`type` | string
-`status` | string
-`amount` | number
-`surcharge` | number
-`totalAmount` | number
-`reference` | string
-`description` | string
-`createdAt` | Date
-
-## Example
-
-```typescript
-import type { TransactionLiteResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "paymentSource": null,
-  "paymentMethod": null,
-  "paymentMethodThumbnail": null,
-  "type": null,
-  "status": null,
-  "amount": null,
-  "surcharge": null,
-  "totalAmount": null,
-  "reference": null,
-  "description": null,
-  "createdAt": null,
-} satisfies TransactionLiteResource
-
-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 TransactionLiteResource
-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/TransactionLiteResourceArrayResponse.md

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

@@ -1,66 +0,0 @@
-
-# TransactionResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`paymentSource` | string
-`paymentMethod` | string
-`type` | string
-`status` | string
-`amount` | number
-`surcharge` | number
-`totalAmount` | number
-`refundedAmount` | number
-`unrefundedAmount` | number
-`reference` | string
-`description` | string
-`extendedData` | string
-`riskScore` | string
-`fraudDecision` | string
-`refundedTransactionId` | number
-`createdAt` | Date
-
-## Example
-
-```typescript
-import type { TransactionResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "paymentSource": null,
-  "paymentMethod": null,
-  "type": null,
-  "status": null,
-  "amount": null,
-  "surcharge": null,
-  "totalAmount": null,
-  "refundedAmount": null,
-  "unrefundedAmount": null,
-  "reference": null,
-  "description": null,
-  "extendedData": null,
-  "riskScore": null,
-  "fraudDecision": null,
-  "refundedTransactionId": null,
-  "createdAt": null,
-} satisfies TransactionResource
-
-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 TransactionResource
-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/TransactionResourceArrayResponse.md

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

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