@redhat-cloud-services/notifications-client 2.2.4 → 2.3.0

package/doc/interfaces/EndpointPage.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / EndpointPage
+
+# Interface: EndpointPage
+
+**`Export`**
+
+**`Interface`**
+
+EndpointPage
+
+## Table of contents
+
+### Properties
+
+- [data](EndpointPage.md#data)
+- [links](EndpointPage.md#links)
+- [meta](EndpointPage.md#meta)
+
+## Properties
+
+### data
+
+• **data**: [`Endpoint`](Endpoint.md)[]
+
+**`Memberof`**
+
+EndpointPage
+
+#### Defined in
+
+[packages/notifications/types/index.ts:771](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L771)
+
+___
+
+### links
+
+• **links**: `Object`
+
+**`Memberof`**
+
+EndpointPage
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:777](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L777)
+
+___
+
+### meta
+
+• **meta**: [`Meta`](Meta.md)
+
+**`Memberof`**
+
+EndpointPage
+
+#### Defined in
+
+[packages/notifications/types/index.ts:783](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L783)

package/doc/interfaces/EndpointTestRequest.md

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

package/doc/interfaces/EventLogEntry.md

@@ -0,0 +1,119 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / EventLogEntry
+
+# Interface: EventLogEntry
+
+**`Export`**
+
+**`Interface`**
+
+EventLogEntry
+
+## Table of contents
+
+### Properties
+
+- [actions](EventLogEntry.md#actions)
+- [application](EventLogEntry.md#application)
+- [bundle](EventLogEntry.md#bundle)
+- [created](EventLogEntry.md#created)
+- [event\_type](EventLogEntry.md#event_type)
+- [id](EventLogEntry.md#id)
+- [payload](EventLogEntry.md#payload)
+
+## Properties
+
+### actions
+
+• **actions**: [`EventLogEntryAction`](EventLogEntryAction.md)[]
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[packages/notifications/types/index.ts:896](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L896)
+
+___
+
+### application
+
+• **application**: `string`
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[packages/notifications/types/index.ts:878](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L878)
+
+___
+
+### bundle
+
+• **bundle**: `string`
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[packages/notifications/types/index.ts:872](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L872)
+
+___
+
+### created
+
+• **created**: `string`
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[packages/notifications/types/index.ts:866](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L866)
+
+___
+
+### event\_type
+
+• **event\_type**: `string`
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[packages/notifications/types/index.ts:884](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L884)
+
+___
+
+### id
+
+• **id**: `string`
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[packages/notifications/types/index.ts:860](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L860)
+
+___
+
+### payload
+
+• `Optional` **payload**: `string`
+
+**`Memberof`**
+
+EventLogEntry
+
+#### Defined in
+
+[packages/notifications/types/index.ts:890](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L890)

package/doc/interfaces/EventLogEntryAction.md

@@ -0,0 +1,125 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / EventLogEntryAction
+
+# Interface: EventLogEntryAction
+
+**`Export`**
+
+**`Interface`**
+
+EventLogEntryAction
+
+## Table of contents
+
+### Properties
+
+- [details](EventLogEntryAction.md#details)
+- [endpoint\_id](EventLogEntryAction.md#endpoint_id)
+- [endpoint\_sub\_type](EventLogEntryAction.md#endpoint_sub_type)
+- [endpoint\_type](EventLogEntryAction.md#endpoint_type)
+- [id](EventLogEntryAction.md#id)
+- [invocation\_result](EventLogEntryAction.md#invocation_result)
+- [status](EventLogEntryAction.md#status)
+
+## Properties
+
+### details
+
+• `Optional` **details**: `Object`
+
+**`Memberof`**
+
+EventLogEntryAction
+
+#### Index signature
+
+▪ [key: `string`]: `any`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:946](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L946)
+
+___
+
+### endpoint\_id
+
+• `Optional` **endpoint\_id**: `string`
+
+**`Memberof`**
+
+EventLogEntryAction
+
+#### Defined in
+
+[packages/notifications/types/index.ts:940](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L940)
+
+___
+
+### endpoint\_sub\_type
+
+• `Optional` **endpoint\_sub\_type**: `string`
+
+**`Memberof`**
+
+EventLogEntryAction
+
+#### Defined in
+
+[packages/notifications/types/index.ts:921](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L921)
+
+___
+
+### endpoint\_type
+
+• **endpoint\_type**: [`EndpointType`](../enums/EndpointType.md)
+
+**`Memberof`**
+
+EventLogEntryAction
+
+#### Defined in
+
+[packages/notifications/types/index.ts:915](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L915)
+
+___
+
+### id
+
+• **id**: `string`
+
+**`Memberof`**
+
+EventLogEntryAction
+
+#### Defined in
+
+[packages/notifications/types/index.ts:909](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L909)
+
+___
+
+### invocation\_result
+
+• **invocation\_result**: `boolean`
+
+**`Memberof`**
+
+EventLogEntryAction
+
+**`Deprecated`**
+
+#### Defined in
+
+[packages/notifications/types/index.ts:928](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L928)
+
+___
+
+### status
+
+• **status**: [`EventLogEntryActionStatus`](../enums/EventLogEntryActionStatus.md)
+
+**`Memberof`**
+
+EventLogEntryAction
+
+#### Defined in
+
+[packages/notifications/types/index.ts:934](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L934)

package/doc/interfaces/EventType.md

@@ -0,0 +1,164 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / EventType
+
+# Interface: EventType
+
+**`Export`**
+
+**`Interface`**
+
+EventType
+
+## Table of contents
+
+### Properties
+
+- [application](EventType.md#application)
+- [application\_id](EventType.md#application_id)
+- [description](EventType.md#description)
+- [display\_name](EventType.md#display_name)
+- [fully\_qualified\_name](EventType.md#fully_qualified_name)
+- [id](EventType.md#id)
+- [name](EventType.md#name)
+- [not\_subscription\_locked\_or\_subscribed\_by\_default](EventType.md#not_subscription_locked_or_subscribed_by_default)
+- [subscribed\_by\_default](EventType.md#subscribed_by_default)
+- [subscription\_locked](EventType.md#subscription_locked)
+
+## Properties
+
+### application
+
+• `Optional` **application**: [`Application`](Application.md)
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1014](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1014)
+
+___
+
+### application\_id
+
+• **application\_id**: `string`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1008](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1008)
+
+___
+
+### description
+
+• `Optional` **description**: `string`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:996](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L996)
+
+___
+
+### display\_name
+
+• **display\_name**: `string`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:990](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L990)
+
+___
+
+### fully\_qualified\_name
+
+• `Optional` **fully\_qualified\_name**: `string`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1002](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1002)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:978](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L978)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:984](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L984)
+
+___
+
+### not\_subscription\_locked\_or\_subscribed\_by\_default
+
+• `Optional` **not\_subscription\_locked\_or\_subscribed\_by\_default**: `boolean`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1032](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1032)
+
+___
+
+### subscribed\_by\_default
+
+• `Optional` **subscribed\_by\_default**: `boolean`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1020](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1020)
+
+___
+
+### subscription\_locked
+
+• `Optional` **subscription\_locked**: `boolean`
+
+**`Memberof`**
+
+EventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1026](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1026)

package/doc/interfaces/EventTypeBehavior.md

@@ -0,0 +1,59 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / EventTypeBehavior
+
+# Interface: EventTypeBehavior
+
+**`Export`**
+
+**`Interface`**
+
+EventTypeBehavior
+
+## Table of contents
+
+### Properties
+
+- [created](EventTypeBehavior.md#created)
+- [event\_type](EventTypeBehavior.md#event_type)
+- [id](EventTypeBehavior.md#id)
+
+## Properties
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+EventTypeBehavior
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1045](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1045)
+
+___
+
+### event\_type
+
+• `Optional` **event\_type**: [`EventType`](EventType.md)
+
+**`Memberof`**
+
+EventTypeBehavior
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1057](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1057)
+
+___
+
+### id
+
+• `Optional` **id**: [`EventTypeBehaviorId`](EventTypeBehaviorId.md)
+
+**`Memberof`**
+
+EventTypeBehavior
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1051](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1051)

package/doc/interfaces/EventTypeBehaviorId.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / EventTypeBehaviorId
+
+# Interface: EventTypeBehaviorId
+
+**`Export`**
+
+**`Interface`**
+
+EventTypeBehaviorId
+
+## Table of contents
+
+### Properties
+
+- [behaviorGroupId](EventTypeBehaviorId.md#behaviorgroupid)
+- [eventTypeId](EventTypeBehaviorId.md#eventtypeid)
+
+## Properties
+
+### behaviorGroupId
+
+• **behaviorGroupId**: `string`
+
+**`Memberof`**
+
+EventTypeBehaviorId
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1076](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1076)
+
+___
+
+### eventTypeId
+
+• **eventTypeId**: `string`
+
+**`Memberof`**
+
+EventTypeBehaviorId
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1070](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1070)

package/doc/interfaces/EventTypeSettingsValue.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / EventTypeSettingsValue
+
+# Interface: EventTypeSettingsValue
+
+**`Export`**
+
+**`Interface`**
+
+EventTypeSettingsValue
+
+## Table of contents
+
+### Properties
+
+- [emailSubscriptionTypes](EventTypeSettingsValue.md#emailsubscriptiontypes)
+- [hasForcedEmail](EventTypeSettingsValue.md#hasforcedemail)
+- [subscriptionLocked](EventTypeSettingsValue.md#subscriptionlocked)
+
+## Properties
+
+### emailSubscriptionTypes
+
+• `Optional` **emailSubscriptionTypes**: `Object`
+
+**`Memberof`**
+
+EventTypeSettingsValue
+
+#### Index signature
+
+▪ [key: `string`]: `boolean`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1089](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1089)
+
+___
+
+### hasForcedEmail
+
+• `Optional` **hasForcedEmail**: `boolean`
+
+**`Memberof`**
+
+EventTypeSettingsValue
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1095](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1095)
+
+___
+
+### subscriptionLocked
+
+• `Optional` **subscriptionLocked**: `boolean`
+
+**`Memberof`**
+
+EventTypeSettingsValue
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1101](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1101)