# stylelens-sdk-js

> This_is_a_API_document_for_Stylens_Service

Latest version **0.0.11** (published 2018-04-13) · Apache 2.0 license · 0 weekly downloads

## Install

```sh
npm install stylelens-sdk-js
pnpm add stylelens-sdk-js
yarn add stylelens-sdk-js
bun add stylelens-sdk-js
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.11 |
| Published | 2018-04-13 |
| First published | 2018-01-15 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 238 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | bluehackrano |

## Links

- npm: https://www.npmjs.com/package/stylelens-sdk-js
- npm.io page: https://npm.io/package/stylelens-sdk-js

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) 3.5.2

## Recent versions

- 0.0.11 (latest) — 2018-04-13
- 0.0.10 — 2018-02-14
- 0.0.9 — 2018-02-11
- 0.0.8 — 2018-02-08
- 0.0.7 — 2018-02-06
- 0.0.6 — 2018-02-06
- 0.0.5 — 2018-01-21
- 0.0.4 — 2018-01-15
- 0.0.3 — 2018-01-15
- 0.0.2 — 2018-01-15
- 0.0.1 — 2018-01-15

## README

# 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](https://github.com/swagger-api/swagger-codegen) project:

- API version: 0.0.11
- Package version: 0.0.11
- Build package: io.swagger.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 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:

```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
```

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

```shell
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:

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

```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 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**](docs/FeedApi.md#getFeeds) | **GET** /feeds | 
*StyleApi.ImageApi* | [**getImageByHostcodeAndProductNo**](docs/ImageApi.md#getImageByHostcodeAndProductNo) | **GET** /images/hosts/{hostCode}/images/{productNo} | Get Image by hostCode and productNo
*StyleApi.ImageApi* | [**getImageById**](docs/ImageApi.md#getImageById) | **GET** /images/{imageId} | Find Images by ID
*StyleApi.ImageApi* | [**getImages**](docs/ImageApi.md#getImages) | **GET** /images | Get Images by imageId
*StyleApi.ImageApi* | [**getImagesByObjectId**](docs/ImageApi.md#getImagesByObjectId) | **GET** /images/objects/{objectId} | Query to search images by object id
*StyleApi.ImageApi* | [**getImagesByUserImageFile**](docs/ImageApi.md#getImagesByUserImageFile) | **POST** /images/userImages | Query to search images
*StyleApi.ImageApi* | [**getImagesByUserImageIdAndObjectIndex**](docs/ImageApi.md#getImagesByUserImageIdAndObjectIndex) | **GET** /images/userImages/{userImageId}/objects/{objectIndex} | Get Images by userImageId and objectIndex
*StyleApi.ObjectApi* | [**getObjectsByImageId**](docs/ObjectApi.md#getObjectsByImageId) | **GET** /objects/images/{imageId} | Query to search multiple objects
*StyleApi.ObjectApi* | [**getObjectsByUserImageFile**](docs/ObjectApi.md#getObjectsByUserImageFile) | **POST** /objects | Query to search objects and images
*StyleApi.PlaygroundApi* | [**getImagesByKeyword**](docs/PlaygroundApi.md#getImagesByKeyword) | **GET** /playgrounds/images | Query to search multiple objects
*StyleApi.PlaygroundApi* | [**getImagesDatasetByCategory**](docs/PlaygroundApi.md#getImagesDatasetByCategory) | **GET** /playgrounds/images/datasets/{source}/categories | Query to search multiple objects
*StyleApi.PlaygroundApi* | [**getImagesDatasetCategoriesCountsByCategory**](docs/PlaygroundApi.md#getImagesDatasetCategoriesCountsByCategory) | **GET** /playgrounds/images/datasets/{source}/categories/counts | Query to search category counts
*StyleApi.PlaygroundApi* | [**getPlaygroundObjectsByUserImageFile**](docs/PlaygroundApi.md#getPlaygroundObjectsByUserImageFile) | **POST** /playgrounds/objects | 
*StyleApi.PlaygroundApi* | [**updateImagesDatasetByIds**](docs/PlaygroundApi.md#updateImagesDatasetByIds) | **POST** /playgrounds/images/datasets/{source} | Update image


## Documentation for Models

 - [StyleApi.Box](docs/Box.md)
 - [StyleApi.BoxDataset](docs/BoxDataset.md)
 - [StyleApi.BoxObject](docs/BoxObject.md)
 - [StyleApi.BoxesArray](docs/BoxesArray.md)
 - [StyleApi.GetFeedResponse](docs/GetFeedResponse.md)
 - [StyleApi.GetImageResponse](docs/GetImageResponse.md)
 - [StyleApi.GetImagesByCategoryResponse](docs/GetImagesByCategoryResponse.md)
 - [StyleApi.GetImagesByCategoryResponseData](docs/GetImagesByCategoryResponseData.md)
 - [StyleApi.GetImagesByKeywordResponse](docs/GetImagesByKeywordResponse.md)
 - [StyleApi.GetImagesByKeywordResponseData](docs/GetImagesByKeywordResponseData.md)
 - [StyleApi.GetImagesCategoriesCountsByCategoryResponse](docs/GetImagesCategoriesCountsByCategoryResponse.md)
 - [StyleApi.GetImagesCategoriesCountsByCategoryResponseData](docs/GetImagesCategoriesCountsByCategoryResponseData.md)
 - [StyleApi.GetImagesResponse](docs/GetImagesResponse.md)
 - [StyleApi.GetObjectsByImageIdResponse](docs/GetObjectsByImageIdResponse.md)
 - [StyleApi.GetObjectsResponse](docs/GetObjectsResponse.md)
 - [StyleApi.GetObjectsResponseData](docs/GetObjectsResponseData.md)
 - [StyleApi.Image](docs/Image.md)
 - [StyleApi.ImageDataset](docs/ImageDataset.md)
 - [StyleApi.ImagesArray](docs/ImagesArray.md)
 - [StyleApi.SearchImageResponse](docs/SearchImageResponse.md)
 - [StyleApi.SimImage](docs/SimImage.md)
 - [StyleApi.SimpleImage](docs/SimpleImage.md)
 - [StyleApi.UpdateImageDatasetResponse](docs/UpdateImageDatasetResponse.md)


## Documentation for Authorization


### api_key

- **Type**: API key
- **API key parameter name**: api_key
- **Location**: HTTP header

---
_Source: https://npm.io/package/stylelens-sdk-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._