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

package/docs/RolesApi.md

@@ -0,0 +1,407 @@
+# 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/SearchAdminUsersRequest.md

@@ -0,0 +1,54 @@
+
+# SearchAdminUsersRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`roleId` | Array<string>
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { SearchAdminUsersRequest } 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,
+  "roleId": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies SearchAdminUsersRequest
+
+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 SearchAdminUsersRequest
+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/SearchAllAdminUsersRequest.md

@@ -0,0 +1,44 @@
+
+# SearchAllAdminUsersRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { SearchAllAdminUsersRequest } 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 SearchAllAdminUsersRequest
+
+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 SearchAllAdminUsersRequest
+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/SearchAllCustomersRequest.md

@@ -0,0 +1,50 @@
+
+# SearchAllCustomersRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+`siteId` | Array<string>
+`type` | Array<string>
+`signUpType` | Array<string>
+
+## Example
+
+```typescript
+import type { SearchAllCustomersRequest } 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,
+  "siteId": null,
+  "type": null,
+  "signUpType": null,
+} satisfies SearchAllCustomersRequest
+
+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 SearchAllCustomersRequest
+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/SearchAllPermissionsRequest.md

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

@@ -0,0 +1,46 @@
+
+# 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/SearchCustomersRequest.md

@@ -12,6 +12,10 @@ Name | Type
 `perPage` | number
 `page` | number
 `siteId` | Array<string>
+`type` | Array<string>
+`signUpType` | Array<string>
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
@@ -29,6 +33,10 @@ const example = {
   "perPage": null,
   "page": null,
   "siteId": null,
+  "type": null,
+  "signUpType": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": null,
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,

package/docs/SearchPermissionsRequest.md

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