@digital8/lighting-illusions-ts-sdk 0.0.2354 → 0.0.2356

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

@@ -1,5 +1,5 @@
 
-# RoleLiteResource
+# CouponLiteResource
 
 
 ## Properties
@@ -8,17 +8,19 @@ Name | Type
 ------------ | -------------
 `id` | number
 `name` | string
+`code` | string
 
 ## Example
 
 ```typescript
-import type { RoleLiteResource } 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 RoleLiteResource
+  "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 RoleLiteResource
+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,76 @@
+
+# CouponResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | 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,
+  "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)
 ```
 

package/docs/{AdminsApi.md → CouponsApi.md}

@@ -1,44 +1,44 @@
-# AdminsApi
+# CouponsApi
 
 All URIs are relative to *http://localhost/api*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**destroyAdminUser**](AdminsApi.md#destroyadminuser) | **DELETE** /admin-api/admins/{admin}/delete | Auto-generated: destroyAdminUser |
-| [**getAllAdminUser**](AdminsApi.md#getalladminuser) | **POST** /admin-api/admins/all | Auto-generated: getAllAdminUser |
-| [**indexAdminUser**](AdminsApi.md#indexadminuser) | **POST** /admin-api/admins/list | Auto-generated: indexAdminUser |
-| [**showAdminUser**](AdminsApi.md#showadminuser) | **GET** /admin-api/admins/{admin} | Auto-generated: showAdminUser |
-| [**storeAdminUser**](AdminsApi.md#storeadminuser) | **POST** /admin-api/admins/create | Auto-generated: storeAdminUser |
-| [**updateAdminUser**](AdminsApi.md#updateadminuseroperation) | **PUT** /admin-api/admins/{admin}/update | Auto-generated: updateAdminUser |
+| [**destroyCoupon**](CouponsApi.md#destroycoupon) | **DELETE** /admin-api/coupons/{coupon}/delete | Auto-generated: destroyCoupon |
+| [**getAllCoupon**](CouponsApi.md#getallcoupon) | **POST** /admin-api/coupons/all | Auto-generated: getAllCoupon |
+| [**indexCoupon**](CouponsApi.md#indexcoupon) | **POST** /admin-api/coupons/list | Auto-generated: indexCoupon |
+| [**showCoupon**](CouponsApi.md#showcoupon) | **GET** /admin-api/coupons/{coupon} | Auto-generated: showCoupon |
+| [**storeCoupon**](CouponsApi.md#storecoupon) | **POST** /admin-api/coupons/create | Auto-generated: storeCoupon |
+| [**updateCoupon**](CouponsApi.md#updatecouponoperation) | **PUT** /admin-api/coupons/{coupon}/update | Auto-generated: updateCoupon |
 
 
 
-## destroyAdminUser
+## destroyCoupon
 
-> GenericResponse destroyAdminUser(admin)
+> GenericResponse destroyCoupon(coupon)
 
-Auto-generated: destroyAdminUser
+Auto-generated: destroyCoupon
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  AdminsApi,
+  CouponsApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new AdminsApi();
+  const api = new CouponsApi();
 
   const body = {
-    // number | The id of the admin
-    admin: 56,
-  } satisfies DestroyAdminUserRequest;
+    // number | The id of the coupon
+    coupon: 56,
+  } satisfies DestroyCouponRequest;
 
   try {
-    const data = await api.destroyAdminUser(body);
+    const data = await api.destroyCoupon(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -54,7 +54,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **admin** | `number` | The id of the admin | [Defaults to `undefined`] |
+| **coupon** | `number` | The id of the coupon | [Defaults to `undefined`] |
 
 ### Return type
 
@@ -78,32 +78,32 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## getAllAdminUser
+## getAllCoupon
 
-> AdminLiteResourceArrayResponse getAllAdminUser(searchAllAdminUsersRequest)
+> CouponLiteResourceArrayResponse getAllCoupon(searchAllCouponsRequest)
 
-Auto-generated: getAllAdminUser
+Auto-generated: getAllCoupon
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  AdminsApi,
+  CouponsApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new AdminsApi();
+  const api = new CouponsApi();
 
   const body = {
-    // SearchAllAdminUsersRequest (optional)
-    searchAllAdminUsersRequest: ...,
-  } satisfies GetAllAdminUserRequest;
+    // SearchAllCouponsRequest (optional)
+    searchAllCouponsRequest: ...,
+  } satisfies GetAllCouponRequest;
 
   try {
-    const data = await api.getAllAdminUser(body);
+    const data = await api.getAllCoupon(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -119,11 +119,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **searchAllAdminUsersRequest** | [SearchAllAdminUsersRequest](SearchAllAdminUsersRequest.md) |  | [Optional] |
+| **searchAllCouponsRequest** | [SearchAllCouponsRequest](SearchAllCouponsRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**AdminLiteResourceArrayResponse**](AdminLiteResourceArrayResponse.md)
+[**CouponLiteResourceArrayResponse**](CouponLiteResourceArrayResponse.md)
 
 ### Authorization
 
@@ -143,32 +143,32 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## indexAdminUser
+## indexCoupon
 
-> PaginatedAdminListResourceResponse indexAdminUser(searchAdminUsersRequest)
+> PaginatedCouponListResourceResponse indexCoupon(searchCouponsRequest)
 
-Auto-generated: indexAdminUser
+Auto-generated: indexCoupon
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  AdminsApi,
+  CouponsApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new AdminsApi();
+  const api = new CouponsApi();
 
   const body = {
-    // SearchAdminUsersRequest (optional)
-    searchAdminUsersRequest: ...,
-  } satisfies IndexAdminUserRequest;
+    // SearchCouponsRequest (optional)
+    searchCouponsRequest: ...,
+  } satisfies IndexCouponRequest;
 
   try {
-    const data = await api.indexAdminUser(body);
+    const data = await api.indexCoupon(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -184,11 +184,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **searchAdminUsersRequest** | [SearchAdminUsersRequest](SearchAdminUsersRequest.md) |  | [Optional] |
+| **searchCouponsRequest** | [SearchCouponsRequest](SearchCouponsRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**PaginatedAdminListResourceResponse**](PaginatedAdminListResourceResponse.md)
+[**PaginatedCouponListResourceResponse**](PaginatedCouponListResourceResponse.md)
 
 ### Authorization
 
@@ -203,37 +203,37 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\AdminListResource[]>> |  -  |
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\CouponListResource[]>> |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## showAdminUser
+## showCoupon
 
-> AdminResource showAdminUser(admin)
+> CouponResource showCoupon(coupon)
 
-Auto-generated: showAdminUser
+Auto-generated: showCoupon
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  AdminsApi,
+  CouponsApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new AdminsApi();
+  const api = new CouponsApi();
 
   const body = {
-    // number | The id of the admin
-    admin: 56,
-  } satisfies ShowAdminUserRequest;
+    // number | The id of the coupon
+    coupon: 56,
+  } satisfies ShowCouponRequest;
 
   try {
-    const data = await api.showAdminUser(body);
+    const data = await api.showCoupon(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -249,11 +249,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **admin** | `number` | The id of the admin | [Defaults to `undefined`] |
+| **coupon** | `number` | The id of the coupon | [Defaults to `undefined`] |
 
 ### Return type
 
-[**AdminResource**](AdminResource.md)
+[**CouponResource**](CouponResource.md)
 
 ### Authorization
 
@@ -273,32 +273,32 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## storeAdminUser
+## storeCoupon
 
-> AdminResource storeAdminUser(createAdminUserRequest)
+> CouponResource storeCoupon(createCouponRequest)
 
-Auto-generated: storeAdminUser
+Auto-generated: storeCoupon
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  AdminsApi,
+  CouponsApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new AdminsApi();
+  const api = new CouponsApi();
 
   const body = {
-    // CreateAdminUserRequest (optional)
-    createAdminUserRequest: ...,
-  } satisfies StoreAdminUserRequest;
+    // CreateCouponRequest (optional)
+    createCouponRequest: ...,
+  } satisfies StoreCouponRequest;
 
   try {
-    const data = await api.storeAdminUser(body);
+    const data = await api.storeCoupon(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -314,11 +314,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **createAdminUserRequest** | [CreateAdminUserRequest](CreateAdminUserRequest.md) |  | [Optional] |
+| **createCouponRequest** | [CreateCouponRequest](CreateCouponRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**AdminResource**](AdminResource.md)
+[**CouponResource**](CouponResource.md)
 
 ### Authorization
 
@@ -338,34 +338,34 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## updateAdminUser
+## updateCoupon
 
-> AdminResource updateAdminUser(admin, updateAdminUserRequest)
+> CouponResource updateCoupon(coupon, updateCouponRequest)
 
-Auto-generated: updateAdminUser
+Auto-generated: updateCoupon
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  AdminsApi,
+  CouponsApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateAdminUserOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateCouponOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new AdminsApi();
+  const api = new CouponsApi();
 
   const body = {
-    // number | The id of the admin
-    admin: 56,
-    // UpdateAdminUserRequest (optional)
-    updateAdminUserRequest: ...,
-  } satisfies UpdateAdminUserOperationRequest;
+    // number | The id of the coupon
+    coupon: 56,
+    // UpdateCouponRequest (optional)
+    updateCouponRequest: ...,
+  } satisfies UpdateCouponOperationRequest;
 
   try {
-    const data = await api.updateAdminUser(body);
+    const data = await api.updateCoupon(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -381,12 +381,12 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **admin** | `number` | The id of the admin | [Defaults to `undefined`] |
-| **updateAdminUserRequest** | [UpdateAdminUserRequest](UpdateAdminUserRequest.md) |  | [Optional] |
+| **coupon** | `number` | The id of the coupon | [Defaults to `undefined`] |
+| **updateCouponRequest** | [UpdateCouponRequest](UpdateCouponRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**AdminResource**](AdminResource.md)
+[**CouponResource**](CouponResource.md)
 
 ### Authorization
 

package/docs/CreateCouponRequest.md

@@ -0,0 +1,62 @@
+
+# CreateCouponRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`siteId` | number
+`name` | string
+`code` | string
+`type` | string
+`discountType` | string
+`discountAmount` | number
+`minAmount` | number
+`minProducts` | number
+`totalUseLimit` | number
+`customerUseLimit` | number
+`startDate` | string
+`endDate` | string
+`isForAllProducts` | boolean
+`isForAllCustomers` | boolean
+`couponables` | [Array<CreateCouponRequestCouponablesInner>](CreateCouponRequestCouponablesInner.md)
+
+## Example
+
+```typescript
+import type { CreateCouponRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "siteId": null,
+  "name": null,
+  "code": null,
+  "type": null,
+  "discountType": null,
+  "discountAmount": null,
+  "minAmount": null,
+  "minProducts": null,
+  "totalUseLimit": null,
+  "customerUseLimit": null,
+  "startDate": null,
+  "endDate": null,
+  "isForAllProducts": null,
+  "isForAllCustomers": null,
+  "couponables": null,
+} satisfies CreateCouponRequest
+
+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 CreateCouponRequest
+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/{AdminLiteResource.md → CreateCouponRequestCouponablesInner.md}

@@ -1,24 +1,24 @@
 
-# AdminLiteResource
+# CreateCouponRequestCouponablesInner
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`type` | string
 `id` | number
-`user` | [UserLiteResource](UserLiteResource.md)
 
 ## Example
 
 ```typescript
-import type { AdminLiteResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { CreateCouponRequestCouponablesInner } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
+  "type": null,
   "id": null,
-  "user": null,
-} satisfies AdminLiteResource
+} satisfies CreateCouponRequestCouponablesInner
 
 console.log(example)
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AdminLiteResource
+const exampleParsed = JSON.parse(exampleJSON) as CreateCouponRequestCouponablesInner
 console.log(exampleParsed)
 ```