@digital8/lighting-illusions-ts-sdk

v0.0.535

Published

5 days ago

OpenAPI client for @digital8/lighting-illusions-ts-sdk

0High
0Medium
0Low

rhys_mckenzie

gilbertchian

@digital8/[email protected]

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install @digital8/lighting-illusions-ts-sdk --save

Next, try it out.

import {
  Configuration,
  AssetApi,
} from '@digital8/lighting-illusions-ts-sdk';
import type { StoreAssetFileOperationRequest } from '@digital8/lighting-illusions-ts-sdk';

async function example() {
  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
  const api = new AssetApi();

  const body = {
    // StoreAssetFileRequest (optional)
    storeAssetFileRequest: ...,
  } satisfies StoreAssetFileOperationRequest;

  try {
    const data = await api.storeAssetFile(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to http://localhost/api

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AssetApi | storeAssetFile | POST /admin-api/asset/create | Auto-generated: storeAssetFile AttributeApi | attachProductTypeAttribute | POST /admin-api/attribute/{attribute}/attach-product-type | Auto-generated: attachProductTypeAttribute AttributeApi | destroyAttribute | DELETE /admin-api/attribute/{attribute}/delete | Auto-generated: destroyAttribute AttributeApi | destroyAttributeValue | POST /admin-api/attribute/value/{attributeValue}/delete | Auto-generated: destroyAttributeValue AttributeApi | detachProductTypeAttribute | POST /admin-api/attribute/{attribute}/detach-product-type/{productType} | Auto-generated: detachProductTypeAttribute AttributeApi | getAllAttribute | POST /admin-api/attribute/all | Auto-generated: getAllAttribute AttributeApi | indexAttribute | POST /admin-api/attribute/list | Auto-generated: indexAttribute AttributeApi | showAttribute | GET /admin-api/attribute/{attribute} | Auto-generated: showAttribute AttributeApi | storeAttribute | POST /admin-api/attribute/create | Auto-generated: storeAttribute AttributeApi | storeAttributeValue | POST /admin-api/attribute/value/create | Auto-generated: storeAttributeValue AttributeApi | updateAttachedProductTypeAttribute | PUT /admin-api/attribute/{attribute}/update-product-type | Auto-generated: updateAttachedProductTypeAttribute AttributeApi | updateAttribute | PUT /admin-api/attribute/{attribute}/update | Auto-generated: updateAttribute AttributeApi | updateAttributeValue | PUT /admin-api/attribute/value/{attributeValue}/update | Auto-generated: updateAttributeValue AttributeApi | updateFilterOrderAttribute | PUT /admin-api/attribute/update-filter-order | Auto-generated: updateFilterOrderAttribute AttributeApi | updateModelAttribute | PUT /admin-api/attribute/model-attribute/{modelAttribute}/update | Auto-generated: updateModelAttribute DocumentApi | attachDocumentablesDocument | POST /admin-api/document/{document}/attach-documentables | Auto-generated: attachDocumentablesDocument DocumentApi | destroyDocument | DELETE /admin-api/document/{document}/delete | Auto-generated: destroyDocument DocumentApi | detachDocumentablesDocument | POST /admin-api/document/{document}/detach-documentables | Auto-generated: detachDocumentablesDocument DocumentApi | getAllDocument | POST /admin-api/document/all | Auto-generated: getAllDocument DocumentApi | indexDocument | POST /admin-api/document/list | Auto-generated: indexDocument DocumentApi | showDocument | GET /admin-api/document/{document} | Auto-generated: showDocument DocumentApi | storeDocument | POST /admin-api/document/create | Auto-generated: storeDocument DocumentApi | storeDocumentFile | POST /admin-api/document/files | Auto-generated: storeDocumentFile DocumentApi | updateDocument | PUT /admin-api/document/{document}/update | Auto-generated: updateDocument ExternalApiLogApi | indexExternalApiLog | POST /admin-api/external-api-log/list | Auto-generated: indexExternalApiLog GoogleCategoryApi | getAllGoogleCategory | POST /admin-api/google-category/all | Auto-generated: getAllGoogleCategory OverlayTemplateApi | attachAssetsOverlayTemplate | POST /admin-api/overlay-template/{overlayTemplate}/attach-assets | Auto-generated: attachAssetsOverlayTemplate OverlayTemplateApi | destroyOverlayTemplate | DELETE /admin-api/overlay-template/{overlayTemplate}/delete | Auto-generated: destroyOverlayTemplate OverlayTemplateApi | destroyOverlayTemplateAsset | DELETE /admin-api/overlay-template/asset/{overlayTemplateAsset}/delete | Auto-generated: destroyOverlayTemplateAsset OverlayTemplateApi | detachAssetOverlayTemplate | POST /admin-api/overlay-template/{overlayTemplate}/detach-asset/{asset} | Auto-generated: detachAssetOverlayTemplate OverlayTemplateApi | detachAssetableOverlayTemplate | POST /admin-api/overlay-template/{overlayTemplate}/detach-assetable | Auto-generated: detachAssetableOverlayTemplate OverlayTemplateApi | getAllOverlayTemplate | POST /admin-api/overlay-template/all | Auto-generated: getAllOverlayTemplate OverlayTemplateApi | indexOverlayTemplate | POST /admin-api/overlay-template/list | Auto-generated: indexOverlayTemplate OverlayTemplateApi | showOverlayTemplate | GET /admin-api/overlay-template/{overlayTemplate} | Auto-generated: showOverlayTemplate OverlayTemplateApi | storeOverlayTemplate | POST /admin-api/overlay-template/create | Auto-generated: storeOverlayTemplate OverlayTemplateApi | storeOverlayTemplateAsset | POST /admin-api/overlay-template/asset/create | Auto-generated: storeOverlayTemplateAsset OverlayTemplateApi | updateOverlayTemplate | PUT /admin-api/overlay-template/{overlayTemplate}/update | Auto-generated: updateOverlayTemplate OverlayTemplateApi | updateOverlayTemplateAsset | PUT /admin-api/overlay-template/asset/{overlayTemplateAsset}/update | Auto-generated: updateOverlayTemplateAsset ProductApi | attachAccessoriesProductChild | POST /admin-api/product/children/{productChild}/accessory/attach | Auto-generated: attachAccessoriesProductChild ProductApi | attachCompatibleProductsProductChild | POST /admin-api/product/children/{productChild}/compatible-product/attach | Auto-generated: attachCompatibleProductsProductChild ProductApi | destroyProduct | DELETE /admin-api/product/parent/{product}/delete | Auto-generated: destroyProduct ProductApi | destroyProductChild | DELETE /admin-api/product/children/{productChild}/delete | Auto-generated: destroyProductChild ProductApi | detachAccessoryProductChild | DELETE /admin-api/product/children/{productChild}/accessory/detach/{accessory} | Auto-generated: detachAccessoryProductChild ProductApi | detachCompatibleProductProductChild | DELETE /admin-api/product/children/{productChild}/compatible-product/detach/{compatibleProduct} | Auto-generated: detachCompatibleProductProductChild ProductApi | getAccessoriesProductChild | POST /admin-api/product/children/{productChild}/accessory/list | Auto-generated: getAccessoriesProductChild ProductApi | getAllProduct | POST /admin-api/product/parent/all | Auto-generated: getAllProduct ProductApi | getAllProductChild | POST /admin-api/product/children/all | Auto-generated: getAllProductChild ProductApi | getCompatibleProductsProductChild | POST /admin-api/product/children/{productChild}/compatible-product/list | Auto-generated: getCompatibleProductsProductChild ProductApi | indexProduct | POST /admin-api/product/parent/list | Auto-generated: indexProduct ProductApi | indexProductChild | POST /admin-api/product/children/list | Auto-generated: indexProductChild ProductApi | showAssetsProductChild | GET /admin-api/product/children/{productChild}/assets | Auto-generated: showAssetsProductChild ProductApi | showProduct | GET /admin-api/product/parent/{product} | Auto-generated: showProduct ProductApi | showProductChild | GET /admin-api/product/children/{productChild} | Auto-generated: showProductChild ProductApi | storeProduct | POST /admin-api/product/parent/create | Auto-generated: storeProduct ProductApi | storeProductChild | POST /admin-api/product/children/create | Auto-generated: storeProductChild ProductApi | updateProduct | PUT /admin-api/product/parent/{product}/update | Auto-generated: updateProduct ProductApi | updateProductChild | PUT /admin-api/product/children/{productChild}/update | Auto-generated: updateProductChild ProductCategoryApi | destroyProductCategory | DELETE /admin-api/product-category/{productCategory}/delete | Auto-generated: destroyProductCategory ProductCategoryApi | getAllProductCategory | POST /admin-api/product-category/all | Auto-generated: getAllProductCategory ProductCategoryApi | getChildrenProductCategory | GET /admin-api/product-category/{productCategory}/children | Auto-generated: getChildrenProductCategory ProductCategoryApi | getHierarchyProductCategory | GET /admin-api/product-category/hierarchy | Auto-generated: getHierarchyProductCategory ProductCategoryApi | indexProductCategory | POST /admin-api/product-category/list | Auto-generated: indexProductCategory ProductCategoryApi | showProductCategory | GET /admin-api/product-category/{productCategory} | Auto-generated: showProductCategory ProductCategoryApi | storeProductCategory | POST /admin-api/product-category/create | Auto-generated: storeProductCategory ProductCategoryApi | updateProductCategory | PUT /admin-api/product-category/{productCategory}/update | Auto-generated: updateProductCategory ProductChildSiteDetailApi | attachDocumentsProductChildSiteDetail | POST /admin-api/product-child-site-detail/{productChildSiteDetail}/attach-documents | Auto-generated: attachDocumentsProductChildSiteDetail ProductChildSiteDetailApi | detachDocumentsProductChildSiteDetail | POST /admin-api/product-child-site-detail/{productChildSiteDetail}/detach-documents | Auto-generated: detachDocumentsProductChildSiteDetail ProductTypeApi | attachAttributeProductType | POST /admin-api/product-type/{productType}/attach-attribute | Auto-generated: attachAttributeProductType ProductTypeApi | destroyProductType | DELETE /admin-api/product-type/{productType}/delete | Auto-generated: destroyProductType ProductTypeApi | detachAttributeProductType | POST /admin-api/product-type/{productType}/detach-attribute/{attribute} | Auto-generated: detachAttributeProductType ProductTypeApi | getAllProductType | POST /admin-api/product-type/all | Auto-generated: getAllProductType ProductTypeApi | indexProductType | POST /admin-api/product-type/list | Auto-generated: indexProductType ProductTypeApi | showProductType | GET /admin-api/product-type/{productType} | Auto-generated: showProductType ProductTypeApi | storeProductType | POST /admin-api/product-type/create | Auto-generated: storeProductType ProductTypeApi | updateAttachedAttributeProductType | PUT /admin-api/product-type/{productType}/update-attribute | Auto-generated: updateAttachedAttributeProductType ProductTypeApi | updateProductType | PUT /admin-api/product-type/{productType}/update | Auto-generated: updateProductType SiteApi | destroySiteNotification | DELETE /admin-api/site/notification/{siteNotification}/delete | Auto-generated: destroySiteNotification SiteApi | getAllSite | POST /admin-api/site/all | Auto-generated: getAllSite SiteApi | indexSite | POST /admin-api/site/list | Auto-generated: indexSite SiteApi | indexSiteNotification | POST /admin-api/site/notification/list | Auto-generated: indexSiteNotification SiteApi | showSite | GET /admin-api/site/{site} | Auto-generated: showSite SiteApi | storeSiteNotification | POST /admin-api/site/notification/create | Auto-generated: storeSiteNotification SiteApi | updateSite | PUT /admin-api/site/{site}/update | Auto-generated: updateSite SiteApi | updateSiteNotification | PUT /admin-api/site/notification/{siteNotification}/update | Auto-generated: updateSiteNotification SupplierApi | destroySupplier | DELETE /admin-api/supplier/{supplier}/delete | Auto-generated: destroySupplier SupplierApi | exportSupplier | POST /admin-api/supplier/export | Auto-generated: exportSupplier SupplierApi | getAllSupplier | POST /admin-api/supplier/all | Auto-generated: getAllSupplier SupplierApi | importSupplier | POST /admin-api/supplier/import | Auto-generated: importSupplier SupplierApi | indexSupplier | POST /admin-api/supplier/list | Auto-generated: indexSupplier SupplierApi | showSupplier | GET /admin-api/supplier/{supplier} | Auto-generated: showSupplier SupplierApi | storeSupplier | POST /admin-api/supplier/create | Auto-generated: storeSupplier SupplierApi | updateSupplier | PUT /admin-api/supplier/{supplier}/update | Auto-generated: updateSupplier TagApi | attachProductChildrenTag | POST /admin-api/tag/{tag}/attach-product-children | Auto-generated: attachProductChildrenTag TagApi | destroyTag | DELETE /admin-api/tag/{tag}/delete | Auto-generated: destroyTag TagApi | detachProductChildTag | POST /admin-api/tag/{tag}/detach-product-child/{productChild} | Auto-generated: detachProductChildTag TagApi | getAllTag | POST /admin-api/tag/all | Auto-generated: getAllTag TagApi | indexTag | POST /admin-api/tag/list | Auto-generated: indexTag TagApi | showTag | GET /admin-api/tag/{tag} | Auto-generated: showTag TagApi | storeTag | POST /admin-api/tag/create | Auto-generated: storeTag TagApi | updateTag | PUT /admin-api/tag/{tag}/update | Auto-generated: updateTag

Models

Authorization

Endpoints do not require authorization.

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 0.0.535
Generator version: 7.18.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme