@digital8/lighting-illusions-ts-sdk 0.0.2283 → 0.0.2284

package/docs/RoleResource.md

@@ -1,48 +0,0 @@
-
-# RoleResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`isLocked` | boolean
-`guardName` | string
-`permissionCount` | object
-`permissions` | [Array<PermissionLiteResource>](PermissionLiteResource.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,
-  "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

@@ -1,34 +0,0 @@
-
-# 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)
-
-

package/docs/RolesApi.md

@@ -1,407 +0,0 @@
-# RolesApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyRole**](RolesApi.md#destroyrole) | **DELETE** /admin-api/roles/{role}/delete | Auto-generated: destroyRole |
-| [**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 |
-
-
-
-## 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)
-
-
-## 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)
-

package/docs/SearchAllPermissionsRequest.md

@@ -1,44 +0,0 @@
-
-# SearchAllPermissionsRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { SearchAllPermissionsRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies SearchAllPermissionsRequest
-
-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 SearchAllPermissionsRequest
-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/SearchAllRolesRequest.md

@@ -1,46 +0,0 @@
-
-# SearchAllRolesRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`isLocked` | Array<string>
-
-## Example
-
-```typescript
-import type { SearchAllRolesRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "isLocked": null,
-} satisfies SearchAllRolesRequest
-
-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 SearchAllRolesRequest
-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/SearchPermissionsRequest.md

@@ -1,48 +0,0 @@
-
-# SearchPermissionsRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { SearchPermissionsRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies SearchPermissionsRequest
-
-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 SearchPermissionsRequest
-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/SearchRolesRequest.md

@@ -1,50 +0,0 @@
-
-# SearchRolesRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`isLocked` | Array<string>
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { SearchRolesRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "isLocked": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies SearchRolesRequest
-
-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 SearchRolesRequest
-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/UpdateRoleRequest.md

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