@digital8/lighting-illusions-ts-sdk 0.0.1827 → 0.0.1828

package/docs/PageComponentApi.md

@@ -1,341 +0,0 @@
-# PageComponentApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyPageComponent**](PageComponentApi.md#destroypagecomponent) | **DELETE** /admin-api/page-component/{pageComponent}/delete | Auto-generated: destroyPageComponent |
-| [**getAllPageComponent**](PageComponentApi.md#getallpagecomponentoperation) | **POST** /admin-api/page-component/all | Auto-generated: getAllPageComponent |
-| [**showPageComponent**](PageComponentApi.md#showpagecomponent) | **GET** /admin-api/page-component/{pageComponent} | Auto-generated: showPageComponent |
-| [**storePageComponent**](PageComponentApi.md#storepagecomponentoperation) | **POST** /admin-api/page-component/create | Auto-generated: storePageComponent |
-| [**updatePageComponent**](PageComponentApi.md#updatepagecomponentoperation) | **PUT** /admin-api/page-component/{pageComponent}/update | Auto-generated: updatePageComponent |
-
-
-
-## destroyPageComponent
-
-> GenericResponse destroyPageComponent(pageComponent)
-
-Auto-generated: destroyPageComponent
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PageComponentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyPageComponentRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageComponentApi();
-
-  const body = {
-    // number | The id of the pageComponent
-    pageComponent: 56,
-  } satisfies DestroyPageComponentRequest;
-
-  try {
-    const data = await api.destroyPageComponent(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **pageComponent** | `number` | The id of the pageComponent | [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)
-
-
-## getAllPageComponent
-
-> PageComponentLiteResourceArrayResponse getAllPageComponent(getAllPageComponentRequest)
-
-Auto-generated: getAllPageComponent
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PageComponentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllPageComponentOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageComponentApi();
-
-  const body = {
-    // GetAllPageComponentRequest (optional)
-    getAllPageComponentRequest: ...,
-  } satisfies GetAllPageComponentOperationRequest;
-
-  try {
-    const data = await api.getAllPageComponent(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getAllPageComponentRequest** | [GetAllPageComponentRequest](GetAllPageComponentRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PageComponentLiteResourceArrayResponse**](PageComponentLiteResourceArrayResponse.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)
-
-
-## showPageComponent
-
-> PageComponentResource showPageComponent(pageComponent)
-
-Auto-generated: showPageComponent
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PageComponentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowPageComponentRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageComponentApi();
-
-  const body = {
-    // number | The id of the pageComponent
-    pageComponent: 56,
-  } satisfies ShowPageComponentRequest;
-
-  try {
-    const data = await api.showPageComponent(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **pageComponent** | `number` | The id of the pageComponent | [Defaults to `undefined`] |
-
-### Return type
-
-[**PageComponentResource**](PageComponentResource.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)
-
-
-## storePageComponent
-
-> PageComponentResource storePageComponent(storePageComponentRequest)
-
-Auto-generated: storePageComponent
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PageComponentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StorePageComponentOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageComponentApi();
-
-  const body = {
-    // StorePageComponentRequest (optional)
-    storePageComponentRequest: ...,
-  } satisfies StorePageComponentOperationRequest;
-
-  try {
-    const data = await api.storePageComponent(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storePageComponentRequest** | [StorePageComponentRequest](StorePageComponentRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PageComponentResource**](PageComponentResource.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)
-
-
-## updatePageComponent
-
-> PageComponentResource updatePageComponent(pageComponent, updatePageComponentRequest)
-
-Auto-generated: updatePageComponent
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PageComponentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdatePageComponentOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageComponentApi();
-
-  const body = {
-    // number | The id of the pageComponent
-    pageComponent: 56,
-    // UpdatePageComponentRequest (optional)
-    updatePageComponentRequest: ...,
-  } satisfies UpdatePageComponentOperationRequest;
-
-  try {
-    const data = await api.updatePageComponent(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **pageComponent** | `number` | The id of the pageComponent | [Defaults to `undefined`] |
-| **updatePageComponentRequest** | [UpdatePageComponentRequest](UpdatePageComponentRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PageComponentResource**](PageComponentResource.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/PageComponentLiteResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# PageComponentLiteResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<PageComponentLiteResource>](PageComponentLiteResource.md)
-
-## Example
-
-```typescript
-import type { PageComponentLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies PageComponentLiteResourceArrayResponse
-
-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 PageComponentLiteResourceArrayResponse
-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/PageComponentRelationResource.md

@@ -1,44 +0,0 @@
-
-# PageComponentRelationResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`pageRelatableType` | string
-`pageRelatableId` | number
-`order` | number
-`pageRelatableName` | string
-`relatable` | [ProductChildFrontendResource](ProductChildFrontendResource.md)
-
-## Example
-
-```typescript
-import type { PageComponentRelationResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "pageRelatableType": null,
-  "pageRelatableId": null,
-  "order": null,
-  "pageRelatableName": null,
-  "relatable": null,
-} satisfies PageComponentRelationResource
-
-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 PageComponentRelationResource
-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/PageComponentRelationResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# PageComponentRelationResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<PageComponentRelationResource>](PageComponentRelationResource.md)
-
-## Example
-
-```typescript
-import type { PageComponentRelationResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies PageComponentRelationResourceArrayResponse
-
-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 PageComponentRelationResourceArrayResponse
-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/PageComponentResource.md

@@ -1,54 +0,0 @@
-
-# PageComponentResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`pageId` | number
-`type` | string
-`disabled` | boolean
-`order` | number
-`startDate` | Date
-`endDate` | Date
-`componentData` | string
-`frontendComponent` | [FrontendComponentLiteResource](FrontendComponentLiteResource.md)
-`pageComponentRelations` | [Array<PageComponentRelationResource>](PageComponentRelationResource.md)
-`autoProducts` | string
-
-## Example
-
-```typescript
-import type { PageComponentResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "pageId": null,
-  "type": null,
-  "disabled": null,
-  "order": null,
-  "startDate": null,
-  "endDate": null,
-  "componentData": null,
-  "frontendComponent": null,
-  "pageComponentRelations": null,
-  "autoProducts": null,
-} satisfies PageComponentResource
-
-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 PageComponentResource
-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/PageComponentResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# PageComponentResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<PageComponentResource>](PageComponentResource.md)
-
-## Example
-
-```typescript
-import type { PageComponentResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies PageComponentResourceArrayResponse
-
-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 PageComponentResourceArrayResponse
-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/PageListResource.md

@@ -1,54 +0,0 @@
-
-# PageListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`slug` | string
-`type` | object
-`enabled` | boolean
-`siteId` | number
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
-`startDate` | Date
-`createdAt` | string
-`updatedAt` | string
-
-## Example
-
-```typescript
-import type { PageListResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "slug": null,
-  "type": null,
-  "enabled": null,
-  "siteId": null,
-  "site": null,
-  "thumbnail": null,
-  "startDate": null,
-  "createdAt": null,
-  "updatedAt": null,
-} satisfies PageListResource
-
-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 PageListResource
-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/PageResource.md

@@ -1,52 +0,0 @@
-
-# PageResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`slug` | string
-`type` | object
-`enabled` | boolean
-`startDate` | Date
-`pageComponents` | object
-`blog` | [BlogResource](BlogResource.md)
-`seo` | [Array<SEOResource>](SEOResource.md)
-`site` | [SiteLiteResource](SiteLiteResource.md)
-
-## Example
-
-```typescript
-import type { PageResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "slug": null,
-  "type": null,
-  "enabled": null,
-  "startDate": null,
-  "pageComponents": null,
-  "blog": null,
-  "seo": null,
-  "site": null,
-} satisfies PageResource
-
-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 PageResource
-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/PaginatedBlogCategoryListResourceResponse.md

@@ -1,36 +0,0 @@
-
-# PaginatedBlogCategoryListResourceResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<BlogCategoryListResource>](BlogCategoryListResource.md)
-`meta` | [PagingMetadata](PagingMetadata.md)
-
-## Example
-
-```typescript
-import type { PaginatedBlogCategoryListResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-  "meta": null,
-} satisfies PaginatedBlogCategoryListResourceResponse
-
-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 PaginatedBlogCategoryListResourceResponse
-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)
-
-