@redhat-cloud-services/notifications-client 2.4.3 → 2.4.4
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 +5 -0
- package/dist/NotificationResourceV1GetEventTypes/index.d.ts +8 -2
- package/dist/NotificationResourceV1GetEventTypes/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetEventTypes/index.js +8 -5
- package/dist/NotificationResourceV1GetEventTypes/index.js.map +1 -1
- package/dist/api.d.ts +12 -8
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js +18 -11
- package/dist/api.js.map +1 -1
- package/doc/enums/types.EndpointStatus.md +6 -6
- package/doc/enums/types.EndpointStatusDTO.md +78 -0
- package/doc/enums/types.EndpointType.md +5 -5
- package/doc/enums/types.EndpointTypeDTO.md +67 -0
- package/doc/enums/types.Environment.md +4 -4
- package/doc/enums/types.EventLogEntryActionStatus.md +5 -5
- package/doc/enums/types.HttpType.md +3 -3
- package/doc/enums/types.NotificationStatus.md +5 -5
- package/doc/enums/types.Status.md +2 -2
- package/doc/enums/types.SubscriptionType.md +3 -3
- package/doc/interfaces/types.AddAccessRequest.md +2 -2
- package/doc/interfaces/types.AddApplicationRequest.md +4 -4
- package/doc/interfaces/types.AggregationEmailTemplate.md +10 -10
- package/doc/interfaces/types.AggregationEmailTemplateSubjectTemplate.md +6 -6
- package/doc/interfaces/types.Application.md +6 -6
- package/doc/interfaces/types.Application1.md +2 -2
- package/doc/interfaces/types.ApplicationDTO.md +6 -6
- package/doc/interfaces/types.ApplicationSettingsValue.md +1 -1
- package/doc/interfaces/types.BasicAuthenticationDTO.md +44 -0
- package/doc/interfaces/types.BehaviorGroup.md +9 -9
- package/doc/interfaces/types.BehaviorGroupAction.md +3 -3
- package/doc/interfaces/types.BehaviorGroupActionId.md +2 -2
- package/doc/interfaces/types.Bundle.md +5 -5
- package/doc/interfaces/types.BundleSettingsValue.md +1 -1
- package/doc/interfaces/types.CamelPropertiesDTO.md +93 -0
- package/doc/interfaces/types.CreateBehaviorGroupRequest.md +6 -6
- package/doc/interfaces/types.CreateBehaviorGroupResponse.md +6 -6
- package/doc/interfaces/types.CurrentStatus.md +7 -7
- package/doc/interfaces/types.DrawerEntryPayload.md +7 -7
- package/doc/interfaces/types.DuplicateNameMigrationReport.md +2 -2
- package/doc/interfaces/types.Endpoint.md +12 -12
- package/doc/interfaces/types.EndpointDTO.md +179 -0
- package/doc/interfaces/types.EndpointPage.md +4 -4
- package/doc/interfaces/types.EndpointTestRequest.md +1 -1
- package/doc/interfaces/types.EventLogEntry.md +7 -7
- package/doc/interfaces/types.EventLogEntryAction.md +7 -7
- package/doc/interfaces/types.EventType.md +11 -11
- package/doc/interfaces/types.EventTypeBehavior.md +3 -3
- package/doc/interfaces/types.EventTypeBehaviorId.md +2 -2
- package/doc/interfaces/types.EventTypeSettingsValue.md +3 -3
- package/doc/interfaces/types.Facet.md +4 -4
- package/doc/interfaces/types.InstantEmailTemplate.md +9 -9
- package/doc/interfaces/types.InternalApplicationUserPermission.md +3 -3
- package/doc/interfaces/types.InternalRoleAccess.md +7 -7
- package/doc/interfaces/types.InternalUserPermissions.md +7 -7
- package/doc/interfaces/types.MessageValidationResponse.md +1 -1
- package/doc/interfaces/types.Meta.md +1 -1
- package/doc/interfaces/types.NotificationHistory.md +9 -9
- package/doc/interfaces/types.PageBehaviorGroup.md +3 -3
- package/doc/interfaces/types.PageDrawerEntryPayload.md +3 -3
- package/doc/interfaces/types.PageEventLogEntry.md +3 -3
- package/doc/interfaces/types.PageEventType.md +3 -3
- package/doc/interfaces/types.PageNotificationHistory.md +3 -3
- package/doc/interfaces/types.RenderEmailTemplateRequest.md +2 -2
- package/doc/interfaces/types.RequestDefaultBehaviorGroupPropertyList.md +2 -2
- package/doc/interfaces/types.RequestSystemSubscriptionProperties.md +5 -5
- package/doc/interfaces/types.ServerInfo.md +1 -1
- package/doc/interfaces/types.SettingsValuesByEventType.md +1 -1
- package/doc/interfaces/types.SystemSubscriptionPropertiesDTO.md +59 -0
- package/doc/interfaces/types.Template.md +6 -6
- package/doc/interfaces/types.TriggerDailyDigestRequest.md +5 -5
- package/doc/interfaces/types.UpdateApplicationRequest.md +3 -3
- package/doc/interfaces/types.UpdateBehaviorGroupRequest.md +4 -4
- package/doc/interfaces/types.UpdateNotificationDrawerStatus.md +5 -5
- package/doc/interfaces/types.WebhookPropertiesDTO.md +104 -0
- package/doc/interfaces/types.X509Certificate.md +5 -5
- package/doc/modules/DrawerResourceV1GetDrawerEntries.md +2 -2
- package/doc/modules/DrawerResourceV1UpdateNotificationReadStatus.md +2 -2
- package/doc/modules/EventResourceV1GetEvents.md +3 -3
- package/doc/modules/NotificationResourceV1AppendBehaviorGroupToEventType.md +2 -2
- package/doc/modules/NotificationResourceV1CreateBehaviorGroup.md +2 -2
- package/doc/modules/NotificationResourceV1DeleteBehaviorGroup.md +2 -2
- package/doc/modules/NotificationResourceV1DeleteBehaviorGroupFromEventType.md +2 -2
- package/doc/modules/NotificationResourceV1FindBehaviorGroupsByBundleId.md +2 -2
- package/doc/modules/NotificationResourceV1GetApplicationByNameAndBundleName.md +3 -3
- package/doc/modules/NotificationResourceV1GetApplicationsFacets.md +3 -3
- package/doc/modules/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint.md +2 -2
- package/doc/modules/NotificationResourceV1GetBundleByName.md +2 -2
- package/doc/modules/NotificationResourceV1GetBundleFacets.md +3 -3
- package/doc/modules/NotificationResourceV1GetEventTypes.md +6 -5
- package/doc/modules/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup.md +2 -2
- package/doc/modules/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName.md +3 -3
- package/doc/modules/NotificationResourceV1GetLinkedBehaviorGroups.md +2 -2
- package/doc/modules/NotificationResourceV1UpdateBehaviorGroup.md +3 -3
- package/doc/modules/NotificationResourceV1UpdateBehaviorGroupActions.md +3 -3
- package/doc/modules/NotificationResourceV1UpdateEventTypeBehaviors.md +2 -2
- package/doc/modules/OrgConfigResourceV1GetDailyDigestTimePreference.md +2 -2
- package/doc/modules/OrgConfigResourceV1SaveDailyDigestTimePreference.md +2 -2
- package/doc/modules/index.md +33 -57
- package/doc/modules/types.md +7 -4
- package/package.json +1 -1
- package/doc/classes/index.BaseAPI.md +0 -73
- package/doc/classes/index.RequiredError.md +0 -187
- package/doc/interfaces/index.RequestArgs.md +0 -36
- package/doc/interfaces/types.BasicAuthentication.md +0 -44
- package/doc/interfaces/types.CamelProperties.md +0 -123
- package/doc/interfaces/types.SystemSubscriptionProperties.md +0 -59
- package/doc/interfaces/types.WebhookProperties.md +0 -104
|
@@ -37,7 +37,7 @@ Renames and re-exports [notificationResourceV1GetBundleByNameParamCreator](Notif
|
|
|
37
37
|
|
|
38
38
|
#### Defined in
|
|
39
39
|
|
|
40
|
-
[
|
|
40
|
+
[NotificationResourceV1GetBundleByName/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBundleByName/index.ts#L14)
|
|
41
41
|
|
|
42
42
|
## Functions
|
|
43
43
|
|
|
@@ -65,4 +65,4 @@ Retrieve a bundle by name
|
|
|
65
65
|
|
|
66
66
|
#### Defined in
|
|
67
67
|
|
|
68
|
-
[
|
|
68
|
+
[NotificationResourceV1GetBundleByName/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBundleByName/index.ts#L34)
|
|
@@ -37,7 +37,7 @@ Renames and re-exports [notificationResourceV1GetBundleFacetsParamCreator](Notif
|
|
|
37
37
|
|
|
38
38
|
#### Defined in
|
|
39
39
|
|
|
40
|
-
[
|
|
40
|
+
[NotificationResourceV1GetBundleFacets/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBundleFacets/index.ts#L14)
|
|
41
41
|
|
|
42
42
|
## Functions
|
|
43
43
|
|
|
@@ -59,10 +59,10 @@ Returns a list of configured bundles that includes the bundle name, the display
|
|
|
59
59
|
|
|
60
60
|
**`Summary`**
|
|
61
61
|
|
|
62
|
-
List configured
|
|
62
|
+
List configured bundles
|
|
63
63
|
|
|
64
64
|
**`Throws`**
|
|
65
65
|
|
|
66
66
|
#### Defined in
|
|
67
67
|
|
|
68
|
-
[
|
|
68
|
+
[NotificationResourceV1GetBundleFacets/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetBundleFacets/index.ts#L34)
|
|
@@ -35,6 +35,7 @@ Renames and re-exports [notificationResourceV1GetEventTypesParamCreator](Notific
|
|
|
35
35
|
| `applicationIds?` | `Set`\<`string`\> | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
36
36
|
| `bundleId?` | `string` | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
37
37
|
| `eventTypeName?` | `string` | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
38
|
+
| `excludeMutedTypes?` | `boolean` | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
38
39
|
| `limit?` | `number` | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
39
40
|
| `offset?` | `number` | **`Memberof`** NotificationResourceV1GetEventTypesApi |
|
|
40
41
|
| `options?` | `AxiosRequestConfig` | - |
|
|
@@ -44,7 +45,7 @@ Renames and re-exports [notificationResourceV1GetEventTypesParamCreator](Notific
|
|
|
44
45
|
|
|
45
46
|
#### Defined in
|
|
46
47
|
|
|
47
|
-
[
|
|
48
|
+
[NotificationResourceV1GetEventTypes/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypes/index.ts#L14)
|
|
48
49
|
|
|
49
50
|
## Functions
|
|
50
51
|
|
|
@@ -52,13 +53,13 @@ Renames and re-exports [notificationResourceV1GetEventTypesParamCreator](Notific
|
|
|
52
53
|
|
|
53
54
|
▸ **notificationResourceV1GetEventTypesParamCreator**(`...config`): `Promise`\<`RequestArgs`\>
|
|
54
55
|
|
|
55
|
-
Lists all event types. You can filter the returned list by bundle or
|
|
56
|
+
Lists all event types. You can filter the returned list by bundle, application name, or unmuted types.
|
|
56
57
|
|
|
57
58
|
#### Parameters
|
|
58
59
|
|
|
59
60
|
| Name | Type | Description |
|
|
60
61
|
| :------ | :------ | :------ |
|
|
61
|
-
| `...config` | [[`NotificationResourceV1GetEventTypesParams`](NotificationResourceV1GetEventTypes.md#notificationresourcev1geteventtypesparams)] \| [`Set`\<`string`\>, `string`, `string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
62
|
+
| `...config` | [[`NotificationResourceV1GetEventTypesParams`](NotificationResourceV1GetEventTypes.md#notificationresourcev1geteventtypesparams)] \| [`Set`\<`string`\>, `string`, `string`, `boolean`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`\<`any`\>] | with all available params. |
|
|
62
63
|
|
|
63
64
|
#### Returns
|
|
64
65
|
|
|
@@ -66,10 +67,10 @@ Lists all event types. You can filter the returned list by bundle or application
|
|
|
66
67
|
|
|
67
68
|
**`Summary`**
|
|
68
69
|
|
|
69
|
-
List all event
|
|
70
|
+
List all event types
|
|
70
71
|
|
|
71
72
|
**`Throws`**
|
|
72
73
|
|
|
73
74
|
#### Defined in
|
|
74
75
|
|
|
75
|
-
[
|
|
76
|
+
[NotificationResourceV1GetEventTypes/index.ts:82](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypes/index.ts#L82)
|
|
@@ -37,7 +37,7 @@ Renames and re-exports [notificationResourceV1GetEventTypesAffectedByRemovalOfBe
|
|
|
37
37
|
|
|
38
38
|
#### Defined in
|
|
39
39
|
|
|
40
|
-
[
|
|
40
|
+
[NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts#L14)
|
|
41
41
|
|
|
42
42
|
## Functions
|
|
43
43
|
|
|
@@ -65,4 +65,4 @@ List the event types affected by the removal of a behavior group
|
|
|
65
65
|
|
|
66
66
|
#### Defined in
|
|
67
67
|
|
|
68
|
-
[
|
|
68
|
+
[NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.ts#L34)
|
|
@@ -39,7 +39,7 @@ Renames and re-exports [notificationResourceV1GetEventTypesByNameAndBundleAndApp
|
|
|
39
39
|
|
|
40
40
|
#### Defined in
|
|
41
41
|
|
|
42
|
-
[
|
|
42
|
+
[NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts#L14)
|
|
43
43
|
|
|
44
44
|
## Functions
|
|
45
45
|
|
|
@@ -61,10 +61,10 @@ Retrieves the details of an event type by specifying the bundle name, the applic
|
|
|
61
61
|
|
|
62
62
|
**`Summary`**
|
|
63
63
|
|
|
64
|
-
Retrieve an event type by bundle, application and event type
|
|
64
|
+
Retrieve an event type by bundle, application and event type names
|
|
65
65
|
|
|
66
66
|
**`Throws`**
|
|
67
67
|
|
|
68
68
|
#### Defined in
|
|
69
69
|
|
|
70
|
-
[
|
|
70
|
+
[NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.ts#L46)
|
|
@@ -42,7 +42,7 @@ Renames and re-exports [notificationResourceV1GetLinkedBehaviorGroupsParamCreato
|
|
|
42
42
|
|
|
43
43
|
#### Defined in
|
|
44
44
|
|
|
45
|
-
[
|
|
45
|
+
[NotificationResourceV1GetLinkedBehaviorGroups/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetLinkedBehaviorGroups/index.ts#L14)
|
|
46
46
|
|
|
47
47
|
## Functions
|
|
48
48
|
|
|
@@ -70,4 +70,4 @@ List the behavior groups linked to an event type
|
|
|
70
70
|
|
|
71
71
|
#### Defined in
|
|
72
72
|
|
|
73
|
-
[
|
|
73
|
+
[NotificationResourceV1GetLinkedBehaviorGroups/index.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1GetLinkedBehaviorGroups/index.ts#L64)
|
|
@@ -34,11 +34,11 @@ Renames and re-exports [notificationResourceV1UpdateBehaviorGroupParamCreator](N
|
|
|
34
34
|
| :------ | :------ | :------ |
|
|
35
35
|
| `id` | `string` | The UUID of the behavior group to update **`Memberof`** NotificationResourceV1UpdateBehaviorGroupApi |
|
|
36
36
|
| `options?` | `AxiosRequestConfig` | - |
|
|
37
|
-
| `updateBehaviorGroupRequest` | [`UpdateBehaviorGroupRequest`](../interfaces/types.UpdateBehaviorGroupRequest.md) | New
|
|
37
|
+
| `updateBehaviorGroupRequest` | [`UpdateBehaviorGroupRequest`](../interfaces/types.UpdateBehaviorGroupRequest.md) | New parameters **`Memberof`** NotificationResourceV1UpdateBehaviorGroupApi |
|
|
38
38
|
|
|
39
39
|
#### Defined in
|
|
40
40
|
|
|
41
|
-
[
|
|
41
|
+
[NotificationResourceV1UpdateBehaviorGroup/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts#L14)
|
|
42
42
|
|
|
43
43
|
## Functions
|
|
44
44
|
|
|
@@ -66,4 +66,4 @@ Update a behavior group
|
|
|
66
66
|
|
|
67
67
|
#### Defined in
|
|
68
68
|
|
|
69
|
-
[
|
|
69
|
+
[NotificationResourceV1UpdateBehaviorGroup/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateBehaviorGroup/index.ts#L40)
|
|
@@ -38,7 +38,7 @@ Renames and re-exports [notificationResourceV1UpdateBehaviorGroupActionsParamCre
|
|
|
38
38
|
|
|
39
39
|
#### Defined in
|
|
40
40
|
|
|
41
|
-
[
|
|
41
|
+
[NotificationResourceV1UpdateBehaviorGroupActions/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateBehaviorGroupActions/index.ts#L14)
|
|
42
42
|
|
|
43
43
|
## Functions
|
|
44
44
|
|
|
@@ -60,10 +60,10 @@ Updates the list of actions to be executed in that particular behavior group aft
|
|
|
60
60
|
|
|
61
61
|
**`Summary`**
|
|
62
62
|
|
|
63
|
-
Update the list of behavior group
|
|
63
|
+
Update the list of behavior group actions
|
|
64
64
|
|
|
65
65
|
**`Throws`**
|
|
66
66
|
|
|
67
67
|
#### Defined in
|
|
68
68
|
|
|
69
|
-
[
|
|
69
|
+
[NotificationResourceV1UpdateBehaviorGroupActions/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateBehaviorGroupActions/index.ts#L40)
|
|
@@ -38,7 +38,7 @@ Renames and re-exports [notificationResourceV1UpdateEventTypeBehaviorsParamCreat
|
|
|
38
38
|
|
|
39
39
|
#### Defined in
|
|
40
40
|
|
|
41
|
-
[
|
|
41
|
+
[NotificationResourceV1UpdateEventTypeBehaviors/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts#L14)
|
|
42
42
|
|
|
43
43
|
## Functions
|
|
44
44
|
|
|
@@ -66,4 +66,4 @@ Update the list of behavior groups for an event type
|
|
|
66
66
|
|
|
67
67
|
#### Defined in
|
|
68
68
|
|
|
69
|
-
[
|
|
69
|
+
[NotificationResourceV1UpdateEventTypeBehaviors/index.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/NotificationResourceV1UpdateEventTypeBehaviors/index.ts#L40)
|
|
@@ -36,7 +36,7 @@ Renames and re-exports [orgConfigResourceV1GetDailyDigestTimePreferenceParamCrea
|
|
|
36
36
|
|
|
37
37
|
#### Defined in
|
|
38
38
|
|
|
39
|
-
[
|
|
39
|
+
[OrgConfigResourceV1GetDailyDigestTimePreference/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/OrgConfigResourceV1GetDailyDigestTimePreference/index.ts#L14)
|
|
40
40
|
|
|
41
41
|
## Functions
|
|
42
42
|
|
|
@@ -64,4 +64,4 @@ Retrieve the daily digest time
|
|
|
64
64
|
|
|
65
65
|
#### Defined in
|
|
66
66
|
|
|
67
|
-
[
|
|
67
|
+
[OrgConfigResourceV1GetDailyDigestTimePreference/index.ts:28](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/OrgConfigResourceV1GetDailyDigestTimePreference/index.ts#L28)
|
|
@@ -37,7 +37,7 @@ Renames and re-exports [orgConfigResourceV1SaveDailyDigestTimePreferenceParamCre
|
|
|
37
37
|
|
|
38
38
|
#### Defined in
|
|
39
39
|
|
|
40
|
-
[
|
|
40
|
+
[OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts:14](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts#L14)
|
|
41
41
|
|
|
42
42
|
## Functions
|
|
43
43
|
|
|
@@ -65,4 +65,4 @@ Set the daily digest time
|
|
|
65
65
|
|
|
66
66
|
#### Defined in
|
|
67
67
|
|
|
68
|
-
[
|
|
68
|
+
[OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts#L34)
|
package/doc/modules/index.md
CHANGED
|
@@ -14,23 +14,26 @@
|
|
|
14
14
|
- [Application1](index.md#application1)
|
|
15
15
|
- [ApplicationDTO](index.md#applicationdto)
|
|
16
16
|
- [ApplicationSettingsValue](index.md#applicationsettingsvalue)
|
|
17
|
-
- [
|
|
17
|
+
- [BasicAuthenticationDTO](index.md#basicauthenticationdto)
|
|
18
18
|
- [BehaviorGroup](index.md#behaviorgroup)
|
|
19
19
|
- [BehaviorGroupAction](index.md#behaviorgroupaction)
|
|
20
20
|
- [BehaviorGroupActionId](index.md#behaviorgroupactionid)
|
|
21
21
|
- [Bundle](index.md#bundle)
|
|
22
22
|
- [BundleSettingsValue](index.md#bundlesettingsvalue)
|
|
23
|
-
- [
|
|
23
|
+
- [CamelPropertiesDTO](index.md#camelpropertiesdto)
|
|
24
24
|
- [CreateBehaviorGroupRequest](index.md#createbehaviorgrouprequest)
|
|
25
25
|
- [CreateBehaviorGroupResponse](index.md#createbehaviorgroupresponse)
|
|
26
26
|
- [CurrentStatus](index.md#currentstatus)
|
|
27
27
|
- [DrawerEntryPayload](index.md#drawerentrypayload)
|
|
28
28
|
- [DuplicateNameMigrationReport](index.md#duplicatenamemigrationreport)
|
|
29
29
|
- [Endpoint](index.md#endpoint)
|
|
30
|
+
- [EndpointDTO](index.md#endpointdto)
|
|
30
31
|
- [EndpointPage](index.md#endpointpage)
|
|
31
32
|
- [EndpointStatus](index.md#endpointstatus)
|
|
33
|
+
- [EndpointStatusDTO](index.md#endpointstatusdto)
|
|
32
34
|
- [EndpointTestRequest](index.md#endpointtestrequest)
|
|
33
35
|
- [EndpointType](index.md#endpointtype)
|
|
36
|
+
- [EndpointTypeDTO](index.md#endpointtypedto)
|
|
34
37
|
- [Environment](index.md#environment)
|
|
35
38
|
- [EventLogEntry](index.md#eventlogentry)
|
|
36
39
|
- [EventLogEntryAction](index.md#eventlogentryaction)
|
|
@@ -61,13 +64,13 @@
|
|
|
61
64
|
- [SettingsValuesByEventType](index.md#settingsvaluesbyeventtype)
|
|
62
65
|
- [Status](index.md#status)
|
|
63
66
|
- [SubscriptionType](index.md#subscriptiontype)
|
|
64
|
-
- [
|
|
67
|
+
- [SystemSubscriptionPropertiesDTO](index.md#systemsubscriptionpropertiesdto)
|
|
65
68
|
- [Template](index.md#template)
|
|
66
69
|
- [TriggerDailyDigestRequest](index.md#triggerdailydigestrequest)
|
|
67
70
|
- [UpdateApplicationRequest](index.md#updateapplicationrequest)
|
|
68
71
|
- [UpdateBehaviorGroupRequest](index.md#updatebehaviorgrouprequest)
|
|
69
72
|
- [UpdateNotificationDrawerStatus](index.md#updatenotificationdrawerstatus)
|
|
70
|
-
- [
|
|
73
|
+
- [WebhookPropertiesDTO](index.md#webhookpropertiesdto)
|
|
71
74
|
- [X509Certificate](index.md#x509certificate)
|
|
72
75
|
- [drawerResourceV1GetDrawerEntries](index.md#drawerresourcev1getdrawerentries)
|
|
73
76
|
- [drawerResourceV1UpdateNotificationReadStatus](index.md#drawerresourcev1updatenotificationreadstatus)
|
|
@@ -92,20 +95,6 @@
|
|
|
92
95
|
- [orgConfigResourceV1GetDailyDigestTimePreference](index.md#orgconfigresourcev1getdailydigesttimepreference)
|
|
93
96
|
- [orgConfigResourceV1SaveDailyDigestTimePreference](index.md#orgconfigresourcev1savedailydigesttimepreference)
|
|
94
97
|
|
|
95
|
-
### Classes
|
|
96
|
-
|
|
97
|
-
- [BaseAPI](../classes/index.BaseAPI.md)
|
|
98
|
-
- [RequiredError](../classes/index.RequiredError.md)
|
|
99
|
-
|
|
100
|
-
### Interfaces
|
|
101
|
-
|
|
102
|
-
- [RequestArgs](../interfaces/index.RequestArgs.md)
|
|
103
|
-
|
|
104
|
-
### Variables
|
|
105
|
-
|
|
106
|
-
- [BASE\_PATH](index.md#base_path)
|
|
107
|
-
- [COLLECTION\_FORMATS](index.md#collection_formats)
|
|
108
|
-
|
|
109
98
|
## References
|
|
110
99
|
|
|
111
100
|
### AddAccessRequest
|
|
@@ -156,9 +145,9 @@ Re-exports [ApplicationSettingsValue](../interfaces/types.ApplicationSettingsVal
|
|
|
156
145
|
|
|
157
146
|
___
|
|
158
147
|
|
|
159
|
-
###
|
|
148
|
+
### BasicAuthenticationDTO
|
|
160
149
|
|
|
161
|
-
Re-exports [
|
|
150
|
+
Re-exports [BasicAuthenticationDTO](../interfaces/types.BasicAuthenticationDTO.md)
|
|
162
151
|
|
|
163
152
|
___
|
|
164
153
|
|
|
@@ -192,9 +181,9 @@ Re-exports [BundleSettingsValue](../interfaces/types.BundleSettingsValue.md)
|
|
|
192
181
|
|
|
193
182
|
___
|
|
194
183
|
|
|
195
|
-
###
|
|
184
|
+
### CamelPropertiesDTO
|
|
196
185
|
|
|
197
|
-
Re-exports [
|
|
186
|
+
Re-exports [CamelPropertiesDTO](../interfaces/types.CamelPropertiesDTO.md)
|
|
198
187
|
|
|
199
188
|
___
|
|
200
189
|
|
|
@@ -234,6 +223,12 @@ Re-exports [Endpoint](../interfaces/types.Endpoint.md)
|
|
|
234
223
|
|
|
235
224
|
___
|
|
236
225
|
|
|
226
|
+
### EndpointDTO
|
|
227
|
+
|
|
228
|
+
Re-exports [EndpointDTO](../interfaces/types.EndpointDTO.md)
|
|
229
|
+
|
|
230
|
+
___
|
|
231
|
+
|
|
237
232
|
### EndpointPage
|
|
238
233
|
|
|
239
234
|
Re-exports [EndpointPage](../interfaces/types.EndpointPage.md)
|
|
@@ -246,6 +241,12 @@ Re-exports [EndpointStatus](../enums/types.EndpointStatus.md)
|
|
|
246
241
|
|
|
247
242
|
___
|
|
248
243
|
|
|
244
|
+
### EndpointStatusDTO
|
|
245
|
+
|
|
246
|
+
Re-exports [EndpointStatusDTO](../enums/types.EndpointStatusDTO.md)
|
|
247
|
+
|
|
248
|
+
___
|
|
249
|
+
|
|
249
250
|
### EndpointTestRequest
|
|
250
251
|
|
|
251
252
|
Re-exports [EndpointTestRequest](../interfaces/types.EndpointTestRequest.md)
|
|
@@ -258,6 +259,12 @@ Re-exports [EndpointType](../enums/types.EndpointType.md)
|
|
|
258
259
|
|
|
259
260
|
___
|
|
260
261
|
|
|
262
|
+
### EndpointTypeDTO
|
|
263
|
+
|
|
264
|
+
Re-exports [EndpointTypeDTO](../enums/types.EndpointTypeDTO.md)
|
|
265
|
+
|
|
266
|
+
___
|
|
267
|
+
|
|
261
268
|
### Environment
|
|
262
269
|
|
|
263
270
|
Re-exports [Environment](../enums/types.Environment.md)
|
|
@@ -438,9 +445,9 @@ Re-exports [SubscriptionType](../enums/types.SubscriptionType.md)
|
|
|
438
445
|
|
|
439
446
|
___
|
|
440
447
|
|
|
441
|
-
###
|
|
448
|
+
### SystemSubscriptionPropertiesDTO
|
|
442
449
|
|
|
443
|
-
Re-exports [
|
|
450
|
+
Re-exports [SystemSubscriptionPropertiesDTO](../interfaces/types.SystemSubscriptionPropertiesDTO.md)
|
|
444
451
|
|
|
445
452
|
___
|
|
446
453
|
|
|
@@ -474,9 +481,9 @@ Re-exports [UpdateNotificationDrawerStatus](../interfaces/types.UpdateNotificati
|
|
|
474
481
|
|
|
475
482
|
___
|
|
476
483
|
|
|
477
|
-
###
|
|
484
|
+
### WebhookPropertiesDTO
|
|
478
485
|
|
|
479
|
-
Re-exports [
|
|
486
|
+
Re-exports [WebhookPropertiesDTO](../interfaces/types.WebhookPropertiesDTO.md)
|
|
480
487
|
|
|
481
488
|
___
|
|
482
489
|
|
|
@@ -615,34 +622,3 @@ ___
|
|
|
615
622
|
### orgConfigResourceV1SaveDailyDigestTimePreference
|
|
616
623
|
|
|
617
624
|
Renames and re-exports [orgConfigResourceV1SaveDailyDigestTimePreferenceParamCreator](OrgConfigResourceV1SaveDailyDigestTimePreference.md#orgconfigresourcev1savedailydigesttimepreferenceparamcreator)
|
|
618
|
-
|
|
619
|
-
## Variables
|
|
620
|
-
|
|
621
|
-
### BASE\_PATH
|
|
622
|
-
|
|
623
|
-
• `Const` **BASE\_PATH**: `string`
|
|
624
|
-
|
|
625
|
-
#### Defined in
|
|
626
|
-
|
|
627
|
-
[packages/notifications/base.ts:22](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/base.ts#L22)
|
|
628
|
-
|
|
629
|
-
___
|
|
630
|
-
|
|
631
|
-
### COLLECTION\_FORMATS
|
|
632
|
-
|
|
633
|
-
• `Const` **COLLECTION\_FORMATS**: `Object`
|
|
634
|
-
|
|
635
|
-
**`Export`**
|
|
636
|
-
|
|
637
|
-
#### Type declaration
|
|
638
|
-
|
|
639
|
-
| Name | Type |
|
|
640
|
-
| :------ | :------ |
|
|
641
|
-
| `csv` | `string` |
|
|
642
|
-
| `pipes` | `string` |
|
|
643
|
-
| `ssv` | `string` |
|
|
644
|
-
| `tsv` | `string` |
|
|
645
|
-
|
|
646
|
-
#### Defined in
|
|
647
|
-
|
|
648
|
-
[packages/notifications/base.ts:28](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/base.ts#L28)
|
package/doc/modules/types.md
CHANGED
|
@@ -7,7 +7,9 @@
|
|
|
7
7
|
### Enumerations
|
|
8
8
|
|
|
9
9
|
- [EndpointStatus](../enums/types.EndpointStatus.md)
|
|
10
|
+
- [EndpointStatusDTO](../enums/types.EndpointStatusDTO.md)
|
|
10
11
|
- [EndpointType](../enums/types.EndpointType.md)
|
|
12
|
+
- [EndpointTypeDTO](../enums/types.EndpointTypeDTO.md)
|
|
11
13
|
- [Environment](../enums/types.Environment.md)
|
|
12
14
|
- [EventLogEntryActionStatus](../enums/types.EventLogEntryActionStatus.md)
|
|
13
15
|
- [HttpType](../enums/types.HttpType.md)
|
|
@@ -25,19 +27,20 @@
|
|
|
25
27
|
- [Application1](../interfaces/types.Application1.md)
|
|
26
28
|
- [ApplicationDTO](../interfaces/types.ApplicationDTO.md)
|
|
27
29
|
- [ApplicationSettingsValue](../interfaces/types.ApplicationSettingsValue.md)
|
|
28
|
-
- [
|
|
30
|
+
- [BasicAuthenticationDTO](../interfaces/types.BasicAuthenticationDTO.md)
|
|
29
31
|
- [BehaviorGroup](../interfaces/types.BehaviorGroup.md)
|
|
30
32
|
- [BehaviorGroupAction](../interfaces/types.BehaviorGroupAction.md)
|
|
31
33
|
- [BehaviorGroupActionId](../interfaces/types.BehaviorGroupActionId.md)
|
|
32
34
|
- [Bundle](../interfaces/types.Bundle.md)
|
|
33
35
|
- [BundleSettingsValue](../interfaces/types.BundleSettingsValue.md)
|
|
34
|
-
- [
|
|
36
|
+
- [CamelPropertiesDTO](../interfaces/types.CamelPropertiesDTO.md)
|
|
35
37
|
- [CreateBehaviorGroupRequest](../interfaces/types.CreateBehaviorGroupRequest.md)
|
|
36
38
|
- [CreateBehaviorGroupResponse](../interfaces/types.CreateBehaviorGroupResponse.md)
|
|
37
39
|
- [CurrentStatus](../interfaces/types.CurrentStatus.md)
|
|
38
40
|
- [DrawerEntryPayload](../interfaces/types.DrawerEntryPayload.md)
|
|
39
41
|
- [DuplicateNameMigrationReport](../interfaces/types.DuplicateNameMigrationReport.md)
|
|
40
42
|
- [Endpoint](../interfaces/types.Endpoint.md)
|
|
43
|
+
- [EndpointDTO](../interfaces/types.EndpointDTO.md)
|
|
41
44
|
- [EndpointPage](../interfaces/types.EndpointPage.md)
|
|
42
45
|
- [EndpointTestRequest](../interfaces/types.EndpointTestRequest.md)
|
|
43
46
|
- [EventLogEntry](../interfaces/types.EventLogEntry.md)
|
|
@@ -64,11 +67,11 @@
|
|
|
64
67
|
- [RequestSystemSubscriptionProperties](../interfaces/types.RequestSystemSubscriptionProperties.md)
|
|
65
68
|
- [ServerInfo](../interfaces/types.ServerInfo.md)
|
|
66
69
|
- [SettingsValuesByEventType](../interfaces/types.SettingsValuesByEventType.md)
|
|
67
|
-
- [
|
|
70
|
+
- [SystemSubscriptionPropertiesDTO](../interfaces/types.SystemSubscriptionPropertiesDTO.md)
|
|
68
71
|
- [Template](../interfaces/types.Template.md)
|
|
69
72
|
- [TriggerDailyDigestRequest](../interfaces/types.TriggerDailyDigestRequest.md)
|
|
70
73
|
- [UpdateApplicationRequest](../interfaces/types.UpdateApplicationRequest.md)
|
|
71
74
|
- [UpdateBehaviorGroupRequest](../interfaces/types.UpdateBehaviorGroupRequest.md)
|
|
72
75
|
- [UpdateNotificationDrawerStatus](../interfaces/types.UpdateNotificationDrawerStatus.md)
|
|
73
|
-
- [
|
|
76
|
+
- [WebhookPropertiesDTO](../interfaces/types.WebhookPropertiesDTO.md)
|
|
74
77
|
- [X509Certificate](../interfaces/types.X509Certificate.md)
|
package/package.json
CHANGED
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/javascript-clients](../README.md) / [Exports](../modules.md) / [index](../modules/index.md) / BaseAPI
|
|
2
|
-
|
|
3
|
-
# Class: BaseAPI
|
|
4
|
-
|
|
5
|
-
[index](../modules/index.md).BaseAPI
|
|
6
|
-
|
|
7
|
-
**`Export`**
|
|
8
|
-
|
|
9
|
-
BaseAPI
|
|
10
|
-
|
|
11
|
-
## Table of contents
|
|
12
|
-
|
|
13
|
-
### Constructors
|
|
14
|
-
|
|
15
|
-
- [constructor](index.BaseAPI.md#constructor)
|
|
16
|
-
|
|
17
|
-
### Properties
|
|
18
|
-
|
|
19
|
-
- [axios](index.BaseAPI.md#axios)
|
|
20
|
-
- [basePath](index.BaseAPI.md#basepath)
|
|
21
|
-
- [configuration](index.BaseAPI.md#configuration)
|
|
22
|
-
|
|
23
|
-
## Constructors
|
|
24
|
-
|
|
25
|
-
### constructor
|
|
26
|
-
|
|
27
|
-
• **new BaseAPI**(`configuration?`, `basePath?`, `axios?`): [`BaseAPI`](index.BaseAPI.md)
|
|
28
|
-
|
|
29
|
-
#### Parameters
|
|
30
|
-
|
|
31
|
-
| Name | Type | Default value |
|
|
32
|
-
| :------ | :------ | :------ |
|
|
33
|
-
| `configuration?` | `Configuration` | `undefined` |
|
|
34
|
-
| `basePath` | `string` | `BASE_PATH` |
|
|
35
|
-
| `axios` | `AxiosInstance` | `globalAxios` |
|
|
36
|
-
|
|
37
|
-
#### Returns
|
|
38
|
-
|
|
39
|
-
[`BaseAPI`](index.BaseAPI.md)
|
|
40
|
-
|
|
41
|
-
#### Defined in
|
|
42
|
-
|
|
43
|
-
[packages/notifications/base.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/base.ts#L53)
|
|
44
|
-
|
|
45
|
-
## Properties
|
|
46
|
-
|
|
47
|
-
### axios
|
|
48
|
-
|
|
49
|
-
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
|
|
50
|
-
|
|
51
|
-
#### Defined in
|
|
52
|
-
|
|
53
|
-
[packages/notifications/base.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/base.ts#L53)
|
|
54
|
-
|
|
55
|
-
___
|
|
56
|
-
|
|
57
|
-
### basePath
|
|
58
|
-
|
|
59
|
-
• `Protected` **basePath**: `string` = `BASE_PATH`
|
|
60
|
-
|
|
61
|
-
#### Defined in
|
|
62
|
-
|
|
63
|
-
[packages/notifications/base.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/base.ts#L53)
|
|
64
|
-
|
|
65
|
-
___
|
|
66
|
-
|
|
67
|
-
### configuration
|
|
68
|
-
|
|
69
|
-
• `Protected` **configuration**: `undefined` \| `Configuration`
|
|
70
|
-
|
|
71
|
-
#### Defined in
|
|
72
|
-
|
|
73
|
-
[packages/notifications/base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/base.ts#L51)
|