@optare/[email protected]

This generator creates TypeScript/JavaScript client that utilizes 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)

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/[email protected] --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 | DELETE /api/v1/api-keys | Delete API key APIKeysApi | apiV1ApiKeysGet | GET /api/v1/api-keys | List API keys APIKeysApi | apiV1ApiKeysPost | POST /api/v1/api-keys | Create API key BillingApi | apiV1BillingConfigPut | PUT /api/v1/billing/config | Configure billing BillingApi | apiV1BillingPortalPost | POST /api/v1/billing/portal | Create billing portal session BillingApi | apiV1BillingProductsGet | GET /api/v1/billing/products | List billing products BillingApi | apiV1BillingSubscribePost | POST /api/v1/billing/subscribe | Create subscription checkout LicensesApi | apiV1LicensesCheckGet | GET /api/v1/licenses/check | Check feature access LicensesApi | apiV1LicensesEntitlementsGet | GET /api/v1/licenses/entitlements | List entitlements LicensesApi | apiV1LicensesGet | GET /api/v1/licenses | List licenses OAuthClientsApi | apiV1OauthClientsGet | GET /api/v1/oauth-clients | List OAuth clients OAuthClientsApi | apiV1OauthClientsPost | POST /api/v1/oauth-clients | Create OAuth client OrganizationsApi | apiV1OrganizationsGet | GET /api/v1/organizations | List organizations OrganizationsApi | apiV1OrganizationsIdDelete | DELETE /api/v1/organizations/{id} | Delete organization OrganizationsApi | apiV1OrganizationsIdGet | GET /api/v1/organizations/{id} | Get organization OrganizationsApi | apiV1OrganizationsIdInvitePost | POST /api/v1/organizations/{id}/invite | Invite user to organization OrganizationsApi | apiV1OrganizationsIdPatch | PATCH /api/v1/organizations/{id} | Update organization OrganizationsApi | apiV1OrganizationsPost | POST /api/v1/organizations | Create organization ProductsApi | apiV1ProductsGet | GET /api/v1/products | List products ProductsApi | apiV1ProductsIdDelete | DELETE /api/v1/products/{id} | Delete product ProductsApi | apiV1ProductsIdGet | GET /api/v1/products/{id} | Get product ProductsApi | apiV1ProductsIdPatch | PATCH /api/v1/products/{id} | Update product SubscriptionsApi | apiV1SubscriptionsGet | GET /api/v1/subscriptions | List subscriptions SubscriptionsApi | apiV1SubscriptionsPost | POST /api/v1/subscriptions | Create subscription UsersApi | apiV1UsersGet | GET /api/v1/users | List users UsersApi | apiV1UsersIdGet | GET /api/v1/users/{id} | Get user UsersApi | apiV1UsersMeDelete | DELETE /api/v1/users/me | Delete current user UsersApi | apiV1UsersMeGet | GET /api/v1/users/me | Get current user UsersApi | apiV1UsersMePatch | PATCH /api/v1/users/me | Update current user UsersApi | apiV1UsersPost | POST /api/v1/users | Create user WebhooksApi | apiV1WebhooksGet | GET /api/v1/webhooks | List webhooks WebhooksApi | apiV1WebhooksIdDelete | DELETE /api/v1/webhooks/{id} | Delete webhook WebhooksApi | apiV1WebhooksIdGet | GET /api/v1/webhooks/{id} | Get webhook WebhooksApi | apiV1WebhooksIdPatch | PATCH /api/v1/webhooks/{id} | Update webhook WebhooksApi | apiV1WebhooksPost | POST /api/v1/webhooks | Create webhook

Documentation For Models

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

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)