ai_as_a_service_api v1.1.1-rc4
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 project:
- API version: 1.1.1-rc4
- Package version: 1.1.1-rc4
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install ai_as_a_service_api --save
Finally, you need to build the module:
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:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
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:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
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:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. 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):
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:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
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 | POST /asset | |
AiAsAServiceApi.DefaultApi | createCampaign | POST /site/{site-id}/campaign | |
AiAsAServiceApi.DefaultApi | createCompany | POST /company | |
AiAsAServiceApi.DefaultApi | createJWT | POST /jwt | |
AiAsAServiceApi.DefaultApi | deleteAsset | DELETE /asset/{asset-id} | |
AiAsAServiceApi.DefaultApi | deleteCampaign | DELETE /campaign/{campaign-id} | |
AiAsAServiceApi.DefaultApi | deleteCompany | DELETE /company/{company-id} | |
AiAsAServiceApi.DefaultApi | deleteCompanySites | DELETE /company/{company-id}/sites | |
AiAsAServiceApi.DefaultApi | deleteSiteAssets | DELETE /site/{site-id}/assets | |
AiAsAServiceApi.DefaultApi | editCompany | PUT /company/{company-id} | |
AiAsAServiceApi.DefaultApi | getAsset | GET /asset/{asset-id} | |
AiAsAServiceApi.DefaultApi | getCategoryTree | GET /category-tree | |
AiAsAServiceApi.DefaultApi | getCompanies | GET /companies | |
AiAsAServiceApi.DefaultApi | getCompany | GET /company/{company-id} | |
AiAsAServiceApi.DefaultApi | getCompanyOverview | GET /company/{company-id}/overview | |
AiAsAServiceApi.DefaultApi | getProductDetails | GET /product/{product-id} | |
AiAsAServiceApi.DefaultApi | getProductsForPanel | GET /catalog | |
AiAsAServiceApi.DefaultApi | linkCategoryToCampaign | PUT /campaign/{campaign-id}/link/{category-id}/{link-type} | |
AiAsAServiceApi.DefaultApi | listCompanySites | GET /company/{company-id}/sites | |
AiAsAServiceApi.DefaultApi | listSiteAssets | GET /site/{site-id}/assets | |
AiAsAServiceApi.DefaultApi | loadAllCampaign | GET /site/{site-id}/campaigns | |
AiAsAServiceApi.DefaultApi | loadCampaign | GET /campaign/{campaign-id} | |
AiAsAServiceApi.DefaultApi | loadCampaignByType | GET /site/{site-id}/campaigns/{type} | |
AiAsAServiceApi.DefaultApi | saveColorFeaturesVector | PUT /site/{site-id}/product/{product-code}/image/{image-code}/color-features | |
AiAsAServiceApi.DefaultApi | saveObjectInformation | PUT /site/{site-id}/product/{product-code}/image/{image-code}/object | |
AiAsAServiceApi.DefaultApi | saveSimilarFeaturesVector | PUT /site/{site-id}/product/{product-code}/image/{image-code}/similarity-features | |
AiAsAServiceApi.DefaultApi | triggerAllSitesDeployment | PUT /deployment/sites | |
AiAsAServiceApi.DefaultApi | triggerFeatureExtractionOnNonVectorImagesOfSite | PUT /product/feature-extraction | |
AiAsAServiceApi.DefaultApi | triggerSiteDeployment | POST /site/{site-id}/deployment | |
AiAsAServiceApi.DefaultApi | unlinkAllCategoriesFromCampaign | DELETE /campaign/{campaign-id}/link/{link-type} | |
AiAsAServiceApi.DefaultApi | unlinkCategoryFromCampaign | DELETE /campaign/{campaign-id}/link/{category-id}/{link-type} | |
AiAsAServiceApi.DefaultApi | updateAsset | PUT /asset/{asset-id} | |
AiAsAServiceApi.DefaultApi | updateCampaign | PUT /campaign/{campaign-id} |
Documentation for Models
- AiAsAServiceApi.Asset
- AiAsAServiceApi.AssetBody
- AiAsAServiceApi.AssetBodyValue
- AiAsAServiceApi.AssetList
- AiAsAServiceApi.AssetObject
- AiAsAServiceApi.Catalog
- AiAsAServiceApi.CategoryTree
- AiAsAServiceApi.CompanyBody
- AiAsAServiceApi.CompanyItem
- AiAsAServiceApi.CompanyOverview
- AiAsAServiceApi.CompanyOverviewSites
- AiAsAServiceApi.CredentialsObject
- AiAsAServiceApi.CredentialsObjectApi
- AiAsAServiceApi.CredentialsObjectJwt
- AiAsAServiceApi.InlineObject
- AiAsAServiceApi.InlineObject1
- AiAsAServiceApi.InlineObject2
- AiAsAServiceApi.InlineObject3
- AiAsAServiceApi.InlineResponse200
- AiAsAServiceApi.InlineResponse2001
- AiAsAServiceApi.InlineResponse20010
- AiAsAServiceApi.InlineResponse20010Data
- AiAsAServiceApi.InlineResponse2002
- AiAsAServiceApi.InlineResponse2002Data
- AiAsAServiceApi.InlineResponse2003
- AiAsAServiceApi.InlineResponse2004
- AiAsAServiceApi.InlineResponse2004Data
- AiAsAServiceApi.InlineResponse2005
- AiAsAServiceApi.InlineResponse2006
- AiAsAServiceApi.InlineResponse2007
- AiAsAServiceApi.InlineResponse2008
- AiAsAServiceApi.InlineResponse2009
- AiAsAServiceApi.InlineResponse200Data
- AiAsAServiceApi.InlineResponse404
- AiAsAServiceApi.InlineResponse422
- AiAsAServiceApi.InlineResponse4221
- AiAsAServiceApi.InlineResponse500
- AiAsAServiceApi.Product
- AiAsAServiceApi.ProductCategories
- AiAsAServiceApi.ProductImages
- AiAsAServiceApi.SimilarityFeatures
- AiAsAServiceApi.SiteItem
- AiAsAServiceApi.Token
Documentation for Authorization
basicAuth
- Type: HTTP basic authentication
2 years ago