npm - @digital8/lighting-illusions-ts-sdk - Versions diffs - 0.0.1817 → 0.0.1819 - Mend

@digital8/lighting-illusions-ts-sdk 0.0.1817 → 0.0.1819

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 (591) hide show

package/docs/{IndexReviewRequest.md → IndexBlogCategoryRequest.md} RENAMED Viewed

@@ -1,5 +1,5 @@
-# IndexReviewRequest
+# IndexBlogCategoryRequest
 ## Properties
@@ -11,9 +11,7 @@ Name | Type
 `sortDirection` | string
 `perPage` | number
 `page` | number
-`siteId` | Array&lt;string&gt;
-`createdByAdmin` | Array&lt;string&gt;
-`hasApprovedAt` | Array&lt;string&gt;
+`hasBlogs` | Array&lt;string&gt;
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
@@ -21,7 +19,7 @@ Name | Type
 ## Example
 ```typescript
-import type { IndexReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
+import type { IndexBlogCategoryRequest } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
@@ -30,13 +28,11 @@ const example = {
   "sortDirection": null,
   "perPage": null,
   "page": null,
-  "siteId": null,
-  "createdByAdmin": null,
-  "hasApprovedAt": null,
+  "hasBlogs": null,
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,
-} satisfies IndexReviewRequest
+} satisfies IndexBlogCategoryRequest
 console.log(example)
@@ -45,7 +41,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as IndexReviewRequest
+const exampleParsed = JSON.parse(exampleJSON) as IndexBlogCategoryRequest
 console.log(exampleParsed)
 ```

package/docs/{IndexMenuRequest.md → IndexPageRequest.md} RENAMED Viewed

@@ -1,5 +1,5 @@
-# IndexMenuRequest
+# IndexPageRequest
 ## Properties
@@ -12,7 +12,8 @@ Name | Type
 `perPage` | number
 `page` | number
 `siteId` | Array&lt;string&gt;
-`position` | Array&lt;string&gt;
+`type` | Array&lt;string&gt;
+`enabled` | Array&lt;string&gt;
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
@@ -20,7 +21,7 @@ Name | Type
 ## Example
 ```typescript
-import type { IndexMenuRequest } from '@digital8/lighting-illusions-ts-sdk'
+import type { IndexPageRequest } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
@@ -30,11 +31,12 @@ const example = {
   "perPage": null,
   "page": null,
   "siteId": null,
-  "position": null,
+  "type": null,
+  "enabled": null,
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,
-} satisfies IndexMenuRequest
+} satisfies IndexPageRequest
 console.log(example)
@@ -43,7 +45,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as IndexMenuRequest
+const exampleParsed = JSON.parse(exampleJSON) as IndexPageRequest
 console.log(exampleParsed)
 ```

package/docs/{MenuApi.md → PageApi.md} RENAMED Viewed

@@ -1,44 +1,44 @@
-# MenuApi
+# PageApi
 All URIs are relative to *http://localhost/api*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**destroyMenu**](MenuApi.md#destroymenu) | **DELETE** /admin-api/menu/{menu}/delete | Auto-generated: destroyMenu |
-| [**getAllMenu**](MenuApi.md#getallmenuoperation) | **POST** /admin-api/menu/all | Auto-generated: getAllMenu |
-| [**indexMenu**](MenuApi.md#indexmenuoperation) | **POST** /admin-api/menu/list | Auto-generated: indexMenu |
-| [**showMenu**](MenuApi.md#showmenu) | **GET** /admin-api/menu/{menu} | Auto-generated: showMenu |
-| [**storeMenu**](MenuApi.md#storemenuoperation) | **POST** /admin-api/menu/create | Auto-generated: storeMenu |
-| [**updateMenu**](MenuApi.md#updatemenuoperation) | **PUT** /admin-api/menu/{menu}/update | Auto-generated: updateMenu |
+| [**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 |
-## destroyMenu
+## destroyPage
-> GenericResponse destroyMenu(menu)
+> GenericResponse destroyPage(page)
-Auto-generated: destroyMenu
+Auto-generated: destroyPage
 ### Example
 ```ts
 import {
   Configuration,
-  MenuApi,
+  PageApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyMenuRequest } 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 MenuApi();
+  const api = new PageApi();
   const body = {
-    // number | The id of the menu
-    menu: 56,
-  } satisfies DestroyMenuRequest;
+    // number | The id of the page
+    page: 56,
+  } satisfies DestroyPageRequest;
   try {
-    const data = await api.destroyMenu(body);
+    const data = await api.destroyPage(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -54,7 +54,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **menu** | `number` | The id of the menu | [Defaults to `undefined`] |
+| **page** | `number` | The id of the page | [Defaults to `undefined`] |
 ### Return type
@@ -73,37 +73,37 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | \\JsonResponse&lt;array{message: string}&gt; |  -  |
+| **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)
-## getAllMenu
+## getAllPage
-> MenuListResourceArrayResponse getAllMenu(getAllMenuRequest)
+> PageLiteResourceArrayResponse getAllPage(getAllPageRequest)
-Auto-generated: getAllMenu
+Auto-generated: getAllPage
 ### Example
 ```ts
 import {
   Configuration,
-  MenuApi,
+  PageApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllMenuOperationRequest } 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 MenuApi();
+  const api = new PageApi();
   const body = {
-    // GetAllMenuRequest (optional)
-    getAllMenuRequest: ...,
-  } satisfies GetAllMenuOperationRequest;
+    // GetAllPageRequest (optional)
+    getAllPageRequest: ...,
+  } satisfies GetAllPageOperationRequest;
   try {
-    const data = await api.getAllMenu(body);
+    const data = await api.getAllPage(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -119,11 +119,11 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **getAllMenuRequest** | [GetAllMenuRequest](GetAllMenuRequest.md) |  | [Optional] |
+| **getAllPageRequest** | [GetAllPageRequest](GetAllPageRequest.md) |  | [Optional] |
 ### Return type
-[**MenuListResourceArrayResponse**](MenuListResourceArrayResponse.md)
+[**PageLiteResourceArrayResponse**](PageLiteResourceArrayResponse.md)
 ### Authorization
@@ -143,32 +143,32 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-## indexMenu
+## indexPage
-> PaginatedMenuListResourceResponse indexMenu(indexMenuRequest)
+> PaginatedPageListResourceResponse indexPage(indexPageRequest)
-Auto-generated: indexMenu
+Auto-generated: indexPage
 ### Example
 ```ts
 import {
   Configuration,
-  MenuApi,
+  PageApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexMenuOperationRequest } 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 MenuApi();
+  const api = new PageApi();
   const body = {
-    // IndexMenuRequest (optional)
-    indexMenuRequest: ...,
-  } satisfies IndexMenuOperationRequest;
+    // IndexPageRequest (optional)
+    indexPageRequest: ...,
+  } satisfies IndexPageOperationRequest;
   try {
-    const data = await api.indexMenu(body);
+    const data = await api.indexPage(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -184,11 +184,11 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **indexMenuRequest** | [IndexMenuRequest](IndexMenuRequest.md) |  | [Optional] |
+| **indexPageRequest** | [IndexPageRequest](IndexPageRequest.md) |  | [Optional] |
 ### Return type
-[**PaginatedMenuListResourceResponse**](PaginatedMenuListResourceResponse.md)
+[**PaginatedPageListResourceResponse**](PaginatedPageListResourceResponse.md)
 ### Authorization
@@ -203,37 +203,37 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Paginated response \\JsonResponse&lt;\\ResourcePaginator&lt;\\MenuListResource[]&gt;&gt; |  -  |
+| **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)
-## showMenu
+## showPage
-> MenuResource showMenu(menu)
+> PageResource showPage(page)
-Auto-generated: showMenu
+Auto-generated: showPage
 ### Example
 ```ts
 import {
   Configuration,
-  MenuApi,
+  PageApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowMenuRequest } 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 MenuApi();
+  const api = new PageApi();
   const body = {
-    // number | The id of the menu
-    menu: 56,
-  } satisfies ShowMenuRequest;
+    // number | The id of the page
+    page: 56,
+  } satisfies ShowPageRequest;
   try {
-    const data = await api.showMenu(body);
+    const data = await api.showPage(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -249,11 +249,11 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **menu** | `number` | The id of the menu | [Defaults to `undefined`] |
+| **page** | `number` | The id of the page | [Defaults to `undefined`] |
 ### Return type
-[**MenuResource**](MenuResource.md)
+[**PageResource**](PageResource.md)
 ### Authorization
@@ -273,32 +273,32 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-## storeMenu
+## storePage
-> MenuResource storeMenu(storeMenuRequest)
+> PageResource storePage(storePageRequest)
-Auto-generated: storeMenu
+Auto-generated: storePage
 ### Example
 ```ts
 import {
   Configuration,
-  MenuApi,
+  PageApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreMenuOperationRequest } 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 MenuApi();
+  const api = new PageApi();
   const body = {
-    // StoreMenuRequest (optional)
-    storeMenuRequest: ...,
-  } satisfies StoreMenuOperationRequest;
+    // StorePageRequest (optional)
+    storePageRequest: ...,
+  } satisfies StorePageOperationRequest;
   try {
-    const data = await api.storeMenu(body);
+    const data = await api.storePage(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -314,11 +314,11 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **storeMenuRequest** | [StoreMenuRequest](StoreMenuRequest.md) |  | [Optional] |
+| **storePageRequest** | [StorePageRequest](StorePageRequest.md) |  | [Optional] |
 ### Return type
-[**MenuResource**](MenuResource.md)
+[**PageResource**](PageResource.md)
 ### Authorization
@@ -338,34 +338,34 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-## updateMenu
+## updatePage
-> MenuResource updateMenu(menu, updateMenuRequest)
+> PageResource updatePage(page, updatePageRequest)
-Auto-generated: updateMenu
+Auto-generated: updatePage
 ### Example
 ```ts
 import {
   Configuration,
-  MenuApi,
+  PageApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateMenuOperationRequest } 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 MenuApi();
+  const api = new PageApi();
   const body = {
-    // number | The id of the menu
-    menu: 56,
-    // UpdateMenuRequest (optional)
-    updateMenuRequest: ...,
-  } satisfies UpdateMenuOperationRequest;
+    // number | The id of the page
+    page: 56,
+    // UpdatePageRequest (optional)
+    updatePageRequest: ...,
+  } satisfies UpdatePageOperationRequest;
   try {
-    const data = await api.updateMenu(body);
+    const data = await api.updatePage(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -381,12 +381,12 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **menu** | `number` | The id of the menu | [Defaults to `undefined`] |
-| **updateMenuRequest** | [UpdateMenuRequest](UpdateMenuRequest.md) |  | [Optional] |
+| **page** | `number` | The id of the page | [Defaults to `undefined`] |
+| **updatePageRequest** | [UpdatePageRequest](UpdatePageRequest.md) |  | [Optional] |
 ### Return type
-[**MenuResource**](MenuResource.md)
+[**PageResource**](PageResource.md)
 ### Authorization