@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.
Files changed (57) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +59 -0
  3. package/doc/README.md +63 -0
  4. package/doc/classes/appregistrationapi.md +102 -0
  5. package/doc/classes/appsapi.md +127 -0
  6. package/doc/classes/baseapi.md +71 -0
  7. package/doc/classes/configuration.md +116 -0
  8. package/doc/classes/endpointsapi.md +229 -0
  9. package/doc/classes/filtersapi.md +103 -0
  10. package/doc/classes/requirederror.md +88 -0
  11. package/doc/enums/apptypeenum.md +19 -0
  12. package/doc/enums/endpointattributeslastdeliverystatusenum.md +28 -0
  13. package/doc/enums/endpointtypeenum.md +19 -0
  14. package/doc/enums/eventtypetypeenum.md +19 -0
  15. package/doc/enums/inlineresponse2004datatypeenum.md +19 -0
  16. package/doc/enums/leveltypeenum.md +19 -0
  17. package/doc/globals.md +458 -0
  18. package/doc/interfaces/app.md +66 -0
  19. package/doc/interfaces/appattributes.md +42 -0
  20. package/doc/interfaces/apprelationships.md +27 -0
  21. package/doc/interfaces/appsregisterapplication.md +38 -0
  22. package/doc/interfaces/appsregistereventtypes.md +49 -0
  23. package/doc/interfaces/appsregistereventtypeslevels.md +38 -0
  24. package/doc/interfaces/configurationparameters.md +75 -0
  25. package/doc/interfaces/endpoint.md +53 -0
  26. package/doc/interfaces/endpointattributes.md +94 -0
  27. package/doc/interfaces/endpointsendpoint.md +60 -0
  28. package/doc/interfaces/endpointsendpointfilter.md +49 -0
  29. package/doc/interfaces/endpointsidendpoint.md +60 -0
  30. package/doc/interfaces/endpointsidendpointfilter.md +60 -0
  31. package/doc/interfaces/errors.md +27 -0
  32. package/doc/interfaces/errorserrors.md +93 -0
  33. package/doc/interfaces/errorssource.md +38 -0
  34. package/doc/interfaces/eventtype.md +66 -0
  35. package/doc/interfaces/eventtypeattributes.md +42 -0
  36. package/doc/interfaces/eventtyperelationships.md +27 -0
  37. package/doc/interfaces/inlineobject.md +38 -0
  38. package/doc/interfaces/inlineobject1.md +27 -0
  39. package/doc/interfaces/inlineobject2.md +27 -0
  40. package/doc/interfaces/inlineresponse200.md +38 -0
  41. package/doc/interfaces/inlineresponse2001.md +27 -0
  42. package/doc/interfaces/inlineresponse2002.md +38 -0
  43. package/doc/interfaces/inlineresponse2003.md +49 -0
  44. package/doc/interfaces/inlineresponse2004.md +27 -0
  45. package/doc/interfaces/inlineresponse2004data.md +60 -0
  46. package/doc/interfaces/inlineresponse2004dataattributes.md +27 -0
  47. package/doc/interfaces/inlineresponse2004datarelationships.md +60 -0
  48. package/doc/interfaces/inlineresponse201.md +27 -0
  49. package/doc/interfaces/level.md +55 -0
  50. package/doc/interfaces/levelattributes.md +29 -0
  51. package/doc/interfaces/links.md +68 -0
  52. package/doc/interfaces/metadata.md +55 -0
  53. package/doc/interfaces/relationship.md +38 -0
  54. package/doc/interfaces/relationships.md +27 -0
  55. package/doc/interfaces/requestargs.md +34 -0
  56. package/package.json +34 -0
  57. package/postProcess.sh +12 -0
@@ -0,0 +1,68 @@
1
+ [@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [Links](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#optional-first)
18
+ * [last](links.md#optional-last)
19
+ * [next](links.md#optional-next)
20
+ * [previous](links.md#optional-previous)
21
+
22
+ ## Properties
23
+
24
+ ### `Optional` first
25
+
26
+ • **first**? : *string*
27
+
28
+ *Defined in [packages/hooks/api.ts:804](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L804)*
29
+
30
+ Link to the first page of records
31
+
32
+ **`memberof`** Links
33
+
34
+ ___
35
+
36
+ ### `Optional` last
37
+
38
+ • **last**? : *string*
39
+
40
+ *Defined in [packages/hooks/api.ts:810](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L810)*
41
+
42
+ Link to the last page of records
43
+
44
+ **`memberof`** Links
45
+
46
+ ___
47
+
48
+ ### `Optional` next
49
+
50
+ • **next**? : *string*
51
+
52
+ *Defined in [packages/hooks/api.ts:822](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L822)*
53
+
54
+ Link to next page of records, if such page exists
55
+
56
+ **`memberof`** Links
57
+
58
+ ___
59
+
60
+ ### `Optional` previous
61
+
62
+ • **previous**? : *string*
63
+
64
+ *Defined in [packages/hooks/api.ts:816](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L816)*
65
+
66
+ Link to previous page of records, if such page exists
67
+
68
+ **`memberof`** Links
@@ -0,0 +1,55 @@
1
+ [@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [Metadata](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#optional-limit)
18
+ * [offset](metadata.md#optional-offset)
19
+ * [total](metadata.md#optional-total)
20
+
21
+ ## Properties
22
+
23
+ ### `Optional` limit
24
+
25
+ • **limit**? : *number*
26
+
27
+ *Defined in [packages/hooks/api.ts:841](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L841)*
28
+
29
+ The maximum number of records to return.
30
+
31
+ **`memberof`** Metadata
32
+
33
+ ___
34
+
35
+ ### `Optional` offset
36
+
37
+ • **offset**? : *number*
38
+
39
+ *Defined in [packages/hooks/api.ts:847](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L847)*
40
+
41
+ The number of records to skip before returning.
42
+
43
+ **`memberof`** Metadata
44
+
45
+ ___
46
+
47
+ ### `Optional` total
48
+
49
+ • **total**? : *number*
50
+
51
+ *Defined in [packages/hooks/api.ts:835](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L835)*
52
+
53
+ The total number of available records.
54
+
55
+ **`memberof`** Metadata
@@ -0,0 +1,38 @@
1
+ [@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [Relationship](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#optional-id)
18
+ * [type](relationship.md#optional-type)
19
+
20
+ ## Properties
21
+
22
+ ### `Optional` id
23
+
24
+ • **id**? : *string*
25
+
26
+ *Defined in [packages/hooks/api.ts:860](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L860)*
27
+
28
+ **`memberof`** Relationship
29
+
30
+ ___
31
+
32
+ ### `Optional` type
33
+
34
+ • **type**? : *string*
35
+
36
+ *Defined in [packages/hooks/api.ts:866](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L866)*
37
+
38
+ **`memberof`** Relationship
@@ -0,0 +1,27 @@
1
+ [@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [Relationships](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#optional-data)
18
+
19
+ ## Properties
20
+
21
+ ### `Optional` data
22
+
23
+ • **data**? : *Array‹[Relationship](relationship.md)›*
24
+
25
+ *Defined in [packages/hooks/api.ts:879](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L879)*
26
+
27
+ **`memberof`** Relationships
@@ -0,0 +1,34 @@
1
+ [@redhat-cloud-services/notifications-client](../README.md) › [Globals](../globals.md) › [RequestArgs](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
+ ## Properties
21
+
22
+ ### options
23
+
24
+ • **options**: *any*
25
+
26
+ Defined in packages/hooks/base.ts:40
27
+
28
+ ___
29
+
30
+ ### url
31
+
32
+ • **url**: *string*
33
+
34
+ Defined in packages/hooks/base.ts:39
package/package.json ADDED
@@ -0,0 +1,34 @@
1
+ {
2
+ "name": "@redhat-cloud-services/notifications-client",
3
+ "version": "1.0.102",
4
+ "description": "",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "publishConfig": {
8
+ "access": "public"
9
+ },
10
+ "repository": {
11
+ "type": "git",
12
+ "url": "git+https://github.com/RedHatInsights/javascript-clients.git"
13
+ },
14
+ "author": "",
15
+ "license": "Apache-2.0",
16
+ "bugs": {
17
+ "url": "https://github.com/RedHatInsights/javascript-clients/issues"
18
+ },
19
+ "homepage": "https://github.com/RedHatInsights/javascript-clients/tree/master/packages/notifications#readme",
20
+ "scripts": {
21
+ "doc": "typedoc --theme markdown --out doc --module commonjs --mode file --gitRevision master",
22
+ "build": "tsc",
23
+ "generate": "TS_POST_PROCESS_FILE='./postProcess.sh' openapi-generator-cli generate -i $SPEC -g typescript-axios -o . --skip-validate-spec --enable-post-process-file",
24
+ "generate:prod": "SPEC='https://cloud.redhat.com/api/hooks/v1/openapi.json' npm run generate"
25
+ },
26
+ "dependencies": {
27
+ "axios": "^0.21.1"
28
+ },
29
+ "devDependencies": {
30
+ "@types/node": "^13.11.1",
31
+ "typedoc": "^0.17.4",
32
+ "typedoc-plugin-markdown": "^2.2.17"
33
+ }
34
+ }
package/postProcess.sh ADDED
@@ -0,0 +1,12 @@
1
+
2
+ #!/bin/sh
3
+
4
+ # remove trailing whitespace
5
+ sed 's/\s*$//' -i $1
6
+
7
+ # https://github.com/OpenAPITools/openapi-generator/issues/2154
8
+ sed 's/OneOfResolutionsboolean/Resolutions \| boolean/' -i $1
9
+ sed 's/OneOf[a-zA-Z]*/Object/' -i $1
10
+ # generator warnings https://github.com/OpenAPITools/openapi-generator/issues/1714
11
+ echo '
12
+ interface Url {}' >> ./custom.d.ts