@redhat-cloud-services/notifications-client 2.3.1 → 2.4.0
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.
- package/CHANGELOG.md +12 -0
- package/dist/DrawerResourceV1GetDrawerEntries/index.d.ts +1 -1
- package/dist/DrawerResourceV1GetDrawerEntries/index.d.ts.map +1 -1
- package/dist/DrawerResourceV1GetDrawerEntries/index.js +1 -1
- package/dist/DrawerResourceV1GetDrawerEntries/index.js.map +1 -1
- package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.d.ts +1 -1
- package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.d.ts.map +1 -1
- package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.js +1 -1
- package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.js.map +1 -1
- package/dist/EventResourceV1GetEvents/index.d.ts +2 -2
- package/dist/EventResourceV1GetEvents/index.d.ts.map +1 -1
- package/dist/EventResourceV1GetEvents/index.js +2 -2
- package/dist/EventResourceV1GetEvents/index.js.map +1 -1
- package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.d.ts +1 -1
- package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.js +1 -1
- package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.js.map +1 -1
- package/dist/NotificationResourceV1CreateBehaviorGroup/index.d.ts +1 -1
- package/dist/NotificationResourceV1CreateBehaviorGroup/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1CreateBehaviorGroup/index.js +1 -1
- package/dist/NotificationResourceV1CreateBehaviorGroup/index.js.map +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroup/index.d.ts +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroup/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroup/index.js +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroup/index.js.map +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.d.ts +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.js +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.js.map +1 -1
- package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.d.ts +1 -1
- package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.js +1 -1
- package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.js.map +1 -1
- package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.d.ts +2 -2
- package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.js +2 -2
- package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.js.map +1 -1
- package/dist/NotificationResourceV1GetApplicationsFacets/index.d.ts +2 -2
- package/dist/NotificationResourceV1GetApplicationsFacets/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetApplicationsFacets/index.js +2 -2
- package/dist/NotificationResourceV1GetApplicationsFacets/index.js.map +1 -1
- package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.js +1 -1
- package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.js.map +1 -1
- package/dist/NotificationResourceV1GetBundleByName/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetBundleByName/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetBundleByName/index.js +1 -1
- package/dist/NotificationResourceV1GetBundleByName/index.js.map +1 -1
- package/dist/NotificationResourceV1GetBundleFacets/index.d.ts +2 -2
- package/dist/NotificationResourceV1GetBundleFacets/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetBundleFacets/index.js +2 -2
- package/dist/NotificationResourceV1GetBundleFacets/index.js.map +1 -1
- package/dist/NotificationResourceV1GetEventTypes/index.d.ts +2 -2
- package/dist/NotificationResourceV1GetEventTypes/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetEventTypes/index.js +2 -2
- package/dist/NotificationResourceV1GetEventTypes/index.js.map +1 -1
- package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.js +1 -1
- package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.js.map +1 -1
- package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.d.ts +2 -2
- package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.js +2 -2
- package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.js.map +1 -1
- package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.js +1 -1
- package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.js.map +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroup/index.d.ts +2 -2
- package/dist/NotificationResourceV1UpdateBehaviorGroup/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroup/index.js +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroup/index.js.map +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.d.ts +2 -2
- package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.js +2 -2
- package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.js.map +1 -1
- package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.d.ts +1 -1
- package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.js +1 -1
- package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.js.map +1 -1
- package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.d.ts +1 -1
- package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.d.ts.map +1 -1
- package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.js +1 -1
- package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.js.map +1 -1
- package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.d.ts +1 -1
- package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.d.ts.map +1 -1
- package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.js +1 -1
- package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.js.map +1 -1
- package/dist/api.d.ts +76 -70
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js +34 -34
- package/dist/api.js.map +1 -1
- package/dist/base.d.ts +2 -2
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +12 -1
- package/dist/configuration.d.ts.map +1 -1
- package/dist/configuration.js +11 -0
- package/dist/configuration.js.map +1 -1
- package/dist/index.d.ts +1 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -3
- package/dist/index.js.map +1 -1
- package/dist/types/index.d.ts +43 -37
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js.map +1 -1
- package/doc/README.md +2 -1
- package/doc/classes/BaseAPI.md +18 -72
- package/doc/classes/RequiredError.md +17 -11
- package/doc/enums/EndpointStatus.md +6 -6
- package/doc/enums/EndpointType.md +5 -5
- package/doc/enums/Environment.md +4 -4
- package/doc/enums/EventLogEntryActionStatus.md +5 -5
- package/doc/enums/HttpType.md +3 -3
- package/doc/enums/NotificationStatus.md +5 -5
- package/doc/enums/Status.md +2 -2
- package/doc/enums/SubscriptionType.md +3 -3
- package/doc/interfaces/AddAccessRequest.md +2 -4
- package/doc/interfaces/AddApplicationRequest.md +4 -6
- package/doc/interfaces/AggregationEmailTemplate.md +10 -12
- package/doc/interfaces/AggregationEmailTemplateSubjectTemplate.md +6 -8
- package/doc/interfaces/Application.md +6 -8
- package/doc/interfaces/Application1.md +2 -4
- package/doc/interfaces/ApplicationDTO.md +6 -8
- package/doc/interfaces/ApplicationSettingsValue.md +1 -3
- package/doc/interfaces/BasicAuthentication.md +2 -4
- package/doc/interfaces/BehaviorGroup.md +10 -12
- package/doc/interfaces/BehaviorGroupAction.md +3 -5
- package/doc/interfaces/BehaviorGroupActionId.md +2 -4
- package/doc/interfaces/Bundle.md +5 -7
- package/doc/interfaces/BundleSettingsValue.md +1 -3
- package/doc/interfaces/CamelProperties.md +15 -17
- package/doc/interfaces/CreateBehaviorGroupRequest.md +7 -9
- package/doc/interfaces/CreateBehaviorGroupResponse.md +7 -9
- package/doc/interfaces/CurrentStatus.md +7 -9
- package/doc/interfaces/DrawerEntryPayload.md +7 -9
- package/doc/interfaces/DuplicateNameMigrationReport.md +2 -4
- package/doc/interfaces/Endpoint.md +11 -13
- package/doc/interfaces/EndpointPage.md +3 -5
- package/doc/interfaces/EndpointTestRequest.md +1 -3
- package/doc/interfaces/EventLogEntry.md +7 -9
- package/doc/interfaces/EventLogEntryAction.md +7 -9
- package/doc/interfaces/EventType.md +25 -12
- package/doc/interfaces/EventTypeBehavior.md +3 -5
- package/doc/interfaces/EventTypeBehaviorId.md +2 -4
- package/doc/interfaces/EventTypeSettingsValue.md +3 -5
- package/doc/interfaces/Facet.md +4 -6
- package/doc/interfaces/InstantEmailTemplate.md +9 -11
- package/doc/interfaces/InternalApplicationUserPermission.md +3 -5
- package/doc/interfaces/InternalRoleAccess.md +7 -9
- package/doc/interfaces/InternalUserPermissions.md +7 -9
- package/doc/interfaces/MessageValidationResponse.md +1 -3
- package/doc/interfaces/Meta.md +1 -3
- package/doc/interfaces/NotificationHistory.md +9 -11
- package/doc/interfaces/PageBehaviorGroup.md +3 -5
- package/doc/interfaces/PageDrawerEntryPayload.md +3 -5
- package/doc/interfaces/PageEventLogEntry.md +3 -5
- package/doc/interfaces/PageEventType.md +3 -5
- package/doc/interfaces/PageNotificationHistory.md +3 -5
- package/doc/interfaces/RenderEmailTemplateRequest.md +2 -4
- package/doc/interfaces/RequestArgs.md +7 -31
- package/doc/interfaces/RequestDefaultBehaviorGroupPropertyList.md +2 -4
- package/doc/interfaces/RequestSystemSubscriptionProperties.md +5 -7
- package/doc/interfaces/ServerInfo.md +1 -3
- package/doc/interfaces/SettingsValuesByEventType.md +1 -3
- package/doc/interfaces/SystemSubscriptionProperties.md +7 -9
- package/doc/interfaces/Template.md +6 -8
- package/doc/interfaces/TriggerDailyDigestRequest.md +5 -7
- package/doc/interfaces/UpdateApplicationRequest.md +3 -5
- package/doc/interfaces/UpdateBehaviorGroupRequest.md +5 -7
- package/doc/interfaces/UpdateNotificationDrawerStatus.md +6 -8
- package/doc/interfaces/WebhookProperties.md +13 -15
- package/doc/interfaces/X509Certificate.md +5 -7
- package/doc/modules.md +206 -563
- package/package.json +4 -3
- package/dist/utils/base.d.ts +0 -85
- package/dist/utils/base.d.ts.map +0 -1
- package/dist/utils/base.js +0 -191
- package/dist/utils/base.js.map +0 -1
- package/dist/utils/common.d.ts +0 -55
- package/dist/utils/common.d.ts.map +0 -1
- package/dist/utils/common.js +0 -196
- package/dist/utils/common.js.map +0 -1
- package/dist/utils/configuration.d.ts +0 -73
- package/dist/utils/configuration.d.ts.map +0 -1
- package/dist/utils/configuration.js +0 -34
- package/dist/utils/configuration.js.map +0 -1
- package/doc/classes/Configuration.md +0 -194
- package/doc/interfaces/ApiConfig.md +0 -30
- package/doc/interfaces/ConfigurationParameters.md +0 -89
package/doc/modules.md
CHANGED
|
@@ -18,7 +18,6 @@
|
|
|
18
18
|
### Classes
|
|
19
19
|
|
|
20
20
|
- [BaseAPI](classes/BaseAPI.md)
|
|
21
|
-
- [Configuration](classes/Configuration.md)
|
|
22
21
|
- [RequiredError](classes/RequiredError.md)
|
|
23
22
|
|
|
24
23
|
### Interfaces
|
|
@@ -27,7 +26,6 @@
|
|
|
27
26
|
- [AddApplicationRequest](interfaces/AddApplicationRequest.md)
|
|
28
27
|
- [AggregationEmailTemplate](interfaces/AggregationEmailTemplate.md)
|
|
29
28
|
- [AggregationEmailTemplateSubjectTemplate](interfaces/AggregationEmailTemplateSubjectTemplate.md)
|
|
30
|
-
- [ApiConfig](interfaces/ApiConfig.md)
|
|
31
29
|
- [Application](interfaces/Application.md)
|
|
32
30
|
- [Application1](interfaces/Application1.md)
|
|
33
31
|
- [ApplicationDTO](interfaces/ApplicationDTO.md)
|
|
@@ -39,7 +37,6 @@
|
|
|
39
37
|
- [Bundle](interfaces/Bundle.md)
|
|
40
38
|
- [BundleSettingsValue](interfaces/BundleSettingsValue.md)
|
|
41
39
|
- [CamelProperties](interfaces/CamelProperties.md)
|
|
42
|
-
- [ConfigurationParameters](interfaces/ConfigurationParameters.md)
|
|
43
40
|
- [CreateBehaviorGroupRequest](interfaces/CreateBehaviorGroupRequest.md)
|
|
44
41
|
- [CreateBehaviorGroupResponse](interfaces/CreateBehaviorGroupResponse.md)
|
|
45
42
|
- [CurrentStatus](interfaces/CurrentStatus.md)
|
|
@@ -82,23 +79,13 @@
|
|
|
82
79
|
- [WebhookProperties](interfaces/WebhookProperties.md)
|
|
83
80
|
- [X509Certificate](interfaces/X509Certificate.md)
|
|
84
81
|
|
|
85
|
-
### Type Aliases
|
|
86
|
-
|
|
87
|
-
- [ActionType](modules.md#actiontype)
|
|
88
|
-
- [AuthTypeEnum](modules.md#authtypeenum)
|
|
89
|
-
|
|
90
82
|
### Variables
|
|
91
83
|
|
|
92
|
-
- [AuthTypeEnum](modules.md#authtypeenum-1)
|
|
93
84
|
- [BASE\_PATH](modules.md#base_path)
|
|
94
85
|
- [COLLECTION\_FORMATS](modules.md#collection_formats)
|
|
95
|
-
- [DUMMY\_BASE\_URL](modules.md#dummy_base_url)
|
|
96
86
|
|
|
97
87
|
### Functions
|
|
98
88
|
|
|
99
|
-
- [APIFactory](modules.md#apifactory)
|
|
100
|
-
- [assertParamExists](modules.md#assertparamexists)
|
|
101
|
-
- [createRequestFunction](modules.md#createrequestfunction)
|
|
102
89
|
- [drawerResourceV1GetDrawerEntries](modules.md#drawerresourcev1getdrawerentries)
|
|
103
90
|
- [drawerResourceV1UpdateNotificationReadStatus](modules.md#drawerresourcev1updatenotificationreadstatus)
|
|
104
91
|
- [eventResourceV1GetEvents](modules.md#eventresourcev1getevents)
|
|
@@ -121,81 +108,16 @@
|
|
|
121
108
|
- [notificationResourceV1UpdateEventTypeBehaviors](modules.md#notificationresourcev1updateeventtypebehaviors)
|
|
122
109
|
- [orgConfigResourceV1GetDailyDigestTimePreference](modules.md#orgconfigresourcev1getdailydigesttimepreference)
|
|
123
110
|
- [orgConfigResourceV1SaveDailyDigestTimePreference](modules.md#orgconfigresourcev1savedailydigesttimepreference)
|
|
124
|
-
- [serializeDataIfNeeded](modules.md#serializedataifneeded)
|
|
125
|
-
- [setApiKeyToObject](modules.md#setapikeytoobject)
|
|
126
|
-
- [setBasicAuthToObject](modules.md#setbasicauthtoobject)
|
|
127
|
-
- [setBearerAuthToObject](modules.md#setbearerauthtoobject)
|
|
128
|
-
- [setOAuthToObject](modules.md#setoauthtoobject)
|
|
129
|
-
- [setSearchParams](modules.md#setsearchparams)
|
|
130
|
-
- [toPathString](modules.md#topathstring)
|
|
131
|
-
|
|
132
|
-
## Type Aliases
|
|
133
|
-
|
|
134
|
-
### ActionType
|
|
135
|
-
|
|
136
|
-
Ƭ **ActionType**: (...`config`: `any`) => `Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
137
|
-
|
|
138
|
-
#### Type declaration
|
|
139
|
-
|
|
140
|
-
▸ (...`config`): `Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
141
|
-
|
|
142
|
-
##### Parameters
|
|
143
|
-
|
|
144
|
-
| Name | Type |
|
|
145
|
-
| :------ | :------ |
|
|
146
|
-
| `...config` | `any` |
|
|
147
|
-
|
|
148
|
-
##### Returns
|
|
149
|
-
|
|
150
|
-
`Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
151
|
-
|
|
152
|
-
#### Defined in
|
|
153
|
-
|
|
154
|
-
[packages/notifications/utils/base.ts:55](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L55)
|
|
155
|
-
|
|
156
|
-
___
|
|
157
|
-
|
|
158
|
-
### AuthTypeEnum
|
|
159
|
-
|
|
160
|
-
Ƭ **AuthTypeEnum**: typeof [`AuthTypeEnum`](modules.md#authtypeenum-1)[keyof typeof [`AuthTypeEnum`](modules.md#authtypeenum-1)]
|
|
161
|
-
|
|
162
|
-
#### Defined in
|
|
163
|
-
|
|
164
|
-
[packages/notifications/utils/base.ts:45](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L45)
|
|
165
|
-
|
|
166
|
-
[packages/notifications/utils/base.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L53)
|
|
167
111
|
|
|
168
112
|
## Variables
|
|
169
113
|
|
|
170
|
-
### AuthTypeEnum
|
|
171
|
-
|
|
172
|
-
• `Const` **AuthTypeEnum**: `Object`
|
|
173
|
-
|
|
174
|
-
#### Type declaration
|
|
175
|
-
|
|
176
|
-
| Name | Type |
|
|
177
|
-
| :------ | :------ |
|
|
178
|
-
| `Basic` | ``"basic"`` |
|
|
179
|
-
| `Bearer` | ``"bearer"`` |
|
|
180
|
-
| `InHeader` | ``"inHeader"`` |
|
|
181
|
-
| `InQuery` | ``"inQuery"`` |
|
|
182
|
-
| `Oauth` | ``"oath"`` |
|
|
183
|
-
|
|
184
|
-
#### Defined in
|
|
185
|
-
|
|
186
|
-
[packages/notifications/utils/base.ts:45](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L45)
|
|
187
|
-
|
|
188
|
-
[packages/notifications/utils/base.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L53)
|
|
189
|
-
|
|
190
|
-
___
|
|
191
|
-
|
|
192
114
|
### BASE\_PATH
|
|
193
115
|
|
|
194
116
|
• `Const` **BASE\_PATH**: `string`
|
|
195
117
|
|
|
196
118
|
#### Defined in
|
|
197
119
|
|
|
198
|
-
[packages/notifications/
|
|
120
|
+
[packages/notifications/base.ts:22](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/base.ts#L22)
|
|
199
121
|
|
|
200
122
|
___
|
|
201
123
|
|
|
@@ -216,212 +138,107 @@ ___
|
|
|
216
138
|
|
|
217
139
|
#### Defined in
|
|
218
140
|
|
|
219
|
-
[packages/notifications/
|
|
220
|
-
|
|
221
|
-
___
|
|
222
|
-
|
|
223
|
-
### DUMMY\_BASE\_URL
|
|
224
|
-
|
|
225
|
-
• `Const` **DUMMY\_BASE\_URL**: ``"https://example.com"``
|
|
226
|
-
|
|
227
|
-
**`Export`**
|
|
228
|
-
|
|
229
|
-
#### Defined in
|
|
230
|
-
|
|
231
|
-
[packages/notifications/utils/common.ts:13](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/common.ts#L13)
|
|
141
|
+
[packages/notifications/base.ts:28](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/base.ts#L28)
|
|
232
142
|
|
|
233
143
|
## Functions
|
|
234
144
|
|
|
235
|
-
###
|
|
236
|
-
|
|
237
|
-
▸ **APIFactory**<`T`\>(`basePath?`, `config?`, `actions`): [`BaseAPI`](classes/BaseAPI.md) & `T`
|
|
238
|
-
|
|
239
|
-
Factory for creating API with option to add enpoints to the API.
|
|
145
|
+
### drawerResourceV1GetDrawerEntries
|
|
240
146
|
|
|
241
|
-
|
|
147
|
+
▸ **drawerResourceV1GetDrawerEntries**(`...config`): `Promise`\<`RequestArgs`\>
|
|
242
148
|
|
|
243
|
-
|
|
244
|
-
| :------ | :------ |
|
|
245
|
-
| `T` | extends `Record`<`string`, [`ActionType`](modules.md#actiontype)\> |
|
|
149
|
+
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.
|
|
246
150
|
|
|
247
151
|
#### Parameters
|
|
248
152
|
|
|
249
|
-
| Name | Type |
|
|
250
|
-
| :------ | :------ | :------ |
|
|
251
|
-
| `
|
|
252
|
-
| `config` | [`ApiConfig`](interfaces/ApiConfig.md) | `undefined` | to be passed down to axios. |
|
|
253
|
-
| `actions` | `T` | `undefined` | object with actions to send with axios. |
|
|
153
|
+
| Name | Type | Description |
|
|
154
|
+
| :------ | :------ | :------ |
|
|
155
|
+
| `...config` | [`DrawerResourceV1GetDrawerEntriesParams`] \| [`Set`\<`string`\>, `Set`\<`string`\>, `string`, `Set`\<`string`\>, `number`, `number`, `number`, `boolean`, `string`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
254
156
|
|
|
255
157
|
#### Returns
|
|
256
158
|
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
created base API.
|
|
159
|
+
`Promise`\<`RequestArgs`\>
|
|
260
160
|
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
[packages/notifications/utils/base.ts:145](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L145)
|
|
264
|
-
|
|
265
|
-
___
|
|
266
|
-
|
|
267
|
-
### assertParamExists
|
|
161
|
+
**`Summary`**
|
|
268
162
|
|
|
269
|
-
|
|
163
|
+
Retrieve drawer notifications entries.
|
|
270
164
|
|
|
271
165
|
**`Throws`**
|
|
272
166
|
|
|
273
|
-
**`Export`**
|
|
274
|
-
|
|
275
|
-
#### Parameters
|
|
276
|
-
|
|
277
|
-
| Name | Type |
|
|
278
|
-
| :------ | :------ |
|
|
279
|
-
| `functionName` | `string` |
|
|
280
|
-
| `paramName` | `string` |
|
|
281
|
-
| `paramValue` | `unknown` |
|
|
282
|
-
|
|
283
|
-
#### Returns
|
|
284
|
-
|
|
285
|
-
`void`
|
|
286
|
-
|
|
287
167
|
#### Defined in
|
|
288
168
|
|
|
289
|
-
[packages/notifications/
|
|
169
|
+
[packages/notifications/DrawerResourceV1GetDrawerEntries/index.ts:94](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/DrawerResourceV1GetDrawerEntries/index.ts#L94)
|
|
290
170
|
|
|
291
171
|
___
|
|
292
172
|
|
|
293
|
-
###
|
|
173
|
+
### drawerResourceV1UpdateNotificationReadStatus
|
|
294
174
|
|
|
295
|
-
▸ **
|
|
175
|
+
▸ **drawerResourceV1UpdateNotificationReadStatus**(`...config`): `Promise`\<`RequestArgs`\>
|
|
296
176
|
|
|
297
|
-
|
|
177
|
+
Update drawer notifications status.
|
|
298
178
|
|
|
299
179
|
#### Parameters
|
|
300
180
|
|
|
301
|
-
| Name | Type |
|
|
302
|
-
| :------ | :------ |
|
|
303
|
-
| `
|
|
304
|
-
| `globalAxios` | `AxiosInstance` |
|
|
305
|
-
| `BASE_PATH` | `string` |
|
|
306
|
-
| `configuration?` | [`Configuration`](classes/Configuration.md) |
|
|
181
|
+
| Name | Type | Description |
|
|
182
|
+
| :------ | :------ | :------ |
|
|
183
|
+
| `...config` | [`DrawerResourceV1UpdateNotificationReadStatusParams`] \| [[`UpdateNotificationDrawerStatus`](interfaces/UpdateNotificationDrawerStatus.md), `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
307
184
|
|
|
308
185
|
#### Returns
|
|
309
186
|
|
|
310
|
-
`
|
|
311
|
-
|
|
312
|
-
▸ <`T`, `R`\>(`axios?`, `basePath?`): `Promise`<`R`\>
|
|
313
|
-
|
|
314
|
-
##### Type parameters
|
|
315
|
-
|
|
316
|
-
| Name | Type |
|
|
317
|
-
| :------ | :------ |
|
|
318
|
-
| `T` | `unknown` |
|
|
319
|
-
| `R` | `AxiosResponse`<`T`, `any`\> |
|
|
320
|
-
|
|
321
|
-
##### Parameters
|
|
187
|
+
`Promise`\<`RequestArgs`\>
|
|
322
188
|
|
|
323
|
-
|
|
324
|
-
| :------ | :------ | :------ |
|
|
325
|
-
| `axios` | `AxiosInstance` | `globalAxios` |
|
|
326
|
-
| `basePath` | `string` | `BASE_PATH` |
|
|
189
|
+
**`Summary`**
|
|
327
190
|
|
|
328
|
-
|
|
191
|
+
Update drawer notifications status.
|
|
329
192
|
|
|
330
|
-
|
|
193
|
+
**`Throws`**
|
|
331
194
|
|
|
332
195
|
#### Defined in
|
|
333
196
|
|
|
334
|
-
[packages/notifications/
|
|
197
|
+
[packages/notifications/DrawerResourceV1UpdateNotificationReadStatus/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/DrawerResourceV1UpdateNotificationReadStatus/index.ts#L34)
|
|
335
198
|
|
|
336
199
|
___
|
|
337
200
|
|
|
338
|
-
###
|
|
339
|
-
|
|
340
|
-
▸ **drawerResourceV1GetDrawerEntries**(...`config`): `Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
341
|
-
|
|
342
|
-
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.
|
|
343
|
-
|
|
344
|
-
**`Summary`**
|
|
201
|
+
### eventResourceV1GetEvents
|
|
345
202
|
|
|
346
|
-
|
|
203
|
+
▸ **eventResourceV1GetEvents**(`...config`): `Promise`\<`RequestArgs`\>
|
|
347
204
|
|
|
348
|
-
|
|
205
|
+
Retrieves the event log entries. Use this endpoint to review a full history of the events related to the tenant. You can sort by the bundle, application, event, and created fields. You can specify the sort order by appending :asc or :desc to the field, for example bundle:desc. Sorting defaults to desc for the created field and to asc for all other fields.
|
|
349
206
|
|
|
350
207
|
#### Parameters
|
|
351
208
|
|
|
352
209
|
| Name | Type | Description |
|
|
353
210
|
| :------ | :------ | :------ |
|
|
354
|
-
| `...config` | [`
|
|
211
|
+
| `...config` | [`EventResourceV1GetEventsParams`] \| [`Set`\<`string`\>, `Set`\<`string`\>, `string`, `Set`\<`string`\>, `string`, `boolean`, `boolean`, `boolean`, `Set`\<`boolean`\>, `number`, `number`, `number`, `string`, `string`, `string`, `Set`\<[`EventLogEntryActionStatus`](enums/EventLogEntryActionStatus.md)\>, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
355
212
|
|
|
356
213
|
#### Returns
|
|
357
214
|
|
|
358
|
-
`Promise
|
|
359
|
-
|
|
360
|
-
#### Defined in
|
|
361
|
-
|
|
362
|
-
[packages/notifications/DrawerResourceV1GetDrawerEntries/index.ts:94](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/DrawerResourceV1GetDrawerEntries/index.ts#L94)
|
|
363
|
-
|
|
364
|
-
___
|
|
365
|
-
|
|
366
|
-
### drawerResourceV1UpdateNotificationReadStatus
|
|
367
|
-
|
|
368
|
-
▸ **drawerResourceV1UpdateNotificationReadStatus**(...`config`): `Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
369
|
-
|
|
370
|
-
Update drawer notifications status.
|
|
215
|
+
`Promise`\<`RequestArgs`\>
|
|
371
216
|
|
|
372
217
|
**`Summary`**
|
|
373
218
|
|
|
374
|
-
|
|
219
|
+
Retrieve the event log entrie
|
|
375
220
|
|
|
376
221
|
**`Throws`**
|
|
377
222
|
|
|
378
|
-
#### Parameters
|
|
379
|
-
|
|
380
|
-
| Name | Type | Description |
|
|
381
|
-
| :------ | :------ | :------ |
|
|
382
|
-
| `...config` | [`DrawerResourceV1UpdateNotificationReadStatusParams`] \| [[`UpdateNotificationDrawerStatus`](interfaces/UpdateNotificationDrawerStatus.md), `AxiosRequestConfig`<`any`\>] | with all available params. |
|
|
383
|
-
|
|
384
|
-
#### Returns
|
|
385
|
-
|
|
386
|
-
`Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
387
|
-
|
|
388
223
|
#### Defined in
|
|
389
224
|
|
|
390
|
-
[packages/notifications/
|
|
225
|
+
[packages/notifications/EventResourceV1GetEvents/index.ts:124](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/EventResourceV1GetEvents/index.ts#L124)
|
|
391
226
|
|
|
392
227
|
___
|
|
393
228
|
|
|
394
|
-
###
|
|
395
|
-
|
|
396
|
-
▸ **eventResourceV1GetEvents**(...`config`): `Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
397
|
-
|
|
398
|
-
Retrieves the event log entries. Use this endpoint to review a full history of the events related to the tenant. You can sort by the bundle, application, event, and created fields. You can specify the sort order by appending :asc or :desc to the field, for example bundle:desc. Sorting defaults to desc for the created field and to asc for all other fields.
|
|
399
|
-
|
|
400
|
-
**`Summary`**
|
|
401
|
-
|
|
402
|
-
Retrieve the event log entries
|
|
229
|
+
### notificationResourceV1AppendBehaviorGroupToEventType
|
|
403
230
|
|
|
404
|
-
|
|
231
|
+
▸ **notificationResourceV1AppendBehaviorGroupToEventType**(`...config`): `Promise`\<`RequestArgs`\>
|
|
405
232
|
|
|
406
233
|
#### Parameters
|
|
407
234
|
|
|
408
235
|
| Name | Type | Description |
|
|
409
236
|
| :------ | :------ | :------ |
|
|
410
|
-
| `...config` | [`
|
|
237
|
+
| `...config` | [`NotificationResourceV1AppendBehaviorGroupToEventTypeParams`] \| [`string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
411
238
|
|
|
412
239
|
#### Returns
|
|
413
240
|
|
|
414
|
-
`Promise
|
|
415
|
-
|
|
416
|
-
#### Defined in
|
|
417
|
-
|
|
418
|
-
[packages/notifications/EventResourceV1GetEvents/index.ts:124](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/EventResourceV1GetEvents/index.ts#L124)
|
|
419
|
-
|
|
420
|
-
___
|
|
421
|
-
|
|
422
|
-
### notificationResourceV1AppendBehaviorGroupToEventType
|
|
423
|
-
|
|
424
|
-
▸ **notificationResourceV1AppendBehaviorGroupToEventType**(...`config`): `Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
241
|
+
`Promise`\<`RequestArgs`\>
|
|
425
242
|
|
|
426
243
|
**`Summary`**
|
|
427
244
|
|
|
@@ -429,684 +246,510 @@ Add a behavior group to the given event type.
|
|
|
429
246
|
|
|
430
247
|
**`Throws`**
|
|
431
248
|
|
|
432
|
-
#### Parameters
|
|
433
|
-
|
|
434
|
-
| Name | Type | Description |
|
|
435
|
-
| :------ | :------ | :------ |
|
|
436
|
-
| `...config` | [`NotificationResourceV1AppendBehaviorGroupToEventTypeParams`] \| [`string`, `string`, `AxiosRequestConfig`<`any`\>] | with all available params. |
|
|
437
|
-
|
|
438
|
-
#### Returns
|
|
439
|
-
|
|
440
|
-
`Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
441
|
-
|
|
442
249
|
#### Defined in
|
|
443
250
|
|
|
444
|
-
[packages/notifications/NotificationResourceV1AppendBehaviorGroupToEventType/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
251
|
+
[packages/notifications/NotificationResourceV1AppendBehaviorGroupToEventType/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1AppendBehaviorGroupToEventType/index.ts#L40)
|
|
445
252
|
|
|
446
253
|
___
|
|
447
254
|
|
|
448
255
|
### notificationResourceV1CreateBehaviorGroup
|
|
449
256
|
|
|
450
|
-
▸ **notificationResourceV1CreateBehaviorGroup**(
|
|
257
|
+
▸ **notificationResourceV1CreateBehaviorGroup**(`...config`): `Promise`\<`RequestArgs`\>
|
|
451
258
|
|
|
452
259
|
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.
|
|
453
260
|
|
|
454
|
-
**`Summary`**
|
|
455
|
-
|
|
456
|
-
Create a behavior group
|
|
457
|
-
|
|
458
|
-
**`Throws`**
|
|
459
|
-
|
|
460
261
|
#### Parameters
|
|
461
262
|
|
|
462
263
|
| Name | Type | Description |
|
|
463
264
|
| :------ | :------ | :------ |
|
|
464
|
-
| `...config` | [`NotificationResourceV1CreateBehaviorGroupParams`] \| [[`CreateBehaviorGroupRequest`](interfaces/CreateBehaviorGroupRequest.md), `AxiosRequestConfig
|
|
265
|
+
| `...config` | [`NotificationResourceV1CreateBehaviorGroupParams`] \| [[`CreateBehaviorGroupRequest`](interfaces/CreateBehaviorGroupRequest.md), `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
465
266
|
|
|
466
267
|
#### Returns
|
|
467
268
|
|
|
468
|
-
`Promise
|
|
269
|
+
`Promise`\<`RequestArgs`\>
|
|
270
|
+
|
|
271
|
+
**`Summary`**
|
|
272
|
+
|
|
273
|
+
Create a behavior group
|
|
274
|
+
|
|
275
|
+
**`Throws`**
|
|
469
276
|
|
|
470
277
|
#### Defined in
|
|
471
278
|
|
|
472
|
-
[packages/notifications/NotificationResourceV1CreateBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
279
|
+
[packages/notifications/NotificationResourceV1CreateBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1CreateBehaviorGroup/index.ts#L34)
|
|
473
280
|
|
|
474
281
|
___
|
|
475
282
|
|
|
476
283
|
### notificationResourceV1DeleteBehaviorGroup
|
|
477
284
|
|
|
478
|
-
▸ **notificationResourceV1DeleteBehaviorGroup**(
|
|
285
|
+
▸ **notificationResourceV1DeleteBehaviorGroup**(`...config`): `Promise`\<`RequestArgs`\>
|
|
479
286
|
|
|
480
287
|
Deletes a behavior group and all of its configured actions. Use this endpoint when you no longer need a behavior group.
|
|
481
288
|
|
|
482
|
-
**`Summary`**
|
|
483
|
-
|
|
484
|
-
Delete a behavior group
|
|
485
|
-
|
|
486
|
-
**`Throws`**
|
|
487
|
-
|
|
488
289
|
#### Parameters
|
|
489
290
|
|
|
490
291
|
| Name | Type | Description |
|
|
491
292
|
| :------ | :------ | :------ |
|
|
492
|
-
| `...config` | [`NotificationResourceV1DeleteBehaviorGroupParams`] \| [`string`, `AxiosRequestConfig
|
|
293
|
+
| `...config` | [`NotificationResourceV1DeleteBehaviorGroupParams`] \| [`string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
493
294
|
|
|
494
295
|
#### Returns
|
|
495
296
|
|
|
496
|
-
`Promise
|
|
297
|
+
`Promise`\<`RequestArgs`\>
|
|
298
|
+
|
|
299
|
+
**`Summary`**
|
|
300
|
+
|
|
301
|
+
Delete a behavior group
|
|
302
|
+
|
|
303
|
+
**`Throws`**
|
|
497
304
|
|
|
498
305
|
#### Defined in
|
|
499
306
|
|
|
500
|
-
[packages/notifications/NotificationResourceV1DeleteBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
307
|
+
[packages/notifications/NotificationResourceV1DeleteBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1DeleteBehaviorGroup/index.ts#L34)
|
|
501
308
|
|
|
502
309
|
___
|
|
503
310
|
|
|
504
311
|
### notificationResourceV1DeleteBehaviorGroupFromEventType
|
|
505
312
|
|
|
506
|
-
▸ **notificationResourceV1DeleteBehaviorGroupFromEventType**(
|
|
313
|
+
▸ **notificationResourceV1DeleteBehaviorGroupFromEventType**(`...config`): `Promise`\<`RequestArgs`\>
|
|
507
314
|
|
|
508
315
|
Adds a behavior group to the specified event type.
|
|
509
316
|
|
|
510
|
-
**`Summary`**
|
|
511
|
-
|
|
512
|
-
Add a behavior group to an event type
|
|
513
|
-
|
|
514
|
-
**`Throws`**
|
|
515
|
-
|
|
516
317
|
#### Parameters
|
|
517
318
|
|
|
518
319
|
| Name | Type | Description |
|
|
519
320
|
| :------ | :------ | :------ |
|
|
520
|
-
| `...config` | [`string`, `string`, `AxiosRequestConfig
|
|
321
|
+
| `...config` | [`string`, `string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1DeleteBehaviorGroupFromEventTypeParams`] | with all available params. |
|
|
521
322
|
|
|
522
323
|
#### Returns
|
|
523
324
|
|
|
524
|
-
`Promise
|
|
325
|
+
`Promise`\<`RequestArgs`\>
|
|
326
|
+
|
|
327
|
+
**`Summary`**
|
|
328
|
+
|
|
329
|
+
Add a behavior group to an event type
|
|
330
|
+
|
|
331
|
+
**`Throws`**
|
|
525
332
|
|
|
526
333
|
#### Defined in
|
|
527
334
|
|
|
528
|
-
[packages/notifications/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
335
|
+
[packages/notifications/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.ts#L40)
|
|
529
336
|
|
|
530
337
|
___
|
|
531
338
|
|
|
532
339
|
### notificationResourceV1FindBehaviorGroupsByBundleId
|
|
533
340
|
|
|
534
|
-
▸ **notificationResourceV1FindBehaviorGroupsByBundleId**(
|
|
341
|
+
▸ **notificationResourceV1FindBehaviorGroupsByBundleId**(`...config`): `Promise`\<`RequestArgs`\>
|
|
535
342
|
|
|
536
343
|
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.
|
|
537
344
|
|
|
538
|
-
**`Summary`**
|
|
539
|
-
|
|
540
|
-
List behavior groups in a bundle
|
|
541
|
-
|
|
542
|
-
**`Throws`**
|
|
543
|
-
|
|
544
345
|
#### Parameters
|
|
545
346
|
|
|
546
347
|
| Name | Type | Description |
|
|
547
348
|
| :------ | :------ | :------ |
|
|
548
|
-
| `...config` | [`string`, `AxiosRequestConfig
|
|
349
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1FindBehaviorGroupsByBundleIdParams`] | with all available params. |
|
|
549
350
|
|
|
550
351
|
#### Returns
|
|
551
352
|
|
|
552
|
-
`Promise
|
|
353
|
+
`Promise`\<`RequestArgs`\>
|
|
354
|
+
|
|
355
|
+
**`Summary`**
|
|
356
|
+
|
|
357
|
+
List behavior groups in a bundle
|
|
358
|
+
|
|
359
|
+
**`Throws`**
|
|
553
360
|
|
|
554
361
|
#### Defined in
|
|
555
362
|
|
|
556
|
-
[packages/notifications/NotificationResourceV1FindBehaviorGroupsByBundleId/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
363
|
+
[packages/notifications/NotificationResourceV1FindBehaviorGroupsByBundleId/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1FindBehaviorGroupsByBundleId/index.ts#L34)
|
|
557
364
|
|
|
558
365
|
___
|
|
559
366
|
|
|
560
367
|
### notificationResourceV1GetApplicationByNameAndBundleName
|
|
561
368
|
|
|
562
|
-
▸ **notificationResourceV1GetApplicationByNameAndBundleName**(
|
|
369
|
+
▸ **notificationResourceV1GetApplicationByNameAndBundleName**(`...config`): `Promise`\<`RequestArgs`\>
|
|
563
370
|
|
|
564
371
|
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.
|
|
565
372
|
|
|
566
|
-
**`Summary`**
|
|
567
|
-
|
|
568
|
-
Retrieve an application by bundle and application names
|
|
569
|
-
|
|
570
|
-
**`Throws`**
|
|
571
|
-
|
|
572
373
|
#### Parameters
|
|
573
374
|
|
|
574
375
|
| Name | Type | Description |
|
|
575
376
|
| :------ | :------ | :------ |
|
|
576
|
-
| `...config` | [`string`, `string`, `AxiosRequestConfig
|
|
377
|
+
| `...config` | [`string`, `string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1GetApplicationByNameAndBundleNameParams`] | with all available params. |
|
|
577
378
|
|
|
578
379
|
#### Returns
|
|
579
380
|
|
|
580
|
-
`Promise
|
|
381
|
+
`Promise`\<`RequestArgs`\>
|
|
382
|
+
|
|
383
|
+
**`Summary`**
|
|
384
|
+
|
|
385
|
+
Retrieve an application by bundle and application name
|
|
386
|
+
|
|
387
|
+
**`Throws`**
|
|
581
388
|
|
|
582
389
|
#### Defined in
|
|
583
390
|
|
|
584
|
-
[packages/notifications/NotificationResourceV1GetApplicationByNameAndBundleName/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
391
|
+
[packages/notifications/NotificationResourceV1GetApplicationByNameAndBundleName/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetApplicationByNameAndBundleName/index.ts#L40)
|
|
585
392
|
|
|
586
393
|
___
|
|
587
394
|
|
|
588
395
|
### notificationResourceV1GetApplicationsFacets
|
|
589
396
|
|
|
590
|
-
▸ **notificationResourceV1GetApplicationsFacets**(
|
|
397
|
+
▸ **notificationResourceV1GetApplicationsFacets**(`...config`): `Promise`\<`RequestArgs`\>
|
|
591
398
|
|
|
592
399
|
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.
|
|
593
400
|
|
|
594
|
-
**`Summary`**
|
|
595
|
-
|
|
596
|
-
List configured applications
|
|
597
|
-
|
|
598
|
-
**`Throws`**
|
|
599
|
-
|
|
600
401
|
#### Parameters
|
|
601
402
|
|
|
602
403
|
| Name | Type | Description |
|
|
603
404
|
| :------ | :------ | :------ |
|
|
604
|
-
| `...config` | [`string`, `AxiosRequestConfig
|
|
405
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1GetApplicationsFacetsParams`] | with all available params. |
|
|
605
406
|
|
|
606
407
|
#### Returns
|
|
607
408
|
|
|
608
|
-
`Promise
|
|
409
|
+
`Promise`\<`RequestArgs`\>
|
|
410
|
+
|
|
411
|
+
**`Summary`**
|
|
412
|
+
|
|
413
|
+
List configured application
|
|
414
|
+
|
|
415
|
+
**`Throws`**
|
|
609
416
|
|
|
610
417
|
#### Defined in
|
|
611
418
|
|
|
612
|
-
[packages/notifications/NotificationResourceV1GetApplicationsFacets/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
419
|
+
[packages/notifications/NotificationResourceV1GetApplicationsFacets/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetApplicationsFacets/index.ts#L34)
|
|
613
420
|
|
|
614
421
|
___
|
|
615
422
|
|
|
616
423
|
### notificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint
|
|
617
424
|
|
|
618
|
-
▸ **notificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint**(
|
|
425
|
+
▸ **notificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint**(`...config`): `Promise`\<`RequestArgs`\>
|
|
619
426
|
|
|
620
427
|
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.
|
|
621
428
|
|
|
622
|
-
**`Summary`**
|
|
623
|
-
|
|
624
|
-
List the behavior groups affected by the removal of an endpoint
|
|
625
|
-
|
|
626
|
-
**`Throws`**
|
|
627
|
-
|
|
628
429
|
#### Parameters
|
|
629
430
|
|
|
630
431
|
| Name | Type | Description |
|
|
631
432
|
| :------ | :------ | :------ |
|
|
632
|
-
| `...config` | [`string`, `AxiosRequestConfig
|
|
433
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointParams`] | with all available params. |
|
|
633
434
|
|
|
634
435
|
#### Returns
|
|
635
436
|
|
|
636
|
-
`Promise
|
|
437
|
+
`Promise`\<`RequestArgs`\>
|
|
438
|
+
|
|
439
|
+
**`Summary`**
|
|
440
|
+
|
|
441
|
+
List the behavior groups affected by the removal of an endpoint
|
|
442
|
+
|
|
443
|
+
**`Throws`**
|
|
637
444
|
|
|
638
445
|
#### Defined in
|
|
639
446
|
|
|
640
|
-
[packages/notifications/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
447
|
+
[packages/notifications/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.ts#L34)
|
|
641
448
|
|
|
642
449
|
___
|
|
643
450
|
|
|
644
451
|
### notificationResourceV1GetBundleByName
|
|
645
452
|
|
|
646
|
-
▸ **notificationResourceV1GetBundleByName**(
|
|
453
|
+
▸ **notificationResourceV1GetBundleByName**(`...config`): `Promise`\<`RequestArgs`\>
|
|
647
454
|
|
|
648
455
|
Retrieves the details of a bundle by searching by its name.
|
|
649
456
|
|
|
650
|
-
**`Summary`**
|
|
651
|
-
|
|
652
|
-
Retrieve a bundle by name
|
|
653
|
-
|
|
654
|
-
**`Throws`**
|
|
655
|
-
|
|
656
457
|
#### Parameters
|
|
657
458
|
|
|
658
459
|
| Name | Type | Description |
|
|
659
460
|
| :------ | :------ | :------ |
|
|
660
|
-
| `...config` | [`string`, `AxiosRequestConfig
|
|
461
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1GetBundleByNameParams`] | with all available params. |
|
|
661
462
|
|
|
662
463
|
#### Returns
|
|
663
464
|
|
|
664
|
-
`Promise
|
|
465
|
+
`Promise`\<`RequestArgs`\>
|
|
466
|
+
|
|
467
|
+
**`Summary`**
|
|
468
|
+
|
|
469
|
+
Retrieve a bundle by name
|
|
470
|
+
|
|
471
|
+
**`Throws`**
|
|
665
472
|
|
|
666
473
|
#### Defined in
|
|
667
474
|
|
|
668
|
-
[packages/notifications/NotificationResourceV1GetBundleByName/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
475
|
+
[packages/notifications/NotificationResourceV1GetBundleByName/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBundleByName/index.ts#L34)
|
|
669
476
|
|
|
670
477
|
___
|
|
671
478
|
|
|
672
479
|
### notificationResourceV1GetBundleFacets
|
|
673
480
|
|
|
674
|
-
▸ **notificationResourceV1GetBundleFacets**(
|
|
481
|
+
▸ **notificationResourceV1GetBundleFacets**(`...config`): `Promise`\<`RequestArgs`\>
|
|
675
482
|
|
|
676
483
|
Returns a list of configured bundles that includes the bundle name, the display name, and the ID. You can use this list to configure a filter in the UI.
|
|
677
484
|
|
|
678
|
-
**`Summary`**
|
|
679
|
-
|
|
680
|
-
List configured bundles
|
|
681
|
-
|
|
682
|
-
**`Throws`**
|
|
683
|
-
|
|
684
485
|
#### Parameters
|
|
685
486
|
|
|
686
487
|
| Name | Type | Description |
|
|
687
488
|
| :------ | :------ | :------ |
|
|
688
|
-
| `...config` | [`NotificationResourceV1GetBundleFacetsParams`] \| [`boolean`, `AxiosRequestConfig
|
|
489
|
+
| `...config` | [`NotificationResourceV1GetBundleFacetsParams`] \| [`boolean`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
689
490
|
|
|
690
491
|
#### Returns
|
|
691
492
|
|
|
692
|
-
`Promise
|
|
493
|
+
`Promise`\<`RequestArgs`\>
|
|
494
|
+
|
|
495
|
+
**`Summary`**
|
|
496
|
+
|
|
497
|
+
List configured bundle
|
|
498
|
+
|
|
499
|
+
**`Throws`**
|
|
693
500
|
|
|
694
501
|
#### Defined in
|
|
695
502
|
|
|
696
|
-
[packages/notifications/NotificationResourceV1GetBundleFacets/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
503
|
+
[packages/notifications/NotificationResourceV1GetBundleFacets/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBundleFacets/index.ts#L34)
|
|
697
504
|
|
|
698
505
|
___
|
|
699
506
|
|
|
700
507
|
### notificationResourceV1GetEventTypes
|
|
701
508
|
|
|
702
|
-
▸ **notificationResourceV1GetEventTypes**(
|
|
509
|
+
▸ **notificationResourceV1GetEventTypes**(`...config`): `Promise`\<`RequestArgs`\>
|
|
703
510
|
|
|
704
511
|
Lists all event types. You can filter the returned list by bundle or application name.
|
|
705
512
|
|
|
706
|
-
**`Summary`**
|
|
707
|
-
|
|
708
|
-
List all event types
|
|
709
|
-
|
|
710
|
-
**`Throws`**
|
|
711
|
-
|
|
712
513
|
#### Parameters
|
|
713
514
|
|
|
714
515
|
| Name | Type | Description |
|
|
715
516
|
| :------ | :------ | :------ |
|
|
716
|
-
| `...config` | [`NotificationResourceV1GetEventTypesParams`] \| [`Set
|
|
517
|
+
| `...config` | [`NotificationResourceV1GetEventTypesParams`] \| [`Set`\<`string`\>, `string`, `string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
717
518
|
|
|
718
519
|
#### Returns
|
|
719
520
|
|
|
720
|
-
`Promise
|
|
521
|
+
`Promise`\<`RequestArgs`\>
|
|
522
|
+
|
|
523
|
+
**`Summary`**
|
|
524
|
+
|
|
525
|
+
List all event type
|
|
526
|
+
|
|
527
|
+
**`Throws`**
|
|
721
528
|
|
|
722
529
|
#### Defined in
|
|
723
530
|
|
|
724
|
-
[packages/notifications/NotificationResourceV1GetEventTypes/index.ts:76](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
531
|
+
[packages/notifications/NotificationResourceV1GetEventTypes/index.ts:76](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypes/index.ts#L76)
|
|
725
532
|
|
|
726
533
|
___
|
|
727
534
|
|
|
728
535
|
### notificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup
|
|
729
536
|
|
|
730
|
-
▸ **notificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup**(
|
|
537
|
+
▸ **notificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup**(`...config`): `Promise`\<`RequestArgs`\>
|
|
731
538
|
|
|
732
539
|
Lists the event types that will be affected by the removal of a behavior group. Use this endpoint to see which event types will be removed if you delete a behavior group.
|
|
733
540
|
|
|
734
|
-
**`Summary`**
|
|
735
|
-
|
|
736
|
-
List the event types affected by the removal of a behavior group
|
|
737
|
-
|
|
738
|
-
**`Throws`**
|
|
739
|
-
|
|
740
541
|
#### Parameters
|
|
741
542
|
|
|
742
543
|
| Name | Type | Description |
|
|
743
544
|
| :------ | :------ | :------ |
|
|
744
|
-
| `...config` | [`string`, `AxiosRequestConfig
|
|
545
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupParams`] | with all available params. |
|
|
745
546
|
|
|
746
547
|
#### Returns
|
|
747
548
|
|
|
748
|
-
`Promise
|
|
549
|
+
`Promise`\<`RequestArgs`\>
|
|
550
|
+
|
|
551
|
+
**`Summary`**
|
|
552
|
+
|
|
553
|
+
List the event types affected by the removal of a behavior group
|
|
554
|
+
|
|
555
|
+
**`Throws`**
|
|
749
556
|
|
|
750
557
|
#### Defined in
|
|
751
558
|
|
|
752
|
-
[packages/notifications/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
559
|
+
[packages/notifications/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts#L34)
|
|
753
560
|
|
|
754
561
|
___
|
|
755
562
|
|
|
756
563
|
### notificationResourceV1GetEventTypesByNameAndBundleAndApplicationName
|
|
757
564
|
|
|
758
|
-
▸ **notificationResourceV1GetEventTypesByNameAndBundleAndApplicationName**(
|
|
565
|
+
▸ **notificationResourceV1GetEventTypesByNameAndBundleAndApplicationName**(`...config`): `Promise`\<`RequestArgs`\>
|
|
759
566
|
|
|
760
567
|
Retrieves the details of an event type by specifying the bundle name, the application name, and the event type name.
|
|
761
568
|
|
|
762
|
-
**`Summary`**
|
|
763
|
-
|
|
764
|
-
Retrieve an event type by bundle, application and event type names
|
|
765
|
-
|
|
766
|
-
**`Throws`**
|
|
767
|
-
|
|
768
569
|
#### Parameters
|
|
769
570
|
|
|
770
571
|
| Name | Type | Description |
|
|
771
572
|
| :------ | :------ | :------ |
|
|
772
|
-
| `...config` | [`NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParams`] \| [`string`, `string`, `string`, `AxiosRequestConfig
|
|
573
|
+
| `...config` | [`NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParams`] \| [`string`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
773
574
|
|
|
774
575
|
#### Returns
|
|
775
576
|
|
|
776
|
-
`Promise
|
|
777
|
-
|
|
778
|
-
#### Defined in
|
|
779
|
-
|
|
780
|
-
[packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts#L46)
|
|
781
|
-
|
|
782
|
-
___
|
|
783
|
-
|
|
784
|
-
### notificationResourceV1GetLinkedBehaviorGroups
|
|
785
|
-
|
|
786
|
-
▸ **notificationResourceV1GetLinkedBehaviorGroups**(...`config`): `Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
787
|
-
|
|
788
|
-
Lists the behavior groups that are linked to an event type. Use this endpoint to see which behavior groups will be affected if you delete an event type.
|
|
577
|
+
`Promise`\<`RequestArgs`\>
|
|
789
578
|
|
|
790
579
|
**`Summary`**
|
|
791
580
|
|
|
792
|
-
|
|
581
|
+
Retrieve an event type by bundle, application and event type name
|
|
793
582
|
|
|
794
583
|
**`Throws`**
|
|
795
584
|
|
|
796
|
-
#### Parameters
|
|
797
|
-
|
|
798
|
-
| Name | Type | Description |
|
|
799
|
-
| :------ | :------ | :------ |
|
|
800
|
-
| `...config` | [`NotificationResourceV1GetLinkedBehaviorGroupsParams`] \| [`string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`<`any`\>] | with all available params. |
|
|
801
|
-
|
|
802
|
-
#### Returns
|
|
803
|
-
|
|
804
|
-
`Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
805
|
-
|
|
806
585
|
#### Defined in
|
|
807
586
|
|
|
808
|
-
[packages/notifications/
|
|
587
|
+
[packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts#L46)
|
|
809
588
|
|
|
810
589
|
___
|
|
811
590
|
|
|
812
|
-
###
|
|
813
|
-
|
|
814
|
-
▸ **notificationResourceV1UpdateBehaviorGroup**(...`config`): `Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
815
|
-
|
|
816
|
-
Updates the details of a behavior group. Use this endpoint to update the list of related endpoints and event types associated with this behavior group.
|
|
591
|
+
### notificationResourceV1GetLinkedBehaviorGroups
|
|
817
592
|
|
|
818
|
-
|
|
593
|
+
▸ **notificationResourceV1GetLinkedBehaviorGroups**(`...config`): `Promise`\<`RequestArgs`\>
|
|
819
594
|
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
**`Throws`**
|
|
595
|
+
Lists the behavior groups that are linked to an event type. Use this endpoint to see which behavior groups will be affected if you delete an event type.
|
|
823
596
|
|
|
824
597
|
#### Parameters
|
|
825
598
|
|
|
826
599
|
| Name | Type | Description |
|
|
827
600
|
| :------ | :------ | :------ |
|
|
828
|
-
| `...config` | [`
|
|
601
|
+
| `...config` | [`NotificationResourceV1GetLinkedBehaviorGroupsParams`] \| [`string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
829
602
|
|
|
830
603
|
#### Returns
|
|
831
604
|
|
|
832
|
-
`Promise
|
|
833
|
-
|
|
834
|
-
#### Defined in
|
|
835
|
-
|
|
836
|
-
[packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts#L40)
|
|
837
|
-
|
|
838
|
-
___
|
|
839
|
-
|
|
840
|
-
### notificationResourceV1UpdateBehaviorGroupActions
|
|
841
|
-
|
|
842
|
-
▸ **notificationResourceV1UpdateBehaviorGroupActions**(...`config`): `Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
843
|
-
|
|
844
|
-
Updates the list of actions to be executed in that particular behavior group after an event is received.
|
|
605
|
+
`Promise`\<`RequestArgs`\>
|
|
845
606
|
|
|
846
607
|
**`Summary`**
|
|
847
608
|
|
|
848
|
-
|
|
609
|
+
List the behavior groups linked to an event type
|
|
849
610
|
|
|
850
611
|
**`Throws`**
|
|
851
612
|
|
|
852
|
-
#### Parameters
|
|
853
|
-
|
|
854
|
-
| Name | Type | Description |
|
|
855
|
-
| :------ | :------ | :------ |
|
|
856
|
-
| `...config` | [`NotificationResourceV1UpdateBehaviorGroupActionsParams`] \| [`string`, `string`[], `AxiosRequestConfig`<`any`\>] | with all available params. |
|
|
857
|
-
|
|
858
|
-
#### Returns
|
|
859
|
-
|
|
860
|
-
`Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
861
|
-
|
|
862
613
|
#### Defined in
|
|
863
614
|
|
|
864
|
-
[packages/notifications/
|
|
615
|
+
[packages/notifications/NotificationResourceV1GetLinkedBehaviorGroups/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetLinkedBehaviorGroups/index.ts#L64)
|
|
865
616
|
|
|
866
617
|
___
|
|
867
618
|
|
|
868
|
-
###
|
|
869
|
-
|
|
870
|
-
▸ **notificationResourceV1UpdateEventTypeBehaviors**(...`config`): `Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
871
|
-
|
|
872
|
-
Updates the list of behavior groups associated with an event type.
|
|
873
|
-
|
|
874
|
-
**`Summary`**
|
|
619
|
+
### notificationResourceV1UpdateBehaviorGroup
|
|
875
620
|
|
|
876
|
-
|
|
621
|
+
▸ **notificationResourceV1UpdateBehaviorGroup**(`...config`): `Promise`\<`RequestArgs`\>
|
|
877
622
|
|
|
878
|
-
|
|
623
|
+
Updates the details of a behavior group. Use this endpoint to update the list of related endpoints and event types associated with this behavior group.
|
|
879
624
|
|
|
880
625
|
#### Parameters
|
|
881
626
|
|
|
882
627
|
| Name | Type | Description |
|
|
883
628
|
| :------ | :------ | :------ |
|
|
884
|
-
| `...config` | [`
|
|
629
|
+
| `...config` | [`NotificationResourceV1UpdateBehaviorGroupParams`] \| [`string`, [`UpdateBehaviorGroupRequest`](interfaces/UpdateBehaviorGroupRequest.md), `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
885
630
|
|
|
886
631
|
#### Returns
|
|
887
632
|
|
|
888
|
-
`Promise
|
|
889
|
-
|
|
890
|
-
#### Defined in
|
|
891
|
-
|
|
892
|
-
[packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts#L40)
|
|
893
|
-
|
|
894
|
-
___
|
|
895
|
-
|
|
896
|
-
### orgConfigResourceV1GetDailyDigestTimePreference
|
|
897
|
-
|
|
898
|
-
▸ **orgConfigResourceV1GetDailyDigestTimePreference**(...`config`): `Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
899
|
-
|
|
900
|
-
Retrieves the daily digest time setting. Use this endpoint to check the time that daily emails are sent.
|
|
633
|
+
`Promise`\<`RequestArgs`\>
|
|
901
634
|
|
|
902
635
|
**`Summary`**
|
|
903
636
|
|
|
904
|
-
|
|
637
|
+
Update a behavior group
|
|
905
638
|
|
|
906
639
|
**`Throws`**
|
|
907
640
|
|
|
908
|
-
#### Parameters
|
|
909
|
-
|
|
910
|
-
| Name | Type | Description |
|
|
911
|
-
| :------ | :------ | :------ |
|
|
912
|
-
| `...config` | [`OrgConfigResourceV1GetDailyDigestTimePreferenceParams`] \| [`AxiosRequestConfig`<`any`\>] | with all available params. |
|
|
913
|
-
|
|
914
|
-
#### Returns
|
|
915
|
-
|
|
916
|
-
`Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
917
|
-
|
|
918
641
|
#### Defined in
|
|
919
642
|
|
|
920
|
-
[packages/notifications/
|
|
643
|
+
[packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts#L40)
|
|
921
644
|
|
|
922
645
|
___
|
|
923
646
|
|
|
924
|
-
###
|
|
925
|
-
|
|
926
|
-
▸ **orgConfigResourceV1SaveDailyDigestTimePreference**(...`config`): `Promise`<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
927
|
-
|
|
928
|
-
Sets the daily digest UTC time. The accepted minute values are 00, 15, 30, and 45. Use this endpoint to set the time when daily emails are sent.
|
|
929
|
-
|
|
930
|
-
**`Summary`**
|
|
647
|
+
### notificationResourceV1UpdateBehaviorGroupActions
|
|
931
648
|
|
|
932
|
-
|
|
649
|
+
▸ **notificationResourceV1UpdateBehaviorGroupActions**(`...config`): `Promise`\<`RequestArgs`\>
|
|
933
650
|
|
|
934
|
-
|
|
651
|
+
Updates the list of actions to be executed in that particular behavior group after an event is received.
|
|
935
652
|
|
|
936
653
|
#### Parameters
|
|
937
654
|
|
|
938
655
|
| Name | Type | Description |
|
|
939
656
|
| :------ | :------ | :------ |
|
|
940
|
-
| `...config` | [`
|
|
657
|
+
| `...config` | [`NotificationResourceV1UpdateBehaviorGroupActionsParams`] \| [`string`, `string`[], `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
941
658
|
|
|
942
659
|
#### Returns
|
|
943
660
|
|
|
944
|
-
`Promise
|
|
945
|
-
|
|
946
|
-
#### Defined in
|
|
947
|
-
|
|
948
|
-
[packages/notifications/OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts#L34)
|
|
949
|
-
|
|
950
|
-
___
|
|
951
|
-
|
|
952
|
-
### serializeDataIfNeeded
|
|
953
|
-
|
|
954
|
-
▸ **serializeDataIfNeeded**(`value`, `requestOptions`, `configuration?`): `any`
|
|
955
|
-
|
|
956
|
-
**`Export`**
|
|
957
|
-
|
|
958
|
-
#### Parameters
|
|
661
|
+
`Promise`\<`RequestArgs`\>
|
|
959
662
|
|
|
960
|
-
|
|
961
|
-
| :------ | :------ |
|
|
962
|
-
| `value` | `any` |
|
|
963
|
-
| `requestOptions` | `any` |
|
|
964
|
-
| `configuration?` | [`Configuration`](classes/Configuration.md) |
|
|
663
|
+
**`Summary`**
|
|
965
664
|
|
|
966
|
-
|
|
665
|
+
Update the list of behavior group action
|
|
967
666
|
|
|
968
|
-
|
|
667
|
+
**`Throws`**
|
|
969
668
|
|
|
970
669
|
#### Defined in
|
|
971
670
|
|
|
972
|
-
[packages/notifications/
|
|
671
|
+
[packages/notifications/NotificationResourceV1UpdateBehaviorGroupActions/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateBehaviorGroupActions/index.ts#L40)
|
|
973
672
|
|
|
974
673
|
___
|
|
975
674
|
|
|
976
|
-
###
|
|
675
|
+
### notificationResourceV1UpdateEventTypeBehaviors
|
|
977
676
|
|
|
978
|
-
▸ **
|
|
677
|
+
▸ **notificationResourceV1UpdateEventTypeBehaviors**(`...config`): `Promise`\<`RequestArgs`\>
|
|
979
678
|
|
|
980
|
-
|
|
679
|
+
Updates the list of behavior groups associated with an event type.
|
|
981
680
|
|
|
982
681
|
#### Parameters
|
|
983
682
|
|
|
984
|
-
| Name | Type |
|
|
985
|
-
| :------ | :------ |
|
|
986
|
-
| `
|
|
987
|
-
| `keyParamName` | `string` |
|
|
988
|
-
| `configuration?` | [`Configuration`](classes/Configuration.md) |
|
|
683
|
+
| Name | Type | Description |
|
|
684
|
+
| :------ | :------ | :------ |
|
|
685
|
+
| `...config` | [`NotificationResourceV1UpdateEventTypeBehaviorsParams`] \| [`string`, `Set`\<`string`\>, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
989
686
|
|
|
990
687
|
#### Returns
|
|
991
688
|
|
|
992
|
-
`Promise
|
|
993
|
-
|
|
994
|
-
#### Defined in
|
|
995
|
-
|
|
996
|
-
[packages/notifications/utils/common.ts:30](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/common.ts#L30)
|
|
997
|
-
|
|
998
|
-
___
|
|
999
|
-
|
|
1000
|
-
### setBasicAuthToObject
|
|
1001
|
-
|
|
1002
|
-
▸ **setBasicAuthToObject**(`object`, `configuration?`): `void`
|
|
1003
|
-
|
|
1004
|
-
**`Export`**
|
|
1005
|
-
|
|
1006
|
-
#### Parameters
|
|
689
|
+
`Promise`\<`RequestArgs`\>
|
|
1007
690
|
|
|
1008
|
-
|
|
1009
|
-
| :------ | :------ |
|
|
1010
|
-
| `object` | `any` |
|
|
1011
|
-
| `configuration?` | [`Configuration`](classes/Configuration.md) |
|
|
691
|
+
**`Summary`**
|
|
1012
692
|
|
|
1013
|
-
|
|
693
|
+
Update the list of behavior groups for an event type
|
|
1014
694
|
|
|
1015
|
-
|
|
695
|
+
**`Throws`**
|
|
1016
696
|
|
|
1017
697
|
#### Defined in
|
|
1018
698
|
|
|
1019
|
-
[packages/notifications/
|
|
699
|
+
[packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts#L40)
|
|
1020
700
|
|
|
1021
701
|
___
|
|
1022
702
|
|
|
1023
|
-
###
|
|
703
|
+
### orgConfigResourceV1GetDailyDigestTimePreference
|
|
1024
704
|
|
|
1025
|
-
▸ **
|
|
705
|
+
▸ **orgConfigResourceV1GetDailyDigestTimePreference**(`...config`): `Promise`\<`RequestArgs`\>
|
|
1026
706
|
|
|
1027
|
-
|
|
707
|
+
Retrieves the daily digest time setting. Use this endpoint to check the time that daily emails are sent.
|
|
1028
708
|
|
|
1029
709
|
#### Parameters
|
|
1030
710
|
|
|
1031
|
-
| Name | Type |
|
|
1032
|
-
| :------ | :------ |
|
|
1033
|
-
| `
|
|
1034
|
-
| `configuration?` | [`Configuration`](classes/Configuration.md) |
|
|
711
|
+
| Name | Type | Description |
|
|
712
|
+
| :------ | :------ | :------ |
|
|
713
|
+
| `...config` | [`OrgConfigResourceV1GetDailyDigestTimePreferenceParams`] \| [`AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
1035
714
|
|
|
1036
715
|
#### Returns
|
|
1037
716
|
|
|
1038
|
-
`Promise
|
|
1039
|
-
|
|
1040
|
-
#### Defined in
|
|
1041
|
-
|
|
1042
|
-
[packages/notifications/utils/common.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/common.ts#L53)
|
|
1043
|
-
|
|
1044
|
-
___
|
|
1045
|
-
|
|
1046
|
-
### setOAuthToObject
|
|
717
|
+
`Promise`\<`RequestArgs`\>
|
|
1047
718
|
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
**`Export`**
|
|
1051
|
-
|
|
1052
|
-
#### Parameters
|
|
1053
|
-
|
|
1054
|
-
| Name | Type |
|
|
1055
|
-
| :------ | :------ |
|
|
1056
|
-
| `object` | `any` |
|
|
1057
|
-
| `name` | `string` |
|
|
1058
|
-
| `scopes` | `string`[] |
|
|
1059
|
-
| `configuration?` | [`Configuration`](classes/Configuration.md) |
|
|
719
|
+
**`Summary`**
|
|
1060
720
|
|
|
1061
|
-
|
|
721
|
+
Retrieve the daily digest time
|
|
1062
722
|
|
|
1063
|
-
|
|
723
|
+
**`Throws`**
|
|
1064
724
|
|
|
1065
725
|
#### Defined in
|
|
1066
726
|
|
|
1067
|
-
[packages/notifications/
|
|
727
|
+
[packages/notifications/OrgConfigResourceV1GetDailyDigestTimePreference/index.ts:28](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/OrgConfigResourceV1GetDailyDigestTimePreference/index.ts#L28)
|
|
1068
728
|
|
|
1069
729
|
___
|
|
1070
730
|
|
|
1071
|
-
###
|
|
731
|
+
### orgConfigResourceV1SaveDailyDigestTimePreference
|
|
1072
732
|
|
|
1073
|
-
▸ **
|
|
733
|
+
▸ **orgConfigResourceV1SaveDailyDigestTimePreference**(`...config`): `Promise`\<`RequestArgs`\>
|
|
1074
734
|
|
|
1075
|
-
|
|
735
|
+
Sets the daily digest UTC time. The accepted minute values are 00, 15, 30, and 45. Use this endpoint to set the time when daily emails are sent.
|
|
1076
736
|
|
|
1077
737
|
#### Parameters
|
|
1078
738
|
|
|
1079
|
-
| Name | Type |
|
|
1080
|
-
| :------ | :------ |
|
|
1081
|
-
| `
|
|
1082
|
-
| `...objects` | `any`[] |
|
|
739
|
+
| Name | Type | Description |
|
|
740
|
+
| :------ | :------ | :------ |
|
|
741
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [`OrgConfigResourceV1SaveDailyDigestTimePreferenceParams`] | with all available params. |
|
|
1083
742
|
|
|
1084
743
|
#### Returns
|
|
1085
744
|
|
|
1086
|
-
`
|
|
1087
|
-
|
|
1088
|
-
#### Defined in
|
|
1089
|
-
|
|
1090
|
-
[packages/notifications/utils/common.ts:101](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/common.ts#L101)
|
|
745
|
+
`Promise`\<`RequestArgs`\>
|
|
1091
746
|
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
### toPathString
|
|
1095
|
-
|
|
1096
|
-
▸ **toPathString**(`url`): `string`
|
|
1097
|
-
|
|
1098
|
-
**`Export`**
|
|
1099
|
-
|
|
1100
|
-
#### Parameters
|
|
1101
|
-
|
|
1102
|
-
| Name | Type |
|
|
1103
|
-
| :------ | :------ |
|
|
1104
|
-
| `url` | `URL` |
|
|
747
|
+
**`Summary`**
|
|
1105
748
|
|
|
1106
|
-
|
|
749
|
+
Set the daily digest time
|
|
1107
750
|
|
|
1108
|
-
|
|
751
|
+
**`Throws`**
|
|
1109
752
|
|
|
1110
753
|
#### Defined in
|
|
1111
754
|
|
|
1112
|
-
[packages/notifications/
|
|
755
|
+
[packages/notifications/OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts#L34)
|