# kroba_licence_sdk_js

> ERROR_UNKNOWN

Latest version **0.2.6** (published 2021-06-04) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install kroba_licence_sdk_js
pnpm add kroba_licence_sdk_js
yarn add kroba_licence_sdk_js
bun add kroba_licence_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.2.6 |
| Published | 2021-06-04 |
| First published | 2021-06-04 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 49.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | morwors |

## Links

- npm: https://www.npmjs.com/package/kroba_licence_sdk_js
- npm.io page: https://npm.io/package/kroba_licence_sdk_js

## Dependencies (1)

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

## Recent versions

- 0.2.6 (latest) — 2021-06-04
- 0.2.5 — 2021-06-04
- 0.2.4 — 2021-06-04
- 0.2.3 — 2021-06-04
- 0.2.2 — 2021-06-04

## README

# kroba_licence_sdk

KrobaLicenceSdk - JavaScript client for kroba_licence_sdk
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: ce2dcc04-fe57-46e6-9f3e-b8a0b61022ae
- Package version: ce2dcc04-fe57-46e6-9f3e-b8a0b61022ae
- 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 kroba_licence_sdk --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 kroba_licence_sdk from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

You should now be able to `require('kroba_licence_sdk')` 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/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, 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 KrobaLicenceSdk = require('kroba_licence_sdk_js');

var defaultClient = KrobaLicenceSdk.ApiClient.instance;

// Configure API key authorization: sso_auth
var sso_auth = defaultClient.authentications['sso_auth'];
sso_auth.apiKey = "Bearer <YOUR API KEY>"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//sso_auth.apiKeyPrefix['Authorization'] = "Token"

var api = new KrobaLicenceSdk.DefaultApi()
var licenceId = "licenceId_example"; // {String} 
var opts = {
  'token': "token_example" // {String} 
};

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

```

## Documentation for API Endpoints

All URIs are relative to *https://licence-backend.glitch.me*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*KrobaLicenceSdk.DefaultApi* | [**activateLicence**](docs/DefaultApi.md#activateLicence) | **POST** /api/licence/activate | ActivateLicence
*KrobaLicenceSdk.DefaultApi* | [**deactivateLicence**](docs/DefaultApi.md#deactivateLicence) | **POST** /api/licence/deactivate | DeactivateLicence


## Documentation for Models

 - [KrobaLicenceSdk.Model201](docs/Model201.md)


## Documentation for Authorization


### sso_auth

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

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