@digital8/lighting-illusions-ts-sdk 0.0.2214 → 0.0.2216

package/docs/AdminsApi.md

@@ -0,0 +1,407 @@
+# 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 |
+| [**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)
+
+
+## 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/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)
+