@redhat-cloud-services/notifications-client 2.3.2 → 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 +10 -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/classes/BaseAPI.md +12 -74
- package/doc/classes/RequiredError.md +2 -2
- 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/CamelProperties.md +8 -8
- package/doc/interfaces/CurrentStatus.md +4 -4
- package/doc/interfaces/EventType.md +18 -3
- package/doc/interfaces/EventTypeBehavior.md +3 -3
- package/doc/interfaces/EventTypeBehaviorId.md +2 -2
- package/doc/interfaces/EventTypeSettingsValue.md +3 -3
- package/doc/interfaces/Facet.md +4 -4
- package/doc/interfaces/InstantEmailTemplate.md +9 -9
- package/doc/interfaces/InternalApplicationUserPermission.md +3 -3
- package/doc/interfaces/InternalRoleAccess.md +7 -7
- package/doc/interfaces/InternalUserPermissions.md +7 -7
- package/doc/interfaces/MessageValidationResponse.md +1 -1
- package/doc/interfaces/Meta.md +1 -1
- package/doc/interfaces/NotificationHistory.md +9 -9
- package/doc/interfaces/PageBehaviorGroup.md +3 -3
- package/doc/interfaces/PageDrawerEntryPayload.md +3 -3
- package/doc/interfaces/PageEventLogEntry.md +3 -3
- package/doc/interfaces/PageEventType.md +3 -3
- package/doc/interfaces/PageNotificationHistory.md +3 -3
- package/doc/interfaces/RenderEmailTemplateRequest.md +2 -2
- package/doc/interfaces/RequestArgs.md +6 -28
- package/doc/interfaces/RequestDefaultBehaviorGroupPropertyList.md +2 -2
- package/doc/interfaces/RequestSystemSubscriptionProperties.md +5 -5
- package/doc/interfaces/ServerInfo.md +1 -1
- package/doc/interfaces/SettingsValuesByEventType.md +1 -1
- package/doc/interfaces/SystemSubscriptionProperties.md +7 -7
- package/doc/interfaces/Template.md +6 -6
- package/doc/interfaces/TriggerDailyDigestRequest.md +5 -5
- package/doc/interfaces/UpdateApplicationRequest.md +3 -3
- package/doc/interfaces/UpdateBehaviorGroupRequest.md +4 -4
- package/doc/interfaces/UpdateNotificationDrawerStatus.md +5 -5
- package/doc/interfaces/WebhookProperties.md +13 -13
- package/doc/interfaces/X509Certificate.md +5 -5
- package/doc/modules.md +53 -410
- package/package.json +3 -2
- 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 -202
- package/doc/interfaces/ApiConfig.md +0 -30
- package/doc/interfaces/ConfigurationParameters.md +0 -93
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/main/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/main/packages/notifications/utils/base.ts#L45)
|
|
165
|
-
|
|
166
|
-
[packages/notifications/utils/base.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/main/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/main/packages/notifications/utils/base.ts#L45)
|
|
187
|
-
|
|
188
|
-
[packages/notifications/utils/base.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/main/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,128 +138,13 @@ ___
|
|
|
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/main/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
|
-
### APIFactory
|
|
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.
|
|
240
|
-
|
|
241
|
-
#### Type parameters
|
|
242
|
-
|
|
243
|
-
| Name | Type |
|
|
244
|
-
| :------ | :------ |
|
|
245
|
-
| `T` | extends `Record`\<`string`, [`ActionType`](modules.md#actiontype)\> |
|
|
246
|
-
|
|
247
|
-
#### Parameters
|
|
248
|
-
|
|
249
|
-
| Name | Type | Default value | Description |
|
|
250
|
-
| :------ | :------ | :------ | :------ |
|
|
251
|
-
| `basePath` | `string` | `BASE_PATH` | basePath of api requests. |
|
|
252
|
-
| `config` | [`ApiConfig`](interfaces/ApiConfig.md) | `undefined` | to be passed down to axios. |
|
|
253
|
-
| `actions` | `T` | `undefined` | object with actions to send with axios. |
|
|
254
|
-
|
|
255
|
-
#### Returns
|
|
256
|
-
|
|
257
|
-
[`BaseAPI`](classes/BaseAPI.md) & `T`
|
|
258
|
-
|
|
259
|
-
created base API.
|
|
260
|
-
|
|
261
|
-
#### Defined in
|
|
262
|
-
|
|
263
|
-
[packages/notifications/utils/base.ts:145](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L145)
|
|
264
|
-
|
|
265
|
-
___
|
|
266
|
-
|
|
267
|
-
### assertParamExists
|
|
268
|
-
|
|
269
|
-
▸ **assertParamExists**(`functionName`, `paramName`, `paramValue`): `void`
|
|
270
|
-
|
|
271
|
-
#### Parameters
|
|
272
|
-
|
|
273
|
-
| Name | Type |
|
|
274
|
-
| :------ | :------ |
|
|
275
|
-
| `functionName` | `string` |
|
|
276
|
-
| `paramName` | `string` |
|
|
277
|
-
| `paramValue` | `unknown` |
|
|
278
|
-
|
|
279
|
-
#### Returns
|
|
280
|
-
|
|
281
|
-
`void`
|
|
282
|
-
|
|
283
|
-
**`Throws`**
|
|
284
|
-
|
|
285
|
-
**`Export`**
|
|
286
|
-
|
|
287
|
-
#### Defined in
|
|
288
|
-
|
|
289
|
-
[packages/notifications/utils/common.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L20)
|
|
290
|
-
|
|
291
|
-
___
|
|
292
|
-
|
|
293
|
-
### createRequestFunction
|
|
294
|
-
|
|
295
|
-
▸ **createRequestFunction**(`axiosArgs`, `globalAxios`, `BASE_PATH`, `configuration?`): \<T, R\>(`axios`: `AxiosInstance`, `basePath`: `string`) => `Promise`\<`R`\>
|
|
296
|
-
|
|
297
|
-
#### Parameters
|
|
298
|
-
|
|
299
|
-
| Name | Type |
|
|
300
|
-
| :------ | :------ |
|
|
301
|
-
| `axiosArgs` | [`RequestArgs`](interfaces/RequestArgs.md) |
|
|
302
|
-
| `globalAxios` | `AxiosInstance` |
|
|
303
|
-
| `BASE_PATH` | `string` |
|
|
304
|
-
| `configuration?` | [`Configuration`](classes/Configuration.md) |
|
|
305
|
-
|
|
306
|
-
#### Returns
|
|
307
|
-
|
|
308
|
-
`fn`
|
|
309
|
-
|
|
310
|
-
▸ \<`T`, `R`\>(`axios?`, `basePath?`): `Promise`\<`R`\>
|
|
311
|
-
|
|
312
|
-
##### Type parameters
|
|
313
|
-
|
|
314
|
-
| Name | Type |
|
|
315
|
-
| :------ | :------ |
|
|
316
|
-
| `T` | `unknown` |
|
|
317
|
-
| `R` | `AxiosResponse`\<`T`, `any`\> |
|
|
318
|
-
|
|
319
|
-
##### Parameters
|
|
320
|
-
|
|
321
|
-
| Name | Type | Default value |
|
|
322
|
-
| :------ | :------ | :------ |
|
|
323
|
-
| `axios` | `AxiosInstance` | `globalAxios` |
|
|
324
|
-
| `basePath` | `string` | `BASE_PATH` |
|
|
325
|
-
|
|
326
|
-
##### Returns
|
|
327
|
-
|
|
328
|
-
`Promise`\<`R`\>
|
|
329
|
-
|
|
330
|
-
**`Export`**
|
|
331
|
-
|
|
332
|
-
#### Defined in
|
|
333
|
-
|
|
334
|
-
[packages/notifications/utils/common.ts:133](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L133)
|
|
335
|
-
|
|
336
|
-
___
|
|
337
|
-
|
|
338
145
|
### drawerResourceV1GetDrawerEntries
|
|
339
146
|
|
|
340
|
-
▸ **drawerResourceV1GetDrawerEntries**(`...config`): `Promise
|
|
147
|
+
▸ **drawerResourceV1GetDrawerEntries**(`...config`): `Promise`\<`RequestArgs`\>
|
|
341
148
|
|
|
342
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.
|
|
343
150
|
|
|
@@ -349,7 +156,7 @@ Allowed `sort_by` fields are `bundleIds`, `applicationIds`, `eventTypeIds`, `sta
|
|
|
349
156
|
|
|
350
157
|
#### Returns
|
|
351
158
|
|
|
352
|
-
`Promise
|
|
159
|
+
`Promise`\<`RequestArgs`\>
|
|
353
160
|
|
|
354
161
|
**`Summary`**
|
|
355
162
|
|
|
@@ -365,7 +172,7 @@ ___
|
|
|
365
172
|
|
|
366
173
|
### drawerResourceV1UpdateNotificationReadStatus
|
|
367
174
|
|
|
368
|
-
▸ **drawerResourceV1UpdateNotificationReadStatus**(`...config`): `Promise
|
|
175
|
+
▸ **drawerResourceV1UpdateNotificationReadStatus**(`...config`): `Promise`\<`RequestArgs`\>
|
|
369
176
|
|
|
370
177
|
Update drawer notifications status.
|
|
371
178
|
|
|
@@ -377,7 +184,7 @@ Update drawer notifications status.
|
|
|
377
184
|
|
|
378
185
|
#### Returns
|
|
379
186
|
|
|
380
|
-
`Promise
|
|
187
|
+
`Promise`\<`RequestArgs`\>
|
|
381
188
|
|
|
382
189
|
**`Summary`**
|
|
383
190
|
|
|
@@ -393,7 +200,7 @@ ___
|
|
|
393
200
|
|
|
394
201
|
### eventResourceV1GetEvents
|
|
395
202
|
|
|
396
|
-
▸ **eventResourceV1GetEvents**(`...config`): `Promise
|
|
203
|
+
▸ **eventResourceV1GetEvents**(`...config`): `Promise`\<`RequestArgs`\>
|
|
397
204
|
|
|
398
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.
|
|
399
206
|
|
|
@@ -405,11 +212,11 @@ Retrieves the event log entries. Use this endpoint to review a full history of t
|
|
|
405
212
|
|
|
406
213
|
#### Returns
|
|
407
214
|
|
|
408
|
-
`Promise
|
|
215
|
+
`Promise`\<`RequestArgs`\>
|
|
409
216
|
|
|
410
217
|
**`Summary`**
|
|
411
218
|
|
|
412
|
-
Retrieve the event log
|
|
219
|
+
Retrieve the event log entrie
|
|
413
220
|
|
|
414
221
|
**`Throws`**
|
|
415
222
|
|
|
@@ -421,7 +228,7 @@ ___
|
|
|
421
228
|
|
|
422
229
|
### notificationResourceV1AppendBehaviorGroupToEventType
|
|
423
230
|
|
|
424
|
-
▸ **notificationResourceV1AppendBehaviorGroupToEventType**(`...config`): `Promise
|
|
231
|
+
▸ **notificationResourceV1AppendBehaviorGroupToEventType**(`...config`): `Promise`\<`RequestArgs`\>
|
|
425
232
|
|
|
426
233
|
#### Parameters
|
|
427
234
|
|
|
@@ -431,7 +238,7 @@ ___
|
|
|
431
238
|
|
|
432
239
|
#### Returns
|
|
433
240
|
|
|
434
|
-
`Promise
|
|
241
|
+
`Promise`\<`RequestArgs`\>
|
|
435
242
|
|
|
436
243
|
**`Summary`**
|
|
437
244
|
|
|
@@ -447,7 +254,7 @@ ___
|
|
|
447
254
|
|
|
448
255
|
### notificationResourceV1CreateBehaviorGroup
|
|
449
256
|
|
|
450
|
-
▸ **notificationResourceV1CreateBehaviorGroup**(`...config`): `Promise
|
|
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
|
|
|
@@ -459,7 +266,7 @@ Creates a behavior group that defines which notifications will be sent to extern
|
|
|
459
266
|
|
|
460
267
|
#### Returns
|
|
461
268
|
|
|
462
|
-
`Promise
|
|
269
|
+
`Promise`\<`RequestArgs`\>
|
|
463
270
|
|
|
464
271
|
**`Summary`**
|
|
465
272
|
|
|
@@ -475,7 +282,7 @@ ___
|
|
|
475
282
|
|
|
476
283
|
### notificationResourceV1DeleteBehaviorGroup
|
|
477
284
|
|
|
478
|
-
▸ **notificationResourceV1DeleteBehaviorGroup**(`...config`): `Promise
|
|
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
|
|
|
@@ -487,7 +294,7 @@ Deletes a behavior group and all of its configured actions. Use this endpoint wh
|
|
|
487
294
|
|
|
488
295
|
#### Returns
|
|
489
296
|
|
|
490
|
-
`Promise
|
|
297
|
+
`Promise`\<`RequestArgs`\>
|
|
491
298
|
|
|
492
299
|
**`Summary`**
|
|
493
300
|
|
|
@@ -503,7 +310,7 @@ ___
|
|
|
503
310
|
|
|
504
311
|
### notificationResourceV1DeleteBehaviorGroupFromEventType
|
|
505
312
|
|
|
506
|
-
▸ **notificationResourceV1DeleteBehaviorGroupFromEventType**(`...config`): `Promise
|
|
313
|
+
▸ **notificationResourceV1DeleteBehaviorGroupFromEventType**(`...config`): `Promise`\<`RequestArgs`\>
|
|
507
314
|
|
|
508
315
|
Adds a behavior group to the specified event type.
|
|
509
316
|
|
|
@@ -515,7 +322,7 @@ Adds a behavior group to the specified event type.
|
|
|
515
322
|
|
|
516
323
|
#### Returns
|
|
517
324
|
|
|
518
|
-
`Promise
|
|
325
|
+
`Promise`\<`RequestArgs`\>
|
|
519
326
|
|
|
520
327
|
**`Summary`**
|
|
521
328
|
|
|
@@ -531,7 +338,7 @@ ___
|
|
|
531
338
|
|
|
532
339
|
### notificationResourceV1FindBehaviorGroupsByBundleId
|
|
533
340
|
|
|
534
|
-
▸ **notificationResourceV1FindBehaviorGroupsByBundleId**(`...config`): `Promise
|
|
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
|
|
|
@@ -543,7 +350,7 @@ Lists the behavior groups associated with a bundle. Use this endpoint to see the
|
|
|
543
350
|
|
|
544
351
|
#### Returns
|
|
545
352
|
|
|
546
|
-
`Promise
|
|
353
|
+
`Promise`\<`RequestArgs`\>
|
|
547
354
|
|
|
548
355
|
**`Summary`**
|
|
549
356
|
|
|
@@ -559,7 +366,7 @@ ___
|
|
|
559
366
|
|
|
560
367
|
### notificationResourceV1GetApplicationByNameAndBundleName
|
|
561
368
|
|
|
562
|
-
▸ **notificationResourceV1GetApplicationByNameAndBundleName**(`...config`): `Promise
|
|
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
|
|
|
@@ -571,11 +378,11 @@ Retrieves an application by bundle and application names. Use this endpoint to
|
|
|
571
378
|
|
|
572
379
|
#### Returns
|
|
573
380
|
|
|
574
|
-
`Promise
|
|
381
|
+
`Promise`\<`RequestArgs`\>
|
|
575
382
|
|
|
576
383
|
**`Summary`**
|
|
577
384
|
|
|
578
|
-
Retrieve an application by bundle and application
|
|
385
|
+
Retrieve an application by bundle and application name
|
|
579
386
|
|
|
580
387
|
**`Throws`**
|
|
581
388
|
|
|
@@ -587,7 +394,7 @@ ___
|
|
|
587
394
|
|
|
588
395
|
### notificationResourceV1GetApplicationsFacets
|
|
589
396
|
|
|
590
|
-
▸ **notificationResourceV1GetApplicationsFacets**(`...config`): `Promise
|
|
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
|
|
|
@@ -599,11 +406,11 @@ Returns a list of configured applications that includes the application name, th
|
|
|
599
406
|
|
|
600
407
|
#### Returns
|
|
601
408
|
|
|
602
|
-
`Promise
|
|
409
|
+
`Promise`\<`RequestArgs`\>
|
|
603
410
|
|
|
604
411
|
**`Summary`**
|
|
605
412
|
|
|
606
|
-
List configured
|
|
413
|
+
List configured application
|
|
607
414
|
|
|
608
415
|
**`Throws`**
|
|
609
416
|
|
|
@@ -615,7 +422,7 @@ ___
|
|
|
615
422
|
|
|
616
423
|
### notificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint
|
|
617
424
|
|
|
618
|
-
▸ **notificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint**(`...config`): `Promise
|
|
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
|
|
|
@@ -627,7 +434,7 @@ Lists the behavior groups that are affected by the removal of an endpoint. Use t
|
|
|
627
434
|
|
|
628
435
|
#### Returns
|
|
629
436
|
|
|
630
|
-
`Promise
|
|
437
|
+
`Promise`\<`RequestArgs`\>
|
|
631
438
|
|
|
632
439
|
**`Summary`**
|
|
633
440
|
|
|
@@ -643,7 +450,7 @@ ___
|
|
|
643
450
|
|
|
644
451
|
### notificationResourceV1GetBundleByName
|
|
645
452
|
|
|
646
|
-
▸ **notificationResourceV1GetBundleByName**(`...config`): `Promise
|
|
453
|
+
▸ **notificationResourceV1GetBundleByName**(`...config`): `Promise`\<`RequestArgs`\>
|
|
647
454
|
|
|
648
455
|
Retrieves the details of a bundle by searching by its name.
|
|
649
456
|
|
|
@@ -655,7 +462,7 @@ Retrieves the details of a bundle by searching by its name.
|
|
|
655
462
|
|
|
656
463
|
#### Returns
|
|
657
464
|
|
|
658
|
-
`Promise
|
|
465
|
+
`Promise`\<`RequestArgs`\>
|
|
659
466
|
|
|
660
467
|
**`Summary`**
|
|
661
468
|
|
|
@@ -671,7 +478,7 @@ ___
|
|
|
671
478
|
|
|
672
479
|
### notificationResourceV1GetBundleFacets
|
|
673
480
|
|
|
674
|
-
▸ **notificationResourceV1GetBundleFacets**(`...config`): `Promise
|
|
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
|
|
|
@@ -683,11 +490,11 @@ Returns a list of configured bundles that includes the bundle name, the display
|
|
|
683
490
|
|
|
684
491
|
#### Returns
|
|
685
492
|
|
|
686
|
-
`Promise
|
|
493
|
+
`Promise`\<`RequestArgs`\>
|
|
687
494
|
|
|
688
495
|
**`Summary`**
|
|
689
496
|
|
|
690
|
-
List configured
|
|
497
|
+
List configured bundle
|
|
691
498
|
|
|
692
499
|
**`Throws`**
|
|
693
500
|
|
|
@@ -699,7 +506,7 @@ ___
|
|
|
699
506
|
|
|
700
507
|
### notificationResourceV1GetEventTypes
|
|
701
508
|
|
|
702
|
-
▸ **notificationResourceV1GetEventTypes**(`...config`): `Promise
|
|
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
|
|
|
@@ -711,11 +518,11 @@ Lists all event types. You can filter the returned list by bundle or application
|
|
|
711
518
|
|
|
712
519
|
#### Returns
|
|
713
520
|
|
|
714
|
-
`Promise
|
|
521
|
+
`Promise`\<`RequestArgs`\>
|
|
715
522
|
|
|
716
523
|
**`Summary`**
|
|
717
524
|
|
|
718
|
-
List all event
|
|
525
|
+
List all event type
|
|
719
526
|
|
|
720
527
|
**`Throws`**
|
|
721
528
|
|
|
@@ -727,7 +534,7 @@ ___
|
|
|
727
534
|
|
|
728
535
|
### notificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup
|
|
729
536
|
|
|
730
|
-
▸ **notificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup**(`...config`): `Promise
|
|
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
|
|
|
@@ -739,7 +546,7 @@ Lists the event types that will be affected by the removal of a behavior group.
|
|
|
739
546
|
|
|
740
547
|
#### Returns
|
|
741
548
|
|
|
742
|
-
`Promise
|
|
549
|
+
`Promise`\<`RequestArgs`\>
|
|
743
550
|
|
|
744
551
|
**`Summary`**
|
|
745
552
|
|
|
@@ -755,7 +562,7 @@ ___
|
|
|
755
562
|
|
|
756
563
|
### notificationResourceV1GetEventTypesByNameAndBundleAndApplicationName
|
|
757
564
|
|
|
758
|
-
▸ **notificationResourceV1GetEventTypesByNameAndBundleAndApplicationName**(`...config`): `Promise
|
|
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
|
|
|
@@ -767,11 +574,11 @@ Retrieves the details of an event type by specifying the bundle name, the applic
|
|
|
767
574
|
|
|
768
575
|
#### Returns
|
|
769
576
|
|
|
770
|
-
`Promise
|
|
577
|
+
`Promise`\<`RequestArgs`\>
|
|
771
578
|
|
|
772
579
|
**`Summary`**
|
|
773
580
|
|
|
774
|
-
Retrieve an event type by bundle, application and event type
|
|
581
|
+
Retrieve an event type by bundle, application and event type name
|
|
775
582
|
|
|
776
583
|
**`Throws`**
|
|
777
584
|
|
|
@@ -783,7 +590,7 @@ ___
|
|
|
783
590
|
|
|
784
591
|
### notificationResourceV1GetLinkedBehaviorGroups
|
|
785
592
|
|
|
786
|
-
▸ **notificationResourceV1GetLinkedBehaviorGroups**(`...config`): `Promise
|
|
593
|
+
▸ **notificationResourceV1GetLinkedBehaviorGroups**(`...config`): `Promise`\<`RequestArgs`\>
|
|
787
594
|
|
|
788
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.
|
|
789
596
|
|
|
@@ -795,7 +602,7 @@ Lists the behavior groups that are linked to an event type. Use this endpoint to
|
|
|
795
602
|
|
|
796
603
|
#### Returns
|
|
797
604
|
|
|
798
|
-
`Promise
|
|
605
|
+
`Promise`\<`RequestArgs`\>
|
|
799
606
|
|
|
800
607
|
**`Summary`**
|
|
801
608
|
|
|
@@ -811,7 +618,7 @@ ___
|
|
|
811
618
|
|
|
812
619
|
### notificationResourceV1UpdateBehaviorGroup
|
|
813
620
|
|
|
814
|
-
▸ **notificationResourceV1UpdateBehaviorGroup**(`...config`): `Promise
|
|
621
|
+
▸ **notificationResourceV1UpdateBehaviorGroup**(`...config`): `Promise`\<`RequestArgs`\>
|
|
815
622
|
|
|
816
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.
|
|
817
624
|
|
|
@@ -823,7 +630,7 @@ Updates the details of a behavior group. Use this endpoint to update the list of
|
|
|
823
630
|
|
|
824
631
|
#### Returns
|
|
825
632
|
|
|
826
|
-
`Promise
|
|
633
|
+
`Promise`\<`RequestArgs`\>
|
|
827
634
|
|
|
828
635
|
**`Summary`**
|
|
829
636
|
|
|
@@ -839,7 +646,7 @@ ___
|
|
|
839
646
|
|
|
840
647
|
### notificationResourceV1UpdateBehaviorGroupActions
|
|
841
648
|
|
|
842
|
-
▸ **notificationResourceV1UpdateBehaviorGroupActions**(`...config`): `Promise
|
|
649
|
+
▸ **notificationResourceV1UpdateBehaviorGroupActions**(`...config`): `Promise`\<`RequestArgs`\>
|
|
843
650
|
|
|
844
651
|
Updates the list of actions to be executed in that particular behavior group after an event is received.
|
|
845
652
|
|
|
@@ -851,11 +658,11 @@ Updates the list of actions to be executed in that particular behavior group aft
|
|
|
851
658
|
|
|
852
659
|
#### Returns
|
|
853
660
|
|
|
854
|
-
`Promise
|
|
661
|
+
`Promise`\<`RequestArgs`\>
|
|
855
662
|
|
|
856
663
|
**`Summary`**
|
|
857
664
|
|
|
858
|
-
Update the list of behavior group
|
|
665
|
+
Update the list of behavior group action
|
|
859
666
|
|
|
860
667
|
**`Throws`**
|
|
861
668
|
|
|
@@ -867,7 +674,7 @@ ___
|
|
|
867
674
|
|
|
868
675
|
### notificationResourceV1UpdateEventTypeBehaviors
|
|
869
676
|
|
|
870
|
-
▸ **notificationResourceV1UpdateEventTypeBehaviors**(`...config`): `Promise
|
|
677
|
+
▸ **notificationResourceV1UpdateEventTypeBehaviors**(`...config`): `Promise`\<`RequestArgs`\>
|
|
871
678
|
|
|
872
679
|
Updates the list of behavior groups associated with an event type.
|
|
873
680
|
|
|
@@ -879,7 +686,7 @@ Updates the list of behavior groups associated with an event type.
|
|
|
879
686
|
|
|
880
687
|
#### Returns
|
|
881
688
|
|
|
882
|
-
`Promise
|
|
689
|
+
`Promise`\<`RequestArgs`\>
|
|
883
690
|
|
|
884
691
|
**`Summary`**
|
|
885
692
|
|
|
@@ -895,7 +702,7 @@ ___
|
|
|
895
702
|
|
|
896
703
|
### orgConfigResourceV1GetDailyDigestTimePreference
|
|
897
704
|
|
|
898
|
-
▸ **orgConfigResourceV1GetDailyDigestTimePreference**(`...config`): `Promise
|
|
705
|
+
▸ **orgConfigResourceV1GetDailyDigestTimePreference**(`...config`): `Promise`\<`RequestArgs`\>
|
|
899
706
|
|
|
900
707
|
Retrieves the daily digest time setting. Use this endpoint to check the time that daily emails are sent.
|
|
901
708
|
|
|
@@ -907,7 +714,7 @@ Retrieves the daily digest time setting. Use this endpoint to check the time tha
|
|
|
907
714
|
|
|
908
715
|
#### Returns
|
|
909
716
|
|
|
910
|
-
`Promise
|
|
717
|
+
`Promise`\<`RequestArgs`\>
|
|
911
718
|
|
|
912
719
|
**`Summary`**
|
|
913
720
|
|
|
@@ -923,7 +730,7 @@ ___
|
|
|
923
730
|
|
|
924
731
|
### orgConfigResourceV1SaveDailyDigestTimePreference
|
|
925
732
|
|
|
926
|
-
▸ **orgConfigResourceV1SaveDailyDigestTimePreference**(`...config`): `Promise
|
|
733
|
+
▸ **orgConfigResourceV1SaveDailyDigestTimePreference**(`...config`): `Promise`\<`RequestArgs`\>
|
|
927
734
|
|
|
928
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.
|
|
929
736
|
|
|
@@ -935,7 +742,7 @@ Sets the daily digest UTC time. The accepted minute values are 00, 15, 30, and 4
|
|
|
935
742
|
|
|
936
743
|
#### Returns
|
|
937
744
|
|
|
938
|
-
`Promise
|
|
745
|
+
`Promise`\<`RequestArgs`\>
|
|
939
746
|
|
|
940
747
|
**`Summary`**
|
|
941
748
|
|
|
@@ -946,167 +753,3 @@ Set the daily digest time
|
|
|
946
753
|
#### Defined in
|
|
947
754
|
|
|
948
755
|
[packages/notifications/OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts#L34)
|
|
949
|
-
|
|
950
|
-
___
|
|
951
|
-
|
|
952
|
-
### serializeDataIfNeeded
|
|
953
|
-
|
|
954
|
-
▸ **serializeDataIfNeeded**(`value`, `requestOptions`, `configuration?`): `any`
|
|
955
|
-
|
|
956
|
-
#### Parameters
|
|
957
|
-
|
|
958
|
-
| Name | Type |
|
|
959
|
-
| :------ | :------ |
|
|
960
|
-
| `value` | `any` |
|
|
961
|
-
| `requestOptions` | `any` |
|
|
962
|
-
| `configuration?` | [`Configuration`](classes/Configuration.md) |
|
|
963
|
-
|
|
964
|
-
#### Returns
|
|
965
|
-
|
|
966
|
-
`any`
|
|
967
|
-
|
|
968
|
-
**`Export`**
|
|
969
|
-
|
|
970
|
-
#### Defined in
|
|
971
|
-
|
|
972
|
-
[packages/notifications/utils/common.ts:111](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L111)
|
|
973
|
-
|
|
974
|
-
___
|
|
975
|
-
|
|
976
|
-
### setApiKeyToObject
|
|
977
|
-
|
|
978
|
-
▸ **setApiKeyToObject**(`object`, `keyParamName`, `configuration?`): `Promise`\<`void`\>
|
|
979
|
-
|
|
980
|
-
#### Parameters
|
|
981
|
-
|
|
982
|
-
| Name | Type |
|
|
983
|
-
| :------ | :------ |
|
|
984
|
-
| `object` | `any` |
|
|
985
|
-
| `keyParamName` | `string` |
|
|
986
|
-
| `configuration?` | [`Configuration`](classes/Configuration.md) |
|
|
987
|
-
|
|
988
|
-
#### Returns
|
|
989
|
-
|
|
990
|
-
`Promise`\<`void`\>
|
|
991
|
-
|
|
992
|
-
**`Export`**
|
|
993
|
-
|
|
994
|
-
#### Defined in
|
|
995
|
-
|
|
996
|
-
[packages/notifications/utils/common.ts:30](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L30)
|
|
997
|
-
|
|
998
|
-
___
|
|
999
|
-
|
|
1000
|
-
### setBasicAuthToObject
|
|
1001
|
-
|
|
1002
|
-
▸ **setBasicAuthToObject**(`object`, `configuration?`): `void`
|
|
1003
|
-
|
|
1004
|
-
#### Parameters
|
|
1005
|
-
|
|
1006
|
-
| Name | Type |
|
|
1007
|
-
| :------ | :------ |
|
|
1008
|
-
| `object` | `any` |
|
|
1009
|
-
| `configuration?` | [`Configuration`](classes/Configuration.md) |
|
|
1010
|
-
|
|
1011
|
-
#### Returns
|
|
1012
|
-
|
|
1013
|
-
`void`
|
|
1014
|
-
|
|
1015
|
-
**`Export`**
|
|
1016
|
-
|
|
1017
|
-
#### Defined in
|
|
1018
|
-
|
|
1019
|
-
[packages/notifications/utils/common.ts:43](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L43)
|
|
1020
|
-
|
|
1021
|
-
___
|
|
1022
|
-
|
|
1023
|
-
### setBearerAuthToObject
|
|
1024
|
-
|
|
1025
|
-
▸ **setBearerAuthToObject**(`object`, `configuration?`): `Promise`\<`void`\>
|
|
1026
|
-
|
|
1027
|
-
#### Parameters
|
|
1028
|
-
|
|
1029
|
-
| Name | Type |
|
|
1030
|
-
| :------ | :------ |
|
|
1031
|
-
| `object` | `any` |
|
|
1032
|
-
| `configuration?` | [`Configuration`](classes/Configuration.md) |
|
|
1033
|
-
|
|
1034
|
-
#### Returns
|
|
1035
|
-
|
|
1036
|
-
`Promise`\<`void`\>
|
|
1037
|
-
|
|
1038
|
-
**`Export`**
|
|
1039
|
-
|
|
1040
|
-
#### Defined in
|
|
1041
|
-
|
|
1042
|
-
[packages/notifications/utils/common.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L53)
|
|
1043
|
-
|
|
1044
|
-
___
|
|
1045
|
-
|
|
1046
|
-
### setOAuthToObject
|
|
1047
|
-
|
|
1048
|
-
▸ **setOAuthToObject**(`object`, `name`, `scopes`, `configuration?`): `Promise`\<`void`\>
|
|
1049
|
-
|
|
1050
|
-
#### Parameters
|
|
1051
|
-
|
|
1052
|
-
| Name | Type |
|
|
1053
|
-
| :------ | :------ |
|
|
1054
|
-
| `object` | `any` |
|
|
1055
|
-
| `name` | `string` |
|
|
1056
|
-
| `scopes` | `string`[] |
|
|
1057
|
-
| `configuration?` | [`Configuration`](classes/Configuration.md) |
|
|
1058
|
-
|
|
1059
|
-
#### Returns
|
|
1060
|
-
|
|
1061
|
-
`Promise`\<`void`\>
|
|
1062
|
-
|
|
1063
|
-
**`Export`**
|
|
1064
|
-
|
|
1065
|
-
#### Defined in
|
|
1066
|
-
|
|
1067
|
-
[packages/notifications/utils/common.ts:66](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L66)
|
|
1068
|
-
|
|
1069
|
-
___
|
|
1070
|
-
|
|
1071
|
-
### setSearchParams
|
|
1072
|
-
|
|
1073
|
-
▸ **setSearchParams**(`url`, `...objects`): `void`
|
|
1074
|
-
|
|
1075
|
-
#### Parameters
|
|
1076
|
-
|
|
1077
|
-
| Name | Type |
|
|
1078
|
-
| :------ | :------ |
|
|
1079
|
-
| `url` | `URL` |
|
|
1080
|
-
| `...objects` | `any`[] |
|
|
1081
|
-
|
|
1082
|
-
#### Returns
|
|
1083
|
-
|
|
1084
|
-
`void`
|
|
1085
|
-
|
|
1086
|
-
**`Export`**
|
|
1087
|
-
|
|
1088
|
-
#### Defined in
|
|
1089
|
-
|
|
1090
|
-
[packages/notifications/utils/common.ts:101](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L101)
|
|
1091
|
-
|
|
1092
|
-
___
|
|
1093
|
-
|
|
1094
|
-
### toPathString
|
|
1095
|
-
|
|
1096
|
-
▸ **toPathString**(`url`): `string`
|
|
1097
|
-
|
|
1098
|
-
#### Parameters
|
|
1099
|
-
|
|
1100
|
-
| Name | Type |
|
|
1101
|
-
| :------ | :------ |
|
|
1102
|
-
| `url` | `URL` |
|
|
1103
|
-
|
|
1104
|
-
#### Returns
|
|
1105
|
-
|
|
1106
|
-
`string`
|
|
1107
|
-
|
|
1108
|
-
**`Export`**
|
|
1109
|
-
|
|
1110
|
-
#### Defined in
|
|
1111
|
-
|
|
1112
|
-
[packages/notifications/utils/common.ts:125](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L125)
|