@digital8/lighting-illusions-ts-sdk 0.0.1747 → 0.0.1749

package/docs/PageComponentApi.md

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

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

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

@@ -0,0 +1,42 @@
+
+# PageComponentRelationResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`pageRelatableType` | string
+`pageRelatableId` | number
+`order` | number
+`relatable` | [ProductChildListResource](ProductChildListResource.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,
+  "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

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

@@ -0,0 +1,52 @@
+
+# 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` | object
+
+## 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,
+} 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

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

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

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

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