npm - @digital8/lighting-illusions-ts-sdk - Versions diffs - 0.0.1815 → 0.0.1816 - Mend

@digital8/lighting-illusions-ts-sdk 0.0.1815 → 0.0.1816

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

package/docs/ListAssetsProductRegistrationRequest.md DELETED Viewed

@@ -1,52 +0,0 @@
-# ListAssetsProductRegistrationRequest
-## Properties
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`productRegistrationId` | Array&lt;string&gt;
-`type` | Array&lt;string&gt;
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-## Example
-```typescript
-import type { ListAssetsProductRegistrationRequest } 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,
-  "productRegistrationId": null,
-  "type": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies ListAssetsProductRegistrationRequest
-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 ListAssetsProductRegistrationRequest
-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/MenuItemHierarchyResource.md DELETED Viewed

@@ -1,50 +0,0 @@
-# MenuItemHierarchyResource
-## Properties
-Name | Type
------------- | -------------
-`id` | number
-`menuId` | number
-`parentId` | number
-`type` | string
-`heading` | string
-`subheading` | string
-`index` | number
-`children` | [Array&lt;MenuItemHierarchyResource&gt;](MenuItemHierarchyResource.md)
-`menuItemLink` | [MenuItemLinkResource](MenuItemLinkResource.md)
-## Example
-```typescript
-import type { MenuItemHierarchyResource } from '@digital8/lighting-illusions-ts-sdk'
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "menuId": null,
-  "parentId": null,
-  "type": null,
-  "heading": null,
-  "subheading": null,
-  "index": null,
-  "children": null,
-  "menuItemLink": null,
-} satisfies MenuItemHierarchyResource
-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 MenuItemHierarchyResource
-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/MenuItemResource.md DELETED Viewed

@@ -1,58 +0,0 @@
-# MenuItemResource
-## Properties
-Name | Type
------------- | -------------
-`id` | number
-`menuId` | number
-`parentId` | number
-`type` | string
-`heading` | string
-`subheading` | string
-`css` | string
-`cssMobile` | string
-`javascript` | string
-`index` | number
-`children` | [Array&lt;MenuItemResource&gt;](MenuItemResource.md)
-`asset` | [AssetResource](AssetResource.md)
-`menuItemLink` | [MenuItemLinkResource](MenuItemLinkResource.md)
-## Example
-```typescript
-import type { MenuItemResource } from '@digital8/lighting-illusions-ts-sdk'
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "menuId": null,
-  "parentId": null,
-  "type": null,
-  "heading": null,
-  "subheading": null,
-  "css": null,
-  "cssMobile": null,
-  "javascript": null,
-  "index": null,
-  "children": null,
-  "asset": null,
-  "menuItemLink": null,
-} satisfies MenuItemResource
-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 MenuItemResource
-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/MenuItemsApi.md DELETED Viewed

@@ -1,473 +0,0 @@
-# MenuItemsApi
-All URIs are relative to *http://localhost/api*
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyMenuItem**](MenuItemsApi.md#destroymenuitem) | **DELETE** /admin-api/menu-items/{menuItem}/delete | Auto-generated: destroyMenuItem |
-| [**getAllMenuItem**](MenuItemsApi.md#getallmenuitemoperation) | **POST** /admin-api/menu-items/all | Auto-generated: getAllMenuItem |
-| [**getHierarchyMenuItem**](MenuItemsApi.md#gethierarchymenuitemoperation) | **POST** /admin-api/menu-items/hierarchy | Auto-generated: getHierarchyMenuItem |
-| [**searchLinkablesMenuItem**](MenuItemsApi.md#searchlinkablesmenuitemoperation) | **POST** /admin-api/menu-items/linkables/search | Auto-generated: searchLinkablesMenuItem |
-| [**showMenuItem**](MenuItemsApi.md#showmenuitem) | **GET** /admin-api/menu-items/{menuItem} | Auto-generated: showMenuItem |
-| [**storeMenuItem**](MenuItemsApi.md#storemenuitemoperation) | **POST** /admin-api/menu-items/create | Auto-generated: storeMenuItem |
-| [**updateMenuItem**](MenuItemsApi.md#updatemenuitemoperation) | **PUT** /admin-api/menu-items/{menuItem}/update | Auto-generated: updateMenuItem |
-## destroyMenuItem
-> GenericResponse destroyMenuItem(menuItem)
-Auto-generated: destroyMenuItem
-### Example
-```ts
-import {
-  Configuration,
-  MenuItemsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuItemsApi();
-  const body = {
-    // number | The id of the menuItem
-    menuItem: 56,
-  } satisfies DestroyMenuItemRequest;
-  try {
-    const data = await api.destroyMenuItem(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **menuItem** | `number` | The id of the menuItem | [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&lt;array{message: string}&gt; |  -  |
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-## getAllMenuItem
-> MenuItemLiteResourceArrayResponse getAllMenuItem(getAllMenuItemRequest)
-Auto-generated: getAllMenuItem
-### Example
-```ts
-import {
-  Configuration,
-  MenuItemsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuItemsApi();
-  const body = {
-    // GetAllMenuItemRequest (optional)
-    getAllMenuItemRequest: ...,
-  } satisfies GetAllMenuItemOperationRequest;
-  try {
-    const data = await api.getAllMenuItem(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getAllMenuItemRequest** | [GetAllMenuItemRequest](GetAllMenuItemRequest.md) |  | [Optional] |
-### Return type
-[**MenuItemLiteResourceArrayResponse**](MenuItemLiteResourceArrayResponse.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)
-## getHierarchyMenuItem
-> MenuItemHierarchyResourceArrayResponse getHierarchyMenuItem(getHierarchyMenuItemRequest)
-Auto-generated: getHierarchyMenuItem
-### Example
-```ts
-import {
-  Configuration,
-  MenuItemsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetHierarchyMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuItemsApi();
-  const body = {
-    // GetHierarchyMenuItemRequest (optional)
-    getHierarchyMenuItemRequest: ...,
-  } satisfies GetHierarchyMenuItemOperationRequest;
-  try {
-    const data = await api.getHierarchyMenuItem(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getHierarchyMenuItemRequest** | [GetHierarchyMenuItemRequest](GetHierarchyMenuItemRequest.md) |  | [Optional] |
-### Return type
-[**MenuItemHierarchyResourceArrayResponse**](MenuItemHierarchyResourceArrayResponse.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)
-## searchLinkablesMenuItem
-> GenericResponse searchLinkablesMenuItem(searchLinkablesMenuItemRequest)
-Auto-generated: searchLinkablesMenuItem
-### Example
-```ts
-import {
-  Configuration,
-  MenuItemsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { SearchLinkablesMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuItemsApi();
-  const body = {
-    // SearchLinkablesMenuItemRequest (optional)
-    searchLinkablesMenuItemRequest: ...,
-  } satisfies SearchLinkablesMenuItemOperationRequest;
-  try {
-    const data = await api.searchLinkablesMenuItem(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **searchLinkablesMenuItemRequest** | [SearchLinkablesMenuItemRequest](SearchLinkablesMenuItemRequest.md) |  | [Optional] |
-### Return type
-[**GenericResponse**](GenericResponse.md)
-### Authorization
-No authorization required
-### HTTP request headers
-- **Content-Type**: `application/json`
-- **Accept**: `application/json`
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | \\JsonResponse&lt;array{data: array&lt;int,array{id: int, slug: string|null, name: string, linkable_type: string}&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)
-## showMenuItem
-> MenuItemResource showMenuItem(menuItem)
-Auto-generated: showMenuItem
-### Example
-```ts
-import {
-  Configuration,
-  MenuItemsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuItemsApi();
-  const body = {
-    // number | The id of the menuItem
-    menuItem: 56,
-  } satisfies ShowMenuItemRequest;
-  try {
-    const data = await api.showMenuItem(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **menuItem** | `number` | The id of the menuItem | [Defaults to `undefined`] |
-### Return type
-[**MenuItemResource**](MenuItemResource.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)
-## storeMenuItem
-> MenuItemResource storeMenuItem(storeMenuItemRequest)
-Auto-generated: storeMenuItem
-### Example
-```ts
-import {
-  Configuration,
-  MenuItemsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuItemsApi();
-  const body = {
-    // StoreMenuItemRequest (optional)
-    storeMenuItemRequest: ...,
-  } satisfies StoreMenuItemOperationRequest;
-  try {
-    const data = await api.storeMenuItem(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storeMenuItemRequest** | [StoreMenuItemRequest](StoreMenuItemRequest.md) |  | [Optional] |
-### Return type
-[**MenuItemResource**](MenuItemResource.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)
-## updateMenuItem
-> MenuItemResource updateMenuItem(menuItem, updateMenuItemRequest)
-Auto-generated: updateMenuItem
-### Example
-```ts
-import {
-  Configuration,
-  MenuItemsApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuItemsApi();
-  const body = {
-    // number | The id of the menuItem
-    menuItem: 56,
-    // UpdateMenuItemRequest (optional)
-    updateMenuItemRequest: ...,
-  } satisfies UpdateMenuItemOperationRequest;
-  try {
-    const data = await api.updateMenuItem(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-// Run the test
-example().catch(console.error);
-```
-### Parameters
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **menuItem** | `number` | The id of the menuItem | [Defaults to `undefined`] |
-| **updateMenuItemRequest** | [UpdateMenuItemRequest](UpdateMenuItemRequest.md) |  | [Optional] |
-### Return type
-[**MenuItemResource**](MenuItemResource.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)