@redhat-cloud-services/notifications-client 4.0.1 → 4.0.2

package/doc/interfaces/types.SystemSubscriptionPropertiesDTO.md

@@ -0,0 +1,59 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / SystemSubscriptionPropertiesDTO
+
+# Interface: SystemSubscriptionPropertiesDTO
+
+[types](../modules/types.md).SystemSubscriptionPropertiesDTO
+
+**`Export`**
+
+SystemSubscriptionPropertiesDTO
+
+## Table of contents
+
+### Properties
+
+- [groupId](types.SystemSubscriptionPropertiesDTO.md#groupid)
+- [ignorePreferences](types.SystemSubscriptionPropertiesDTO.md#ignorepreferences)
+- [onlyAdmins](types.SystemSubscriptionPropertiesDTO.md#onlyadmins)
+
+## Properties
+
+### groupId
+
+• `Optional` **groupId**: `string`
+
+**`Memberof`**
+
+SystemSubscriptionPropertiesDTO
+
+#### Defined in
+
+[types/index.ts:1746](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1746)
+
+___
+
+### ignorePreferences
+
+• `Optional` **ignorePreferences**: `boolean`
+
+**`Memberof`**
+
+SystemSubscriptionPropertiesDTO
+
+#### Defined in
+
+[types/index.ts:1752](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1752)
+
+___
+
+### onlyAdmins
+
+• `Optional` **onlyAdmins**: `boolean`
+
+**`Memberof`**
+
+SystemSubscriptionPropertiesDTO
+
+#### Defined in
+
+[types/index.ts:1758](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1758)

package/doc/interfaces/types.Template.md

@@ -0,0 +1,104 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / Template
+
+# Interface: Template
+
+[types](../modules/types.md).Template
+
+**`Export`**
+
+Template
+
+## Table of contents
+
+### Properties
+
+- [created](types.Template.md#created)
+- [data](types.Template.md#data)
+- [description](types.Template.md#description)
+- [id](types.Template.md#id)
+- [name](types.Template.md#name)
+- [updated](types.Template.md#updated)
+
+## Properties
+
+### created
+
+• `Optional` **created**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[types/index.ts:1771](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1771)
+
+___
+
+### data
+
+• **data**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[types/index.ts:1801](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1801)
+
+___
+
+### description
+
+• **description**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[types/index.ts:1795](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1795)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[types/index.ts:1783](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1783)
+
+___
+
+### name
+
+• **name**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[types/index.ts:1789](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1789)
+
+___
+
+### updated
+
+• `Optional` **updated**: `string`
+
+**`Memberof`**
+
+Template
+
+#### Defined in
+
+[types/index.ts:1777](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1777)

package/doc/interfaces/types.TriggerDailyDigestRequest.md

@@ -0,0 +1,89 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / TriggerDailyDigestRequest
+
+# Interface: TriggerDailyDigestRequest
+
+[types](../modules/types.md).TriggerDailyDigestRequest
+
+**`Export`**
+
+TriggerDailyDigestRequest
+
+## Table of contents
+
+### Properties
+
+- [application\_name](types.TriggerDailyDigestRequest.md#application_name)
+- [bundle\_name](types.TriggerDailyDigestRequest.md#bundle_name)
+- [end](types.TriggerDailyDigestRequest.md#end)
+- [org\_id](types.TriggerDailyDigestRequest.md#org_id)
+- [start](types.TriggerDailyDigestRequest.md#start)
+
+## Properties
+
+### application\_name
+
+• **application\_name**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[types/index.ts:1814](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1814)
+
+___
+
+### bundle\_name
+
+• **bundle\_name**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[types/index.ts:1820](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1820)
+
+___
+
+### end
+
+• `Optional` **end**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[types/index.ts:1826](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1826)
+
+___
+
+### org\_id
+
+• **org\_id**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[types/index.ts:1832](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1832)
+
+___
+
+### start
+
+• `Optional` **start**: `string`
+
+**`Memberof`**
+
+TriggerDailyDigestRequest
+
+#### Defined in
+
+[types/index.ts:1838](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1838)

package/doc/interfaces/types.UpdateApplicationRequest.md

@@ -0,0 +1,59 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / UpdateApplicationRequest
+
+# Interface: UpdateApplicationRequest
+
+[types](../modules/types.md).UpdateApplicationRequest
+
+**`Export`**
+
+UpdateApplicationRequest
+
+## Table of contents
+
+### Properties
+
+- [display\_name](types.UpdateApplicationRequest.md#display_name)
+- [name](types.UpdateApplicationRequest.md#name)
+- [owner\_role](types.UpdateApplicationRequest.md#owner_role)
+
+## Properties
+
+### display\_name
+
+• `Optional` **display\_name**: `string`
+
+**`Memberof`**
+
+UpdateApplicationRequest
+
+#### Defined in
+
+[types/index.ts:1857](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1857)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+**`Memberof`**
+
+UpdateApplicationRequest
+
+#### Defined in
+
+[types/index.ts:1851](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1851)
+
+___
+
+### owner\_role
+
+• `Optional` **owner\_role**: `string`
+
+**`Memberof`**
+
+UpdateApplicationRequest
+
+#### Defined in
+
+[types/index.ts:1863](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1863)

package/doc/interfaces/types.UpdateBehaviorGroupRequest.md

@@ -0,0 +1,74 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / UpdateBehaviorGroupRequest
+
+# Interface: UpdateBehaviorGroupRequest
+
+[types](../modules/types.md).UpdateBehaviorGroupRequest
+
+**`Export`**
+
+UpdateBehaviorGroupRequest
+
+## Table of contents
+
+### Properties
+
+- [display\_name](types.UpdateBehaviorGroupRequest.md#display_name)
+- [display\_name\_not\_null\_and\_blank](types.UpdateBehaviorGroupRequest.md#display_name_not_null_and_blank)
+- [endpoint\_ids](types.UpdateBehaviorGroupRequest.md#endpoint_ids)
+- [event\_type\_ids](types.UpdateBehaviorGroupRequest.md#event_type_ids)
+
+## Properties
+
+### display\_name
+
+• `Optional` **display\_name**: `string`
+
+**`Memberof`**
+
+UpdateBehaviorGroupRequest
+
+#### Defined in
+
+[types/index.ts:1876](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1876)
+
+___
+
+### display\_name\_not\_null\_and\_blank
+
+• `Optional` **display\_name\_not\_null\_and\_blank**: `boolean`
+
+**`Memberof`**
+
+UpdateBehaviorGroupRequest
+
+#### Defined in
+
+[types/index.ts:1894](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1894)
+
+___
+
+### endpoint\_ids
+
+• `Optional` **endpoint\_ids**: `string`[]
+
+**`Memberof`**
+
+UpdateBehaviorGroupRequest
+
+#### Defined in
+
+[types/index.ts:1882](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1882)
+
+___
+
+### event\_type\_ids
+
+• `Optional` **event\_type\_ids**: `Set`\<`string`\>
+
+**`Memberof`**
+
+UpdateBehaviorGroupRequest
+
+#### Defined in
+
+[types/index.ts:1888](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1888)

package/doc/interfaces/types.UpdateNotificationDrawerStatus.md

@@ -0,0 +1,44 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / UpdateNotificationDrawerStatus
+
+# Interface: UpdateNotificationDrawerStatus
+
+[types](../modules/types.md).UpdateNotificationDrawerStatus
+
+**`Export`**
+
+UpdateNotificationDrawerStatus
+
+## Table of contents
+
+### Properties
+
+- [notification\_ids](types.UpdateNotificationDrawerStatus.md#notification_ids)
+- [read\_status](types.UpdateNotificationDrawerStatus.md#read_status)
+
+## Properties
+
+### notification\_ids
+
+• **notification\_ids**: `Set`\<`string`\>
+
+**`Memberof`**
+
+UpdateNotificationDrawerStatus
+
+#### Defined in
+
+[types/index.ts:1907](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1907)
+
+___
+
+### read\_status
+
+• **read\_status**: `boolean`
+
+**`Memberof`**
+
+UpdateNotificationDrawerStatus
+
+#### Defined in
+
+[types/index.ts:1913](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1913)

package/doc/interfaces/types.WebhookPropertiesDTO.md

@@ -0,0 +1,104 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / WebhookPropertiesDTO
+
+# Interface: WebhookPropertiesDTO
+
+[types](../modules/types.md).WebhookPropertiesDTO
+
+**`Export`**
+
+WebhookPropertiesDTO
+
+## Table of contents
+
+### Properties
+
+- [basicAuthentication](types.WebhookPropertiesDTO.md#basicauthentication)
+- [bearerAuthentication](types.WebhookPropertiesDTO.md#bearerauthentication)
+- [disableSslVerification](types.WebhookPropertiesDTO.md#disablesslverification)
+- [method](types.WebhookPropertiesDTO.md#method)
+- [secretToken](types.WebhookPropertiesDTO.md#secrettoken)
+- [url](types.WebhookPropertiesDTO.md#url)
+
+## Properties
+
+### basicAuthentication
+
+• `Optional` **basicAuthentication**: [`BasicAuthenticationDTO`](types.BasicAuthenticationDTO.md)
+
+**`Memberof`**
+
+WebhookPropertiesDTO
+
+#### Defined in
+
+[types/index.ts:1944](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1944)
+
+___
+
+### bearerAuthentication
+
+• `Optional` **bearerAuthentication**: `string`
+
+**`Memberof`**
+
+WebhookPropertiesDTO
+
+#### Defined in
+
+[types/index.ts:1950](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1950)
+
+___
+
+### disableSslVerification
+
+• **disableSslVerification**: `boolean`
+
+**`Memberof`**
+
+WebhookPropertiesDTO
+
+#### Defined in
+
+[types/index.ts:1926](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1926)
+
+___
+
+### method
+
+• **method**: [`HttpType`](../enums/types.HttpType.md)
+
+**`Memberof`**
+
+WebhookPropertiesDTO
+
+#### Defined in
+
+[types/index.ts:1932](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1932)
+
+___
+
+### secretToken
+
+• `Optional` **secretToken**: `string`
+
+**`Memberof`**
+
+WebhookPropertiesDTO
+
+#### Defined in
+
+[types/index.ts:1956](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1956)
+
+___
+
+### url
+
+• **url**: `string`
+
+**`Memberof`**
+
+WebhookPropertiesDTO
+
+#### Defined in
+
+[types/index.ts:1938](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1938)

package/doc/interfaces/types.X509Certificate.md

@@ -0,0 +1,89 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / X509Certificate
+
+# Interface: X509Certificate
+
+[types](../modules/types.md).X509Certificate
+
+**`Export`**
+
+X509Certificate
+
+## Table of contents
+
+### Properties
+
+- [application](types.X509Certificate.md#application)
+- [bundle](types.X509Certificate.md#bundle)
+- [id](types.X509Certificate.md#id)
+- [source\_environment](types.X509Certificate.md#source_environment)
+- [subject\_dn](types.X509Certificate.md#subject_dn)
+
+## Properties
+
+### application
+
+• **application**: `string`
+
+**`Memberof`**
+
+X509Certificate
+
+#### Defined in
+
+[types/index.ts:1995](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1995)
+
+___
+
+### bundle
+
+• **bundle**: `string`
+
+**`Memberof`**
+
+X509Certificate
+
+#### Defined in
+
+[types/index.ts:1989](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1989)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+**`Memberof`**
+
+X509Certificate
+
+#### Defined in
+
+[types/index.ts:1971](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1971)
+
+___
+
+### source\_environment
+
+• **source\_environment**: `string`
+
+**`Memberof`**
+
+X509Certificate
+
+#### Defined in
+
+[types/index.ts:1983](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1983)
+
+___
+
+### subject\_dn
+
+• **subject\_dn**: `string`
+
+**`Memberof`**
+
+X509Certificate
+
+#### Defined in
+
+[types/index.ts:1977](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/types/index.ts#L1977)

package/doc/modules/DrawerResourceV1GetDrawerEntries.md

@@ -0,0 +1,78 @@
+[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / DrawerResourceV1GetDrawerEntries
+
+# Module: DrawerResourceV1GetDrawerEntries
+
+## Table of contents
+
+### References
+
+- [default](DrawerResourceV1GetDrawerEntries.md#default)
+
+### Type Aliases
+
+- [DrawerResourceV1GetDrawerEntriesParams](DrawerResourceV1GetDrawerEntries.md#drawerresourcev1getdrawerentriesparams)
+
+### Functions
+
+- [drawerResourceV1GetDrawerEntriesParamCreator](DrawerResourceV1GetDrawerEntries.md#drawerresourcev1getdrawerentriesparamcreator)
+
+## References
+
+### default
+
+Renames and re-exports [drawerResourceV1GetDrawerEntriesParamCreator](DrawerResourceV1GetDrawerEntries.md#drawerresourcev1getdrawerentriesparamcreator)
+
+## Type Aliases
+
+### DrawerResourceV1GetDrawerEntriesParams
+
+Ƭ **DrawerResourceV1GetDrawerEntriesParams**: `Object`
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `appIds?` | `Set`\<`string`\> | **`Memberof`** DrawerResourceV1GetDrawerEntriesApi |
+| `bundleIds?` | `Set`\<`string`\> | **`Memberof`** DrawerResourceV1GetDrawerEntriesApi |
+| `endDate?` | `string` | **`Memberof`** DrawerResourceV1GetDrawerEntriesApi |
+| `eventTypeIds?` | `Set`\<`string`\> | **`Memberof`** DrawerResourceV1GetDrawerEntriesApi |
+| `limit?` | `number` | **`Memberof`** DrawerResourceV1GetDrawerEntriesApi |
+| `offset?` | `number` | **`Memberof`** DrawerResourceV1GetDrawerEntriesApi |
+| `options?` | `AxiosRequestConfig` | - |
+| `pageNumber?` | `number` | **`Memberof`** DrawerResourceV1GetDrawerEntriesApi |
+| `readStatus?` | `boolean` | **`Memberof`** DrawerResourceV1GetDrawerEntriesApi |
+| `sortBy?` | `string` | **`Memberof`** DrawerResourceV1GetDrawerEntriesApi |
+| `sortBy2?` | `string` | **`Memberof`** DrawerResourceV1GetDrawerEntriesApi |
+| `startDate?` | `string` | **`Memberof`** DrawerResourceV1GetDrawerEntriesApi |
+
+#### Defined in
+
+[DrawerResourceV1GetDrawerEntries/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/DrawerResourceV1GetDrawerEntries/index.ts#L14)
+
+## Functions
+
+### drawerResourceV1GetDrawerEntriesParamCreator
+
+▸ **drawerResourceV1GetDrawerEntriesParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
+
+Allowed `sort_by` fields are `bundleIds`, `applicationIds`, `eventTypeIds`, `startTime`, `endTime` and `read`. The ordering can be optionally specified by appending `:asc` or `:desc` to the field, e.g. `bundle:desc`. Defaults to `desc` for the `created` field and to `asc` for all other fields.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `...config` | [[`DrawerResourceV1GetDrawerEntriesParams`](DrawerResourceV1GetDrawerEntries.md#drawerresourcev1getdrawerentriesparams)] \| [`Set`\<`string`\>, `Set`\<`string`\>, `string`, `Set`\<`string`\>, `number`, `number`, `number`, `boolean`, `string`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
+
+#### Returns
+
+`Promise`\<`RequestArgs`\>
+
+**`Summary`**
+
+Retrieve drawer notifications entries.
+
+**`Throws`**
+
+#### Defined in
+
+[DrawerResourceV1GetDrawerEntries/index.ts:94](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/DrawerResourceV1GetDrawerEntries/index.ts#L94)