@digital8/lighting-illusions-ts-sdk 0.0.2373 → 0.0.2374

package/docs/AuthApi.md

@@ -0,0 +1,322 @@
+# AuthApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**forgotPasswordAdminAuth**](AuthApi.md#forgotpasswordadminauth) | **POST** /admin-api/auth/admin/forgot-password | Auto-generated: forgotPasswordAdminAuth |
+| [**loginAdminAuth**](AuthApi.md#loginadminauth) | **POST** /admin-api/auth/admin/login | Auto-generated: loginAdminAuth |
+| [**logoutAdminAuth**](AuthApi.md#logoutadminauth) | **POST** /admin-api/auth/admin/logout | Auto-generated: logoutAdminAuth |
+| [**meAdminAuth**](AuthApi.md#meadminauth) | **GET** /admin-api/auth/admin/me | Auto-generated: meAdminAuth |
+| [**resetPasswordAdminAuth**](AuthApi.md#resetpasswordadminauth) | **POST** /admin-api/auth/admin/reset-password | Auto-generated: resetPasswordAdminAuth |
+
+
+
+## forgotPasswordAdminAuth
+
+> GenericResponse forgotPasswordAdminAuth(forgotPasswordAdminRequest)
+
+Auto-generated: forgotPasswordAdminAuth
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ForgotPasswordAdminAuthRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AuthApi();
+
+  const body = {
+    // ForgotPasswordAdminRequest (optional)
+    forgotPasswordAdminRequest: ...,
+  } satisfies ForgotPasswordAdminAuthRequest;
+
+  try {
+    const data = await api.forgotPasswordAdminAuth(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **forgotPasswordAdminRequest** | [ForgotPasswordAdminRequest](ForgotPasswordAdminRequest.md) |  | [Optional] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Generic JSON success |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## loginAdminAuth
+
+> AdminLoginResponseResource loginAdminAuth(loginAdminRequest)
+
+Auto-generated: loginAdminAuth
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { LoginAdminAuthRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AuthApi();
+
+  const body = {
+    // LoginAdminRequest (optional)
+    loginAdminRequest: ...,
+  } satisfies LoginAdminAuthRequest;
+
+  try {
+    const data = await api.loginAdminAuth(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **loginAdminRequest** | [LoginAdminRequest](LoginAdminRequest.md) |  | [Optional] |
+
+### Return type
+
+[**AdminLoginResponseResource**](AdminLoginResponseResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## logoutAdminAuth
+
+> GenericResponse logoutAdminAuth()
+
+Auto-generated: logoutAdminAuth
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { LogoutAdminAuthRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AuthApi();
+
+  try {
+    const data = await api.logoutAdminAuth();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Generic JSON success |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## meAdminAuth
+
+> AdminResource meAdminAuth()
+
+Auto-generated: meAdminAuth
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { MeAdminAuthRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AuthApi();
+
+  try {
+    const data = await api.meAdminAuth();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AdminResource**](AdminResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## resetPasswordAdminAuth
+
+> GenericResponse resetPasswordAdminAuth(resetPasswordAdminRequest)
+
+Auto-generated: resetPasswordAdminAuth
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ResetPasswordAdminAuthRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AuthApi();
+
+  const body = {
+    // ResetPasswordAdminRequest (optional)
+    resetPasswordAdminRequest: ...,
+  } satisfies ResetPasswordAdminAuthRequest;
+
+  try {
+    const data = await api.resetPasswordAdminAuth(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **resetPasswordAdminRequest** | [ResetPasswordAdminRequest](ResetPasswordAdminRequest.md) |  | [Optional] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Generic JSON success |  -  |
+
+[[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

@@ -22,7 +22,7 @@ Name | Type
 `includeInsurance` | boolean
 `overrideInsurance` | boolean
 `useAsBillingAddress` | boolean
-`admin` | [LiAdminUserLiteResource](LiAdminUserLiteResource.md)
+`admin` | [AdminUserLiteResource](AdminUserLiteResource.md)
 `site` | [SiteLiteResource](SiteLiteResource.md)
 `customer` | [CustomerResource](CustomerResource.md)
 `lineItems` | [Array<LineItemListResource>](LineItemListResource.md)

package/docs/CheckEmailFrontendResource.md

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

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

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

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

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