npm package: @optare/api-core
Description: OpenAPI client for @optare/api-core
Author: OpenAPI-Generator Contributors
Latest version: 1.0.0

## @optare/api-core@1.0.0

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 @optare/api-core@1.0.0 --save
```

_unPublished (not recommended):_

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

### Documentation for API Endpoints

All URIs are relative to *https://id.optare.one*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*APIKeysApi* | [**apiV1ApiKeysDelete**](docs/APIKeysApi.md#apiv1apikeysdelete) | **DELETE** /api/v1/api-keys | Delete API key
*APIKeysApi* | [**apiV1ApiKeysGet**](docs/APIKeysApi.md#apiv1apikeysget) | **GET** /api/v1/api-keys | List API keys
*APIKeysApi* | [**apiV1ApiKeysPost**](docs/APIKeysApi.md#apiv1apikeyspost) | **POST** /api/v1/api-keys | Create API key
*BillingApi* | [**apiV1BillingConfigPut**](docs/BillingApi.md#apiv1billingconfigput) | **PUT** /api/v1/billing/config | Configure billing
*BillingApi* | [**apiV1BillingPortalPost**](docs/BillingApi.md#apiv1billingportalpost) | **POST** /api/v1/billing/portal | Create billing portal session
*BillingApi* | [**apiV1BillingProductsGet**](docs/BillingApi.md#apiv1billingproductsget) | **GET** /api/v1/billing/products | List billing products
*BillingApi* | [**apiV1BillingSubscribePost**](docs/BillingApi.md#apiv1billingsubscribepost) | **POST** /api/v1/billing/subscribe | Create subscription checkout
*LicensesApi* | [**apiV1LicensesCheckGet**](docs/LicensesApi.md#apiv1licensescheckget) | **GET** /api/v1/licenses/check | Check feature access
*LicensesApi* | [**apiV1LicensesEntitlementsGet**](docs/LicensesApi.md#apiv1licensesentitlementsget) | **GET** /api/v1/licenses/entitlements | List entitlements
*LicensesApi* | [**apiV1LicensesGet**](docs/LicensesApi.md#apiv1licensesget) | **GET** /api/v1/licenses | List licenses
*OAuthClientsApi* | [**apiV1OauthClientsGet**](docs/OAuthClientsApi.md#apiv1oauthclientsget) | **GET** /api/v1/oauth-clients | List OAuth clients
*OAuthClientsApi* | [**apiV1OauthClientsPost**](docs/OAuthClientsApi.md#apiv1oauthclientspost) | **POST** /api/v1/oauth-clients | Create OAuth client
*OrganizationsApi* | [**apiV1OrganizationsGet**](docs/OrganizationsApi.md#apiv1organizationsget) | **GET** /api/v1/organizations | List organizations
*OrganizationsApi* | [**apiV1OrganizationsIdDelete**](docs/OrganizationsApi.md#apiv1organizationsiddelete) | **DELETE** /api/v1/organizations/{id} | Delete organization
*OrganizationsApi* | [**apiV1OrganizationsIdGet**](docs/OrganizationsApi.md#apiv1organizationsidget) | **GET** /api/v1/organizations/{id} | Get organization
*OrganizationsApi* | [**apiV1OrganizationsIdInvitePost**](docs/OrganizationsApi.md#apiv1organizationsidinvitepost) | **POST** /api/v1/organizations/{id}/invite | Invite user to organization
*OrganizationsApi* | [**apiV1OrganizationsIdPatch**](docs/OrganizationsApi.md#apiv1organizationsidpatch) | **PATCH** /api/v1/organizations/{id} | Update organization
*OrganizationsApi* | [**apiV1OrganizationsPost**](docs/OrganizationsApi.md#apiv1organizationspost) | **POST** /api/v1/organizations | Create organization
*ProductsApi* | [**apiV1ProductsGet**](docs/ProductsApi.md#apiv1productsget) | **GET** /api/v1/products | List products
*ProductsApi* | [**apiV1ProductsIdDelete**](docs/ProductsApi.md#apiv1productsiddelete) | **DELETE** /api/v1/products/{id} | Delete product
*ProductsApi* | [**apiV1ProductsIdGet**](docs/ProductsApi.md#apiv1productsidget) | **GET** /api/v1/products/{id} | Get product
*ProductsApi* | [**apiV1ProductsIdPatch**](docs/ProductsApi.md#apiv1productsidpatch) | **PATCH** /api/v1/products/{id} | Update product
*SubscriptionsApi* | [**apiV1SubscriptionsGet**](docs/SubscriptionsApi.md#apiv1subscriptionsget) | **GET** /api/v1/subscriptions | List subscriptions
*SubscriptionsApi* | [**apiV1SubscriptionsPost**](docs/SubscriptionsApi.md#apiv1subscriptionspost) | **POST** /api/v1/subscriptions | Create subscription
*UsersApi* | [**apiV1UsersGet**](docs/UsersApi.md#apiv1usersget) | **GET** /api/v1/users | List users
*UsersApi* | [**apiV1UsersIdGet**](docs/UsersApi.md#apiv1usersidget) | **GET** /api/v1/users/{id} | Get user
*UsersApi* | [**apiV1UsersMeDelete**](docs/UsersApi.md#apiv1usersmedelete) | **DELETE** /api/v1/users/me | Delete current user
*UsersApi* | [**apiV1UsersMeGet**](docs/UsersApi.md#apiv1usersmeget) | **GET** /api/v1/users/me | Get current user
*UsersApi* | [**apiV1UsersMePatch**](docs/UsersApi.md#apiv1usersmepatch) | **PATCH** /api/v1/users/me | Update current user
*UsersApi* | [**apiV1UsersPost**](docs/UsersApi.md#apiv1userspost) | **POST** /api/v1/users | Create user
*WebhooksApi* | [**apiV1WebhooksGet**](docs/WebhooksApi.md#apiv1webhooksget) | **GET** /api/v1/webhooks | List webhooks
*WebhooksApi* | [**apiV1WebhooksIdDelete**](docs/WebhooksApi.md#apiv1webhooksiddelete) | **DELETE** /api/v1/webhooks/{id} | Delete webhook
*WebhooksApi* | [**apiV1WebhooksIdGet**](docs/WebhooksApi.md#apiv1webhooksidget) | **GET** /api/v1/webhooks/{id} | Get webhook
*WebhooksApi* | [**apiV1WebhooksIdPatch**](docs/WebhooksApi.md#apiv1webhooksidpatch) | **PATCH** /api/v1/webhooks/{id} | Update webhook
*WebhooksApi* | [**apiV1WebhooksPost**](docs/WebhooksApi.md#apiv1webhookspost) | **POST** /api/v1/webhooks | Create webhook


### Documentation For Models

 - [ApiKey](docs/ApiKey.md)
 - [ApiV1ApiKeysGet200Response](docs/ApiV1ApiKeysGet200Response.md)
 - [ApiV1ApiKeysPost200Response](docs/ApiV1ApiKeysPost200Response.md)
 - [ApiV1BillingPortalPost200Response](docs/ApiV1BillingPortalPost200Response.md)
 - [ApiV1BillingProductsGet200Response](docs/ApiV1BillingProductsGet200Response.md)
 - [ApiV1BillingSubscribePost200Response](docs/ApiV1BillingSubscribePost200Response.md)
 - [ApiV1LicensesEntitlementsGet200Response](docs/ApiV1LicensesEntitlementsGet200Response.md)
 - [ApiV1LicensesGet200Response](docs/ApiV1LicensesGet200Response.md)
 - [ApiV1OauthClientsGet200Response](docs/ApiV1OauthClientsGet200Response.md)
 - [ApiV1OauthClientsPost201Response](docs/ApiV1OauthClientsPost201Response.md)
 - [ApiV1OrganizationsGet200Response](docs/ApiV1OrganizationsGet200Response.md)
 - [ApiV1OrganizationsIdInvitePost201Response](docs/ApiV1OrganizationsIdInvitePost201Response.md)
 - [ApiV1ProductsGet200Response](docs/ApiV1ProductsGet200Response.md)
 - [ApiV1ProductsIdGet200Response](docs/ApiV1ProductsIdGet200Response.md)
 - [ApiV1SubscriptionsGet200Response](docs/ApiV1SubscriptionsGet200Response.md)
 - [ApiV1UsersGet200Response](docs/ApiV1UsersGet200Response.md)
 - [ApiV1WebhooksGet200Response](docs/ApiV1WebhooksGet200Response.md)
 - [ApiV1WebhooksIdGet200Response](docs/ApiV1WebhooksIdGet200Response.md)
 - [ApiV1WebhooksPost201Response](docs/ApiV1WebhooksPost201Response.md)
 - [ApiV1WebhooksPost201ResponseWebhook](docs/ApiV1WebhooksPost201ResponseWebhook.md)
 - [BillingConfig](docs/BillingConfig.md)
 - [BillingPortalRequest](docs/BillingPortalRequest.md)
 - [BillingSubscribe](docs/BillingSubscribe.md)
 - [CreateApiKey](docs/CreateApiKey.md)
 - [CreateInvitation](docs/CreateInvitation.md)
 - [CreateOAuthClient](docs/CreateOAuthClient.md)
 - [CreateOrganization](docs/CreateOrganization.md)
 - [CreateSubscription](docs/CreateSubscription.md)
 - [CreateUser](docs/CreateUser.md)
 - [CreateWebhook](docs/CreateWebhook.md)
 - [Entitlement](docs/Entitlement.md)
 - [Invitation](docs/Invitation.md)
 - [License](docs/License.md)
 - [LicenseCheck](docs/LicenseCheck.md)
 - [ModelError](docs/ModelError.md)
 - [OAuthClient](docs/OAuthClient.md)
 - [Organization](docs/Organization.md)
 - [Pagination](docs/Pagination.md)
 - [Product](docs/Product.md)
 - [Subscription](docs/Subscription.md)
 - [Success](docs/Success.md)
 - [UpdateOrganization](docs/UpdateOrganization.md)
 - [UpdateProduct](docs/UpdateProduct.md)
 - [UpdateUser](docs/UpdateUser.md)
 - [UpdateUserImage](docs/UpdateUserImage.md)
 - [UpdateWebhook](docs/UpdateWebhook.md)
 - [User](docs/User.md)
 - [UserMetadata](docs/UserMetadata.md)
 - [Webhook](docs/Webhook.md)


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


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

- **Type**: Bearer authentication (JWT)