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

package/doc/interfaces/PageDrawerEntryPayload.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / PageDrawerEntryPayload
+
+# Interface: PageDrawerEntryPayload
+
+**`Export`**
+
+**`Interface`**
+
+PageDrawerEntryPayload
+
+## Table of contents
+
+### Properties
+
+- [data](PageDrawerEntryPayload.md#data)
+- [links](PageDrawerEntryPayload.md#links)
+- [meta](PageDrawerEntryPayload.md#meta)
+
+## Properties
+
+### data
+
+• **data**: [`DrawerEntryPayload`](DrawerEntryPayload.md)[]
+
+**`Memberof`**
+
+PageDrawerEntryPayload
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1428](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1428)
+
+___
+
+### links
+
+• **links**: `Object`
+
+**`Memberof`**
+
+PageDrawerEntryPayload
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1434](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1434)
+
+___
+
+### meta
+
+• **meta**: [`Meta`](Meta.md)
+
+**`Memberof`**
+
+PageDrawerEntryPayload
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1440](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1440)

package/doc/interfaces/PageEventLogEntry.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / PageEventLogEntry
+
+# Interface: PageEventLogEntry
+
+**`Export`**
+
+**`Interface`**
+
+PageEventLogEntry
+
+## Table of contents
+
+### Properties
+
+- [data](PageEventLogEntry.md#data)
+- [links](PageEventLogEntry.md#links)
+- [meta](PageEventLogEntry.md#meta)
+
+## Properties
+
+### data
+
+• **data**: [`EventLogEntry`](EventLogEntry.md)[]
+
+**`Memberof`**
+
+PageEventLogEntry
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1453](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1453)
+
+___
+
+### links
+
+• **links**: `Object`
+
+**`Memberof`**
+
+PageEventLogEntry
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1459](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1459)
+
+___
+
+### meta
+
+• **meta**: [`Meta`](Meta.md)
+
+**`Memberof`**
+
+PageEventLogEntry
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1465](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1465)

package/doc/interfaces/PageEventType.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / PageEventType
+
+# Interface: PageEventType
+
+**`Export`**
+
+**`Interface`**
+
+PageEventType
+
+## Table of contents
+
+### Properties
+
+- [data](PageEventType.md#data)
+- [links](PageEventType.md#links)
+- [meta](PageEventType.md#meta)
+
+## Properties
+
+### data
+
+• **data**: [`EventType`](EventType.md)[]
+
+**`Memberof`**
+
+PageEventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1478](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1478)
+
+___
+
+### links
+
+• **links**: `Object`
+
+**`Memberof`**
+
+PageEventType
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1484](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1484)
+
+___
+
+### meta
+
+• **meta**: [`Meta`](Meta.md)
+
+**`Memberof`**
+
+PageEventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1490](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1490)

package/doc/interfaces/PageNotificationHistory.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / PageNotificationHistory
+
+# Interface: PageNotificationHistory
+
+**`Export`**
+
+**`Interface`**
+
+PageNotificationHistory
+
+## Table of contents
+
+### Properties
+
+- [data](PageNotificationHistory.md#data)
+- [links](PageNotificationHistory.md#links)
+- [meta](PageNotificationHistory.md#meta)
+
+## Properties
+
+### data
+
+• **data**: [`NotificationHistory`](NotificationHistory.md)[]
+
+**`Memberof`**
+
+PageNotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1503](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1503)
+
+___
+
+### links
+
+• **links**: `Object`
+
+**`Memberof`**
+
+PageNotificationHistory
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1509](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1509)
+
+___
+
+### meta
+
+• **meta**: [`Meta`](Meta.md)
+
+**`Memberof`**
+
+PageNotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1515](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1515)

package/doc/interfaces/RenderEmailTemplateRequest.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / RenderEmailTemplateRequest
+
+# Interface: RenderEmailTemplateRequest
+
+**`Export`**
+
+**`Interface`**
+
+RenderEmailTemplateRequest
+
+## Table of contents
+
+### Properties
+
+- [payload](RenderEmailTemplateRequest.md#payload)
+- [template](RenderEmailTemplateRequest.md#template)
+
+## Properties
+
+### payload
+
+• **payload**: `string`
+
+**`Memberof`**
+
+RenderEmailTemplateRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1534](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1534)
+
+___
+
+### template
+
+• **template**: `string`[]
+
+**`Memberof`**
+
+RenderEmailTemplateRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1528](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1528)

package/doc/interfaces/RequestArgs.md

@@ -0,0 +1,58 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / RequestArgs
+
+# Interface: RequestArgs
+
+**`Export`**
+
+**`Interface`**
+
+RequestArgs
+
+## Table of contents
+
+### Properties
+
+- [auth](RequestArgs.md#auth)
+- [options](RequestArgs.md#options)
+- [serializeData](RequestArgs.md#serializedata)
+- [urlObj](RequestArgs.md#urlobj)
+
+## Properties
+
+### auth
+
+• `Optional` **auth**: { `authKey?`: `string` \| [`string`, `string`[]] ; `authType`: [`AuthTypeEnum`](../modules.md#authtypeenum-1)  }[]
+
+#### Defined in
+
+[packages/notifications/utils/base.ts:33](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L33)
+
+___
+
+### options
+
+• **options**: `AxiosRequestConfig`<`any`\>
+
+#### Defined in
+
+[packages/notifications/utils/base.ts:32](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L32)
+
+___
+
+### serializeData
+
+• `Optional` **serializeData**: `unknown`
+
+#### Defined in
+
+[packages/notifications/utils/base.ts:37](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L37)
+
+___
+
+### urlObj
+
+• **urlObj**: `URL`
+
+#### Defined in
+
+[packages/notifications/utils/base.ts:31](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L31)

package/doc/interfaces/RequestDefaultBehaviorGroupPropertyList.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / RequestDefaultBehaviorGroupPropertyList
+
+# Interface: RequestDefaultBehaviorGroupPropertyList
+
+**`Export`**
+
+**`Interface`**
+
+RequestDefaultBehaviorGroupPropertyList
+
+## Table of contents
+
+### Properties
+
+- [ignore\_preferences](RequestDefaultBehaviorGroupPropertyList.md#ignore_preferences)
+- [only\_admins](RequestDefaultBehaviorGroupPropertyList.md#only_admins)
+
+## Properties
+
+### ignore\_preferences
+
+• **ignore\_preferences**: `boolean`
+
+**`Memberof`**
+
+RequestDefaultBehaviorGroupPropertyList
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1553](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1553)
+
+___
+
+### only\_admins
+
+• **only\_admins**: `boolean`
+
+**`Memberof`**
+
+RequestDefaultBehaviorGroupPropertyList
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1547](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1547)

package/doc/interfaces/RequestSystemSubscriptionProperties.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / RequestSystemSubscriptionProperties
+
+# Interface: RequestSystemSubscriptionProperties
+
+**`Export`**
+
+**`Interface`**
+
+RequestSystemSubscriptionProperties
+
+## Table of contents
+
+### Properties
+
+- [group\_id](RequestSystemSubscriptionProperties.md#group_id)
+- [only\_admins](RequestSystemSubscriptionProperties.md#only_admins)
+
+## Properties
+
+### group\_id
+
+• `Optional` **group\_id**: `string`
+
+**`Memberof`**
+
+RequestSystemSubscriptionProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1572](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1572)
+
+___
+
+### only\_admins
+
+• **only\_admins**: `boolean`
+
+**`Memberof`**
+
+RequestSystemSubscriptionProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1566](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1566)

package/doc/interfaces/ServerInfo.md

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

package/doc/interfaces/SettingsValuesByEventType.md

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

package/doc/interfaces/SystemSubscriptionProperties.md

@@ -0,0 +1,59 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / SystemSubscriptionProperties
+
+# Interface: SystemSubscriptionProperties
+
+**`Export`**
+
+**`Interface`**
+
+SystemSubscriptionProperties
+
+## Table of contents
+
+### Properties
+
+- [group\_id](SystemSubscriptionProperties.md#group_id)
+- [ignore\_preferences](SystemSubscriptionProperties.md#ignore_preferences)
+- [only\_admins](SystemSubscriptionProperties.md#only_admins)
+
+## Properties
+
+### group\_id
+
+• `Optional` **group\_id**: `string`
+
+**`Memberof`**
+
+SystemSubscriptionProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1654](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1654)
+
+___
+
+### ignore\_preferences
+
+• **ignore\_preferences**: `boolean`
+
+**`Memberof`**
+
+SystemSubscriptionProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1648](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1648)
+
+___
+
+### only\_admins
+
+• **only\_admins**: `boolean`
+
+**`Memberof`**
+
+SystemSubscriptionProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1642](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1642)

package/doc/interfaces/Template.md

@@ -0,0 +1,104 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Template
+
+# Interface: Template
+
+**`Export`**
+
+**`Interface`**
+
+Template
+
+## Table of contents
+
+### Properties
+
+- [created](Template.md#created)
+- [data](Template.md#data)
+- [description](Template.md#description)
+- [id](Template.md#id)
+- [name](Template.md#name)
+- [updated](Template.md#updated)
+
+## Properties
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1667](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1667)
+
+___
+
+### data
+
+• **data**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1697](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1697)
+
+___
+
+### description
+
+• **description**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1691](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1691)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1679](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1679)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1685](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1685)
+
+___
+
+### updated
+
+• `Optional` **updated**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1673](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1673)