@digital8/lighting-illusions-ts-sdk 0.0.486 → 0.0.488

package/docs/DocumentApi.md

@@ -5,14 +5,12 @@ All URIs are relative to *http://localhost/api*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**attachDocumentablesDocument**](DocumentApi.md#attachdocumentablesdocumentoperation) | **POST** /admin-api/document/{document}/attach-documentables | Auto-generated: attachDocumentablesDocument |
-| [**destroyDocument**](DocumentApi.md#destroydocument) | **DELETE** /admin-api/document/{document}/delete | Auto-generated: destroyDocument |
+| [**destroyDocument**](DocumentApi.md#destroydocument) | **DELETE** /admin-api/document/{document} | Auto-generated: destroyDocument |
 | [**detachDocumentablesDocument**](DocumentApi.md#detachdocumentablesdocumentoperation) | **POST** /admin-api/document/{document}/detach-documentables | Auto-generated: detachDocumentablesDocument |
 | [**getAllDocument**](DocumentApi.md#getalldocumentoperation) | **POST** /admin-api/document/all | Auto-generated: getAllDocument |
 | [**indexDocument**](DocumentApi.md#indexdocumentoperation) | **POST** /admin-api/document/list | Auto-generated: indexDocument |
-| [**showDocument**](DocumentApi.md#showdocument) | **GET** /admin-api/document/{document} | Auto-generated: showDocument |
-| [**storeDocument**](DocumentApi.md#storedocumentoperation) | **POST** /admin-api/document/create | Auto-generated: storeDocument |
+| [**storeDocument**](DocumentApi.md#storedocumentoperation) | **POST** /admin-api/document | Auto-generated: storeDocument |
 | [**storeDocumentFile**](DocumentApi.md#storedocumentfileoperation) | **POST** /admin-api/document/files | Auto-generated: storeDocumentFile |
-| [**updateDocument**](DocumentApi.md#updatedocumentoperation) | **PUT** /admin-api/document/{document}/update | Auto-generated: updateDocument |
 
 
 
@@ -347,71 +345,6 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## showDocument
-
-> DocumentResource showDocument(document)
-
-Auto-generated: showDocument
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DocumentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowDocumentRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DocumentApi();
-
-  const body = {
-    // number | The id of the document
-    document: 56,
-  } satisfies ShowDocumentRequest;
-
-  try {
-    const data = await api.showDocument(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **document** | `number` | The id of the document | [Defaults to `undefined`] |
-
-### Return type
-
-[**DocumentResource**](DocumentResource.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)
-
-
 ## storeDocument
 
 > DocumentResource storeDocument(storeDocumentRequest)
@@ -541,71 +474,3 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
-
-## updateDocument
-
-> DocumentResource updateDocument(document, updateDocumentRequest)
-
-Auto-generated: updateDocument
-
-### Example
-
-```ts
-import {
-  Configuration,
-  DocumentApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateDocumentOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new DocumentApi();
-
-  const body = {
-    // number | The id of the document
-    document: 56,
-    // UpdateDocumentRequest (optional)
-    updateDocumentRequest: ...,
-  } satisfies UpdateDocumentOperationRequest;
-
-  try {
-    const data = await api.updateDocument(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **document** | `number` | The id of the document | [Defaults to `undefined`] |
-| **updateDocumentRequest** | [UpdateDocumentRequest](UpdateDocumentRequest.md) |  | [Optional] |
-
-### Return type
-
-[**DocumentResource**](DocumentResource.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/GetAllDocumentRequest.md

@@ -9,9 +9,6 @@ Name | Type
 `search` | string
 `sortBy` | string
 `sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
 
 ## Example
 
@@ -23,9 +20,6 @@ const example = {
   "search": null,
   "sortBy": null,
   "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
 } satisfies GetAllDocumentRequest
 
 console.log(example)

package/docs/IndexDocumentRequest.md

@@ -11,9 +11,6 @@ Name | Type
 `sortDirection` | string
 `perPage` | number
 `page` | number
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
 
 ## Example
 
@@ -27,9 +24,6 @@ const example = {
   "sortDirection": null,
   "perPage": null,
   "page": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
 } satisfies IndexDocumentRequest
 
 console.log(example)

package/docs/IndexExternalApiLogRequest.md

@@ -17,6 +17,7 @@ Name | Type
 `externalApiLoggableType` | Array<string>
 `externalApiLoggableId` | Array<string>
 `siteId` | Array<string>
+`productChildId` | Array<string>
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
@@ -39,6 +40,7 @@ const example = {
   "externalApiLoggableType": null,
   "externalApiLoggableId": null,
   "siteId": null,
+  "productChildId": null,
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,

package/docs/PaginatedProductSearchResultResourceResponse.md

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

@@ -0,0 +1,40 @@
+
+# ProductAggregationResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`attributes` | Array<object>
+`priceRanges` | Array<object>
+`brands` | Array<object>
+`ratings` | Array<object>
+
+## Example
+
+```typescript
+import type { ProductAggregationResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "attributes": null,
+  "priceRanges": null,
+  "brands": null,
+  "ratings": null,
+} satisfies ProductAggregationResource
+
+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 ProductAggregationResource
+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/ProductAggregationResourceArrayResponse.md

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

@@ -16,7 +16,8 @@ Name | Type
 `salePrice` | number
 `isDisabled` | boolean
 `seo` | [SEOResource](SEOResource.md)
-`documents` | object
+`omnisendId` | string
+`omnisendSyncStatus` | string
 
 ## Example
 
@@ -35,7 +36,8 @@ const example = {
   "salePrice": null,
   "isDisabled": null,
   "seo": null,
-  "documents": null,
+  "omnisendId": null,
+  "omnisendSyncStatus": null,
 } satisfies ProductChildSiteDetailResource
 
 console.log(example)

package/docs/{UpdateDocumentRequest.md → ProductRating.md}

@@ -1,26 +1,20 @@
 
-# UpdateDocumentRequest
+# ProductRating
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`name` | string
-`documentFileId` | string
-`siteIds` | Array<string>
 
 ## Example
 
 ```typescript
-import type { UpdateDocumentRequest } from '@digital8/lighting-illusions-ts-sdk'
+import type { ProductRating } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "name": null,
-  "documentFileId": null,
-  "siteIds": null,
-} satisfies UpdateDocumentRequest
+} satisfies ProductRating
 
 console.log(example)
 
@@ -29,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as UpdateDocumentRequest
+const exampleParsed = JSON.parse(exampleJSON) as ProductRating
 console.log(exampleParsed)
 ```
 

package/docs/ProductSearchResponseResource.md

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

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

@@ -0,0 +1,40 @@
+
+# ProductSearchResponseResourceMeta
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`currentPage` | number
+`perPage` | number
+`total` | number
+`lastPage` | number
+
+## Example
+
+```typescript
+import type { ProductSearchResponseResourceMeta } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "currentPage": 1,
+  "perPage": 24,
+  "total": 1500,
+  "lastPage": 63,
+} satisfies ProductSearchResponseResourceMeta
+
+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 ProductSearchResponseResourceMeta
+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/ProductSearchResponseResourcePriceInfo.md

@@ -0,0 +1,40 @@
+
+# ProductSearchResponseResourcePriceInfo
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`minPrice` | number
+`maxPrice` | number
+`lowestPrice` | number
+`highestPrice` | number
+
+## Example
+
+```typescript
+import type { ProductSearchResponseResourcePriceInfo } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "minPrice": 49.99,
+  "maxPrice": 899.99,
+  "lowestPrice": 29.99,
+  "highestPrice": 1299.99,
+} satisfies ProductSearchResponseResourcePriceInfo
+
+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 ProductSearchResponseResourcePriceInfo
+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/ProductSearchResultResource.md

@@ -0,0 +1,62 @@
+
+# ProductSearchResultResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`sku` | string
+`model` | string
+`name` | string
+`slug` | string
+`price` | number
+`salePrice` | number
+`thumbnail` | string
+`averageRating` | string
+`labelDetails` | Array<number>
+`categories` | Array<object>
+`supplierName` | string
+`supplierId` | number
+`availability` | string
+`wishlisted` | boolean
+
+## Example
+
+```typescript
+import type { ProductSearchResultResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "sku": null,
+  "model": null,
+  "name": null,
+  "slug": null,
+  "price": null,
+  "salePrice": null,
+  "thumbnail": null,
+  "averageRating": null,
+  "labelDetails": null,
+  "categories": null,
+  "supplierName": null,
+  "supplierId": null,
+  "availability": null,
+  "wishlisted": null,
+} satisfies ProductSearchResultResource
+
+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 ProductSearchResultResource
+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/ProductSearchResultResourceArrayResponse.md

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

@@ -0,0 +1,32 @@
+
+# ProductSortBy
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ProductSortBy } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ProductSortBy
+
+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 ProductSortBy
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digital8/lighting-illusions-ts-sdk",
-  "version": "0.0.486",
+  "version": "0.0.488",
   "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
   "author": "OpenAPI-Generator",
   "repository": {