npm package: @rcholic/sentience-sdk
Description: OpenAPI client for @rcholic/sentience-sdk
Author: OpenAPI-Generator Contributors
Latest version: 0.2.2

## @rcholic/sentience-sdk@0.2.2

This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:

Environment
* Node.js
* Webpack
* Browserify

Language level
* ES5 - you must have a Promises/A+ library installed
* ES6

Module system
* CommonJS
* ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))

### Building

To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```

### Publishing

First build the package then run `npm publish`

### Consuming

navigate to the folder of your consuming project and run one of the following commands.

_published:_

```
npm install @rcholic/sentience-sdk@0.2.2 --save
```

_unPublished (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
```

### Documentation for API Endpoints

All URIs are relative to *https://api.sentienceapi.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*SentienceObservationApi* | [**observe**](docs/SentienceObservationApi.md#observe) | **POST** /v1/observe | Observe and extract web content or element coordinates


### Documentation For Models

 - [SentienceAppliedFilters](docs/SentienceAppliedFilters.md)
 - [SentienceBoundingBox](docs/SentienceBoundingBox.md)
 - [SentienceCreditDetails](docs/SentienceCreditDetails.md)
 - [SentienceElementFilter](docs/SentienceElementFilter.md)
 - [SentienceElementStates](docs/SentienceElementStates.md)
 - [SentienceErrorResponse](docs/SentienceErrorResponse.md)
 - [SentienceInsufficientCreditsError](docs/SentienceInsufficientCreditsError.md)
 - [SentienceInteractableElement](docs/SentienceInteractableElement.md)
 - [SentienceLayoutViewport](docs/SentienceLayoutViewport.md)
 - [SentienceMapModeResponse](docs/SentienceMapModeResponse.md)
 - [SentienceObserve200Response](docs/SentienceObserve200Response.md)
 - [SentienceObserveOptions](docs/SentienceObserveOptions.md)
 - [SentienceObserveRequest](docs/SentienceObserveRequest.md)
 - [SentienceOutputFormat](docs/SentienceOutputFormat.md)
 - [SentiencePlanTier](docs/SentiencePlanTier.md)
 - [SentienceProcessingMode](docs/SentienceProcessingMode.md)
 - [SentienceProxyFailure](docs/SentienceProxyFailure.md)
 - [SentienceReaderModeResponse](docs/SentienceReaderModeResponse.md)
 - [SentienceReaderModeResponseData](docs/SentienceReaderModeResponseData.md)
 - [SentienceRenderQuality](docs/SentienceRenderQuality.md)
 - [SentienceResponseMetadata](docs/SentienceResponseMetadata.md)
 - [SentienceSubscriptionDetails](docs/SentienceSubscriptionDetails.md)
 - [SentienceSubscriptionInactiveError](docs/SentienceSubscriptionInactiveError.md)
 - [SentienceViewport](docs/SentienceViewport.md)
 - [SentienceVisualModeResponse](docs/SentienceVisualModeResponse.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="apiKeyAuth"></a>
### apiKeyAuth

- **Type**: Bearer authentication (API Key)