@redhat-cloud-services/notifications-client 2.4.0 → 2.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -0
- package/README.md +1 -1
- package/dist/configuration.d.ts +0 -11
- package/dist/configuration.d.ts.map +1 -1
- package/dist/configuration.js +0 -11
- package/dist/configuration.js.map +1 -1
- package/dist/index.d.ts +0 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +0 -1
- package/dist/index.js.map +1 -1
- package/doc/README.md +28 -56
- package/doc/classes/{BaseAPI.md → index.BaseAPI.md} +9 -7
- package/doc/classes/{RequiredError.md → index.RequiredError.md} +13 -11
- package/doc/enums/{EndpointStatus.md → types.EndpointStatus.md} +9 -7
- package/doc/enums/{EndpointType.md → types.EndpointType.md} +8 -6
- package/doc/enums/{Environment.md → types.Environment.md} +7 -5
- package/doc/enums/{EventLogEntryActionStatus.md → types.EventLogEntryActionStatus.md} +8 -6
- package/doc/enums/{HttpType.md → types.HttpType.md} +6 -4
- package/doc/enums/{NotificationStatus.md → types.NotificationStatus.md} +8 -6
- package/doc/enums/{Status.md → types.Status.md} +5 -3
- package/doc/enums/{SubscriptionType.md → types.SubscriptionType.md} +6 -4
- package/doc/interfaces/{RequestArgs.md → index.RequestArgs.md} +5 -3
- package/doc/interfaces/{AddAccessRequest.md → types.AddAccessRequest.md} +5 -3
- package/doc/interfaces/{AddApplicationRequest.md → types.AddApplicationRequest.md} +7 -5
- package/doc/interfaces/{AggregationEmailTemplate.md → types.AggregationEmailTemplate.md} +17 -15
- package/doc/interfaces/{AggregationEmailTemplateSubjectTemplate.md → types.AggregationEmailTemplateSubjectTemplate.md} +9 -7
- package/doc/interfaces/{Application.md → types.Application.md} +9 -7
- package/doc/interfaces/{Application1.md → types.Application1.md} +5 -3
- package/doc/interfaces/{ApplicationDTO.md → types.ApplicationDTO.md} +9 -7
- package/doc/interfaces/{ApplicationSettingsValue.md → types.ApplicationSettingsValue.md} +5 -3
- package/doc/interfaces/{BasicAuthentication.md → types.BasicAuthentication.md} +5 -3
- package/doc/interfaces/{BehaviorGroup.md → types.BehaviorGroup.md} +15 -13
- package/doc/interfaces/{BehaviorGroupAction.md → types.BehaviorGroupAction.md} +8 -6
- package/doc/interfaces/{BehaviorGroupActionId.md → types.BehaviorGroupActionId.md} +5 -3
- package/doc/interfaces/{Bundle.md → types.Bundle.md} +8 -6
- package/doc/interfaces/{BundleSettingsValue.md → types.BundleSettingsValue.md} +5 -3
- package/doc/interfaces/{CamelProperties.md → types.CamelProperties.md} +11 -9
- package/doc/interfaces/{CreateBehaviorGroupRequest.md → types.CreateBehaviorGroupRequest.md} +9 -7
- package/doc/interfaces/{CreateBehaviorGroupResponse.md → types.CreateBehaviorGroupResponse.md} +9 -7
- package/doc/interfaces/{CurrentStatus.md → types.CurrentStatus.md} +7 -5
- package/doc/interfaces/{DrawerEntryPayload.md → types.DrawerEntryPayload.md} +10 -8
- package/doc/interfaces/{DuplicateNameMigrationReport.md → types.DuplicateNameMigrationReport.md} +5 -3
- package/doc/interfaces/{Endpoint.md → types.Endpoint.md} +16 -14
- package/doc/interfaces/{EndpointPage.md → types.EndpointPage.md} +8 -6
- package/doc/interfaces/{EndpointTestRequest.md → types.EndpointTestRequest.md} +4 -2
- package/doc/interfaces/{EventLogEntry.md → types.EventLogEntry.md} +11 -9
- package/doc/interfaces/{EventLogEntryAction.md → types.EventLogEntryAction.md} +12 -10
- package/doc/interfaces/{EventType.md → types.EventType.md} +15 -13
- package/doc/interfaces/{EventTypeBehavior.md → types.EventTypeBehavior.md} +8 -6
- package/doc/interfaces/{EventTypeBehaviorId.md → types.EventTypeBehaviorId.md} +5 -3
- package/doc/interfaces/{EventTypeSettingsValue.md → types.EventTypeSettingsValue.md} +6 -4
- package/doc/interfaces/{Facet.md → types.Facet.md} +8 -6
- package/doc/interfaces/{InstantEmailTemplate.md → types.InstantEmailTemplate.md} +15 -13
- package/doc/interfaces/{InternalApplicationUserPermission.md → types.InternalApplicationUserPermission.md} +6 -4
- package/doc/interfaces/{InternalRoleAccess.md → types.InternalRoleAccess.md} +6 -4
- package/doc/interfaces/{InternalUserPermissions.md → types.InternalUserPermissions.md} +7 -5
- package/doc/interfaces/{MessageValidationResponse.md → types.MessageValidationResponse.md} +4 -2
- package/doc/interfaces/{Meta.md → types.Meta.md} +4 -2
- package/doc/interfaces/{NotificationHistory.md → types.NotificationHistory.md} +14 -12
- package/doc/interfaces/{PageBehaviorGroup.md → types.PageBehaviorGroup.md} +8 -6
- package/doc/interfaces/{PageDrawerEntryPayload.md → types.PageDrawerEntryPayload.md} +8 -6
- package/doc/interfaces/{PageEventLogEntry.md → types.PageEventLogEntry.md} +8 -6
- package/doc/interfaces/{PageEventType.md → types.PageEventType.md} +8 -6
- package/doc/interfaces/{PageNotificationHistory.md → types.PageNotificationHistory.md} +8 -6
- package/doc/interfaces/{RenderEmailTemplateRequest.md → types.RenderEmailTemplateRequest.md} +5 -3
- package/doc/interfaces/{RequestDefaultBehaviorGroupPropertyList.md → types.RequestDefaultBehaviorGroupPropertyList.md} +5 -3
- package/doc/interfaces/{RequestSystemSubscriptionProperties.md → types.RequestSystemSubscriptionProperties.md} +5 -3
- package/doc/interfaces/{ServerInfo.md → types.ServerInfo.md} +5 -3
- package/doc/interfaces/{SettingsValuesByEventType.md → types.SettingsValuesByEventType.md} +5 -3
- package/doc/interfaces/{SystemSubscriptionProperties.md → types.SystemSubscriptionProperties.md} +6 -4
- package/doc/interfaces/{Template.md → types.Template.md} +9 -7
- package/doc/interfaces/{TriggerDailyDigestRequest.md → types.TriggerDailyDigestRequest.md} +8 -6
- package/doc/interfaces/{UpdateApplicationRequest.md → types.UpdateApplicationRequest.md} +6 -4
- package/doc/interfaces/{UpdateBehaviorGroupRequest.md → types.UpdateBehaviorGroupRequest.md} +7 -5
- package/doc/interfaces/{UpdateNotificationDrawerStatus.md → types.UpdateNotificationDrawerStatus.md} +5 -3
- package/doc/interfaces/{WebhookProperties.md → types.WebhookProperties.md} +11 -9
- package/doc/interfaces/{X509Certificate.md → types.X509Certificate.md} +8 -6
- package/doc/modules/DrawerResourceV1GetDrawerEntries.md +78 -0
- package/doc/modules/DrawerResourceV1UpdateNotificationReadStatus.md +68 -0
- package/doc/modules/EventResourceV1GetEvents.md +83 -0
- package/doc/modules/NotificationResourceV1AppendBehaviorGroupToEventType.md +67 -0
- package/doc/modules/NotificationResourceV1CreateBehaviorGroup.md +68 -0
- package/doc/modules/NotificationResourceV1DeleteBehaviorGroup.md +68 -0
- package/doc/modules/NotificationResourceV1DeleteBehaviorGroupFromEventType.md +69 -0
- package/doc/modules/NotificationResourceV1FindBehaviorGroupsByBundleId.md +68 -0
- package/doc/modules/NotificationResourceV1GetApplicationByNameAndBundleName.md +69 -0
- package/doc/modules/NotificationResourceV1GetApplicationsFacets.md +68 -0
- package/doc/modules/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint.md +68 -0
- package/doc/modules/NotificationResourceV1GetBundleByName.md +68 -0
- package/doc/modules/NotificationResourceV1GetBundleFacets.md +68 -0
- package/doc/modules/NotificationResourceV1GetEventTypes.md +75 -0
- package/doc/modules/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup.md +68 -0
- package/doc/modules/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName.md +70 -0
- package/doc/modules/NotificationResourceV1GetLinkedBehaviorGroups.md +73 -0
- package/doc/modules/NotificationResourceV1UpdateBehaviorGroup.md +69 -0
- package/doc/modules/NotificationResourceV1UpdateBehaviorGroupActions.md +69 -0
- package/doc/modules/NotificationResourceV1UpdateEventTypeBehaviors.md +69 -0
- package/doc/modules/OrgConfigResourceV1GetDailyDigestTimePreference.md +67 -0
- package/doc/modules/OrgConfigResourceV1SaveDailyDigestTimePreference.md +68 -0
- package/doc/modules/index.md +648 -0
- package/doc/modules/types.md +74 -0
- package/doc/modules.md +28 -751
- package/package.json +1 -1
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1GetBundleFacets
|
|
2
|
+
|
|
3
|
+
# Module: NotificationResourceV1GetBundleFacets
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### References
|
|
8
|
+
|
|
9
|
+
- [default](NotificationResourceV1GetBundleFacets.md#default)
|
|
10
|
+
|
|
11
|
+
### Type Aliases
|
|
12
|
+
|
|
13
|
+
- [NotificationResourceV1GetBundleFacetsParams](NotificationResourceV1GetBundleFacets.md#notificationresourcev1getbundlefacetsparams)
|
|
14
|
+
|
|
15
|
+
### Functions
|
|
16
|
+
|
|
17
|
+
- [notificationResourceV1GetBundleFacetsParamCreator](NotificationResourceV1GetBundleFacets.md#notificationresourcev1getbundlefacetsparamcreator)
|
|
18
|
+
|
|
19
|
+
## References
|
|
20
|
+
|
|
21
|
+
### default
|
|
22
|
+
|
|
23
|
+
Renames and re-exports [notificationResourceV1GetBundleFacetsParamCreator](NotificationResourceV1GetBundleFacets.md#notificationresourcev1getbundlefacetsparamcreator)
|
|
24
|
+
|
|
25
|
+
## Type Aliases
|
|
26
|
+
|
|
27
|
+
### NotificationResourceV1GetBundleFacetsParams
|
|
28
|
+
|
|
29
|
+
Ƭ **NotificationResourceV1GetBundleFacetsParams**: `Object`
|
|
30
|
+
|
|
31
|
+
#### Type declaration
|
|
32
|
+
|
|
33
|
+
| Name | Type | Description |
|
|
34
|
+
| :------ | :------ | :------ |
|
|
35
|
+
| `includeApplications?` | `boolean` | **`Memberof`** NotificationResourceV1GetBundleFacetsApi |
|
|
36
|
+
| `options?` | `AxiosRequestConfig` | - |
|
|
37
|
+
|
|
38
|
+
#### Defined in
|
|
39
|
+
|
|
40
|
+
[packages/notifications/NotificationResourceV1GetBundleFacets/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBundleFacets/index.ts#L14)
|
|
41
|
+
|
|
42
|
+
## Functions
|
|
43
|
+
|
|
44
|
+
### notificationResourceV1GetBundleFacetsParamCreator
|
|
45
|
+
|
|
46
|
+
▸ **notificationResourceV1GetBundleFacetsParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
|
|
47
|
+
|
|
48
|
+
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.
|
|
49
|
+
|
|
50
|
+
#### Parameters
|
|
51
|
+
|
|
52
|
+
| Name | Type | Description |
|
|
53
|
+
| :------ | :------ | :------ |
|
|
54
|
+
| `...config` | [[`NotificationResourceV1GetBundleFacetsParams`](NotificationResourceV1GetBundleFacets.md#notificationresourcev1getbundlefacetsparams)] \| [`boolean`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
55
|
+
|
|
56
|
+
#### Returns
|
|
57
|
+
|
|
58
|
+
`Promise`\<`RequestArgs`\>
|
|
59
|
+
|
|
60
|
+
**`Summary`**
|
|
61
|
+
|
|
62
|
+
List configured bundle
|
|
63
|
+
|
|
64
|
+
**`Throws`**
|
|
65
|
+
|
|
66
|
+
#### Defined in
|
|
67
|
+
|
|
68
|
+
[packages/notifications/NotificationResourceV1GetBundleFacets/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBundleFacets/index.ts#L34)
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1GetEventTypes
|
|
2
|
+
|
|
3
|
+
# Module: NotificationResourceV1GetEventTypes
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### References
|
|
8
|
+
|
|
9
|
+
- [default](NotificationResourceV1GetEventTypes.md#default)
|
|
10
|
+
|
|
11
|
+
### Type Aliases
|
|
12
|
+
|
|
13
|
+
- [NotificationResourceV1GetEventTypesParams](NotificationResourceV1GetEventTypes.md#notificationresourcev1geteventtypesparams)
|
|
14
|
+
|
|
15
|
+
### Functions
|
|
16
|
+
|
|
17
|
+
- [notificationResourceV1GetEventTypesParamCreator](NotificationResourceV1GetEventTypes.md#notificationresourcev1geteventtypesparamcreator)
|
|
18
|
+
|
|
19
|
+
## References
|
|
20
|
+
|
|
21
|
+
### default
|
|
22
|
+
|
|
23
|
+
Renames and re-exports [notificationResourceV1GetEventTypesParamCreator](NotificationResourceV1GetEventTypes.md#notificationresourcev1geteventtypesparamcreator)
|
|
24
|
+
|
|
25
|
+
## Type Aliases
|
|
26
|
+
|
|
27
|
+
### NotificationResourceV1GetEventTypesParams
|
|
28
|
+
|
|
29
|
+
Ƭ **NotificationResourceV1GetEventTypesParams**: `Object`
|
|
30
|
+
|
|
31
|
+
#### Type declaration
|
|
32
|
+
|
|
33
|
+
| Name | Type | Description |
|
|
34
|
+
| :------ | :------ | :------ |
|
|
35
|
+
| `applicationIds?` | `Set`\<`string`\> | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
36
|
+
| `bundleId?` | `string` | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
37
|
+
| `eventTypeName?` | `string` | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
38
|
+
| `limit?` | `number` | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
39
|
+
| `offset?` | `number` | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
40
|
+
| `options?` | `AxiosRequestConfig` | - |
|
|
41
|
+
| `pageNumber?` | `number` | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
42
|
+
| `sortBy?` | `string` | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
43
|
+
| `sortBy2?` | `string` | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
44
|
+
|
|
45
|
+
#### Defined in
|
|
46
|
+
|
|
47
|
+
[packages/notifications/NotificationResourceV1GetEventTypes/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypes/index.ts#L14)
|
|
48
|
+
|
|
49
|
+
## Functions
|
|
50
|
+
|
|
51
|
+
### notificationResourceV1GetEventTypesParamCreator
|
|
52
|
+
|
|
53
|
+
▸ **notificationResourceV1GetEventTypesParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
|
|
54
|
+
|
|
55
|
+
Lists all event types. You can filter the returned list by bundle or application name.
|
|
56
|
+
|
|
57
|
+
#### Parameters
|
|
58
|
+
|
|
59
|
+
| Name | Type | Description |
|
|
60
|
+
| :------ | :------ | :------ |
|
|
61
|
+
| `...config` | [[`NotificationResourceV1GetEventTypesParams`](NotificationResourceV1GetEventTypes.md#notificationresourcev1geteventtypesparams)] \| [`Set`\<`string`\>, `string`, `string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
62
|
+
|
|
63
|
+
#### Returns
|
|
64
|
+
|
|
65
|
+
`Promise`\<`RequestArgs`\>
|
|
66
|
+
|
|
67
|
+
**`Summary`**
|
|
68
|
+
|
|
69
|
+
List all event type
|
|
70
|
+
|
|
71
|
+
**`Throws`**
|
|
72
|
+
|
|
73
|
+
#### Defined in
|
|
74
|
+
|
|
75
|
+
[packages/notifications/NotificationResourceV1GetEventTypes/index.ts:76](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypes/index.ts#L76)
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup
|
|
2
|
+
|
|
3
|
+
# Module: NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### References
|
|
8
|
+
|
|
9
|
+
- [default](NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup.md#default)
|
|
10
|
+
|
|
11
|
+
### Type Aliases
|
|
12
|
+
|
|
13
|
+
- [NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupParams](NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup.md#notificationresourcev1geteventtypesaffectedbyremovalofbehaviorgroupparams)
|
|
14
|
+
|
|
15
|
+
### Functions
|
|
16
|
+
|
|
17
|
+
- [notificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupParamCreator](NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup.md#notificationresourcev1geteventtypesaffectedbyremovalofbehaviorgroupparamcreator)
|
|
18
|
+
|
|
19
|
+
## References
|
|
20
|
+
|
|
21
|
+
### default
|
|
22
|
+
|
|
23
|
+
Renames and re-exports [notificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupParamCreator](NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup.md#notificationresourcev1geteventtypesaffectedbyremovalofbehaviorgroupparamcreator)
|
|
24
|
+
|
|
25
|
+
## Type Aliases
|
|
26
|
+
|
|
27
|
+
### NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupParams
|
|
28
|
+
|
|
29
|
+
Ƭ **NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupParams**: `Object`
|
|
30
|
+
|
|
31
|
+
#### Type declaration
|
|
32
|
+
|
|
33
|
+
| Name | Type | Description |
|
|
34
|
+
| :------ | :------ | :------ |
|
|
35
|
+
| `behaviorGroupId` | `string` | The UUID of the behavior group to check **`Memberof`** NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupApi |
|
|
36
|
+
| `options?` | `AxiosRequestConfig` | - |
|
|
37
|
+
|
|
38
|
+
#### Defined in
|
|
39
|
+
|
|
40
|
+
[packages/notifications/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts#L14)
|
|
41
|
+
|
|
42
|
+
## Functions
|
|
43
|
+
|
|
44
|
+
### notificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupParamCreator
|
|
45
|
+
|
|
46
|
+
▸ **notificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
|
|
47
|
+
|
|
48
|
+
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.
|
|
49
|
+
|
|
50
|
+
#### Parameters
|
|
51
|
+
|
|
52
|
+
| Name | Type | Description |
|
|
53
|
+
| :------ | :------ | :------ |
|
|
54
|
+
| `...config` | [`string`, `AxiosRequestConfig`\<`any`\>] \| [[`NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupParams`](NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup.md#notificationresourcev1geteventtypesaffectedbyremovalofbehaviorgroupparams)] | with all available params. |
|
|
55
|
+
|
|
56
|
+
#### Returns
|
|
57
|
+
|
|
58
|
+
`Promise`\<`RequestArgs`\>
|
|
59
|
+
|
|
60
|
+
**`Summary`**
|
|
61
|
+
|
|
62
|
+
List the event types affected by the removal of a behavior group
|
|
63
|
+
|
|
64
|
+
**`Throws`**
|
|
65
|
+
|
|
66
|
+
#### Defined in
|
|
67
|
+
|
|
68
|
+
[packages/notifications/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts#L34)
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName
|
|
2
|
+
|
|
3
|
+
# Module: NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### References
|
|
8
|
+
|
|
9
|
+
- [default](NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName.md#default)
|
|
10
|
+
|
|
11
|
+
### Type Aliases
|
|
12
|
+
|
|
13
|
+
- [NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParams](NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName.md#notificationresourcev1geteventtypesbynameandbundleandapplicationnameparams)
|
|
14
|
+
|
|
15
|
+
### Functions
|
|
16
|
+
|
|
17
|
+
- [notificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParamCreator](NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName.md#notificationresourcev1geteventtypesbynameandbundleandapplicationnameparamcreator)
|
|
18
|
+
|
|
19
|
+
## References
|
|
20
|
+
|
|
21
|
+
### default
|
|
22
|
+
|
|
23
|
+
Renames and re-exports [notificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParamCreator](NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName.md#notificationresourcev1geteventtypesbynameandbundleandapplicationnameparamcreator)
|
|
24
|
+
|
|
25
|
+
## Type Aliases
|
|
26
|
+
|
|
27
|
+
### NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParams
|
|
28
|
+
|
|
29
|
+
Ƭ **NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParams**: `Object`
|
|
30
|
+
|
|
31
|
+
#### Type declaration
|
|
32
|
+
|
|
33
|
+
| Name | Type | Description |
|
|
34
|
+
| :------ | :------ | :------ |
|
|
35
|
+
| `applicationName` | `string` | **`Memberof`** NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameApi |
|
|
36
|
+
| `bundleName` | `string` | **`Memberof`** NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameApi |
|
|
37
|
+
| `eventTypeName` | `string` | **`Memberof`** NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameApi |
|
|
38
|
+
| `options?` | `AxiosRequestConfig` | - |
|
|
39
|
+
|
|
40
|
+
#### Defined in
|
|
41
|
+
|
|
42
|
+
[packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts#L14)
|
|
43
|
+
|
|
44
|
+
## Functions
|
|
45
|
+
|
|
46
|
+
### notificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParamCreator
|
|
47
|
+
|
|
48
|
+
▸ **notificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
|
|
49
|
+
|
|
50
|
+
Retrieves the details of an event type by specifying the bundle name, the application name, and the event type name.
|
|
51
|
+
|
|
52
|
+
#### Parameters
|
|
53
|
+
|
|
54
|
+
| Name | Type | Description |
|
|
55
|
+
| :------ | :------ | :------ |
|
|
56
|
+
| `...config` | [[`NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParams`](NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName.md#notificationresourcev1geteventtypesbynameandbundleandapplicationnameparams)] \| [`string`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
57
|
+
|
|
58
|
+
#### Returns
|
|
59
|
+
|
|
60
|
+
`Promise`\<`RequestArgs`\>
|
|
61
|
+
|
|
62
|
+
**`Summary`**
|
|
63
|
+
|
|
64
|
+
Retrieve an event type by bundle, application and event type name
|
|
65
|
+
|
|
66
|
+
**`Throws`**
|
|
67
|
+
|
|
68
|
+
#### Defined in
|
|
69
|
+
|
|
70
|
+
[packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts#L46)
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1GetLinkedBehaviorGroups
|
|
2
|
+
|
|
3
|
+
# Module: NotificationResourceV1GetLinkedBehaviorGroups
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### References
|
|
8
|
+
|
|
9
|
+
- [default](NotificationResourceV1GetLinkedBehaviorGroups.md#default)
|
|
10
|
+
|
|
11
|
+
### Type Aliases
|
|
12
|
+
|
|
13
|
+
- [NotificationResourceV1GetLinkedBehaviorGroupsParams](NotificationResourceV1GetLinkedBehaviorGroups.md#notificationresourcev1getlinkedbehaviorgroupsparams)
|
|
14
|
+
|
|
15
|
+
### Functions
|
|
16
|
+
|
|
17
|
+
- [notificationResourceV1GetLinkedBehaviorGroupsParamCreator](NotificationResourceV1GetLinkedBehaviorGroups.md#notificationresourcev1getlinkedbehaviorgroupsparamcreator)
|
|
18
|
+
|
|
19
|
+
## References
|
|
20
|
+
|
|
21
|
+
### default
|
|
22
|
+
|
|
23
|
+
Renames and re-exports [notificationResourceV1GetLinkedBehaviorGroupsParamCreator](NotificationResourceV1GetLinkedBehaviorGroups.md#notificationresourcev1getlinkedbehaviorgroupsparamcreator)
|
|
24
|
+
|
|
25
|
+
## Type Aliases
|
|
26
|
+
|
|
27
|
+
### NotificationResourceV1GetLinkedBehaviorGroupsParams
|
|
28
|
+
|
|
29
|
+
Ƭ **NotificationResourceV1GetLinkedBehaviorGroupsParams**: `Object`
|
|
30
|
+
|
|
31
|
+
#### Type declaration
|
|
32
|
+
|
|
33
|
+
| Name | Type | Description |
|
|
34
|
+
| :------ | :------ | :------ |
|
|
35
|
+
| `eventTypeId` | `string` | **`Memberof`** NotificationResourceV1GetLinkedBehaviorGroupsApi |
|
|
36
|
+
| `limit?` | `number` | **`Memberof`** NotificationResourceV1GetLinkedBehaviorGroupsApi |
|
|
37
|
+
| `offset?` | `number` | **`Memberof`** NotificationResourceV1GetLinkedBehaviorGroupsApi |
|
|
38
|
+
| `options?` | `AxiosRequestConfig` | - |
|
|
39
|
+
| `pageNumber?` | `number` | **`Memberof`** NotificationResourceV1GetLinkedBehaviorGroupsApi |
|
|
40
|
+
| `sortBy?` | `string` | **`Memberof`** NotificationResourceV1GetLinkedBehaviorGroupsApi |
|
|
41
|
+
| `sortBy2?` | `string` | **`Memberof`** NotificationResourceV1GetLinkedBehaviorGroupsApi |
|
|
42
|
+
|
|
43
|
+
#### Defined in
|
|
44
|
+
|
|
45
|
+
[packages/notifications/NotificationResourceV1GetLinkedBehaviorGroups/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetLinkedBehaviorGroups/index.ts#L14)
|
|
46
|
+
|
|
47
|
+
## Functions
|
|
48
|
+
|
|
49
|
+
### notificationResourceV1GetLinkedBehaviorGroupsParamCreator
|
|
50
|
+
|
|
51
|
+
▸ **notificationResourceV1GetLinkedBehaviorGroupsParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
|
|
52
|
+
|
|
53
|
+
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.
|
|
54
|
+
|
|
55
|
+
#### Parameters
|
|
56
|
+
|
|
57
|
+
| Name | Type | Description |
|
|
58
|
+
| :------ | :------ | :------ |
|
|
59
|
+
| `...config` | [[`NotificationResourceV1GetLinkedBehaviorGroupsParams`](NotificationResourceV1GetLinkedBehaviorGroups.md#notificationresourcev1getlinkedbehaviorgroupsparams)] \| [`string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
60
|
+
|
|
61
|
+
#### Returns
|
|
62
|
+
|
|
63
|
+
`Promise`\<`RequestArgs`\>
|
|
64
|
+
|
|
65
|
+
**`Summary`**
|
|
66
|
+
|
|
67
|
+
List the behavior groups linked to an event type
|
|
68
|
+
|
|
69
|
+
**`Throws`**
|
|
70
|
+
|
|
71
|
+
#### Defined in
|
|
72
|
+
|
|
73
|
+
[packages/notifications/NotificationResourceV1GetLinkedBehaviorGroups/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetLinkedBehaviorGroups/index.ts#L64)
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1UpdateBehaviorGroup
|
|
2
|
+
|
|
3
|
+
# Module: NotificationResourceV1UpdateBehaviorGroup
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### References
|
|
8
|
+
|
|
9
|
+
- [default](NotificationResourceV1UpdateBehaviorGroup.md#default)
|
|
10
|
+
|
|
11
|
+
### Type Aliases
|
|
12
|
+
|
|
13
|
+
- [NotificationResourceV1UpdateBehaviorGroupParams](NotificationResourceV1UpdateBehaviorGroup.md#notificationresourcev1updatebehaviorgroupparams)
|
|
14
|
+
|
|
15
|
+
### Functions
|
|
16
|
+
|
|
17
|
+
- [notificationResourceV1UpdateBehaviorGroupParamCreator](NotificationResourceV1UpdateBehaviorGroup.md#notificationresourcev1updatebehaviorgroupparamcreator)
|
|
18
|
+
|
|
19
|
+
## References
|
|
20
|
+
|
|
21
|
+
### default
|
|
22
|
+
|
|
23
|
+
Renames and re-exports [notificationResourceV1UpdateBehaviorGroupParamCreator](NotificationResourceV1UpdateBehaviorGroup.md#notificationresourcev1updatebehaviorgroupparamcreator)
|
|
24
|
+
|
|
25
|
+
## Type Aliases
|
|
26
|
+
|
|
27
|
+
### NotificationResourceV1UpdateBehaviorGroupParams
|
|
28
|
+
|
|
29
|
+
Ƭ **NotificationResourceV1UpdateBehaviorGroupParams**: `Object`
|
|
30
|
+
|
|
31
|
+
#### Type declaration
|
|
32
|
+
|
|
33
|
+
| Name | Type | Description |
|
|
34
|
+
| :------ | :------ | :------ |
|
|
35
|
+
| `id` | `string` | The UUID of the behavior group to update **`Memberof`** NotificationResourceV1UpdateBehaviorGroupApi |
|
|
36
|
+
| `options?` | `AxiosRequestConfig` | - |
|
|
37
|
+
| `updateBehaviorGroupRequest` | [`UpdateBehaviorGroupRequest`](../interfaces/types.UpdateBehaviorGroupRequest.md) | New parameter **`Memberof`** NotificationResourceV1UpdateBehaviorGroupApi |
|
|
38
|
+
|
|
39
|
+
#### Defined in
|
|
40
|
+
|
|
41
|
+
[packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts#L14)
|
|
42
|
+
|
|
43
|
+
## Functions
|
|
44
|
+
|
|
45
|
+
### notificationResourceV1UpdateBehaviorGroupParamCreator
|
|
46
|
+
|
|
47
|
+
▸ **notificationResourceV1UpdateBehaviorGroupParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
|
|
48
|
+
|
|
49
|
+
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.
|
|
50
|
+
|
|
51
|
+
#### Parameters
|
|
52
|
+
|
|
53
|
+
| Name | Type | Description |
|
|
54
|
+
| :------ | :------ | :------ |
|
|
55
|
+
| `...config` | [[`NotificationResourceV1UpdateBehaviorGroupParams`](NotificationResourceV1UpdateBehaviorGroup.md#notificationresourcev1updatebehaviorgroupparams)] \| [`string`, [`UpdateBehaviorGroupRequest`](../interfaces/types.UpdateBehaviorGroupRequest.md), `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
56
|
+
|
|
57
|
+
#### Returns
|
|
58
|
+
|
|
59
|
+
`Promise`\<`RequestArgs`\>
|
|
60
|
+
|
|
61
|
+
**`Summary`**
|
|
62
|
+
|
|
63
|
+
Update a behavior group
|
|
64
|
+
|
|
65
|
+
**`Throws`**
|
|
66
|
+
|
|
67
|
+
#### Defined in
|
|
68
|
+
|
|
69
|
+
[packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts#L40)
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1UpdateBehaviorGroupActions
|
|
2
|
+
|
|
3
|
+
# Module: NotificationResourceV1UpdateBehaviorGroupActions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### References
|
|
8
|
+
|
|
9
|
+
- [default](NotificationResourceV1UpdateBehaviorGroupActions.md#default)
|
|
10
|
+
|
|
11
|
+
### Type Aliases
|
|
12
|
+
|
|
13
|
+
- [NotificationResourceV1UpdateBehaviorGroupActionsParams](NotificationResourceV1UpdateBehaviorGroupActions.md#notificationresourcev1updatebehaviorgroupactionsparams)
|
|
14
|
+
|
|
15
|
+
### Functions
|
|
16
|
+
|
|
17
|
+
- [notificationResourceV1UpdateBehaviorGroupActionsParamCreator](NotificationResourceV1UpdateBehaviorGroupActions.md#notificationresourcev1updatebehaviorgroupactionsparamcreator)
|
|
18
|
+
|
|
19
|
+
## References
|
|
20
|
+
|
|
21
|
+
### default
|
|
22
|
+
|
|
23
|
+
Renames and re-exports [notificationResourceV1UpdateBehaviorGroupActionsParamCreator](NotificationResourceV1UpdateBehaviorGroupActions.md#notificationresourcev1updatebehaviorgroupactionsparamcreator)
|
|
24
|
+
|
|
25
|
+
## Type Aliases
|
|
26
|
+
|
|
27
|
+
### NotificationResourceV1UpdateBehaviorGroupActionsParams
|
|
28
|
+
|
|
29
|
+
Ƭ **NotificationResourceV1UpdateBehaviorGroupActionsParams**: `Object`
|
|
30
|
+
|
|
31
|
+
#### Type declaration
|
|
32
|
+
|
|
33
|
+
| Name | Type | Description |
|
|
34
|
+
| :------ | :------ | :------ |
|
|
35
|
+
| `behaviorGroupId` | `string` | The UUID of the behavior group to update **`Memberof`** NotificationResourceV1UpdateBehaviorGroupActionsApi |
|
|
36
|
+
| `options?` | `AxiosRequestConfig` | - |
|
|
37
|
+
| `requestBody?` | `string`[] | **`Memberof`** NotificationResourceV1UpdateBehaviorGroupActionsApi |
|
|
38
|
+
|
|
39
|
+
#### Defined in
|
|
40
|
+
|
|
41
|
+
[packages/notifications/NotificationResourceV1UpdateBehaviorGroupActions/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateBehaviorGroupActions/index.ts#L14)
|
|
42
|
+
|
|
43
|
+
## Functions
|
|
44
|
+
|
|
45
|
+
### notificationResourceV1UpdateBehaviorGroupActionsParamCreator
|
|
46
|
+
|
|
47
|
+
▸ **notificationResourceV1UpdateBehaviorGroupActionsParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
|
|
48
|
+
|
|
49
|
+
Updates the list of actions to be executed in that particular behavior group after an event is received.
|
|
50
|
+
|
|
51
|
+
#### Parameters
|
|
52
|
+
|
|
53
|
+
| Name | Type | Description |
|
|
54
|
+
| :------ | :------ | :------ |
|
|
55
|
+
| `...config` | [[`NotificationResourceV1UpdateBehaviorGroupActionsParams`](NotificationResourceV1UpdateBehaviorGroupActions.md#notificationresourcev1updatebehaviorgroupactionsparams)] \| [`string`, `string`[], `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
56
|
+
|
|
57
|
+
#### Returns
|
|
58
|
+
|
|
59
|
+
`Promise`\<`RequestArgs`\>
|
|
60
|
+
|
|
61
|
+
**`Summary`**
|
|
62
|
+
|
|
63
|
+
Update the list of behavior group action
|
|
64
|
+
|
|
65
|
+
**`Throws`**
|
|
66
|
+
|
|
67
|
+
#### Defined in
|
|
68
|
+
|
|
69
|
+
[packages/notifications/NotificationResourceV1UpdateBehaviorGroupActions/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateBehaviorGroupActions/index.ts#L40)
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / NotificationResourceV1UpdateEventTypeBehaviors
|
|
2
|
+
|
|
3
|
+
# Module: NotificationResourceV1UpdateEventTypeBehaviors
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### References
|
|
8
|
+
|
|
9
|
+
- [default](NotificationResourceV1UpdateEventTypeBehaviors.md#default)
|
|
10
|
+
|
|
11
|
+
### Type Aliases
|
|
12
|
+
|
|
13
|
+
- [NotificationResourceV1UpdateEventTypeBehaviorsParams](NotificationResourceV1UpdateEventTypeBehaviors.md#notificationresourcev1updateeventtypebehaviorsparams)
|
|
14
|
+
|
|
15
|
+
### Functions
|
|
16
|
+
|
|
17
|
+
- [notificationResourceV1UpdateEventTypeBehaviorsParamCreator](NotificationResourceV1UpdateEventTypeBehaviors.md#notificationresourcev1updateeventtypebehaviorsparamcreator)
|
|
18
|
+
|
|
19
|
+
## References
|
|
20
|
+
|
|
21
|
+
### default
|
|
22
|
+
|
|
23
|
+
Renames and re-exports [notificationResourceV1UpdateEventTypeBehaviorsParamCreator](NotificationResourceV1UpdateEventTypeBehaviors.md#notificationresourcev1updateeventtypebehaviorsparamcreator)
|
|
24
|
+
|
|
25
|
+
## Type Aliases
|
|
26
|
+
|
|
27
|
+
### NotificationResourceV1UpdateEventTypeBehaviorsParams
|
|
28
|
+
|
|
29
|
+
Ƭ **NotificationResourceV1UpdateEventTypeBehaviorsParams**: `Object`
|
|
30
|
+
|
|
31
|
+
#### Type declaration
|
|
32
|
+
|
|
33
|
+
| Name | Type | Description |
|
|
34
|
+
| :------ | :------ | :------ |
|
|
35
|
+
| `eventTypeId` | `string` | UUID of the eventType to associate with the behavior group(s) **`Memberof`** NotificationResourceV1UpdateEventTypeBehaviorsApi |
|
|
36
|
+
| `options?` | `AxiosRequestConfig` | - |
|
|
37
|
+
| `requestBody?` | `Set`\<`string`\> | **`Memberof`** NotificationResourceV1UpdateEventTypeBehaviorsApi |
|
|
38
|
+
|
|
39
|
+
#### Defined in
|
|
40
|
+
|
|
41
|
+
[packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts#L14)
|
|
42
|
+
|
|
43
|
+
## Functions
|
|
44
|
+
|
|
45
|
+
### notificationResourceV1UpdateEventTypeBehaviorsParamCreator
|
|
46
|
+
|
|
47
|
+
▸ **notificationResourceV1UpdateEventTypeBehaviorsParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
|
|
48
|
+
|
|
49
|
+
Updates the list of behavior groups associated with an event type.
|
|
50
|
+
|
|
51
|
+
#### Parameters
|
|
52
|
+
|
|
53
|
+
| Name | Type | Description |
|
|
54
|
+
| :------ | :------ | :------ |
|
|
55
|
+
| `...config` | [[`NotificationResourceV1UpdateEventTypeBehaviorsParams`](NotificationResourceV1UpdateEventTypeBehaviors.md#notificationresourcev1updateeventtypebehaviorsparams)] \| [`string`, `Set`\<`string`\>, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
56
|
+
|
|
57
|
+
#### Returns
|
|
58
|
+
|
|
59
|
+
`Promise`\<`RequestArgs`\>
|
|
60
|
+
|
|
61
|
+
**`Summary`**
|
|
62
|
+
|
|
63
|
+
Update the list of behavior groups for an event type
|
|
64
|
+
|
|
65
|
+
**`Throws`**
|
|
66
|
+
|
|
67
|
+
#### Defined in
|
|
68
|
+
|
|
69
|
+
[packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts#L40)
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / OrgConfigResourceV1GetDailyDigestTimePreference
|
|
2
|
+
|
|
3
|
+
# Module: OrgConfigResourceV1GetDailyDigestTimePreference
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### References
|
|
8
|
+
|
|
9
|
+
- [default](OrgConfigResourceV1GetDailyDigestTimePreference.md#default)
|
|
10
|
+
|
|
11
|
+
### Type Aliases
|
|
12
|
+
|
|
13
|
+
- [OrgConfigResourceV1GetDailyDigestTimePreferenceParams](OrgConfigResourceV1GetDailyDigestTimePreference.md#orgconfigresourcev1getdailydigesttimepreferenceparams)
|
|
14
|
+
|
|
15
|
+
### Functions
|
|
16
|
+
|
|
17
|
+
- [orgConfigResourceV1GetDailyDigestTimePreferenceParamCreator](OrgConfigResourceV1GetDailyDigestTimePreference.md#orgconfigresourcev1getdailydigesttimepreferenceparamcreator)
|
|
18
|
+
|
|
19
|
+
## References
|
|
20
|
+
|
|
21
|
+
### default
|
|
22
|
+
|
|
23
|
+
Renames and re-exports [orgConfigResourceV1GetDailyDigestTimePreferenceParamCreator](OrgConfigResourceV1GetDailyDigestTimePreference.md#orgconfigresourcev1getdailydigesttimepreferenceparamcreator)
|
|
24
|
+
|
|
25
|
+
## Type Aliases
|
|
26
|
+
|
|
27
|
+
### OrgConfigResourceV1GetDailyDigestTimePreferenceParams
|
|
28
|
+
|
|
29
|
+
Ƭ **OrgConfigResourceV1GetDailyDigestTimePreferenceParams**: `Object`
|
|
30
|
+
|
|
31
|
+
#### Type declaration
|
|
32
|
+
|
|
33
|
+
| Name | Type |
|
|
34
|
+
| :------ | :------ |
|
|
35
|
+
| `options?` | `AxiosRequestConfig` |
|
|
36
|
+
|
|
37
|
+
#### Defined in
|
|
38
|
+
|
|
39
|
+
[packages/notifications/OrgConfigResourceV1GetDailyDigestTimePreference/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/OrgConfigResourceV1GetDailyDigestTimePreference/index.ts#L14)
|
|
40
|
+
|
|
41
|
+
## Functions
|
|
42
|
+
|
|
43
|
+
### orgConfigResourceV1GetDailyDigestTimePreferenceParamCreator
|
|
44
|
+
|
|
45
|
+
▸ **orgConfigResourceV1GetDailyDigestTimePreferenceParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
|
|
46
|
+
|
|
47
|
+
Retrieves the daily digest time setting. Use this endpoint to check the time that daily emails are sent.
|
|
48
|
+
|
|
49
|
+
#### Parameters
|
|
50
|
+
|
|
51
|
+
| Name | Type | Description |
|
|
52
|
+
| :------ | :------ | :------ |
|
|
53
|
+
| `...config` | [[`OrgConfigResourceV1GetDailyDigestTimePreferenceParams`](OrgConfigResourceV1GetDailyDigestTimePreference.md#orgconfigresourcev1getdailydigesttimepreferenceparams)] \| [`AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
54
|
+
|
|
55
|
+
#### Returns
|
|
56
|
+
|
|
57
|
+
`Promise`\<`RequestArgs`\>
|
|
58
|
+
|
|
59
|
+
**`Summary`**
|
|
60
|
+
|
|
61
|
+
Retrieve the daily digest time
|
|
62
|
+
|
|
63
|
+
**`Throws`**
|
|
64
|
+
|
|
65
|
+
#### Defined in
|
|
66
|
+
|
|
67
|
+
[packages/notifications/OrgConfigResourceV1GetDailyDigestTimePreference/index.ts:28](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/OrgConfigResourceV1GetDailyDigestTimePreference/index.ts#L28)
|