@digital8/lighting-illusions-ts-sdk 0.0.2382 → 0.0.2383

package/docs/PageApi.md

@@ -1,407 +0,0 @@
-# PageApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyPage**](PageApi.md#destroypage) | **DELETE** /admin-api/page/{page}/delete | Auto-generated: destroyPage |
-| [**getAllPage**](PageApi.md#getallpage) | **POST** /admin-api/page/all | Auto-generated: getAllPage |
-| [**indexPage**](PageApi.md#indexpage) | **POST** /admin-api/page/list | Auto-generated: indexPage |
-| [**showPage**](PageApi.md#showpage) | **GET** /admin-api/page/{page} | Auto-generated: showPage |
-| [**storePage**](PageApi.md#storepage) | **POST** /admin-api/page/create | Auto-generated: storePage |
-| [**updatePage**](PageApi.md#updatepageoperation) | **PUT** /admin-api/page/{page}/update | Auto-generated: updatePage |
-
-
-
-## destroyPage
-
-> GenericResponse destroyPage(page)
-
-Auto-generated: destroyPage
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PageApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyPageRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
-
-  const body = {
-    // number | The id of the page
-    page: 56,
-  } satisfies DestroyPageRequest;
-
-  try {
-    const data = await api.destroyPage(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **page** | `number` | The id of the page | [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)
-
-
-## getAllPage
-
-> PageLiteResourceArrayResponse getAllPage(searchAllPagesRequest)
-
-Auto-generated: getAllPage
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PageApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllPageRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
-
-  const body = {
-    // SearchAllPagesRequest (optional)
-    searchAllPagesRequest: ...,
-  } satisfies GetAllPageRequest;
-
-  try {
-    const data = await api.getAllPage(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **searchAllPagesRequest** | [SearchAllPagesRequest](SearchAllPagesRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PageLiteResourceArrayResponse**](PageLiteResourceArrayResponse.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)
-
-
-## indexPage
-
-> PaginatedPageListResourceResponse indexPage(searchPagesRequest)
-
-Auto-generated: indexPage
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PageApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexPageRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
-
-  const body = {
-    // SearchPagesRequest (optional)
-    searchPagesRequest: ...,
-  } satisfies IndexPageRequest;
-
-  try {
-    const data = await api.indexPage(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **searchPagesRequest** | [SearchPagesRequest](SearchPagesRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedPageListResourceResponse**](PaginatedPageListResourceResponse.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<\\PageListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## showPage
-
-> PageResource showPage(page)
-
-Auto-generated: showPage
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PageApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowPageRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
-
-  const body = {
-    // number | The id of the page
-    page: 56,
-  } satisfies ShowPageRequest;
-
-  try {
-    const data = await api.showPage(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **page** | `number` | The id of the page | [Defaults to `undefined`] |
-
-### Return type
-
-[**PageResource**](PageResource.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)
-
-
-## storePage
-
-> PageResource storePage(createPageRequest)
-
-Auto-generated: storePage
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PageApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StorePageRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
-
-  const body = {
-    // CreatePageRequest (optional)
-    createPageRequest: ...,
-  } satisfies StorePageRequest;
-
-  try {
-    const data = await api.storePage(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **createPageRequest** | [CreatePageRequest](CreatePageRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PageResource**](PageResource.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)
-
-
-## updatePage
-
-> PageResource updatePage(page, updatePageRequest)
-
-Auto-generated: updatePage
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PageApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdatePageOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
-
-  const body = {
-    // number | The id of the page
-    page: 56,
-    // UpdatePageRequest (optional)
-    updatePageRequest: ...,
-  } satisfies UpdatePageOperationRequest;
-
-  try {
-    const data = await api.updatePage(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **page** | `number` | The id of the page | [Defaults to `undefined`] |
-| **updatePageRequest** | [UpdatePageRequest](UpdatePageRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PageResource**](PageResource.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)
-