@redhat-cloud-services/notifications-client 2.3.0 → 2.3.2
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 +4 -0
- package/dist/DrawerResourceV1GetDrawerEntries/index.d.ts +1 -1
- package/dist/DrawerResourceV1GetDrawerEntries/index.d.ts.map +1 -1
- package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.d.ts +1 -1
- package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.d.ts.map +1 -1
- package/dist/EventResourceV1GetEvents/index.d.ts +1 -1
- package/dist/EventResourceV1GetEvents/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.d.ts +1 -1
- package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1CreateBehaviorGroup/index.d.ts +1 -1
- package/dist/NotificationResourceV1CreateBehaviorGroup/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroup/index.d.ts +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroup/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.d.ts +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.d.ts +1 -1
- package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetApplicationsFacets/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetApplicationsFacets/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetBundleByName/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetBundleByName/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetBundleFacets/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetBundleFacets/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetEventTypes/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetEventTypes/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroup/index.d.ts +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroup/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.d.ts +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.d.ts +1 -1
- package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.d.ts.map +1 -1
- package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.d.ts +1 -1
- package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.d.ts.map +1 -1
- package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.d.ts +1 -1
- package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.d.ts.map +1 -1
- package/dist/api.d.ts +8 -8
- package/dist/api.d.ts.map +1 -1
- package/dist/types/index.d.ts +8 -8
- package/dist/types/index.d.ts.map +1 -1
- package/dist/utils/base.d.ts +2 -2
- package/dist/utils/base.d.ts.map +1 -1
- package/doc/README.md +2 -1
- package/doc/classes/BaseAPI.md +21 -13
- package/doc/classes/Configuration.md +24 -16
- 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/ApiConfig.md +2 -2
- 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 +7 -9
- package/doc/interfaces/ConfigurationParameters.md +14 -10
- package/doc/interfaces/CreateBehaviorGroupRequest.md +7 -9
- package/doc/interfaces/CreateBehaviorGroupResponse.md +7 -9
- package/doc/interfaces/CurrentStatus.md +3 -5
- 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 +10 -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 +3 -5
- package/doc/interfaces/InternalUserPermissions.md +3 -5
- 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 +6 -8
- package/doc/interfaces/RequestDefaultBehaviorGroupPropertyList.md +2 -4
- package/doc/interfaces/RequestSystemSubscriptionProperties.md +2 -4
- package/doc/interfaces/ServerInfo.md +1 -3
- package/doc/interfaces/SettingsValuesByEventType.md +1 -3
- package/doc/interfaces/SystemSubscriptionProperties.md +3 -5
- 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 +3 -5
- package/doc/interfaces/WebhookProperties.md +6 -8
- package/doc/interfaces/X509Certificate.md +5 -7
- package/doc/modules.md +274 -274
- package/package.json +2 -2
package/doc/modules.md
CHANGED
|
@@ -133,11 +133,11 @@
|
|
|
133
133
|
|
|
134
134
|
### ActionType
|
|
135
135
|
|
|
136
|
-
Ƭ **ActionType**: (...`config`: `any`) => `Promise
|
|
136
|
+
Ƭ **ActionType**: (...`config`: `any`) => `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
137
137
|
|
|
138
138
|
#### Type declaration
|
|
139
139
|
|
|
140
|
-
▸ (
|
|
140
|
+
▸ (`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
141
141
|
|
|
142
142
|
##### Parameters
|
|
143
143
|
|
|
@@ -147,11 +147,11 @@
|
|
|
147
147
|
|
|
148
148
|
##### Returns
|
|
149
149
|
|
|
150
|
-
`Promise
|
|
150
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
151
151
|
|
|
152
152
|
#### Defined in
|
|
153
153
|
|
|
154
|
-
[packages/notifications/utils/base.ts:55](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
154
|
+
[packages/notifications/utils/base.ts:55](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L55)
|
|
155
155
|
|
|
156
156
|
___
|
|
157
157
|
|
|
@@ -161,9 +161,9 @@ ___
|
|
|
161
161
|
|
|
162
162
|
#### Defined in
|
|
163
163
|
|
|
164
|
-
[packages/notifications/utils/base.ts:45](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
164
|
+
[packages/notifications/utils/base.ts:45](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L45)
|
|
165
165
|
|
|
166
|
-
[packages/notifications/utils/base.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
166
|
+
[packages/notifications/utils/base.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L53)
|
|
167
167
|
|
|
168
168
|
## Variables
|
|
169
169
|
|
|
@@ -183,9 +183,9 @@ ___
|
|
|
183
183
|
|
|
184
184
|
#### Defined in
|
|
185
185
|
|
|
186
|
-
[packages/notifications/utils/base.ts:45](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
186
|
+
[packages/notifications/utils/base.ts:45](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L45)
|
|
187
187
|
|
|
188
|
-
[packages/notifications/utils/base.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
188
|
+
[packages/notifications/utils/base.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L53)
|
|
189
189
|
|
|
190
190
|
___
|
|
191
191
|
|
|
@@ -195,7 +195,7 @@ ___
|
|
|
195
195
|
|
|
196
196
|
#### Defined in
|
|
197
197
|
|
|
198
|
-
[packages/notifications/utils/base.ts:12](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
198
|
+
[packages/notifications/utils/base.ts:12](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L12)
|
|
199
199
|
|
|
200
200
|
___
|
|
201
201
|
|
|
@@ -216,7 +216,7 @@ ___
|
|
|
216
216
|
|
|
217
217
|
#### Defined in
|
|
218
218
|
|
|
219
|
-
[packages/notifications/utils/base.ts:18](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
219
|
+
[packages/notifications/utils/base.ts:18](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L18)
|
|
220
220
|
|
|
221
221
|
___
|
|
222
222
|
|
|
@@ -228,13 +228,13 @@ ___
|
|
|
228
228
|
|
|
229
229
|
#### Defined in
|
|
230
230
|
|
|
231
|
-
[packages/notifications/utils/common.ts:13](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
231
|
+
[packages/notifications/utils/common.ts:13](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L13)
|
|
232
232
|
|
|
233
233
|
## Functions
|
|
234
234
|
|
|
235
235
|
### APIFactory
|
|
236
236
|
|
|
237
|
-
▸ **APIFactory
|
|
237
|
+
▸ **APIFactory**\<`T`\>(`basePath?`, `config?`, `actions`): [`BaseAPI`](classes/BaseAPI.md) & `T`
|
|
238
238
|
|
|
239
239
|
Factory for creating API with option to add enpoints to the API.
|
|
240
240
|
|
|
@@ -242,7 +242,7 @@ Factory for creating API with option to add enpoints to the API.
|
|
|
242
242
|
|
|
243
243
|
| Name | Type |
|
|
244
244
|
| :------ | :------ |
|
|
245
|
-
| `T` | extends `Record
|
|
245
|
+
| `T` | extends `Record`\<`string`, [`ActionType`](modules.md#actiontype)\> |
|
|
246
246
|
|
|
247
247
|
#### Parameters
|
|
248
248
|
|
|
@@ -260,7 +260,7 @@ created base API.
|
|
|
260
260
|
|
|
261
261
|
#### Defined in
|
|
262
262
|
|
|
263
|
-
[packages/notifications/utils/base.ts:145](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
263
|
+
[packages/notifications/utils/base.ts:145](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/base.ts#L145)
|
|
264
264
|
|
|
265
265
|
___
|
|
266
266
|
|
|
@@ -268,10 +268,6 @@ ___
|
|
|
268
268
|
|
|
269
269
|
▸ **assertParamExists**(`functionName`, `paramName`, `paramValue`): `void`
|
|
270
270
|
|
|
271
|
-
**`Throws`**
|
|
272
|
-
|
|
273
|
-
**`Export`**
|
|
274
|
-
|
|
275
271
|
#### Parameters
|
|
276
272
|
|
|
277
273
|
| Name | Type |
|
|
@@ -284,17 +280,19 @@ ___
|
|
|
284
280
|
|
|
285
281
|
`void`
|
|
286
282
|
|
|
283
|
+
**`Throws`**
|
|
284
|
+
|
|
285
|
+
**`Export`**
|
|
286
|
+
|
|
287
287
|
#### Defined in
|
|
288
288
|
|
|
289
|
-
[packages/notifications/utils/common.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
289
|
+
[packages/notifications/utils/common.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L20)
|
|
290
290
|
|
|
291
291
|
___
|
|
292
292
|
|
|
293
293
|
### createRequestFunction
|
|
294
294
|
|
|
295
|
-
▸ **createRequestFunction**(`axiosArgs`, `globalAxios`, `BASE_PATH`, `configuration?`):
|
|
296
|
-
|
|
297
|
-
**`Export`**
|
|
295
|
+
▸ **createRequestFunction**(`axiosArgs`, `globalAxios`, `BASE_PATH`, `configuration?`): \<T, R\>(`axios`: `AxiosInstance`, `basePath`: `string`) => `Promise`\<`R`\>
|
|
298
296
|
|
|
299
297
|
#### Parameters
|
|
300
298
|
|
|
@@ -309,14 +307,14 @@ ___
|
|
|
309
307
|
|
|
310
308
|
`fn`
|
|
311
309
|
|
|
312
|
-
▸
|
|
310
|
+
▸ \<`T`, `R`\>(`axios?`, `basePath?`): `Promise`\<`R`\>
|
|
313
311
|
|
|
314
312
|
##### Type parameters
|
|
315
313
|
|
|
316
314
|
| Name | Type |
|
|
317
315
|
| :------ | :------ |
|
|
318
316
|
| `T` | `unknown` |
|
|
319
|
-
| `R` | `AxiosResponse
|
|
317
|
+
| `R` | `AxiosResponse`\<`T`, `any`\> |
|
|
320
318
|
|
|
321
319
|
##### Parameters
|
|
322
320
|
|
|
@@ -327,625 +325,627 @@ ___
|
|
|
327
325
|
|
|
328
326
|
##### Returns
|
|
329
327
|
|
|
330
|
-
`Promise
|
|
328
|
+
`Promise`\<`R`\>
|
|
329
|
+
|
|
330
|
+
**`Export`**
|
|
331
331
|
|
|
332
332
|
#### Defined in
|
|
333
333
|
|
|
334
|
-
[packages/notifications/utils/common.ts:133](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
334
|
+
[packages/notifications/utils/common.ts:133](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L133)
|
|
335
335
|
|
|
336
336
|
___
|
|
337
337
|
|
|
338
338
|
### drawerResourceV1GetDrawerEntries
|
|
339
339
|
|
|
340
|
-
▸ **drawerResourceV1GetDrawerEntries**(
|
|
340
|
+
▸ **drawerResourceV1GetDrawerEntries**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
341
341
|
|
|
342
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
343
|
|
|
344
|
-
**`Summary`**
|
|
345
|
-
|
|
346
|
-
Retrieve drawer notifications entries.
|
|
347
|
-
|
|
348
|
-
**`Throws`**
|
|
349
|
-
|
|
350
344
|
#### Parameters
|
|
351
345
|
|
|
352
346
|
| Name | Type | Description |
|
|
353
347
|
| :------ | :------ | :------ |
|
|
354
|
-
| `...config` | [`DrawerResourceV1GetDrawerEntriesParams`] \| [`Set
|
|
348
|
+
| `...config` | [`DrawerResourceV1GetDrawerEntriesParams`] \| [`Set`\<`string`\>, `Set`\<`string`\>, `string`, `Set`\<`string`\>, `number`, `number`, `number`, `boolean`, `string`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
355
349
|
|
|
356
350
|
#### Returns
|
|
357
351
|
|
|
358
|
-
`Promise
|
|
352
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
353
|
+
|
|
354
|
+
**`Summary`**
|
|
355
|
+
|
|
356
|
+
Retrieve drawer notifications entries.
|
|
357
|
+
|
|
358
|
+
**`Throws`**
|
|
359
359
|
|
|
360
360
|
#### Defined in
|
|
361
361
|
|
|
362
|
-
[packages/notifications/DrawerResourceV1GetDrawerEntries/index.ts:94](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
362
|
+
[packages/notifications/DrawerResourceV1GetDrawerEntries/index.ts:94](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/DrawerResourceV1GetDrawerEntries/index.ts#L94)
|
|
363
363
|
|
|
364
364
|
___
|
|
365
365
|
|
|
366
366
|
### drawerResourceV1UpdateNotificationReadStatus
|
|
367
367
|
|
|
368
|
-
▸ **drawerResourceV1UpdateNotificationReadStatus**(
|
|
368
|
+
▸ **drawerResourceV1UpdateNotificationReadStatus**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
369
369
|
|
|
370
370
|
Update drawer notifications status.
|
|
371
371
|
|
|
372
|
-
**`Summary`**
|
|
373
|
-
|
|
374
|
-
Update drawer notifications status.
|
|
375
|
-
|
|
376
|
-
**`Throws`**
|
|
377
|
-
|
|
378
372
|
#### Parameters
|
|
379
373
|
|
|
380
374
|
| Name | Type | Description |
|
|
381
375
|
| :------ | :------ | :------ |
|
|
382
|
-
| `...config` | [`DrawerResourceV1UpdateNotificationReadStatusParams`] \| [[`UpdateNotificationDrawerStatus`](interfaces/UpdateNotificationDrawerStatus.md), `AxiosRequestConfig
|
|
376
|
+
| `...config` | [`DrawerResourceV1UpdateNotificationReadStatusParams`] \| [[`UpdateNotificationDrawerStatus`](interfaces/UpdateNotificationDrawerStatus.md), `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
383
377
|
|
|
384
378
|
#### Returns
|
|
385
379
|
|
|
386
|
-
`Promise
|
|
380
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
381
|
+
|
|
382
|
+
**`Summary`**
|
|
383
|
+
|
|
384
|
+
Update drawer notifications status.
|
|
385
|
+
|
|
386
|
+
**`Throws`**
|
|
387
387
|
|
|
388
388
|
#### Defined in
|
|
389
389
|
|
|
390
|
-
[packages/notifications/DrawerResourceV1UpdateNotificationReadStatus/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
390
|
+
[packages/notifications/DrawerResourceV1UpdateNotificationReadStatus/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/DrawerResourceV1UpdateNotificationReadStatus/index.ts#L34)
|
|
391
391
|
|
|
392
392
|
___
|
|
393
393
|
|
|
394
394
|
### eventResourceV1GetEvents
|
|
395
395
|
|
|
396
|
-
▸ **eventResourceV1GetEvents**(
|
|
396
|
+
▸ **eventResourceV1GetEvents**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
397
397
|
|
|
398
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
399
|
|
|
400
|
-
**`Summary`**
|
|
401
|
-
|
|
402
|
-
Retrieve the event log entries
|
|
403
|
-
|
|
404
|
-
**`Throws`**
|
|
405
|
-
|
|
406
400
|
#### Parameters
|
|
407
401
|
|
|
408
402
|
| Name | Type | Description |
|
|
409
403
|
| :------ | :------ | :------ |
|
|
410
|
-
| `...config` | [`EventResourceV1GetEventsParams`] \| [`Set
|
|
404
|
+
| `...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. |
|
|
411
405
|
|
|
412
406
|
#### Returns
|
|
413
407
|
|
|
414
|
-
`Promise
|
|
408
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
415
409
|
|
|
416
|
-
|
|
410
|
+
**`Summary`**
|
|
417
411
|
|
|
418
|
-
|
|
412
|
+
Retrieve the event log entries
|
|
419
413
|
|
|
420
|
-
|
|
414
|
+
**`Throws`**
|
|
421
415
|
|
|
422
|
-
|
|
416
|
+
#### Defined in
|
|
423
417
|
|
|
424
|
-
|
|
418
|
+
[packages/notifications/EventResourceV1GetEvents/index.ts:124](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/EventResourceV1GetEvents/index.ts#L124)
|
|
425
419
|
|
|
426
|
-
|
|
420
|
+
___
|
|
427
421
|
|
|
428
|
-
|
|
422
|
+
### notificationResourceV1AppendBehaviorGroupToEventType
|
|
429
423
|
|
|
430
|
-
|
|
424
|
+
▸ **notificationResourceV1AppendBehaviorGroupToEventType**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
431
425
|
|
|
432
426
|
#### Parameters
|
|
433
427
|
|
|
434
428
|
| Name | Type | Description |
|
|
435
429
|
| :------ | :------ | :------ |
|
|
436
|
-
| `...config` | [`NotificationResourceV1AppendBehaviorGroupToEventTypeParams`] \| [`string`, `string`, `AxiosRequestConfig
|
|
430
|
+
| `...config` | [`NotificationResourceV1AppendBehaviorGroupToEventTypeParams`] \| [`string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
437
431
|
|
|
438
432
|
#### Returns
|
|
439
433
|
|
|
440
|
-
`Promise
|
|
434
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
435
|
+
|
|
436
|
+
**`Summary`**
|
|
437
|
+
|
|
438
|
+
Add a behavior group to the given event type.
|
|
439
|
+
|
|
440
|
+
**`Throws`**
|
|
441
441
|
|
|
442
442
|
#### Defined in
|
|
443
443
|
|
|
444
|
-
[packages/notifications/NotificationResourceV1AppendBehaviorGroupToEventType/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
444
|
+
[packages/notifications/NotificationResourceV1AppendBehaviorGroupToEventType/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1AppendBehaviorGroupToEventType/index.ts#L40)
|
|
445
445
|
|
|
446
446
|
___
|
|
447
447
|
|
|
448
448
|
### notificationResourceV1CreateBehaviorGroup
|
|
449
449
|
|
|
450
|
-
▸ **notificationResourceV1CreateBehaviorGroup**(
|
|
450
|
+
▸ **notificationResourceV1CreateBehaviorGroup**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
451
451
|
|
|
452
452
|
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
453
|
|
|
454
|
-
**`Summary`**
|
|
455
|
-
|
|
456
|
-
Create a behavior group
|
|
457
|
-
|
|
458
|
-
**`Throws`**
|
|
459
|
-
|
|
460
454
|
#### Parameters
|
|
461
455
|
|
|
462
456
|
| Name | Type | Description |
|
|
463
457
|
| :------ | :------ | :------ |
|
|
464
|
-
| `...config` | [`NotificationResourceV1CreateBehaviorGroupParams`] \| [[`CreateBehaviorGroupRequest`](interfaces/CreateBehaviorGroupRequest.md), `AxiosRequestConfig
|
|
458
|
+
| `...config` | [`NotificationResourceV1CreateBehaviorGroupParams`] \| [[`CreateBehaviorGroupRequest`](interfaces/CreateBehaviorGroupRequest.md), `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
465
459
|
|
|
466
460
|
#### Returns
|
|
467
461
|
|
|
468
|
-
`Promise
|
|
462
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
463
|
+
|
|
464
|
+
**`Summary`**
|
|
465
|
+
|
|
466
|
+
Create a behavior group
|
|
467
|
+
|
|
468
|
+
**`Throws`**
|
|
469
469
|
|
|
470
470
|
#### Defined in
|
|
471
471
|
|
|
472
|
-
[packages/notifications/NotificationResourceV1CreateBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
472
|
+
[packages/notifications/NotificationResourceV1CreateBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1CreateBehaviorGroup/index.ts#L34)
|
|
473
473
|
|
|
474
474
|
___
|
|
475
475
|
|
|
476
476
|
### notificationResourceV1DeleteBehaviorGroup
|
|
477
477
|
|
|
478
|
-
▸ **notificationResourceV1DeleteBehaviorGroup**(
|
|
478
|
+
▸ **notificationResourceV1DeleteBehaviorGroup**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
479
479
|
|
|
480
480
|
Deletes a behavior group and all of its configured actions. Use this endpoint when you no longer need a behavior group.
|
|
481
481
|
|
|
482
|
-
**`Summary`**
|
|
483
|
-
|
|
484
|
-
Delete a behavior group
|
|
485
|
-
|
|
486
|
-
**`Throws`**
|
|
487
|
-
|
|
488
482
|
#### Parameters
|
|
489
483
|
|
|
490
484
|
| Name | Type | Description |
|
|
491
485
|
| :------ | :------ | :------ |
|
|
492
|
-
| `...config` | [`NotificationResourceV1DeleteBehaviorGroupParams`] \| [`string`, `AxiosRequestConfig
|
|
486
|
+
| `...config` | [`NotificationResourceV1DeleteBehaviorGroupParams`] \| [`string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
493
487
|
|
|
494
488
|
#### Returns
|
|
495
489
|
|
|
496
|
-
`Promise
|
|
490
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
491
|
+
|
|
492
|
+
**`Summary`**
|
|
493
|
+
|
|
494
|
+
Delete a behavior group
|
|
495
|
+
|
|
496
|
+
**`Throws`**
|
|
497
497
|
|
|
498
498
|
#### Defined in
|
|
499
499
|
|
|
500
|
-
[packages/notifications/NotificationResourceV1DeleteBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
500
|
+
[packages/notifications/NotificationResourceV1DeleteBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1DeleteBehaviorGroup/index.ts#L34)
|
|
501
501
|
|
|
502
502
|
___
|
|
503
503
|
|
|
504
504
|
### notificationResourceV1DeleteBehaviorGroupFromEventType
|
|
505
505
|
|
|
506
|
-
▸ **notificationResourceV1DeleteBehaviorGroupFromEventType**(
|
|
506
|
+
▸ **notificationResourceV1DeleteBehaviorGroupFromEventType**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
507
507
|
|
|
508
508
|
Adds a behavior group to the specified event type.
|
|
509
509
|
|
|
510
|
-
**`Summary`**
|
|
511
|
-
|
|
512
|
-
Add a behavior group to an event type
|
|
513
|
-
|
|
514
|
-
**`Throws`**
|
|
515
|
-
|
|
516
510
|
#### Parameters
|
|
517
511
|
|
|
518
512
|
| Name | Type | Description |
|
|
519
513
|
| :------ | :------ | :------ |
|
|
520
|
-
| `...config` | [`string`, `string`, `AxiosRequestConfig
|
|
514
|
+
| `...config` | [`string`, `string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1DeleteBehaviorGroupFromEventTypeParams`] | with all available params. |
|
|
521
515
|
|
|
522
516
|
#### Returns
|
|
523
517
|
|
|
524
|
-
`Promise
|
|
518
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
519
|
+
|
|
520
|
+
**`Summary`**
|
|
521
|
+
|
|
522
|
+
Add a behavior group to an event type
|
|
523
|
+
|
|
524
|
+
**`Throws`**
|
|
525
525
|
|
|
526
526
|
#### Defined in
|
|
527
527
|
|
|
528
|
-
[packages/notifications/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
528
|
+
[packages/notifications/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.ts#L40)
|
|
529
529
|
|
|
530
530
|
___
|
|
531
531
|
|
|
532
532
|
### notificationResourceV1FindBehaviorGroupsByBundleId
|
|
533
533
|
|
|
534
|
-
▸ **notificationResourceV1FindBehaviorGroupsByBundleId**(
|
|
534
|
+
▸ **notificationResourceV1FindBehaviorGroupsByBundleId**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
535
535
|
|
|
536
536
|
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
537
|
|
|
538
|
-
**`Summary`**
|
|
539
|
-
|
|
540
|
-
List behavior groups in a bundle
|
|
541
|
-
|
|
542
|
-
**`Throws`**
|
|
543
|
-
|
|
544
538
|
#### Parameters
|
|
545
539
|
|
|
546
540
|
| Name | Type | Description |
|
|
547
541
|
| :------ | :------ | :------ |
|
|
548
|
-
| `...config` | [`string`, `AxiosRequestConfig
|
|
542
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1FindBehaviorGroupsByBundleIdParams`] | with all available params. |
|
|
549
543
|
|
|
550
544
|
#### Returns
|
|
551
545
|
|
|
552
|
-
`Promise
|
|
546
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
547
|
+
|
|
548
|
+
**`Summary`**
|
|
549
|
+
|
|
550
|
+
List behavior groups in a bundle
|
|
551
|
+
|
|
552
|
+
**`Throws`**
|
|
553
553
|
|
|
554
554
|
#### Defined in
|
|
555
555
|
|
|
556
|
-
[packages/notifications/NotificationResourceV1FindBehaviorGroupsByBundleId/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
556
|
+
[packages/notifications/NotificationResourceV1FindBehaviorGroupsByBundleId/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1FindBehaviorGroupsByBundleId/index.ts#L34)
|
|
557
557
|
|
|
558
558
|
___
|
|
559
559
|
|
|
560
560
|
### notificationResourceV1GetApplicationByNameAndBundleName
|
|
561
561
|
|
|
562
|
-
▸ **notificationResourceV1GetApplicationByNameAndBundleName**(
|
|
562
|
+
▸ **notificationResourceV1GetApplicationByNameAndBundleName**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
563
563
|
|
|
564
564
|
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
565
|
|
|
566
|
-
**`Summary`**
|
|
567
|
-
|
|
568
|
-
Retrieve an application by bundle and application names
|
|
569
|
-
|
|
570
|
-
**`Throws`**
|
|
571
|
-
|
|
572
566
|
#### Parameters
|
|
573
567
|
|
|
574
568
|
| Name | Type | Description |
|
|
575
569
|
| :------ | :------ | :------ |
|
|
576
|
-
| `...config` | [`string`, `string`, `AxiosRequestConfig
|
|
570
|
+
| `...config` | [`string`, `string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1GetApplicationByNameAndBundleNameParams`] | with all available params. |
|
|
577
571
|
|
|
578
572
|
#### Returns
|
|
579
573
|
|
|
580
|
-
`Promise
|
|
574
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
575
|
+
|
|
576
|
+
**`Summary`**
|
|
577
|
+
|
|
578
|
+
Retrieve an application by bundle and application names
|
|
579
|
+
|
|
580
|
+
**`Throws`**
|
|
581
581
|
|
|
582
582
|
#### Defined in
|
|
583
583
|
|
|
584
|
-
[packages/notifications/NotificationResourceV1GetApplicationByNameAndBundleName/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
584
|
+
[packages/notifications/NotificationResourceV1GetApplicationByNameAndBundleName/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetApplicationByNameAndBundleName/index.ts#L40)
|
|
585
585
|
|
|
586
586
|
___
|
|
587
587
|
|
|
588
588
|
### notificationResourceV1GetApplicationsFacets
|
|
589
589
|
|
|
590
|
-
▸ **notificationResourceV1GetApplicationsFacets**(
|
|
590
|
+
▸ **notificationResourceV1GetApplicationsFacets**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
591
591
|
|
|
592
592
|
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
593
|
|
|
594
|
-
**`Summary`**
|
|
595
|
-
|
|
596
|
-
List configured applications
|
|
597
|
-
|
|
598
|
-
**`Throws`**
|
|
599
|
-
|
|
600
594
|
#### Parameters
|
|
601
595
|
|
|
602
596
|
| Name | Type | Description |
|
|
603
597
|
| :------ | :------ | :------ |
|
|
604
|
-
| `...config` | [`string`, `AxiosRequestConfig
|
|
598
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1GetApplicationsFacetsParams`] | with all available params. |
|
|
605
599
|
|
|
606
600
|
#### Returns
|
|
607
601
|
|
|
608
|
-
`Promise
|
|
602
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
603
|
+
|
|
604
|
+
**`Summary`**
|
|
605
|
+
|
|
606
|
+
List configured applications
|
|
607
|
+
|
|
608
|
+
**`Throws`**
|
|
609
609
|
|
|
610
610
|
#### Defined in
|
|
611
611
|
|
|
612
|
-
[packages/notifications/NotificationResourceV1GetApplicationsFacets/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
612
|
+
[packages/notifications/NotificationResourceV1GetApplicationsFacets/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetApplicationsFacets/index.ts#L34)
|
|
613
613
|
|
|
614
614
|
___
|
|
615
615
|
|
|
616
616
|
### notificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint
|
|
617
617
|
|
|
618
|
-
▸ **notificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint**(
|
|
618
|
+
▸ **notificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
619
619
|
|
|
620
620
|
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
621
|
|
|
622
|
-
**`Summary`**
|
|
623
|
-
|
|
624
|
-
List the behavior groups affected by the removal of an endpoint
|
|
625
|
-
|
|
626
|
-
**`Throws`**
|
|
627
|
-
|
|
628
622
|
#### Parameters
|
|
629
623
|
|
|
630
624
|
| Name | Type | Description |
|
|
631
625
|
| :------ | :------ | :------ |
|
|
632
|
-
| `...config` | [`string`, `AxiosRequestConfig
|
|
626
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointParams`] | with all available params. |
|
|
633
627
|
|
|
634
628
|
#### Returns
|
|
635
629
|
|
|
636
|
-
`Promise
|
|
630
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
631
|
+
|
|
632
|
+
**`Summary`**
|
|
633
|
+
|
|
634
|
+
List the behavior groups affected by the removal of an endpoint
|
|
635
|
+
|
|
636
|
+
**`Throws`**
|
|
637
637
|
|
|
638
638
|
#### Defined in
|
|
639
639
|
|
|
640
|
-
[packages/notifications/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
640
|
+
[packages/notifications/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.ts#L34)
|
|
641
641
|
|
|
642
642
|
___
|
|
643
643
|
|
|
644
644
|
### notificationResourceV1GetBundleByName
|
|
645
645
|
|
|
646
|
-
▸ **notificationResourceV1GetBundleByName**(
|
|
646
|
+
▸ **notificationResourceV1GetBundleByName**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
647
647
|
|
|
648
648
|
Retrieves the details of a bundle by searching by its name.
|
|
649
649
|
|
|
650
|
-
**`Summary`**
|
|
651
|
-
|
|
652
|
-
Retrieve a bundle by name
|
|
653
|
-
|
|
654
|
-
**`Throws`**
|
|
655
|
-
|
|
656
650
|
#### Parameters
|
|
657
651
|
|
|
658
652
|
| Name | Type | Description |
|
|
659
653
|
| :------ | :------ | :------ |
|
|
660
|
-
| `...config` | [`string`, `AxiosRequestConfig
|
|
654
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1GetBundleByNameParams`] | with all available params. |
|
|
661
655
|
|
|
662
656
|
#### Returns
|
|
663
657
|
|
|
664
|
-
`Promise
|
|
658
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
659
|
+
|
|
660
|
+
**`Summary`**
|
|
661
|
+
|
|
662
|
+
Retrieve a bundle by name
|
|
663
|
+
|
|
664
|
+
**`Throws`**
|
|
665
665
|
|
|
666
666
|
#### Defined in
|
|
667
667
|
|
|
668
|
-
[packages/notifications/NotificationResourceV1GetBundleByName/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
668
|
+
[packages/notifications/NotificationResourceV1GetBundleByName/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBundleByName/index.ts#L34)
|
|
669
669
|
|
|
670
670
|
___
|
|
671
671
|
|
|
672
672
|
### notificationResourceV1GetBundleFacets
|
|
673
673
|
|
|
674
|
-
▸ **notificationResourceV1GetBundleFacets**(
|
|
674
|
+
▸ **notificationResourceV1GetBundleFacets**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
675
675
|
|
|
676
676
|
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
677
|
|
|
678
|
-
**`Summary`**
|
|
679
|
-
|
|
680
|
-
List configured bundles
|
|
681
|
-
|
|
682
|
-
**`Throws`**
|
|
683
|
-
|
|
684
678
|
#### Parameters
|
|
685
679
|
|
|
686
680
|
| Name | Type | Description |
|
|
687
681
|
| :------ | :------ | :------ |
|
|
688
|
-
| `...config` | [`NotificationResourceV1GetBundleFacetsParams`] \| [`boolean`, `AxiosRequestConfig
|
|
682
|
+
| `...config` | [`NotificationResourceV1GetBundleFacetsParams`] \| [`boolean`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
689
683
|
|
|
690
684
|
#### Returns
|
|
691
685
|
|
|
692
|
-
`Promise
|
|
686
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
687
|
+
|
|
688
|
+
**`Summary`**
|
|
689
|
+
|
|
690
|
+
List configured bundles
|
|
691
|
+
|
|
692
|
+
**`Throws`**
|
|
693
693
|
|
|
694
694
|
#### Defined in
|
|
695
695
|
|
|
696
|
-
[packages/notifications/NotificationResourceV1GetBundleFacets/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
696
|
+
[packages/notifications/NotificationResourceV1GetBundleFacets/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBundleFacets/index.ts#L34)
|
|
697
697
|
|
|
698
698
|
___
|
|
699
699
|
|
|
700
700
|
### notificationResourceV1GetEventTypes
|
|
701
701
|
|
|
702
|
-
▸ **notificationResourceV1GetEventTypes**(
|
|
702
|
+
▸ **notificationResourceV1GetEventTypes**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
703
703
|
|
|
704
704
|
Lists all event types. You can filter the returned list by bundle or application name.
|
|
705
705
|
|
|
706
|
-
**`Summary`**
|
|
707
|
-
|
|
708
|
-
List all event types
|
|
709
|
-
|
|
710
|
-
**`Throws`**
|
|
711
|
-
|
|
712
706
|
#### Parameters
|
|
713
707
|
|
|
714
708
|
| Name | Type | Description |
|
|
715
709
|
| :------ | :------ | :------ |
|
|
716
|
-
| `...config` | [`NotificationResourceV1GetEventTypesParams`] \| [`Set
|
|
710
|
+
| `...config` | [`NotificationResourceV1GetEventTypesParams`] \| [`Set`\<`string`\>, `string`, `string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
717
711
|
|
|
718
712
|
#### Returns
|
|
719
713
|
|
|
720
|
-
`Promise
|
|
714
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
715
|
+
|
|
716
|
+
**`Summary`**
|
|
717
|
+
|
|
718
|
+
List all event types
|
|
719
|
+
|
|
720
|
+
**`Throws`**
|
|
721
721
|
|
|
722
722
|
#### Defined in
|
|
723
723
|
|
|
724
|
-
[packages/notifications/NotificationResourceV1GetEventTypes/index.ts:76](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
724
|
+
[packages/notifications/NotificationResourceV1GetEventTypes/index.ts:76](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypes/index.ts#L76)
|
|
725
725
|
|
|
726
726
|
___
|
|
727
727
|
|
|
728
728
|
### notificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup
|
|
729
729
|
|
|
730
|
-
▸ **notificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup**(
|
|
730
|
+
▸ **notificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
731
731
|
|
|
732
732
|
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
733
|
|
|
734
|
-
**`Summary`**
|
|
735
|
-
|
|
736
|
-
List the event types affected by the removal of a behavior group
|
|
737
|
-
|
|
738
|
-
**`Throws`**
|
|
739
|
-
|
|
740
734
|
#### Parameters
|
|
741
735
|
|
|
742
736
|
| Name | Type | Description |
|
|
743
737
|
| :------ | :------ | :------ |
|
|
744
|
-
| `...config` | [`string`, `AxiosRequestConfig
|
|
738
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [`NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupParams`] | with all available params. |
|
|
745
739
|
|
|
746
740
|
#### Returns
|
|
747
741
|
|
|
748
|
-
`Promise
|
|
742
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
743
|
+
|
|
744
|
+
**`Summary`**
|
|
745
|
+
|
|
746
|
+
List the event types affected by the removal of a behavior group
|
|
747
|
+
|
|
748
|
+
**`Throws`**
|
|
749
749
|
|
|
750
750
|
#### Defined in
|
|
751
751
|
|
|
752
|
-
[packages/notifications/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
752
|
+
[packages/notifications/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts#L34)
|
|
753
753
|
|
|
754
754
|
___
|
|
755
755
|
|
|
756
756
|
### notificationResourceV1GetEventTypesByNameAndBundleAndApplicationName
|
|
757
757
|
|
|
758
|
-
▸ **notificationResourceV1GetEventTypesByNameAndBundleAndApplicationName**(
|
|
758
|
+
▸ **notificationResourceV1GetEventTypesByNameAndBundleAndApplicationName**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
759
759
|
|
|
760
760
|
Retrieves the details of an event type by specifying the bundle name, the application name, and the event type name.
|
|
761
761
|
|
|
762
|
-
**`Summary`**
|
|
763
|
-
|
|
764
|
-
Retrieve an event type by bundle, application and event type names
|
|
765
|
-
|
|
766
|
-
**`Throws`**
|
|
767
|
-
|
|
768
762
|
#### Parameters
|
|
769
763
|
|
|
770
764
|
| Name | Type | Description |
|
|
771
765
|
| :------ | :------ | :------ |
|
|
772
|
-
| `...config` | [`NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParams`] \| [`string`, `string`, `string`, `AxiosRequestConfig
|
|
766
|
+
| `...config` | [`NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParams`] \| [`string`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
773
767
|
|
|
774
768
|
#### Returns
|
|
775
769
|
|
|
776
|
-
`Promise
|
|
770
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
771
|
+
|
|
772
|
+
**`Summary`**
|
|
773
|
+
|
|
774
|
+
Retrieve an event type by bundle, application and event type names
|
|
775
|
+
|
|
776
|
+
**`Throws`**
|
|
777
777
|
|
|
778
778
|
#### Defined in
|
|
779
779
|
|
|
780
|
-
[packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
780
|
+
[packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts#L46)
|
|
781
781
|
|
|
782
782
|
___
|
|
783
783
|
|
|
784
784
|
### notificationResourceV1GetLinkedBehaviorGroups
|
|
785
785
|
|
|
786
|
-
▸ **notificationResourceV1GetLinkedBehaviorGroups**(
|
|
786
|
+
▸ **notificationResourceV1GetLinkedBehaviorGroups**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
787
787
|
|
|
788
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.
|
|
789
789
|
|
|
790
|
-
**`Summary`**
|
|
791
|
-
|
|
792
|
-
List the behavior groups linked to an event type
|
|
793
|
-
|
|
794
|
-
**`Throws`**
|
|
795
|
-
|
|
796
790
|
#### Parameters
|
|
797
791
|
|
|
798
792
|
| Name | Type | Description |
|
|
799
793
|
| :------ | :------ | :------ |
|
|
800
|
-
| `...config` | [`NotificationResourceV1GetLinkedBehaviorGroupsParams`] \| [`string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig
|
|
794
|
+
| `...config` | [`NotificationResourceV1GetLinkedBehaviorGroupsParams`] \| [`string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
801
795
|
|
|
802
796
|
#### Returns
|
|
803
797
|
|
|
804
|
-
`Promise
|
|
798
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
799
|
+
|
|
800
|
+
**`Summary`**
|
|
801
|
+
|
|
802
|
+
List the behavior groups linked to an event type
|
|
803
|
+
|
|
804
|
+
**`Throws`**
|
|
805
805
|
|
|
806
806
|
#### Defined in
|
|
807
807
|
|
|
808
|
-
[packages/notifications/NotificationResourceV1GetLinkedBehaviorGroups/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
808
|
+
[packages/notifications/NotificationResourceV1GetLinkedBehaviorGroups/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetLinkedBehaviorGroups/index.ts#L64)
|
|
809
809
|
|
|
810
810
|
___
|
|
811
811
|
|
|
812
812
|
### notificationResourceV1UpdateBehaviorGroup
|
|
813
813
|
|
|
814
|
-
▸ **notificationResourceV1UpdateBehaviorGroup**(
|
|
814
|
+
▸ **notificationResourceV1UpdateBehaviorGroup**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
815
815
|
|
|
816
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.
|
|
817
817
|
|
|
818
|
-
**`Summary`**
|
|
819
|
-
|
|
820
|
-
Update a behavior group
|
|
821
|
-
|
|
822
|
-
**`Throws`**
|
|
823
|
-
|
|
824
818
|
#### Parameters
|
|
825
819
|
|
|
826
820
|
| Name | Type | Description |
|
|
827
821
|
| :------ | :------ | :------ |
|
|
828
|
-
| `...config` | [`NotificationResourceV1UpdateBehaviorGroupParams`] \| [`string`, [`UpdateBehaviorGroupRequest`](interfaces/UpdateBehaviorGroupRequest.md), `AxiosRequestConfig
|
|
822
|
+
| `...config` | [`NotificationResourceV1UpdateBehaviorGroupParams`] \| [`string`, [`UpdateBehaviorGroupRequest`](interfaces/UpdateBehaviorGroupRequest.md), `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
829
823
|
|
|
830
824
|
#### Returns
|
|
831
825
|
|
|
832
|
-
`Promise
|
|
826
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
827
|
+
|
|
828
|
+
**`Summary`**
|
|
829
|
+
|
|
830
|
+
Update a behavior group
|
|
831
|
+
|
|
832
|
+
**`Throws`**
|
|
833
833
|
|
|
834
834
|
#### Defined in
|
|
835
835
|
|
|
836
|
-
[packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
836
|
+
[packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts#L40)
|
|
837
837
|
|
|
838
838
|
___
|
|
839
839
|
|
|
840
840
|
### notificationResourceV1UpdateBehaviorGroupActions
|
|
841
841
|
|
|
842
|
-
▸ **notificationResourceV1UpdateBehaviorGroupActions**(
|
|
842
|
+
▸ **notificationResourceV1UpdateBehaviorGroupActions**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
843
843
|
|
|
844
844
|
Updates the list of actions to be executed in that particular behavior group after an event is received.
|
|
845
845
|
|
|
846
|
-
**`Summary`**
|
|
847
|
-
|
|
848
|
-
Update the list of behavior group actions
|
|
849
|
-
|
|
850
|
-
**`Throws`**
|
|
851
|
-
|
|
852
846
|
#### Parameters
|
|
853
847
|
|
|
854
848
|
| Name | Type | Description |
|
|
855
849
|
| :------ | :------ | :------ |
|
|
856
|
-
| `...config` | [`NotificationResourceV1UpdateBehaviorGroupActionsParams`] \| [`string`, `string`[], `AxiosRequestConfig
|
|
850
|
+
| `...config` | [`NotificationResourceV1UpdateBehaviorGroupActionsParams`] \| [`string`, `string`[], `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
857
851
|
|
|
858
852
|
#### Returns
|
|
859
853
|
|
|
860
|
-
`Promise
|
|
854
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
855
|
+
|
|
856
|
+
**`Summary`**
|
|
857
|
+
|
|
858
|
+
Update the list of behavior group actions
|
|
859
|
+
|
|
860
|
+
**`Throws`**
|
|
861
861
|
|
|
862
862
|
#### Defined in
|
|
863
863
|
|
|
864
|
-
[packages/notifications/NotificationResourceV1UpdateBehaviorGroupActions/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
864
|
+
[packages/notifications/NotificationResourceV1UpdateBehaviorGroupActions/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateBehaviorGroupActions/index.ts#L40)
|
|
865
865
|
|
|
866
866
|
___
|
|
867
867
|
|
|
868
868
|
### notificationResourceV1UpdateEventTypeBehaviors
|
|
869
869
|
|
|
870
|
-
▸ **notificationResourceV1UpdateEventTypeBehaviors**(
|
|
870
|
+
▸ **notificationResourceV1UpdateEventTypeBehaviors**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
871
871
|
|
|
872
872
|
Updates the list of behavior groups associated with an event type.
|
|
873
873
|
|
|
874
|
-
**`Summary`**
|
|
875
|
-
|
|
876
|
-
Update the list of behavior groups for an event type
|
|
877
|
-
|
|
878
|
-
**`Throws`**
|
|
879
|
-
|
|
880
874
|
#### Parameters
|
|
881
875
|
|
|
882
876
|
| Name | Type | Description |
|
|
883
877
|
| :------ | :------ | :------ |
|
|
884
|
-
| `...config` | [`NotificationResourceV1UpdateEventTypeBehaviorsParams`] \| [`string`, `Set
|
|
878
|
+
| `...config` | [`NotificationResourceV1UpdateEventTypeBehaviorsParams`] \| [`string`, `Set`\<`string`\>, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
885
879
|
|
|
886
880
|
#### Returns
|
|
887
881
|
|
|
888
|
-
`Promise
|
|
882
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
883
|
+
|
|
884
|
+
**`Summary`**
|
|
885
|
+
|
|
886
|
+
Update the list of behavior groups for an event type
|
|
887
|
+
|
|
888
|
+
**`Throws`**
|
|
889
889
|
|
|
890
890
|
#### Defined in
|
|
891
891
|
|
|
892
|
-
[packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
892
|
+
[packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts#L40)
|
|
893
893
|
|
|
894
894
|
___
|
|
895
895
|
|
|
896
896
|
### orgConfigResourceV1GetDailyDigestTimePreference
|
|
897
897
|
|
|
898
|
-
▸ **orgConfigResourceV1GetDailyDigestTimePreference**(
|
|
898
|
+
▸ **orgConfigResourceV1GetDailyDigestTimePreference**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
899
899
|
|
|
900
900
|
Retrieves the daily digest time setting. Use this endpoint to check the time that daily emails are sent.
|
|
901
901
|
|
|
902
|
-
**`Summary`**
|
|
903
|
-
|
|
904
|
-
Retrieve the daily digest time
|
|
905
|
-
|
|
906
|
-
**`Throws`**
|
|
907
|
-
|
|
908
902
|
#### Parameters
|
|
909
903
|
|
|
910
904
|
| Name | Type | Description |
|
|
911
905
|
| :------ | :------ | :------ |
|
|
912
|
-
| `...config` | [`OrgConfigResourceV1GetDailyDigestTimePreferenceParams`] \| [`AxiosRequestConfig
|
|
906
|
+
| `...config` | [`OrgConfigResourceV1GetDailyDigestTimePreferenceParams`] \| [`AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
913
907
|
|
|
914
908
|
#### Returns
|
|
915
909
|
|
|
916
|
-
`Promise
|
|
910
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
911
|
+
|
|
912
|
+
**`Summary`**
|
|
913
|
+
|
|
914
|
+
Retrieve the daily digest time
|
|
915
|
+
|
|
916
|
+
**`Throws`**
|
|
917
917
|
|
|
918
918
|
#### Defined in
|
|
919
919
|
|
|
920
|
-
[packages/notifications/OrgConfigResourceV1GetDailyDigestTimePreference/index.ts:28](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
920
|
+
[packages/notifications/OrgConfigResourceV1GetDailyDigestTimePreference/index.ts:28](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/OrgConfigResourceV1GetDailyDigestTimePreference/index.ts#L28)
|
|
921
921
|
|
|
922
922
|
___
|
|
923
923
|
|
|
924
924
|
### orgConfigResourceV1SaveDailyDigestTimePreference
|
|
925
925
|
|
|
926
|
-
▸ **orgConfigResourceV1SaveDailyDigestTimePreference**(
|
|
926
|
+
▸ **orgConfigResourceV1SaveDailyDigestTimePreference**(`...config`): `Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
927
927
|
|
|
928
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
929
|
|
|
930
|
-
**`Summary`**
|
|
931
|
-
|
|
932
|
-
Set the daily digest time
|
|
933
|
-
|
|
934
|
-
**`Throws`**
|
|
935
|
-
|
|
936
930
|
#### Parameters
|
|
937
931
|
|
|
938
932
|
| Name | Type | Description |
|
|
939
933
|
| :------ | :------ | :------ |
|
|
940
|
-
| `...config` | [`string`, `AxiosRequestConfig
|
|
934
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [`OrgConfigResourceV1SaveDailyDigestTimePreferenceParams`] | with all available params. |
|
|
941
935
|
|
|
942
936
|
#### Returns
|
|
943
937
|
|
|
944
|
-
`Promise
|
|
938
|
+
`Promise`\<[`RequestArgs`](interfaces/RequestArgs.md)\>
|
|
939
|
+
|
|
940
|
+
**`Summary`**
|
|
941
|
+
|
|
942
|
+
Set the daily digest time
|
|
943
|
+
|
|
944
|
+
**`Throws`**
|
|
945
945
|
|
|
946
946
|
#### Defined in
|
|
947
947
|
|
|
948
|
-
[packages/notifications/OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
948
|
+
[packages/notifications/OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts#L34)
|
|
949
949
|
|
|
950
950
|
___
|
|
951
951
|
|
|
@@ -953,8 +953,6 @@ ___
|
|
|
953
953
|
|
|
954
954
|
▸ **serializeDataIfNeeded**(`value`, `requestOptions`, `configuration?`): `any`
|
|
955
955
|
|
|
956
|
-
**`Export`**
|
|
957
|
-
|
|
958
956
|
#### Parameters
|
|
959
957
|
|
|
960
958
|
| Name | Type |
|
|
@@ -967,17 +965,17 @@ ___
|
|
|
967
965
|
|
|
968
966
|
`any`
|
|
969
967
|
|
|
968
|
+
**`Export`**
|
|
969
|
+
|
|
970
970
|
#### Defined in
|
|
971
971
|
|
|
972
|
-
[packages/notifications/utils/common.ts:111](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
972
|
+
[packages/notifications/utils/common.ts:111](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L111)
|
|
973
973
|
|
|
974
974
|
___
|
|
975
975
|
|
|
976
976
|
### setApiKeyToObject
|
|
977
977
|
|
|
978
|
-
▸ **setApiKeyToObject**(`object`, `keyParamName`, `configuration?`): `Promise
|
|
979
|
-
|
|
980
|
-
**`Export`**
|
|
978
|
+
▸ **setApiKeyToObject**(`object`, `keyParamName`, `configuration?`): `Promise`\<`void`\>
|
|
981
979
|
|
|
982
980
|
#### Parameters
|
|
983
981
|
|
|
@@ -989,11 +987,13 @@ ___
|
|
|
989
987
|
|
|
990
988
|
#### Returns
|
|
991
989
|
|
|
992
|
-
`Promise
|
|
990
|
+
`Promise`\<`void`\>
|
|
991
|
+
|
|
992
|
+
**`Export`**
|
|
993
993
|
|
|
994
994
|
#### Defined in
|
|
995
995
|
|
|
996
|
-
[packages/notifications/utils/common.ts:30](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
996
|
+
[packages/notifications/utils/common.ts:30](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L30)
|
|
997
997
|
|
|
998
998
|
___
|
|
999
999
|
|
|
@@ -1001,8 +1001,6 @@ ___
|
|
|
1001
1001
|
|
|
1002
1002
|
▸ **setBasicAuthToObject**(`object`, `configuration?`): `void`
|
|
1003
1003
|
|
|
1004
|
-
**`Export`**
|
|
1005
|
-
|
|
1006
1004
|
#### Parameters
|
|
1007
1005
|
|
|
1008
1006
|
| Name | Type |
|
|
@@ -1014,17 +1012,17 @@ ___
|
|
|
1014
1012
|
|
|
1015
1013
|
`void`
|
|
1016
1014
|
|
|
1015
|
+
**`Export`**
|
|
1016
|
+
|
|
1017
1017
|
#### Defined in
|
|
1018
1018
|
|
|
1019
|
-
[packages/notifications/utils/common.ts:43](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
1019
|
+
[packages/notifications/utils/common.ts:43](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L43)
|
|
1020
1020
|
|
|
1021
1021
|
___
|
|
1022
1022
|
|
|
1023
1023
|
### setBearerAuthToObject
|
|
1024
1024
|
|
|
1025
|
-
▸ **setBearerAuthToObject**(`object`, `configuration?`): `Promise
|
|
1026
|
-
|
|
1027
|
-
**`Export`**
|
|
1025
|
+
▸ **setBearerAuthToObject**(`object`, `configuration?`): `Promise`\<`void`\>
|
|
1028
1026
|
|
|
1029
1027
|
#### Parameters
|
|
1030
1028
|
|
|
@@ -1035,19 +1033,19 @@ ___
|
|
|
1035
1033
|
|
|
1036
1034
|
#### Returns
|
|
1037
1035
|
|
|
1038
|
-
`Promise
|
|
1036
|
+
`Promise`\<`void`\>
|
|
1037
|
+
|
|
1038
|
+
**`Export`**
|
|
1039
1039
|
|
|
1040
1040
|
#### Defined in
|
|
1041
1041
|
|
|
1042
|
-
[packages/notifications/utils/common.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
1042
|
+
[packages/notifications/utils/common.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L53)
|
|
1043
1043
|
|
|
1044
1044
|
___
|
|
1045
1045
|
|
|
1046
1046
|
### setOAuthToObject
|
|
1047
1047
|
|
|
1048
|
-
▸ **setOAuthToObject**(`object`, `name`, `scopes`, `configuration?`): `Promise
|
|
1049
|
-
|
|
1050
|
-
**`Export`**
|
|
1048
|
+
▸ **setOAuthToObject**(`object`, `name`, `scopes`, `configuration?`): `Promise`\<`void`\>
|
|
1051
1049
|
|
|
1052
1050
|
#### Parameters
|
|
1053
1051
|
|
|
@@ -1060,19 +1058,19 @@ ___
|
|
|
1060
1058
|
|
|
1061
1059
|
#### Returns
|
|
1062
1060
|
|
|
1063
|
-
`Promise
|
|
1061
|
+
`Promise`\<`void`\>
|
|
1062
|
+
|
|
1063
|
+
**`Export`**
|
|
1064
1064
|
|
|
1065
1065
|
#### Defined in
|
|
1066
1066
|
|
|
1067
|
-
[packages/notifications/utils/common.ts:66](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
1067
|
+
[packages/notifications/utils/common.ts:66](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L66)
|
|
1068
1068
|
|
|
1069
1069
|
___
|
|
1070
1070
|
|
|
1071
1071
|
### setSearchParams
|
|
1072
1072
|
|
|
1073
|
-
▸ **setSearchParams**(`url`,
|
|
1074
|
-
|
|
1075
|
-
**`Export`**
|
|
1073
|
+
▸ **setSearchParams**(`url`, `...objects`): `void`
|
|
1076
1074
|
|
|
1077
1075
|
#### Parameters
|
|
1078
1076
|
|
|
@@ -1085,9 +1083,11 @@ ___
|
|
|
1085
1083
|
|
|
1086
1084
|
`void`
|
|
1087
1085
|
|
|
1086
|
+
**`Export`**
|
|
1087
|
+
|
|
1088
1088
|
#### Defined in
|
|
1089
1089
|
|
|
1090
|
-
[packages/notifications/utils/common.ts:101](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
1090
|
+
[packages/notifications/utils/common.ts:101](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L101)
|
|
1091
1091
|
|
|
1092
1092
|
___
|
|
1093
1093
|
|
|
@@ -1095,8 +1095,6 @@ ___
|
|
|
1095
1095
|
|
|
1096
1096
|
▸ **toPathString**(`url`): `string`
|
|
1097
1097
|
|
|
1098
|
-
**`Export`**
|
|
1099
|
-
|
|
1100
1098
|
#### Parameters
|
|
1101
1099
|
|
|
1102
1100
|
| Name | Type |
|
|
@@ -1107,6 +1105,8 @@ ___
|
|
|
1107
1105
|
|
|
1108
1106
|
`string`
|
|
1109
1107
|
|
|
1108
|
+
**`Export`**
|
|
1109
|
+
|
|
1110
1110
|
#### Defined in
|
|
1111
1111
|
|
|
1112
|
-
[packages/notifications/utils/common.ts:125](https://github.com/RedHatInsights/javascript-clients/blob/
|
|
1112
|
+
[packages/notifications/utils/common.ts:125](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/common.ts#L125)
|