@digital8/lighting-illusions-ts-sdk 0.0.2361 → 0.0.2363

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/{AppliedCouponResource.md → CartCouponResource.md}

@@ -1,5 +1,5 @@
 
-# AppliedCouponResource
+# CartCouponResource
 
 
 ## Properties
@@ -14,7 +14,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { AppliedCouponResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { CartCouponResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -22,7 +22,7 @@ const example = {
   "code": null,
   "name": null,
   "discountTotal": null,
-} satisfies AppliedCouponResource
+} satisfies CartCouponResource
 
 console.log(example)
 
@@ -31,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AppliedCouponResource
+const exampleParsed = JSON.parse(exampleJSON) as CartCouponResource
 console.log(exampleParsed)
 ```
 

package/docs/CartCouponResourceArrayResponse.md

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

@@ -0,0 +1,42 @@
+
+# CreateAdminUserRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`phone` | string
+`password` | string
+`email` | string
+
+## Example
+
+```typescript
+import type { CreateAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": null,
+  "lastName": null,
+  "phone": null,
+  "password": null,
+  "email": null,
+} satisfies CreateAdminUserRequest
+
+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 CreateAdminUserRequest
+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/CreateCustomerAddressRequest.md

@@ -0,0 +1,50 @@
+
+# CreateCustomerAddressRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`addresseeName` | string
+`company` | string
+`line1` | string
+`line2` | string
+`suburb` | string
+`state` | string
+`postcode` | string
+`country` | string
+`type` | string
+
+## Example
+
+```typescript
+import type { CreateCustomerAddressRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "addresseeName": null,
+  "company": null,
+  "line1": null,
+  "line2": null,
+  "suburb": null,
+  "state": null,
+  "postcode": null,
+  "country": null,
+  "type": null,
+} satisfies CreateCustomerAddressRequest
+
+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 CreateCustomerAddressRequest
+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/CreateCustomerRequest.md

@@ -6,11 +6,14 @@
 
 Name | Type
 ------------ | -------------
-`siteId` | number
 `firstName` | string
 `lastName` | string
-`email` | string
 `phone` | string
+`password` | string
+`email` | string
+`siteId` | number
+`subscribedToNewsletter` | boolean
+`netsuiteId` | number
 
 ## Example
 
@@ -19,11 +22,14 @@ import type { CreateCustomerRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "siteId": null,
   "firstName": null,
   "lastName": null,
-  "email": null,
   "phone": null,
+  "password": null,
+  "email": null,
+  "siteId": null,
+  "subscribedToNewsletter": null,
+  "netsuiteId": null,
 } satisfies CreateCustomerRequest
 
 console.log(example)

package/docs/CreateRoleRequest.md

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

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

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