@digital8/lighting-illusions-ts-sdk 0.0.625 → 0.0.626

package/docs/IndexDefinitionRequest.md

@@ -1,48 +0,0 @@
-
-# IndexDefinitionRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { IndexDefinitionRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies IndexDefinitionRequest
-
-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 IndexDefinitionRequest
-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/OverlayTemplateAssetFrontendResource.md

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

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

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

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

@@ -1,70 +0,0 @@
-
-# ProductCompareResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`sku` | number
-`model` | string
-`stock` | number
-`warranty` | string
-`name` | string
-`slug` | string
-`parentName` | string
-`price` | number
-`salePrice` | number
-`availability` | number
-`optionsCount` | number
-`averageRating` | number
-`thumbnail` | [AssetFrontendResource](AssetFrontendResource.md)
-`supplierName` | string
-`supplierLogo` | [AssetFrontendResource](AssetFrontendResource.md)
-`specsData` | Array<object>
-`dimensionData` | Array<object>
-`performanceSpecsData` | Array<object>
-
-## Example
-
-```typescript
-import type { ProductCompareResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "sku": null,
-  "model": null,
-  "stock": null,
-  "warranty": null,
-  "name": null,
-  "slug": null,
-  "parentName": null,
-  "price": null,
-  "salePrice": null,
-  "availability": null,
-  "optionsCount": null,
-  "averageRating": null,
-  "thumbnail": null,
-  "supplierName": null,
-  "supplierLogo": null,
-  "specsData": null,
-  "dimensionData": null,
-  "performanceSpecsData": null,
-} satisfies ProductCompareResource
-
-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 ProductCompareResource
-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/ProductCompareResourceArrayResponse.md

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

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

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

@@ -1,286 +0,0 @@
-/* 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 {
-  DefinitionListResourceArrayResponse,
-  DefinitionResource,
-  GenericResponse,
-  GetAllDefinitionRequest,
-  IndexDefinitionRequest,
-  PaginatedDefinitionListResourceResponse,
-  StoreDefinitionRequest,
-  UpdateDefinitionRequest,
-} from '../models/index';
-import {
-    DefinitionListResourceArrayResponseFromJSON,
-    DefinitionListResourceArrayResponseToJSON,
-    DefinitionResourceFromJSON,
-    DefinitionResourceToJSON,
-    GenericResponseFromJSON,
-    GenericResponseToJSON,
-    GetAllDefinitionRequestFromJSON,
-    GetAllDefinitionRequestToJSON,
-    IndexDefinitionRequestFromJSON,
-    IndexDefinitionRequestToJSON,
-    PaginatedDefinitionListResourceResponseFromJSON,
-    PaginatedDefinitionListResourceResponseToJSON,
-    StoreDefinitionRequestFromJSON,
-    StoreDefinitionRequestToJSON,
-    UpdateDefinitionRequestFromJSON,
-    UpdateDefinitionRequestToJSON,
-} from '../models/index';
-
-export interface DestroyDefinitionRequest {
-    definition: number;
-}
-
-export interface GetAllDefinitionOperationRequest {
-    getAllDefinitionRequest?: GetAllDefinitionRequest;
-}
-
-export interface IndexDefinitionOperationRequest {
-    indexDefinitionRequest?: IndexDefinitionRequest;
-}
-
-export interface ShowDefinitionRequest {
-    definition: number;
-}
-
-export interface StoreDefinitionOperationRequest {
-    storeDefinitionRequest?: StoreDefinitionRequest;
-}
-
-export interface UpdateDefinitionOperationRequest {
-    definition: number;
-    updateDefinitionRequest?: UpdateDefinitionRequest;
-}
-
-/**
- * 
- */
-export class DefinitionApi extends runtime.BaseAPI {
-
-    /**
-     * Auto-generated: destroyDefinition
-     */
-    async destroyDefinitionRaw(requestParameters: DestroyDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
-        if (requestParameters['definition'] == null) {
-            throw new runtime.RequiredError(
-                'definition',
-                'Required parameter "definition" was null or undefined when calling destroyDefinition().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-
-        let urlPath = `/admin-api/definition/{definition}/delete`;
-        urlPath = urlPath.replace(`{${"definition"}}`, encodeURIComponent(String(requestParameters['definition'])));
-
-        const response = await this.request({
-            path: urlPath,
-            method: 'DELETE',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: destroyDefinition
-     */
-    async destroyDefinition(requestParameters: DestroyDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
-        const response = await this.destroyDefinitionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Auto-generated: getAllDefinition
-     */
-    async getAllDefinitionRaw(requestParameters: GetAllDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DefinitionListResourceArrayResponse>> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/definition/all`;
-
-        const response = await this.request({
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: GetAllDefinitionRequestToJSON(requestParameters['getAllDefinitionRequest']),
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => DefinitionListResourceArrayResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: getAllDefinition
-     */
-    async getAllDefinition(requestParameters: GetAllDefinitionOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DefinitionListResourceArrayResponse> {
-        const response = await this.getAllDefinitionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Auto-generated: indexDefinition
-     */
-    async indexDefinitionRaw(requestParameters: IndexDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedDefinitionListResourceResponse>> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/definition/list`;
-
-        const response = await this.request({
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: IndexDefinitionRequestToJSON(requestParameters['indexDefinitionRequest']),
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedDefinitionListResourceResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: indexDefinition
-     */
-    async indexDefinition(requestParameters: IndexDefinitionOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedDefinitionListResourceResponse> {
-        const response = await this.indexDefinitionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Auto-generated: showDefinition
-     */
-    async showDefinitionRaw(requestParameters: ShowDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DefinitionResource>> {
-        if (requestParameters['definition'] == null) {
-            throw new runtime.RequiredError(
-                'definition',
-                'Required parameter "definition" was null or undefined when calling showDefinition().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-
-        let urlPath = `/admin-api/definition/{definition}`;
-        urlPath = urlPath.replace(`{${"definition"}}`, encodeURIComponent(String(requestParameters['definition'])));
-
-        const response = await this.request({
-            path: urlPath,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => DefinitionResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: showDefinition
-     */
-    async showDefinition(requestParameters: ShowDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DefinitionResource> {
-        const response = await this.showDefinitionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Auto-generated: storeDefinition
-     */
-    async storeDefinitionRaw(requestParameters: StoreDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DefinitionResource>> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/definition/create`;
-
-        const response = await this.request({
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: StoreDefinitionRequestToJSON(requestParameters['storeDefinitionRequest']),
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => DefinitionResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: storeDefinition
-     */
-    async storeDefinition(requestParameters: StoreDefinitionOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DefinitionResource> {
-        const response = await this.storeDefinitionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Auto-generated: updateDefinition
-     */
-    async updateDefinitionRaw(requestParameters: UpdateDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DefinitionResource>> {
-        if (requestParameters['definition'] == null) {
-            throw new runtime.RequiredError(
-                'definition',
-                'Required parameter "definition" was null or undefined when calling updateDefinition().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/definition/{definition}/update`;
-        urlPath = urlPath.replace(`{${"definition"}}`, encodeURIComponent(String(requestParameters['definition'])));
-
-        const response = await this.request({
-            path: urlPath,
-            method: 'PUT',
-            headers: headerParameters,
-            query: queryParameters,
-            body: UpdateDefinitionRequestToJSON(requestParameters['updateDefinitionRequest']),
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => DefinitionResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: updateDefinition
-     */
-    async updateDefinition(requestParameters: UpdateDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DefinitionResource> {
-        const response = await this.updateDefinitionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}