@redhat-cloud-services/notifications-client 0.0.40 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/dist/EventResourceV1GetEvents/index.d.ts +111 -0
- package/dist/EventResourceV1GetEvents/index.js +143 -0
- package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.d.ts +26 -0
- package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.js +93 -0
- package/dist/NotificationResourceV1CreateBehaviorGroup/index.d.ts +21 -0
- package/dist/NotificationResourceV1CreateBehaviorGroup/index.js +93 -0
- package/dist/NotificationResourceV1DeleteBehaviorGroup/index.d.ts +20 -0
- package/dist/NotificationResourceV1DeleteBehaviorGroup/index.js +92 -0
- package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.d.ts +26 -0
- package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.js +93 -0
- package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.d.ts +20 -0
- package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.js +92 -0
- package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.d.ts +26 -0
- package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.js +93 -0
- package/dist/NotificationResourceV1GetApplicationsFacets/index.d.ts +20 -0
- package/dist/NotificationResourceV1GetApplicationsFacets/index.js +94 -0
- package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.d.ts +20 -0
- package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.js +92 -0
- package/dist/NotificationResourceV1GetBundleByName/index.d.ts +20 -0
- package/dist/NotificationResourceV1GetBundleByName/index.js +92 -0
- package/dist/NotificationResourceV1GetBundleFacets/index.d.ts +20 -0
- package/dist/NotificationResourceV1GetBundleFacets/index.js +94 -0
- package/dist/NotificationResourceV1GetEventTypes/index.d.ts +62 -0
- package/dist/NotificationResourceV1GetEventTypes/index.js +115 -0
- package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.d.ts +20 -0
- package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.js +92 -0
- package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.d.ts +32 -0
- package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.js +94 -0
- package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.d.ts +50 -0
- package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.js +116 -0
- package/dist/NotificationResourceV1UpdateBehaviorGroup/index.d.ts +27 -0
- package/dist/NotificationResourceV1UpdateBehaviorGroup/index.js +94 -0
- package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.d.ts +26 -0
- package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.js +94 -0
- package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.d.ts +26 -0
- package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.js +94 -0
- package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.d.ts +13 -0
- package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.js +90 -0
- package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.d.ts +20 -0
- package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.js +93 -0
- package/dist/UserConfigResourceV1GetPreferences/index.d.ts +25 -0
- package/dist/UserConfigResourceV1GetPreferences/index.js +92 -0
- package/dist/UserConfigResourceV1GetSettingsSchema/index.d.ts +19 -0
- package/dist/UserConfigResourceV1GetSettingsSchema/index.js +93 -0
- package/dist/UserConfigResourceV1SaveSettings/index.d.ts +20 -0
- package/dist/UserConfigResourceV1SaveSettings/index.js +92 -0
- package/dist/api.d.ts +2536 -759
- package/dist/api.js +2833 -778
- package/dist/base.d.ts +54 -0
- package/dist/base.js +80 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +252 -0
- package/dist/configuration.d.ts +24 -15
- package/dist/configuration.js +19 -12
- package/dist/index.d.ts +27 -13
- package/dist/index.js +89 -17
- package/dist/types/index.d.ts +1657 -0
- package/dist/types/index.js +90 -0
- package/dist/utils/base.d.ts +84 -0
- package/dist/utils/base.js +251 -0
- package/dist/utils/common.d.ts +54 -0
- package/dist/utils/common.js +241 -0
- package/dist/utils/configuration.d.ts +72 -0
- package/dist/utils/configuration.js +33 -0
- package/dist/utils/index.d.ts +3 -0
- package/dist/utils/index.js +19 -0
- package/doc/.nojekyll +1 -0
- package/doc/README.md +11 -420
- package/doc/classes/BaseAPI.md +125 -0
- package/doc/classes/Configuration.md +194 -0
- package/doc/classes/RequiredError.md +179 -0
- package/doc/enums/EmailSubscriptionType.md +21 -0
- package/doc/enums/EndpointStatus.md +76 -0
- package/doc/enums/EndpointType.md +65 -0
- package/doc/enums/Environment.md +54 -0
- package/doc/enums/EventLogEntryActionStatus.md +65 -0
- package/doc/enums/HttpType.md +43 -0
- package/doc/enums/NotificationStatus.md +65 -0
- package/doc/enums/Status.md +32 -0
- package/doc/interfaces/AddAccessRequest.md +44 -0
- package/doc/interfaces/AddApplicationRequest.md +74 -0
- package/doc/interfaces/AggregationEmailTemplate.md +164 -0
- package/doc/interfaces/ApiConfig.md +30 -0
- package/doc/interfaces/Application.md +104 -0
- package/doc/interfaces/Application1.md +44 -0
- package/doc/interfaces/ApplicationSettingsValue.md +33 -0
- package/doc/interfaces/ApplicationSettingsValue1.md +48 -0
- package/doc/interfaces/BasicAuthentication.md +44 -0
- package/doc/interfaces/BehaviorGroup.md +149 -0
- package/doc/interfaces/BehaviorGroupAction.md +59 -0
- package/doc/interfaces/BehaviorGroupActionId.md +44 -0
- package/doc/interfaces/Bundle.md +89 -0
- package/doc/interfaces/BundleSettingsValue.md +33 -0
- package/doc/interfaces/BundleSettingsValue1.md +33 -0
- package/doc/interfaces/CamelProperties.md +93 -0
- package/doc/interfaces/ConfigurationParameters.md +89 -0
- package/doc/interfaces/CreateBehaviorGroupRequest.md +104 -0
- package/doc/interfaces/CreateBehaviorGroupResponse.md +104 -0
- package/doc/interfaces/CurrentStatus.md +59 -0
- package/doc/interfaces/DuplicateNameMigrationReport.md +44 -0
- package/doc/interfaces/Endpoint.md +179 -0
- package/doc/interfaces/EndpointPage.md +63 -0
- package/doc/interfaces/EndpointTestRequest.md +29 -0
- package/doc/interfaces/EventLogEntry.md +119 -0
- package/doc/interfaces/EventLogEntryAction.md +125 -0
- package/doc/interfaces/EventType.md +119 -0
- package/doc/interfaces/EventTypeBehavior.md +59 -0
- package/doc/interfaces/EventTypeBehaviorId.md +44 -0
- package/doc/interfaces/EventTypeSettingsValue.md +48 -0
- package/doc/interfaces/Facet.md +74 -0
- package/doc/interfaces/InstantEmailTemplate.md +149 -0
- package/doc/interfaces/InternalApplicationUserPermission.md +59 -0
- package/doc/interfaces/InternalRoleAccess.md +59 -0
- package/doc/interfaces/InternalUserPermissions.md +59 -0
- package/doc/interfaces/MessageValidationResponse.md +33 -0
- package/doc/interfaces/Meta.md +29 -0
- package/doc/interfaces/NotificationHistory.md +155 -0
- package/doc/interfaces/PageBehaviorGroup.md +63 -0
- package/doc/interfaces/PageEventLogEntry.md +63 -0
- package/doc/interfaces/PageEventType.md +63 -0
- package/doc/interfaces/PageNotificationHistory.md +63 -0
- package/doc/interfaces/RenderEmailTemplateRequest.md +44 -0
- package/doc/interfaces/RequestArgs.md +58 -0
- package/doc/interfaces/RequestDefaultBehaviorGroupPropertyList.md +44 -0
- package/doc/interfaces/RequestSystemSubscriptionProperties.md +44 -0
- package/doc/interfaces/ServerInfo.md +29 -0
- package/doc/interfaces/SettingsValues.md +33 -0
- package/doc/interfaces/SettingsValuesByEventType.md +33 -0
- package/doc/interfaces/SystemSubscriptionProperties.md +59 -0
- package/doc/interfaces/Template.md +104 -0
- package/doc/interfaces/TriggerDailyDigestRequest.md +89 -0
- package/doc/interfaces/UpdateBehaviorGroupRequest.md +74 -0
- package/doc/interfaces/UserConfigPreferences.md +44 -0
- package/doc/interfaces/WebhookProperties.md +89 -0
- package/doc/modules.md +1080 -0
- package/git_push.sh +57 -0
- package/openapitools.json +7 -0
- package/package.json +26 -31
- package/postProcess.sh +3 -11
- package/tsconfig-cjs.json +19 -0
- package/tsconfig-esm.json +21 -0
- package/tsconfig.json +18 -0
- package/doc/classes/appregistrationapi.md +0 -123
- package/doc/classes/appsapi.md +0 -149
- package/doc/classes/baseapi.md +0 -86
- package/doc/classes/configuration.md +0 -140
- package/doc/classes/endpointsapi.md +0 -255
- package/doc/classes/filtersapi.md +0 -124
- package/doc/classes/requirederror.md +0 -109
- package/doc/enums/app.typeenum.md +0 -28
- package/doc/enums/endpoint.typeenum.md +0 -28
- package/doc/enums/endpointattributes.lastdeliverystatusenum.md +0 -38
- package/doc/enums/eventtype.typeenum.md +0 -28
- package/doc/enums/inlineresponse2004data.typeenum.md +0 -28
- package/doc/enums/level.typeenum.md +0 -28
- package/doc/interfaces/appattributes.md +0 -54
- package/doc/interfaces/apprelationships.md +0 -36
- package/doc/interfaces/appsregisterapplication.md +0 -50
- package/doc/interfaces/appsregistereventtypes.md +0 -64
- package/doc/interfaces/appsregistereventtypeslevels.md +0 -50
- package/doc/interfaces/configurationparameters.md +0 -84
- package/doc/interfaces/endpointsendpoint.md +0 -78
- package/doc/interfaces/endpointsendpointfilter.md +0 -64
- package/doc/interfaces/endpointsidendpoint.md +0 -78
- package/doc/interfaces/endpointsidendpointfilter.md +0 -78
- package/doc/interfaces/errors.md +0 -36
- package/doc/interfaces/errorserrors.md +0 -120
- package/doc/interfaces/errorssource.md +0 -50
- package/doc/interfaces/eventtypeattributes.md +0 -54
- package/doc/interfaces/eventtyperelationships.md +0 -36
- package/doc/interfaces/inlineobject.md +0 -50
- package/doc/interfaces/inlineobject1.md +0 -36
- package/doc/interfaces/inlineobject2.md +0 -36
- package/doc/interfaces/inlineresponse200.md +0 -50
- package/doc/interfaces/inlineresponse2001.md +0 -36
- package/doc/interfaces/inlineresponse2002.md +0 -50
- package/doc/interfaces/inlineresponse2003.md +0 -64
- package/doc/interfaces/inlineresponse2004.md +0 -36
- package/doc/interfaces/inlineresponse2004dataattributes.md +0 -36
- package/doc/interfaces/inlineresponse2004datarelationships.md +0 -78
- package/doc/interfaces/inlineresponse201.md +0 -36
- package/doc/interfaces/levelattributes.md +0 -38
- package/doc/interfaces/links.md +0 -86
- package/doc/interfaces/metadata.md +0 -70
- package/doc/interfaces/relationship.md +0 -50
- package/doc/interfaces/relationships.md +0 -36
- package/doc/interfaces/requestargs.md +0 -42
- package/doc/modules/app.md +0 -82
- package/doc/modules/endpoint.md +0 -68
- package/doc/modules/endpointattributes.md +0 -118
- package/doc/modules/eventtype.md +0 -82
- package/doc/modules/inlineresponse2004data.md +0 -78
- package/doc/modules/level.md +0 -68
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [InlineResponse2004](../interfaces/inlineresponse2004.md)
|
|
2
|
-
|
|
3
|
-
# Interface: InlineResponse2004
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__interface__*: InlineResponse2004
|
|
8
|
-
|
|
9
|
-
## Hierarchy
|
|
10
|
-
|
|
11
|
-
**InlineResponse2004**
|
|
12
|
-
|
|
13
|
-
## Index
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
* [data](inlineresponse2004.md#data)
|
|
18
|
-
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
## Properties
|
|
22
|
-
|
|
23
|
-
<a id="data"></a>
|
|
24
|
-
|
|
25
|
-
### `<Optional>` data
|
|
26
|
-
|
|
27
|
-
**● data**: *[InlineResponse2004Data](../modules/inlineresponse2004data.md)*
|
|
28
|
-
|
|
29
|
-
*Defined in [api.ts:742](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L742)*
|
|
30
|
-
|
|
31
|
-
*__type__*: {InlineResponse2004Data}
|
|
32
|
-
|
|
33
|
-
*__memberof__*: InlineResponse2004
|
|
34
|
-
|
|
35
|
-
___
|
|
36
|
-
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [InlineResponse2004DataAttributes](../interfaces/inlineresponse2004dataattributes.md)
|
|
2
|
-
|
|
3
|
-
# Interface: InlineResponse2004DataAttributes
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__interface__*: InlineResponse2004DataAttributes
|
|
8
|
-
|
|
9
|
-
## Hierarchy
|
|
10
|
-
|
|
11
|
-
**InlineResponse2004DataAttributes**
|
|
12
|
-
|
|
13
|
-
## Index
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
* [enabled](inlineresponse2004dataattributes.md#enabled)
|
|
18
|
-
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
## Properties
|
|
22
|
-
|
|
23
|
-
<a id="enabled"></a>
|
|
24
|
-
|
|
25
|
-
### `<Optional>` enabled
|
|
26
|
-
|
|
27
|
-
**● enabled**: *`boolean`*
|
|
28
|
-
|
|
29
|
-
*Defined in [api.ts:802](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L802)*
|
|
30
|
-
|
|
31
|
-
*__type__*: {boolean}
|
|
32
|
-
|
|
33
|
-
*__memberof__*: InlineResponse2004DataAttributes
|
|
34
|
-
|
|
35
|
-
___
|
|
36
|
-
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [InlineResponse2004DataRelationships](../interfaces/inlineresponse2004datarelationships.md)
|
|
2
|
-
|
|
3
|
-
# Interface: InlineResponse2004DataRelationships
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__interface__*: InlineResponse2004DataRelationships
|
|
8
|
-
|
|
9
|
-
## Hierarchy
|
|
10
|
-
|
|
11
|
-
**InlineResponse2004DataRelationships**
|
|
12
|
-
|
|
13
|
-
## Index
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
* [apps](inlineresponse2004datarelationships.md#apps)
|
|
18
|
-
* [endpoint](inlineresponse2004datarelationships.md#endpoint)
|
|
19
|
-
* [eventTypes](inlineresponse2004datarelationships.md#eventtypes)
|
|
20
|
-
* [levels](inlineresponse2004datarelationships.md#levels)
|
|
21
|
-
|
|
22
|
-
---
|
|
23
|
-
|
|
24
|
-
## Properties
|
|
25
|
-
|
|
26
|
-
<a id="apps"></a>
|
|
27
|
-
|
|
28
|
-
### `<Optional>` apps
|
|
29
|
-
|
|
30
|
-
**● apps**: *[Relationships](relationships.md)*
|
|
31
|
-
|
|
32
|
-
*Defined in [api.ts:816](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L816)*
|
|
33
|
-
|
|
34
|
-
*__type__*: {Relationships}
|
|
35
|
-
|
|
36
|
-
*__memberof__*: InlineResponse2004DataRelationships
|
|
37
|
-
|
|
38
|
-
___
|
|
39
|
-
<a id="endpoint"></a>
|
|
40
|
-
|
|
41
|
-
### `<Optional>` endpoint
|
|
42
|
-
|
|
43
|
-
**● endpoint**: *[Relationship](relationship.md)*
|
|
44
|
-
|
|
45
|
-
*Defined in [api.ts:834](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L834)*
|
|
46
|
-
|
|
47
|
-
*__type__*: {Relationship}
|
|
48
|
-
|
|
49
|
-
*__memberof__*: InlineResponse2004DataRelationships
|
|
50
|
-
|
|
51
|
-
___
|
|
52
|
-
<a id="eventtypes"></a>
|
|
53
|
-
|
|
54
|
-
### `<Optional>` eventTypes
|
|
55
|
-
|
|
56
|
-
**● eventTypes**: *[Relationships](relationships.md)*
|
|
57
|
-
|
|
58
|
-
*Defined in [api.ts:822](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L822)*
|
|
59
|
-
|
|
60
|
-
*__type__*: {Relationships}
|
|
61
|
-
|
|
62
|
-
*__memberof__*: InlineResponse2004DataRelationships
|
|
63
|
-
|
|
64
|
-
___
|
|
65
|
-
<a id="levels"></a>
|
|
66
|
-
|
|
67
|
-
### `<Optional>` levels
|
|
68
|
-
|
|
69
|
-
**● levels**: *[Relationships](relationships.md)*
|
|
70
|
-
|
|
71
|
-
*Defined in [api.ts:828](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L828)*
|
|
72
|
-
|
|
73
|
-
*__type__*: {Relationships}
|
|
74
|
-
|
|
75
|
-
*__memberof__*: InlineResponse2004DataRelationships
|
|
76
|
-
|
|
77
|
-
___
|
|
78
|
-
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [InlineResponse201](../interfaces/inlineresponse201.md)
|
|
2
|
-
|
|
3
|
-
# Interface: InlineResponse201
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__interface__*: InlineResponse201
|
|
8
|
-
|
|
9
|
-
## Hierarchy
|
|
10
|
-
|
|
11
|
-
**InlineResponse201**
|
|
12
|
-
|
|
13
|
-
## Index
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
* [data](inlineresponse201.md#data)
|
|
18
|
-
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
## Properties
|
|
22
|
-
|
|
23
|
-
<a id="data"></a>
|
|
24
|
-
|
|
25
|
-
### `<Optional>` data
|
|
26
|
-
|
|
27
|
-
**● data**: *[Endpoint](../modules/endpoint.md)*
|
|
28
|
-
|
|
29
|
-
*Defined in [api.ts:848](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L848)*
|
|
30
|
-
|
|
31
|
-
*__type__*: {Endpoint}
|
|
32
|
-
|
|
33
|
-
*__memberof__*: InlineResponse201
|
|
34
|
-
|
|
35
|
-
___
|
|
36
|
-
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [LevelAttributes](../interfaces/levelattributes.md)
|
|
2
|
-
|
|
3
|
-
# Interface: LevelAttributes
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__interface__*: LevelAttributes
|
|
8
|
-
|
|
9
|
-
## Hierarchy
|
|
10
|
-
|
|
11
|
-
**LevelAttributes**
|
|
12
|
-
|
|
13
|
-
## Index
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
* [title](levelattributes.md#title)
|
|
18
|
-
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
## Properties
|
|
22
|
-
|
|
23
|
-
<a id="title"></a>
|
|
24
|
-
|
|
25
|
-
### `<Optional>` title
|
|
26
|
-
|
|
27
|
-
**● title**: *`string`*
|
|
28
|
-
|
|
29
|
-
*Defined in [api.ts:902](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L902)*
|
|
30
|
-
|
|
31
|
-
Title of the level, shown to the user when configuring filters
|
|
32
|
-
|
|
33
|
-
*__type__*: {string}
|
|
34
|
-
|
|
35
|
-
*__memberof__*: LevelAttributes
|
|
36
|
-
|
|
37
|
-
___
|
|
38
|
-
|
package/doc/interfaces/links.md
DELETED
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [Links](../interfaces/links.md)
|
|
2
|
-
|
|
3
|
-
# Interface: Links
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__interface__*: Links
|
|
8
|
-
|
|
9
|
-
## Hierarchy
|
|
10
|
-
|
|
11
|
-
**Links**
|
|
12
|
-
|
|
13
|
-
## Index
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
* [first](links.md#first)
|
|
18
|
-
* [last](links.md#last)
|
|
19
|
-
* [next](links.md#next)
|
|
20
|
-
* [previous](links.md#previous)
|
|
21
|
-
|
|
22
|
-
---
|
|
23
|
-
|
|
24
|
-
## Properties
|
|
25
|
-
|
|
26
|
-
<a id="first"></a>
|
|
27
|
-
|
|
28
|
-
### `<Optional>` first
|
|
29
|
-
|
|
30
|
-
**● first**: *`string`*
|
|
31
|
-
|
|
32
|
-
*Defined in [api.ts:916](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L916)*
|
|
33
|
-
|
|
34
|
-
Link to the first page of records
|
|
35
|
-
|
|
36
|
-
*__type__*: {string}
|
|
37
|
-
|
|
38
|
-
*__memberof__*: Links
|
|
39
|
-
|
|
40
|
-
___
|
|
41
|
-
<a id="last"></a>
|
|
42
|
-
|
|
43
|
-
### `<Optional>` last
|
|
44
|
-
|
|
45
|
-
**● last**: *`string`*
|
|
46
|
-
|
|
47
|
-
*Defined in [api.ts:922](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L922)*
|
|
48
|
-
|
|
49
|
-
Link to the last page of records
|
|
50
|
-
|
|
51
|
-
*__type__*: {string}
|
|
52
|
-
|
|
53
|
-
*__memberof__*: Links
|
|
54
|
-
|
|
55
|
-
___
|
|
56
|
-
<a id="next"></a>
|
|
57
|
-
|
|
58
|
-
### `<Optional>` next
|
|
59
|
-
|
|
60
|
-
**● next**: *`string`*
|
|
61
|
-
|
|
62
|
-
*Defined in [api.ts:934](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L934)*
|
|
63
|
-
|
|
64
|
-
Link to next page of records, if such page exists
|
|
65
|
-
|
|
66
|
-
*__type__*: {string}
|
|
67
|
-
|
|
68
|
-
*__memberof__*: Links
|
|
69
|
-
|
|
70
|
-
___
|
|
71
|
-
<a id="previous"></a>
|
|
72
|
-
|
|
73
|
-
### `<Optional>` previous
|
|
74
|
-
|
|
75
|
-
**● previous**: *`string`*
|
|
76
|
-
|
|
77
|
-
*Defined in [api.ts:928](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L928)*
|
|
78
|
-
|
|
79
|
-
Link to previous page of records, if such page exists
|
|
80
|
-
|
|
81
|
-
*__type__*: {string}
|
|
82
|
-
|
|
83
|
-
*__memberof__*: Links
|
|
84
|
-
|
|
85
|
-
___
|
|
86
|
-
|
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [Metadata](../interfaces/metadata.md)
|
|
2
|
-
|
|
3
|
-
# Interface: Metadata
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__interface__*: Metadata
|
|
8
|
-
|
|
9
|
-
## Hierarchy
|
|
10
|
-
|
|
11
|
-
**Metadata**
|
|
12
|
-
|
|
13
|
-
## Index
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
* [limit](metadata.md#limit)
|
|
18
|
-
* [offset](metadata.md#offset)
|
|
19
|
-
* [total](metadata.md#total)
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
## Properties
|
|
24
|
-
|
|
25
|
-
<a id="limit"></a>
|
|
26
|
-
|
|
27
|
-
### `<Optional>` limit
|
|
28
|
-
|
|
29
|
-
**● limit**: *`number`*
|
|
30
|
-
|
|
31
|
-
*Defined in [api.ts:954](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L954)*
|
|
32
|
-
|
|
33
|
-
The maximum number of records to return.
|
|
34
|
-
|
|
35
|
-
*__type__*: {number}
|
|
36
|
-
|
|
37
|
-
*__memberof__*: Metadata
|
|
38
|
-
|
|
39
|
-
___
|
|
40
|
-
<a id="offset"></a>
|
|
41
|
-
|
|
42
|
-
### `<Optional>` offset
|
|
43
|
-
|
|
44
|
-
**● offset**: *`number`*
|
|
45
|
-
|
|
46
|
-
*Defined in [api.ts:960](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L960)*
|
|
47
|
-
|
|
48
|
-
The number of records to skip before returning.
|
|
49
|
-
|
|
50
|
-
*__type__*: {number}
|
|
51
|
-
|
|
52
|
-
*__memberof__*: Metadata
|
|
53
|
-
|
|
54
|
-
___
|
|
55
|
-
<a id="total"></a>
|
|
56
|
-
|
|
57
|
-
### `<Optional>` total
|
|
58
|
-
|
|
59
|
-
**● total**: *`number`*
|
|
60
|
-
|
|
61
|
-
*Defined in [api.ts:948](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L948)*
|
|
62
|
-
|
|
63
|
-
The total number of available records.
|
|
64
|
-
|
|
65
|
-
*__type__*: {number}
|
|
66
|
-
|
|
67
|
-
*__memberof__*: Metadata
|
|
68
|
-
|
|
69
|
-
___
|
|
70
|
-
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [Relationship](../interfaces/relationship.md)
|
|
2
|
-
|
|
3
|
-
# Interface: Relationship
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__interface__*: Relationship
|
|
8
|
-
|
|
9
|
-
## Hierarchy
|
|
10
|
-
|
|
11
|
-
**Relationship**
|
|
12
|
-
|
|
13
|
-
## Index
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
* [id](relationship.md#id)
|
|
18
|
-
* [type](relationship.md#type)
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## Properties
|
|
23
|
-
|
|
24
|
-
<a id="id"></a>
|
|
25
|
-
|
|
26
|
-
### `<Optional>` id
|
|
27
|
-
|
|
28
|
-
**● id**: *`string`*
|
|
29
|
-
|
|
30
|
-
*Defined in [api.ts:974](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L974)*
|
|
31
|
-
|
|
32
|
-
*__type__*: {string}
|
|
33
|
-
|
|
34
|
-
*__memberof__*: Relationship
|
|
35
|
-
|
|
36
|
-
___
|
|
37
|
-
<a id="type"></a>
|
|
38
|
-
|
|
39
|
-
### `<Optional>` type
|
|
40
|
-
|
|
41
|
-
**● type**: *`string`*
|
|
42
|
-
|
|
43
|
-
*Defined in [api.ts:980](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L980)*
|
|
44
|
-
|
|
45
|
-
*__type__*: {string}
|
|
46
|
-
|
|
47
|
-
*__memberof__*: Relationship
|
|
48
|
-
|
|
49
|
-
___
|
|
50
|
-
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [Relationships](../interfaces/relationships.md)
|
|
2
|
-
|
|
3
|
-
# Interface: Relationships
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__interface__*: Relationships
|
|
8
|
-
|
|
9
|
-
## Hierarchy
|
|
10
|
-
|
|
11
|
-
**Relationships**
|
|
12
|
-
|
|
13
|
-
## Index
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
* [data](relationships.md#data)
|
|
18
|
-
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
## Properties
|
|
22
|
-
|
|
23
|
-
<a id="data"></a>
|
|
24
|
-
|
|
25
|
-
### `<Optional>` data
|
|
26
|
-
|
|
27
|
-
**● data**: *`Array`<[Relationship](relationship.md)>*
|
|
28
|
-
|
|
29
|
-
*Defined in [api.ts:994](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L994)*
|
|
30
|
-
|
|
31
|
-
*__type__*: {Array}
|
|
32
|
-
|
|
33
|
-
*__memberof__*: Relationships
|
|
34
|
-
|
|
35
|
-
___
|
|
36
|
-
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [RequestArgs](../interfaces/requestargs.md)
|
|
2
|
-
|
|
3
|
-
# Interface: RequestArgs
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__interface__*: RequestArgs
|
|
8
|
-
|
|
9
|
-
## Hierarchy
|
|
10
|
-
|
|
11
|
-
**RequestArgs**
|
|
12
|
-
|
|
13
|
-
## Index
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
* [options](requestargs.md#options)
|
|
18
|
-
* [url](requestargs.md#url)
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## Properties
|
|
23
|
-
|
|
24
|
-
<a id="options"></a>
|
|
25
|
-
|
|
26
|
-
### options
|
|
27
|
-
|
|
28
|
-
**● options**: *`any`*
|
|
29
|
-
|
|
30
|
-
*Defined in [api.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L40)*
|
|
31
|
-
|
|
32
|
-
___
|
|
33
|
-
<a id="url"></a>
|
|
34
|
-
|
|
35
|
-
### url
|
|
36
|
-
|
|
37
|
-
**● url**: *`string`*
|
|
38
|
-
|
|
39
|
-
*Defined in [api.ts:39](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L39)*
|
|
40
|
-
|
|
41
|
-
___
|
|
42
|
-
|
package/doc/modules/app.md
DELETED
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [App](../modules/app.md)
|
|
2
|
-
|
|
3
|
-
# Module: App
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__namespace__*: App
|
|
8
|
-
|
|
9
|
-
## Index
|
|
10
|
-
|
|
11
|
-
### Enumerations
|
|
12
|
-
|
|
13
|
-
* [TypeEnum](../enums/app.typeenum.md)
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
* [attributes](app.md#attributes)
|
|
18
|
-
* [id](app.md#id)
|
|
19
|
-
* [relationships](app.md#relationships)
|
|
20
|
-
* [type](app.md#type)
|
|
21
|
-
|
|
22
|
-
---
|
|
23
|
-
|
|
24
|
-
## Properties
|
|
25
|
-
|
|
26
|
-
<a id="attributes"></a>
|
|
27
|
-
|
|
28
|
-
### `<Optional>` attributes
|
|
29
|
-
|
|
30
|
-
**● attributes**: *[AppAttributes](../interfaces/appattributes.md)*
|
|
31
|
-
|
|
32
|
-
*Defined in [api.ts:95](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L95)*
|
|
33
|
-
|
|
34
|
-
*__type__*: {AppAttributes}
|
|
35
|
-
|
|
36
|
-
*__memberof__*: App
|
|
37
|
-
|
|
38
|
-
___
|
|
39
|
-
<a id="id"></a>
|
|
40
|
-
|
|
41
|
-
### `<Optional>` id
|
|
42
|
-
|
|
43
|
-
**● id**: *`string`*
|
|
44
|
-
|
|
45
|
-
*Defined in [api.ts:83](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L83)*
|
|
46
|
-
|
|
47
|
-
Identifier of the application
|
|
48
|
-
|
|
49
|
-
*__type__*: {string}
|
|
50
|
-
|
|
51
|
-
*__memberof__*: App
|
|
52
|
-
|
|
53
|
-
___
|
|
54
|
-
<a id="relationships"></a>
|
|
55
|
-
|
|
56
|
-
### `<Optional>` relationships
|
|
57
|
-
|
|
58
|
-
**● relationships**: *[AppRelationships](../interfaces/apprelationships.md)*
|
|
59
|
-
|
|
60
|
-
*Defined in [api.ts:101](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L101)*
|
|
61
|
-
|
|
62
|
-
*__type__*: {AppRelationships}
|
|
63
|
-
|
|
64
|
-
*__memberof__*: App
|
|
65
|
-
|
|
66
|
-
___
|
|
67
|
-
<a id="type"></a>
|
|
68
|
-
|
|
69
|
-
### `<Optional>` type
|
|
70
|
-
|
|
71
|
-
**● type**: *[TypeEnum](../enums/app.typeenum.md)*
|
|
72
|
-
|
|
73
|
-
*Defined in [api.ts:89](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L89)*
|
|
74
|
-
|
|
75
|
-
Type of the returned record
|
|
76
|
-
|
|
77
|
-
*__type__*: {string}
|
|
78
|
-
|
|
79
|
-
*__memberof__*: App
|
|
80
|
-
|
|
81
|
-
___
|
|
82
|
-
|
package/doc/modules/endpoint.md
DELETED
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [Endpoint](../modules/endpoint.md)
|
|
2
|
-
|
|
3
|
-
# Module: Endpoint
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__namespace__*: Endpoint
|
|
8
|
-
|
|
9
|
-
## Index
|
|
10
|
-
|
|
11
|
-
### Enumerations
|
|
12
|
-
|
|
13
|
-
* [TypeEnum](../enums/endpoint.typeenum.md)
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
* [attributes](endpoint.md#attributes)
|
|
18
|
-
* [id](endpoint.md#id)
|
|
19
|
-
* [type](endpoint.md#type)
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
## Properties
|
|
24
|
-
|
|
25
|
-
<a id="attributes"></a>
|
|
26
|
-
|
|
27
|
-
### `<Optional>` attributes
|
|
28
|
-
|
|
29
|
-
**● attributes**: *[EndpointAttributes](endpointattributes.md)*
|
|
30
|
-
|
|
31
|
-
*Defined in [api.ts:241](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L241)*
|
|
32
|
-
|
|
33
|
-
*__type__*: {EndpointAttributes}
|
|
34
|
-
|
|
35
|
-
*__memberof__*: Endpoint
|
|
36
|
-
|
|
37
|
-
___
|
|
38
|
-
<a id="id"></a>
|
|
39
|
-
|
|
40
|
-
### `<Optional>` id
|
|
41
|
-
|
|
42
|
-
**● id**: *`string`*
|
|
43
|
-
|
|
44
|
-
*Defined in [api.ts:229](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L229)*
|
|
45
|
-
|
|
46
|
-
Identifier of the endpoint
|
|
47
|
-
|
|
48
|
-
*__type__*: {string}
|
|
49
|
-
|
|
50
|
-
*__memberof__*: Endpoint
|
|
51
|
-
|
|
52
|
-
___
|
|
53
|
-
<a id="type"></a>
|
|
54
|
-
|
|
55
|
-
### `<Optional>` type
|
|
56
|
-
|
|
57
|
-
**● type**: *[TypeEnum](../enums/endpoint.typeenum.md)*
|
|
58
|
-
|
|
59
|
-
*Defined in [api.ts:235](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L235)*
|
|
60
|
-
|
|
61
|
-
Type of the returned record
|
|
62
|
-
|
|
63
|
-
*__type__*: {string}
|
|
64
|
-
|
|
65
|
-
*__memberof__*: Endpoint
|
|
66
|
-
|
|
67
|
-
___
|
|
68
|
-
|