@redhat-cloud-services/notifications-client 2.0.6 → 2.2.0

package/doc/README.md

@@ -1,61 +0,0 @@
-@redhat-cloud-services/notifications-client / [Exports](modules.md)
-
-# Javascript client for Notifications API
-If you want to use [RedHatInsights/notifications-backend](https://github.com/RedHatInsights/notifications-backend) you shouldn't use get requests directly, but rather use this client to integrate with this service.
-
-## Install
-NPM
-```bash
-npm install --save @redhat-cloud-services/notifications-client
-```
-
-Or Yarn
-```bash
-yarn add @redhat-cloud-services/notifications-client
-```
-
-### Usage
-This client is using typescript and axios. Types are distributed with this package, so no need to define or install them separately.
-
-To correctly bootstrap this API you should use this config (no need to define it multiple times, just one config and reimport it anywhere you want to use it).
-```JS
-// api.js
-import axios from 'axios';
-import { NotificationsApi } from '@redhat-cloud-services/notifications-client';
-const instance = axios.create();
-
-// BASE_PATH should be set in your constants file
-const notificationsApi = new NotificationsApi(undefined, BASE_PATH, instance);
-export notificationsApi;
-```
-
-If you want to add some interceptors you can use axios build in interceptors
-```JS
-// api.js
-import axios from 'axios';
-import { NotificationsApi } from '@redhat-cloud-services/notifications-client';
-const instance = axios.create();
-
-// Request interceptor
-instance.interceptors.request.use((request) => {
-    // some logic to do with request
-});
-
-// Response interceptor
-instance.interceptors.response.use((response) => {
-    // some logic to do with request
-});
-
-// Error interceptor
-instance.interceptors.response.use(null, (error) => {
-    // some logic to do with error
-});
-
-// BASE_PATH should be set in your constants file
-const notificationsApi = new NotificationsApi(undefined, BASE_PATH, instance);
-export notificationsApi;
-```
-
-## API documentation
-
-* [README](doc/README.md)

package/doc/classes/BaseAPI.md

@@ -1,125 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / BaseAPI
-
-# Class: BaseAPI
-
-Base API to store config, basepath and axios instance.
-
-**`Export`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](BaseAPI.md#constructor)
-
-### Properties
-
-- [axios](BaseAPI.md#axios)
-- [basePath](BaseAPI.md#basepath)
-- [configuration](BaseAPI.md#configuration)
-
-### Methods
-
-- [authConfig](BaseAPI.md#authconfig)
-- [sendRequest](BaseAPI.md#sendrequest)
-
-## Constructors
-
-### constructor
-
-• **new BaseAPI**(`basePath?`, `config?`)
-
-Constructor to create baseAPI.
-
-#### Parameters
-
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `basePath` | `string` | `BASE_PATH` | basePath of api requests. |
-| `config` | [`ApiConfig`](../interfaces/ApiConfig.md) | `undefined` | to be passed down to axios. |
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:70](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/base.ts#L70)
-
-## Properties
-
-### axios
-
-• `Protected` **axios**: `AxiosInstance`
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:64](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/base.ts#L64)
-
-___
-
-### basePath
-
-• `Protected` **basePath**: `string` = `BASE_PATH`
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:70](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/base.ts#L70)
-
-___
-
-### configuration
-
-• `Protected` **configuration**: [`Configuration`](Configuration.md)
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:63](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/base.ts#L63)
-
-## Methods
-
-### authConfig
-
-▸ `Private` **authConfig**(`__namedParameters`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `__namedParameters` | `Omit`<[`RequestArgs`](../interfaces/RequestArgs.md), ``"authType"`` \| ``"authKey"``\> & { `authKey?`: `string` \| [`string`, `string`[]] ; `authType`: [`AuthTypeEnum`](../modules.md#authtypeenum-1)  } |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:83](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/base.ts#L83)
-
-___
-
-### sendRequest
-
-▸ **sendRequest**<`T`\>(`request`, `axios?`, `basePath?`): `Promise`<`AxiosResponse`<`T`, `any`\>\>
-
-Send axios request
-
-#### Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `request` | `Promise`<[`RequestArgs`](../interfaces/RequestArgs.md)\> | to be send trough axios. |
-| `axios?` | `AxiosInstance` | optional axios instance. |
-| `basePath?` | `string` | - |
-
-#### Returns
-
-`Promise`<`AxiosResponse`<`T`, `any`\>\>
-
-promisable axios response.
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:111](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/base.ts#L111)

package/doc/classes/Configuration.md

@@ -1,194 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Configuration
-
-# Class: Configuration
-
-## Table of contents
-
-### Constructors
-
-- [constructor](Configuration.md#constructor)
-
-### Properties
-
-- [accessToken](Configuration.md#accesstoken)
-- [apiKey](Configuration.md#apikey)
-- [baseOptions](Configuration.md#baseoptions)
-- [basePath](Configuration.md#basepath)
-- [formDataCtor](Configuration.md#formdatactor)
-- [password](Configuration.md#password)
-- [username](Configuration.md#username)
-
-### Methods
-
-- [isJsonMime](Configuration.md#isjsonmime)
-
-## Constructors
-
-### constructor
-
-• **new Configuration**(`param?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `param` | [`ConfigurationParameters`](../interfaces/ConfigurationParameters.md) |
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:65](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L65)
-
-## Properties
-
-### accessToken
-
-• `Optional` **accessToken**: `string` \| `Promise`<`string`\> \| (`name?`: `string`, `scopes?`: `string`[]) => `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `Promise`<`string`\>
-
-parameter for oauth2 security
-
-**`Param`**
-
-security name
-
-**`Param`**
-
-oauth2 scope
-
-**`Memberof`**
-
-Configuration
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:41](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L41)
-
-___
-
-### apiKey
-
-• `Optional` **apiKey**: `string` \| `Promise`<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`<`string`\>
-
-parameter for apiKey security
-
-**`Param`**
-
-security name
-
-**`Memberof`**
-
-Configuration
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:20](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L20)
-
-___
-
-### baseOptions
-
-• `Optional` **baseOptions**: `any`
-
-base options for axios calls
-
-**`Memberof`**
-
-Configuration
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:55](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L55)
-
-___
-
-### basePath
-
-• `Optional` **basePath**: `string`
-
-override base path
-
-**`Memberof`**
-
-Configuration
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:48](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L48)
-
-___
-
-### formDataCtor
-
-• `Optional` **formDataCtor**: () => `any`
-
-#### Type declaration
-
-• **new Configuration**()
-
-The FormData constructor that will be used to create multipart form data
-requests. You can inject this here so that execution environments that
-do not support the FormData class can still run the generated client.
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:63](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L63)
-
-___
-
-### password
-
-• `Optional` **password**: `string`
-
-parameter for basic security
-
-**`Memberof`**
-
-Configuration
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:34](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L34)
-
-___
-
-### username
-
-• `Optional` **username**: `string`
-
-parameter for basic security
-
-**`Memberof`**
-
-Configuration
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:27](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L27)
-
-## Methods
-
-### isJsonMime
-
-▸ **isJsonMime**(`mime`): `boolean`
-
-Check if the given MIME is a JSON MIME.
-JSON MIME examples:
-  application/json
-  application/json; charset=UTF8
-  APPLICATION/JSON
-  application/vnd.company+json
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `mime` | `string` | MIME (Multipurpose Internet Mail Extensions) |
-
-#### Returns
-
-`boolean`
-
-True if the given MIME is JSON, false otherwise.
-
-#### Defined in
-
-[packages/notifications/utils/configuration.ts:85](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L85)

package/doc/classes/RequiredError.md

@@ -1,179 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / RequiredError
-
-# Class: RequiredError
-
-**`Export`**
-
-## Hierarchy
-
-- `Error`
-
-  ↳ **`RequiredError`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](RequiredError.md#constructor)
-
-### Properties
-
-- [field](RequiredError.md#field)
-- [message](RequiredError.md#message)
-- [name](RequiredError.md#name)
-- [stack](RequiredError.md#stack)
-- [prepareStackTrace](RequiredError.md#preparestacktrace)
-- [stackTraceLimit](RequiredError.md#stacktracelimit)
-
-### Methods
-
-- [captureStackTrace](RequiredError.md#capturestacktrace)
-
-## Constructors
-
-### constructor
-
-• **new RequiredError**(`field`, `msg?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `field` | `string` |
-| `msg?` | `string` |
-
-#### Overrides
-
-Error.constructor
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:167](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/base.ts#L167)
-
-## Properties
-
-### field
-
-• **field**: `string`
-
-#### Defined in
-
-[packages/notifications/utils/base.ts:167](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/utils/base.ts#L167)
-
-___
-
-### message
-
-• **message**: `string`
-
-#### Inherited from
-
-Error.message
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1041
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-Error.name
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1040
-
-___
-
-### stack
-
-• `Optional` **stack**: `string`
-
-#### Inherited from
-
-Error.stack
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1042
-
-___
-
-### prepareStackTrace
-
-▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
-
-#### Type declaration
-
-▸ (`err`, `stackTraces`): `any`
-
-Optional override for formatting stack traces
-
-**`See`**
-
-https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `err` | `Error` |
-| `stackTraces` | `CallSite`[] |
-
-##### Returns
-
-`any`
-
-#### Inherited from
-
-Error.prepareStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:115
-
-___
-
-### stackTraceLimit
-
-▪ `Static` **stackTraceLimit**: `number`
-
-#### Inherited from
-
-Error.stackTraceLimit
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:117
-
-## Methods
-
-### captureStackTrace
-
-▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `targetObject` | `object` |
-| `constructorOpt?` | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-Error.captureStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:108

package/doc/enums/EndpointStatus.md

@@ -1,76 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / EndpointStatus
-
-# Enumeration: EndpointStatus
-
-**`Export`**
-
-## Table of contents
-
-### Enumeration Members
-
-- [Deleting](EndpointStatus.md#deleting)
-- [Failed](EndpointStatus.md#failed)
-- [New](EndpointStatus.md#new)
-- [Provisioning](EndpointStatus.md#provisioning)
-- [Ready](EndpointStatus.md#ready)
-- [Unknown](EndpointStatus.md#unknown)
-
-## Enumeration Members
-
-### Deleting
-
-• **Deleting** = ``"DELETING"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:747](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/types/index.ts#L747)
-
-___
-
-### Failed
-
-• **Failed** = ``"FAILED"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:748](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/types/index.ts#L748)
-
-___
-
-### New
-
-• **New** = ``"NEW"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:745](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/types/index.ts#L745)
-
-___
-
-### Provisioning
-
-• **Provisioning** = ``"PROVISIONING"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:746](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/types/index.ts#L746)
-
-___
-
-### Ready
-
-• **Ready** = ``"READY"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:743](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/types/index.ts#L743)
-
-___
-
-### Unknown
-
-• **Unknown** = ``"UNKNOWN"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:744](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/types/index.ts#L744)

package/doc/enums/EndpointType.md

@@ -1,65 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / EndpointType
-
-# Enumeration: EndpointType
-
-**`Export`**
-
-## Table of contents
-
-### Enumeration Members
-
-- [Ansible](EndpointType.md#ansible)
-- [Camel](EndpointType.md#camel)
-- [Drawer](EndpointType.md#drawer)
-- [EmailSubscription](EndpointType.md#emailsubscription)
-- [Webhook](EndpointType.md#webhook)
-
-## Enumeration Members
-
-### Ansible
-
-• **Ansible** = ``"ansible"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:777](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/types/index.ts#L777)
-
-___
-
-### Camel
-
-• **Camel** = ``"camel"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:776](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/types/index.ts#L776)
-
-___
-
-### Drawer
-
-• **Drawer** = ``"drawer"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:778](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/types/index.ts#L778)
-
-___
-
-### EmailSubscription
-
-• **EmailSubscription** = ``"email_subscription"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:775](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/types/index.ts#L775)
-
-___
-
-### Webhook
-
-• **Webhook** = ``"webhook"``
-
-#### Defined in
-
-[packages/notifications/types/index.ts:774](https://github.com/mkholjuraev/javascript-clients/blob/master/packages/notifications/types/index.ts#L774)