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

package/docs/RolesApi.md

@@ -0,0 +1,683 @@
+# RolesApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**attachAdminsRole**](RolesApi.md#attachadminsrole) | **POST** /admin-api/roles/{role}/admins/attach | Auto-generated: attachAdminsRole |
+| [**attachPermissionsRole**](RolesApi.md#attachpermissionsrole) | **POST** /admin-api/roles/{role}/permissions/attach | Auto-generated: attachPermissionsRole |
+| [**destroyRole**](RolesApi.md#destroyrole) | **DELETE** /admin-api/roles/{role}/delete | Auto-generated: destroyRole |
+| [**detachAdminRole**](RolesApi.md#detachadminrole) | **DELETE** /admin-api/roles/{role}/admins/{admin} | Auto-generated: detachAdminRole |
+| [**detachPermissionRole**](RolesApi.md#detachpermissionrole) | **DELETE** /admin-api/roles/{role}/permissions/{permission} | Auto-generated: detachPermissionRole |
+| [**getAllRole**](RolesApi.md#getallrole) | **POST** /admin-api/roles/all | Auto-generated: getAllRole |
+| [**indexRole**](RolesApi.md#indexrole) | **POST** /admin-api/roles/list | Auto-generated: indexRole |
+| [**showRole**](RolesApi.md#showrole) | **GET** /admin-api/roles/{role} | Auto-generated: showRole |
+| [**storeRole**](RolesApi.md#storerole) | **POST** /admin-api/roles/create | Auto-generated: storeRole |
+| [**updateRole**](RolesApi.md#updateroleoperation) | **PUT** /admin-api/roles/{role}/update | Auto-generated: updateRole |
+
+
+
+## attachAdminsRole
+
+> RoleResource attachAdminsRole(role, attachAdminsToRoleRequest)
+
+Auto-generated: attachAdminsRole
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { AttachAdminsRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new RolesApi();
+
+  const body = {
+    // number | The id of the role
+    role: 56,
+    // AttachAdminsToRoleRequest (optional)
+    attachAdminsToRoleRequest: ...,
+  } satisfies AttachAdminsRoleRequest;
+
+  try {
+    const data = await api.attachAdminsRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **role** | `number` | The id of the role | [Defaults to `undefined`] |
+| **attachAdminsToRoleRequest** | [AttachAdminsToRoleRequest](AttachAdminsToRoleRequest.md) |  | [Optional] |
+
+### Return type
+
+[**RoleResource**](RoleResource.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)
+
+
+## attachPermissionsRole
+
+> RoleResource attachPermissionsRole(role, attachPermissionsToRoleRequest)
+
+Auto-generated: attachPermissionsRole
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { AttachPermissionsRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new RolesApi();
+
+  const body = {
+    // number | The id of the role
+    role: 56,
+    // AttachPermissionsToRoleRequest (optional)
+    attachPermissionsToRoleRequest: ...,
+  } satisfies AttachPermissionsRoleRequest;
+
+  try {
+    const data = await api.attachPermissionsRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **role** | `number` | The id of the role | [Defaults to `undefined`] |
+| **attachPermissionsToRoleRequest** | [AttachPermissionsToRoleRequest](AttachPermissionsToRoleRequest.md) |  | [Optional] |
+
+### Return type
+
+[**RoleResource**](RoleResource.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)
+
+
+## destroyRole
+
+> GenericResponse destroyRole(role)
+
+Auto-generated: destroyRole
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new RolesApi();
+
+  const body = {
+    // number | The id of the role
+    role: 56,
+  } satisfies DestroyRoleRequest;
+
+  try {
+    const data = await api.destroyRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **role** | `number` | The id of the role | [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)
+
+
+## detachAdminRole
+
+> RoleResource detachAdminRole(role, admin)
+
+Auto-generated: detachAdminRole
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DetachAdminRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new RolesApi();
+
+  const body = {
+    // number | The id of the role
+    role: 56,
+    // number | The id of the admin
+    admin: 56,
+  } satisfies DetachAdminRoleRequest;
+
+  try {
+    const data = await api.detachAdminRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **role** | `number` | The id of the role | [Defaults to `undefined`] |
+| **admin** | `number` | The id of the admin | [Defaults to `undefined`] |
+
+### Return type
+
+[**RoleResource**](RoleResource.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)
+
+
+## detachPermissionRole
+
+> RoleResource detachPermissionRole(role, permission)
+
+Auto-generated: detachPermissionRole
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DetachPermissionRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new RolesApi();
+
+  const body = {
+    // number | The id of the role
+    role: 56,
+    // number | The id of the permission
+    permission: 56,
+  } satisfies DetachPermissionRoleRequest;
+
+  try {
+    const data = await api.detachPermissionRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **role** | `number` | The id of the role | [Defaults to `undefined`] |
+| **permission** | `number` | The id of the permission | [Defaults to `undefined`] |
+
+### Return type
+
+[**RoleResource**](RoleResource.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)
+
+
+## getAllRole
+
+> RoleLiteResourceArrayResponse getAllRole(searchAllRolesRequest)
+
+Auto-generated: getAllRole
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new RolesApi();
+
+  const body = {
+    // SearchAllRolesRequest (optional)
+    searchAllRolesRequest: ...,
+  } satisfies GetAllRoleRequest;
+
+  try {
+    const data = await api.getAllRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchAllRolesRequest** | [SearchAllRolesRequest](SearchAllRolesRequest.md) |  | [Optional] |
+
+### Return type
+
+[**RoleLiteResourceArrayResponse**](RoleLiteResourceArrayResponse.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)
+
+
+## indexRole
+
+> PaginatedRoleListResourceResponse indexRole(searchRolesRequest)
+
+Auto-generated: indexRole
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new RolesApi();
+
+  const body = {
+    // SearchRolesRequest (optional)
+    searchRolesRequest: ...,
+  } satisfies IndexRoleRequest;
+
+  try {
+    const data = await api.indexRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchRolesRequest** | [SearchRolesRequest](SearchRolesRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedRoleListResourceResponse**](PaginatedRoleListResourceResponse.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<\\RoleListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showRole
+
+> RoleResource showRole(role)
+
+Auto-generated: showRole
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new RolesApi();
+
+  const body = {
+    // number | The id of the role
+    role: 56,
+  } satisfies ShowRoleRequest;
+
+  try {
+    const data = await api.showRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **role** | `number` | The id of the role | [Defaults to `undefined`] |
+
+### Return type
+
+[**RoleResource**](RoleResource.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)
+
+
+## storeRole
+
+> RoleResource storeRole(createRoleRequest)
+
+Auto-generated: storeRole
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreRoleRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new RolesApi();
+
+  const body = {
+    // CreateRoleRequest (optional)
+    createRoleRequest: ...,
+  } satisfies StoreRoleRequest;
+
+  try {
+    const data = await api.storeRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createRoleRequest** | [CreateRoleRequest](CreateRoleRequest.md) |  | [Optional] |
+
+### Return type
+
+[**RoleResource**](RoleResource.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)
+
+
+## updateRole
+
+> RoleResource updateRole(role, updateRoleRequest)
+
+Auto-generated: updateRole
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateRoleOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new RolesApi();
+
+  const body = {
+    // number | The id of the role
+    role: 56,
+    // UpdateRoleRequest (optional)
+    updateRoleRequest: ...,
+  } satisfies UpdateRoleOperationRequest;
+
+  try {
+    const data = await api.updateRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **role** | `number` | The id of the role | [Defaults to `undefined`] |
+| **updateRoleRequest** | [UpdateRoleRequest](UpdateRoleRequest.md) |  | [Optional] |
+
+### Return type
+
+[**RoleResource**](RoleResource.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)
+