stylelens-sdk-js

stylelens-sdk-js

StyleApi - JavaScript client for style_api This is a API document for Stylens Service This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.11
• Package version: 0.0.11
• Build package: io.swagger.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 stylelens-sdk-js --save

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

Finally, switch to the directory you want to use your stylelens-sdk-js from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('stylelens-sdk-js') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/stylelens-sdk-js then install it via:

    npm install YOUR_USERNAME/stylelens-sdk-js --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, that's to say your javascript file where you actually use this library):

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 StyleApi = require('stylelens-sdk-js');

var api = new StyleApi.FeedApi()

var opts = { 
  'offset': 56, // {Number} 
  'limit': 56 // {Number} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeeds(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://api-prod.stylelens.io

Class	Method	HTTP request	Description
StyleApi.FeedApi	getFeeds	GET /feeds
StyleApi.ImageApi	getImageByHostcodeAndProductNo	GET /images/hosts/{hostCode}/images/{productNo}	Get Image by hostCode and productNo
StyleApi.ImageApi	getImageById	GET /images/{imageId}	Find Images by ID
StyleApi.ImageApi	getImages	GET /images	Get Images by imageId
StyleApi.ImageApi	getImagesByObjectId	GET /images/objects/{objectId}	Query to search images by object id
StyleApi.ImageApi	getImagesByUserImageFile	POST /images/userImages	Query to search images
StyleApi.ImageApi	getImagesByUserImageIdAndObjectIndex	GET /images/userImages/{userImageId}/objects/{objectIndex}	Get Images by userImageId and objectIndex
StyleApi.ObjectApi	getObjectsByImageId	GET /objects/images/{imageId}	Query to search multiple objects
StyleApi.ObjectApi	getObjectsByUserImageFile	POST /objects	Query to search objects and images
StyleApi.PlaygroundApi	getImagesByKeyword	GET /playgrounds/images	Query to search multiple objects
StyleApi.PlaygroundApi	getImagesDatasetByCategory	GET /playgrounds/images/datasets/{source}/categories	Query to search multiple objects
StyleApi.PlaygroundApi	getImagesDatasetCategoriesCountsByCategory	GET /playgrounds/images/datasets/{source}/categories/counts	Query to search category counts
StyleApi.PlaygroundApi	getPlaygroundObjectsByUserImageFile	POST /playgrounds/objects
StyleApi.PlaygroundApi	updateImagesDatasetByIds	POST /playgrounds/images/datasets/{source}	Update image

Documentation for Models

• StyleApi.Box
• StyleApi.BoxDataset
• StyleApi.BoxObject
• StyleApi.BoxesArray
• StyleApi.GetFeedResponse
• StyleApi.GetImageResponse
• StyleApi.GetImagesByCategoryResponse
• StyleApi.GetImagesByCategoryResponseData
• StyleApi.GetImagesByKeywordResponse
• StyleApi.GetImagesByKeywordResponseData
• StyleApi.GetImagesCategoriesCountsByCategoryResponse
• StyleApi.GetImagesCategoriesCountsByCategoryResponseData
• StyleApi.GetImagesResponse
• StyleApi.GetObjectsByImageIdResponse
• StyleApi.GetObjectsResponse
• StyleApi.GetObjectsResponseData
• StyleApi.Image
• StyleApi.ImageDataset
• StyleApi.ImagesArray
• StyleApi.SearchImageResponse
• StyleApi.SimImage
• StyleApi.SimpleImage
• StyleApi.UpdateImageDatasetResponse

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header