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

package/doc/interfaces/ApplicationDTO.md

@@ -0,0 +1,104 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / ApplicationDTO
+
+# Interface: ApplicationDTO
+
+**`Export`**
+
+**`Interface`**
+
+ApplicationDTO
+
+## Table of contents
+
+### Properties
+
+- [bundle\_id](ApplicationDTO.md#bundle_id)
+- [created](ApplicationDTO.md#created)
+- [display\_name](ApplicationDTO.md#display_name)
+- [id](ApplicationDTO.md#id)
+- [name](ApplicationDTO.md#name)
+- [owner\_role](ApplicationDTO.md#owner_role)
+
+## Properties
+
+### bundle\_id
+
+• **bundle\_id**: `string`
+
+**`Memberof`**
+
+ApplicationDTO
+
+#### Defined in
+
+[packages/notifications/types/index.ts:254](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L254)
+
+___
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+ApplicationDTO
+
+#### Defined in
+
+[packages/notifications/types/index.ts:266](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L266)
+
+___
+
+### display\_name
+
+• **display\_name**: `string`
+
+**`Memberof`**
+
+ApplicationDTO
+
+#### Defined in
+
+[packages/notifications/types/index.ts:248](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L248)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+ApplicationDTO
+
+#### Defined in
+
+[packages/notifications/types/index.ts:236](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L236)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+ApplicationDTO
+
+#### Defined in
+
+[packages/notifications/types/index.ts:242](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L242)
+
+___
+
+### owner\_role
+
+• `Optional` **owner\_role**: `string`
+
+**`Memberof`**
+
+ApplicationDTO
+
+#### Defined in
+
+[packages/notifications/types/index.ts:260](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L260)

package/doc/interfaces/ApplicationSettingsValue.md

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

package/doc/interfaces/BasicAuthentication.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / BasicAuthentication
+
+# Interface: BasicAuthentication
+
+**`Export`**
+
+**`Interface`**
+
+BasicAuthentication
+
+## Table of contents
+
+### Properties
+
+- [password](BasicAuthentication.md#password)
+- [username](BasicAuthentication.md#username)
+
+## Properties
+
+### password
+
+• `Optional` **password**: `string`
+
+**`Memberof`**
+
+BasicAuthentication
+
+#### Defined in
+
+[packages/notifications/types/index.ts:298](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L298)
+
+___
+
+### username
+
+• `Optional` **username**: `string`
+
+**`Memberof`**
+
+BasicAuthentication
+
+#### Defined in
+
+[packages/notifications/types/index.ts:292](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L292)

package/doc/interfaces/BehaviorGroup.md

@@ -0,0 +1,149 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / BehaviorGroup
+
+# Interface: BehaviorGroup
+
+**`Export`**
+
+**`Interface`**
+
+BehaviorGroup
+
+## Table of contents
+
+### Properties
+
+- [actions](BehaviorGroup.md#actions)
+- [behaviors](BehaviorGroup.md#behaviors)
+- [bundle](BehaviorGroup.md#bundle)
+- [bundle\_id](BehaviorGroup.md#bundle_id)
+- [created](BehaviorGroup.md#created)
+- [default\_behavior](BehaviorGroup.md#default_behavior)
+- [display\_name](BehaviorGroup.md#display_name)
+- [id](BehaviorGroup.md#id)
+- [updated](BehaviorGroup.md#updated)
+
+## Properties
+
+### actions
+
+• `Optional` **actions**: [`BehaviorGroupAction`](BehaviorGroupAction.md)[]
+
+**`Memberof`**
+
+BehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:347](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L347)
+
+___
+
+### behaviors
+
+• `Optional` **behaviors**: `Set`<[`EventTypeBehavior`](EventTypeBehavior.md)\>
+
+**`Memberof`**
+
+BehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:353](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L353)
+
+___
+
+### bundle
+
+• `Optional` **bundle**: [`Bundle`](Bundle.md)
+
+**`Memberof`**
+
+BehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:341](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L341)
+
+___
+
+### bundle\_id
+
+• **bundle\_id**: `string`
+
+**`Memberof`**
+
+BehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:335](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L335)
+
+___
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+BehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:311](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L311)
+
+___
+
+### default\_behavior
+
+• `Optional` **default\_behavior**: `boolean`
+
+**`Memberof`**
+
+BehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:359](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L359)
+
+___
+
+### display\_name
+
+• **display\_name**: `string`
+
+**`Memberof`**
+
+BehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:329](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L329)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+BehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:323](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L323)
+
+___
+
+### updated
+
+• `Optional` **updated**: `string`
+
+**`Memberof`**
+
+BehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:317](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L317)

package/doc/interfaces/BehaviorGroupAction.md

@@ -0,0 +1,59 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / BehaviorGroupAction
+
+# Interface: BehaviorGroupAction
+
+**`Export`**
+
+**`Interface`**
+
+BehaviorGroupAction
+
+## Table of contents
+
+### Properties
+
+- [created](BehaviorGroupAction.md#created)
+- [endpoint](BehaviorGroupAction.md#endpoint)
+- [id](BehaviorGroupAction.md#id)
+
+## Properties
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+BehaviorGroupAction
+
+#### Defined in
+
+[packages/notifications/types/index.ts:372](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L372)
+
+___
+
+### endpoint
+
+• `Optional` **endpoint**: [`Endpoint`](Endpoint.md)
+
+**`Memberof`**
+
+BehaviorGroupAction
+
+#### Defined in
+
+[packages/notifications/types/index.ts:384](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L384)
+
+___
+
+### id
+
+• `Optional` **id**: [`BehaviorGroupActionId`](BehaviorGroupActionId.md)
+
+**`Memberof`**
+
+BehaviorGroupAction
+
+#### Defined in
+
+[packages/notifications/types/index.ts:378](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L378)

package/doc/interfaces/BehaviorGroupActionId.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / BehaviorGroupActionId
+
+# Interface: BehaviorGroupActionId
+
+**`Export`**
+
+**`Interface`**
+
+BehaviorGroupActionId
+
+## Table of contents
+
+### Properties
+
+- [behaviorGroupId](BehaviorGroupActionId.md#behaviorgroupid)
+- [endpointId](BehaviorGroupActionId.md#endpointid)
+
+## Properties
+
+### behaviorGroupId
+
+• **behaviorGroupId**: `string`
+
+**`Memberof`**
+
+BehaviorGroupActionId
+
+#### Defined in
+
+[packages/notifications/types/index.ts:397](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L397)
+
+___
+
+### endpointId
+
+• **endpointId**: `string`
+
+**`Memberof`**
+
+BehaviorGroupActionId
+
+#### Defined in
+
+[packages/notifications/types/index.ts:403](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L403)

package/doc/interfaces/Bundle.md

@@ -0,0 +1,89 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Bundle
+
+# Interface: Bundle
+
+**`Export`**
+
+**`Interface`**
+
+Bundle
+
+## Table of contents
+
+### Properties
+
+- [created](Bundle.md#created)
+- [display\_name](Bundle.md#display_name)
+- [id](Bundle.md#id)
+- [name](Bundle.md#name)
+- [updated](Bundle.md#updated)
+
+## Properties
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+Bundle
+
+#### Defined in
+
+[packages/notifications/types/index.ts:416](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L416)
+
+___
+
+### display\_name
+
+• **display\_name**: `string`
+
+**`Memberof`**
+
+Bundle
+
+#### Defined in
+
+[packages/notifications/types/index.ts:440](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L440)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+Bundle
+
+#### Defined in
+
+[packages/notifications/types/index.ts:428](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L428)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+Bundle
+
+#### Defined in
+
+[packages/notifications/types/index.ts:434](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L434)
+
+___
+
+### updated
+
+• `Optional` **updated**: `string`
+
+**`Memberof`**
+
+Bundle
+
+#### Defined in
+
+[packages/notifications/types/index.ts:422](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L422)

package/doc/interfaces/BundleSettingsValue.md

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

package/doc/interfaces/CamelProperties.md

@@ -0,0 +1,123 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / CamelProperties
+
+# Interface: CamelProperties
+
+**`Export`**
+
+**`Interface`**
+
+CamelProperties
+
+## Table of contents
+
+### Properties
+
+- [basic\_authentication](CamelProperties.md#basic_authentication)
+- [bearer\_authentication](CamelProperties.md#bearer_authentication)
+- [bearer\_authentication\_sources\_id](CamelProperties.md#bearer_authentication_sources_id)
+- [disable\_ssl\_verification](CamelProperties.md#disable_ssl_verification)
+- [extras](CamelProperties.md#extras)
+- [secret\_token](CamelProperties.md#secret_token)
+- [url](CamelProperties.md#url)
+
+## Properties
+
+### basic\_authentication
+
+• `Optional` **basic\_authentication**: [`BasicAuthentication`](BasicAuthentication.md)
+
+**`Memberof`**
+
+CamelProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:484](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L484)
+
+___
+
+### bearer\_authentication
+
+• `Optional` **bearer\_authentication**: `string`
+
+**`Memberof`**
+
+CamelProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:502](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L502)
+
+___
+
+### bearer\_authentication\_sources\_id
+
+• `Optional` **bearer\_authentication\_sources\_id**: `number`
+
+**`Memberof`**
+
+CamelProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:496](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L496)
+
+___
+
+### disable\_ssl\_verification
+
+• **disable\_ssl\_verification**: `boolean`
+
+**`Memberof`**
+
+CamelProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:472](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L472)
+
+___
+
+### extras
+
+• `Optional` **extras**: `Object`
+
+**`Memberof`**
+
+CamelProperties
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:490](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L490)
+
+___
+
+### secret\_token
+
+• `Optional` **secret\_token**: `string`
+
+**`Memberof`**
+
+CamelProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:478](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L478)
+
+___
+
+### url
+
+• **url**: `string`
+
+**`Memberof`**
+
+CamelProperties
+
+#### Defined in
+
+[packages/notifications/types/index.ts:466](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L466)