@digital8/lighting-illusions-ts-sdk 0.0.531 → 0.0.532

package/docs/ProductCategoryLiteResource.md

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

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

@@ -0,0 +1,58 @@
+
+# ProductCategoryResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`siteId` | number
+`name` | string
+`slug` | string
+`parentId` | string
+`isDisabled` | boolean
+`isAutomated` | boolean
+`index` | number
+`automatedConditionType` | string
+`thumbnail` | [AssetResource](AssetResource.md)
+`automationRules` | object
+`parent` | [ProductCategoryLiteResource](ProductCategoryLiteResource.md)
+`site` | [SiteLiteResource](SiteLiteResource.md)
+
+## Example
+
+```typescript
+import type { ProductCategoryResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "siteId": null,
+  "name": null,
+  "slug": null,
+  "parentId": null,
+  "isDisabled": null,
+  "isAutomated": null,
+  "index": null,
+  "automatedConditionType": null,
+  "thumbnail": null,
+  "automationRules": null,
+  "parent": null,
+  "site": null,
+} satisfies ProductCategoryResource
+
+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 ProductCategoryResource
+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/ProductCategoryResourceArrayResponse.md

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

@@ -0,0 +1,58 @@
+
+# StoreProductCategoryRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`siteId` | string
+`name` | string
+`slug` | string
+`parentId` | string
+`isDisabled` | boolean
+`hideFromFrontend` | boolean
+`isAutomated` | boolean
+`index` | number
+`automatedConditionType` | string
+`automationRules` | [Array<StoreProductCategoryRequestAutomationRulesInner>](StoreProductCategoryRequestAutomationRulesInner.md)
+`altText` | string
+`mimeType` | string
+`fileId` | number
+
+## Example
+
+```typescript
+import type { StoreProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "siteId": null,
+  "name": null,
+  "slug": null,
+  "parentId": null,
+  "isDisabled": null,
+  "hideFromFrontend": null,
+  "isAutomated": null,
+  "index": null,
+  "automatedConditionType": null,
+  "automationRules": null,
+  "altText": null,
+  "mimeType": null,
+  "fileId": null,
+} satisfies StoreProductCategoryRequest
+
+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 StoreProductCategoryRequest
+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/StoreProductCategoryRequestAutomationRulesInner.md

@@ -0,0 +1,44 @@
+
+# StoreProductCategoryRequestAutomationRulesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fieldType` | string
+`comparisonType` | string
+`groupId` | number
+`relatedId` | string
+`value` | string
+`valueId` | number
+
+## Example
+
+```typescript
+import type { StoreProductCategoryRequestAutomationRulesInner } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fieldType": null,
+  "comparisonType": null,
+  "groupId": null,
+  "relatedId": null,
+  "value": null,
+  "valueId": null,
+} satisfies StoreProductCategoryRequestAutomationRulesInner
+
+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 StoreProductCategoryRequestAutomationRulesInner
+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/UpdateProductCategoryRequest.md

@@ -0,0 +1,58 @@
+
+# UpdateProductCategoryRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`siteId` | string
+`name` | string
+`slug` | string
+`parentId` | string
+`isDisabled` | boolean
+`hideFromFrontend` | boolean
+`isAutomated` | boolean
+`index` | number
+`automatedConditionType` | string
+`automationRules` | [Array<StoreProductCategoryRequestAutomationRulesInner>](StoreProductCategoryRequestAutomationRulesInner.md)
+`altText` | string
+`mimeType` | string
+`fileId` | number
+
+## Example
+
+```typescript
+import type { UpdateProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "siteId": null,
+  "name": null,
+  "slug": null,
+  "parentId": null,
+  "isDisabled": null,
+  "hideFromFrontend": null,
+  "isAutomated": null,
+  "index": null,
+  "automatedConditionType": null,
+  "automationRules": null,
+  "altText": null,
+  "mimeType": null,
+  "fileId": null,
+} satisfies UpdateProductCategoryRequest
+
+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 UpdateProductCategoryRequest
+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.531",
+  "version": "0.0.532",
   "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/ProductCategoryApi.ts

@@ -0,0 +1,363 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  GenericResponse,
+  GetAllProductCategoryRequest,
+  IndexProductCategoryRequest,
+  PaginatedProductCategoryListResourceResponse,
+  ProductCategoryHierarchyResourceArrayResponse,
+  ProductCategoryLiteResourceArrayResponse,
+  ProductCategoryResource,
+  StoreProductCategoryRequest,
+  UpdateProductCategoryRequest,
+} from '../models/index';
+import {
+    GenericResponseFromJSON,
+    GenericResponseToJSON,
+    GetAllProductCategoryRequestFromJSON,
+    GetAllProductCategoryRequestToJSON,
+    IndexProductCategoryRequestFromJSON,
+    IndexProductCategoryRequestToJSON,
+    PaginatedProductCategoryListResourceResponseFromJSON,
+    PaginatedProductCategoryListResourceResponseToJSON,
+    ProductCategoryHierarchyResourceArrayResponseFromJSON,
+    ProductCategoryHierarchyResourceArrayResponseToJSON,
+    ProductCategoryLiteResourceArrayResponseFromJSON,
+    ProductCategoryLiteResourceArrayResponseToJSON,
+    ProductCategoryResourceFromJSON,
+    ProductCategoryResourceToJSON,
+    StoreProductCategoryRequestFromJSON,
+    StoreProductCategoryRequestToJSON,
+    UpdateProductCategoryRequestFromJSON,
+    UpdateProductCategoryRequestToJSON,
+} from '../models/index';
+
+export interface DestroyProductCategoryRequest {
+    productCategory: number;
+}
+
+export interface GetAllProductCategoryOperationRequest {
+    getAllProductCategoryRequest?: GetAllProductCategoryRequest;
+}
+
+export interface GetChildrenProductCategoryRequest {
+    productCategory: number;
+    indexProductCategoryRequest?: IndexProductCategoryRequest;
+}
+
+export interface IndexProductCategoryOperationRequest {
+    indexProductCategoryRequest?: IndexProductCategoryRequest;
+}
+
+export interface ShowProductCategoryRequest {
+    productCategory: number;
+}
+
+export interface StoreProductCategoryOperationRequest {
+    storeProductCategoryRequest?: StoreProductCategoryRequest;
+}
+
+export interface UpdateProductCategoryOperationRequest {
+    productCategory: number;
+    updateProductCategoryRequest?: UpdateProductCategoryRequest;
+}
+
+/**
+ * 
+ */
+export class ProductCategoryApi extends runtime.BaseAPI {
+
+    /**
+     * Auto-generated: destroyProductCategory
+     */
+    async destroyProductCategoryRaw(requestParameters: DestroyProductCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
+        if (requestParameters['productCategory'] == null) {
+            throw new runtime.RequiredError(
+                'productCategory',
+                'Required parameter "productCategory" was null or undefined when calling destroyProductCategory().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/admin-api/product-category/{productCategory}/delete`;
+        urlPath = urlPath.replace(`{${"productCategory"}}`, encodeURIComponent(String(requestParameters['productCategory'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: destroyProductCategory
+     */
+    async destroyProductCategory(requestParameters: DestroyProductCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
+        const response = await this.destroyProductCategoryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: getAllProductCategory
+     */
+    async getAllProductCategoryRaw(requestParameters: GetAllProductCategoryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductCategoryLiteResourceArrayResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/product-category/all`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GetAllProductCategoryRequestToJSON(requestParameters['getAllProductCategoryRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProductCategoryLiteResourceArrayResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: getAllProductCategory
+     */
+    async getAllProductCategory(requestParameters: GetAllProductCategoryOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductCategoryLiteResourceArrayResponse> {
+        const response = await this.getAllProductCategoryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: getChildrenProductCategory
+     */
+    async getChildrenProductCategoryRaw(requestParameters: GetChildrenProductCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductCategoryListResourceResponse>> {
+        if (requestParameters['productCategory'] == null) {
+            throw new runtime.RequiredError(
+                'productCategory',
+                'Required parameter "productCategory" was null or undefined when calling getChildrenProductCategory().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/product-category/{productCategory}/children`;
+        urlPath = urlPath.replace(`{${"productCategory"}}`, encodeURIComponent(String(requestParameters['productCategory'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IndexProductCategoryRequestToJSON(requestParameters['indexProductCategoryRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedProductCategoryListResourceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: getChildrenProductCategory
+     */
+    async getChildrenProductCategory(requestParameters: GetChildrenProductCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductCategoryListResourceResponse> {
+        const response = await this.getChildrenProductCategoryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: getHierarchyProductCategory
+     */
+    async getHierarchyProductCategoryRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductCategoryHierarchyResourceArrayResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/admin-api/product-category/hierarchy`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProductCategoryHierarchyResourceArrayResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: getHierarchyProductCategory
+     */
+    async getHierarchyProductCategory(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductCategoryHierarchyResourceArrayResponse> {
+        const response = await this.getHierarchyProductCategoryRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: indexProductCategory
+     */
+    async indexProductCategoryRaw(requestParameters: IndexProductCategoryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductCategoryListResourceResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/product-category/list`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IndexProductCategoryRequestToJSON(requestParameters['indexProductCategoryRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedProductCategoryListResourceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: indexProductCategory
+     */
+    async indexProductCategory(requestParameters: IndexProductCategoryOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductCategoryListResourceResponse> {
+        const response = await this.indexProductCategoryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: showProductCategory
+     */
+    async showProductCategoryRaw(requestParameters: ShowProductCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductCategoryResource>> {
+        if (requestParameters['productCategory'] == null) {
+            throw new runtime.RequiredError(
+                'productCategory',
+                'Required parameter "productCategory" was null or undefined when calling showProductCategory().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/admin-api/product-category/{productCategory}`;
+        urlPath = urlPath.replace(`{${"productCategory"}}`, encodeURIComponent(String(requestParameters['productCategory'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProductCategoryResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: showProductCategory
+     */
+    async showProductCategory(requestParameters: ShowProductCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductCategoryResource> {
+        const response = await this.showProductCategoryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: storeProductCategory
+     */
+    async storeProductCategoryRaw(requestParameters: StoreProductCategoryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductCategoryResource>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/product-category/create`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: StoreProductCategoryRequestToJSON(requestParameters['storeProductCategoryRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProductCategoryResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: storeProductCategory
+     */
+    async storeProductCategory(requestParameters: StoreProductCategoryOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductCategoryResource> {
+        const response = await this.storeProductCategoryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: updateProductCategory
+     */
+    async updateProductCategoryRaw(requestParameters: UpdateProductCategoryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductCategoryResource>> {
+        if (requestParameters['productCategory'] == null) {
+            throw new runtime.RequiredError(
+                'productCategory',
+                'Required parameter "productCategory" was null or undefined when calling updateProductCategory().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/product-category/{productCategory}/update`;
+        urlPath = urlPath.replace(`{${"productCategory"}}`, encodeURIComponent(String(requestParameters['productCategory'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateProductCategoryRequestToJSON(requestParameters['updateProductCategoryRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProductCategoryResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: updateProductCategory
+     */
+    async updateProductCategory(requestParameters: UpdateProductCategoryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductCategoryResource> {
+        const response = await this.updateProductCategoryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}