@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
package/git_push.sh
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
|
|
3
|
+
#
|
|
4
|
+
# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
|
|
5
|
+
|
|
6
|
+
git_user_id=$1
|
|
7
|
+
git_repo_id=$2
|
|
8
|
+
release_note=$3
|
|
9
|
+
git_host=$4
|
|
10
|
+
|
|
11
|
+
if [ "$git_host" = "" ]; then
|
|
12
|
+
git_host="github.com"
|
|
13
|
+
echo "[INFO] No command line input provided. Set \$git_host to $git_host"
|
|
14
|
+
fi
|
|
15
|
+
|
|
16
|
+
if [ "$git_user_id" = "" ]; then
|
|
17
|
+
git_user_id="GIT_USER_ID"
|
|
18
|
+
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
|
|
19
|
+
fi
|
|
20
|
+
|
|
21
|
+
if [ "$git_repo_id" = "" ]; then
|
|
22
|
+
git_repo_id="GIT_REPO_ID"
|
|
23
|
+
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
|
|
24
|
+
fi
|
|
25
|
+
|
|
26
|
+
if [ "$release_note" = "" ]; then
|
|
27
|
+
release_note="Minor update"
|
|
28
|
+
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
|
|
29
|
+
fi
|
|
30
|
+
|
|
31
|
+
# Initialize the local directory as a Git repository
|
|
32
|
+
git init
|
|
33
|
+
|
|
34
|
+
# Adds the files in the local repository and stages them for commit.
|
|
35
|
+
git add .
|
|
36
|
+
|
|
37
|
+
# Commits the tracked changes and prepares them to be pushed to a remote repository.
|
|
38
|
+
git commit -m "$release_note"
|
|
39
|
+
|
|
40
|
+
# Sets the new remote
|
|
41
|
+
git_remote=$(git remote)
|
|
42
|
+
if [ "$git_remote" = "" ]; then # git remote not defined
|
|
43
|
+
|
|
44
|
+
if [ "$GIT_TOKEN" = "" ]; then
|
|
45
|
+
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
|
|
46
|
+
git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
|
|
47
|
+
else
|
|
48
|
+
git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
|
|
49
|
+
fi
|
|
50
|
+
|
|
51
|
+
fi
|
|
52
|
+
|
|
53
|
+
git pull origin master
|
|
54
|
+
|
|
55
|
+
# Pushes (Forces) the changes in the local repository up to the remote repository
|
|
56
|
+
echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
|
|
57
|
+
git push origin master 2>&1 | grep -v 'To https'
|
package/package.json
CHANGED
|
@@ -1,34 +1,29 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@redhat-cloud-services/notifications-client",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "",
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
"@types/node": "^12.6.3",
|
|
31
|
-
"typedoc": "^0.15.2",
|
|
32
|
-
"typedoc-plugin-markdown": "^1.1.27"
|
|
33
|
-
}
|
|
34
|
-
}
|
|
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#readme",
|
|
20
|
+
"scripts": {
|
|
21
|
+
"doc": "typedoc --theme markdown --out doc --gitRevision master index.ts",
|
|
22
|
+
"build": "tsc",
|
|
23
|
+
"generate": "TS_POST_PROCESS_FILE='../../postProcess.sh' openapi-generator-cli generate -i $SPEC --custom-generator=../../target/typescript-axios-webpack-module-federation-openapi-generator-1.0.0.jar -g typescript-axios-webpack-module-federation -o . --skip-validate-spec --enable-post-process-file",
|
|
24
|
+
"generate:prod": "SPEC='https://console.redhat.com/api/notifications/v1.0/openapi.json' npm run generate"
|
|
25
|
+
},
|
|
26
|
+
"dependencies": {
|
|
27
|
+
"axios": "^0.27.2"
|
|
28
|
+
}
|
|
29
|
+
}
|
package/postProcess.sh
CHANGED
|
@@ -1,12 +1,4 @@
|
|
|
1
|
+
#!/bin/bash
|
|
1
2
|
|
|
2
|
-
|
|
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
|
|
3
|
+
sed -i.bak 's/AnyType/any/g' api.ts
|
|
4
|
+
rm api.ts.bak
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"declaration": true,
|
|
4
|
+
"target": "es5",
|
|
5
|
+
"module": "commonjs",
|
|
6
|
+
"noImplicitAny": true,
|
|
7
|
+
"outDir": ".",
|
|
8
|
+
"rootDir": ".",
|
|
9
|
+
"lib": [
|
|
10
|
+
"es2017",
|
|
11
|
+
"dom"
|
|
12
|
+
]
|
|
13
|
+
},
|
|
14
|
+
"exclude": [
|
|
15
|
+
"dist",
|
|
16
|
+
"node_modules",
|
|
17
|
+
"*.d.ts"
|
|
18
|
+
]
|
|
19
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"target": "es2021",
|
|
4
|
+
"module": "esnext",
|
|
5
|
+
"moduleResolution": "node",
|
|
6
|
+
"declaration": true,
|
|
7
|
+
"declarationMap": true,
|
|
8
|
+
"noImplicitAny": true,
|
|
9
|
+
"outDir": "esm",
|
|
10
|
+
"rootDir": ".",
|
|
11
|
+
"lib": [
|
|
12
|
+
"es2017",
|
|
13
|
+
"dom"
|
|
14
|
+
]
|
|
15
|
+
},
|
|
16
|
+
"exclude": [
|
|
17
|
+
"dist",
|
|
18
|
+
"node_modules",
|
|
19
|
+
"*.d.ts"
|
|
20
|
+
]
|
|
21
|
+
}
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"declaration": true,
|
|
4
|
+
"target": "es5",
|
|
5
|
+
"module": "commonjs",
|
|
6
|
+
"noImplicitAny": true,
|
|
7
|
+
"outDir": "dist",
|
|
8
|
+
"rootDir": ".",
|
|
9
|
+
"lib": [
|
|
10
|
+
"es6",
|
|
11
|
+
"dom"
|
|
12
|
+
]
|
|
13
|
+
},
|
|
14
|
+
"exclude": [
|
|
15
|
+
"dist",
|
|
16
|
+
"node_modules"
|
|
17
|
+
]
|
|
18
|
+
}
|
|
@@ -1,123 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [AppRegistrationApi](../classes/appregistrationapi.md)
|
|
2
|
-
|
|
3
|
-
# Class: AppRegistrationApi
|
|
4
|
-
|
|
5
|
-
AppRegistrationApi - object-oriented interface
|
|
6
|
-
|
|
7
|
-
*__export__*:
|
|
8
|
-
|
|
9
|
-
*__class__*: AppRegistrationApi
|
|
10
|
-
|
|
11
|
-
*__extends__*: {BaseAPI}
|
|
12
|
-
|
|
13
|
-
## Hierarchy
|
|
14
|
-
|
|
15
|
-
[BaseAPI](baseapi.md)
|
|
16
|
-
|
|
17
|
-
**↳ AppRegistrationApi**
|
|
18
|
-
|
|
19
|
-
## Index
|
|
20
|
-
|
|
21
|
-
### Constructors
|
|
22
|
-
|
|
23
|
-
* [constructor](appregistrationapi.md#constructor)
|
|
24
|
-
|
|
25
|
-
### Properties
|
|
26
|
-
|
|
27
|
-
* [axios](appregistrationapi.md#axios)
|
|
28
|
-
* [basePath](appregistrationapi.md#basepath)
|
|
29
|
-
* [configuration](appregistrationapi.md#configuration)
|
|
30
|
-
|
|
31
|
-
### Methods
|
|
32
|
-
|
|
33
|
-
* [appRegistrationCreate](appregistrationapi.md#appregistrationcreate)
|
|
34
|
-
|
|
35
|
-
---
|
|
36
|
-
|
|
37
|
-
## Constructors
|
|
38
|
-
|
|
39
|
-
<a id="constructor"></a>
|
|
40
|
-
|
|
41
|
-
### constructor
|
|
42
|
-
|
|
43
|
-
⊕ **new AppRegistrationApi**(configuration?: *[Configuration](configuration.md)*, basePath?: *`string`*, axios?: *`AxiosInstance`*): [AppRegistrationApi](appregistrationapi.md)
|
|
44
|
-
|
|
45
|
-
*Inherited from [BaseAPI](baseapi.md).[constructor](baseapi.md#constructor)*
|
|
46
|
-
|
|
47
|
-
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L49)*
|
|
48
|
-
|
|
49
|
-
**Parameters:**
|
|
50
|
-
|
|
51
|
-
| Name | Type | Default value |
|
|
52
|
-
| ------ | ------ | ------ |
|
|
53
|
-
| `Optional` configuration | [Configuration](configuration.md) | - |
|
|
54
|
-
| `Default value` basePath | `string` | BASE_PATH |
|
|
55
|
-
| `Default value` axios | `AxiosInstance` | globalAxios |
|
|
56
|
-
|
|
57
|
-
**Returns:** [AppRegistrationApi](appregistrationapi.md)
|
|
58
|
-
|
|
59
|
-
___
|
|
60
|
-
|
|
61
|
-
## Properties
|
|
62
|
-
|
|
63
|
-
<a id="axios"></a>
|
|
64
|
-
|
|
65
|
-
### `<Protected>` axios
|
|
66
|
-
|
|
67
|
-
**● axios**: *`AxiosInstance`*
|
|
68
|
-
|
|
69
|
-
*Inherited from [BaseAPI](baseapi.md).[axios](baseapi.md#axios)*
|
|
70
|
-
|
|
71
|
-
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L51)*
|
|
72
|
-
|
|
73
|
-
___
|
|
74
|
-
<a id="basepath"></a>
|
|
75
|
-
|
|
76
|
-
### `<Protected>` basePath
|
|
77
|
-
|
|
78
|
-
**● basePath**: *`string`*
|
|
79
|
-
|
|
80
|
-
*Inherited from [BaseAPI](baseapi.md).[basePath](baseapi.md#basepath)*
|
|
81
|
-
|
|
82
|
-
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L51)*
|
|
83
|
-
|
|
84
|
-
___
|
|
85
|
-
<a id="configuration"></a>
|
|
86
|
-
|
|
87
|
-
### `<Protected>` configuration
|
|
88
|
-
|
|
89
|
-
**● configuration**: *[Configuration](configuration.md) \| `undefined`*
|
|
90
|
-
|
|
91
|
-
*Inherited from [BaseAPI](baseapi.md).[configuration](baseapi.md#configuration)*
|
|
92
|
-
|
|
93
|
-
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L49)*
|
|
94
|
-
|
|
95
|
-
___
|
|
96
|
-
|
|
97
|
-
## Methods
|
|
98
|
-
|
|
99
|
-
<a id="appregistrationcreate"></a>
|
|
100
|
-
|
|
101
|
-
### appRegistrationCreate
|
|
102
|
-
|
|
103
|
-
▸ **appRegistrationCreate**(inlineObject: *[InlineObject](../interfaces/inlineobject.md)*, options?: *`any`*): `AxiosPromise`<[InlineResponse2001](../interfaces/inlineresponse2001.md)>
|
|
104
|
-
|
|
105
|
-
*Defined in [api.ts:1096](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1096)*
|
|
106
|
-
|
|
107
|
-
Register an application
|
|
108
|
-
|
|
109
|
-
*__throws__*: {RequiredError}
|
|
110
|
-
|
|
111
|
-
*__memberof__*: AppRegistrationApi
|
|
112
|
-
|
|
113
|
-
**Parameters:**
|
|
114
|
-
|
|
115
|
-
| Name | Type | Description |
|
|
116
|
-
| ------ | ------ | ------ |
|
|
117
|
-
| inlineObject | [InlineObject](../interfaces/inlineobject.md) | \- |
|
|
118
|
-
| `Optional` options | `any` |
|
|
119
|
-
|
|
120
|
-
**Returns:** `AxiosPromise`<[InlineResponse2001](../interfaces/inlineresponse2001.md)>
|
|
121
|
-
|
|
122
|
-
___
|
|
123
|
-
|
package/doc/classes/appsapi.md
DELETED
|
@@ -1,149 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [AppsApi](../classes/appsapi.md)
|
|
2
|
-
|
|
3
|
-
# Class: AppsApi
|
|
4
|
-
|
|
5
|
-
AppsApi - object-oriented interface
|
|
6
|
-
|
|
7
|
-
*__export__*:
|
|
8
|
-
|
|
9
|
-
*__class__*: AppsApi
|
|
10
|
-
|
|
11
|
-
*__extends__*: {BaseAPI}
|
|
12
|
-
|
|
13
|
-
## Hierarchy
|
|
14
|
-
|
|
15
|
-
[BaseAPI](baseapi.md)
|
|
16
|
-
|
|
17
|
-
**↳ AppsApi**
|
|
18
|
-
|
|
19
|
-
## Index
|
|
20
|
-
|
|
21
|
-
### Constructors
|
|
22
|
-
|
|
23
|
-
* [constructor](appsapi.md#constructor)
|
|
24
|
-
|
|
25
|
-
### Properties
|
|
26
|
-
|
|
27
|
-
* [axios](appsapi.md#axios)
|
|
28
|
-
* [basePath](appsapi.md#basepath)
|
|
29
|
-
* [configuration](appsapi.md#configuration)
|
|
30
|
-
|
|
31
|
-
### Methods
|
|
32
|
-
|
|
33
|
-
* [appsIndex](appsapi.md#appsindex)
|
|
34
|
-
* [appsShow](appsapi.md#appsshow)
|
|
35
|
-
|
|
36
|
-
---
|
|
37
|
-
|
|
38
|
-
## Constructors
|
|
39
|
-
|
|
40
|
-
<a id="constructor"></a>
|
|
41
|
-
|
|
42
|
-
### constructor
|
|
43
|
-
|
|
44
|
-
⊕ **new AppsApi**(configuration?: *[Configuration](configuration.md)*, basePath?: *`string`*, axios?: *`AxiosInstance`*): [AppsApi](appsapi.md)
|
|
45
|
-
|
|
46
|
-
*Inherited from [BaseAPI](baseapi.md).[constructor](baseapi.md#constructor)*
|
|
47
|
-
|
|
48
|
-
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L49)*
|
|
49
|
-
|
|
50
|
-
**Parameters:**
|
|
51
|
-
|
|
52
|
-
| Name | Type | Default value |
|
|
53
|
-
| ------ | ------ | ------ |
|
|
54
|
-
| `Optional` configuration | [Configuration](configuration.md) | - |
|
|
55
|
-
| `Default value` basePath | `string` | BASE_PATH |
|
|
56
|
-
| `Default value` axios | `AxiosInstance` | globalAxios |
|
|
57
|
-
|
|
58
|
-
**Returns:** [AppsApi](appsapi.md)
|
|
59
|
-
|
|
60
|
-
___
|
|
61
|
-
|
|
62
|
-
## Properties
|
|
63
|
-
|
|
64
|
-
<a id="axios"></a>
|
|
65
|
-
|
|
66
|
-
### `<Protected>` axios
|
|
67
|
-
|
|
68
|
-
**● axios**: *`AxiosInstance`*
|
|
69
|
-
|
|
70
|
-
*Inherited from [BaseAPI](baseapi.md).[axios](baseapi.md#axios)*
|
|
71
|
-
|
|
72
|
-
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L51)*
|
|
73
|
-
|
|
74
|
-
___
|
|
75
|
-
<a id="basepath"></a>
|
|
76
|
-
|
|
77
|
-
### `<Protected>` basePath
|
|
78
|
-
|
|
79
|
-
**● basePath**: *`string`*
|
|
80
|
-
|
|
81
|
-
*Inherited from [BaseAPI](baseapi.md).[basePath](baseapi.md#basepath)*
|
|
82
|
-
|
|
83
|
-
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L51)*
|
|
84
|
-
|
|
85
|
-
___
|
|
86
|
-
<a id="configuration"></a>
|
|
87
|
-
|
|
88
|
-
### `<Protected>` configuration
|
|
89
|
-
|
|
90
|
-
**● configuration**: *[Configuration](configuration.md) \| `undefined`*
|
|
91
|
-
|
|
92
|
-
*Inherited from [BaseAPI](baseapi.md).[configuration](baseapi.md#configuration)*
|
|
93
|
-
|
|
94
|
-
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L49)*
|
|
95
|
-
|
|
96
|
-
___
|
|
97
|
-
|
|
98
|
-
## Methods
|
|
99
|
-
|
|
100
|
-
<a id="appsindex"></a>
|
|
101
|
-
|
|
102
|
-
### appsIndex
|
|
103
|
-
|
|
104
|
-
▸ **appsIndex**(X_RH_IDENTITY: *`string`*, options?: *`any`*): `AxiosPromise`<[InlineResponse200](../interfaces/inlineresponse200.md)>
|
|
105
|
-
|
|
106
|
-
*Defined in [api.ts:1265](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1265)*
|
|
107
|
-
|
|
108
|
-
Lists all apps requested
|
|
109
|
-
|
|
110
|
-
*__throws__*: {RequiredError}
|
|
111
|
-
|
|
112
|
-
*__memberof__*: AppsApi
|
|
113
|
-
|
|
114
|
-
**Parameters:**
|
|
115
|
-
|
|
116
|
-
| Name | Type | Description |
|
|
117
|
-
| ------ | ------ | ------ |
|
|
118
|
-
| X_RH_IDENTITY | `string` | \- |
|
|
119
|
-
| `Optional` options | `any` |
|
|
120
|
-
|
|
121
|
-
**Returns:** `AxiosPromise`<[InlineResponse200](../interfaces/inlineresponse200.md)>
|
|
122
|
-
|
|
123
|
-
___
|
|
124
|
-
<a id="appsshow"></a>
|
|
125
|
-
|
|
126
|
-
### appsShow
|
|
127
|
-
|
|
128
|
-
▸ **appsShow**(X_RH_IDENTITY: *`string`*, id: *`number`*, options?: *`any`*): `AxiosPromise`<[InlineResponse2002](../interfaces/inlineresponse2002.md)>
|
|
129
|
-
|
|
130
|
-
*Defined in [api.ts:1277](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L1277)*
|
|
131
|
-
|
|
132
|
-
Shows the requested app
|
|
133
|
-
|
|
134
|
-
*__throws__*: {RequiredError}
|
|
135
|
-
|
|
136
|
-
*__memberof__*: AppsApi
|
|
137
|
-
|
|
138
|
-
**Parameters:**
|
|
139
|
-
|
|
140
|
-
| Name | Type | Description |
|
|
141
|
-
| ------ | ------ | ------ |
|
|
142
|
-
| X_RH_IDENTITY | `string` | \- |
|
|
143
|
-
| id | `number` | \- |
|
|
144
|
-
| `Optional` options | `any` |
|
|
145
|
-
|
|
146
|
-
**Returns:** `AxiosPromise`<[InlineResponse2002](../interfaces/inlineresponse2002.md)>
|
|
147
|
-
|
|
148
|
-
___
|
|
149
|
-
|
package/doc/classes/baseapi.md
DELETED
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) > [BaseAPI](../classes/baseapi.md)
|
|
2
|
-
|
|
3
|
-
# Class: BaseAPI
|
|
4
|
-
|
|
5
|
-
*__export__*:
|
|
6
|
-
|
|
7
|
-
*__class__*: BaseAPI
|
|
8
|
-
|
|
9
|
-
## Hierarchy
|
|
10
|
-
|
|
11
|
-
**BaseAPI**
|
|
12
|
-
|
|
13
|
-
↳ [AppRegistrationApi](appregistrationapi.md)
|
|
14
|
-
|
|
15
|
-
↳ [AppsApi](appsapi.md)
|
|
16
|
-
|
|
17
|
-
↳ [EndpointsApi](endpointsapi.md)
|
|
18
|
-
|
|
19
|
-
↳ [FiltersApi](filtersapi.md)
|
|
20
|
-
|
|
21
|
-
## Index
|
|
22
|
-
|
|
23
|
-
### Constructors
|
|
24
|
-
|
|
25
|
-
* [constructor](baseapi.md#constructor)
|
|
26
|
-
|
|
27
|
-
### Properties
|
|
28
|
-
|
|
29
|
-
* [axios](baseapi.md#axios)
|
|
30
|
-
* [basePath](baseapi.md#basepath)
|
|
31
|
-
* [configuration](baseapi.md#configuration)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
## Constructors
|
|
36
|
-
|
|
37
|
-
<a id="constructor"></a>
|
|
38
|
-
|
|
39
|
-
### constructor
|
|
40
|
-
|
|
41
|
-
⊕ **new BaseAPI**(configuration?: *[Configuration](configuration.md)*, basePath?: *`string`*, axios?: *`AxiosInstance`*): [BaseAPI](baseapi.md)
|
|
42
|
-
|
|
43
|
-
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L49)*
|
|
44
|
-
|
|
45
|
-
**Parameters:**
|
|
46
|
-
|
|
47
|
-
| Name | Type | Default value |
|
|
48
|
-
| ------ | ------ | ------ |
|
|
49
|
-
| `Optional` configuration | [Configuration](configuration.md) | - |
|
|
50
|
-
| `Default value` basePath | `string` | BASE_PATH |
|
|
51
|
-
| `Default value` axios | `AxiosInstance` | globalAxios |
|
|
52
|
-
|
|
53
|
-
**Returns:** [BaseAPI](baseapi.md)
|
|
54
|
-
|
|
55
|
-
___
|
|
56
|
-
|
|
57
|
-
## Properties
|
|
58
|
-
|
|
59
|
-
<a id="axios"></a>
|
|
60
|
-
|
|
61
|
-
### `<Protected>` axios
|
|
62
|
-
|
|
63
|
-
**● axios**: *`AxiosInstance`*
|
|
64
|
-
|
|
65
|
-
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L51)*
|
|
66
|
-
|
|
67
|
-
___
|
|
68
|
-
<a id="basepath"></a>
|
|
69
|
-
|
|
70
|
-
### `<Protected>` basePath
|
|
71
|
-
|
|
72
|
-
**● basePath**: *`string`*
|
|
73
|
-
|
|
74
|
-
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L51)*
|
|
75
|
-
|
|
76
|
-
___
|
|
77
|
-
<a id="configuration"></a>
|
|
78
|
-
|
|
79
|
-
### `<Protected>` configuration
|
|
80
|
-
|
|
81
|
-
**● configuration**: *[Configuration](configuration.md) \| `undefined`*
|
|
82
|
-
|
|
83
|
-
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/hooks/api.ts#L49)*
|
|
84
|
-
|
|
85
|
-
___
|
|
86
|
-
|