@digital8/lighting-illusions-ts-sdk 0.0.642 → 0.0.644

package/dist/models/index.js

@@ -18,6 +18,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable */
 __exportStar(require("./AssetFileForUploadResource"), exports);
 __exportStar(require("./AssetFileForUploadResourceArrayResponse"), exports);
+__exportStar(require("./AssetFrontendResource"), exports);
+__exportStar(require("./AssetFrontendResourceArrayResponse"), exports);
 __exportStar(require("./AssetLiteResource"), exports);
 __exportStar(require("./AssetLiteResourceArrayResponse"), exports);
 __exportStar(require("./AssetResource"), exports);
@@ -49,6 +51,10 @@ __exportStar(require("./CategoryAutomationFieldType"), exports);
 __exportStar(require("./CategoryAutomationRuleResource"), exports);
 __exportStar(require("./CategoryAutomationRuleResourceArrayResponse"), exports);
 __exportStar(require("./CouponDiscountType"), exports);
+__exportStar(require("./DefinitionListResource"), exports);
+__exportStar(require("./DefinitionListResourceArrayResponse"), exports);
+__exportStar(require("./DefinitionResource"), exports);
+__exportStar(require("./DefinitionResourceArrayResponse"), exports);
 __exportStar(require("./DescriptionResource"), exports);
 __exportStar(require("./DescriptionResourceArrayResponse"), exports);
 __exportStar(require("./DestroyAttributeValueRequest"), exports);
@@ -59,6 +65,8 @@ __exportStar(require("./DetachDocumentsProductChildSiteDetailRequest"), exports)
 __exportStar(require("./DetachProductsProductCategoryRequest"), exports);
 __exportStar(require("./DocumentFileForUploadResource"), exports);
 __exportStar(require("./DocumentFileForUploadResourceArrayResponse"), exports);
+__exportStar(require("./DocumentFrontendResource"), exports);
+__exportStar(require("./DocumentFrontendResourceArrayResponse"), exports);
 __exportStar(require("./DocumentLiteResource"), exports);
 __exportStar(require("./DocumentLiteResourceArrayResponse"), exports);
 __exportStar(require("./DocumentResource"), exports);
@@ -71,6 +79,7 @@ __exportStar(require("./ExternalApiProvider"), exports);
 __exportStar(require("./ExternalApiSyncStatus"), exports);
 __exportStar(require("./GenericResponse"), exports);
 __exportStar(require("./GetAllAttributeRequest"), exports);
+__exportStar(require("./GetAllDefinitionRequest"), exports);
 __exportStar(require("./GetAllDocumentRequest"), exports);
 __exportStar(require("./GetAllGoogleCategoryRequest"), exports);
 __exportStar(require("./GetAllOverlayTemplateRequest"), exports);
@@ -90,6 +99,7 @@ __exportStar(require("./GlobalSearchResponseResourceArrayResponse"), exports);
 __exportStar(require("./GoogleCategoryResource"), exports);
 __exportStar(require("./GoogleCategoryResourceArrayResponse"), exports);
 __exportStar(require("./IndexAttributeRequest"), exports);
+__exportStar(require("./IndexDefinitionRequest"), exports);
 __exportStar(require("./IndexDocumentRequest"), exports);
 __exportStar(require("./IndexExternalApiLogRequest"), exports);
 __exportStar(require("./IndexOverlayTemplateRequest"), exports);
@@ -103,6 +113,8 @@ __exportStar(require("./IndexSupplierRequest"), exports);
 __exportStar(require("./IndexTagRequest"), exports);
 __exportStar(require("./ModelAttributeResource"), exports);
 __exportStar(require("./ModelAttributeResourceArrayResponse"), exports);
+__exportStar(require("./OverlayTemplateAssetFrontendResource"), exports);
+__exportStar(require("./OverlayTemplateAssetFrontendResourceArrayResponse"), exports);
 __exportStar(require("./OverlayTemplateAssetPosition"), exports);
 __exportStar(require("./OverlayTemplateAssetResource"), exports);
 __exportStar(require("./OverlayTemplateAssetResourceArrayResponse"), exports);
@@ -116,6 +128,8 @@ __exportStar(require("./PaginatedAttributeListResourceResponse"), exports);
 __exportStar(require("./PaginatedAttributeLiteResourceResponse"), exports);
 __exportStar(require("./PaginatedAttributeProductTypeRelationResourceResponse"), exports);
 __exportStar(require("./PaginatedAttributeResourceResponse"), exports);
+__exportStar(require("./PaginatedDefinitionListResourceResponse"), exports);
+__exportStar(require("./PaginatedDefinitionResourceResponse"), exports);
 __exportStar(require("./PaginatedDocumentResourceResponse"), exports);
 __exportStar(require("./PaginatedExternalApiLogListResourceResponse"), exports);
 __exportStar(require("./PaginatedExternalApiLogResourceResponse"), exports);
@@ -177,6 +191,8 @@ __exportStar(require("./ProductChildSiteDetailLiteResource"), exports);
 __exportStar(require("./ProductChildSiteDetailLiteResourceArrayResponse"), exports);
 __exportStar(require("./ProductChildSiteDetailResource"), exports);
 __exportStar(require("./ProductChildSiteDetailResourceArrayResponse"), exports);
+__exportStar(require("./ProductCompareResource"), exports);
+__exportStar(require("./ProductCompareResourceArrayResponse"), exports);
 __exportStar(require("./ProductListResource"), exports);
 __exportStar(require("./ProductListResourceArrayResponse"), exports);
 __exportStar(require("./ProductLiteResource"), exports);
@@ -217,6 +233,7 @@ __exportStar(require("./SiteResourceArrayResponse"), exports);
 __exportStar(require("./StoreAssetFileRequest"), exports);
 __exportStar(require("./StoreAttributeRequest"), exports);
 __exportStar(require("./StoreAttributeValueRequest"), exports);
+__exportStar(require("./StoreDefinitionRequest"), exports);
 __exportStar(require("./StoreDocumentFileRequest"), exports);
 __exportStar(require("./StoreDocumentRequest"), exports);
 __exportStar(require("./StoreOverlayTemplateAssetRequest"), exports);
@@ -252,6 +269,7 @@ __exportStar(require("./TagResourceArrayResponse"), exports);
 __exportStar(require("./TagType"), exports);
 __exportStar(require("./UpdateAttributeRequest"), exports);
 __exportStar(require("./UpdateAttributeValueRequest"), exports);
+__exportStar(require("./UpdateDefinitionRequest"), exports);
 __exportStar(require("./UpdateDocumentRequest"), exports);
 __exportStar(require("./UpdateFilterOrderAttributeRequest"), exports);
 __exportStar(require("./UpdateFilterOrderAttributeRequestValuesInner"), exports);

package/docs/AssetFrontendResource.md

@@ -0,0 +1,48 @@
+
+# AssetFrontendResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`filePath` | string
+`fileName` | string
+`altText` | string
+`index` | number
+`isThumbnail` | boolean
+`isLifestyle` | boolean
+`overlays` | object
+
+## Example
+
+```typescript
+import type { AssetFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "filePath": null,
+  "fileName": null,
+  "altText": null,
+  "index": null,
+  "isThumbnail": null,
+  "isLifestyle": null,
+  "overlays": null,
+} satisfies AssetFrontendResource
+
+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 AssetFrontendResource
+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/AssetFrontendResourceArrayResponse.md

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

@@ -0,0 +1,407 @@
+# DefinitionApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**destroyDefinition**](DefinitionApi.md#destroydefinition) | **DELETE** /admin-api/definition/{definition}/delete | Auto-generated: destroyDefinition |
+| [**getAllDefinition**](DefinitionApi.md#getalldefinitionoperation) | **POST** /admin-api/definition/all | Auto-generated: getAllDefinition |
+| [**indexDefinition**](DefinitionApi.md#indexdefinitionoperation) | **POST** /admin-api/definition/list | Auto-generated: indexDefinition |
+| [**showDefinition**](DefinitionApi.md#showdefinition) | **GET** /admin-api/definition/{definition} | Auto-generated: showDefinition |
+| [**storeDefinition**](DefinitionApi.md#storedefinitionoperation) | **POST** /admin-api/definition/create | Auto-generated: storeDefinition |
+| [**updateDefinition**](DefinitionApi.md#updatedefinitionoperation) | **PUT** /admin-api/definition/{definition}/update | Auto-generated: updateDefinition |
+
+
+
+## destroyDefinition
+
+> GenericResponse destroyDefinition(definition)
+
+Auto-generated: destroyDefinition
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefinitionApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyDefinitionRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new DefinitionApi();
+
+  const body = {
+    // number | The id of the definition
+    definition: 56,
+  } satisfies DestroyDefinitionRequest;
+
+  try {
+    const data = await api.destroyDefinition(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **definition** | `number` | The id of the definition | [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)
+
+
+## getAllDefinition
+
+> DefinitionListResourceArrayResponse getAllDefinition(getAllDefinitionRequest)
+
+Auto-generated: getAllDefinition
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefinitionApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllDefinitionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new DefinitionApi();
+
+  const body = {
+    // GetAllDefinitionRequest (optional)
+    getAllDefinitionRequest: ...,
+  } satisfies GetAllDefinitionOperationRequest;
+
+  try {
+    const data = await api.getAllDefinition(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getAllDefinitionRequest** | [GetAllDefinitionRequest](GetAllDefinitionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**DefinitionListResourceArrayResponse**](DefinitionListResourceArrayResponse.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)
+
+
+## indexDefinition
+
+> PaginatedDefinitionListResourceResponse indexDefinition(indexDefinitionRequest)
+
+Auto-generated: indexDefinition
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefinitionApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexDefinitionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new DefinitionApi();
+
+  const body = {
+    // IndexDefinitionRequest (optional)
+    indexDefinitionRequest: ...,
+  } satisfies IndexDefinitionOperationRequest;
+
+  try {
+    const data = await api.indexDefinition(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexDefinitionRequest** | [IndexDefinitionRequest](IndexDefinitionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedDefinitionListResourceResponse**](PaginatedDefinitionListResourceResponse.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<\\DefinitionListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showDefinition
+
+> DefinitionResource showDefinition(definition)
+
+Auto-generated: showDefinition
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefinitionApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowDefinitionRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new DefinitionApi();
+
+  const body = {
+    // number | The id of the definition
+    definition: 56,
+  } satisfies ShowDefinitionRequest;
+
+  try {
+    const data = await api.showDefinition(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **definition** | `number` | The id of the definition | [Defaults to `undefined`] |
+
+### Return type
+
+[**DefinitionResource**](DefinitionResource.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)
+
+
+## storeDefinition
+
+> DefinitionResource storeDefinition(storeDefinitionRequest)
+
+Auto-generated: storeDefinition
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefinitionApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreDefinitionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new DefinitionApi();
+
+  const body = {
+    // StoreDefinitionRequest (optional)
+    storeDefinitionRequest: ...,
+  } satisfies StoreDefinitionOperationRequest;
+
+  try {
+    const data = await api.storeDefinition(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeDefinitionRequest** | [StoreDefinitionRequest](StoreDefinitionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**DefinitionResource**](DefinitionResource.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)
+
+
+## updateDefinition
+
+> DefinitionResource updateDefinition(definition, updateDefinitionRequest)
+
+Auto-generated: updateDefinition
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefinitionApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateDefinitionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new DefinitionApi();
+
+  const body = {
+    // number | The id of the definition
+    definition: 56,
+    // UpdateDefinitionRequest (optional)
+    updateDefinitionRequest: ...,
+  } satisfies UpdateDefinitionOperationRequest;
+
+  try {
+    const data = await api.updateDefinition(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **definition** | `number` | The id of the definition | [Defaults to `undefined`] |
+| **updateDefinitionRequest** | [UpdateDefinitionRequest](UpdateDefinitionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**DefinitionResource**](DefinitionResource.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/DefinitionListResource.md

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

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

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