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

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)

package/doc/interfaces/TriggerDailyDigestRequest.md

@@ -0,0 +1,89 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / TriggerDailyDigestRequest
+
+# Interface: TriggerDailyDigestRequest
+
+**`Export`**
+
+**`Interface`**
+
+TriggerDailyDigestRequest
+
+## Table of contents
+
+### Properties
+
+- [application\_name](TriggerDailyDigestRequest.md#application_name)
+- [bundle\_name](TriggerDailyDigestRequest.md#bundle_name)
+- [end](TriggerDailyDigestRequest.md#end)
+- [org\_id](TriggerDailyDigestRequest.md#org_id)
+- [start](TriggerDailyDigestRequest.md#start)
+
+## Properties
+
+### application\_name
+
+• **application\_name**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1710](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1710)
+
+___
+
+### bundle\_name
+
+• **bundle\_name**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1716](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1716)
+
+___
+
+### end
+
+• `Optional` **end**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1722](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1722)
+
+___
+
+### org\_id
+
+• **org\_id**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1728](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1728)
+
+___
+
+### start
+
+• `Optional` **start**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1734](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1734)

package/doc/interfaces/UpdateApplicationRequest.md

@@ -0,0 +1,59 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / UpdateApplicationRequest
+
+# Interface: UpdateApplicationRequest
+
+**`Export`**
+
+**`Interface`**
+
+UpdateApplicationRequest
+
+## Table of contents
+
+### Properties
+
+- [display\_name](UpdateApplicationRequest.md#display_name)
+- [name](UpdateApplicationRequest.md#name)
+- [owner\_role](UpdateApplicationRequest.md#owner_role)
+
+## Properties
+
+### display\_name
+
+• `Optional` **display\_name**: `string`
+
+**`Memberof`**
+
+UpdateApplicationRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1753](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1753)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+**`Memberof`**
+
+UpdateApplicationRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1747](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1747)
+
+___
+
+### owner\_role
+
+• `Optional` **owner\_role**: `string`
+
+**`Memberof`**
+
+UpdateApplicationRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1759](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1759)

package/doc/interfaces/UpdateBehaviorGroupRequest.md

@@ -0,0 +1,74 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / UpdateBehaviorGroupRequest
+
+# Interface: UpdateBehaviorGroupRequest
+
+**`Export`**
+
+**`Interface`**
+
+UpdateBehaviorGroupRequest
+
+## Table of contents
+
+### Properties
+
+- [display\_name](UpdateBehaviorGroupRequest.md#display_name)
+- [display\_name\_not\_null\_and\_blank](UpdateBehaviorGroupRequest.md#display_name_not_null_and_blank)
+- [endpoint\_ids](UpdateBehaviorGroupRequest.md#endpoint_ids)
+- [event\_type\_ids](UpdateBehaviorGroupRequest.md#event_type_ids)
+
+## Properties
+
+### display\_name
+
+• `Optional` **display\_name**: `string`
+
+**`Memberof`**
+
+UpdateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1772](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1772)
+
+___
+
+### display\_name\_not\_null\_and\_blank
+
+• `Optional` **display\_name\_not\_null\_and\_blank**: `boolean`
+
+**`Memberof`**
+
+UpdateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1790](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1790)
+
+___
+
+### endpoint\_ids
+
+• `Optional` **endpoint\_ids**: `string`[]
+
+**`Memberof`**
+
+UpdateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1778](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1778)
+
+___
+
+### event\_type\_ids
+
+• `Optional` **event\_type\_ids**: `Set`<`string`\>
+
+**`Memberof`**
+
+UpdateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1784](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1784)

package/doc/interfaces/UpdateNotificationDrawerStatus.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / UpdateNotificationDrawerStatus
+
+# Interface: UpdateNotificationDrawerStatus
+
+**`Export`**
+
+**`Interface`**
+
+UpdateNotificationDrawerStatus
+
+## Table of contents
+
+### Properties
+
+- [notification\_ids](UpdateNotificationDrawerStatus.md#notification_ids)
+- [read\_status](UpdateNotificationDrawerStatus.md#read_status)
+
+## Properties
+
+### notification\_ids
+
+• **notification\_ids**: `Set`<`string`\>
+
+**`Memberof`**
+
+UpdateNotificationDrawerStatus
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1803](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1803)
+
+___
+
+### read\_status
+
+• **read\_status**: `boolean`
+
+**`Memberof`**
+
+UpdateNotificationDrawerStatus
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1809](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1809)