@redhat-cloud-services/notifications-client 0.0.40 → 1.0.0

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:1402](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1402)
+
+___
+
+### only\_admins
+
+• **only\_admins**: `boolean`
+
+**`Memberof`**
+
+RequestDefaultBehaviorGroupPropertyList
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1396](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1396)

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:1421](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1421)
+
+___
+
+### only\_admins
+
+• **only\_admins**: `boolean`
+
+**`Memberof`**
+
+RequestSystemSubscriptionProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1415](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1415)

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:1434](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1434)

package/doc/interfaces/SettingsValues.md

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

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:1462](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1462)

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:1501](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1501)
+
+___
+
+### ignore\_preferences
+
+• **ignore\_preferences**: `boolean`
+
+**`Memberof`**
+
+SystemSubscriptionProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1495](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1495)
+
+___
+
+### only\_admins
+
+• **only\_admins**: `boolean`
+
+**`Memberof`**
+
+SystemSubscriptionProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1489](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1489)

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:1514](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1514)
+
+___
+
+### data
+
+• **data**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1544](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1544)
+
+___
+
+### description
+
+• **description**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1538](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1538)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1526](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1526)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1532](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1532)
+
+___
+
+### updated
+
+• `Optional` **updated**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1520](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1520)

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:1557](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1557)
+
+___
+
+### bundle\_name
+
+• **bundle\_name**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1563](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1563)
+
+___
+
+### end
+
+• `Optional` **end**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1569](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1569)
+
+___
+
+### org\_id
+
+• **org\_id**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1575](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1575)
+
+___
+
+### start
+
+• `Optional` **start**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1581](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1581)

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:1594](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1594)
+
+___
+
+### display\_name\_not\_null\_and\_blank
+
+• `Optional` **display\_name\_not\_null\_and\_blank**: `boolean`
+
+**`Memberof`**
+
+UpdateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1612](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1612)
+
+___
+
+### endpoint\_ids
+
+• `Optional` **endpoint\_ids**: `string`[]
+
+**`Memberof`**
+
+UpdateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1600](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1600)
+
+___
+
+### event\_type\_ids
+
+• `Optional` **event\_type\_ids**: `Set`<`string`\>
+
+**`Memberof`**
+
+UpdateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1606](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1606)

package/doc/interfaces/UserConfigPreferences.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / UserConfigPreferences
+
+# Interface: UserConfigPreferences
+
+**`Export`**
+
+**`Interface`**
+
+UserConfigPreferences
+
+## Table of contents
+
+### Properties
+
+- [daily\_email](UserConfigPreferences.md#daily_email)
+- [instant\_email](UserConfigPreferences.md#instant_email)
+
+## Properties
+
+### daily\_email
+
+• `Optional` **daily\_email**: `boolean`
+
+**`Memberof`**
+
+UserConfigPreferences
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1631](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1631)
+
+___
+
+### instant\_email
+
+• `Optional` **instant\_email**: `boolean`
+
+**`Memberof`**
+
+UserConfigPreferences
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1625](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1625)

package/doc/interfaces/WebhookProperties.md

@@ -0,0 +1,89 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / WebhookProperties
+
+# Interface: WebhookProperties
+
+**`Export`**
+
+**`Interface`**
+
+WebhookProperties
+
+## Table of contents
+
+### Properties
+
+- [basic\_authentication](WebhookProperties.md#basic_authentication)
+- [disable\_ssl\_verification](WebhookProperties.md#disable_ssl_verification)
+- [method](WebhookProperties.md#method)
+- [secret\_token](WebhookProperties.md#secret_token)
+- [url](WebhookProperties.md#url)
+
+## Properties
+
+### basic\_authentication
+
+• `Optional` **basic\_authentication**: [`BasicAuthentication`](BasicAuthentication.md)
+
+**`Memberof`**
+
+WebhookProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1668](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1668)
+
+___
+
+### disable\_ssl\_verification
+
+• **disable\_ssl\_verification**: `boolean`
+
+**`Memberof`**
+
+WebhookProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1656](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1656)
+
+___
+
+### method
+
+• **method**: [`HttpType`](../enums/HttpType.md)
+
+**`Memberof`**
+
+WebhookProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1650](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1650)
+
+___
+
+### secret\_token
+
+• `Optional` **secret\_token**: `string`
+
+**`Memberof`**
+
+WebhookProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1662](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1662)
+
+___
+
+### url
+
+• **url**: `string`
+
+**`Memberof`**
+
+WebhookProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1644](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1644)