@digital8/lighting-illusions-ts-sdk 0.0.2343 → 0.0.2345

package/docs/PermissionsApi.md

@@ -0,0 +1,206 @@
+# PermissionsApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAllPermission**](PermissionsApi.md#getallpermission) | **POST** /admin-api/permissions/all | Auto-generated: getAllPermission |
+| [**indexPermission**](PermissionsApi.md#indexpermission) | **POST** /admin-api/permissions/list | Auto-generated: indexPermission |
+| [**showPermission**](PermissionsApi.md#showpermission) | **GET** /admin-api/permissions/{permission} | Auto-generated: showPermission |
+
+
+
+## getAllPermission
+
+> PermissionLiteResourceArrayResponse getAllPermission(searchAllPermissionsRequest)
+
+Auto-generated: getAllPermission
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PermissionsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllPermissionRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new PermissionsApi();
+
+  const body = {
+    // SearchAllPermissionsRequest (optional)
+    searchAllPermissionsRequest: ...,
+  } satisfies GetAllPermissionRequest;
+
+  try {
+    const data = await api.getAllPermission(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchAllPermissionsRequest** | [SearchAllPermissionsRequest](SearchAllPermissionsRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PermissionLiteResourceArrayResponse**](PermissionLiteResourceArrayResponse.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)
+
+
+## indexPermission
+
+> PaginatedPermissionListResourceResponse indexPermission(searchPermissionsRequest)
+
+Auto-generated: indexPermission
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PermissionsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexPermissionRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new PermissionsApi();
+
+  const body = {
+    // SearchPermissionsRequest (optional)
+    searchPermissionsRequest: ...,
+  } satisfies IndexPermissionRequest;
+
+  try {
+    const data = await api.indexPermission(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchPermissionsRequest** | [SearchPermissionsRequest](SearchPermissionsRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedPermissionListResourceResponse**](PaginatedPermissionListResourceResponse.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<\\PermissionListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showPermission
+
+> PermissionResource showPermission(permission)
+
+Auto-generated: showPermission
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PermissionsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowPermissionRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new PermissionsApi();
+
+  const body = {
+    // number | The id of the permission
+    permission: 56,
+  } satisfies ShowPermissionRequest;
+
+  try {
+    const data = await api.showPermission(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **permission** | `number` | The id of the permission | [Defaults to `undefined`] |
+
+### Return type
+
+[**PermissionResource**](PermissionResource.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)
+

package/docs/ResetPasswordAdminRequest.md

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

@@ -0,0 +1,48 @@
+
+# RoleListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`isLocked` | boolean
+`permissionCount` | number
+`adminsCount` | number
+`permissions` | object
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { RoleListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "isLocked": null,
+  "permissionCount": null,
+  "adminsCount": null,
+  "permissions": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies RoleListResource
+
+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 RoleListResource
+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/RoleListResourceArrayResponse.md

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

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

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

@@ -0,0 +1,50 @@
+
+# RoleResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`isLocked` | boolean
+`guardName` | string
+`permissionCount` | number
+`permissions` | [Array<PermissionLiteResource>](PermissionLiteResource.md)
+`admins` | [Array<AdminLiteResource>](AdminLiteResource.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { RoleResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "isLocked": null,
+  "guardName": null,
+  "permissionCount": null,
+  "permissions": null,
+  "admins": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies RoleResource
+
+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 RoleResource
+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/RoleResourceArrayResponse.md

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