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

package/docs/DocumentApi.md

@@ -5,12 +5,14 @@ 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} | Auto-generated: destroyDocument |
+| [**destroyDocument**](DocumentApi.md#destroydocument) | **DELETE** /admin-api/document/{document}/delete | 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 |
-| [**storeDocument**](DocumentApi.md#storedocumentoperation) | **POST** /admin-api/document | Auto-generated: storeDocument |
+| [**showDocument**](DocumentApi.md#showdocument) | **GET** /admin-api/document/{document} | Auto-generated: showDocument |
+| [**storeDocument**](DocumentApi.md#storedocumentoperation) | **POST** /admin-api/document/create | 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 |
 
 
 
@@ -345,6 +347,71 @@ 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)
@@ -474,3 +541,71 @@ 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,6 +9,9 @@ Name | Type
 `search` | string
 `sortBy` | string
 `sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
 
 ## Example
 
@@ -20,6 +23,9 @@ const example = {
   "search": null,
   "sortBy": null,
   "sortDirection": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
 } satisfies GetAllDocumentRequest
 
 console.log(example)

package/docs/IndexDocumentRequest.md

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

package/docs/IndexExternalApiLogRequest.md

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

package/docs/ProductChildSiteDetailResource.md

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

package/docs/SEOResource.md

@@ -7,12 +7,9 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`title` | string
-`description` | string
-`keywords` | string
+`seoTitle` | string
+`seoDescription` | string
 `siteId` | number
-`footerDescription` | string
-`pageDescription` | string
 
 ## Example
 
@@ -22,12 +19,9 @@ import type { SEOResource } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "title": null,
-  "description": null,
-  "keywords": null,
+  "seoTitle": null,
+  "seoDescription": null,
   "siteId": null,
-  "footerDescription": null,
-  "pageDescription": null,
 } satisfies SEOResource
 
 console.log(example)

package/docs/StoreProductChildRequestSitesInner.md

@@ -14,10 +14,8 @@ Name | Type
 `salePrice` | number
 `slug` | string
 `documents` | Array<number>
-`title` | string
-`keywords` | string
-`footerDescription` | string
-`pageDescription` | string
+`seoTitle` | string
+`seoDescription` | string
 
 ## Example
 
@@ -34,10 +32,8 @@ const example = {
   "salePrice": null,
   "slug": null,
   "documents": null,
-  "title": null,
-  "keywords": null,
-  "footerDescription": null,
-  "pageDescription": null,
+  "seoTitle": null,
+  "seoDescription": null,
 } satisfies StoreProductChildRequestSitesInner
 
 console.log(example)

package/docs/StoreSupplierRequest.md

@@ -13,6 +13,7 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `assetFileId` | number
+`descriptions` | [Array<StoreSupplierRequestDescriptionsInner>](StoreSupplierRequestDescriptionsInner.md)
 
 ## Example
 
@@ -28,6 +29,7 @@ const example = {
   "altText": null,
   "mimeType": null,
   "assetFileId": null,
+  "descriptions": null,
 } satisfies StoreSupplierRequest
 
 console.log(example)

package/docs/{ProductSearchResponseResourceMeta.md → StoreSupplierRequestDescriptionsInner.md}

@@ -1,28 +1,26 @@
 
-# ProductSearchResponseResourceMeta
+# StoreSupplierRequestDescriptionsInner
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`currentPage` | number
-`perPage` | number
-`total` | number
-`lastPage` | number
+`headerDescription` | string
+`footerDescription` | string
+`siteId` | number
 
 ## Example
 
 ```typescript
-import type { ProductSearchResponseResourceMeta } from '@digital8/lighting-illusions-ts-sdk'
+import type { StoreSupplierRequestDescriptionsInner } 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
+  "headerDescription": null,
+  "footerDescription": null,
+  "siteId": null,
+} satisfies StoreSupplierRequestDescriptionsInner
 
 console.log(example)
 
@@ -31,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ProductSearchResponseResourceMeta
+const exampleParsed = JSON.parse(exampleJSON) as StoreSupplierRequestDescriptionsInner
 console.log(exampleParsed)
 ```
 

package/docs/StoreSupplierRequestSeoInner.md

@@ -6,11 +6,8 @@
 
 Name | Type
 ------------ | -------------
-`title` | string
-`description` | string
-`keywords` | string
-`footerDescription` | string
-`pageDescription` | string
+`seoTitle` | string
+`seoDescription` | string
 `siteId` | number
 
 ## Example
@@ -20,11 +17,8 @@ import type { StoreSupplierRequestSeoInner } from '@digital8/lighting-illusions-
 
 // TODO: Update the object below with actual values
 const example = {
-  "title": null,
-  "description": null,
-  "keywords": null,
-  "footerDescription": null,
-  "pageDescription": null,
+  "seoTitle": null,
+  "seoDescription": null,
   "siteId": null,
 } satisfies StoreSupplierRequestSeoInner
 

package/docs/StoreTagRequest.md

@@ -10,11 +10,10 @@ Name | Type
 `slug` | string
 `siteId` | number
 `type` | string
-`title` | string
-`description` | string
-`keywords` | string
+`seoTitle` | string
+`seoDescription` | string
+`headerDescription` | string
 `footerDescription` | string
-`pageDescription` | string
 
 ## Example
 
@@ -27,11 +26,10 @@ const example = {
   "slug": null,
   "siteId": null,
   "type": null,
-  "title": null,
-  "description": null,
-  "keywords": null,
+  "seoTitle": null,
+  "seoDescription": null,
+  "headerDescription": null,
   "footerDescription": null,
-  "pageDescription": null,
 } satisfies StoreTagRequest
 
 console.log(example)

package/docs/SupplierFrontendResource.md

@@ -12,6 +12,7 @@ Name | Type
 `thumbnail` | [AssetResource](AssetResource.md)
 `supplierEta` | number
 `seo` | [SEOResource](SEOResource.md)
+`descriptions` | [Array<DescriptionResource>](DescriptionResource.md)
 
 ## Example
 
@@ -26,6 +27,7 @@ const example = {
   "thumbnail": null,
   "supplierEta": null,
   "seo": null,
+  "descriptions": null,
 } satisfies SupplierFrontendResource
 
 console.log(example)

package/docs/SupplierResource.md

@@ -12,6 +12,7 @@ Name | Type
 `thumbnail` | [AssetResource](AssetResource.md)
 `supplierEta` | number
 `seo` | [Array<SEOResource>](SEOResource.md)
+`descriptions` | [Array<DescriptionResource>](DescriptionResource.md)
 
 ## Example
 
@@ -26,6 +27,7 @@ const example = {
   "thumbnail": null,
   "supplierEta": null,
   "seo": null,
+  "descriptions": null,
 } satisfies SupplierResource
 
 console.log(example)

package/docs/TagResource.md

@@ -12,6 +12,7 @@ Name | Type
 `type` | string
 `site` | [SiteLiteResource](SiteLiteResource.md)
 `seo` | [SEOResource](SEOResource.md)
+`description` | [DescriptionResource](DescriptionResource.md)
 
 ## Example
 
@@ -26,6 +27,7 @@ const example = {
   "type": null,
   "site": null,
   "seo": null,
+  "description": null,
 } satisfies TagResource
 
 console.log(example)

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

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

package/docs/UpdateSupplierRequest.md

@@ -13,6 +13,7 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `assetFileId` | number
+`descriptions` | [Array<StoreSupplierRequestDescriptionsInner>](StoreSupplierRequestDescriptionsInner.md)
 
 ## Example
 
@@ -28,6 +29,7 @@ const example = {
   "altText": null,
   "mimeType": null,
   "assetFileId": null,
+  "descriptions": null,
 } satisfies UpdateSupplierRequest
 
 console.log(example)

package/docs/UpdateTagRequest.md

@@ -9,11 +9,10 @@ Name | Type
 `name` | string
 `slug` | string
 `type` | string
-`title` | string
-`description` | string
-`keywords` | string
+`seoTitle` | string
+`seoDescription` | string
+`headerDescription` | string
 `footerDescription` | string
-`pageDescription` | string
 
 ## Example
 
@@ -25,11 +24,10 @@ const example = {
   "name": null,
   "slug": null,
   "type": null,
-  "title": null,
-  "description": null,
-  "keywords": null,
+  "seoTitle": null,
+  "seoDescription": null,
+  "headerDescription": null,
   "footerDescription": null,
-  "pageDescription": null,
 } satisfies UpdateTagRequest
 
 console.log(example)

package/package.json

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