@digital8/lighting-illusions-ts-sdk 0.0.2339 → 0.0.2341

package/docs/{CustomerFrontendResource.md → CouponListResource.md}

@@ -1,5 +1,5 @@
 
-# CustomerFrontendResource
+# CouponListResource
 
 
 ## Properties
@@ -7,28 +7,38 @@
 Name | Type
 ------------ | -------------
 `id` | number
+`name` | string
+`code` | string
 `type` | string
-`signUpType` | string
-`subscribedToNewsletter` | boolean
-`user` | [UserLiteResource](UserLiteResource.md)
+`discountType` | string
+`discountAmount` | number
+`startDate` | Date
+`endDate` | Date
+`isAbandonedCart` | boolean
 `site` | [SiteLiteResource](SiteLiteResource.md)
-`addresses` | object
+`ordersCount` | number
+`cartsCount` | number
 
 ## Example
 
 ```typescript
-import type { CustomerFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
+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,
-  "signUpType": null,
-  "subscribedToNewsletter": null,
-  "user": null,
+  "discountType": null,
+  "discountAmount": null,
+  "startDate": null,
+  "endDate": null,
+  "isAbandonedCart": null,
   "site": null,
-  "addresses": null,
-} satisfies CustomerFrontendResource
+  "ordersCount": null,
+  "cartsCount": null,
+} satisfies CouponListResource
 
 console.log(example)
 
@@ -37,7 +47,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as CustomerFrontendResource
+const exampleParsed = JSON.parse(exampleJSON) as CouponListResource
 console.log(exampleParsed)
 ```
 

package/docs/{PermissionResourceArrayResponse.md → CouponListResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# PermissionResourceArrayResponse
+# CouponListResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<PermissionResource>](PermissionResource.md)
+`data` | [Array<CouponListResource>](CouponListResource.md)
 
 ## Example
 
 ```typescript
-import type { PermissionResourceArrayResponse } 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 PermissionResourceArrayResponse
+} 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 PermissionResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as CouponListResourceArrayResponse
 console.log(exampleParsed)
 ```
 

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

@@ -1,5 +1,5 @@
 
-# PermissionLiteResource
+# CouponLiteResource
 
 
 ## Properties
@@ -8,17 +8,19 @@ Name | Type
 ------------ | -------------
 `id` | number
 `name` | string
+`code` | string
 
 ## Example
 
 ```typescript
-import type { PermissionLiteResource } 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,
   "name": null,
-} satisfies PermissionLiteResource
+  "code": null,
+} satisfies CouponLiteResource
 
 console.log(example)
 
@@ -27,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 PermissionLiteResource
+const exampleParsed = JSON.parse(exampleJSON) as CouponLiteResource
 console.log(exampleParsed)
 ```
 

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

@@ -1,22 +1,22 @@
 
-# AdminListResourceArrayResponse
+# CouponLiteResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<AdminListResource>](AdminListResource.md)
+`data` | [Array<CouponLiteResource>](CouponLiteResource.md)
 
 ## Example
 
 ```typescript
-import type { AdminListResourceArrayResponse } 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 AdminListResourceArrayResponse
+} 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 AdminListResourceArrayResponse
+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<ProductCategoryListResource>](ProductCategoryListResource.md)
+`suppliers` | [Array<SupplierListResource>](SupplierListResource.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/{AdminResourceArrayResponse.md → CouponResourceArrayResponse.md}

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

package/docs/{SignUpType.md → CouponType.md}

@@ -1,5 +1,5 @@
 
-# SignUpType
+# CouponType
 
 
 ## Properties
@@ -10,11 +10,11 @@ Name | Type
 ## Example
 
 ```typescript
-import type { SignUpType } from '@digital8/lighting-illusions-ts-sdk'
+import type { CouponType } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-} satisfies SignUpType
+} satisfies CouponType
 
 console.log(example)
 
@@ -23,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as SignUpType
+const exampleParsed = JSON.parse(exampleJSON) as CouponType
 console.log(exampleParsed)
 ```