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

package/doc/enums/NotificationStatus.md

@@ -0,0 +1,65 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / NotificationStatus
+
+# Enumeration: NotificationStatus
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [FailedExternal](NotificationStatus.md#failedexternal)
+- [FailedInternal](NotificationStatus.md#failedinternal)
+- [Processing](NotificationStatus.md#processing)
+- [Sent](NotificationStatus.md#sent)
+- [Success](NotificationStatus.md#success)
+
+## Enumeration Members
+
+### FailedExternal
+
+• **FailedExternal** = ``"FAILED_EXTERNAL"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1383](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1383)
+
+___
+
+### FailedInternal
+
+• **FailedInternal** = ``"FAILED_INTERNAL"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1382](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1382)
+
+___
+
+### Processing
+
+• **Processing** = ``"PROCESSING"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1384](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1384)
+
+___
+
+### Sent
+
+• **Sent** = ``"SENT"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1385](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1385)
+
+___
+
+### Success
+
+• **Success** = ``"SUCCESS"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1386](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1386)

package/doc/enums/Status.md

@@ -0,0 +1,32 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Status
+
+# Enumeration: Status
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Maintenance](Status.md#maintenance)
+- [Up](Status.md#up)
+
+## Enumeration Members
+
+### Maintenance
+
+• **Maintenance** = ``"MAINTENANCE"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1610](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1610)
+
+___
+
+### Up
+
+• **Up** = ``"UP"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1609](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1609)

package/doc/enums/SubscriptionType.md

@@ -0,0 +1,43 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / SubscriptionType
+
+# Enumeration: SubscriptionType
+
+**`Export`**
+
+## Table of contents
+
+### Enumeration Members
+
+- [Daily](SubscriptionType.md#daily)
+- [Drawer](SubscriptionType.md#drawer)
+- [Instant](SubscriptionType.md#instant)
+
+## Enumeration Members
+
+### Daily
+
+• **Daily** = ``"DAILY"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1624](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1624)
+
+___
+
+### Drawer
+
+• **Drawer** = ``"DRAWER"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1625](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1625)
+
+___
+
+### Instant
+
+• **Instant** = ``"INSTANT"``
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1623](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1623)

package/doc/interfaces/AddAccessRequest.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / AddAccessRequest
+
+# Interface: AddAccessRequest
+
+**`Export`**
+
+**`Interface`**
+
+AddAccessRequest
+
+## Table of contents
+
+### Properties
+
+- [application\_id](AddAccessRequest.md#application_id)
+- [role](AddAccessRequest.md#role)
+
+## Properties
+
+### application\_id
+
+• `Optional` **application\_id**: `string`
+
+**`Memberof`**
+
+AddAccessRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:18](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L18)
+
+___
+
+### role
+
+• `Optional` **role**: `string`
+
+**`Memberof`**
+
+AddAccessRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:12](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L12)

package/doc/interfaces/AddApplicationRequest.md

@@ -0,0 +1,74 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / AddApplicationRequest
+
+# Interface: AddApplicationRequest
+
+**`Export`**
+
+**`Interface`**
+
+AddApplicationRequest
+
+## Table of contents
+
+### Properties
+
+- [bundle\_id](AddApplicationRequest.md#bundle_id)
+- [display\_name](AddApplicationRequest.md#display_name)
+- [name](AddApplicationRequest.md#name)
+- [owner\_role](AddApplicationRequest.md#owner_role)
+
+## Properties
+
+### bundle\_id
+
+• **bundle\_id**: `string`
+
+**`Memberof`**
+
+AddApplicationRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:43](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L43)
+
+___
+
+### display\_name
+
+• **display\_name**: `string`
+
+**`Memberof`**
+
+AddApplicationRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:37](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L37)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+AddApplicationRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:31](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L31)
+
+___
+
+### owner\_role
+
+• `Optional` **owner\_role**: `string`
+
+**`Memberof`**
+
+AddApplicationRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L49)

package/doc/interfaces/AggregationEmailTemplate.md

@@ -0,0 +1,164 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / AggregationEmailTemplate
+
+# Interface: AggregationEmailTemplate
+
+**`Export`**
+
+**`Interface`**
+
+AggregationEmailTemplate
+
+## Table of contents
+
+### Properties
+
+- [application](AggregationEmailTemplate.md#application)
+- [application\_id](AggregationEmailTemplate.md#application_id)
+- [body\_template](AggregationEmailTemplate.md#body_template)
+- [body\_template\_id](AggregationEmailTemplate.md#body_template_id)
+- [created](AggregationEmailTemplate.md#created)
+- [id](AggregationEmailTemplate.md#id)
+- [subject\_template](AggregationEmailTemplate.md#subject_template)
+- [subject\_template\_id](AggregationEmailTemplate.md#subject_template_id)
+- [subscription\_type](AggregationEmailTemplate.md#subscription_type)
+- [updated](AggregationEmailTemplate.md#updated)
+
+## Properties
+
+### application
+
+• `Optional` **application**: [`Application`](Application.md)
+
+**`Memberof`**
+
+AggregationEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:80](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L80)
+
+___
+
+### application\_id
+
+• `Optional` **application\_id**: `string`
+
+**`Memberof`**
+
+AggregationEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:86](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L86)
+
+___
+
+### body\_template
+
+• `Optional` **body\_template**: [`AggregationEmailTemplateSubjectTemplate`](AggregationEmailTemplateSubjectTemplate.md)
+
+**`Memberof`**
+
+AggregationEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:110](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L110)
+
+___
+
+### body\_template\_id
+
+• **body\_template\_id**: `string`
+
+**`Memberof`**
+
+AggregationEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:116](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L116)
+
+___
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+AggregationEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:62](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L62)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+AggregationEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:74](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L74)
+
+___
+
+### subject\_template
+
+• `Optional` **subject\_template**: [`AggregationEmailTemplateSubjectTemplate`](AggregationEmailTemplateSubjectTemplate.md)
+
+**`Memberof`**
+
+AggregationEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:98](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L98)
+
+___
+
+### subject\_template\_id
+
+• **subject\_template\_id**: `string`
+
+**`Memberof`**
+
+AggregationEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:104](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L104)
+
+___
+
+### subscription\_type
+
+• **subscription\_type**: [`SubscriptionType`](../enums/SubscriptionType.md)
+
+**`Memberof`**
+
+AggregationEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:92](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L92)
+
+___
+
+### updated
+
+• `Optional` **updated**: `string`
+
+**`Memberof`**
+
+AggregationEmailTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:68](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L68)

package/doc/interfaces/AggregationEmailTemplateSubjectTemplate.md

@@ -0,0 +1,104 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / AggregationEmailTemplateSubjectTemplate
+
+# Interface: AggregationEmailTemplateSubjectTemplate
+
+**`Export`**
+
+**`Interface`**
+
+AggregationEmailTemplateSubjectTemplate
+
+## Table of contents
+
+### Properties
+
+- [created](AggregationEmailTemplateSubjectTemplate.md#created)
+- [data](AggregationEmailTemplateSubjectTemplate.md#data)
+- [description](AggregationEmailTemplateSubjectTemplate.md#description)
+- [id](AggregationEmailTemplateSubjectTemplate.md#id)
+- [name](AggregationEmailTemplateSubjectTemplate.md#name)
+- [updated](AggregationEmailTemplateSubjectTemplate.md#updated)
+
+## Properties
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+AggregationEmailTemplateSubjectTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:131](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L131)
+
+___
+
+### data
+
+• **data**: `string`
+
+**`Memberof`**
+
+AggregationEmailTemplateSubjectTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:161](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L161)
+
+___
+
+### description
+
+• **description**: `string`
+
+**`Memberof`**
+
+AggregationEmailTemplateSubjectTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:155](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L155)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+AggregationEmailTemplateSubjectTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:143](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L143)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+AggregationEmailTemplateSubjectTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:149](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L149)
+
+___
+
+### updated
+
+• `Optional` **updated**: `string`
+
+**`Memberof`**
+
+AggregationEmailTemplateSubjectTemplate
+
+#### Defined in
+
+[packages/notifications/types/index.ts:137](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L137)

package/doc/interfaces/ApiConfig.md

@@ -0,0 +1,30 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / ApiConfig
+
+# Interface: ApiConfig
+
+## Table of contents
+
+### Properties
+
+- [axios](ApiConfig.md#axios)
+- [configuration](ApiConfig.md#configuration)
+
+## Properties
+
+### axios
+
+• **axios**: `AxiosInstance`
+
+#### Defined in
+
+[packages/notifications/utils/base.ts:41](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L41)
+
+___
+
+### configuration
+
+• `Optional` **configuration**: [`Configuration`](../classes/Configuration.md)
+
+#### Defined in
+
+[packages/notifications/utils/base.ts:42](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L42)

package/doc/interfaces/Application.md

@@ -0,0 +1,104 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Application
+
+# Interface: Application
+
+**`Export`**
+
+**`Interface`**
+
+Application
+
+## Table of contents
+
+### Properties
+
+- [bundle\_id](Application.md#bundle_id)
+- [created](Application.md#created)
+- [display\_name](Application.md#display_name)
+- [id](Application.md#id)
+- [name](Application.md#name)
+- [updated](Application.md#updated)
+
+## Properties
+
+### bundle\_id
+
+• **bundle\_id**: `string`
+
+**`Memberof`**
+
+Application
+
+#### Defined in
+
+[packages/notifications/types/index.ts:204](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L204)
+
+___
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+Application
+
+#### Defined in
+
+[packages/notifications/types/index.ts:174](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L174)
+
+___
+
+### display\_name
+
+• **display\_name**: `string`
+
+**`Memberof`**
+
+Application
+
+#### Defined in
+
+[packages/notifications/types/index.ts:198](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L198)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+Application
+
+#### Defined in
+
+[packages/notifications/types/index.ts:186](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L186)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+Application
+
+#### Defined in
+
+[packages/notifications/types/index.ts:192](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L192)
+
+___
+
+### updated
+
+• `Optional` **updated**: `string`
+
+**`Memberof`**
+
+Application
+
+#### Defined in
+
+[packages/notifications/types/index.ts:180](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L180)

package/doc/interfaces/Application1.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Application1
+
+# Interface: Application1
+
+**`Export`**
+
+**`Interface`**
+
+Application1
+
+## Table of contents
+
+### Properties
+
+- [display\_name](Application1.md#display_name)
+- [id](Application1.md#id)
+
+## Properties
+
+### display\_name
+
+• **display\_name**: `string`
+
+**`Memberof`**
+
+Application1
+
+#### Defined in
+
+[packages/notifications/types/index.ts:223](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L223)
+
+___
+
+### id
+
+• **id**: `string`
+
+**`Memberof`**
+
+Application1
+
+#### Defined in
+
+[packages/notifications/types/index.ts:217](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L217)