@digital8/lighting-illusions-ts-sdk 0.0.2167 → 0.0.2168

package/docs/AdminOrderLineItemResource.md

@@ -1,64 +0,0 @@
-
-# AdminOrderLineItemResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`quantity` | number
-`productPrice` | number
-`labelId` | number
-`label` | [LabelLiteResource](LabelLiteResource.md)
-`productDiscount` | number
-`totalDiscount` | number
-`lineSubtotal` | number
-`discounts` | object
-`productChild` | [ProductChildLineItemLiteResource](ProductChildLineItemLiteResource.md)
-`quantityFulfilled` | number
-`returnsQuantity` | number
-`lastDateShipped` | string
-`lastTrackingNumber` | string
-`lastTrackingUrl` | string
-`totalShipments` | number
-
-## Example
-
-```typescript
-import type { AdminOrderLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "quantity": null,
-  "productPrice": null,
-  "labelId": null,
-  "label": null,
-  "productDiscount": null,
-  "totalDiscount": null,
-  "lineSubtotal": null,
-  "discounts": null,
-  "productChild": null,
-  "quantityFulfilled": null,
-  "returnsQuantity": null,
-  "lastDateShipped": null,
-  "lastTrackingNumber": null,
-  "lastTrackingUrl": null,
-  "totalShipments": null,
-} satisfies AdminOrderLineItemResource
-
-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 AdminOrderLineItemResource
-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/AdminOrderLineItemResourceArrayResponse.md

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

@@ -1,120 +0,0 @@
-
-# AdminOrderResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`cartId` | number
-`placedAt` | Date
-`createdAt` | Date
-`updatedAt` | Date
-`source` | string
-`paymentToken` | string
-`shippingType` | string
-`shippingSubtotal` | number
-`overrideShipping` | boolean
-`lockedInsuranceAmount` | number
-`includeInsurance` | boolean
-`overrideInsurance` | boolean
-`useAsBillingAddress` | boolean
-`netsuiteId` | number
-`isNetsuiteLocked` | boolean
-`subtotal` | number
-`productDiscountAmount` | number
-`subtotalDiscountAmount` | number
-`shippingDiscountAmount` | number
-`shippingAmount` | number
-`total` | number
-`discountAmount` | number
-`finalTotalAmount` | number
-`totalAmount` | number
-`totalShipping` | number
-`grandTotal` | number
-`totalPaid` | number
-`totalOutstanding` | number
-`insuranceEstimate` | number
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`fulfillmentStatus` | string
-`fulfillmentsCount` | object
-`latestFulfillment` | [OrderFulfillmentResource](OrderFulfillmentResource.md)
-`customer` | [CustomerResource](CustomerResource.md)
-`admin` | [LiAdminUserLiteResource](LiAdminUserLiteResource.md)
-`status` | [OrderStatusLiteResource](OrderStatusLiteResource.md)
-`lineItems` | [Array<AdminOrderLineItemResource>](AdminOrderLineItemResource.md)
-`coupons` | [Array<CartCouponResource>](CartCouponResource.md)
-`discounts` | [Array<DiscountResource>](DiscountResource.md)
-`transactions` | [Array<TransactionLiteResource>](TransactionLiteResource.md)
-`shippingAddress` | [AddressResource](AddressResource.md)
-`billingAddress` | [AddressResource](AddressResource.md)
-`omnisendSync` | [OmnisendSyncLiteResource](OmnisendSyncLiteResource.md)
-
-## Example
-
-```typescript
-import type { AdminOrderResource } 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,
-  "paymentToken": null,
-  "shippingType": null,
-  "shippingSubtotal": null,
-  "overrideShipping": null,
-  "lockedInsuranceAmount": null,
-  "includeInsurance": null,
-  "overrideInsurance": null,
-  "useAsBillingAddress": null,
-  "netsuiteId": null,
-  "isNetsuiteLocked": null,
-  "subtotal": null,
-  "productDiscountAmount": null,
-  "subtotalDiscountAmount": null,
-  "shippingDiscountAmount": null,
-  "shippingAmount": null,
-  "total": null,
-  "discountAmount": null,
-  "finalTotalAmount": null,
-  "totalAmount": null,
-  "totalShipping": null,
-  "grandTotal": null,
-  "totalPaid": null,
-  "totalOutstanding": null,
-  "insuranceEstimate": null,
-  "site": null,
-  "fulfillmentStatus": null,
-  "fulfillmentsCount": null,
-  "latestFulfillment": null,
-  "customer": null,
-  "admin": null,
-  "status": null,
-  "lineItems": null,
-  "coupons": null,
-  "discounts": null,
-  "transactions": null,
-  "shippingAddress": null,
-  "billingAddress": null,
-  "omnisendSync": null,
-} satisfies AdminOrderResource
-
-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 AdminOrderResource
-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/AdminOrderResourceArrayResponse.md

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

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

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

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

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

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

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

@@ -1,52 +0,0 @@
-
-# CartListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`guestEmail` | string
-`source` | string
-`checkoutCompletedAt` | Date
-`createdAt` | Date
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`customer` | [CustomerListResource](CustomerListResource.md)
-`lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
-`subtotal` | number
-`status` | string
-
-## Example
-
-```typescript
-import type { CartListResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "guestEmail": null,
-  "source": null,
-  "checkoutCompletedAt": null,
-  "createdAt": null,
-  "site": null,
-  "customer": null,
-  "lineItems": null,
-  "subtotal": null,
-  "status": null,
-} satisfies CartListResource
-
-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 CartListResource
-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/CartListResourceArrayResponse.md

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

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

@@ -1,100 +0,0 @@
-
-# CartResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`guestEmail` | string
-`source` | string
-`sessionToken` | string
-`paymentToken` | string
-`expiryDate` | Date
-`checkoutCompletedAt` | Date
-`createdAt` | Date
-`updatedAt` | Date
-`shippingType` | string
-`shippingSubtotal` | number
-`overrideShipping` | boolean
-`lockedInsuranceAmount` | string
-`includeInsurance` | boolean
-`overrideInsurance` | boolean
-`useAsBillingAddress` | boolean
-`admin` | [LiAdminUserLiteResource](LiAdminUserLiteResource.md)
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`customer` | [CustomerResource](CustomerResource.md)
-`lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
-`coupons` | object
-`shippingAddress` | [AddressResource](AddressResource.md)
-`billingAddress` | [AddressResource](AddressResource.md)
-`discountPreview` | number
-`subtotal` | number
-`shippingAmount` | number
-`insuranceEstimate` | number
-`total` | number
-`discountAmount` | number
-`productDiscountAmount` | number
-`shippingDiscountAmount` | number
-`subtotalDiscountAmount` | number
-`finalTotalAmount` | number
-`status` | string
-
-## Example
-
-```typescript
-import type { CartResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "guestEmail": null,
-  "source": null,
-  "sessionToken": null,
-  "paymentToken": null,
-  "expiryDate": null,
-  "checkoutCompletedAt": null,
-  "createdAt": null,
-  "updatedAt": null,
-  "shippingType": null,
-  "shippingSubtotal": null,
-  "overrideShipping": null,
-  "lockedInsuranceAmount": null,
-  "includeInsurance": null,
-  "overrideInsurance": null,
-  "useAsBillingAddress": null,
-  "admin": null,
-  "site": null,
-  "customer": null,
-  "lineItems": null,
-  "coupons": null,
-  "shippingAddress": null,
-  "billingAddress": null,
-  "discountPreview": null,
-  "subtotal": null,
-  "shippingAmount": null,
-  "insuranceEstimate": null,
-  "total": null,
-  "discountAmount": null,
-  "productDiscountAmount": null,
-  "shippingDiscountAmount": null,
-  "subtotalDiscountAmount": null,
-  "finalTotalAmount": null,
-  "status": null,
-} satisfies CartResource
-
-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 CartResource
-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)
-
-