@digital8/lighting-illusions-ts-sdk 0.0.2213 → 0.0.2215

package/docs/AdminsApi.md

@@ -0,0 +1,465 @@
+# AdminsApi
+
+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 |
+| [**meAdminUser**](AdminsApi.md#meadminuser) | **GET** /admin-api/admins/me | Auto-generated: meAdminUser |
+| [**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 |
+
+
+
+## destroyAdminUser
+
+> GenericResponse destroyAdminUser(admin)
+
+Auto-generated: destroyAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  const body = {
+    // number | The id of the admin
+    admin: 56,
+  } satisfies DestroyAdminUserRequest;
+
+  try {
+    const data = await api.destroyAdminUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **admin** | `number` | The id of the admin | [Defaults to `undefined`] |
+
+### 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** | \\JsonResponse |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAllAdminUser
+
+> AdminLiteResourceArrayResponse getAllAdminUser(searchAllAdminUsersRequest)
+
+Auto-generated: getAllAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  const body = {
+    // SearchAllAdminUsersRequest (optional)
+    searchAllAdminUsersRequest: ...,
+  } satisfies GetAllAdminUserRequest;
+
+  try {
+    const data = await api.getAllAdminUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchAllAdminUsersRequest** | [SearchAllAdminUsersRequest](SearchAllAdminUsersRequest.md) |  | [Optional] |
+
+### Return type
+
+[**AdminLiteResourceArrayResponse**](AdminLiteResourceArrayResponse.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)
+
+
+## indexAdminUser
+
+> PaginatedAdminListResourceResponse indexAdminUser(searchAdminUsersRequest)
+
+Auto-generated: indexAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  const body = {
+    // SearchAdminUsersRequest (optional)
+    searchAdminUsersRequest: ...,
+  } satisfies IndexAdminUserRequest;
+
+  try {
+    const data = await api.indexAdminUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchAdminUsersRequest** | [SearchAdminUsersRequest](SearchAdminUsersRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedAdminListResourceResponse**](PaginatedAdminListResourceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\AdminListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## meAdminUser
+
+> AdminResource meAdminUser()
+
+Auto-generated: meAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { MeAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  try {
+    const data = await api.meAdminUser();
+    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)
+
+
+## showAdminUser
+
+> AdminResource showAdminUser(admin)
+
+Auto-generated: showAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  const body = {
+    // number | The id of the admin
+    admin: 56,
+  } satisfies ShowAdminUserRequest;
+
+  try {
+    const data = await api.showAdminUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **admin** | `number` | The id of the admin | [Defaults to `undefined`] |
+
+### 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)
+
+
+## storeAdminUser
+
+> AdminResource storeAdminUser(createAdminUserRequest)
+
+Auto-generated: storeAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  const body = {
+    // CreateAdminUserRequest (optional)
+    createAdminUserRequest: ...,
+  } satisfies StoreAdminUserRequest;
+
+  try {
+    const data = await api.storeAdminUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createAdminUserRequest** | [CreateAdminUserRequest](CreateAdminUserRequest.md) |  | [Optional] |
+
+### Return type
+
+[**AdminResource**](AdminResource.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)
+
+
+## updateAdminUser
+
+> AdminResource updateAdminUser(admin, updateAdminUserRequest)
+
+Auto-generated: updateAdminUser
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateAdminUserOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new AdminsApi();
+
+  const body = {
+    // number | The id of the admin
+    admin: 56,
+    // UpdateAdminUserRequest (optional)
+    updateAdminUserRequest: ...,
+  } satisfies UpdateAdminUserOperationRequest;
+
+  try {
+    const data = await api.updateAdminUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **admin** | `number` | The id of the admin | [Defaults to `undefined`] |
+| **updateAdminUserRequest** | [UpdateAdminUserRequest](UpdateAdminUserRequest.md) |  | [Optional] |
+
+### Return type
+
+[**AdminResource**](AdminResource.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)
+

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/CreateCustomerRequest.md

@@ -6,11 +6,13 @@
 
 Name | Type
 ------------ | -------------
-`siteId` | number
 `firstName` | string
 `lastName` | string
-`email` | string
 `phone` | string
+`password` | string
+`email` | string
+`siteId` | number
+`subscribedToNewsletter` | boolean
 
 ## Example
 
@@ -19,11 +21,13 @@ 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,
 } 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/CreateSupplierRequest.md

@@ -9,7 +9,6 @@ Name | Type
 `name` | string
 `slug` | string
 `supplierEta` | number
-`productEnquiriesOnly` | boolean
 `seo` | [Array<CreateBlogCategoryRequestSeoInner>](CreateBlogCategoryRequestSeoInner.md)
 `altText` | string
 `mimeType` | string
@@ -28,7 +27,6 @@ const example = {
   "name": null,
   "slug": null,
   "supplierEta": null,
-  "productEnquiriesOnly": null,
   "seo": null,
   "altText": null,
   "mimeType": null,

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)
+
+