@digital8/lighting-illusions-ts-sdk 0.0.1672 → 0.0.1673

package/dist/models/index.js

@@ -117,10 +117,14 @@ __exportStar(require("./FrontendComponentResourceArrayResponse"), exports);
 __exportStar(require("./GenericResponse"), exports);
 __exportStar(require("./GetAllAttributeRequest"), exports);
 __exportStar(require("./GetAllAttributeValueRequest"), exports);
+__exportStar(require("./GetAllBlogCategoryRequest"), exports);
 __exportStar(require("./GetAllDefinitionRequest"), exports);
 __exportStar(require("./GetAllDocumentRequest"), exports);
+__exportStar(require("./GetAllFrontendComponentRequest"), exports);
 __exportStar(require("./GetAllGoogleCategoryRequest"), exports);
 __exportStar(require("./GetAllOverlayTemplateRequest"), exports);
+__exportStar(require("./GetAllPageComponentRequest"), exports);
+__exportStar(require("./GetAllPageRequest"), exports);
 __exportStar(require("./GetAllProductCategoryRequest"), exports);
 __exportStar(require("./GetAllProductChildRequest"), exports);
 __exportStar(require("./GetAllProductRangeRequest"), exports);
@@ -142,12 +146,14 @@ __exportStar(require("./GoogleCategoryResource"), exports);
 __exportStar(require("./GoogleCategoryResourceArrayResponse"), exports);
 __exportStar(require("./IndexAttributeRequest"), exports);
 __exportStar(require("./IndexAttributeValueRequest"), exports);
+__exportStar(require("./IndexBlogCategoryRequest"), exports);
 __exportStar(require("./IndexDefinitionRequest"), exports);
 __exportStar(require("./IndexDocumentRequest"), exports);
 __exportStar(require("./IndexExternalApiLogRequest"), exports);
 __exportStar(require("./IndexLabelRequest"), exports);
 __exportStar(require("./IndexModelAttributeRequest"), exports);
 __exportStar(require("./IndexOverlayTemplateRequest"), exports);
+__exportStar(require("./IndexPageRequest"), exports);
 __exportStar(require("./IndexProductCategoryRequest"), exports);
 __exportStar(require("./IndexProductChildRequest"), exports);
 __exportStar(require("./IndexProductRangeRequest"), exports);
@@ -360,6 +366,7 @@ __exportStar(require("./StoreAssetFileRequest"), exports);
 __exportStar(require("./StoreAssetForAssetableRequest"), exports);
 __exportStar(require("./StoreAttributeRequest"), exports);
 __exportStar(require("./StoreAttributeValueRequest"), exports);
+__exportStar(require("./StoreBlogCategoryRequest"), exports);
 __exportStar(require("./StoreDefinitionRequest"), exports);
 __exportStar(require("./StoreDocumentFileRequest"), exports);
 __exportStar(require("./StoreDocumentRequest"), exports);
@@ -372,6 +379,10 @@ __exportStar(require("./StoreLiteResource"), exports);
 __exportStar(require("./StoreLiteResourceArrayResponse"), exports);
 __exportStar(require("./StoreOverlayTemplateAssetRequest"), exports);
 __exportStar(require("./StoreOverlayTemplateRequest"), exports);
+__exportStar(require("./StorePageComponentRequest"), exports);
+__exportStar(require("./StorePageComponentRequestRelationsInner"), exports);
+__exportStar(require("./StorePageRequest"), exports);
+__exportStar(require("./StorePageRequestBlog"), exports);
 __exportStar(require("./StoreProductCategoryRequest"), exports);
 __exportStar(require("./StoreProductCategoryRequestAutomationRulesInner"), exports);
 __exportStar(require("./StoreProductCategoryRequestDescriptionsInner"), exports);
@@ -418,6 +429,7 @@ __exportStar(require("./TagType"), exports);
 __exportStar(require("./UpdateAssetForAssetableRequest"), exports);
 __exportStar(require("./UpdateAttributeRequest"), exports);
 __exportStar(require("./UpdateAttributeValueRequest"), exports);
+__exportStar(require("./UpdateBlogCategoryRequest"), exports);
 __exportStar(require("./UpdateDefinitionRequest"), exports);
 __exportStar(require("./UpdateDocumentRequest"), exports);
 __exportStar(require("./UpdateFilterOrderAttributeRequest"), exports);
@@ -426,6 +438,8 @@ __exportStar(require("./UpdateLabelRequest"), exports);
 __exportStar(require("./UpdateModelAttributeRequest"), exports);
 __exportStar(require("./UpdateOverlayTemplateAssetRequest"), exports);
 __exportStar(require("./UpdateOverlayTemplateRequest"), exports);
+__exportStar(require("./UpdatePageComponentRequest"), exports);
+__exportStar(require("./UpdatePageRequest"), exports);
 __exportStar(require("./UpdateProductCategoryRequest"), exports);
 __exportStar(require("./UpdateProductChildRequest"), exports);
 __exportStar(require("./UpdateProductChildRequestAssetsInner"), exports);

package/docs/BlogCategoryApi.md

@@ -0,0 +1,407 @@
+# BlogCategoryApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**destroyBlogCategory**](BlogCategoryApi.md#destroyblogcategory) | **DELETE** /admin-api/blog-category/{blogCategory}/delete | Auto-generated: destroyBlogCategory |
+| [**getAllBlogCategory**](BlogCategoryApi.md#getallblogcategoryoperation) | **POST** /admin-api/blog-category/all | Auto-generated: getAllBlogCategory |
+| [**indexBlogCategory**](BlogCategoryApi.md#indexblogcategoryoperation) | **POST** /admin-api/blog-category/list | Auto-generated: indexBlogCategory |
+| [**showBlogCategory**](BlogCategoryApi.md#showblogcategory) | **GET** /admin-api/blog-category/{blogCategory} | Auto-generated: showBlogCategory |
+| [**storeBlogCategory**](BlogCategoryApi.md#storeblogcategoryoperation) | **POST** /admin-api/blog-category/create | Auto-generated: storeBlogCategory |
+| [**updateBlogCategory**](BlogCategoryApi.md#updateblogcategoryoperation) | **PUT** /admin-api/blog-category/{blogCategory}/update | Auto-generated: updateBlogCategory |
+
+
+
+## destroyBlogCategory
+
+> GenericResponse destroyBlogCategory(blogCategory)
+
+Auto-generated: destroyBlogCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BlogCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyBlogCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new BlogCategoryApi();
+
+  const body = {
+    // number | The id of the blogCategory
+    blogCategory: 56,
+  } satisfies DestroyBlogCategoryRequest;
+
+  try {
+    const data = await api.destroyBlogCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **blogCategory** | `number` | The id of the blogCategory | [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)
+
+
+## getAllBlogCategory
+
+> BlogCategoryLiteResourceArrayResponse getAllBlogCategory(getAllBlogCategoryRequest)
+
+Auto-generated: getAllBlogCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BlogCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllBlogCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new BlogCategoryApi();
+
+  const body = {
+    // GetAllBlogCategoryRequest (optional)
+    getAllBlogCategoryRequest: ...,
+  } satisfies GetAllBlogCategoryOperationRequest;
+
+  try {
+    const data = await api.getAllBlogCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getAllBlogCategoryRequest** | [GetAllBlogCategoryRequest](GetAllBlogCategoryRequest.md) |  | [Optional] |
+
+### Return type
+
+[**BlogCategoryLiteResourceArrayResponse**](BlogCategoryLiteResourceArrayResponse.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)
+
+
+## indexBlogCategory
+
+> PaginatedBlogCategoryListResourceResponse indexBlogCategory(indexBlogCategoryRequest)
+
+Auto-generated: indexBlogCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BlogCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexBlogCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new BlogCategoryApi();
+
+  const body = {
+    // IndexBlogCategoryRequest (optional)
+    indexBlogCategoryRequest: ...,
+  } satisfies IndexBlogCategoryOperationRequest;
+
+  try {
+    const data = await api.indexBlogCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexBlogCategoryRequest** | [IndexBlogCategoryRequest](IndexBlogCategoryRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedBlogCategoryListResourceResponse**](PaginatedBlogCategoryListResourceResponse.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<\\ResourcePaginator<\\BlogCategoryListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showBlogCategory
+
+> BlogCategoryResource showBlogCategory(blogCategory)
+
+Auto-generated: showBlogCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BlogCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowBlogCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new BlogCategoryApi();
+
+  const body = {
+    // number | The id of the blogCategory
+    blogCategory: 56,
+  } satisfies ShowBlogCategoryRequest;
+
+  try {
+    const data = await api.showBlogCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **blogCategory** | `number` | The id of the blogCategory | [Defaults to `undefined`] |
+
+### Return type
+
+[**BlogCategoryResource**](BlogCategoryResource.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)
+
+
+## storeBlogCategory
+
+> BlogCategoryResource storeBlogCategory(storeBlogCategoryRequest)
+
+Auto-generated: storeBlogCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BlogCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreBlogCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new BlogCategoryApi();
+
+  const body = {
+    // StoreBlogCategoryRequest (optional)
+    storeBlogCategoryRequest: ...,
+  } satisfies StoreBlogCategoryOperationRequest;
+
+  try {
+    const data = await api.storeBlogCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeBlogCategoryRequest** | [StoreBlogCategoryRequest](StoreBlogCategoryRequest.md) |  | [Optional] |
+
+### Return type
+
+[**BlogCategoryResource**](BlogCategoryResource.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)
+
+
+## updateBlogCategory
+
+> BlogCategoryResource updateBlogCategory(blogCategory, updateBlogCategoryRequest)
+
+Auto-generated: updateBlogCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BlogCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateBlogCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new BlogCategoryApi();
+
+  const body = {
+    // number | The id of the blogCategory
+    blogCategory: 56,
+    // UpdateBlogCategoryRequest (optional)
+    updateBlogCategoryRequest: ...,
+  } satisfies UpdateBlogCategoryOperationRequest;
+
+  try {
+    const data = await api.updateBlogCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **blogCategory** | `number` | The id of the blogCategory | [Defaults to `undefined`] |
+| **updateBlogCategoryRequest** | [UpdateBlogCategoryRequest](UpdateBlogCategoryRequest.md) |  | [Optional] |
+
+### Return type
+
+[**BlogCategoryResource**](BlogCategoryResource.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/FrontendComponentApi.md

@@ -0,0 +1,74 @@
+# 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/GetAllBlogCategoryRequest.md

@@ -0,0 +1,44 @@
+
+# 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

@@ -0,0 +1,44 @@
+
+# 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

@@ -0,0 +1,48 @@
+
+# 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)
+
+