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

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)

package/doc/interfaces/InternalApplicationUserPermission.md

@@ -0,0 +1,59 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / InternalApplicationUserPermission
+
+# Interface: InternalApplicationUserPermission
+
+**`Export`**
+
+**`Interface`**
+
+InternalApplicationUserPermission
+
+## Table of contents
+
+### Properties
+
+- [application\_display\_name](InternalApplicationUserPermission.md#application_display_name)
+- [application\_id](InternalApplicationUserPermission.md#application_id)
+- [role](InternalApplicationUserPermission.md#role)
+
+## Properties
+
+### application\_display\_name
+
+• **application\_display\_name**: `string`
+
+**`Memberof`**
+
+InternalApplicationUserPermission
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1227](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1227)
+
+___
+
+### application\_id
+
+• **application\_id**: `string`
+
+**`Memberof`**
+
+InternalApplicationUserPermission
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1221](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1221)
+
+___
+
+### role
+
+• **role**: `string`
+
+**`Memberof`**
+
+InternalApplicationUserPermission
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1233](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1233)

package/doc/interfaces/InternalRoleAccess.md

@@ -0,0 +1,59 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / InternalRoleAccess
+
+# Interface: InternalRoleAccess
+
+**`Export`**
+
+**`Interface`**
+
+InternalRoleAccess
+
+## Table of contents
+
+### Properties
+
+- [application\_id](InternalRoleAccess.md#application_id)
+- [id](InternalRoleAccess.md#id)
+- [role](InternalRoleAccess.md#role)
+
+## Properties
+
+### application\_id
+
+• **application\_id**: `string`
+
+**`Memberof`**
+
+InternalRoleAccess
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1258](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1258)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+InternalRoleAccess
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1246](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1246)
+
+___
+
+### role
+
+• **role**: `string`
+
+**`Memberof`**
+
+InternalRoleAccess
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1252](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1252)

package/doc/interfaces/InternalUserPermissions.md

@@ -0,0 +1,59 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / InternalUserPermissions
+
+# Interface: InternalUserPermissions
+
+**`Export`**
+
+**`Interface`**
+
+InternalUserPermissions
+
+## Table of contents
+
+### Properties
+
+- [applications](InternalUserPermissions.md#applications)
+- [is\_admin](InternalUserPermissions.md#is_admin)
+- [roles](InternalUserPermissions.md#roles)
+
+## Properties
+
+### applications
+
+• **applications**: [`Application1`](Application1.md)[]
+
+**`Memberof`**
+
+InternalUserPermissions
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1277](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1277)
+
+___
+
+### is\_admin
+
+• **is\_admin**: `boolean`
+
+**`Memberof`**
+
+InternalUserPermissions
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1271](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1271)
+
+___
+
+### roles
+
+• **roles**: `string`[]
+
+**`Memberof`**
+
+InternalUserPermissions
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1283](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1283)

package/doc/interfaces/MessageValidationResponse.md

@@ -0,0 +1,33 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / MessageValidationResponse
+
+# Interface: MessageValidationResponse
+
+**`Export`**
+
+**`Interface`**
+
+MessageValidationResponse
+
+## Table of contents
+
+### Properties
+
+- [errors](MessageValidationResponse.md#errors)
+
+## Properties
+
+### errors
+
+• **errors**: `Object`
+
+**`Memberof`**
+
+MessageValidationResponse
+
+#### Index signature
+
+▪ [key: `string`]: `string`[]
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1296](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1296)

package/doc/interfaces/Meta.md

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

package/doc/interfaces/NotificationHistory.md

@@ -0,0 +1,155 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / NotificationHistory
+
+# Interface: NotificationHistory
+
+**`Export`**
+
+**`Interface`**
+
+NotificationHistory
+
+## Table of contents
+
+### Properties
+
+- [created](NotificationHistory.md#created)
+- [details](NotificationHistory.md#details)
+- [endpointId](NotificationHistory.md#endpointid)
+- [endpointSubType](NotificationHistory.md#endpointsubtype)
+- [endpointType](NotificationHistory.md#endpointtype)
+- [id](NotificationHistory.md#id)
+- [invocationResult](NotificationHistory.md#invocationresult)
+- [invocationTime](NotificationHistory.md#invocationtime)
+- [status](NotificationHistory.md#status)
+
+## Properties
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1322](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1322)
+
+___
+
+### details
+
+• `Optional` **details**: `Object`
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Index signature
+
+▪ [key: `string`]: `any`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1359](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1359)
+
+___
+
+### endpointId
+
+• `Optional` **endpointId**: `string`
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1353](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1353)
+
+___
+
+### endpointSubType
+
+• `Optional` **endpointSubType**: `string`
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1371](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1371)
+
+___
+
+### endpointType
+
+• `Optional` **endpointType**: [`EndpointType`](../enums/EndpointType.md)
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1365](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1365)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1328](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1328)
+
+___
+
+### invocationResult
+
+• **invocationResult**: `boolean`
+
+**`Memberof`**
+
+NotificationHistory
+
+**`Deprecated`**
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1341](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1341)
+
+___
+
+### invocationTime
+
+• **invocationTime**: `number`
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1334](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1334)
+
+___
+
+### status
+
+• **status**: [`NotificationStatus`](../enums/NotificationStatus.md)
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1347](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1347)

package/doc/interfaces/PageBehaviorGroup.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / PageBehaviorGroup
+
+# Interface: PageBehaviorGroup
+
+**`Export`**
+
+**`Interface`**
+
+PageBehaviorGroup
+
+## Table of contents
+
+### Properties
+
+- [data](PageBehaviorGroup.md#data)
+- [links](PageBehaviorGroup.md#links)
+- [meta](PageBehaviorGroup.md#meta)
+
+## Properties
+
+### data
+
+• **data**: [`BehaviorGroup`](BehaviorGroup.md)[]
+
+**`Memberof`**
+
+PageBehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1403](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1403)
+
+___
+
+### links
+
+• **links**: `Object`
+
+**`Memberof`**
+
+PageBehaviorGroup
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1409](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1409)
+
+___
+
+### meta
+
+• **meta**: [`Meta`](Meta.md)
+
+**`Memberof`**
+
+PageBehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1415](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1415)