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

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

@@ -1,44 +1,44 @@
-# CouponsApi
+# RolesApi
 
 All URIs are relative to *http://localhost/api*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**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 |
+| [**destroyRole**](RolesApi.md#destroyrole) | **DELETE** /admin-api/roles/{role}/delete | Auto-generated: destroyRole |
+| [**getAllRole**](RolesApi.md#getallrole) | **POST** /admin-api/roles/all | Auto-generated: getAllRole |
+| [**indexRole**](RolesApi.md#indexrole) | **POST** /admin-api/roles/list | Auto-generated: indexRole |
+| [**showRole**](RolesApi.md#showrole) | **GET** /admin-api/roles/{role} | Auto-generated: showRole |
+| [**storeRole**](RolesApi.md#storerole) | **POST** /admin-api/roles/create | Auto-generated: storeRole |
+| [**updateRole**](RolesApi.md#updateroleoperation) | **PUT** /admin-api/roles/{role}/update | Auto-generated: updateRole |
 
 
 
-## destroyCoupon
+## destroyRole
 
-> GenericResponse destroyCoupon(coupon)
+> GenericResponse destroyRole(role)
 
-Auto-generated: destroyCoupon
+Auto-generated: destroyRole
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  CouponsApi,
+  RolesApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CouponsApi();
+  const api = new RolesApi();
 
   const body = {
-    // number | The id of the coupon
-    coupon: 56,
-  } satisfies DestroyCouponRequest;
+    // number | The id of the role
+    role: 56,
+  } satisfies DestroyRoleRequest;
 
   try {
-    const data = await api.destroyCoupon(body);
+    const data = await api.destroyRole(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -54,7 +54,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **coupon** | `number` | The id of the coupon | [Defaults to `undefined`] |
+| **role** | `number` | The id of the role | [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)
 
 
-## getAllCoupon
+## getAllRole
 
-> CouponLiteResourceArrayResponse getAllCoupon(searchAllCouponsRequest)
+> RoleLiteResourceArrayResponse getAllRole(searchAllRolesRequest)
 
-Auto-generated: getAllCoupon
+Auto-generated: getAllRole
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  CouponsApi,
+  RolesApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CouponsApi();
+  const api = new RolesApi();
 
   const body = {
-    // SearchAllCouponsRequest (optional)
-    searchAllCouponsRequest: ...,
-  } satisfies GetAllCouponRequest;
+    // SearchAllRolesRequest (optional)
+    searchAllRolesRequest: ...,
+  } satisfies GetAllRoleRequest;
 
   try {
-    const data = await api.getAllCoupon(body);
+    const data = await api.getAllRole(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -119,11 +119,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **searchAllCouponsRequest** | [SearchAllCouponsRequest](SearchAllCouponsRequest.md) |  | [Optional] |
+| **searchAllRolesRequest** | [SearchAllRolesRequest](SearchAllRolesRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**CouponLiteResourceArrayResponse**](CouponLiteResourceArrayResponse.md)
+[**RoleLiteResourceArrayResponse**](RoleLiteResourceArrayResponse.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)
 
 
-## indexCoupon
+## indexRole
 
-> PaginatedCouponListResourceResponse indexCoupon(searchCouponsRequest)
+> PaginatedRoleListResourceResponse indexRole(searchRolesRequest)
 
-Auto-generated: indexCoupon
+Auto-generated: indexRole
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  CouponsApi,
+  RolesApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CouponsApi();
+  const api = new RolesApi();
 
   const body = {
-    // SearchCouponsRequest (optional)
-    searchCouponsRequest: ...,
-  } satisfies IndexCouponRequest;
+    // SearchRolesRequest (optional)
+    searchRolesRequest: ...,
+  } satisfies IndexRoleRequest;
 
   try {
-    const data = await api.indexCoupon(body);
+    const data = await api.indexRole(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -184,11 +184,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **searchCouponsRequest** | [SearchCouponsRequest](SearchCouponsRequest.md) |  | [Optional] |
+| **searchRolesRequest** | [SearchRolesRequest](SearchRolesRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**PaginatedCouponListResourceResponse**](PaginatedCouponListResourceResponse.md)
+[**PaginatedRoleListResourceResponse**](PaginatedRoleListResourceResponse.md)
 
 ### Authorization
 
@@ -203,37 +203,37 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\CouponListResource[]>> |  -  |
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\RoleListResource[]>> |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## showCoupon
+## showRole
 
-> CouponResource showCoupon(coupon)
+> RoleResource showRole(role)
 
-Auto-generated: showCoupon
+Auto-generated: showRole
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  CouponsApi,
+  RolesApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CouponsApi();
+  const api = new RolesApi();
 
   const body = {
-    // number | The id of the coupon
-    coupon: 56,
-  } satisfies ShowCouponRequest;
+    // number | The id of the role
+    role: 56,
+  } satisfies ShowRoleRequest;
 
   try {
-    const data = await api.showCoupon(body);
+    const data = await api.showRole(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -249,11 +249,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **coupon** | `number` | The id of the coupon | [Defaults to `undefined`] |
+| **role** | `number` | The id of the role | [Defaults to `undefined`] |
 
 ### Return type
 
-[**CouponResource**](CouponResource.md)
+[**RoleResource**](RoleResource.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)
 
 
-## storeCoupon
+## storeRole
 
-> CouponResource storeCoupon(createCouponRequest)
+> RoleResource storeRole(createRoleRequest)
 
-Auto-generated: storeCoupon
+Auto-generated: storeRole
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  CouponsApi,
+  RolesApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreCouponRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CouponsApi();
+  const api = new RolesApi();
 
   const body = {
-    // CreateCouponRequest (optional)
-    createCouponRequest: ...,
-  } satisfies StoreCouponRequest;
+    // CreateRoleRequest (optional)
+    createRoleRequest: ...,
+  } satisfies StoreRoleRequest;
 
   try {
-    const data = await api.storeCoupon(body);
+    const data = await api.storeRole(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -314,11 +314,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **createCouponRequest** | [CreateCouponRequest](CreateCouponRequest.md) |  | [Optional] |
+| **createRoleRequest** | [CreateRoleRequest](CreateRoleRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**CouponResource**](CouponResource.md)
+[**RoleResource**](RoleResource.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)
 
 
-## updateCoupon
+## updateRole
 
-> CouponResource updateCoupon(coupon, updateCouponRequest)
+> RoleResource updateRole(role, updateRoleRequest)
 
-Auto-generated: updateCoupon
+Auto-generated: updateRole
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  CouponsApi,
+  RolesApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateCouponOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateRoleOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CouponsApi();
+  const api = new RolesApi();
 
   const body = {
-    // number | The id of the coupon
-    coupon: 56,
-    // UpdateCouponRequest (optional)
-    updateCouponRequest: ...,
-  } satisfies UpdateCouponOperationRequest;
+    // number | The id of the role
+    role: 56,
+    // UpdateRoleRequest (optional)
+    updateRoleRequest: ...,
+  } satisfies UpdateRoleOperationRequest;
 
   try {
-    const data = await api.updateCoupon(body);
+    const data = await api.updateRole(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -381,12 +381,12 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **coupon** | `number` | The id of the coupon | [Defaults to `undefined`] |
-| **updateCouponRequest** | [UpdateCouponRequest](UpdateCouponRequest.md) |  | [Optional] |
+| **role** | `number` | The id of the role | [Defaults to `undefined`] |
+| **updateRoleRequest** | [UpdateRoleRequest](UpdateRoleRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**CouponResource**](CouponResource.md)
+[**RoleResource**](RoleResource.md)
 
 ### Authorization
 

package/docs/{SearchCouponsRequest.md → SearchAdminUsersRequest.md}

@@ -1,5 +1,5 @@
 
-# SearchCouponsRequest
+# SearchAdminUsersRequest
 
 
 ## Properties
@@ -11,13 +11,9 @@ Name | Type
 `sortDirection` | string
 `perPage` | number
 `page` | number
-`type` | Array<string>
-`siteId` | Array<string>
-`isAbandonedCart` | Array<string>
-`beforeStartDate` | Date
-`afterStartDate` | Date
-`beforeEndDate` | Date
-`afterEndDate` | Date
+`roleId` | Array<string>
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
@@ -25,7 +21,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { SearchCouponsRequest } from '@digital8/lighting-illusions-ts-sdk'
+import type { SearchAdminUsersRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -34,17 +30,13 @@ const example = {
   "sortDirection": null,
   "perPage": null,
   "page": null,
-  "type": null,
-  "siteId": null,
-  "isAbandonedCart": null,
-  "beforeStartDate": null,
-  "afterStartDate": null,
-  "beforeEndDate": null,
-  "afterEndDate": null,
+  "roleId": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": null,
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,
-} satisfies SearchCouponsRequest
+} satisfies SearchAdminUsersRequest
 
 console.log(example)
 
@@ -53,7 +45,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as SearchCouponsRequest
+const exampleParsed = JSON.parse(exampleJSON) as SearchAdminUsersRequest
 console.log(exampleParsed)
 ```
 

package/docs/SearchAllAdminUsersRequest.md

@@ -0,0 +1,44 @@
+
+# SearchAllAdminUsersRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { SearchAllAdminUsersRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "search": null,
+  "sortBy": null,
+  "sortDirection": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies SearchAllAdminUsersRequest
+
+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 SearchAllAdminUsersRequest
+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/{SearchAllCouponsRequest.md → SearchAllCustomersRequest.md}

@@ -1,5 +1,5 @@
 
-# SearchAllCouponsRequest
+# SearchAllCustomersRequest
 
 
 ## Properties
@@ -12,14 +12,14 @@ Name | Type
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
-`type` | Array<string>
 `siteId` | Array<string>
-`isAbandonedCart` | Array<string>
+`type` | Array<string>
+`signUpType` | Array<string>
 
 ## Example
 
 ```typescript
-import type { SearchAllCouponsRequest } from '@digital8/lighting-illusions-ts-sdk'
+import type { SearchAllCustomersRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -29,10 +29,10 @@ const example = {
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,
-  "type": null,
   "siteId": null,
-  "isAbandonedCart": null,
-} satisfies SearchAllCouponsRequest
+  "type": null,
+  "signUpType": null,
+} satisfies SearchAllCustomersRequest
 
 console.log(example)
 
@@ -41,7 +41,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as SearchAllCouponsRequest
+const exampleParsed = JSON.parse(exampleJSON) as SearchAllCustomersRequest
 console.log(exampleParsed)
 ```
 

package/docs/SearchAllPermissionsRequest.md

@@ -0,0 +1,44 @@
+
+# SearchAllPermissionsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { SearchAllPermissionsRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "search": null,
+  "sortBy": null,
+  "sortDirection": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies SearchAllPermissionsRequest
+
+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 SearchAllPermissionsRequest
+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/SearchAllRolesRequest.md

@@ -0,0 +1,46 @@
+
+# SearchAllRolesRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+`isLocked` | Array<string>
+
+## Example
+
+```typescript
+import type { SearchAllRolesRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "search": null,
+  "sortBy": null,
+  "sortDirection": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+  "isLocked": null,
+} satisfies SearchAllRolesRequest
+
+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 SearchAllRolesRequest
+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/SearchCartsRequest.md

@@ -23,7 +23,6 @@ Name | Type
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
-`couponId` | number
 
 ## Example
 
@@ -49,7 +48,6 @@ const example = {
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,
-  "couponId": null,
 } satisfies SearchCartsRequest
 
 console.log(example)

package/docs/SearchCustomersRequest.md

@@ -12,6 +12,10 @@ Name | Type
 `perPage` | number
 `page` | number
 `siteId` | Array<string>
+`type` | Array<string>
+`signUpType` | Array<string>
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
@@ -29,6 +33,10 @@ const example = {
   "perPage": null,
   "page": null,
   "siteId": null,
+  "type": null,
+  "signUpType": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": null,
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,

package/docs/SearchOrdersRequest.md

@@ -24,7 +24,6 @@ Name | Type
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
-`couponId` | number
 
 ## Example
 
@@ -51,7 +50,6 @@ const example = {
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,
-  "couponId": null,
 } satisfies SearchOrdersRequest
 
 console.log(example)