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

package/dist/models/index.d.ts

@@ -124,10 +124,8 @@ export * from './ProductListResource';
 export * from './ProductListResourceArrayResponse';
 export * from './ProductLiteResource';
 export * from './ProductLiteResourceArrayResponse';
-export * from './ProductRating';
 export * from './ProductResource';
 export * from './ProductResourceArrayResponse';
-export * from './ProductSortBy';
 export * from './ProductTypeListResource';
 export * from './ProductTypeListResourceArrayResponse';
 export * from './ProductTypeLiteResource';
@@ -185,6 +183,7 @@ export * from './TagResourceArrayResponse';
 export * from './TagType';
 export * from './UpdateAttributeRequest';
 export * from './UpdateAttributeValueRequest';
+export * from './UpdateDocumentRequest';
 export * from './UpdateFilterOrderAttributeRequest';
 export * from './UpdateFilterOrderAttributeRequestValuesInner';
 export * from './UpdateModelAttributeRequest';

package/dist/models/index.js

@@ -142,10 +142,8 @@ __exportStar(require("./ProductListResource"), exports);
 __exportStar(require("./ProductListResourceArrayResponse"), exports);
 __exportStar(require("./ProductLiteResource"), exports);
 __exportStar(require("./ProductLiteResourceArrayResponse"), exports);
-__exportStar(require("./ProductRating"), exports);
 __exportStar(require("./ProductResource"), exports);
 __exportStar(require("./ProductResourceArrayResponse"), exports);
-__exportStar(require("./ProductSortBy"), exports);
 __exportStar(require("./ProductTypeListResource"), exports);
 __exportStar(require("./ProductTypeListResourceArrayResponse"), exports);
 __exportStar(require("./ProductTypeLiteResource"), exports);
@@ -203,6 +201,7 @@ __exportStar(require("./TagResourceArrayResponse"), exports);
 __exportStar(require("./TagType"), exports);
 __exportStar(require("./UpdateAttributeRequest"), exports);
 __exportStar(require("./UpdateAttributeValueRequest"), exports);
+__exportStar(require("./UpdateDocumentRequest"), exports);
 __exportStar(require("./UpdateFilterOrderAttributeRequest"), exports);
 __exportStar(require("./UpdateFilterOrderAttributeRequestValuesInner"), exports);
 __exportStar(require("./UpdateModelAttributeRequest"), exports);

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/{ProductRating.md → UpdateDocumentRequest.md}

@@ -1,20 +1,26 @@
 
-# ProductRating
+# UpdateDocumentRequest
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`name` | string
+`documentFileId` | string
+`siteIds` | Array<string>
 
 ## Example
 
 ```typescript
-import type { ProductRating } 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 ProductRating
+  "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 ProductRating
+const exampleParsed = JSON.parse(exampleJSON) as UpdateDocumentRequest
 console.log(exampleParsed)
 ```
 

package/package.json

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

package/src/apis/DocumentApi.ts

@@ -26,6 +26,7 @@ import type {
   PaginatedDocumentResourceResponse,
   StoreDocumentFileRequest,
   StoreDocumentRequest,
+  UpdateDocumentRequest,
 } from '../models/index';
 import {
     AttachDocumentablesDocumentRequestFromJSON,
@@ -50,6 +51,8 @@ import {
     StoreDocumentFileRequestToJSON,
     StoreDocumentRequestFromJSON,
     StoreDocumentRequestToJSON,
+    UpdateDocumentRequestFromJSON,
+    UpdateDocumentRequestToJSON,
 } from '../models/index';
 
 export interface AttachDocumentablesDocumentOperationRequest {
@@ -74,6 +77,10 @@ export interface IndexDocumentOperationRequest {
     indexDocumentRequest?: IndexDocumentRequest;
 }
 
+export interface ShowDocumentRequest {
+    document: number;
+}
+
 export interface StoreDocumentOperationRequest {
     storeDocumentRequest?: StoreDocumentRequest;
 }
@@ -82,6 +89,11 @@ export interface StoreDocumentFileOperationRequest {
     storeDocumentFileRequest?: StoreDocumentFileRequest;
 }
 
+export interface UpdateDocumentOperationRequest {
+    document: number;
+    updateDocumentRequest?: UpdateDocumentRequest;
+}
+
 /**
  * 
  */
@@ -143,7 +155,7 @@ export class DocumentApi extends runtime.BaseAPI {
         const headerParameters: runtime.HTTPHeaders = {};
 
 
-        let urlPath = `/admin-api/document/{document}`;
+        let urlPath = `/admin-api/document/{document}/delete`;
         urlPath = urlPath.replace(`{${"document"}}`, encodeURIComponent(String(requestParameters['document'])));
 
         const response = await this.request({
@@ -268,6 +280,43 @@ export class DocumentApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: showDocument
+     */
+    async showDocumentRaw(requestParameters: ShowDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResource>> {
+        if (requestParameters['document'] == null) {
+            throw new runtime.RequiredError(
+                'document',
+                'Required parameter "document" was null or undefined when calling showDocument().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/admin-api/document/{document}`;
+        urlPath = urlPath.replace(`{${"document"}}`, encodeURIComponent(String(requestParameters['document'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: showDocument
+     */
+    async showDocument(requestParameters: ShowDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResource> {
+        const response = await this.showDocumentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: storeDocument
      */
@@ -279,7 +328,7 @@ export class DocumentApi extends runtime.BaseAPI {
         headerParameters['Content-Type'] = 'application/json';
 
 
-        let urlPath = `/admin-api/document`;
+        let urlPath = `/admin-api/document/create`;
 
         const response = await this.request({
             path: urlPath,
@@ -332,4 +381,44 @@ export class DocumentApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: updateDocument
+     */
+    async updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResource>> {
+        if (requestParameters['document'] == null) {
+            throw new runtime.RequiredError(
+                'document',
+                'Required parameter "document" was null or undefined when calling updateDocument().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/document/{document}/update`;
+        urlPath = urlPath.replace(`{${"document"}}`, encodeURIComponent(String(requestParameters['document'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateDocumentRequestToJSON(requestParameters['updateDocumentRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: updateDocument
+     */
+    async updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResource> {
+        const response = await this.updateDocumentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }

package/src/models/GetAllDocumentRequest.ts

@@ -37,6 +37,24 @@ export interface GetAllDocumentRequest {
      * @memberof GetAllDocumentRequest
      */
     sortDirection?: GetAllDocumentRequestSortDirectionEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetAllDocumentRequest
+     */
+    relatedId?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetAllDocumentRequest
+     */
+    relatedType?: GetAllDocumentRequestRelatedTypeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetAllDocumentRequest
+     */
+    includesRelations?: boolean;
 }
 
 
@@ -60,6 +78,15 @@ export const GetAllDocumentRequestSortDirectionEnum = {
 } as const;
 export type GetAllDocumentRequestSortDirectionEnum = typeof GetAllDocumentRequestSortDirectionEnum[keyof typeof GetAllDocumentRequestSortDirectionEnum];
 
+/**
+ * @export
+ */
+export const GetAllDocumentRequestRelatedTypeEnum = {
+    ProductChild: 'productChild',
+    ProductRangeSite: 'productRangeSite'
+} as const;
+export type GetAllDocumentRequestRelatedTypeEnum = typeof GetAllDocumentRequestRelatedTypeEnum[keyof typeof GetAllDocumentRequestRelatedTypeEnum];
+
 
 /**
  * Check if a given object implements the GetAllDocumentRequest interface.
@@ -81,6 +108,9 @@ export function GetAllDocumentRequestFromJSONTyped(json: any, ignoreDiscriminato
         'search': json['search'] == null ? undefined : json['search'],
         'sortBy': json['sortBy'] == null ? undefined : json['sortBy'],
         'sortDirection': json['sortDirection'] == null ? undefined : json['sortDirection'],
+        'relatedId': json['related_id'] == null ? undefined : json['related_id'],
+        'relatedType': json['related_type'] == null ? undefined : json['related_type'],
+        'includesRelations': json['includes_relations'] == null ? undefined : json['includes_relations'],
     };
 }
 
@@ -98,6 +128,9 @@ export function GetAllDocumentRequestToJSONTyped(value?: GetAllDocumentRequest |
         'search': value['search'],
         'sortBy': value['sortBy'],
         'sortDirection': value['sortDirection'],
+        'related_id': value['relatedId'],
+        'related_type': value['relatedType'],
+        'includes_relations': value['includesRelations'],
     };
 }
 

package/src/models/GetAllProductChildRequest.ts

@@ -123,7 +123,8 @@ export type GetAllProductChildRequestSortDirectionEnum = typeof GetAllProductChi
 export const GetAllProductChildRequestRelatedTypeEnum = {
     OverlayTemplate: 'overlayTemplate',
     Supplier: 'supplier',
-    Tag: 'tag'
+    Tag: 'tag',
+    Document: 'document'
 } as const;
 export type GetAllProductChildRequestRelatedTypeEnum = typeof GetAllProductChildRequestRelatedTypeEnum[keyof typeof GetAllProductChildRequestRelatedTypeEnum];
 

package/src/models/IndexDocumentRequest.ts

@@ -49,6 +49,24 @@ export interface IndexDocumentRequest {
      * @memberof IndexDocumentRequest
      */
     page?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof IndexDocumentRequest
+     */
+    relatedId?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof IndexDocumentRequest
+     */
+    relatedType?: IndexDocumentRequestRelatedTypeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IndexDocumentRequest
+     */
+    includesRelations?: boolean;
 }
 
 
@@ -72,6 +90,15 @@ export const IndexDocumentRequestSortDirectionEnum = {
 } as const;
 export type IndexDocumentRequestSortDirectionEnum = typeof IndexDocumentRequestSortDirectionEnum[keyof typeof IndexDocumentRequestSortDirectionEnum];
 
+/**
+ * @export
+ */
+export const IndexDocumentRequestRelatedTypeEnum = {
+    ProductChild: 'productChild',
+    ProductRangeSite: 'productRangeSite'
+} as const;
+export type IndexDocumentRequestRelatedTypeEnum = typeof IndexDocumentRequestRelatedTypeEnum[keyof typeof IndexDocumentRequestRelatedTypeEnum];
+
 
 /**
  * Check if a given object implements the IndexDocumentRequest interface.
@@ -95,6 +122,9 @@ export function IndexDocumentRequestFromJSONTyped(json: any, ignoreDiscriminator
         'sortDirection': json['sortDirection'] == null ? undefined : json['sortDirection'],
         'perPage': json['per_page'] == null ? undefined : json['per_page'],
         'page': json['page'] == null ? undefined : json['page'],
+        'relatedId': json['related_id'] == null ? undefined : json['related_id'],
+        'relatedType': json['related_type'] == null ? undefined : json['related_type'],
+        'includesRelations': json['includes_relations'] == null ? undefined : json['includes_relations'],
     };
 }
 
@@ -114,6 +144,9 @@ export function IndexDocumentRequestToJSONTyped(value?: IndexDocumentRequest | n
         'sortDirection': value['sortDirection'],
         'per_page': value['perPage'],
         'page': value['page'],
+        'related_id': value['relatedId'],
+        'related_type': value['relatedType'],
+        'includes_relations': value['includesRelations'],
     };
 }
 

package/src/models/IndexExternalApiLogRequest.ts

@@ -85,12 +85,6 @@ export interface IndexExternalApiLogRequest {
      * @memberof IndexExternalApiLogRequest
      */
     siteId?: Array<string>;
-    /**
-     * 
-     * @type {Array<string>}
-     * @memberof IndexExternalApiLogRequest
-     */
-    productChildId?: Array<string>;
     /**
      * 
      * @type {number}
@@ -164,7 +158,6 @@ export function IndexExternalApiLogRequestFromJSONTyped(json: any, ignoreDiscrim
         'externalApiLoggableType': json['external_api_loggable_type'] == null ? undefined : json['external_api_loggable_type'],
         'externalApiLoggableId': json['external_api_loggable_id'] == null ? undefined : json['external_api_loggable_id'],
         'siteId': json['site_id'] == null ? undefined : json['site_id'],
-        'productChildId': json['product_child_id'] == null ? undefined : json['product_child_id'],
         'relatedId': json['related_id'] == null ? undefined : json['related_id'],
         'relatedType': json['related_type'] == null ? undefined : json['related_type'],
         'includesRelations': json['includes_relations'] == null ? undefined : json['includes_relations'],
@@ -193,7 +186,6 @@ export function IndexExternalApiLogRequestToJSONTyped(value?: IndexExternalApiLo
         'external_api_loggable_type': value['externalApiLoggableType'],
         'external_api_loggable_id': value['externalApiLoggableId'],
         'site_id': value['siteId'],
-        'product_child_id': value['productChildId'],
         'related_id': value['relatedId'],
         'related_type': value['relatedType'],
         'includes_relations': value['includesRelations'],

package/src/models/IndexProductChildRequest.ts

@@ -136,6 +136,7 @@ export const IndexProductChildRequestRelatedTypeEnum = {
     OverlayTemplate: 'overlayTemplate',
     Supplier: 'supplier',
     Tag: 'tag',
+    Document: 'document',
     Attribute: 'attribute',
     AttributeValue: 'attributeValue'
 } as const;