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

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)

package/doc/interfaces/Facet.md

@@ -0,0 +1,74 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Facet
+
+# Interface: Facet
+
+**`Export`**
+
+**`Interface`**
+
+Facet
+
+## Table of contents
+
+### Properties
+
+- [children](Facet.md#children)
+- [displayName](Facet.md#displayname)
+- [id](Facet.md#id)
+- [name](Facet.md#name)
+
+## Properties
+
+### children
+
+• `Optional` **children**: [`Facet`](Facet.md)[]
+
+**`Memberof`**
+
+Facet
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1132](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1132)
+
+___
+
+### displayName
+
+• **displayName**: `string`
+
+**`Memberof`**
+
+Facet
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1126](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1126)
+
+___
+
+### id
+
+• **id**: `string`
+
+**`Memberof`**
+
+Facet
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1114](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1114)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+Facet
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1120](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1120)

package/doc/interfaces/InstantEmailTemplate.md

@@ -0,0 +1,149 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / InstantEmailTemplate
+
+# Interface: InstantEmailTemplate
+
+**`Export`**
+
+**`Interface`**
+
+InstantEmailTemplate
+
+## Table of contents
+
+### Properties
+
+- [body\_template](InstantEmailTemplate.md#body_template)
+- [body\_template\_id](InstantEmailTemplate.md#body_template_id)
+- [created](InstantEmailTemplate.md#created)
+- [event\_type](InstantEmailTemplate.md#event_type)
+- [event\_type\_id](InstantEmailTemplate.md#event_type_id)
+- [id](InstantEmailTemplate.md#id)
+- [subject\_template](InstantEmailTemplate.md#subject_template)
+- [subject\_template\_id](InstantEmailTemplate.md#subject_template_id)
+- [updated](InstantEmailTemplate.md#updated)
+
+## Properties
+
+### body\_template
+
+• `Optional` **body\_template**: [`AggregationEmailTemplateSubjectTemplate`](AggregationEmailTemplateSubjectTemplate.md)
+
+**`Memberof`**
+
+InstantEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1202](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1202)
+
+___
+
+### body\_template\_id
+
+• **body\_template\_id**: `string`
+
+**`Memberof`**
+
+InstantEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1208](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1208)
+
+___
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+InstantEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1160](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1160)
+
+___
+
+### event\_type
+
+• `Optional` **event\_type**: [`EventType`](EventType.md)
+
+**`Memberof`**
+
+InstantEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1178](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1178)
+
+___
+
+### event\_type\_id
+
+• `Optional` **event\_type\_id**: `string`
+
+**`Memberof`**
+
+InstantEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1184](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1184)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+InstantEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1172](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1172)
+
+___
+
+### subject\_template
+
+• `Optional` **subject\_template**: [`AggregationEmailTemplateSubjectTemplate`](AggregationEmailTemplateSubjectTemplate.md)
+
+**`Memberof`**
+
+InstantEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1190](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1190)
+
+___
+
+### subject\_template\_id
+
+• **subject\_template\_id**: `string`
+
+**`Memberof`**
+
+InstantEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1196](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1196)
+
+___
+
+### updated
+
+• `Optional` **updated**: `string`
+
+**`Memberof`**
+
+InstantEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1166](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1166)