@redhat-cloud-services/notifications-client 1.0.102
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/LICENSE +201 -0
- package/README.md +59 -0
- package/doc/README.md +63 -0
- package/doc/classes/appregistrationapi.md +102 -0
- package/doc/classes/appsapi.md +127 -0
- package/doc/classes/baseapi.md +71 -0
- package/doc/classes/configuration.md +116 -0
- package/doc/classes/endpointsapi.md +229 -0
- package/doc/classes/filtersapi.md +103 -0
- package/doc/classes/requirederror.md +88 -0
- package/doc/enums/apptypeenum.md +19 -0
- package/doc/enums/endpointattributeslastdeliverystatusenum.md +28 -0
- package/doc/enums/endpointtypeenum.md +19 -0
- package/doc/enums/eventtypetypeenum.md +19 -0
- package/doc/enums/inlineresponse2004datatypeenum.md +19 -0
- package/doc/enums/leveltypeenum.md +19 -0
- package/doc/globals.md +458 -0
- package/doc/interfaces/app.md +66 -0
- package/doc/interfaces/appattributes.md +42 -0
- package/doc/interfaces/apprelationships.md +27 -0
- package/doc/interfaces/appsregisterapplication.md +38 -0
- package/doc/interfaces/appsregistereventtypes.md +49 -0
- package/doc/interfaces/appsregistereventtypeslevels.md +38 -0
- package/doc/interfaces/configurationparameters.md +75 -0
- package/doc/interfaces/endpoint.md +53 -0
- package/doc/interfaces/endpointattributes.md +94 -0
- package/doc/interfaces/endpointsendpoint.md +60 -0
- package/doc/interfaces/endpointsendpointfilter.md +49 -0
- package/doc/interfaces/endpointsidendpoint.md +60 -0
- package/doc/interfaces/endpointsidendpointfilter.md +60 -0
- package/doc/interfaces/errors.md +27 -0
- package/doc/interfaces/errorserrors.md +93 -0
- package/doc/interfaces/errorssource.md +38 -0
- package/doc/interfaces/eventtype.md +66 -0
- package/doc/interfaces/eventtypeattributes.md +42 -0
- package/doc/interfaces/eventtyperelationships.md +27 -0
- package/doc/interfaces/inlineobject.md +38 -0
- package/doc/interfaces/inlineobject1.md +27 -0
- package/doc/interfaces/inlineobject2.md +27 -0
- package/doc/interfaces/inlineresponse200.md +38 -0
- package/doc/interfaces/inlineresponse2001.md +27 -0
- package/doc/interfaces/inlineresponse2002.md +38 -0
- package/doc/interfaces/inlineresponse2003.md +49 -0
- package/doc/interfaces/inlineresponse2004.md +27 -0
- package/doc/interfaces/inlineresponse2004data.md +60 -0
- package/doc/interfaces/inlineresponse2004dataattributes.md +27 -0
- package/doc/interfaces/inlineresponse2004datarelationships.md +60 -0
- package/doc/interfaces/inlineresponse201.md +27 -0
- package/doc/interfaces/level.md +55 -0
- package/doc/interfaces/levelattributes.md +29 -0
- package/doc/interfaces/links.md +68 -0
- package/doc/interfaces/metadata.md +55 -0
- package/doc/interfaces/relationship.md +38 -0
- package/doc/interfaces/relationships.md +27 -0
- package/doc/interfaces/requestargs.md +34 -0
- package/package.json +34 -0
- package/postProcess.sh +12 -0
package/doc/globals.md
ADDED
|
@@ -0,0 +1,458 @@
|
|
|
1
|
+
[@redhat-cloud-services/notifications-client](README.md) › [Globals](globals.md)
|
|
2
|
+
|
|
3
|
+
# @redhat-cloud-services/notifications-client
|
|
4
|
+
|
|
5
|
+
## Index
|
|
6
|
+
|
|
7
|
+
### Enumerations
|
|
8
|
+
|
|
9
|
+
* [AppTypeEnum](enums/apptypeenum.md)
|
|
10
|
+
* [EndpointAttributesLastDeliveryStatusEnum](enums/endpointattributeslastdeliverystatusenum.md)
|
|
11
|
+
* [EndpointTypeEnum](enums/endpointtypeenum.md)
|
|
12
|
+
* [EventTypeTypeEnum](enums/eventtypetypeenum.md)
|
|
13
|
+
* [InlineResponse2004DataTypeEnum](enums/inlineresponse2004datatypeenum.md)
|
|
14
|
+
* [LevelTypeEnum](enums/leveltypeenum.md)
|
|
15
|
+
|
|
16
|
+
### Classes
|
|
17
|
+
|
|
18
|
+
* [AppRegistrationApi](classes/appregistrationapi.md)
|
|
19
|
+
* [AppsApi](classes/appsapi.md)
|
|
20
|
+
* [BaseAPI](classes/baseapi.md)
|
|
21
|
+
* [Configuration](classes/configuration.md)
|
|
22
|
+
* [EndpointsApi](classes/endpointsapi.md)
|
|
23
|
+
* [FiltersApi](classes/filtersapi.md)
|
|
24
|
+
* [RequiredError](classes/requirederror.md)
|
|
25
|
+
|
|
26
|
+
### Interfaces
|
|
27
|
+
|
|
28
|
+
* [App](interfaces/app.md)
|
|
29
|
+
* [AppAttributes](interfaces/appattributes.md)
|
|
30
|
+
* [AppRelationships](interfaces/apprelationships.md)
|
|
31
|
+
* [AppsRegisterApplication](interfaces/appsregisterapplication.md)
|
|
32
|
+
* [AppsRegisterEventTypes](interfaces/appsregistereventtypes.md)
|
|
33
|
+
* [AppsRegisterEventTypesLevels](interfaces/appsregistereventtypeslevels.md)
|
|
34
|
+
* [ConfigurationParameters](interfaces/configurationparameters.md)
|
|
35
|
+
* [Endpoint](interfaces/endpoint.md)
|
|
36
|
+
* [EndpointAttributes](interfaces/endpointattributes.md)
|
|
37
|
+
* [EndpointsEndpoint](interfaces/endpointsendpoint.md)
|
|
38
|
+
* [EndpointsEndpointFilter](interfaces/endpointsendpointfilter.md)
|
|
39
|
+
* [EndpointsIdEndpoint](interfaces/endpointsidendpoint.md)
|
|
40
|
+
* [EndpointsIdEndpointFilter](interfaces/endpointsidendpointfilter.md)
|
|
41
|
+
* [Errors](interfaces/errors.md)
|
|
42
|
+
* [ErrorsErrors](interfaces/errorserrors.md)
|
|
43
|
+
* [ErrorsSource](interfaces/errorssource.md)
|
|
44
|
+
* [EventType](interfaces/eventtype.md)
|
|
45
|
+
* [EventTypeAttributes](interfaces/eventtypeattributes.md)
|
|
46
|
+
* [EventTypeRelationships](interfaces/eventtyperelationships.md)
|
|
47
|
+
* [InlineObject](interfaces/inlineobject.md)
|
|
48
|
+
* [InlineObject1](interfaces/inlineobject1.md)
|
|
49
|
+
* [InlineObject2](interfaces/inlineobject2.md)
|
|
50
|
+
* [InlineResponse200](interfaces/inlineresponse200.md)
|
|
51
|
+
* [InlineResponse2001](interfaces/inlineresponse2001.md)
|
|
52
|
+
* [InlineResponse2002](interfaces/inlineresponse2002.md)
|
|
53
|
+
* [InlineResponse2003](interfaces/inlineresponse2003.md)
|
|
54
|
+
* [InlineResponse2004](interfaces/inlineresponse2004.md)
|
|
55
|
+
* [InlineResponse2004Data](interfaces/inlineresponse2004data.md)
|
|
56
|
+
* [InlineResponse2004DataAttributes](interfaces/inlineresponse2004dataattributes.md)
|
|
57
|
+
* [InlineResponse2004DataRelationships](interfaces/inlineresponse2004datarelationships.md)
|
|
58
|
+
* [InlineResponse201](interfaces/inlineresponse201.md)
|
|
59
|
+
* [Level](interfaces/level.md)
|
|
60
|
+
* [LevelAttributes](interfaces/levelattributes.md)
|
|
61
|
+
* [Links](interfaces/links.md)
|
|
62
|
+
* [Metadata](interfaces/metadata.md)
|
|
63
|
+
* [Relationship](interfaces/relationship.md)
|
|
64
|
+
* [Relationships](interfaces/relationships.md)
|
|
65
|
+
* [RequestArgs](interfaces/requestargs.md)
|
|
66
|
+
|
|
67
|
+
### Variables
|
|
68
|
+
|
|
69
|
+
* [BASE_PATH](globals.md#const-base_path)
|
|
70
|
+
|
|
71
|
+
### Functions
|
|
72
|
+
|
|
73
|
+
* [AppRegistrationApiAxiosParamCreator](globals.md#const-appregistrationapiaxiosparamcreator)
|
|
74
|
+
* [AppRegistrationApiFactory](globals.md#const-appregistrationapifactory)
|
|
75
|
+
* [AppRegistrationApiFp](globals.md#const-appregistrationapifp)
|
|
76
|
+
* [AppsApiAxiosParamCreator](globals.md#const-appsapiaxiosparamcreator)
|
|
77
|
+
* [AppsApiFactory](globals.md#const-appsapifactory)
|
|
78
|
+
* [AppsApiFp](globals.md#const-appsapifp)
|
|
79
|
+
* [EndpointsApiAxiosParamCreator](globals.md#const-endpointsapiaxiosparamcreator)
|
|
80
|
+
* [EndpointsApiFactory](globals.md#const-endpointsapifactory)
|
|
81
|
+
* [EndpointsApiFp](globals.md#const-endpointsapifp)
|
|
82
|
+
* [FiltersApiAxiosParamCreator](globals.md#const-filtersapiaxiosparamcreator)
|
|
83
|
+
* [FiltersApiFactory](globals.md#const-filtersapifactory)
|
|
84
|
+
* [FiltersApiFp](globals.md#const-filtersapifp)
|
|
85
|
+
|
|
86
|
+
### Object literals
|
|
87
|
+
|
|
88
|
+
* [COLLECTION_FORMATS](globals.md#const-collection_formats)
|
|
89
|
+
|
|
90
|
+
## Variables
|
|
91
|
+
|
|
92
|
+
### `Const` BASE_PATH
|
|
93
|
+
|
|
94
|
+
• **BASE_PATH**: *string* = "http://localhost".replace(/\/+$/, "")
|
|
95
|
+
|
|
96
|
+
Defined in packages/hooks/base.ts:20
|
|
97
|
+
|
|
98
|
+
## Functions
|
|
99
|
+
|
|
100
|
+
### `Const` AppRegistrationApiAxiosParamCreator
|
|
101
|
+
|
|
102
|
+
▸ **AppRegistrationApiAxiosParamCreator**(`configuration?`: [Configuration](classes/configuration.md)): *object*
|
|
103
|
+
|
|
104
|
+
*Defined in [packages/hooks/api.ts:886](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L886)*
|
|
105
|
+
|
|
106
|
+
AppRegistrationApi - axios parameter creator
|
|
107
|
+
|
|
108
|
+
**`export`**
|
|
109
|
+
|
|
110
|
+
**Parameters:**
|
|
111
|
+
|
|
112
|
+
Name | Type |
|
|
113
|
+
------ | ------ |
|
|
114
|
+
`configuration?` | [Configuration](classes/configuration.md) |
|
|
115
|
+
|
|
116
|
+
**Returns:** *object*
|
|
117
|
+
|
|
118
|
+
* **appRegistrationCreate**(`inlineObject`: [InlineObject](interfaces/inlineobject.md), `options`: any): *[RequestArgs](interfaces/requestargs.md)*
|
|
119
|
+
|
|
120
|
+
___
|
|
121
|
+
|
|
122
|
+
### `Const` AppRegistrationApiFactory
|
|
123
|
+
|
|
124
|
+
▸ **AppRegistrationApiFactory**(`configuration?`: [Configuration](classes/configuration.md), `basePath?`: string, `axios?`: AxiosInstance): *object*
|
|
125
|
+
|
|
126
|
+
*Defined in [packages/hooks/api.ts:955](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L955)*
|
|
127
|
+
|
|
128
|
+
AppRegistrationApi - factory interface
|
|
129
|
+
|
|
130
|
+
**`export`**
|
|
131
|
+
|
|
132
|
+
**Parameters:**
|
|
133
|
+
|
|
134
|
+
Name | Type |
|
|
135
|
+
------ | ------ |
|
|
136
|
+
`configuration?` | [Configuration](classes/configuration.md) |
|
|
137
|
+
`basePath?` | string |
|
|
138
|
+
`axios?` | AxiosInstance |
|
|
139
|
+
|
|
140
|
+
**Returns:** *object*
|
|
141
|
+
|
|
142
|
+
* **appRegistrationCreate**(`inlineObject`: [InlineObject](interfaces/inlineobject.md), `options?`: any): *AxiosPromise‹[InlineResponse2001](interfaces/inlineresponse2001.md)›*
|
|
143
|
+
|
|
144
|
+
___
|
|
145
|
+
|
|
146
|
+
### `Const` AppRegistrationApiFp
|
|
147
|
+
|
|
148
|
+
▸ **AppRegistrationApiFp**(`configuration?`: [Configuration](classes/configuration.md)): *object*
|
|
149
|
+
|
|
150
|
+
*Defined in [packages/hooks/api.ts:933](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L933)*
|
|
151
|
+
|
|
152
|
+
AppRegistrationApi - functional programming interface
|
|
153
|
+
|
|
154
|
+
**`export`**
|
|
155
|
+
|
|
156
|
+
**Parameters:**
|
|
157
|
+
|
|
158
|
+
Name | Type |
|
|
159
|
+
------ | ------ |
|
|
160
|
+
`configuration?` | [Configuration](classes/configuration.md) |
|
|
161
|
+
|
|
162
|
+
**Returns:** *object*
|
|
163
|
+
|
|
164
|
+
* **appRegistrationCreate**(`inlineObject`: [InlineObject](interfaces/inlineobject.md), `options?`: any): *function*
|
|
165
|
+
|
|
166
|
+
* (`axios?`: AxiosInstance, `basePath?`: string): *AxiosPromise‹[InlineResponse2001](interfaces/inlineresponse2001.md)›*
|
|
167
|
+
|
|
168
|
+
___
|
|
169
|
+
|
|
170
|
+
### `Const` AppsApiAxiosParamCreator
|
|
171
|
+
|
|
172
|
+
▸ **AppsApiAxiosParamCreator**(`configuration?`: [Configuration](classes/configuration.md)): *object*
|
|
173
|
+
|
|
174
|
+
*Defined in [packages/hooks/api.ts:994](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L994)*
|
|
175
|
+
|
|
176
|
+
AppsApi - axios parameter creator
|
|
177
|
+
|
|
178
|
+
**`export`**
|
|
179
|
+
|
|
180
|
+
**Parameters:**
|
|
181
|
+
|
|
182
|
+
Name | Type |
|
|
183
|
+
------ | ------ |
|
|
184
|
+
`configuration?` | [Configuration](classes/configuration.md) |
|
|
185
|
+
|
|
186
|
+
**Returns:** *object*
|
|
187
|
+
|
|
188
|
+
* **appsIndex**(`xRHIDENTITY`: string, `options`: any): *[RequestArgs](interfaces/requestargs.md)*
|
|
189
|
+
|
|
190
|
+
* **appsShow**(`xRHIDENTITY`: string, `id`: number, `options`: any): *[RequestArgs](interfaces/requestargs.md)*
|
|
191
|
+
|
|
192
|
+
___
|
|
193
|
+
|
|
194
|
+
### `Const` AppsApiFactory
|
|
195
|
+
|
|
196
|
+
▸ **AppsApiFactory**(`configuration?`: [Configuration](classes/configuration.md), `basePath?`: string, `axios?`: AxiosInstance): *object*
|
|
197
|
+
|
|
198
|
+
*Defined in [packages/hooks/api.ts:1121](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1121)*
|
|
199
|
+
|
|
200
|
+
AppsApi - factory interface
|
|
201
|
+
|
|
202
|
+
**`export`**
|
|
203
|
+
|
|
204
|
+
**Parameters:**
|
|
205
|
+
|
|
206
|
+
Name | Type |
|
|
207
|
+
------ | ------ |
|
|
208
|
+
`configuration?` | [Configuration](classes/configuration.md) |
|
|
209
|
+
`basePath?` | string |
|
|
210
|
+
`axios?` | AxiosInstance |
|
|
211
|
+
|
|
212
|
+
**Returns:** *object*
|
|
213
|
+
|
|
214
|
+
* **appsIndex**(`xRHIDENTITY`: string, `options?`: any): *AxiosPromise‹[InlineResponse200](interfaces/inlineresponse200.md)›*
|
|
215
|
+
|
|
216
|
+
* **appsShow**(`xRHIDENTITY`: string, `id`: number, `options?`: any): *AxiosPromise‹[InlineResponse2002](interfaces/inlineresponse2002.md)›*
|
|
217
|
+
|
|
218
|
+
___
|
|
219
|
+
|
|
220
|
+
### `Const` AppsApiFp
|
|
221
|
+
|
|
222
|
+
▸ **AppsApiFp**(`configuration?`: [Configuration](classes/configuration.md)): *object*
|
|
223
|
+
|
|
224
|
+
*Defined in [packages/hooks/api.ts:1085](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1085)*
|
|
225
|
+
|
|
226
|
+
AppsApi - functional programming interface
|
|
227
|
+
|
|
228
|
+
**`export`**
|
|
229
|
+
|
|
230
|
+
**Parameters:**
|
|
231
|
+
|
|
232
|
+
Name | Type |
|
|
233
|
+
------ | ------ |
|
|
234
|
+
`configuration?` | [Configuration](classes/configuration.md) |
|
|
235
|
+
|
|
236
|
+
**Returns:** *object*
|
|
237
|
+
|
|
238
|
+
* **appsIndex**(`xRHIDENTITY`: string, `options?`: any): *function*
|
|
239
|
+
|
|
240
|
+
* (`axios?`: AxiosInstance, `basePath?`: string): *AxiosPromise‹[InlineResponse200](interfaces/inlineresponse200.md)›*
|
|
241
|
+
|
|
242
|
+
* **appsShow**(`xRHIDENTITY`: string, `id`: number, `options?`: any): *function*
|
|
243
|
+
|
|
244
|
+
* (`axios?`: AxiosInstance, `basePath?`: string): *AxiosPromise‹[InlineResponse2002](interfaces/inlineresponse2002.md)›*
|
|
245
|
+
|
|
246
|
+
___
|
|
247
|
+
|
|
248
|
+
### `Const` EndpointsApiAxiosParamCreator
|
|
249
|
+
|
|
250
|
+
▸ **EndpointsApiAxiosParamCreator**(`configuration?`: [Configuration](classes/configuration.md)): *object*
|
|
251
|
+
|
|
252
|
+
*Defined in [packages/hooks/api.ts:1182](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1182)*
|
|
253
|
+
|
|
254
|
+
EndpointsApi - axios parameter creator
|
|
255
|
+
|
|
256
|
+
**`export`**
|
|
257
|
+
|
|
258
|
+
**Parameters:**
|
|
259
|
+
|
|
260
|
+
Name | Type |
|
|
261
|
+
------ | ------ |
|
|
262
|
+
`configuration?` | [Configuration](classes/configuration.md) |
|
|
263
|
+
|
|
264
|
+
**Returns:** *object*
|
|
265
|
+
|
|
266
|
+
* **endpointsCreate**(`xRHIDENTITY`: string, `inlineObject1`: [InlineObject1](interfaces/inlineobject1.md), `options`: any): *[RequestArgs](interfaces/requestargs.md)*
|
|
267
|
+
|
|
268
|
+
* **endpointsDestroy**(`xRHIDENTITY`: string, `id`: number, `options`: any): *[RequestArgs](interfaces/requestargs.md)*
|
|
269
|
+
|
|
270
|
+
* **endpointsIndex**(`xRHIDENTITY`: string, `order?`: string, `offset?`: number, `limit?`: number, `options`: any): *[RequestArgs](interfaces/requestargs.md)*
|
|
271
|
+
|
|
272
|
+
* **endpointsShow**(`xRHIDENTITY`: string, `id`: number, `options`: any): *[RequestArgs](interfaces/requestargs.md)*
|
|
273
|
+
|
|
274
|
+
* **endpointsTest**(`xRHIDENTITY`: string, `id`: number, `options`: any): *[RequestArgs](interfaces/requestargs.md)*
|
|
275
|
+
|
|
276
|
+
* **endpointsUpdate**(`xRHIDENTITY`: string, `id`: number, `inlineObject2`: [InlineObject2](interfaces/inlineobject2.md), `options`: any): *[RequestArgs](interfaces/requestargs.md)*
|
|
277
|
+
|
|
278
|
+
___
|
|
279
|
+
|
|
280
|
+
### `Const` EndpointsApiFactory
|
|
281
|
+
|
|
282
|
+
▸ **EndpointsApiFactory**(`configuration?`: [Configuration](classes/configuration.md), `basePath?`: string, `axios?`: AxiosInstance): *object*
|
|
283
|
+
|
|
284
|
+
*Defined in [packages/hooks/api.ts:1572](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1572)*
|
|
285
|
+
|
|
286
|
+
EndpointsApi - factory interface
|
|
287
|
+
|
|
288
|
+
**`export`**
|
|
289
|
+
|
|
290
|
+
**Parameters:**
|
|
291
|
+
|
|
292
|
+
Name | Type |
|
|
293
|
+
------ | ------ |
|
|
294
|
+
`configuration?` | [Configuration](classes/configuration.md) |
|
|
295
|
+
`basePath?` | string |
|
|
296
|
+
`axios?` | AxiosInstance |
|
|
297
|
+
|
|
298
|
+
**Returns:** *object*
|
|
299
|
+
|
|
300
|
+
* **endpointsCreate**(`xRHIDENTITY`: string, `inlineObject1`: [InlineObject1](interfaces/inlineobject1.md), `options?`: any): *AxiosPromise‹[InlineResponse201](interfaces/inlineresponse201.md)›*
|
|
301
|
+
|
|
302
|
+
* **endpointsDestroy**(`xRHIDENTITY`: string, `id`: number, `options?`: any): *AxiosPromise‹void›*
|
|
303
|
+
|
|
304
|
+
* **endpointsIndex**(`xRHIDENTITY`: string, `order?`: string, `offset?`: number, `limit?`: number, `options?`: any): *AxiosPromise‹[InlineResponse2003](interfaces/inlineresponse2003.md)›*
|
|
305
|
+
|
|
306
|
+
* **endpointsShow**(`xRHIDENTITY`: string, `id`: number, `options?`: any): *AxiosPromise‹[InlineResponse201](interfaces/inlineresponse201.md)›*
|
|
307
|
+
|
|
308
|
+
* **endpointsTest**(`xRHIDENTITY`: string, `id`: number, `options?`: any): *AxiosPromise‹void›*
|
|
309
|
+
|
|
310
|
+
* **endpointsUpdate**(`xRHIDENTITY`: string, `id`: number, `inlineObject2`: [InlineObject2](interfaces/inlineobject2.md), `options?`: any): *AxiosPromise‹[InlineResponse201](interfaces/inlineresponse201.md)›*
|
|
311
|
+
|
|
312
|
+
___
|
|
313
|
+
|
|
314
|
+
### `Const` EndpointsApiFp
|
|
315
|
+
|
|
316
|
+
▸ **EndpointsApiFp**(`configuration?`: [Configuration](classes/configuration.md)): *object*
|
|
317
|
+
|
|
318
|
+
*Defined in [packages/hooks/api.ts:1476](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1476)*
|
|
319
|
+
|
|
320
|
+
EndpointsApi - functional programming interface
|
|
321
|
+
|
|
322
|
+
**`export`**
|
|
323
|
+
|
|
324
|
+
**Parameters:**
|
|
325
|
+
|
|
326
|
+
Name | Type |
|
|
327
|
+
------ | ------ |
|
|
328
|
+
`configuration?` | [Configuration](classes/configuration.md) |
|
|
329
|
+
|
|
330
|
+
**Returns:** *object*
|
|
331
|
+
|
|
332
|
+
* **endpointsCreate**(`xRHIDENTITY`: string, `inlineObject1`: [InlineObject1](interfaces/inlineobject1.md), `options?`: any): *function*
|
|
333
|
+
|
|
334
|
+
* (`axios?`: AxiosInstance, `basePath?`: string): *AxiosPromise‹[InlineResponse201](interfaces/inlineresponse201.md)›*
|
|
335
|
+
|
|
336
|
+
* **endpointsDestroy**(`xRHIDENTITY`: string, `id`: number, `options?`: any): *function*
|
|
337
|
+
|
|
338
|
+
* (`axios?`: AxiosInstance, `basePath?`: string): *AxiosPromise‹void›*
|
|
339
|
+
|
|
340
|
+
* **endpointsIndex**(`xRHIDENTITY`: string, `order?`: string, `offset?`: number, `limit?`: number, `options?`: any): *function*
|
|
341
|
+
|
|
342
|
+
* (`axios?`: AxiosInstance, `basePath?`: string): *AxiosPromise‹[InlineResponse2003](interfaces/inlineresponse2003.md)›*
|
|
343
|
+
|
|
344
|
+
* **endpointsShow**(`xRHIDENTITY`: string, `id`: number, `options?`: any): *function*
|
|
345
|
+
|
|
346
|
+
* (`axios?`: AxiosInstance, `basePath?`: string): *AxiosPromise‹[InlineResponse201](interfaces/inlineresponse201.md)›*
|
|
347
|
+
|
|
348
|
+
* **endpointsTest**(`xRHIDENTITY`: string, `id`: number, `options?`: any): *function*
|
|
349
|
+
|
|
350
|
+
* (`axios?`: AxiosInstance, `basePath?`: string): *AxiosPromise‹void›*
|
|
351
|
+
|
|
352
|
+
* **endpointsUpdate**(`xRHIDENTITY`: string, `id`: number, `inlineObject2`: [InlineObject2](interfaces/inlineobject2.md), `options?`: any): *function*
|
|
353
|
+
|
|
354
|
+
* (`axios?`: AxiosInstance, `basePath?`: string): *AxiosPromise‹[InlineResponse201](interfaces/inlineresponse201.md)›*
|
|
355
|
+
|
|
356
|
+
___
|
|
357
|
+
|
|
358
|
+
### `Const` FiltersApiAxiosParamCreator
|
|
359
|
+
|
|
360
|
+
▸ **FiltersApiAxiosParamCreator**(`configuration?`: [Configuration](classes/configuration.md)): *object*
|
|
361
|
+
|
|
362
|
+
*Defined in [packages/hooks/api.ts:1729](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1729)*
|
|
363
|
+
|
|
364
|
+
FiltersApi - axios parameter creator
|
|
365
|
+
|
|
366
|
+
**`export`**
|
|
367
|
+
|
|
368
|
+
**Parameters:**
|
|
369
|
+
|
|
370
|
+
Name | Type |
|
|
371
|
+
------ | ------ |
|
|
372
|
+
`configuration?` | [Configuration](classes/configuration.md) |
|
|
373
|
+
|
|
374
|
+
**Returns:** *object*
|
|
375
|
+
|
|
376
|
+
* **filtersShow**(`xRHIDENTITY`: string, `endpointId`: number, `options`: any): *[RequestArgs](interfaces/requestargs.md)*
|
|
377
|
+
|
|
378
|
+
___
|
|
379
|
+
|
|
380
|
+
### `Const` FiltersApiFactory
|
|
381
|
+
|
|
382
|
+
▸ **FiltersApiFactory**(`configuration?`: [Configuration](classes/configuration.md), `basePath?`: string, `axios?`: AxiosInstance): *object*
|
|
383
|
+
|
|
384
|
+
*Defined in [packages/hooks/api.ts:1805](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1805)*
|
|
385
|
+
|
|
386
|
+
FiltersApi - factory interface
|
|
387
|
+
|
|
388
|
+
**`export`**
|
|
389
|
+
|
|
390
|
+
**Parameters:**
|
|
391
|
+
|
|
392
|
+
Name | Type |
|
|
393
|
+
------ | ------ |
|
|
394
|
+
`configuration?` | [Configuration](classes/configuration.md) |
|
|
395
|
+
`basePath?` | string |
|
|
396
|
+
`axios?` | AxiosInstance |
|
|
397
|
+
|
|
398
|
+
**Returns:** *object*
|
|
399
|
+
|
|
400
|
+
* **filtersShow**(`xRHIDENTITY`: string, `endpointId`: number, `options?`: any): *AxiosPromise‹[InlineResponse2004](interfaces/inlineresponse2004.md)›*
|
|
401
|
+
|
|
402
|
+
___
|
|
403
|
+
|
|
404
|
+
### `Const` FiltersApiFp
|
|
405
|
+
|
|
406
|
+
▸ **FiltersApiFp**(`configuration?`: [Configuration](classes/configuration.md)): *object*
|
|
407
|
+
|
|
408
|
+
*Defined in [packages/hooks/api.ts:1782](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1782)*
|
|
409
|
+
|
|
410
|
+
FiltersApi - functional programming interface
|
|
411
|
+
|
|
412
|
+
**`export`**
|
|
413
|
+
|
|
414
|
+
**Parameters:**
|
|
415
|
+
|
|
416
|
+
Name | Type |
|
|
417
|
+
------ | ------ |
|
|
418
|
+
`configuration?` | [Configuration](classes/configuration.md) |
|
|
419
|
+
|
|
420
|
+
**Returns:** *object*
|
|
421
|
+
|
|
422
|
+
* **filtersShow**(`xRHIDENTITY`: string, `endpointId`: number, `options?`: any): *function*
|
|
423
|
+
|
|
424
|
+
* (`axios?`: AxiosInstance, `basePath?`: string): *AxiosPromise‹[InlineResponse2004](interfaces/inlineresponse2004.md)›*
|
|
425
|
+
|
|
426
|
+
## Object literals
|
|
427
|
+
|
|
428
|
+
### `Const` COLLECTION_FORMATS
|
|
429
|
+
|
|
430
|
+
### ▪ **COLLECTION_FORMATS**: *object*
|
|
431
|
+
|
|
432
|
+
Defined in packages/hooks/base.ts:26
|
|
433
|
+
|
|
434
|
+
**`export`**
|
|
435
|
+
|
|
436
|
+
### csv
|
|
437
|
+
|
|
438
|
+
• **csv**: *string* = ","
|
|
439
|
+
|
|
440
|
+
Defined in packages/hooks/base.ts:27
|
|
441
|
+
|
|
442
|
+
### pipes
|
|
443
|
+
|
|
444
|
+
• **pipes**: *string* = "|"
|
|
445
|
+
|
|
446
|
+
Defined in packages/hooks/base.ts:30
|
|
447
|
+
|
|
448
|
+
### ssv
|
|
449
|
+
|
|
450
|
+
• **ssv**: *string* = " "
|
|
451
|
+
|
|
452
|
+
Defined in packages/hooks/base.ts:28
|
|
453
|
+
|
|
454
|
+
### tsv
|
|
455
|
+
|
|
456
|
+
• **tsv**: *string* = " "
|
|
457
|
+
|
|
458
|
+
Defined in packages/hooks/base.ts:29
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [App](app.md)
|
|
2
|
+
|
|
3
|
+
# Interface: App
|
|
4
|
+
|
|
5
|
+
Application object properties
|
|
6
|
+
|
|
7
|
+
**`export`**
|
|
8
|
+
|
|
9
|
+
**`interface`** App
|
|
10
|
+
|
|
11
|
+
## Hierarchy
|
|
12
|
+
|
|
13
|
+
* **App**
|
|
14
|
+
|
|
15
|
+
## Index
|
|
16
|
+
|
|
17
|
+
### Properties
|
|
18
|
+
|
|
19
|
+
* [attributes](app.md#optional-attributes)
|
|
20
|
+
* [id](app.md#optional-id)
|
|
21
|
+
* [relationships](app.md#optional-relationships)
|
|
22
|
+
* [type](app.md#optional-type)
|
|
23
|
+
|
|
24
|
+
## Properties
|
|
25
|
+
|
|
26
|
+
### `Optional` attributes
|
|
27
|
+
|
|
28
|
+
• **attributes**? : *[AppAttributes](appattributes.md)*
|
|
29
|
+
|
|
30
|
+
*Defined in [packages/hooks/api.ts:45](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L45)*
|
|
31
|
+
|
|
32
|
+
**`memberof`** App
|
|
33
|
+
|
|
34
|
+
___
|
|
35
|
+
|
|
36
|
+
### `Optional` id
|
|
37
|
+
|
|
38
|
+
• **id**? : *string*
|
|
39
|
+
|
|
40
|
+
*Defined in [packages/hooks/api.ts:33](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L33)*
|
|
41
|
+
|
|
42
|
+
Identifier of the application
|
|
43
|
+
|
|
44
|
+
**`memberof`** App
|
|
45
|
+
|
|
46
|
+
___
|
|
47
|
+
|
|
48
|
+
### `Optional` relationships
|
|
49
|
+
|
|
50
|
+
• **relationships**? : *[AppRelationships](apprelationships.md)*
|
|
51
|
+
|
|
52
|
+
*Defined in [packages/hooks/api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L51)*
|
|
53
|
+
|
|
54
|
+
**`memberof`** App
|
|
55
|
+
|
|
56
|
+
___
|
|
57
|
+
|
|
58
|
+
### `Optional` type
|
|
59
|
+
|
|
60
|
+
• **type**? : *[AppTypeEnum](../enums/apptypeenum.md)*
|
|
61
|
+
|
|
62
|
+
*Defined in [packages/hooks/api.ts:39](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L39)*
|
|
63
|
+
|
|
64
|
+
Type of the returned record
|
|
65
|
+
|
|
66
|
+
**`memberof`** App
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [AppAttributes](appattributes.md)
|
|
2
|
+
|
|
3
|
+
# Interface: AppAttributes
|
|
4
|
+
|
|
5
|
+
**`export`**
|
|
6
|
+
|
|
7
|
+
**`interface`** AppAttributes
|
|
8
|
+
|
|
9
|
+
## Hierarchy
|
|
10
|
+
|
|
11
|
+
* **AppAttributes**
|
|
12
|
+
|
|
13
|
+
## Index
|
|
14
|
+
|
|
15
|
+
### Properties
|
|
16
|
+
|
|
17
|
+
* [name](appattributes.md#optional-name)
|
|
18
|
+
* [title](appattributes.md#optional-title)
|
|
19
|
+
|
|
20
|
+
## Properties
|
|
21
|
+
|
|
22
|
+
### `Optional` name
|
|
23
|
+
|
|
24
|
+
• **name**? : *string*
|
|
25
|
+
|
|
26
|
+
*Defined in [packages/hooks/api.ts:73](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L73)*
|
|
27
|
+
|
|
28
|
+
Name of the application, used to identify the sender in messages
|
|
29
|
+
|
|
30
|
+
**`memberof`** AppAttributes
|
|
31
|
+
|
|
32
|
+
___
|
|
33
|
+
|
|
34
|
+
### `Optional` title
|
|
35
|
+
|
|
36
|
+
• **title**? : *string*
|
|
37
|
+
|
|
38
|
+
*Defined in [packages/hooks/api.ts:79](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L79)*
|
|
39
|
+
|
|
40
|
+
Title of the application, shown to the user when configuring filters
|
|
41
|
+
|
|
42
|
+
**`memberof`** AppAttributes
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [AppRelationships](apprelationships.md)
|
|
2
|
+
|
|
3
|
+
# Interface: AppRelationships
|
|
4
|
+
|
|
5
|
+
**`export`**
|
|
6
|
+
|
|
7
|
+
**`interface`** AppRelationships
|
|
8
|
+
|
|
9
|
+
## Hierarchy
|
|
10
|
+
|
|
11
|
+
* **AppRelationships**
|
|
12
|
+
|
|
13
|
+
## Index
|
|
14
|
+
|
|
15
|
+
### Properties
|
|
16
|
+
|
|
17
|
+
* [event_types](apprelationships.md#optional-event_types)
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### `Optional` event_types
|
|
22
|
+
|
|
23
|
+
• **event_types**? : *[Relationships](relationships.md)*
|
|
24
|
+
|
|
25
|
+
*Defined in [packages/hooks/api.ts:92](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L92)*
|
|
26
|
+
|
|
27
|
+
**`memberof`** AppRelationships
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [AppsRegisterApplication](appsregisterapplication.md)
|
|
2
|
+
|
|
3
|
+
# Interface: AppsRegisterApplication
|
|
4
|
+
|
|
5
|
+
**`export`**
|
|
6
|
+
|
|
7
|
+
**`interface`** AppsRegisterApplication
|
|
8
|
+
|
|
9
|
+
## Hierarchy
|
|
10
|
+
|
|
11
|
+
* **AppsRegisterApplication**
|
|
12
|
+
|
|
13
|
+
## Index
|
|
14
|
+
|
|
15
|
+
### Properties
|
|
16
|
+
|
|
17
|
+
* [name](appsregisterapplication.md#optional-name)
|
|
18
|
+
* [title](appsregisterapplication.md#optional-title)
|
|
19
|
+
|
|
20
|
+
## Properties
|
|
21
|
+
|
|
22
|
+
### `Optional` name
|
|
23
|
+
|
|
24
|
+
• **name**? : *string*
|
|
25
|
+
|
|
26
|
+
*Defined in [packages/hooks/api.ts:105](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L105)*
|
|
27
|
+
|
|
28
|
+
**`memberof`** AppsRegisterApplication
|
|
29
|
+
|
|
30
|
+
___
|
|
31
|
+
|
|
32
|
+
### `Optional` title
|
|
33
|
+
|
|
34
|
+
• **title**? : *string*
|
|
35
|
+
|
|
36
|
+
*Defined in [packages/hooks/api.ts:111](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L111)*
|
|
37
|
+
|
|
38
|
+
**`memberof`** AppsRegisterApplication
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
[@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [AppsRegisterEventTypes](appsregistereventtypes.md)
|
|
2
|
+
|
|
3
|
+
# Interface: AppsRegisterEventTypes
|
|
4
|
+
|
|
5
|
+
**`export`**
|
|
6
|
+
|
|
7
|
+
**`interface`** AppsRegisterEventTypes
|
|
8
|
+
|
|
9
|
+
## Hierarchy
|
|
10
|
+
|
|
11
|
+
* **AppsRegisterEventTypes**
|
|
12
|
+
|
|
13
|
+
## Index
|
|
14
|
+
|
|
15
|
+
### Properties
|
|
16
|
+
|
|
17
|
+
* [id](appsregistereventtypes.md#optional-id)
|
|
18
|
+
* [levels](appsregistereventtypes.md#optional-levels)
|
|
19
|
+
* [title](appsregistereventtypes.md#optional-title)
|
|
20
|
+
|
|
21
|
+
## Properties
|
|
22
|
+
|
|
23
|
+
### `Optional` id
|
|
24
|
+
|
|
25
|
+
• **id**? : *number | string*
|
|
26
|
+
|
|
27
|
+
*Defined in [packages/hooks/api.ts:124](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L124)*
|
|
28
|
+
|
|
29
|
+
**`memberof`** AppsRegisterEventTypes
|
|
30
|
+
|
|
31
|
+
___
|
|
32
|
+
|
|
33
|
+
### `Optional` levels
|
|
34
|
+
|
|
35
|
+
• **levels**? : *[AppsRegisterEventTypesLevels](appsregistereventtypeslevels.md)*
|
|
36
|
+
|
|
37
|
+
*Defined in [packages/hooks/api.ts:136](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L136)*
|
|
38
|
+
|
|
39
|
+
**`memberof`** AppsRegisterEventTypes
|
|
40
|
+
|
|
41
|
+
___
|
|
42
|
+
|
|
43
|
+
### `Optional` title
|
|
44
|
+
|
|
45
|
+
• **title**? : *string*
|
|
46
|
+
|
|
47
|
+
*Defined in [packages/hooks/api.ts:130](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L130)*
|
|
48
|
+
|
|
49
|
+
**`memberof`** AppsRegisterEventTypes
|