@digital8/lighting-illusions-ts-sdk 0.0.1680 → 0.0.1682

package/docs/BlogCategoryLiteResourceArrayResponse.md

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

@@ -1,40 +0,0 @@
-
-# BlogCategoryResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`slug` | string
-`descriptions` | [Array<DescriptionResource>](DescriptionResource.md)
-
-## Example
-
-```typescript
-import type { BlogCategoryResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "slug": null,
-  "descriptions": null,
-} satisfies BlogCategoryResource
-
-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 BlogCategoryResource
-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/BlogFrontendDetailResource.md

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

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

@@ -1,48 +0,0 @@
-
-# BlogFrontendResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`slug` | string
-`excerpt` | string
-`featured` | boolean
-`thumbnail` | [AssetResource](AssetResource.md)
-`startDate` | Date
-`categories` | [Array<BlogCategoryLiteResource>](BlogCategoryLiteResource.md)
-
-## Example
-
-```typescript
-import type { BlogFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "slug": null,
-  "excerpt": null,
-  "featured": null,
-  "thumbnail": null,
-  "startDate": null,
-  "categories": null,
-} satisfies BlogFrontendResource
-
-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 BlogFrontendResource
-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/BlogFrontendResourceArrayResponse.md

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

@@ -1,44 +0,0 @@
-
-# BlogResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`pageId` | number
-`thumbnail` | [AssetResource](AssetResource.md)
-`excerpt` | string
-`featured` | boolean
-`blogCategories` | [Array<BlogCategoryLiteResource>](BlogCategoryLiteResource.md)
-
-## Example
-
-```typescript
-import type { BlogResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "pageId": null,
-  "thumbnail": null,
-  "excerpt": null,
-  "featured": null,
-  "blogCategories": null,
-} satisfies BlogResource
-
-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 BlogResource
-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/FrontendComponentApi.md

@@ -1,74 +0,0 @@
-# FrontendComponentApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**getAllFrontendComponent**](FrontendComponentApi.md#getallfrontendcomponentoperation) | **POST** /admin-api/frontend-component/all | Auto-generated: getAllFrontendComponent |
-
-
-
-## getAllFrontendComponent
-
-> FrontendComponentResourceArrayResponse getAllFrontendComponent(getAllFrontendComponentRequest)
-
-Auto-generated: getAllFrontendComponent
-
-### Example
-
-```ts
-import {
-  Configuration,
-  FrontendComponentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllFrontendComponentOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new FrontendComponentApi();
-
-  const body = {
-    // GetAllFrontendComponentRequest (optional)
-    getAllFrontendComponentRequest: ...,
-  } satisfies GetAllFrontendComponentOperationRequest;
-
-  try {
-    const data = await api.getAllFrontendComponent(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getAllFrontendComponentRequest** | [GetAllFrontendComponentRequest](GetAllFrontendComponentRequest.md) |  | [Optional] |
-
-### Return type
-
-[**FrontendComponentResourceArrayResponse**](FrontendComponentResourceArrayResponse.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/FrontendComponentLiteResource.md

@@ -1,38 +0,0 @@
-
-# FrontendComponentLiteResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`schema` | Array<boolean>
-
-## Example
-
-```typescript
-import type { FrontendComponentLiteResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "schema": null,
-} satisfies FrontendComponentLiteResource
-
-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 FrontendComponentLiteResource
-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/FrontendComponentLiteResourceArrayResponse.md

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

@@ -1,40 +0,0 @@
-
-# FrontendComponentResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`schema` | Array<boolean>
-`sites` | [Array<SiteLiteResource>](SiteLiteResource.md)
-
-## Example
-
-```typescript
-import type { FrontendComponentResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "schema": null,
-  "sites": null,
-} satisfies FrontendComponentResource
-
-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 FrontendComponentResource
-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/FrontendComponentResourceArrayResponse.md

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

@@ -1,44 +0,0 @@
-
-# GetAllBlogCategoryRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { GetAllBlogCategoryRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies GetAllBlogCategoryRequest
-
-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 GetAllBlogCategoryRequest
-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/GetAllFrontendComponentRequest.md

@@ -1,44 +0,0 @@
-
-# GetAllFrontendComponentRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { GetAllFrontendComponentRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies GetAllFrontendComponentRequest
-
-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 GetAllFrontendComponentRequest
-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/GetAllPageComponentRequest.md

@@ -1,48 +0,0 @@
-
-# GetAllPageComponentRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`pageId` | Array<string>
-`type` | Array<string>
-
-## Example
-
-```typescript
-import type { GetAllPageComponentRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "pageId": null,
-  "type": null,
-} satisfies GetAllPageComponentRequest
-
-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 GetAllPageComponentRequest
-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)
-
-