@redhat-cloud-services/notifications-client 4.0.1 → 4.0.3

package/doc/interfaces/types.EndpointDTO.md

@@ -0,0 +1,179 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / EndpointDTO
+
+# Interface: EndpointDTO
+
+[types](../modules/types.md).EndpointDTO
+
+**`Export`**
+
+EndpointDTO
+
+## Table of contents
+
+### Properties
+
+- [created](types.EndpointDTO.md#created)
+- [description](types.EndpointDTO.md#description)
+- [enabled](types.EndpointDTO.md#enabled)
+- [id](types.EndpointDTO.md#id)
+- [name](types.EndpointDTO.md#name)
+- [properties](types.EndpointDTO.md#properties)
+- [server\_errors](types.EndpointDTO.md#server_errors)
+- [status](types.EndpointDTO.md#status)
+- [sub\_type](types.EndpointDTO.md#sub_type)
+- [type](types.EndpointDTO.md#type)
+- [updated](types.EndpointDTO.md#updated)
+
+## Properties
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+EndpointDTO
+
+#### Defined in
+
+[types/index.ts:807](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L807)
+
+___
+
+### description
+
+• **description**: `string`
+
+**`Memberof`**
+
+EndpointDTO
+
+#### Defined in
+
+[types/index.ts:771](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L771)
+
+___
+
+### enabled
+
+• `Optional` **enabled**: `boolean`
+
+**`Memberof`**
+
+EndpointDTO
+
+#### Defined in
+
+[types/index.ts:777](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L777)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+EndpointDTO
+
+#### Defined in
+
+[types/index.ts:759](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L759)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+EndpointDTO
+
+#### Defined in
+
+[types/index.ts:765](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L765)
+
+___
+
+### properties
+
+• `Optional` **properties**: `object`
+
+**`Memberof`**
+
+EndpointDTO
+
+#### Defined in
+
+[types/index.ts:819](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L819)
+
+___
+
+### server\_errors
+
+• `Optional` **server\_errors**: `number`
+
+**`Memberof`**
+
+EndpointDTO
+
+#### Defined in
+
+[types/index.ts:789](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L789)
+
+___
+
+### status
+
+• `Optional` **status**: [`EndpointStatusDTO`](../enums/types.EndpointStatusDTO.md)
+
+**`Memberof`**
+
+EndpointDTO
+
+#### Defined in
+
+[types/index.ts:783](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L783)
+
+___
+
+### sub\_type
+
+• `Optional` **sub\_type**: `string`
+
+**`Memberof`**
+
+EndpointDTO
+
+#### Defined in
+
+[types/index.ts:801](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L801)
+
+___
+
+### type
+
+• **type**: [`EndpointTypeDTO`](../enums/types.EndpointTypeDTO.md)
+
+**`Memberof`**
+
+EndpointDTO
+
+#### Defined in
+
+[types/index.ts:795](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L795)
+
+___
+
+### updated
+
+• `Optional` **updated**: `string`
+
+**`Memberof`**
+
+EndpointDTO
+
+#### Defined in
+
+[types/index.ts:813](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L813)

package/doc/interfaces/types.EndpointPage.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / EndpointPage
+
+# Interface: EndpointPage
+
+[types](../modules/types.md).EndpointPage
+
+**`Export`**
+
+EndpointPage
+
+## Table of contents
+
+### Properties
+
+- [data](types.EndpointPage.md#data)
+- [links](types.EndpointPage.md#links)
+- [meta](types.EndpointPage.md#meta)
+
+## Properties
+
+### data
+
+• **data**: [`EndpointDTO`](types.EndpointDTO.md)[]
+
+**`Memberof`**
+
+EndpointPage
+
+#### Defined in
+
+[types/index.ts:834](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L834)
+
+___
+
+### links
+
+• **links**: `Object`
+
+**`Memberof`**
+
+EndpointPage
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+#### Defined in
+
+[types/index.ts:840](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L840)
+
+___
+
+### meta
+
+• **meta**: [`Meta`](types.Meta.md)
+
+**`Memberof`**
+
+EndpointPage
+
+#### Defined in
+
+[types/index.ts:846](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L846)

package/doc/interfaces/types.EndpointTestRequest.md

@@ -0,0 +1,29 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / EndpointTestRequest
+
+# Interface: EndpointTestRequest
+
+[types](../modules/types.md).EndpointTestRequest
+
+**`Export`**
+
+EndpointTestRequest
+
+## Table of contents
+
+### Properties
+
+- [message](types.EndpointTestRequest.md#message)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+**`Memberof`**
+
+EndpointTestRequest
+
+#### Defined in
+
+[types/index.ts:895](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L895)

package/doc/interfaces/types.EventLogEntry.md

@@ -0,0 +1,119 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / EventLogEntry
+
+# Interface: EventLogEntry
+
+[types](../modules/types.md).EventLogEntry
+
+**`Export`**
+
+EventLogEntry
+
+## Table of contents
+
+### Properties
+
+- [actions](types.EventLogEntry.md#actions)
+- [application](types.EventLogEntry.md#application)
+- [bundle](types.EventLogEntry.md#bundle)
+- [created](types.EventLogEntry.md#created)
+- [event\_type](types.EventLogEntry.md#event_type)
+- [id](types.EventLogEntry.md#id)
+- [payload](types.EventLogEntry.md#payload)
+
+## Properties
+
+### actions
+
+• **actions**: [`EventLogEntryAction`](types.EventLogEntryAction.md)[]
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[types/index.ts:994](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L994)
+
+___
+
+### application
+
+• **application**: `string`
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[types/index.ts:976](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L976)
+
+___
+
+### bundle
+
+• **bundle**: `string`
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[types/index.ts:970](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L970)
+
+___
+
+### created
+
+• **created**: `string`
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[types/index.ts:964](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L964)
+
+___
+
+### event\_type
+
+• **event\_type**: `string`
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[types/index.ts:982](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L982)
+
+___
+
+### id
+
+• **id**: `string`
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[types/index.ts:958](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L958)
+
+___
+
+### payload
+
+• `Optional` **payload**: `string`
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[types/index.ts:988](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L988)

package/doc/interfaces/types.EventLogEntryAction.md

@@ -0,0 +1,125 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / EventLogEntryAction
+
+# Interface: EventLogEntryAction
+
+[types](../modules/types.md).EventLogEntryAction
+
+**`Export`**
+
+EventLogEntryAction
+
+## Table of contents
+
+### Properties
+
+- [details](types.EventLogEntryAction.md#details)
+- [endpoint\_id](types.EventLogEntryAction.md#endpoint_id)
+- [endpoint\_sub\_type](types.EventLogEntryAction.md#endpoint_sub_type)
+- [endpoint\_type](types.EventLogEntryAction.md#endpoint_type)
+- [id](types.EventLogEntryAction.md#id)
+- [invocation\_result](types.EventLogEntryAction.md#invocation_result)
+- [status](types.EventLogEntryAction.md#status)
+
+## Properties
+
+### details
+
+• `Optional` **details**: `Object`
+
+**`Memberof`**
+
+EventLogEntryAction
+
+#### Index signature
+
+▪ [key: `string`]: `any`
+
+#### Defined in
+
+[types/index.ts:1044](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1044)
+
+___
+
+### endpoint\_id
+
+• `Optional` **endpoint\_id**: `string`
+
+**`Memberof`**
+
+EventLogEntryAction
+
+#### Defined in
+
+[types/index.ts:1038](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1038)
+
+___
+
+### endpoint\_sub\_type
+
+• `Optional` **endpoint\_sub\_type**: `string`
+
+**`Memberof`**
+
+EventLogEntryAction
+
+#### Defined in
+
+[types/index.ts:1019](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1019)
+
+___
+
+### endpoint\_type
+
+• **endpoint\_type**: [`EndpointType`](../enums/types.EndpointType.md)
+
+**`Memberof`**
+
+EventLogEntryAction
+
+#### Defined in
+
+[types/index.ts:1013](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1013)
+
+___
+
+### id
+
+• **id**: `string`
+
+**`Memberof`**
+
+EventLogEntryAction
+
+#### Defined in
+
+[types/index.ts:1007](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1007)
+
+___
+
+### invocation\_result
+
+• **invocation\_result**: `boolean`
+
+**`Memberof`**
+
+EventLogEntryAction
+
+**`Deprecated`**
+
+#### Defined in
+
+[types/index.ts:1026](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1026)
+
+___
+
+### status
+
+• **status**: [`EventLogEntryActionStatus`](../enums/types.EventLogEntryActionStatus.md)
+
+**`Memberof`**
+
+EventLogEntryAction
+
+#### Defined in
+
+[types/index.ts:1032](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1032)

package/doc/interfaces/types.EventType.md

@@ -0,0 +1,179 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / EventType
+
+# Interface: EventType
+
+[types](../modules/types.md).EventType
+
+**`Export`**
+
+EventType
+
+## Table of contents
+
+### Properties
+
+- [application](types.EventType.md#application)
+- [application\_id](types.EventType.md#application_id)
+- [description](types.EventType.md#description)
+- [display\_name](types.EventType.md#display_name)
+- [fully\_qualified\_name](types.EventType.md#fully_qualified_name)
+- [id](types.EventType.md#id)
+- [name](types.EventType.md#name)
+- [not\_subscription\_locked\_or\_subscribed\_by\_default](types.EventType.md#not_subscription_locked_or_subscribed_by_default)
+- [subscribed\_by\_default](types.EventType.md#subscribed_by_default)
+- [subscription\_locked](types.EventType.md#subscription_locked)
+- [visible](types.EventType.md#visible)
+
+## Properties
+
+### application
+
+• `Optional` **application**: [`Application`](types.Application.md)
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[types/index.ts:1112](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1112)
+
+___
+
+### application\_id
+
+• **application\_id**: `string`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[types/index.ts:1106](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1106)
+
+___
+
+### description
+
+• `Optional` **description**: `string`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[types/index.ts:1094](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1094)
+
+___
+
+### display\_name
+
+• **display\_name**: `string`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[types/index.ts:1088](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1088)
+
+___
+
+### fully\_qualified\_name
+
+• `Optional` **fully\_qualified\_name**: `string`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[types/index.ts:1100](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1100)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[types/index.ts:1076](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1076)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[types/index.ts:1082](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1082)
+
+___
+
+### not\_subscription\_locked\_or\_subscribed\_by\_default
+
+• `Optional` **not\_subscription\_locked\_or\_subscribed\_by\_default**: `boolean`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[types/index.ts:1136](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1136)
+
+___
+
+### subscribed\_by\_default
+
+• `Optional` **subscribed\_by\_default**: `boolean`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[types/index.ts:1124](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1124)
+
+___
+
+### subscription\_locked
+
+• `Optional` **subscription\_locked**: `boolean`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[types/index.ts:1130](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1130)
+
+___
+
+### visible
+
+• `Optional` **visible**: `boolean`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[types/index.ts:1118](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1118)