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

package/doc/interfaces/ConfigurationParameters.md

@@ -0,0 +1,89 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / ConfigurationParameters
+
+# Interface: ConfigurationParameters
+
+## Table of contents
+
+### Properties
+
+- [accessToken](ConfigurationParameters.md#accesstoken)
+- [apiKey](ConfigurationParameters.md#apikey)
+- [baseOptions](ConfigurationParameters.md#baseoptions)
+- [basePath](ConfigurationParameters.md#basepath)
+- [formDataCtor](ConfigurationParameters.md#formdatactor)
+- [password](ConfigurationParameters.md#password)
+- [username](ConfigurationParameters.md#username)
+
+## Properties
+
+### accessToken
+
+• `Optional` **accessToken**: `string` \| `Promise`<`string`\> \| (`name?`: `string`, `scopes?`: `string`[]) => `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `Promise`<`string`\>
+
+#### Defined in
+
+[packages/notifications/utils/configuration.ts:8](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L8)
+
+___
+
+### apiKey
+
+• `Optional` **apiKey**: `string` \| `Promise`<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`<`string`\>
+
+#### Defined in
+
+[packages/notifications/utils/configuration.ts:5](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L5)
+
+___
+
+### baseOptions
+
+• `Optional` **baseOptions**: `any`
+
+#### Defined in
+
+[packages/notifications/utils/configuration.ts:10](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L10)
+
+___
+
+### basePath
+
+• `Optional` **basePath**: `string`
+
+#### Defined in
+
+[packages/notifications/utils/configuration.ts:9](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L9)
+
+___
+
+### formDataCtor
+
+• `Optional` **formDataCtor**: () => `any`
+
+#### Type declaration
+
+• **new ConfigurationParameters**()
+
+#### Defined in
+
+[packages/notifications/utils/configuration.ts:11](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L11)
+
+___
+
+### password
+
+• `Optional` **password**: `string`
+
+#### Defined in
+
+[packages/notifications/utils/configuration.ts:7](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L7)
+
+___
+
+### username
+
+• `Optional` **username**: `string`
+
+#### Defined in
+
+[packages/notifications/utils/configuration.ts:6](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L6)

package/doc/interfaces/CreateBehaviorGroupRequest.md

@@ -0,0 +1,104 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / CreateBehaviorGroupRequest
+
+# Interface: CreateBehaviorGroupRequest
+
+**`Export`**
+
+**`Interface`**
+
+CreateBehaviorGroupRequest
+
+## Table of contents
+
+### Properties
+
+- [bundle\_id](CreateBehaviorGroupRequest.md#bundle_id)
+- [bundle\_name](CreateBehaviorGroupRequest.md#bundle_name)
+- [bundle\_uuid\_or\_bundle\_name\_valid](CreateBehaviorGroupRequest.md#bundle_uuid_or_bundle_name_valid)
+- [display\_name](CreateBehaviorGroupRequest.md#display_name)
+- [endpoint\_ids](CreateBehaviorGroupRequest.md#endpoint_ids)
+- [event\_type\_ids](CreateBehaviorGroupRequest.md#event_type_ids)
+
+## Properties
+
+### bundle\_id
+
+• `Optional` **bundle\_id**: `string`
+
+**`Memberof`**
+
+CreateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:515](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L515)
+
+___
+
+### bundle\_name
+
+• `Optional` **bundle\_name**: `string`
+
+**`Memberof`**
+
+CreateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:521](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L521)
+
+___
+
+### bundle\_uuid\_or\_bundle\_name\_valid
+
+• `Optional` **bundle\_uuid\_or\_bundle\_name\_valid**: `boolean`
+
+**`Memberof`**
+
+CreateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:545](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L545)
+
+___
+
+### display\_name
+
+• **display\_name**: `string`
+
+**`Memberof`**
+
+CreateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:527](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L527)
+
+___
+
+### endpoint\_ids
+
+• `Optional` **endpoint\_ids**: `string`[]
+
+**`Memberof`**
+
+CreateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:533](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L533)
+
+___
+
+### event\_type\_ids
+
+• `Optional` **event\_type\_ids**: `Set`<`string`\>
+
+**`Memberof`**
+
+CreateBehaviorGroupRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:539](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L539)

package/doc/interfaces/CreateBehaviorGroupResponse.md

@@ -0,0 +1,104 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / CreateBehaviorGroupResponse
+
+# Interface: CreateBehaviorGroupResponse
+
+**`Export`**
+
+**`Interface`**
+
+CreateBehaviorGroupResponse
+
+## Table of contents
+
+### Properties
+
+- [bundle\_id](CreateBehaviorGroupResponse.md#bundle_id)
+- [created](CreateBehaviorGroupResponse.md#created)
+- [display\_name](CreateBehaviorGroupResponse.md#display_name)
+- [endpoints](CreateBehaviorGroupResponse.md#endpoints)
+- [event\_types](CreateBehaviorGroupResponse.md#event_types)
+- [id](CreateBehaviorGroupResponse.md#id)
+
+## Properties
+
+### bundle\_id
+
+• **bundle\_id**: `string`
+
+**`Memberof`**
+
+CreateBehaviorGroupResponse
+
+#### Defined in
+
+[packages/notifications/types/index.ts:564](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L564)
+
+___
+
+### created
+
+• **created**: `string`
+
+**`Memberof`**
+
+CreateBehaviorGroupResponse
+
+#### Defined in
+
+[packages/notifications/types/index.ts:588](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L588)
+
+___
+
+### display\_name
+
+• **display\_name**: `string`
+
+**`Memberof`**
+
+CreateBehaviorGroupResponse
+
+#### Defined in
+
+[packages/notifications/types/index.ts:570](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L570)
+
+___
+
+### endpoints
+
+• **endpoints**: `string`[]
+
+**`Memberof`**
+
+CreateBehaviorGroupResponse
+
+#### Defined in
+
+[packages/notifications/types/index.ts:576](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L576)
+
+___
+
+### event\_types
+
+• **event\_types**: `Set`<`string`\>
+
+**`Memberof`**
+
+CreateBehaviorGroupResponse
+
+#### Defined in
+
+[packages/notifications/types/index.ts:582](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L582)
+
+___
+
+### id
+
+• **id**: `string`
+
+**`Memberof`**
+
+CreateBehaviorGroupResponse
+
+#### Defined in
+
+[packages/notifications/types/index.ts:558](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L558)

package/doc/interfaces/CurrentStatus.md

@@ -0,0 +1,59 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / CurrentStatus
+
+# Interface: CurrentStatus
+
+**`Export`**
+
+**`Interface`**
+
+CurrentStatus
+
+## Table of contents
+
+### Properties
+
+- [end\_time](CurrentStatus.md#end_time)
+- [start\_time](CurrentStatus.md#start_time)
+- [status](CurrentStatus.md#status)
+
+## Properties
+
+### end\_time
+
+• `Optional` **end\_time**: `string`
+
+**`Memberof`**
+
+CurrentStatus
+
+#### Defined in
+
+[packages/notifications/types/index.ts:613](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L613)
+
+___
+
+### start\_time
+
+• `Optional` **start\_time**: `string`
+
+**`Memberof`**
+
+CurrentStatus
+
+#### Defined in
+
+[packages/notifications/types/index.ts:607](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L607)
+
+___
+
+### status
+
+• **status**: [`Status`](../enums/Status.md)
+
+**`Memberof`**
+
+CurrentStatus
+
+#### Defined in
+
+[packages/notifications/types/index.ts:601](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L601)

package/doc/interfaces/DrawerEntryPayload.md

@@ -0,0 +1,119 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / DrawerEntryPayload
+
+# Interface: DrawerEntryPayload
+
+**`Export`**
+
+**`Interface`**
+
+DrawerEntryPayload
+
+## Table of contents
+
+### Properties
+
+- [bundle](DrawerEntryPayload.md#bundle)
+- [created](DrawerEntryPayload.md#created)
+- [description](DrawerEntryPayload.md#description)
+- [id](DrawerEntryPayload.md#id)
+- [read](DrawerEntryPayload.md#read)
+- [source](DrawerEntryPayload.md#source)
+- [title](DrawerEntryPayload.md#title)
+
+## Properties
+
+### bundle
+
+• `Optional` **bundle**: `string`
+
+**`Memberof`**
+
+DrawerEntryPayload
+
+#### Defined in
+
+[packages/notifications/types/index.ts:664](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L664)
+
+___
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+DrawerEntryPayload
+
+#### Defined in
+
+[packages/notifications/types/index.ts:646](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L646)
+
+___
+
+### description
+
+• `Optional` **description**: `string`
+
+**`Memberof`**
+
+DrawerEntryPayload
+
+#### Defined in
+
+[packages/notifications/types/index.ts:634](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L634)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+DrawerEntryPayload
+
+#### Defined in
+
+[packages/notifications/types/index.ts:628](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L628)
+
+___
+
+### read
+
+• **read**: `boolean`
+
+**`Memberof`**
+
+DrawerEntryPayload
+
+#### Defined in
+
+[packages/notifications/types/index.ts:652](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L652)
+
+___
+
+### source
+
+• `Optional` **source**: `string`
+
+**`Memberof`**
+
+DrawerEntryPayload
+
+#### Defined in
+
+[packages/notifications/types/index.ts:658](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L658)
+
+___
+
+### title
+
+• `Optional` **title**: `string`
+
+**`Memberof`**
+
+DrawerEntryPayload
+
+#### Defined in
+
+[packages/notifications/types/index.ts:640](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L640)

package/doc/interfaces/DuplicateNameMigrationReport.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / DuplicateNameMigrationReport
+
+# Interface: DuplicateNameMigrationReport
+
+**`Export`**
+
+**`Interface`**
+
+DuplicateNameMigrationReport
+
+## Table of contents
+
+### Properties
+
+- [updatedBehaviorGroups](DuplicateNameMigrationReport.md#updatedbehaviorgroups)
+- [updatedIntegrations](DuplicateNameMigrationReport.md#updatedintegrations)
+
+## Properties
+
+### updatedBehaviorGroups
+
+• `Optional` **updatedBehaviorGroups**: `number`
+
+**`Memberof`**
+
+DuplicateNameMigrationReport
+
+#### Defined in
+
+[packages/notifications/types/index.ts:683](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L683)
+
+___
+
+### updatedIntegrations
+
+• `Optional` **updatedIntegrations**: `number`
+
+**`Memberof`**
+
+DuplicateNameMigrationReport
+
+#### Defined in
+
+[packages/notifications/types/index.ts:677](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L677)

package/doc/interfaces/Endpoint.md

@@ -0,0 +1,179 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Endpoint
+
+# Interface: Endpoint
+
+**`Export`**
+
+**`Interface`**
+
+Endpoint
+
+## Table of contents
+
+### Properties
+
+- [created](Endpoint.md#created)
+- [description](Endpoint.md#description)
+- [enabled](Endpoint.md#enabled)
+- [id](Endpoint.md#id)
+- [name](Endpoint.md#name)
+- [properties](Endpoint.md#properties)
+- [server\_errors](Endpoint.md#server_errors)
+- [status](Endpoint.md#status)
+- [sub\_type](Endpoint.md#sub_type)
+- [type](Endpoint.md#type)
+- [updated](Endpoint.md#updated)
+
+## Properties
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+Endpoint
+
+#### Defined in
+
+[packages/notifications/types/index.ts:696](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L696)
+
+___
+
+### description
+
+• **description**: `string`
+
+**`Memberof`**
+
+Endpoint
+
+#### Defined in
+
+[packages/notifications/types/index.ts:720](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L720)
+
+___
+
+### enabled
+
+• `Optional` **enabled**: `boolean`
+
+**`Memberof`**
+
+Endpoint
+
+#### Defined in
+
+[packages/notifications/types/index.ts:726](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L726)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+Endpoint
+
+#### Defined in
+
+[packages/notifications/types/index.ts:708](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L708)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+Endpoint
+
+#### Defined in
+
+[packages/notifications/types/index.ts:714](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L714)
+
+___
+
+### properties
+
+• `Optional` **properties**: `object`
+
+**`Memberof`**
+
+Endpoint
+
+#### Defined in
+
+[packages/notifications/types/index.ts:744](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L744)
+
+___
+
+### server\_errors
+
+• `Optional` **server\_errors**: `number`
+
+**`Memberof`**
+
+Endpoint
+
+#### Defined in
+
+[packages/notifications/types/index.ts:738](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L738)
+
+___
+
+### status
+
+• `Optional` **status**: [`EndpointStatus`](../enums/EndpointStatus.md)
+
+**`Memberof`**
+
+Endpoint
+
+#### Defined in
+
+[packages/notifications/types/index.ts:732](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L732)
+
+___
+
+### sub\_type
+
+• `Optional` **sub\_type**: `string`
+
+**`Memberof`**
+
+Endpoint
+
+#### Defined in
+
+[packages/notifications/types/index.ts:756](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L756)
+
+___
+
+### type
+
+• **type**: [`EndpointType`](../enums/EndpointType.md)
+
+**`Memberof`**
+
+Endpoint
+
+#### Defined in
+
+[packages/notifications/types/index.ts:750](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L750)
+
+___
+
+### updated
+
+• `Optional` **updated**: `string`
+
+**`Memberof`**
+
+Endpoint
+
+#### Defined in
+
+[packages/notifications/types/index.ts:702](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L702)