@redhat-cloud-services/notifications-client 1.0.102

package/doc/classes/configuration.md

@@ -0,0 +1,116 @@
+[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [Configuration](configuration.md)
+
+# Class: Configuration
+
+## Hierarchy
+
+* **Configuration**
+
+## Index
+
+### Constructors
+
+* [constructor](configuration.md#constructor)
+
+### Properties
+
+* [accessToken](configuration.md#optional-accesstoken)
+* [apiKey](configuration.md#optional-apikey)
+* [baseOptions](configuration.md#optional-baseoptions)
+* [basePath](configuration.md#optional-basepath)
+* [password](configuration.md#optional-password)
+* [username](configuration.md#optional-username)
+
+## Constructors
+
+###  constructor
+
+\+ **new Configuration**(`param`: [ConfigurationParameters](../interfaces/configurationparameters.md)): *[Configuration](configuration.md)*
+
+*Defined in [packages/hooks/configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/configuration.ts#L65)*
+
+**Parameters:**
+
+Name | Type | Default |
+------ | ------ | ------ |
+`param` | [ConfigurationParameters](../interfaces/configurationparameters.md) | {} |
+
+**Returns:** *[Configuration](configuration.md)*
+
+## Properties
+
+### `Optional` accessToken
+
+• **accessToken**? : *string | function*
+
+*Defined in [packages/hooks/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
+
+___
+
+### `Optional` apiKey
+
+• **apiKey**? : *string | function*
+
+*Defined in [packages/hooks/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
+
+___
+
+### `Optional` baseOptions
+
+• **baseOptions**? : *any*
+
+*Defined in [packages/hooks/configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/configuration.ts#L65)*
+
+base options for axios calls
+
+**`memberof`** Configuration
+
+___
+
+### `Optional` basePath
+
+• **basePath**? : *string*
+
+*Defined in [packages/hooks/configuration.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/configuration.ts#L58)*
+
+override base path
+
+**`memberof`** Configuration
+
+___
+
+### `Optional` password
+
+• **password**? : *string*
+
+*Defined in [packages/hooks/configuration.ts:44](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/configuration.ts#L44)*
+
+parameter for basic security
+
+**`memberof`** Configuration
+
+___
+
+### `Optional` username
+
+• **username**? : *string*
+
+*Defined in [packages/hooks/configuration.ts:37](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/configuration.ts#L37)*
+
+parameter for basic security
+
+**`memberof`** Configuration

package/doc/classes/endpointsapi.md

@@ -0,0 +1,229 @@
+[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [EndpointsApi](endpointsapi.md)
+
+# Class: EndpointsApi
+
+EndpointsApi - object-oriented interface
+
+**`export`** 
+
+## Hierarchy
+
+* [BaseAPI](baseapi.md)
+
+  ↳ **EndpointsApi**
+
+## Index
+
+### Constructors
+
+* [constructor](endpointsapi.md#constructor)
+
+### Properties
+
+* [axios](endpointsapi.md#protected-axios)
+* [basePath](endpointsapi.md#protected-basepath)
+* [configuration](endpointsapi.md#protected-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
+
+###  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 packages/hooks/base.ts:49
+
+**Parameters:**
+
+Name | Type | Default |
+------ | ------ | ------ |
+`configuration?` | [Configuration](configuration.md) | - |
+`basePath` | string | BASE_PATH |
+`axios` | AxiosInstance | globalAxios |
+
+**Returns:** *[EndpointsApi](endpointsapi.md)*
+
+## Properties
+
+### `Protected` axios
+
+• **axios**: *AxiosInstance*
+
+*Inherited from [BaseAPI](baseapi.md).[axios](baseapi.md#protected-axios)*
+
+Defined in packages/hooks/base.ts:51
+
+___
+
+### `Protected` basePath
+
+• **basePath**: *string*
+
+*Inherited from [BaseAPI](baseapi.md).[basePath](baseapi.md#protected-basepath)*
+
+Defined in packages/hooks/base.ts:51
+
+___
+
+### `Protected` configuration
+
+• **configuration**: *[Configuration](configuration.md) | undefined*
+
+*Inherited from [BaseAPI](baseapi.md).[configuration](baseapi.md#protected-configuration)*
+
+Defined in packages/hooks/base.ts:49
+
+## Methods
+
+###  endpointsCreate
+
+▸ **endpointsCreate**(`xRHIDENTITY`: string, `inlineObject1`: [InlineObject1](../interfaces/inlineobject1.md), `options?`: any): *AxiosPromise‹[InlineResponse201](../interfaces/inlineresponse201.md)›*
+
+*Defined in [packages/hooks/api.ts:1655](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1655)*
+
+Creates an endpoint
+
+**`throws`** {RequiredError}
+
+**`memberof`** EndpointsApi
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`xRHIDENTITY` | string |
+`inlineObject1` | [InlineObject1](../interfaces/inlineobject1.md) |
+`options?` | any |
+
+**Returns:** *AxiosPromise‹[InlineResponse201](../interfaces/inlineresponse201.md)›*
+
+___
+
+###  endpointsDestroy
+
+▸ **endpointsDestroy**(`xRHIDENTITY`: string, `id`: number, `options?`: any): *AxiosPromise‹void›*
+
+*Defined in [packages/hooks/api.ts:1667](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1667)*
+
+**`throws`** {RequiredError}
+
+**`memberof`** EndpointsApi
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`xRHIDENTITY` | string |
+`id` | number |
+`options?` | any |
+
+**Returns:** *AxiosPromise‹void›*
+
+___
+
+###  endpointsIndex
+
+▸ **endpointsIndex**(`xRHIDENTITY`: string, `order?`: string, `offset?`: number, `limit?`: number, `options?`: any): *AxiosPromise‹[InlineResponse2003](../interfaces/inlineresponse2003.md)›*
+
+*Defined in [packages/hooks/api.ts:1681](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1681)*
+
+List all endpoints
+
+**`throws`** {RequiredError}
+
+**`memberof`** EndpointsApi
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`xRHIDENTITY` | string |
+`order?` | string |
+`offset?` | number |
+`limit?` | number |
+`options?` | any |
+
+**Returns:** *AxiosPromise‹[InlineResponse2003](../interfaces/inlineresponse2003.md)›*
+
+___
+
+###  endpointsShow
+
+▸ **endpointsShow**(`xRHIDENTITY`: string, `id`: number, `options?`: any): *AxiosPromise‹[InlineResponse201](../interfaces/inlineresponse201.md)›*
+
+*Defined in [packages/hooks/api.ts:1693](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1693)*
+
+Shows the requested endpoint
+
+**`throws`** {RequiredError}
+
+**`memberof`** EndpointsApi
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`xRHIDENTITY` | string |
+`id` | number |
+`options?` | any |
+
+**Returns:** *AxiosPromise‹[InlineResponse201](../interfaces/inlineresponse201.md)›*
+
+___
+
+###  endpointsTest
+
+▸ **endpointsTest**(`xRHIDENTITY`: string, `id`: number, `options?`: any): *AxiosPromise‹void›*
+
+*Defined in [packages/hooks/api.ts:1705](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1705)*
+
+Send a test message to the endpoint
+
+**`throws`** {RequiredError}
+
+**`memberof`** EndpointsApi
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`xRHIDENTITY` | string |
+`id` | number |
+`options?` | any |
+
+**Returns:** *AxiosPromise‹void›*
+
+___
+
+###  endpointsUpdate
+
+▸ **endpointsUpdate**(`xRHIDENTITY`: string, `id`: number, `inlineObject2`: [InlineObject2](../interfaces/inlineobject2.md), `options?`: any): *AxiosPromise‹[InlineResponse201](../interfaces/inlineresponse201.md)›*
+
+*Defined in [packages/hooks/api.ts:1718](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1718)*
+
+Updates the requested endpoint
+
+**`throws`** {RequiredError}
+
+**`memberof`** EndpointsApi
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`xRHIDENTITY` | string |
+`id` | number |
+`inlineObject2` | [InlineObject2](../interfaces/inlineobject2.md) |
+`options?` | any |
+
+**Returns:** *AxiosPromise‹[InlineResponse201](../interfaces/inlineresponse201.md)›*

package/doc/classes/filtersapi.md

@@ -0,0 +1,103 @@
+[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [FiltersApi](filtersapi.md)
+
+# Class: FiltersApi
+
+FiltersApi - object-oriented interface
+
+**`export`** 
+
+## Hierarchy
+
+* [BaseAPI](baseapi.md)
+
+  ↳ **FiltersApi**
+
+## Index
+
+### Constructors
+
+* [constructor](filtersapi.md#constructor)
+
+### Properties
+
+* [axios](filtersapi.md#protected-axios)
+* [basePath](filtersapi.md#protected-basepath)
+* [configuration](filtersapi.md#protected-configuration)
+
+### Methods
+
+* [filtersShow](filtersapi.md#filtersshow)
+
+## Constructors
+
+###  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 packages/hooks/base.ts:49
+
+**Parameters:**
+
+Name | Type | Default |
+------ | ------ | ------ |
+`configuration?` | [Configuration](configuration.md) | - |
+`basePath` | string | BASE_PATH |
+`axios` | AxiosInstance | globalAxios |
+
+**Returns:** *[FiltersApi](filtersapi.md)*
+
+## Properties
+
+### `Protected` axios
+
+• **axios**: *AxiosInstance*
+
+*Inherited from [BaseAPI](baseapi.md).[axios](baseapi.md#protected-axios)*
+
+Defined in packages/hooks/base.ts:51
+
+___
+
+### `Protected` basePath
+
+• **basePath**: *string*
+
+*Inherited from [BaseAPI](baseapi.md).[basePath](baseapi.md#protected-basepath)*
+
+Defined in packages/hooks/base.ts:51
+
+___
+
+### `Protected` configuration
+
+• **configuration**: *[Configuration](configuration.md) | undefined*
+
+*Inherited from [BaseAPI](baseapi.md).[configuration](baseapi.md#protected-configuration)*
+
+Defined in packages/hooks/base.ts:49
+
+## Methods
+
+###  filtersShow
+
+▸ **filtersShow**(`xRHIDENTITY`: string, `endpointId`: number, `options?`: any): *AxiosPromise‹[InlineResponse2004](../interfaces/inlineresponse2004.md)›*
+
+*Defined in [packages/hooks/api.ts:1835](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1835)*
+
+Show the filter of the endpoint
+
+**`throws`** {RequiredError}
+
+**`memberof`** FiltersApi
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`xRHIDENTITY` | string |
+`endpointId` | number |
+`options?` | any |
+
+**Returns:** *AxiosPromise‹[InlineResponse2004](../interfaces/inlineresponse2004.md)›*

package/doc/classes/requirederror.md

@@ -0,0 +1,88 @@
+[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [RequiredError](requirederror.md)
+
+# Class: RequiredError
+
+**`export`** 
+
+## Hierarchy
+
+* [Error](requirederror.md#static-error)
+
+  ↳ **RequiredError**
+
+## Index
+
+### Constructors
+
+* [constructor](requirederror.md#constructor)
+
+### Properties
+
+* [field](requirederror.md#field)
+* [message](requirederror.md#message)
+* [name](requirederror.md#name)
+* [stack](requirederror.md#optional-stack)
+* [Error](requirederror.md#static-error)
+
+## Constructors
+
+###  constructor
+
+\+ **new RequiredError**(`field`: string, `msg?`: string): *[RequiredError](requirederror.md)*
+
+Defined in packages/hooks/base.ts:66
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`field` | string |
+`msg?` | string |
+
+**Returns:** *[RequiredError](requirederror.md)*
+
+## Properties
+
+###  field
+
+• **field**: *string*
+
+Defined in packages/hooks/base.ts:67
+
+___
+
+###  message
+
+• **message**: *string*
+
+*Inherited from [RequiredError](requirederror.md).[message](requirederror.md#message)*
+
+Defined in node_modules/typescript/lib/lib.es5.d.ts:974
+
+___
+
+###  name
+
+• **name**: *"RequiredError"* = "RequiredError"
+
+*Overrides void*
+
+Defined in packages/hooks/base.ts:66
+
+___
+
+### `Optional` stack
+
+• **stack**? : *string*
+
+*Inherited from [RequiredError](requirederror.md).[stack](requirederror.md#optional-stack)*
+
+Defined in node_modules/typescript/lib/lib.es5.d.ts:975
+
+___
+
+### `Static` Error
+
+▪ **Error**: *ErrorConstructor*
+
+Defined in node_modules/typescript/lib/lib.es5.d.ts:984

package/doc/enums/apptypeenum.md

@@ -0,0 +1,19 @@
+[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [AppTypeEnum](apptypeenum.md)
+
+# Enumeration: AppTypeEnum
+
+**`export`** 
+
+## Index
+
+### Enumeration members
+
+* [App](apptypeenum.md#app)
+
+## Enumeration members
+
+###  App
+
+• **App**: = "app"
+
+*Defined in [packages/hooks/api.ts:59](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L59)*

package/doc/enums/endpointattributeslastdeliverystatusenum.md

@@ -0,0 +1,28 @@
+[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [EndpointAttributesLastDeliveryStatusEnum](endpointattributeslastdeliverystatusenum.md)
+
+# Enumeration: EndpointAttributesLastDeliveryStatusEnum
+
+**`export`** 
+
+## Index
+
+### Enumeration members
+
+* [Failure](endpointattributeslastdeliverystatusenum.md#failure)
+* [Success](endpointattributeslastdeliverystatusenum.md#success)
+
+## Enumeration members
+
+###  Failure
+
+• **Failure**: = "failure"
+
+*Defined in [packages/hooks/api.ts:241](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L241)*
+
+___
+
+###  Success
+
+• **Success**: = "success"
+
+*Defined in [packages/hooks/api.ts:240](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L240)*

package/doc/enums/endpointtypeenum.md

@@ -0,0 +1,19 @@
+[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [EndpointTypeEnum](endpointtypeenum.md)
+
+# Enumeration: EndpointTypeEnum
+
+**`export`** 
+
+## Index
+
+### Enumeration members
+
+* [Endpoint](endpointtypeenum.md#endpoint)
+
+## Enumeration members
+
+###  Endpoint
+
+• **Endpoint**: = "endpoint"
+
+*Defined in [packages/hooks/api.ts:188](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L188)*

package/doc/enums/eventtypetypeenum.md

@@ -0,0 +1,19 @@
+[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [EventTypeTypeEnum](eventtypetypeenum.md)
+
+# Enumeration: EventTypeTypeEnum
+
+**`export`** 
+
+## Index
+
+### Enumeration members
+
+* [EventType](eventtypetypeenum.md#eventtype)
+
+## Enumeration members
+
+###  EventType
+
+• **EventType**: = "event_type"
+
+*Defined in [packages/hooks/api.ts:480](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L480)*

package/doc/enums/inlineresponse2004datatypeenum.md

@@ -0,0 +1,19 @@
+[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [InlineResponse2004DataTypeEnum](inlineresponse2004datatypeenum.md)
+
+# Enumeration: InlineResponse2004DataTypeEnum
+
+**`export`** 
+
+## Index
+
+### Enumeration members
+
+* [Filter](inlineresponse2004datatypeenum.md#filter)
+
+## Enumeration members
+
+###  Filter
+
+• **Filter**: = "filter"
+
+*Defined in [packages/hooks/api.ts:686](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L686)*

package/doc/enums/leveltypeenum.md

@@ -0,0 +1,19 @@
+[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [LevelTypeEnum](leveltypeenum.md)
+
+# Enumeration: LevelTypeEnum
+
+**`export`** 
+
+## Index
+
+### Enumeration members
+
+* [Level](leveltypeenum.md#level)
+
+## Enumeration members
+
+###  Level
+
+• **Level**: = "level"
+
+*Defined in [packages/hooks/api.ts:777](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L777)*