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

package/doc/interfaces/InternalRoleAccess.md

@@ -0,0 +1,59 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / InternalRoleAccess
+
+# Interface: InternalRoleAccess
+
+**`Export`**
+
+**`Interface`**
+
+InternalRoleAccess
+
+## Table of contents
+
+### Properties
+
+- [application\_id](InternalRoleAccess.md#application_id)
+- [id](InternalRoleAccess.md#id)
+- [role](InternalRoleAccess.md#role)
+
+## Properties
+
+### application\_id
+
+• **application\_id**: `string`
+
+**`Memberof`**
+
+InternalRoleAccess
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1132](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1132)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+InternalRoleAccess
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1120](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1120)
+
+___
+
+### role
+
+• **role**: `string`
+
+**`Memberof`**
+
+InternalRoleAccess
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1126](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1126)

package/doc/interfaces/InternalUserPermissions.md

@@ -0,0 +1,59 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / InternalUserPermissions
+
+# Interface: InternalUserPermissions
+
+**`Export`**
+
+**`Interface`**
+
+InternalUserPermissions
+
+## Table of contents
+
+### Properties
+
+- [applications](InternalUserPermissions.md#applications)
+- [is\_admin](InternalUserPermissions.md#is_admin)
+- [roles](InternalUserPermissions.md#roles)
+
+## Properties
+
+### applications
+
+• **applications**: [`Application1`](Application1.md)[]
+
+**`Memberof`**
+
+InternalUserPermissions
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1151](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1151)
+
+___
+
+### is\_admin
+
+• **is\_admin**: `boolean`
+
+**`Memberof`**
+
+InternalUserPermissions
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1145](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1145)
+
+___
+
+### roles
+
+• **roles**: `string`[]
+
+**`Memberof`**
+
+InternalUserPermissions
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1157](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1157)

package/doc/interfaces/MessageValidationResponse.md

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

package/doc/interfaces/Meta.md

@@ -0,0 +1,29 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Meta
+
+# Interface: Meta
+
+**`Export`**
+
+**`Interface`**
+
+Meta
+
+## Table of contents
+
+### Properties
+
+- [count](Meta.md#count)
+
+## Properties
+
+### count
+
+• **count**: `number`
+
+**`Memberof`**
+
+Meta
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1183](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1183)

package/doc/interfaces/NotificationHistory.md

@@ -0,0 +1,155 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / NotificationHistory
+
+# Interface: NotificationHistory
+
+**`Export`**
+
+**`Interface`**
+
+NotificationHistory
+
+## Table of contents
+
+### Properties
+
+- [created](NotificationHistory.md#created)
+- [details](NotificationHistory.md#details)
+- [endpointId](NotificationHistory.md#endpointid)
+- [endpointSubType](NotificationHistory.md#endpointsubtype)
+- [endpointType](NotificationHistory.md#endpointtype)
+- [id](NotificationHistory.md#id)
+- [invocationResult](NotificationHistory.md#invocationresult)
+- [invocationTime](NotificationHistory.md#invocationtime)
+- [status](NotificationHistory.md#status)
+
+## Properties
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1196](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1196)
+
+___
+
+### details
+
+• `Optional` **details**: `Object`
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Index signature
+
+▪ [key: `string`]: `object`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1233](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1233)
+
+___
+
+### endpointId
+
+• `Optional` **endpointId**: `string`
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1227](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1227)
+
+___
+
+### endpointSubType
+
+• `Optional` **endpointSubType**: `string`
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1245](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1245)
+
+___
+
+### endpointType
+
+• `Optional` **endpointType**: [`EndpointType`](../enums/EndpointType.md)
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1239](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1239)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1202](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1202)
+
+___
+
+### invocationResult
+
+• **invocationResult**: `boolean`
+
+**`Memberof`**
+
+NotificationHistory
+
+**`Deprecated`**
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1215](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1215)
+
+___
+
+### invocationTime
+
+• **invocationTime**: `number`
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1208](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1208)
+
+___
+
+### status
+
+• **status**: [`NotificationStatus`](../enums/NotificationStatus.md)
+
+**`Memberof`**
+
+NotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1221](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1221)

package/doc/interfaces/PageBehaviorGroup.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / PageBehaviorGroup
+
+# Interface: PageBehaviorGroup
+
+**`Export`**
+
+**`Interface`**
+
+PageBehaviorGroup
+
+## Table of contents
+
+### Properties
+
+- [data](PageBehaviorGroup.md#data)
+- [links](PageBehaviorGroup.md#links)
+- [meta](PageBehaviorGroup.md#meta)
+
+## Properties
+
+### data
+
+• **data**: [`BehaviorGroup`](BehaviorGroup.md)[]
+
+**`Memberof`**
+
+PageBehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1277](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1277)
+
+___
+
+### links
+
+• **links**: `Object`
+
+**`Memberof`**
+
+PageBehaviorGroup
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1283](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1283)
+
+___
+
+### meta
+
+• **meta**: [`Meta`](Meta.md)
+
+**`Memberof`**
+
+PageBehaviorGroup
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1289](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1289)

package/doc/interfaces/PageEventLogEntry.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / PageEventLogEntry
+
+# Interface: PageEventLogEntry
+
+**`Export`**
+
+**`Interface`**
+
+PageEventLogEntry
+
+## Table of contents
+
+### Properties
+
+- [data](PageEventLogEntry.md#data)
+- [links](PageEventLogEntry.md#links)
+- [meta](PageEventLogEntry.md#meta)
+
+## Properties
+
+### data
+
+• **data**: [`EventLogEntry`](EventLogEntry.md)[]
+
+**`Memberof`**
+
+PageEventLogEntry
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1302](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1302)
+
+___
+
+### links
+
+• **links**: `Object`
+
+**`Memberof`**
+
+PageEventLogEntry
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1308](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1308)
+
+___
+
+### meta
+
+• **meta**: [`Meta`](Meta.md)
+
+**`Memberof`**
+
+PageEventLogEntry
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1314](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1314)

package/doc/interfaces/PageEventType.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / PageEventType
+
+# Interface: PageEventType
+
+**`Export`**
+
+**`Interface`**
+
+PageEventType
+
+## Table of contents
+
+### Properties
+
+- [data](PageEventType.md#data)
+- [links](PageEventType.md#links)
+- [meta](PageEventType.md#meta)
+
+## Properties
+
+### data
+
+• **data**: [`EventType`](EventType.md)[]
+
+**`Memberof`**
+
+PageEventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1327](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1327)
+
+___
+
+### links
+
+• **links**: `Object`
+
+**`Memberof`**
+
+PageEventType
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1333](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1333)
+
+___
+
+### meta
+
+• **meta**: [`Meta`](Meta.md)
+
+**`Memberof`**
+
+PageEventType
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1339](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1339)

package/doc/interfaces/PageNotificationHistory.md

@@ -0,0 +1,63 @@
+[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / PageNotificationHistory
+
+# Interface: PageNotificationHistory
+
+**`Export`**
+
+**`Interface`**
+
+PageNotificationHistory
+
+## Table of contents
+
+### Properties
+
+- [data](PageNotificationHistory.md#data)
+- [links](PageNotificationHistory.md#links)
+- [meta](PageNotificationHistory.md#meta)
+
+## Properties
+
+### data
+
+• **data**: [`NotificationHistory`](NotificationHistory.md)[]
+
+**`Memberof`**
+
+PageNotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1352](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1352)
+
+___
+
+### links
+
+• **links**: `Object`
+
+**`Memberof`**
+
+PageNotificationHistory
+
+#### Index signature
+
+▪ [key: `string`]: `string`
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1358](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1358)
+
+___
+
+### meta
+
+• **meta**: [`Meta`](Meta.md)
+
+**`Memberof`**
+
+PageNotificationHistory
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1364](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1364)

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:1383](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1383)
+
+___
+
+### template
+
+• **template**: `string`[]
+
+**`Memberof`**
+
+RenderEmailTemplateRequest
+
+#### Defined in
+
+[packages/notifications/types/index.ts:1377](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/types/index.ts#L1377)

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`
+
+#### 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)