npm - @digital8/lighting-illusions-ts-sdk - Versions diffs - 0.0.1884 → 0.0.1885 - Mend

@digital8/lighting-illusions-ts-sdk 0.0.1884 → 0.0.1885

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (401) hide show

package/docs/PageApi.md DELETED Viewed

@@ -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#getallpageoperation) | **POST** /admin-api/page/all | Auto-generated: getAllPage |
-| [**indexPage**](PageApi.md#indexpageoperation) | **POST** /admin-api/page/list | Auto-generated: indexPage |
-| [**showPage**](PageApi.md#showpage) | **GET** /admin-api/page/{page} | Auto-generated: showPage |
-| [**storePage**](PageApi.md#storepageoperation) | **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(getAllPageRequest)
-Auto-generated: getAllPage
-### Example
-```ts
-import {
-  Configuration,
-  PageApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllPageOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
-  const body = {
-    // GetAllPageRequest (optional)
-    getAllPageRequest: ...,
-  } satisfies GetAllPageOperationRequest;
-  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 |
-|------------- | ------------- | ------------- | -------------|
-| **getAllPageRequest** | [GetAllPageRequest](GetAllPageRequest.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(indexPageRequest)
-Auto-generated: indexPage
-### Example
-```ts
-import {
-  Configuration,
-  PageApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexPageOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
-  const body = {
-    // IndexPageRequest (optional)
-    indexPageRequest: ...,
-  } satisfies IndexPageOperationRequest;
-  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 |
-|------------- | ------------- | ------------- | -------------|
-| **indexPageRequest** | [IndexPageRequest](IndexPageRequest.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&lt;\\ResourcePaginator&lt;\\PageListResource[]&gt;&gt; |  -  |
-[[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(storePageRequest)
-Auto-generated: storePage
-### Example
-```ts
-import {
-  Configuration,
-  PageApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StorePageOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
-  const body = {
-    // StorePageRequest (optional)
-    storePageRequest: ...,
-  } satisfies StorePageOperationRequest;
-  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 |
-|------------- | ------------- | ------------- | -------------|
-| **storePageRequest** | [StorePageRequest](StorePageRequest.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)