# antenny-js

> Api client for antenny

Latest version **1.3.0** (published 2021-01-31) · Apache 2.0 license · 0 weekly downloads

## Install

```sh
npm install antenny-js
pnpm add antenny-js
yarn add antenny-js
bun add antenny-js
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2021-01-31 |
| First published | 2020-09-22 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 106.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | antenny-admin |

## Links

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

## Dependencies (2)

- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0
- [superagent](https://npm.io/package/superagent.md) ^5.3.0

## Recent versions

- 1.3.0 (latest) — 2021-01-31
- 1.2.0 — 2021-01-03
- 1.1.0 — 2021-01-01
- 1.0.3 — 2020-12-19
- 1.0.2 — 2020-09-26
- 1.0.1 — 2020-09-26
- 1.0.0 — 2020-09-22

## README

# antenny-js

antenny - JavaScript client for [antenny](https://antenny.io). This is an api that allows you to interact with Antenny. It allows you to manage your clients and subscriptions.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project.

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

```shell
npm install antenny-js --save
```

## Getting Started

Please follow the [installation](#installation) instructions and execute the following JS code:

```javascript
const antenny = require('antenny-js');
const instance = antenny.ApiClient.instance;
const Auth = instance.authentications['ApiKeyAuth'];
Auth.apiKey = "YOUR API KEY"

// create subscription
const api = new antenny.SubscriptionApi();
const newSub = new antenny.NewSubscription({
  name: 'test-subscription',
  customerId: '{customerId}',
  region: '{aws-region}',
  resource: new antenny.Resource({
    protocol: 'ws',
    url: 'wss://example.com/'
  }),
  endpoint: new antenny.Endpoint({
    protocol: 'http',
    url: 'https://example.com'
  })
});

let sub;
try {
  sub = await api.createSubscription(newSub);
} catch (err) {
  console.error(err);
  return;
}
console.log(sub);
```

## Documentation for API Endpoints

All URIs are relative to *https://api.antenny.io*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*antenny.ClientApi* | [**createClient**](docs/ClientApi.md#createClient) | **POST** /clients | Creates a client
*antenny.ClientApi* | [**deleteClient**](docs/ClientApi.md#deleteClient) | **DELETE** /clients/{clientId} | Deletes a client
*antenny.ClientApi* | [**getClient**](docs/ClientApi.md#getClient) | **GET** /clients/{clientId} | Gets a client
*antenny.ClientApi* | [**listClients**](docs/ClientApi.md#listClients) | **GET** /customers/{custId}/clients | Gets a list of clients
*antenny.EventsApi* | [**listEvents**](docs/EventsApi.md#listEvents) | **GET** /subscriptions/{subId}/events | Gets a list of events for a subscription
*antenny.RegistrationApi* | [**getRegistration**](docs/RegistrationApi.md#getRegistration) | **GET** /customers/{custId}/registration | Gets a customers registration
*antenny.SubscriptionApi* | [**cancelSubscription**](docs/SubscriptionApi.md#cancelSubscription) | **PATCH** /subscriptions/{subId} | Cancels a subscription
*antenny.SubscriptionApi* | [**createSubscription**](docs/SubscriptionApi.md#createSubscription) | **POST** /subscriptions | Creates a subscription
*antenny.SubscriptionApi* | [**getSubscription**](docs/SubscriptionApi.md#getSubscription) | **GET** /subscriptions/{subId} | Gets a subscription
*antenny.SubscriptionApi* | [**listSubscriptions**](docs/SubscriptionApi.md#listSubscriptions) | **GET** /customers/{custId}/subscriptions | Gets a list of subscriptions


## Documentation for Models

 - [antenny.Client](docs/Client.md)
 - [antenny.ClientList](docs/ClientList.md)
 - [antenny.Endpoint](docs/Endpoint.md)
 - [antenny.Event](docs/Event.md)
 - [antenny.EventList](docs/EventList.md)
 - [antenny.InlineObject](docs/InlineObject.md)
 - [antenny.NewClient](docs/NewClient.md)
 - [antenny.NewSubscription](docs/NewSubscription.md)
 - [antenny.Registration](docs/Registration.md)
 - [antenny.Resource](docs/Resource.md)
 - [antenny.Subscription](docs/Subscription.md)
 - [antenny.SubscriptionList](docs/SubscriptionList.md)


## Documentation for Authorization

### ApiKeyAuth

- **Type**: API key
- **API key parameter name**: X-API-Key
- **Location**: HTTP header

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