@redhat-cloud-services/notifications-client 0.0.40 → 1.0.0

package/doc/classes/configuration.md

@@ -1,140 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) > [Configuration](../classes/configuration.md)
-
-# Class: Configuration
-
-## Hierarchy
-
-**Configuration**
-
-## Index
-
-### Constructors
-
-* [constructor](configuration.md#constructor)
-
-### Properties
-
-* [accessToken](configuration.md#accesstoken)
-* [apiKey](configuration.md#apikey)
-* [baseOptions](configuration.md#baseoptions)
-* [basePath](configuration.md#basepath)
-* [password](configuration.md#password)
-* [username](configuration.md#username)
-
----
-
-## Constructors
-
-<a id="constructor"></a>
-
-###  constructor
-
-⊕ **new Configuration**(param?: *[ConfigurationParameters](../interfaces/configurationparameters.md)*): [Configuration](configuration.md)
-
-*Defined in [configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/configuration.ts#L65)*
-
-**Parameters:**
-
-| Name | Type | Default value |
-| ------ | ------ | ------ |
-| `Default value` param | [ConfigurationParameters](../interfaces/configurationparameters.md) |  {} |
-
-**Returns:** [Configuration](configuration.md)
-
-___
-
-## Properties
-
-<a id="accesstoken"></a>
-
-### `<Optional>` accessToken
-
-**● accessToken**: *`string` \| `function`*
-
-*Defined in [configuration.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/configuration.ts#L51)*
-
-parameter for oauth2 security
-
-*__param__*: security name
-
-*__param__*: oauth2 scope
-
-*__memberof__*: Configuration
-
-___
-<a id="apikey"></a>
-
-### `<Optional>` apiKey
-
-**● apiKey**: *`string` \| `function`*
-
-*Defined in [configuration.ts:30](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/configuration.ts#L30)*
-
-parameter for apiKey security
-
-*__param__*: security name
-
-*__memberof__*: Configuration
-
-___
-<a id="baseoptions"></a>
-
-### `<Optional>` baseOptions
-
-**● baseOptions**: *`any`*
-
-*Defined in [configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/configuration.ts#L65)*
-
-base options for axios calls
-
-*__type__*: {any}
-
-*__memberof__*: Configuration
-
-___
-<a id="basepath"></a>
-
-### `<Optional>` basePath
-
-**● basePath**: *`string`*
-
-*Defined in [configuration.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/configuration.ts#L58)*
-
-override base path
-
-*__type__*: {string}
-
-*__memberof__*: Configuration
-
-___
-<a id="password"></a>
-
-### `<Optional>` password
-
-**● password**: *`string`*
-
-*Defined in [configuration.ts:44](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/configuration.ts#L44)*
-
-parameter for basic security
-
-*__type__*: {string}
-
-*__memberof__*: Configuration
-
-___
-<a id="username"></a>
-
-### `<Optional>` username
-
-**● username**: *`string`*
-
-*Defined in [configuration.ts:37](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/configuration.ts#L37)*
-
-parameter for basic security
-
-*__type__*: {string}
-
-*__memberof__*: Configuration
-
-___
-

package/doc/classes/endpointsapi.md

@@ -1,255 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) > [EndpointsApi](../classes/endpointsapi.md)
-
-# Class: EndpointsApi
-
-EndpointsApi - object-oriented interface
-
-*__export__*: 
-
-*__class__*: EndpointsApi
-
-*__extends__*: {BaseAPI}
-
-## Hierarchy
-
- [BaseAPI](baseapi.md)
-
-**↳ EndpointsApi**
-
-## Index
-
-### Constructors
-
-* [constructor](endpointsapi.md#constructor)
-
-### Properties
-
-* [axios](endpointsapi.md#axios)
-* [basePath](endpointsapi.md#basepath)
-* [configuration](endpointsapi.md#configuration)
-
-### Methods
-
-* [endpointsCreate](endpointsapi.md#endpointscreate)
-* [endpointsDestroy](endpointsapi.md#endpointsdestroy)
-* [endpointsIndex](endpointsapi.md#endpointsindex)
-* [endpointsShow](endpointsapi.md#endpointsshow)
-* [endpointsTest](endpointsapi.md#endpointstest)
-* [endpointsUpdate](endpointsapi.md#endpointsupdate)
-
----
-
-## Constructors
-
-<a id="constructor"></a>
-
-###  constructor
-
-⊕ **new EndpointsApi**(configuration?: *[Configuration](configuration.md)*, basePath?: *`string`*, axios?: *`AxiosInstance`*): [EndpointsApi](endpointsapi.md)
-
-*Inherited from [BaseAPI](baseapi.md).[constructor](baseapi.md#constructor)*
-
-*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L49)*
-
-**Parameters:**
-
-| Name | Type | Default value |
-| ------ | ------ | ------ |
-| `Optional` configuration | [Configuration](configuration.md) | - |
-| `Default value` basePath | `string` |  BASE_PATH |
-| `Default value` axios | `AxiosInstance` |  globalAxios |
-
-**Returns:** [EndpointsApi](endpointsapi.md)
-
-___
-
-## Properties
-
-<a id="axios"></a>
-
-### `<Protected>` axios
-
-**● axios**: *`AxiosInstance`*
-
-*Inherited from [BaseAPI](baseapi.md).[axios](baseapi.md#axios)*
-
-*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L51)*
-
-___
-<a id="basepath"></a>
-
-### `<Protected>` basePath
-
-**● basePath**: *`string`*
-
-*Inherited from [BaseAPI](baseapi.md).[basePath](baseapi.md#basepath)*
-
-*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L51)*
-
-___
-<a id="configuration"></a>
-
-### `<Protected>` configuration
-
-**● configuration**: *[Configuration](configuration.md) \| `undefined`*
-
-*Inherited from [BaseAPI](baseapi.md).[configuration](baseapi.md#configuration)*
-
-*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L49)*
-
-___
-
-## Methods
-
-<a id="endpointscreate"></a>
-
-###  endpointsCreate
-
-▸ **endpointsCreate**(X_RH_IDENTITY: *`string`*, inlineObject1: *[InlineObject1](../interfaces/inlineobject1.md)*, options?: *`any`*): `AxiosPromise`<[InlineResponse201](../interfaces/inlineresponse201.md)>
-
-*Defined in [api.ts:1742](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1742)*
-
-Creates an endpoint
-
-*__throws__*: {RequiredError}
-
-*__memberof__*: EndpointsApi
-
-**Parameters:**
-
-| Name | Type | Description |
-| ------ | ------ | ------ |
-| X_RH_IDENTITY | `string` |  \- |
-| inlineObject1 | [InlineObject1](../interfaces/inlineobject1.md) |  \- |
-| `Optional` options | `any` |
-
-**Returns:** `AxiosPromise`<[InlineResponse201](../interfaces/inlineresponse201.md)>
-
-___
-<a id="endpointsdestroy"></a>
-
-###  endpointsDestroy
-
-▸ **endpointsDestroy**(X_RH_IDENTITY: *`string`*, id: *`number`*, options?: *`any`*): `AxiosPromise`<`Response`>
-
-*Defined in [api.ts:1754](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1754)*
-
-*__throws__*: {RequiredError}
-
-*__memberof__*: EndpointsApi
-
-**Parameters:**
-
-| Name | Type | Description |
-| ------ | ------ | ------ |
-| X_RH_IDENTITY | `string` |  \- |
-| id | `number` |  \- |
-| `Optional` options | `any` |
-
-**Returns:** `AxiosPromise`<`Response`>
-
-___
-<a id="endpointsindex"></a>
-
-###  endpointsIndex
-
-▸ **endpointsIndex**(X_RH_IDENTITY: *`string`*, order?: *`string`*, offset?: *`number`*, limit?: *`number`*, options?: *`any`*): `AxiosPromise`<[InlineResponse2003](../interfaces/inlineresponse2003.md)>
-
-*Defined in [api.ts:1768](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1768)*
-
-List all endpoints
-
-*__throws__*: {RequiredError}
-
-*__memberof__*: EndpointsApi
-
-**Parameters:**
-
-| Name | Type | Description |
-| ------ | ------ | ------ |
-| X_RH_IDENTITY | `string` |  \- |
-| `Optional` order | `string` |
-| `Optional` offset | `number` |
-| `Optional` limit | `number` |
-| `Optional` options | `any` |
-
-**Returns:** `AxiosPromise`<[InlineResponse2003](../interfaces/inlineresponse2003.md)>
-
-___
-<a id="endpointsshow"></a>
-
-###  endpointsShow
-
-▸ **endpointsShow**(X_RH_IDENTITY: *`string`*, id: *`number`*, options?: *`any`*): `AxiosPromise`<[InlineResponse201](../interfaces/inlineresponse201.md)>
-
-*Defined in [api.ts:1780](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1780)*
-
-Shows the requested endpoint
-
-*__throws__*: {RequiredError}
-
-*__memberof__*: EndpointsApi
-
-**Parameters:**
-
-| Name | Type | Description |
-| ------ | ------ | ------ |
-| X_RH_IDENTITY | `string` |  \- |
-| id | `number` |  \- |
-| `Optional` options | `any` |
-
-**Returns:** `AxiosPromise`<[InlineResponse201](../interfaces/inlineresponse201.md)>
-
-___
-<a id="endpointstest"></a>
-
-###  endpointsTest
-
-▸ **endpointsTest**(X_RH_IDENTITY: *`string`*, id: *`number`*, options?: *`any`*): `AxiosPromise`<`Response`>
-
-*Defined in [api.ts:1792](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1792)*
-
-Send a test message to the endpoint
-
-*__throws__*: {RequiredError}
-
-*__memberof__*: EndpointsApi
-
-**Parameters:**
-
-| Name | Type | Description |
-| ------ | ------ | ------ |
-| X_RH_IDENTITY | `string` |  \- |
-| id | `number` |  \- |
-| `Optional` options | `any` |
-
-**Returns:** `AxiosPromise`<`Response`>
-
-___
-<a id="endpointsupdate"></a>
-
-###  endpointsUpdate
-
-▸ **endpointsUpdate**(X_RH_IDENTITY: *`string`*, id: *`number`*, inlineObject2: *[InlineObject2](../interfaces/inlineobject2.md)*, options?: *`any`*): `AxiosPromise`<[InlineResponse201](../interfaces/inlineresponse201.md)>
-
-*Defined in [api.ts:1805](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1805)*
-
-Updates the requested endpoint
-
-*__throws__*: {RequiredError}
-
-*__memberof__*: EndpointsApi
-
-**Parameters:**
-
-| Name | Type | Description |
-| ------ | ------ | ------ |
-| X_RH_IDENTITY | `string` |  \- |
-| id | `number` |  \- |
-| inlineObject2 | [InlineObject2](../interfaces/inlineobject2.md) |  \- |
-| `Optional` options | `any` |
-
-**Returns:** `AxiosPromise`<[InlineResponse201](../interfaces/inlineresponse201.md)>
-
-___
-

package/doc/classes/filtersapi.md

@@ -1,124 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) > [FiltersApi](../classes/filtersapi.md)
-
-# Class: FiltersApi
-
-FiltersApi - object-oriented interface
-
-*__export__*: 
-
-*__class__*: FiltersApi
-
-*__extends__*: {BaseAPI}
-
-## Hierarchy
-
- [BaseAPI](baseapi.md)
-
-**↳ FiltersApi**
-
-## Index
-
-### Constructors
-
-* [constructor](filtersapi.md#constructor)
-
-### Properties
-
-* [axios](filtersapi.md#axios)
-* [basePath](filtersapi.md#basepath)
-* [configuration](filtersapi.md#configuration)
-
-### Methods
-
-* [filtersShow](filtersapi.md#filtersshow)
-
----
-
-## Constructors
-
-<a id="constructor"></a>
-
-###  constructor
-
-⊕ **new FiltersApi**(configuration?: *[Configuration](configuration.md)*, basePath?: *`string`*, axios?: *`AxiosInstance`*): [FiltersApi](filtersapi.md)
-
-*Inherited from [BaseAPI](baseapi.md).[constructor](baseapi.md#constructor)*
-
-*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L49)*
-
-**Parameters:**
-
-| Name | Type | Default value |
-| ------ | ------ | ------ |
-| `Optional` configuration | [Configuration](configuration.md) | - |
-| `Default value` basePath | `string` |  BASE_PATH |
-| `Default value` axios | `AxiosInstance` |  globalAxios |
-
-**Returns:** [FiltersApi](filtersapi.md)
-
-___
-
-## Properties
-
-<a id="axios"></a>
-
-### `<Protected>` axios
-
-**● axios**: *`AxiosInstance`*
-
-*Inherited from [BaseAPI](baseapi.md).[axios](baseapi.md#axios)*
-
-*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L51)*
-
-___
-<a id="basepath"></a>
-
-### `<Protected>` basePath
-
-**● basePath**: *`string`*
-
-*Inherited from [BaseAPI](baseapi.md).[basePath](baseapi.md#basepath)*
-
-*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L51)*
-
-___
-<a id="configuration"></a>
-
-### `<Protected>` configuration
-
-**● configuration**: *[Configuration](configuration.md) \| `undefined`*
-
-*Inherited from [BaseAPI](baseapi.md).[configuration](baseapi.md#configuration)*
-
-*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L49)*
-
-___
-
-## Methods
-
-<a id="filtersshow"></a>
-
-###  filtersShow
-
-▸ **filtersShow**(X_RH_IDENTITY: *`string`*, endpointId: *`number`*, options?: *`any`*): `AxiosPromise`<[InlineResponse2004](../interfaces/inlineresponse2004.md)>
-
-*Defined in [api.ts:1918](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1918)*
-
-Show the filter of the endpoint
-
-*__throws__*: {RequiredError}
-
-*__memberof__*: FiltersApi
-
-**Parameters:**
-
-| Name | Type | Description |
-| ------ | ------ | ------ |
-| X_RH_IDENTITY | `string` |  \- |
-| endpointId | `number` |  \- |
-| `Optional` options | `any` |
-
-**Returns:** `AxiosPromise`<[InlineResponse2004](../interfaces/inlineresponse2004.md)>
-
-___
-

package/doc/classes/requirederror.md

@@ -1,109 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) > [RequiredError](../classes/requirederror.md)
-
-# Class: RequiredError
-
-*__export__*: 
-
-*__class__*: RequiredError
-
-*__extends__*: {Error}
-
-## Hierarchy
-
- `Error`
-
-**↳ RequiredError**
-
-## Index
-
-### Constructors
-
-* [constructor](requirederror.md#constructor)
-
-### Properties
-
-* [field](requirederror.md#field)
-* [message](requirederror.md#message)
-* [name](requirederror.md#name)
-* [stack](requirederror.md#stack)
-* [Error](requirederror.md#error)
-
----
-
-## Constructors
-
-<a id="constructor"></a>
-
-###  constructor
-
-⊕ **new RequiredError**(field: *`string`*, msg?: *`string`*): [RequiredError](requirederror.md)
-
-*Defined in [api.ts:66](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L66)*
-
-**Parameters:**
-
-| Name | Type |
-| ------ | ------ |
-| field | `string` |
-| `Optional` msg | `string` |
-
-**Returns:** [RequiredError](requirederror.md)
-
-___
-
-## Properties
-
-<a id="field"></a>
-
-###  field
-
-**● field**: *`string`*
-
-*Defined in [api.ts:67](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L67)*
-
-___
-<a id="message"></a>
-
-###  message
-
-**● message**: *`string`*
-
-*Inherited from Error.message*
-
-*Defined in node_modules/typescript/lib/lib.es5.d.ts:974*
-
-___
-<a id="name"></a>
-
-###  name
-
-**● name**: *"RequiredError"* = "RequiredError"
-
-*Overrides Error.name*
-
-*Defined in [api.ts:66](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L66)*
-
-___
-<a id="stack"></a>
-
-### `<Optional>` stack
-
-**● stack**: *`string`*
-
-*Inherited from Error.stack*
-
-*Overrides Error.stack*
-
-*Defined in node_modules/typescript/lib/lib.es5.d.ts:975*
-
-___
-<a id="error"></a>
-
-### `<Static>` Error
-
-**● Error**: *`ErrorConstructor`*
-
-*Defined in node_modules/typescript/lib/lib.es5.d.ts:984*
-
-___
-

package/doc/enums/app.typeenum.md

@@ -1,28 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) > [App](../modules/app.md) > [TypeEnum](../enums/app.typeenum.md)
-
-# Enumeration: TypeEnum
-
-*__export__*: 
-
-*__enum__*: {string}
-
-## Index
-
-### Enumeration members
-
-* [App](app.typeenum.md#app)
-
----
-
-## Enumeration members
-
-<a id="app"></a>
-
-###  App
-
-**App**:  = "app"
-
-*Defined in [api.ts:114](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L114)*
-
-___
-

package/doc/enums/endpoint.typeenum.md

@@ -1,28 +0,0 @@
-[@redhat-cloud-services/notifications-client](../README.md) > [Endpoint](../modules/endpoint.md) > [TypeEnum](../enums/endpoint.typeenum.md)
-
-# Enumeration: TypeEnum
-
-*__export__*: 
-
-*__enum__*: {string}
-
-## Index
-
-### Enumeration members
-
-* [Endpoint](endpoint.typeenum.md#endpoint)
-
----
-
-## Enumeration members
-
-<a id="endpoint"></a>
-
-###  Endpoint
-
-**Endpoint**:  = "endpoint"
-
-*Defined in [api.ts:254](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L254)*
-
-___
-