@digital8/lighting-illusions-ts-sdk 0.0.2303 → 0.0.2305

package/docs/CouponListResource.md

@@ -0,0 +1,56 @@
+
+# CouponListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`code` | string
+`type` | string
+`discountType` | string
+`discountAmount` | number
+`startDate` | Date
+`endDate` | Date
+`isAbandonedCart` | boolean
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`ordersCount` | number
+`cartsCount` | number
+
+## Example
+
+```typescript
+import type { CouponListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "code": null,
+  "type": null,
+  "discountType": null,
+  "discountAmount": null,
+  "startDate": null,
+  "endDate": null,
+  "isAbandonedCart": null,
+  "site": null,
+  "ordersCount": null,
+  "cartsCount": null,
+} satisfies CouponListResource
+
+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 CouponListResource
+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/{OrderCouponResourceArrayResponse.md → CouponListResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# OrderCouponResourceArrayResponse
+# CouponListResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<OrderCouponResource>](OrderCouponResource.md)
+`data` | [Array<CouponListResource>](CouponListResource.md)
 
 ## Example
 
 ```typescript
-import type { OrderCouponResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { CouponListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies OrderCouponResourceArrayResponse
+} satisfies CouponListResourceArrayResponse
 
 console.log(example)
 
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as OrderCouponResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as CouponListResourceArrayResponse
 console.log(exampleParsed)
 ```
 

package/docs/{OrderCouponResource.md → CouponLiteResource.md}

@@ -1,5 +1,5 @@
 
-# OrderCouponResource
+# CouponLiteResource
 
 
 ## Properties
@@ -7,22 +7,20 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`code` | string
 `name` | string
-`discountTotal` | number
+`code` | string
 
 ## Example
 
 ```typescript
-import type { OrderCouponResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { CouponLiteResource } 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 OrderCouponResource
+  "code": null,
+} satisfies CouponLiteResource
 
 console.log(example)
 
@@ -31,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as OrderCouponResource
+const exampleParsed = JSON.parse(exampleJSON) as CouponLiteResource
 console.log(exampleParsed)
 ```
 

package/docs/{ProductClassLiteResourceArrayResponse.md → CouponLiteResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# ProductClassLiteResourceArrayResponse
+# CouponLiteResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<ProductClassLiteResource>](ProductClassLiteResource.md)
+`data` | [Array<CouponLiteResource>](CouponLiteResource.md)
 
 ## Example
 
 ```typescript
-import type { ProductClassLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { CouponLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies ProductClassLiteResourceArrayResponse
+} satisfies CouponLiteResourceArrayResponse
 
 console.log(example)
 
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ProductClassLiteResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as CouponLiteResourceArrayResponse
 console.log(exampleParsed)
 ```
 

package/docs/CouponResource.md

@@ -0,0 +1,78 @@
+
+# CouponResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`siteId` | number
+`name` | string
+`code` | string
+`type` | string
+`discountType` | string
+`discountAmount` | number
+`minAmount` | number
+`minProducts` | number
+`totalUseLimit` | number
+`customerUseLimit` | number
+`isAbandonedCart` | boolean
+`isForAllProducts` | boolean
+`isForAllCustomers` | boolean
+`startDate` | Date
+`endDate` | Date
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`productChildren` | [Array<ProductChildLiteResource>](ProductChildLiteResource.md)
+`categories` | [Array<ProductCategoryLiteResource>](ProductCategoryLiteResource.md)
+`suppliers` | [Array<SupplierLiteResource>](SupplierLiteResource.md)
+`customers` | [Array<CustomerListResource>](CustomerListResource.md)
+`ordersCount` | number
+`cartsCount` | number
+
+## Example
+
+```typescript
+import type { CouponResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "siteId": null,
+  "name": null,
+  "code": null,
+  "type": null,
+  "discountType": null,
+  "discountAmount": null,
+  "minAmount": null,
+  "minProducts": null,
+  "totalUseLimit": null,
+  "customerUseLimit": null,
+  "isAbandonedCart": null,
+  "isForAllProducts": null,
+  "isForAllCustomers": null,
+  "startDate": null,
+  "endDate": null,
+  "site": null,
+  "productChildren": null,
+  "categories": null,
+  "suppliers": null,
+  "customers": null,
+  "ordersCount": null,
+  "cartsCount": null,
+} satisfies CouponResource
+
+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 CouponResource
+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/CouponResourceArrayResponse.md

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

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