@digital8/lighting-illusions-ts-sdk 0.0.2357 → 0.0.2358

package/docs/AdminsApi.md

@@ -1,545 +0,0 @@
-# AdminsApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**attachRolesAdminUser**](AdminsApi.md#attachrolesadminuser) | **POST** /admin-api/admins/{admin}/roles/attach | Auto-generated: attachRolesAdminUser |
-| [**destroyAdminUser**](AdminsApi.md#destroyadminuser) | **DELETE** /admin-api/admins/{admin}/delete | Auto-generated: destroyAdminUser |
-| [**detachRoleAdminUser**](AdminsApi.md#detachroleadminuser) | **DELETE** /admin-api/admins/{admin}/roles/{role} | Auto-generated: detachRoleAdminUser |
-| [**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 |
-
-
-
-## attachRolesAdminUser
-
-> AdminResource attachRolesAdminUser(admin, attachRolesToAdminRequest)
-
-Auto-generated: attachRolesAdminUser
-
-### Example
-
-```ts
-import {
-  Configuration,
-  AdminsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { AttachRolesAdminUserRequest } 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,
-    // AttachRolesToAdminRequest (optional)
-    attachRolesToAdminRequest: ...,
-  } satisfies AttachRolesAdminUserRequest;
-
-  try {
-    const data = await api.attachRolesAdminUser(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`] |
-| **attachRolesToAdminRequest** | [AttachRolesToAdminRequest](AttachRolesToAdminRequest.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)
-
-
-## 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)
-
-
-## detachRoleAdminUser
-
-> AdminResource detachRoleAdminUser(admin, role)
-
-Auto-generated: detachRoleAdminUser
-
-### Example
-
-```ts
-import {
-  Configuration,
-  AdminsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DetachRoleAdminUserRequest } 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,
-    // number | The id of the role
-    role: 56,
-  } satisfies DetachRoleAdminUserRequest;
-
-  try {
-    const data = await api.detachRoleAdminUser(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`] |
-| **role** | `number` | The id of the role | [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)
-
-
-## 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/AttachAdminsToRoleRequest.md

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

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

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