@redhat-cloud-services/notifications-client 2.4.0 → 2.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. package/CHANGELOG.md +2 -0
  2. package/README.md +1 -1
  3. package/dist/configuration.d.ts +0 -11
  4. package/dist/configuration.d.ts.map +1 -1
  5. package/dist/configuration.js +0 -11
  6. package/dist/configuration.js.map +1 -1
  7. package/dist/index.d.ts +0 -1
  8. package/dist/index.d.ts.map +1 -1
  9. package/dist/index.js +0 -1
  10. package/dist/index.js.map +1 -1
  11. package/doc/README.md +28 -56
  12. package/doc/classes/{BaseAPI.md → index.BaseAPI.md} +9 -7
  13. package/doc/classes/{RequiredError.md → index.RequiredError.md} +13 -11
  14. package/doc/enums/{EndpointStatus.md → types.EndpointStatus.md} +9 -7
  15. package/doc/enums/{EndpointType.md → types.EndpointType.md} +8 -6
  16. package/doc/enums/{Environment.md → types.Environment.md} +7 -5
  17. package/doc/enums/{EventLogEntryActionStatus.md → types.EventLogEntryActionStatus.md} +8 -6
  18. package/doc/enums/{HttpType.md → types.HttpType.md} +6 -4
  19. package/doc/enums/{NotificationStatus.md → types.NotificationStatus.md} +8 -6
  20. package/doc/enums/{Status.md → types.Status.md} +5 -3
  21. package/doc/enums/{SubscriptionType.md → types.SubscriptionType.md} +6 -4
  22. package/doc/interfaces/{RequestArgs.md → index.RequestArgs.md} +5 -3
  23. package/doc/interfaces/{AddAccessRequest.md → types.AddAccessRequest.md} +5 -3
  24. package/doc/interfaces/{AddApplicationRequest.md → types.AddApplicationRequest.md} +7 -5
  25. package/doc/interfaces/{AggregationEmailTemplate.md → types.AggregationEmailTemplate.md} +17 -15
  26. package/doc/interfaces/{AggregationEmailTemplateSubjectTemplate.md → types.AggregationEmailTemplateSubjectTemplate.md} +9 -7
  27. package/doc/interfaces/{Application.md → types.Application.md} +9 -7
  28. package/doc/interfaces/{Application1.md → types.Application1.md} +5 -3
  29. package/doc/interfaces/{ApplicationDTO.md → types.ApplicationDTO.md} +9 -7
  30. package/doc/interfaces/{ApplicationSettingsValue.md → types.ApplicationSettingsValue.md} +5 -3
  31. package/doc/interfaces/{BasicAuthentication.md → types.BasicAuthentication.md} +5 -3
  32. package/doc/interfaces/{BehaviorGroup.md → types.BehaviorGroup.md} +15 -13
  33. package/doc/interfaces/{BehaviorGroupAction.md → types.BehaviorGroupAction.md} +8 -6
  34. package/doc/interfaces/{BehaviorGroupActionId.md → types.BehaviorGroupActionId.md} +5 -3
  35. package/doc/interfaces/{Bundle.md → types.Bundle.md} +8 -6
  36. package/doc/interfaces/{BundleSettingsValue.md → types.BundleSettingsValue.md} +5 -3
  37. package/doc/interfaces/{CamelProperties.md → types.CamelProperties.md} +11 -9
  38. package/doc/interfaces/{CreateBehaviorGroupRequest.md → types.CreateBehaviorGroupRequest.md} +9 -7
  39. package/doc/interfaces/{CreateBehaviorGroupResponse.md → types.CreateBehaviorGroupResponse.md} +9 -7
  40. package/doc/interfaces/{CurrentStatus.md → types.CurrentStatus.md} +7 -5
  41. package/doc/interfaces/{DrawerEntryPayload.md → types.DrawerEntryPayload.md} +10 -8
  42. package/doc/interfaces/{DuplicateNameMigrationReport.md → types.DuplicateNameMigrationReport.md} +5 -3
  43. package/doc/interfaces/{Endpoint.md → types.Endpoint.md} +16 -14
  44. package/doc/interfaces/{EndpointPage.md → types.EndpointPage.md} +8 -6
  45. package/doc/interfaces/{EndpointTestRequest.md → types.EndpointTestRequest.md} +4 -2
  46. package/doc/interfaces/{EventLogEntry.md → types.EventLogEntry.md} +11 -9
  47. package/doc/interfaces/{EventLogEntryAction.md → types.EventLogEntryAction.md} +12 -10
  48. package/doc/interfaces/{EventType.md → types.EventType.md} +15 -13
  49. package/doc/interfaces/{EventTypeBehavior.md → types.EventTypeBehavior.md} +8 -6
  50. package/doc/interfaces/{EventTypeBehaviorId.md → types.EventTypeBehaviorId.md} +5 -3
  51. package/doc/interfaces/{EventTypeSettingsValue.md → types.EventTypeSettingsValue.md} +6 -4
  52. package/doc/interfaces/{Facet.md → types.Facet.md} +8 -6
  53. package/doc/interfaces/{InstantEmailTemplate.md → types.InstantEmailTemplate.md} +15 -13
  54. package/doc/interfaces/{InternalApplicationUserPermission.md → types.InternalApplicationUserPermission.md} +6 -4
  55. package/doc/interfaces/{InternalRoleAccess.md → types.InternalRoleAccess.md} +6 -4
  56. package/doc/interfaces/{InternalUserPermissions.md → types.InternalUserPermissions.md} +7 -5
  57. package/doc/interfaces/{MessageValidationResponse.md → types.MessageValidationResponse.md} +4 -2
  58. package/doc/interfaces/{Meta.md → types.Meta.md} +4 -2
  59. package/doc/interfaces/{NotificationHistory.md → types.NotificationHistory.md} +14 -12
  60. package/doc/interfaces/{PageBehaviorGroup.md → types.PageBehaviorGroup.md} +8 -6
  61. package/doc/interfaces/{PageDrawerEntryPayload.md → types.PageDrawerEntryPayload.md} +8 -6
  62. package/doc/interfaces/{PageEventLogEntry.md → types.PageEventLogEntry.md} +8 -6
  63. package/doc/interfaces/{PageEventType.md → types.PageEventType.md} +8 -6
  64. package/doc/interfaces/{PageNotificationHistory.md → types.PageNotificationHistory.md} +8 -6
  65. package/doc/interfaces/{RenderEmailTemplateRequest.md → types.RenderEmailTemplateRequest.md} +5 -3
  66. package/doc/interfaces/{RequestDefaultBehaviorGroupPropertyList.md → types.RequestDefaultBehaviorGroupPropertyList.md} +5 -3
  67. package/doc/interfaces/{RequestSystemSubscriptionProperties.md → types.RequestSystemSubscriptionProperties.md} +5 -3
  68. package/doc/interfaces/{ServerInfo.md → types.ServerInfo.md} +5 -3
  69. package/doc/interfaces/{SettingsValuesByEventType.md → types.SettingsValuesByEventType.md} +5 -3
  70. package/doc/interfaces/{SystemSubscriptionProperties.md → types.SystemSubscriptionProperties.md} +6 -4
  71. package/doc/interfaces/{Template.md → types.Template.md} +9 -7
  72. package/doc/interfaces/{TriggerDailyDigestRequest.md → types.TriggerDailyDigestRequest.md} +8 -6
  73. package/doc/interfaces/{UpdateApplicationRequest.md → types.UpdateApplicationRequest.md} +6 -4
  74. package/doc/interfaces/{UpdateBehaviorGroupRequest.md → types.UpdateBehaviorGroupRequest.md} +7 -5
  75. package/doc/interfaces/{UpdateNotificationDrawerStatus.md → types.UpdateNotificationDrawerStatus.md} +5 -3
  76. package/doc/interfaces/{WebhookProperties.md → types.WebhookProperties.md} +11 -9
  77. package/doc/interfaces/{X509Certificate.md → types.X509Certificate.md} +8 -6
  78. package/doc/modules/DrawerResourceV1GetDrawerEntries.md +78 -0
  79. package/doc/modules/DrawerResourceV1UpdateNotificationReadStatus.md +68 -0
  80. package/doc/modules/EventResourceV1GetEvents.md +83 -0
  81. package/doc/modules/NotificationResourceV1AppendBehaviorGroupToEventType.md +67 -0
  82. package/doc/modules/NotificationResourceV1CreateBehaviorGroup.md +68 -0
  83. package/doc/modules/NotificationResourceV1DeleteBehaviorGroup.md +68 -0
  84. package/doc/modules/NotificationResourceV1DeleteBehaviorGroupFromEventType.md +69 -0
  85. package/doc/modules/NotificationResourceV1FindBehaviorGroupsByBundleId.md +68 -0
  86. package/doc/modules/NotificationResourceV1GetApplicationByNameAndBundleName.md +69 -0
  87. package/doc/modules/NotificationResourceV1GetApplicationsFacets.md +68 -0
  88. package/doc/modules/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint.md +68 -0
  89. package/doc/modules/NotificationResourceV1GetBundleByName.md +68 -0
  90. package/doc/modules/NotificationResourceV1GetBundleFacets.md +68 -0
  91. package/doc/modules/NotificationResourceV1GetEventTypes.md +75 -0
  92. package/doc/modules/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup.md +68 -0
  93. package/doc/modules/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName.md +70 -0
  94. package/doc/modules/NotificationResourceV1GetLinkedBehaviorGroups.md +73 -0
  95. package/doc/modules/NotificationResourceV1UpdateBehaviorGroup.md +69 -0
  96. package/doc/modules/NotificationResourceV1UpdateBehaviorGroupActions.md +69 -0
  97. package/doc/modules/NotificationResourceV1UpdateEventTypeBehaviors.md +69 -0
  98. package/doc/modules/OrgConfigResourceV1GetDailyDigestTimePreference.md +67 -0
  99. package/doc/modules/OrgConfigResourceV1SaveDailyDigestTimePreference.md +68 -0
  100. package/doc/modules/index.md +648 -0
  101. package/doc/modules/types.md +74 -0
  102. package/doc/modules.md +28 -751
  103. package/package.json +1 -1
@@ -0,0 +1,67 @@
1
+ [@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1AppendBehaviorGroupToEventType
2
+
3
+ # Module: NotificationResourceV1AppendBehaviorGroupToEventType
4
+
5
+ ## Table of contents
6
+
7
+ ### References
8
+
9
+ - [default](NotificationResourceV1AppendBehaviorGroupToEventType.md#default)
10
+
11
+ ### Type Aliases
12
+
13
+ - [NotificationResourceV1AppendBehaviorGroupToEventTypeParams](NotificationResourceV1AppendBehaviorGroupToEventType.md#notificationresourcev1appendbehaviorgrouptoeventtypeparams)
14
+
15
+ ### Functions
16
+
17
+ - [notificationResourceV1AppendBehaviorGroupToEventTypeParamCreator](NotificationResourceV1AppendBehaviorGroupToEventType.md#notificationresourcev1appendbehaviorgrouptoeventtypeparamcreator)
18
+
19
+ ## References
20
+
21
+ ### default
22
+
23
+ Renames and re-exports [notificationResourceV1AppendBehaviorGroupToEventTypeParamCreator](NotificationResourceV1AppendBehaviorGroupToEventType.md#notificationresourcev1appendbehaviorgrouptoeventtypeparamcreator)
24
+
25
+ ## Type Aliases
26
+
27
+ ### NotificationResourceV1AppendBehaviorGroupToEventTypeParams
28
+
29
+ Ƭ **NotificationResourceV1AppendBehaviorGroupToEventTypeParams**: `Object`
30
+
31
+ #### Type declaration
32
+
33
+ | Name | Type | Description |
34
+ | :------ | :------ | :------ |
35
+ | `behaviorGroupUuid` | `string` | **`Memberof`** NotificationResourceV1AppendBehaviorGroupToEventTypeApi |
36
+ | `eventTypeUuid` | `string` | **`Memberof`** NotificationResourceV1AppendBehaviorGroupToEventTypeApi |
37
+ | `options?` | `AxiosRequestConfig` | - |
38
+
39
+ #### Defined in
40
+
41
+ [packages/notifications/NotificationResourceV1AppendBehaviorGroupToEventType/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1AppendBehaviorGroupToEventType/index.ts#L14)
42
+
43
+ ## Functions
44
+
45
+ ### notificationResourceV1AppendBehaviorGroupToEventTypeParamCreator
46
+
47
+ ▸ **notificationResourceV1AppendBehaviorGroupToEventTypeParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
48
+
49
+ #### Parameters
50
+
51
+ | Name | Type | Description |
52
+ | :------ | :------ | :------ |
53
+ | `...config` | [[`NotificationResourceV1AppendBehaviorGroupToEventTypeParams`](NotificationResourceV1AppendBehaviorGroupToEventType.md#notificationresourcev1appendbehaviorgrouptoeventtypeparams)] \| [`string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
54
+
55
+ #### Returns
56
+
57
+ `Promise`\<`RequestArgs`\>
58
+
59
+ **`Summary`**
60
+
61
+ Add a behavior group to the given event type.
62
+
63
+ **`Throws`**
64
+
65
+ #### Defined in
66
+
67
+ [packages/notifications/NotificationResourceV1AppendBehaviorGroupToEventType/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1AppendBehaviorGroupToEventType/index.ts#L40)
@@ -0,0 +1,68 @@
1
+ [@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1CreateBehaviorGroup
2
+
3
+ # Module: NotificationResourceV1CreateBehaviorGroup
4
+
5
+ ## Table of contents
6
+
7
+ ### References
8
+
9
+ - [default](NotificationResourceV1CreateBehaviorGroup.md#default)
10
+
11
+ ### Type Aliases
12
+
13
+ - [NotificationResourceV1CreateBehaviorGroupParams](NotificationResourceV1CreateBehaviorGroup.md#notificationresourcev1createbehaviorgroupparams)
14
+
15
+ ### Functions
16
+
17
+ - [notificationResourceV1CreateBehaviorGroupParamCreator](NotificationResourceV1CreateBehaviorGroup.md#notificationresourcev1createbehaviorgroupparamcreator)
18
+
19
+ ## References
20
+
21
+ ### default
22
+
23
+ Renames and re-exports [notificationResourceV1CreateBehaviorGroupParamCreator](NotificationResourceV1CreateBehaviorGroup.md#notificationresourcev1createbehaviorgroupparamcreator)
24
+
25
+ ## Type Aliases
26
+
27
+ ### NotificationResourceV1CreateBehaviorGroupParams
28
+
29
+ Ƭ **NotificationResourceV1CreateBehaviorGroupParams**: `Object`
30
+
31
+ #### Type declaration
32
+
33
+ | Name | Type | Description |
34
+ | :------ | :------ | :------ |
35
+ | `createBehaviorGroupRequest` | [`CreateBehaviorGroupRequest`](../interfaces/types.CreateBehaviorGroupRequest.md) | **`Memberof`** NotificationResourceV1CreateBehaviorGroupApi |
36
+ | `options?` | `AxiosRequestConfig` | - |
37
+
38
+ #### Defined in
39
+
40
+ [packages/notifications/NotificationResourceV1CreateBehaviorGroup/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1CreateBehaviorGroup/index.ts#L14)
41
+
42
+ ## Functions
43
+
44
+ ### notificationResourceV1CreateBehaviorGroupParamCreator
45
+
46
+ ▸ **notificationResourceV1CreateBehaviorGroupParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
47
+
48
+ Creates a behavior group that defines which notifications will be sent to external services after an event is received. Use this endpoint to control the types of events users are notified about.
49
+
50
+ #### Parameters
51
+
52
+ | Name | Type | Description |
53
+ | :------ | :------ | :------ |
54
+ | `...config` | [[`NotificationResourceV1CreateBehaviorGroupParams`](NotificationResourceV1CreateBehaviorGroup.md#notificationresourcev1createbehaviorgroupparams)] \| [[`CreateBehaviorGroupRequest`](../interfaces/types.CreateBehaviorGroupRequest.md), `AxiosRequestConfig`\<`any`\>] | with all available params. |
55
+
56
+ #### Returns
57
+
58
+ `Promise`\<`RequestArgs`\>
59
+
60
+ **`Summary`**
61
+
62
+ Create a behavior group
63
+
64
+ **`Throws`**
65
+
66
+ #### Defined in
67
+
68
+ [packages/notifications/NotificationResourceV1CreateBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1CreateBehaviorGroup/index.ts#L34)
@@ -0,0 +1,68 @@
1
+ [@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1DeleteBehaviorGroup
2
+
3
+ # Module: NotificationResourceV1DeleteBehaviorGroup
4
+
5
+ ## Table of contents
6
+
7
+ ### References
8
+
9
+ - [default](NotificationResourceV1DeleteBehaviorGroup.md#default)
10
+
11
+ ### Type Aliases
12
+
13
+ - [NotificationResourceV1DeleteBehaviorGroupParams](NotificationResourceV1DeleteBehaviorGroup.md#notificationresourcev1deletebehaviorgroupparams)
14
+
15
+ ### Functions
16
+
17
+ - [notificationResourceV1DeleteBehaviorGroupParamCreator](NotificationResourceV1DeleteBehaviorGroup.md#notificationresourcev1deletebehaviorgroupparamcreator)
18
+
19
+ ## References
20
+
21
+ ### default
22
+
23
+ Renames and re-exports [notificationResourceV1DeleteBehaviorGroupParamCreator](NotificationResourceV1DeleteBehaviorGroup.md#notificationresourcev1deletebehaviorgroupparamcreator)
24
+
25
+ ## Type Aliases
26
+
27
+ ### NotificationResourceV1DeleteBehaviorGroupParams
28
+
29
+ Ƭ **NotificationResourceV1DeleteBehaviorGroupParams**: `Object`
30
+
31
+ #### Type declaration
32
+
33
+ | Name | Type | Description |
34
+ | :------ | :------ | :------ |
35
+ | `id` | `string` | The UUID of the behavior group to delete **`Memberof`** NotificationResourceV1DeleteBehaviorGroupApi |
36
+ | `options?` | `AxiosRequestConfig` | - |
37
+
38
+ #### Defined in
39
+
40
+ [packages/notifications/NotificationResourceV1DeleteBehaviorGroup/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1DeleteBehaviorGroup/index.ts#L14)
41
+
42
+ ## Functions
43
+
44
+ ### notificationResourceV1DeleteBehaviorGroupParamCreator
45
+
46
+ ▸ **notificationResourceV1DeleteBehaviorGroupParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
47
+
48
+ Deletes a behavior group and all of its configured actions. Use this endpoint when you no longer need a behavior group.
49
+
50
+ #### Parameters
51
+
52
+ | Name | Type | Description |
53
+ | :------ | :------ | :------ |
54
+ | `...config` | [[`NotificationResourceV1DeleteBehaviorGroupParams`](NotificationResourceV1DeleteBehaviorGroup.md#notificationresourcev1deletebehaviorgroupparams)] \| [`string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
55
+
56
+ #### Returns
57
+
58
+ `Promise`\<`RequestArgs`\>
59
+
60
+ **`Summary`**
61
+
62
+ Delete a behavior group
63
+
64
+ **`Throws`**
65
+
66
+ #### Defined in
67
+
68
+ [packages/notifications/NotificationResourceV1DeleteBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1DeleteBehaviorGroup/index.ts#L34)
@@ -0,0 +1,69 @@
1
+ [@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1DeleteBehaviorGroupFromEventType
2
+
3
+ # Module: NotificationResourceV1DeleteBehaviorGroupFromEventType
4
+
5
+ ## Table of contents
6
+
7
+ ### References
8
+
9
+ - [default](NotificationResourceV1DeleteBehaviorGroupFromEventType.md#default)
10
+
11
+ ### Type Aliases
12
+
13
+ - [NotificationResourceV1DeleteBehaviorGroupFromEventTypeParams](NotificationResourceV1DeleteBehaviorGroupFromEventType.md#notificationresourcev1deletebehaviorgroupfromeventtypeparams)
14
+
15
+ ### Functions
16
+
17
+ - [notificationResourceV1DeleteBehaviorGroupFromEventTypeParamCreator](NotificationResourceV1DeleteBehaviorGroupFromEventType.md#notificationresourcev1deletebehaviorgroupfromeventtypeparamcreator)
18
+
19
+ ## References
20
+
21
+ ### default
22
+
23
+ Renames and re-exports [notificationResourceV1DeleteBehaviorGroupFromEventTypeParamCreator](NotificationResourceV1DeleteBehaviorGroupFromEventType.md#notificationresourcev1deletebehaviorgroupfromeventtypeparamcreator)
24
+
25
+ ## Type Aliases
26
+
27
+ ### NotificationResourceV1DeleteBehaviorGroupFromEventTypeParams
28
+
29
+ Ƭ **NotificationResourceV1DeleteBehaviorGroupFromEventTypeParams**: `Object`
30
+
31
+ #### Type declaration
32
+
33
+ | Name | Type | Description |
34
+ | :------ | :------ | :------ |
35
+ | `behaviorGroupId` | `string` | **`Memberof`** NotificationResourceV1DeleteBehaviorGroupFromEventTypeApi |
36
+ | `eventTypeId` | `string` | **`Memberof`** NotificationResourceV1DeleteBehaviorGroupFromEventTypeApi |
37
+ | `options?` | `AxiosRequestConfig` | - |
38
+
39
+ #### Defined in
40
+
41
+ [packages/notifications/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.ts#L14)
42
+
43
+ ## Functions
44
+
45
+ ### notificationResourceV1DeleteBehaviorGroupFromEventTypeParamCreator
46
+
47
+ ▸ **notificationResourceV1DeleteBehaviorGroupFromEventTypeParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
48
+
49
+ Adds a behavior group to the specified event type.
50
+
51
+ #### Parameters
52
+
53
+ | Name | Type | Description |
54
+ | :------ | :------ | :------ |
55
+ | `...config` | [`string`, `string`, `AxiosRequestConfig`\<`any`\>] \| [[`NotificationResourceV1DeleteBehaviorGroupFromEventTypeParams`](NotificationResourceV1DeleteBehaviorGroupFromEventType.md#notificationresourcev1deletebehaviorgroupfromeventtypeparams)] | with all available params. |
56
+
57
+ #### Returns
58
+
59
+ `Promise`\<`RequestArgs`\>
60
+
61
+ **`Summary`**
62
+
63
+ Add a behavior group to an event type
64
+
65
+ **`Throws`**
66
+
67
+ #### Defined in
68
+
69
+ [packages/notifications/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.ts#L40)
@@ -0,0 +1,68 @@
1
+ [@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1FindBehaviorGroupsByBundleId
2
+
3
+ # Module: NotificationResourceV1FindBehaviorGroupsByBundleId
4
+
5
+ ## Table of contents
6
+
7
+ ### References
8
+
9
+ - [default](NotificationResourceV1FindBehaviorGroupsByBundleId.md#default)
10
+
11
+ ### Type Aliases
12
+
13
+ - [NotificationResourceV1FindBehaviorGroupsByBundleIdParams](NotificationResourceV1FindBehaviorGroupsByBundleId.md#notificationresourcev1findbehaviorgroupsbybundleidparams)
14
+
15
+ ### Functions
16
+
17
+ - [notificationResourceV1FindBehaviorGroupsByBundleIdParamCreator](NotificationResourceV1FindBehaviorGroupsByBundleId.md#notificationresourcev1findbehaviorgroupsbybundleidparamcreator)
18
+
19
+ ## References
20
+
21
+ ### default
22
+
23
+ Renames and re-exports [notificationResourceV1FindBehaviorGroupsByBundleIdParamCreator](NotificationResourceV1FindBehaviorGroupsByBundleId.md#notificationresourcev1findbehaviorgroupsbybundleidparamcreator)
24
+
25
+ ## Type Aliases
26
+
27
+ ### NotificationResourceV1FindBehaviorGroupsByBundleIdParams
28
+
29
+ Ƭ **NotificationResourceV1FindBehaviorGroupsByBundleIdParams**: `Object`
30
+
31
+ #### Type declaration
32
+
33
+ | Name | Type | Description |
34
+ | :------ | :------ | :------ |
35
+ | `bundleId` | `string` | UUID of the bundle to retrieve the behavior groups for. **`Memberof`** NotificationResourceV1FindBehaviorGroupsByBundleIdApi |
36
+ | `options?` | `AxiosRequestConfig` | - |
37
+
38
+ #### Defined in
39
+
40
+ [packages/notifications/NotificationResourceV1FindBehaviorGroupsByBundleId/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1FindBehaviorGroupsByBundleId/index.ts#L14)
41
+
42
+ ## Functions
43
+
44
+ ### notificationResourceV1FindBehaviorGroupsByBundleIdParamCreator
45
+
46
+ ▸ **notificationResourceV1FindBehaviorGroupsByBundleIdParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
47
+
48
+ Lists the behavior groups associated with a bundle. Use this endpoint to see the behavior groups that are configured for a particular bundle for a particular tenant.
49
+
50
+ #### Parameters
51
+
52
+ | Name | Type | Description |
53
+ | :------ | :------ | :------ |
54
+ | `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [[`NotificationResourceV1FindBehaviorGroupsByBundleIdParams`](NotificationResourceV1FindBehaviorGroupsByBundleId.md#notificationresourcev1findbehaviorgroupsbybundleidparams)] | with all available params. |
55
+
56
+ #### Returns
57
+
58
+ `Promise`\<`RequestArgs`\>
59
+
60
+ **`Summary`**
61
+
62
+ List behavior groups in a bundle
63
+
64
+ **`Throws`**
65
+
66
+ #### Defined in
67
+
68
+ [packages/notifications/NotificationResourceV1FindBehaviorGroupsByBundleId/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1FindBehaviorGroupsByBundleId/index.ts#L34)
@@ -0,0 +1,69 @@
1
+ [@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1GetApplicationByNameAndBundleName
2
+
3
+ # Module: NotificationResourceV1GetApplicationByNameAndBundleName
4
+
5
+ ## Table of contents
6
+
7
+ ### References
8
+
9
+ - [default](NotificationResourceV1GetApplicationByNameAndBundleName.md#default)
10
+
11
+ ### Type Aliases
12
+
13
+ - [NotificationResourceV1GetApplicationByNameAndBundleNameParams](NotificationResourceV1GetApplicationByNameAndBundleName.md#notificationresourcev1getapplicationbynameandbundlenameparams)
14
+
15
+ ### Functions
16
+
17
+ - [notificationResourceV1GetApplicationByNameAndBundleNameParamCreator](NotificationResourceV1GetApplicationByNameAndBundleName.md#notificationresourcev1getapplicationbynameandbundlenameparamcreator)
18
+
19
+ ## References
20
+
21
+ ### default
22
+
23
+ Renames and re-exports [notificationResourceV1GetApplicationByNameAndBundleNameParamCreator](NotificationResourceV1GetApplicationByNameAndBundleName.md#notificationresourcev1getapplicationbynameandbundlenameparamcreator)
24
+
25
+ ## Type Aliases
26
+
27
+ ### NotificationResourceV1GetApplicationByNameAndBundleNameParams
28
+
29
+ Ƭ **NotificationResourceV1GetApplicationByNameAndBundleNameParams**: `Object`
30
+
31
+ #### Type declaration
32
+
33
+ | Name | Type | Description |
34
+ | :------ | :------ | :------ |
35
+ | `applicationName` | `string` | **`Memberof`** NotificationResourceV1GetApplicationByNameAndBundleNameApi |
36
+ | `bundleName` | `string` | **`Memberof`** NotificationResourceV1GetApplicationByNameAndBundleNameApi |
37
+ | `options?` | `AxiosRequestConfig` | - |
38
+
39
+ #### Defined in
40
+
41
+ [packages/notifications/NotificationResourceV1GetApplicationByNameAndBundleName/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetApplicationByNameAndBundleName/index.ts#L14)
42
+
43
+ ## Functions
44
+
45
+ ### notificationResourceV1GetApplicationByNameAndBundleNameParamCreator
46
+
47
+ ▸ **notificationResourceV1GetApplicationByNameAndBundleNameParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
48
+
49
+ Retrieves an application by bundle and application names. Use this endpoint to find an application by searching for the bundle that the application is part of. This is useful if you do not know the UUID of the bundle or application.
50
+
51
+ #### Parameters
52
+
53
+ | Name | Type | Description |
54
+ | :------ | :------ | :------ |
55
+ | `...config` | [`string`, `string`, `AxiosRequestConfig`\<`any`\>] \| [[`NotificationResourceV1GetApplicationByNameAndBundleNameParams`](NotificationResourceV1GetApplicationByNameAndBundleName.md#notificationresourcev1getapplicationbynameandbundlenameparams)] | with all available params. |
56
+
57
+ #### Returns
58
+
59
+ `Promise`\<`RequestArgs`\>
60
+
61
+ **`Summary`**
62
+
63
+ Retrieve an application by bundle and application name
64
+
65
+ **`Throws`**
66
+
67
+ #### Defined in
68
+
69
+ [packages/notifications/NotificationResourceV1GetApplicationByNameAndBundleName/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetApplicationByNameAndBundleName/index.ts#L40)
@@ -0,0 +1,68 @@
1
+ [@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1GetApplicationsFacets
2
+
3
+ # Module: NotificationResourceV1GetApplicationsFacets
4
+
5
+ ## Table of contents
6
+
7
+ ### References
8
+
9
+ - [default](NotificationResourceV1GetApplicationsFacets.md#default)
10
+
11
+ ### Type Aliases
12
+
13
+ - [NotificationResourceV1GetApplicationsFacetsParams](NotificationResourceV1GetApplicationsFacets.md#notificationresourcev1getapplicationsfacetsparams)
14
+
15
+ ### Functions
16
+
17
+ - [notificationResourceV1GetApplicationsFacetsParamCreator](NotificationResourceV1GetApplicationsFacets.md#notificationresourcev1getapplicationsfacetsparamcreator)
18
+
19
+ ## References
20
+
21
+ ### default
22
+
23
+ Renames and re-exports [notificationResourceV1GetApplicationsFacetsParamCreator](NotificationResourceV1GetApplicationsFacets.md#notificationresourcev1getapplicationsfacetsparamcreator)
24
+
25
+ ## Type Aliases
26
+
27
+ ### NotificationResourceV1GetApplicationsFacetsParams
28
+
29
+ Ƭ **NotificationResourceV1GetApplicationsFacetsParams**: `Object`
30
+
31
+ #### Type declaration
32
+
33
+ | Name | Type | Description |
34
+ | :------ | :------ | :------ |
35
+ | `bundleName?` | `string` | **`Memberof`** NotificationResourceV1GetApplicationsFacetsApi |
36
+ | `options?` | `AxiosRequestConfig` | - |
37
+
38
+ #### Defined in
39
+
40
+ [packages/notifications/NotificationResourceV1GetApplicationsFacets/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetApplicationsFacets/index.ts#L14)
41
+
42
+ ## Functions
43
+
44
+ ### notificationResourceV1GetApplicationsFacetsParamCreator
45
+
46
+ ▸ **notificationResourceV1GetApplicationsFacetsParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
47
+
48
+ Returns a list of configured applications that includes the application name, the display name, and the ID. You can use this list to configure a filter in the UI.
49
+
50
+ #### Parameters
51
+
52
+ | Name | Type | Description |
53
+ | :------ | :------ | :------ |
54
+ | `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [[`NotificationResourceV1GetApplicationsFacetsParams`](NotificationResourceV1GetApplicationsFacets.md#notificationresourcev1getapplicationsfacetsparams)] | with all available params. |
55
+
56
+ #### Returns
57
+
58
+ `Promise`\<`RequestArgs`\>
59
+
60
+ **`Summary`**
61
+
62
+ List configured application
63
+
64
+ **`Throws`**
65
+
66
+ #### Defined in
67
+
68
+ [packages/notifications/NotificationResourceV1GetApplicationsFacets/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetApplicationsFacets/index.ts#L34)
@@ -0,0 +1,68 @@
1
+ [@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint
2
+
3
+ # Module: NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint
4
+
5
+ ## Table of contents
6
+
7
+ ### References
8
+
9
+ - [default](NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint.md#default)
10
+
11
+ ### Type Aliases
12
+
13
+ - [NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointParams](NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint.md#notificationresourcev1getbehaviorgroupsaffectedbyremovalofendpointparams)
14
+
15
+ ### Functions
16
+
17
+ - [notificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointParamCreator](NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint.md#notificationresourcev1getbehaviorgroupsaffectedbyremovalofendpointparamcreator)
18
+
19
+ ## References
20
+
21
+ ### default
22
+
23
+ Renames and re-exports [notificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointParamCreator](NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint.md#notificationresourcev1getbehaviorgroupsaffectedbyremovalofendpointparamcreator)
24
+
25
+ ## Type Aliases
26
+
27
+ ### NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointParams
28
+
29
+ Ƭ **NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointParams**: `Object`
30
+
31
+ #### Type declaration
32
+
33
+ | Name | Type | Description |
34
+ | :------ | :------ | :------ |
35
+ | `endpointId` | `string` | **`Memberof`** NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointApi |
36
+ | `options?` | `AxiosRequestConfig` | - |
37
+
38
+ #### Defined in
39
+
40
+ [packages/notifications/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.ts#L14)
41
+
42
+ ## Functions
43
+
44
+ ### notificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointParamCreator
45
+
46
+ ▸ **notificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
47
+
48
+ Lists the behavior groups that are affected by the removal of an endpoint. Use this endpoint to understand how removing an endpoint affects existing behavior groups.
49
+
50
+ #### Parameters
51
+
52
+ | Name | Type | Description |
53
+ | :------ | :------ | :------ |
54
+ | `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [[`NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointParams`](NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint.md#notificationresourcev1getbehaviorgroupsaffectedbyremovalofendpointparams)] | with all available params. |
55
+
56
+ #### Returns
57
+
58
+ `Promise`\<`RequestArgs`\>
59
+
60
+ **`Summary`**
61
+
62
+ List the behavior groups affected by the removal of an endpoint
63
+
64
+ **`Throws`**
65
+
66
+ #### Defined in
67
+
68
+ [packages/notifications/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.ts#L34)
@@ -0,0 +1,68 @@
1
+ [@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1GetBundleByName
2
+
3
+ # Module: NotificationResourceV1GetBundleByName
4
+
5
+ ## Table of contents
6
+
7
+ ### References
8
+
9
+ - [default](NotificationResourceV1GetBundleByName.md#default)
10
+
11
+ ### Type Aliases
12
+
13
+ - [NotificationResourceV1GetBundleByNameParams](NotificationResourceV1GetBundleByName.md#notificationresourcev1getbundlebynameparams)
14
+
15
+ ### Functions
16
+
17
+ - [notificationResourceV1GetBundleByNameParamCreator](NotificationResourceV1GetBundleByName.md#notificationresourcev1getbundlebynameparamcreator)
18
+
19
+ ## References
20
+
21
+ ### default
22
+
23
+ Renames and re-exports [notificationResourceV1GetBundleByNameParamCreator](NotificationResourceV1GetBundleByName.md#notificationresourcev1getbundlebynameparamcreator)
24
+
25
+ ## Type Aliases
26
+
27
+ ### NotificationResourceV1GetBundleByNameParams
28
+
29
+ Ƭ **NotificationResourceV1GetBundleByNameParams**: `Object`
30
+
31
+ #### Type declaration
32
+
33
+ | Name | Type | Description |
34
+ | :------ | :------ | :------ |
35
+ | `bundleName` | `string` | **`Memberof`** NotificationResourceV1GetBundleByNameApi |
36
+ | `options?` | `AxiosRequestConfig` | - |
37
+
38
+ #### Defined in
39
+
40
+ [packages/notifications/NotificationResourceV1GetBundleByName/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBundleByName/index.ts#L14)
41
+
42
+ ## Functions
43
+
44
+ ### notificationResourceV1GetBundleByNameParamCreator
45
+
46
+ ▸ **notificationResourceV1GetBundleByNameParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
47
+
48
+ Retrieves the details of a bundle by searching by its name.
49
+
50
+ #### Parameters
51
+
52
+ | Name | Type | Description |
53
+ | :------ | :------ | :------ |
54
+ | `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [[`NotificationResourceV1GetBundleByNameParams`](NotificationResourceV1GetBundleByName.md#notificationresourcev1getbundlebynameparams)] | with all available params. |
55
+
56
+ #### Returns
57
+
58
+ `Promise`\<`RequestArgs`\>
59
+
60
+ **`Summary`**
61
+
62
+ Retrieve a bundle by name
63
+
64
+ **`Throws`**
65
+
66
+ #### Defined in
67
+
68
+ [packages/notifications/NotificationResourceV1GetBundleByName/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBundleByName/index.ts#L34)