# ai_as_a_service_api > JS API client generated by OpenAPI Generator Latest version **1.1.1-rc4** (published 2022-04-21) · Unlicense license · 0 weekly downloads ## Install ```sh npm install ai_as_a_service_api pnpm add ai_as_a_service_api yarn add ai_as_a_service_api bun add ai_as_a_service_api ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.1-rc4 | | Published | 2022-04-21 | | First published | 2022-04-21 | | Weekly downloads | 0 | | License | Unlicense | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Unpacked size | 257.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Maintainers | vviinn | ## Links - npm: https://www.npmjs.com/package/ai_as_a_service_api - npm.io page: https://npm.io/package/ai_as_a_service_api ## Dependencies (2) - [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0 - [superagent](https://npm.io/package/superagent.md) ^5.3.0 ## Recent versions - 1.1.1-rc4 (latest) — 2022-04-21 ## README # ai_as_a_service_api AiAsAServiceApi - JavaScript client for ai_as_a_service_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.1.1-rc4 - Package version: 1.1.1-rc4 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell npm install ai_as_a_service_api --save ``` Finally, you need to build the module: ```shell npm run build ``` ##### Local development To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` To use the link you just defined in your project, switch to the directory you want to use your ai_as_a_service_api from, and run: ```shell npm link /path/to/ ``` Finally, you need to build the module: ```shell npm run build ``` #### git If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via: ```shell npm install GIT_USER_ID/GIT_REPO_ID --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following the above steps with Node.js and installing browserify with `npm install -g browserify`, perform the following (assuming *main.js* is your entry file): ```shell browserify main.js > bundle.js ``` Then include *bundle.js* in the HTML pages. ### Webpack Configuration Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config: ```javascript module: { rules: [ { parser: { amd: false } } ] } ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript var AiAsAServiceApi = require('ai_as_a_service_api'); var defaultClient = AiAsAServiceApi.ApiClient.instance; // Configure HTTP basic authorization: basicAuth var basicAuth = defaultClient.authentications['basicAuth']; basicAuth.username = 'YOUR USERNAME' basicAuth.password = 'YOUR PASSWORD' var api = new AiAsAServiceApi.DefaultApi() var opts = { 'assetBody': new AiAsAServiceApi.AssetBody() // {AssetBody} }; api.createAsset(opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); }); ``` ## Documentation for API Endpoints All URIs are relative to *https://api.stage.vviinn.com* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *AiAsAServiceApi.DefaultApi* | [**createAsset**](docs/DefaultApi.md#createAsset) | **POST** /asset | *AiAsAServiceApi.DefaultApi* | [**createCampaign**](docs/DefaultApi.md#createCampaign) | **POST** /site/{site-id}/campaign | *AiAsAServiceApi.DefaultApi* | [**createCompany**](docs/DefaultApi.md#createCompany) | **POST** /company | *AiAsAServiceApi.DefaultApi* | [**createJWT**](docs/DefaultApi.md#createJWT) | **POST** /jwt | *AiAsAServiceApi.DefaultApi* | [**deleteAsset**](docs/DefaultApi.md#deleteAsset) | **DELETE** /asset/{asset-id} | *AiAsAServiceApi.DefaultApi* | [**deleteCampaign**](docs/DefaultApi.md#deleteCampaign) | **DELETE** /campaign/{campaign-id} | *AiAsAServiceApi.DefaultApi* | [**deleteCompany**](docs/DefaultApi.md#deleteCompany) | **DELETE** /company/{company-id} | *AiAsAServiceApi.DefaultApi* | [**deleteCompanySites**](docs/DefaultApi.md#deleteCompanySites) | **DELETE** /company/{company-id}/sites | *AiAsAServiceApi.DefaultApi* | [**deleteSiteAssets**](docs/DefaultApi.md#deleteSiteAssets) | **DELETE** /site/{site-id}/assets | *AiAsAServiceApi.DefaultApi* | [**editCompany**](docs/DefaultApi.md#editCompany) | **PUT** /company/{company-id} | *AiAsAServiceApi.DefaultApi* | [**getAsset**](docs/DefaultApi.md#getAsset) | **GET** /asset/{asset-id} | *AiAsAServiceApi.DefaultApi* | [**getCategoryTree**](docs/DefaultApi.md#getCategoryTree) | **GET** /category-tree | *AiAsAServiceApi.DefaultApi* | [**getCompanies**](docs/DefaultApi.md#getCompanies) | **GET** /companies | *AiAsAServiceApi.DefaultApi* | [**getCompany**](docs/DefaultApi.md#getCompany) | **GET** /company/{company-id} | *AiAsAServiceApi.DefaultApi* | [**getCompanyOverview**](docs/DefaultApi.md#getCompanyOverview) | **GET** /company/{company-id}/overview | *AiAsAServiceApi.DefaultApi* | [**getProductDetails**](docs/DefaultApi.md#getProductDetails) | **GET** /product/{product-id} | *AiAsAServiceApi.DefaultApi* | [**getProductsForPanel**](docs/DefaultApi.md#getProductsForPanel) | **GET** /catalog | *AiAsAServiceApi.DefaultApi* | [**linkCategoryToCampaign**](docs/DefaultApi.md#linkCategoryToCampaign) | **PUT** /campaign/{campaign-id}/link/{category-id}/{link-type} | *AiAsAServiceApi.DefaultApi* | [**listCompanySites**](docs/DefaultApi.md#listCompanySites) | **GET** /company/{company-id}/sites | *AiAsAServiceApi.DefaultApi* | [**listSiteAssets**](docs/DefaultApi.md#listSiteAssets) | **GET** /site/{site-id}/assets | *AiAsAServiceApi.DefaultApi* | [**loadAllCampaign**](docs/DefaultApi.md#loadAllCampaign) | **GET** /site/{site-id}/campaigns | *AiAsAServiceApi.DefaultApi* | [**loadCampaign**](docs/DefaultApi.md#loadCampaign) | **GET** /campaign/{campaign-id} | *AiAsAServiceApi.DefaultApi* | [**loadCampaignByType**](docs/DefaultApi.md#loadCampaignByType) | **GET** /site/{site-id}/campaigns/{type} | *AiAsAServiceApi.DefaultApi* | [**saveColorFeaturesVector**](docs/DefaultApi.md#saveColorFeaturesVector) | **PUT** /site/{site-id}/product/{product-code}/image/{image-code}/color-features | *AiAsAServiceApi.DefaultApi* | [**saveObjectInformation**](docs/DefaultApi.md#saveObjectInformation) | **PUT** /site/{site-id}/product/{product-code}/image/{image-code}/object | *AiAsAServiceApi.DefaultApi* | [**saveSimilarFeaturesVector**](docs/DefaultApi.md#saveSimilarFeaturesVector) | **PUT** /site/{site-id}/product/{product-code}/image/{image-code}/similarity-features | *AiAsAServiceApi.DefaultApi* | [**triggerAllSitesDeployment**](docs/DefaultApi.md#triggerAllSitesDeployment) | **PUT** /deployment/sites | *AiAsAServiceApi.DefaultApi* | [**triggerFeatureExtractionOnNonVectorImagesOfSite**](docs/DefaultApi.md#triggerFeatureExtractionOnNonVectorImagesOfSite) | **PUT** /product/feature-extraction | *AiAsAServiceApi.DefaultApi* | [**triggerSiteDeployment**](docs/DefaultApi.md#triggerSiteDeployment) | **POST** /site/{site-id}/deployment | *AiAsAServiceApi.DefaultApi* | [**unlinkAllCategoriesFromCampaign**](docs/DefaultApi.md#unlinkAllCategoriesFromCampaign) | **DELETE** /campaign/{campaign-id}/link/{link-type} | *AiAsAServiceApi.DefaultApi* | [**unlinkCategoryFromCampaign**](docs/DefaultApi.md#unlinkCategoryFromCampaign) | **DELETE** /campaign/{campaign-id}/link/{category-id}/{link-type} | *AiAsAServiceApi.DefaultApi* | [**updateAsset**](docs/DefaultApi.md#updateAsset) | **PUT** /asset/{asset-id} | *AiAsAServiceApi.DefaultApi* | [**updateCampaign**](docs/DefaultApi.md#updateCampaign) | **PUT** /campaign/{campaign-id} | ## Documentation for Models - [AiAsAServiceApi.Asset](docs/Asset.md) - [AiAsAServiceApi.AssetBody](docs/AssetBody.md) - [AiAsAServiceApi.AssetBodyValue](docs/AssetBodyValue.md) - [AiAsAServiceApi.AssetList](docs/AssetList.md) - [AiAsAServiceApi.AssetObject](docs/AssetObject.md) - [AiAsAServiceApi.Catalog](docs/Catalog.md) - [AiAsAServiceApi.CategoryTree](docs/CategoryTree.md) - [AiAsAServiceApi.CompanyBody](docs/CompanyBody.md) - [AiAsAServiceApi.CompanyItem](docs/CompanyItem.md) - [AiAsAServiceApi.CompanyOverview](docs/CompanyOverview.md) - [AiAsAServiceApi.CompanyOverviewSites](docs/CompanyOverviewSites.md) - [AiAsAServiceApi.CredentialsObject](docs/CredentialsObject.md) - [AiAsAServiceApi.CredentialsObjectApi](docs/CredentialsObjectApi.md) - [AiAsAServiceApi.CredentialsObjectJwt](docs/CredentialsObjectJwt.md) - [AiAsAServiceApi.InlineObject](docs/InlineObject.md) - [AiAsAServiceApi.InlineObject1](docs/InlineObject1.md) - [AiAsAServiceApi.InlineObject2](docs/InlineObject2.md) - [AiAsAServiceApi.InlineObject3](docs/InlineObject3.md) - [AiAsAServiceApi.InlineResponse200](docs/InlineResponse200.md) - [AiAsAServiceApi.InlineResponse2001](docs/InlineResponse2001.md) - [AiAsAServiceApi.InlineResponse20010](docs/InlineResponse20010.md) - [AiAsAServiceApi.InlineResponse20010Data](docs/InlineResponse20010Data.md) - [AiAsAServiceApi.InlineResponse2002](docs/InlineResponse2002.md) - [AiAsAServiceApi.InlineResponse2002Data](docs/InlineResponse2002Data.md) - [AiAsAServiceApi.InlineResponse2003](docs/InlineResponse2003.md) - [AiAsAServiceApi.InlineResponse2004](docs/InlineResponse2004.md) - [AiAsAServiceApi.InlineResponse2004Data](docs/InlineResponse2004Data.md) - [AiAsAServiceApi.InlineResponse2005](docs/InlineResponse2005.md) - [AiAsAServiceApi.InlineResponse2006](docs/InlineResponse2006.md) - [AiAsAServiceApi.InlineResponse2007](docs/InlineResponse2007.md) - [AiAsAServiceApi.InlineResponse2008](docs/InlineResponse2008.md) - [AiAsAServiceApi.InlineResponse2009](docs/InlineResponse2009.md) - [AiAsAServiceApi.InlineResponse200Data](docs/InlineResponse200Data.md) - [AiAsAServiceApi.InlineResponse404](docs/InlineResponse404.md) - [AiAsAServiceApi.InlineResponse422](docs/InlineResponse422.md) - [AiAsAServiceApi.InlineResponse4221](docs/InlineResponse4221.md) - [AiAsAServiceApi.InlineResponse500](docs/InlineResponse500.md) - [AiAsAServiceApi.Product](docs/Product.md) - [AiAsAServiceApi.ProductCategories](docs/ProductCategories.md) - [AiAsAServiceApi.ProductImages](docs/ProductImages.md) - [AiAsAServiceApi.SimilarityFeatures](docs/SimilarityFeatures.md) - [AiAsAServiceApi.SiteItem](docs/SiteItem.md) - [AiAsAServiceApi.Token](docs/Token.md) ## Documentation for Authorization ### basicAuth - **Type**: HTTP basic authentication --- _Source: https://npm.io/package/ai_as_a_service_api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._