@redhat-cloud-services/notifications-client 2.3.1 → 2.4.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/CHANGELOG.md +12 -0
- package/dist/DrawerResourceV1GetDrawerEntries/index.d.ts +1 -1
- package/dist/DrawerResourceV1GetDrawerEntries/index.d.ts.map +1 -1
- package/dist/DrawerResourceV1GetDrawerEntries/index.js +1 -1
- package/dist/DrawerResourceV1GetDrawerEntries/index.js.map +1 -1
- package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.d.ts +1 -1
- package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.d.ts.map +1 -1
- package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.js +1 -1
- package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.js.map +1 -1
- package/dist/EventResourceV1GetEvents/index.d.ts +2 -2
- package/dist/EventResourceV1GetEvents/index.d.ts.map +1 -1
- package/dist/EventResourceV1GetEvents/index.js +2 -2
- package/dist/EventResourceV1GetEvents/index.js.map +1 -1
- package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.d.ts +1 -1
- package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.js +1 -1
- package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.js.map +1 -1
- package/dist/NotificationResourceV1CreateBehaviorGroup/index.d.ts +1 -1
- package/dist/NotificationResourceV1CreateBehaviorGroup/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1CreateBehaviorGroup/index.js +1 -1
- package/dist/NotificationResourceV1CreateBehaviorGroup/index.js.map +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroup/index.d.ts +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroup/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroup/index.js +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroup/index.js.map +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.d.ts +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.js +1 -1
- package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.js.map +1 -1
- package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.d.ts +1 -1
- package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.js +1 -1
- package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.js.map +1 -1
- package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.d.ts +2 -2
- package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.js +2 -2
- package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.js.map +1 -1
- package/dist/NotificationResourceV1GetApplicationsFacets/index.d.ts +2 -2
- package/dist/NotificationResourceV1GetApplicationsFacets/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetApplicationsFacets/index.js +2 -2
- package/dist/NotificationResourceV1GetApplicationsFacets/index.js.map +1 -1
- package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.js +1 -1
- package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.js.map +1 -1
- package/dist/NotificationResourceV1GetBundleByName/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetBundleByName/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetBundleByName/index.js +1 -1
- package/dist/NotificationResourceV1GetBundleByName/index.js.map +1 -1
- package/dist/NotificationResourceV1GetBundleFacets/index.d.ts +2 -2
- package/dist/NotificationResourceV1GetBundleFacets/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetBundleFacets/index.js +2 -2
- package/dist/NotificationResourceV1GetBundleFacets/index.js.map +1 -1
- package/dist/NotificationResourceV1GetEventTypes/index.d.ts +2 -2
- package/dist/NotificationResourceV1GetEventTypes/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetEventTypes/index.js +2 -2
- package/dist/NotificationResourceV1GetEventTypes/index.js.map +1 -1
- package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.js +1 -1
- package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.js.map +1 -1
- package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.d.ts +2 -2
- package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.js +2 -2
- package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.js.map +1 -1
- package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.d.ts +1 -1
- package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.js +1 -1
- package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.js.map +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroup/index.d.ts +2 -2
- package/dist/NotificationResourceV1UpdateBehaviorGroup/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroup/index.js +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroup/index.js.map +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.d.ts +2 -2
- package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.js +2 -2
- package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.js.map +1 -1
- package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.d.ts +1 -1
- package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.d.ts.map +1 -1
- package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.js +1 -1
- package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.js.map +1 -1
- package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.d.ts +1 -1
- package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.d.ts.map +1 -1
- package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.js +1 -1
- package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.js.map +1 -1
- package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.d.ts +1 -1
- package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.d.ts.map +1 -1
- package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.js +1 -1
- package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.js.map +1 -1
- package/dist/api.d.ts +76 -70
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js +34 -34
- package/dist/api.js.map +1 -1
- package/dist/base.d.ts +2 -2
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +12 -1
- package/dist/configuration.d.ts.map +1 -1
- package/dist/configuration.js +11 -0
- package/dist/configuration.js.map +1 -1
- package/dist/index.d.ts +1 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -3
- package/dist/index.js.map +1 -1
- package/dist/types/index.d.ts +43 -37
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js.map +1 -1
- package/doc/README.md +2 -1
- package/doc/classes/BaseAPI.md +18 -72
- package/doc/classes/RequiredError.md +17 -11
- package/doc/enums/EndpointStatus.md +6 -6
- package/doc/enums/EndpointType.md +5 -5
- package/doc/enums/Environment.md +4 -4
- package/doc/enums/EventLogEntryActionStatus.md +5 -5
- package/doc/enums/HttpType.md +3 -3
- package/doc/enums/NotificationStatus.md +5 -5
- package/doc/enums/Status.md +2 -2
- package/doc/enums/SubscriptionType.md +3 -3
- package/doc/interfaces/AddAccessRequest.md +2 -4
- package/doc/interfaces/AddApplicationRequest.md +4 -6
- package/doc/interfaces/AggregationEmailTemplate.md +10 -12
- package/doc/interfaces/AggregationEmailTemplateSubjectTemplate.md +6 -8
- package/doc/interfaces/Application.md +6 -8
- package/doc/interfaces/Application1.md +2 -4
- package/doc/interfaces/ApplicationDTO.md +6 -8
- package/doc/interfaces/ApplicationSettingsValue.md +1 -3
- package/doc/interfaces/BasicAuthentication.md +2 -4
- package/doc/interfaces/BehaviorGroup.md +10 -12
- package/doc/interfaces/BehaviorGroupAction.md +3 -5
- package/doc/interfaces/BehaviorGroupActionId.md +2 -4
- package/doc/interfaces/Bundle.md +5 -7
- package/doc/interfaces/BundleSettingsValue.md +1 -3
- package/doc/interfaces/CamelProperties.md +15 -17
- package/doc/interfaces/CreateBehaviorGroupRequest.md +7 -9
- package/doc/interfaces/CreateBehaviorGroupResponse.md +7 -9
- package/doc/interfaces/CurrentStatus.md +7 -9
- package/doc/interfaces/DrawerEntryPayload.md +7 -9
- package/doc/interfaces/DuplicateNameMigrationReport.md +2 -4
- package/doc/interfaces/Endpoint.md +11 -13
- package/doc/interfaces/EndpointPage.md +3 -5
- package/doc/interfaces/EndpointTestRequest.md +1 -3
- package/doc/interfaces/EventLogEntry.md +7 -9
- package/doc/interfaces/EventLogEntryAction.md +7 -9
- package/doc/interfaces/EventType.md +25 -12
- package/doc/interfaces/EventTypeBehavior.md +3 -5
- package/doc/interfaces/EventTypeBehaviorId.md +2 -4
- package/doc/interfaces/EventTypeSettingsValue.md +3 -5
- package/doc/interfaces/Facet.md +4 -6
- package/doc/interfaces/InstantEmailTemplate.md +9 -11
- package/doc/interfaces/InternalApplicationUserPermission.md +3 -5
- package/doc/interfaces/InternalRoleAccess.md +7 -9
- package/doc/interfaces/InternalUserPermissions.md +7 -9
- package/doc/interfaces/MessageValidationResponse.md +1 -3
- package/doc/interfaces/Meta.md +1 -3
- package/doc/interfaces/NotificationHistory.md +9 -11
- package/doc/interfaces/PageBehaviorGroup.md +3 -5
- package/doc/interfaces/PageDrawerEntryPayload.md +3 -5
- package/doc/interfaces/PageEventLogEntry.md +3 -5
- package/doc/interfaces/PageEventType.md +3 -5
- package/doc/interfaces/PageNotificationHistory.md +3 -5
- package/doc/interfaces/RenderEmailTemplateRequest.md +2 -4
- package/doc/interfaces/RequestArgs.md +7 -31
- package/doc/interfaces/RequestDefaultBehaviorGroupPropertyList.md +2 -4
- package/doc/interfaces/RequestSystemSubscriptionProperties.md +5 -7
- package/doc/interfaces/ServerInfo.md +1 -3
- package/doc/interfaces/SettingsValuesByEventType.md +1 -3
- package/doc/interfaces/SystemSubscriptionProperties.md +7 -9
- package/doc/interfaces/Template.md +6 -8
- package/doc/interfaces/TriggerDailyDigestRequest.md +5 -7
- package/doc/interfaces/UpdateApplicationRequest.md +3 -5
- package/doc/interfaces/UpdateBehaviorGroupRequest.md +5 -7
- package/doc/interfaces/UpdateNotificationDrawerStatus.md +6 -8
- package/doc/interfaces/WebhookProperties.md +13 -15
- package/doc/interfaces/X509Certificate.md +5 -7
- package/doc/modules.md +206 -563
- package/package.json +4 -3
- package/dist/utils/base.d.ts +0 -85
- package/dist/utils/base.d.ts.map +0 -1
- package/dist/utils/base.js +0 -191
- package/dist/utils/base.js.map +0 -1
- package/dist/utils/common.d.ts +0 -55
- package/dist/utils/common.d.ts.map +0 -1
- package/dist/utils/common.js +0 -196
- package/dist/utils/common.js.map +0 -1
- package/dist/utils/configuration.d.ts +0 -73
- package/dist/utils/configuration.d.ts.map +0 -1
- package/dist/utils/configuration.js +0 -34
- package/dist/utils/configuration.js.map +0 -1
- package/doc/classes/Configuration.md +0 -194
- package/doc/interfaces/ApiConfig.md +0 -30
- package/doc/interfaces/ConfigurationParameters.md +0 -89
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/* tslint:disable */
|
|
3
|
-
/* eslint-disable */
|
|
4
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
-
exports.Configuration = void 0;
|
|
6
|
-
var Configuration = /** @class */ (function () {
|
|
7
|
-
function Configuration(param) {
|
|
8
|
-
if (param === void 0) { param = {}; }
|
|
9
|
-
this.apiKey = param.apiKey;
|
|
10
|
-
this.username = param.username;
|
|
11
|
-
this.password = param.password;
|
|
12
|
-
this.accessToken = param.accessToken;
|
|
13
|
-
this.basePath = param.basePath;
|
|
14
|
-
this.baseOptions = param.baseOptions;
|
|
15
|
-
this.formDataCtor = param.formDataCtor;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Check if the given MIME is a JSON MIME.
|
|
19
|
-
* JSON MIME examples:
|
|
20
|
-
* application/json
|
|
21
|
-
* application/json; charset=UTF8
|
|
22
|
-
* APPLICATION/JSON
|
|
23
|
-
* application/vnd.company+json
|
|
24
|
-
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
25
|
-
* @return True if the given MIME is JSON, false otherwise.
|
|
26
|
-
*/
|
|
27
|
-
Configuration.prototype.isJsonMime = function (mime) {
|
|
28
|
-
var jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
|
|
29
|
-
return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
|
|
30
|
-
};
|
|
31
|
-
return Configuration;
|
|
32
|
-
}());
|
|
33
|
-
exports.Configuration = Configuration;
|
|
34
|
-
//# sourceMappingURL=configuration.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../../utils/configuration.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;;;AAYpB;IAmDI,uBAAY,KAAmC;QAAnC,sBAAA,EAAA,UAAmC;QAC3C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;IAC3C,CAAC;IAED;;;;;;;;;OASG;IACI,kCAAU,GAAjB,UAAkB,IAAY;QAC1B,IAAM,QAAQ,GAAW,IAAI,MAAM,CAAC,+DAA+D,EAAE,GAAG,CAAC,CAAC;QAC1G,OAAO,IAAI,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,KAAK,6BAA6B,CAAC,CAAC;IAC1G,CAAC;IACL,oBAAC;AAAD,CAAC,AA3ED,IA2EC;AA3EY,sCAAa"}
|
|
@@ -1,194 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / Configuration
|
|
2
|
-
|
|
3
|
-
# Class: Configuration
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Constructors
|
|
8
|
-
|
|
9
|
-
- [constructor](Configuration.md#constructor)
|
|
10
|
-
|
|
11
|
-
### Properties
|
|
12
|
-
|
|
13
|
-
- [accessToken](Configuration.md#accesstoken)
|
|
14
|
-
- [apiKey](Configuration.md#apikey)
|
|
15
|
-
- [baseOptions](Configuration.md#baseoptions)
|
|
16
|
-
- [basePath](Configuration.md#basepath)
|
|
17
|
-
- [formDataCtor](Configuration.md#formdatactor)
|
|
18
|
-
- [password](Configuration.md#password)
|
|
19
|
-
- [username](Configuration.md#username)
|
|
20
|
-
|
|
21
|
-
### Methods
|
|
22
|
-
|
|
23
|
-
- [isJsonMime](Configuration.md#isjsonmime)
|
|
24
|
-
|
|
25
|
-
## Constructors
|
|
26
|
-
|
|
27
|
-
### constructor
|
|
28
|
-
|
|
29
|
-
• **new Configuration**(`param?`)
|
|
30
|
-
|
|
31
|
-
#### Parameters
|
|
32
|
-
|
|
33
|
-
| Name | Type |
|
|
34
|
-
| :------ | :------ |
|
|
35
|
-
| `param` | [`ConfigurationParameters`](../interfaces/ConfigurationParameters.md) |
|
|
36
|
-
|
|
37
|
-
#### Defined in
|
|
38
|
-
|
|
39
|
-
[packages/notifications/utils/configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L65)
|
|
40
|
-
|
|
41
|
-
## Properties
|
|
42
|
-
|
|
43
|
-
### accessToken
|
|
44
|
-
|
|
45
|
-
• `Optional` **accessToken**: `string` \| `Promise`<`string`\> \| (`name?`: `string`, `scopes?`: `string`[]) => `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `Promise`<`string`\>
|
|
46
|
-
|
|
47
|
-
parameter for oauth2 security
|
|
48
|
-
|
|
49
|
-
**`Param`**
|
|
50
|
-
|
|
51
|
-
security name
|
|
52
|
-
|
|
53
|
-
**`Param`**
|
|
54
|
-
|
|
55
|
-
oauth2 scope
|
|
56
|
-
|
|
57
|
-
**`Memberof`**
|
|
58
|
-
|
|
59
|
-
Configuration
|
|
60
|
-
|
|
61
|
-
#### Defined in
|
|
62
|
-
|
|
63
|
-
[packages/notifications/utils/configuration.ts:41](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L41)
|
|
64
|
-
|
|
65
|
-
___
|
|
66
|
-
|
|
67
|
-
### apiKey
|
|
68
|
-
|
|
69
|
-
• `Optional` **apiKey**: `string` \| `Promise`<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`<`string`\>
|
|
70
|
-
|
|
71
|
-
parameter for apiKey security
|
|
72
|
-
|
|
73
|
-
**`Param`**
|
|
74
|
-
|
|
75
|
-
security name
|
|
76
|
-
|
|
77
|
-
**`Memberof`**
|
|
78
|
-
|
|
79
|
-
Configuration
|
|
80
|
-
|
|
81
|
-
#### Defined in
|
|
82
|
-
|
|
83
|
-
[packages/notifications/utils/configuration.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L20)
|
|
84
|
-
|
|
85
|
-
___
|
|
86
|
-
|
|
87
|
-
### baseOptions
|
|
88
|
-
|
|
89
|
-
• `Optional` **baseOptions**: `any`
|
|
90
|
-
|
|
91
|
-
base options for axios calls
|
|
92
|
-
|
|
93
|
-
**`Memberof`**
|
|
94
|
-
|
|
95
|
-
Configuration
|
|
96
|
-
|
|
97
|
-
#### Defined in
|
|
98
|
-
|
|
99
|
-
[packages/notifications/utils/configuration.ts:55](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L55)
|
|
100
|
-
|
|
101
|
-
___
|
|
102
|
-
|
|
103
|
-
### basePath
|
|
104
|
-
|
|
105
|
-
• `Optional` **basePath**: `string`
|
|
106
|
-
|
|
107
|
-
override base path
|
|
108
|
-
|
|
109
|
-
**`Memberof`**
|
|
110
|
-
|
|
111
|
-
Configuration
|
|
112
|
-
|
|
113
|
-
#### Defined in
|
|
114
|
-
|
|
115
|
-
[packages/notifications/utils/configuration.ts:48](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L48)
|
|
116
|
-
|
|
117
|
-
___
|
|
118
|
-
|
|
119
|
-
### formDataCtor
|
|
120
|
-
|
|
121
|
-
• `Optional` **formDataCtor**: () => `any`
|
|
122
|
-
|
|
123
|
-
#### Type declaration
|
|
124
|
-
|
|
125
|
-
• **new Configuration**()
|
|
126
|
-
|
|
127
|
-
The FormData constructor that will be used to create multipart form data
|
|
128
|
-
requests. You can inject this here so that execution environments that
|
|
129
|
-
do not support the FormData class can still run the generated client.
|
|
130
|
-
|
|
131
|
-
#### Defined in
|
|
132
|
-
|
|
133
|
-
[packages/notifications/utils/configuration.ts:63](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L63)
|
|
134
|
-
|
|
135
|
-
___
|
|
136
|
-
|
|
137
|
-
### password
|
|
138
|
-
|
|
139
|
-
• `Optional` **password**: `string`
|
|
140
|
-
|
|
141
|
-
parameter for basic security
|
|
142
|
-
|
|
143
|
-
**`Memberof`**
|
|
144
|
-
|
|
145
|
-
Configuration
|
|
146
|
-
|
|
147
|
-
#### Defined in
|
|
148
|
-
|
|
149
|
-
[packages/notifications/utils/configuration.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L34)
|
|
150
|
-
|
|
151
|
-
___
|
|
152
|
-
|
|
153
|
-
### username
|
|
154
|
-
|
|
155
|
-
• `Optional` **username**: `string`
|
|
156
|
-
|
|
157
|
-
parameter for basic security
|
|
158
|
-
|
|
159
|
-
**`Memberof`**
|
|
160
|
-
|
|
161
|
-
Configuration
|
|
162
|
-
|
|
163
|
-
#### Defined in
|
|
164
|
-
|
|
165
|
-
[packages/notifications/utils/configuration.ts:27](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L27)
|
|
166
|
-
|
|
167
|
-
## Methods
|
|
168
|
-
|
|
169
|
-
### isJsonMime
|
|
170
|
-
|
|
171
|
-
▸ **isJsonMime**(`mime`): `boolean`
|
|
172
|
-
|
|
173
|
-
Check if the given MIME is a JSON MIME.
|
|
174
|
-
JSON MIME examples:
|
|
175
|
-
application/json
|
|
176
|
-
application/json; charset=UTF8
|
|
177
|
-
APPLICATION/JSON
|
|
178
|
-
application/vnd.company+json
|
|
179
|
-
|
|
180
|
-
#### Parameters
|
|
181
|
-
|
|
182
|
-
| Name | Type | Description |
|
|
183
|
-
| :------ | :------ | :------ |
|
|
184
|
-
| `mime` | `string` | MIME (Multipurpose Internet Mail Extensions) |
|
|
185
|
-
|
|
186
|
-
#### Returns
|
|
187
|
-
|
|
188
|
-
`boolean`
|
|
189
|
-
|
|
190
|
-
True if the given MIME is JSON, false otherwise.
|
|
191
|
-
|
|
192
|
-
#### Defined in
|
|
193
|
-
|
|
194
|
-
[packages/notifications/utils/configuration.ts:85](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L85)
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / ApiConfig
|
|
2
|
-
|
|
3
|
-
# Interface: ApiConfig
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [axios](ApiConfig.md#axios)
|
|
10
|
-
- [configuration](ApiConfig.md#configuration)
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### axios
|
|
15
|
-
|
|
16
|
-
• **axios**: `AxiosInstance`
|
|
17
|
-
|
|
18
|
-
#### Defined in
|
|
19
|
-
|
|
20
|
-
[packages/notifications/utils/base.ts:41](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L41)
|
|
21
|
-
|
|
22
|
-
___
|
|
23
|
-
|
|
24
|
-
### configuration
|
|
25
|
-
|
|
26
|
-
• `Optional` **configuration**: [`Configuration`](../classes/Configuration.md)
|
|
27
|
-
|
|
28
|
-
#### Defined in
|
|
29
|
-
|
|
30
|
-
[packages/notifications/utils/base.ts:42](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/base.ts#L42)
|
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
[@redhat-cloud-services/notifications-client](../README.md) / [Exports](../modules.md) / ConfigurationParameters
|
|
2
|
-
|
|
3
|
-
# Interface: ConfigurationParameters
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [accessToken](ConfigurationParameters.md#accesstoken)
|
|
10
|
-
- [apiKey](ConfigurationParameters.md#apikey)
|
|
11
|
-
- [baseOptions](ConfigurationParameters.md#baseoptions)
|
|
12
|
-
- [basePath](ConfigurationParameters.md#basepath)
|
|
13
|
-
- [formDataCtor](ConfigurationParameters.md#formdatactor)
|
|
14
|
-
- [password](ConfigurationParameters.md#password)
|
|
15
|
-
- [username](ConfigurationParameters.md#username)
|
|
16
|
-
|
|
17
|
-
## Properties
|
|
18
|
-
|
|
19
|
-
### accessToken
|
|
20
|
-
|
|
21
|
-
• `Optional` **accessToken**: `string` \| `Promise`<`string`\> \| (`name?`: `string`, `scopes?`: `string`[]) => `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `Promise`<`string`\>
|
|
22
|
-
|
|
23
|
-
#### Defined in
|
|
24
|
-
|
|
25
|
-
[packages/notifications/utils/configuration.ts:8](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L8)
|
|
26
|
-
|
|
27
|
-
___
|
|
28
|
-
|
|
29
|
-
### apiKey
|
|
30
|
-
|
|
31
|
-
• `Optional` **apiKey**: `string` \| `Promise`<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`<`string`\>
|
|
32
|
-
|
|
33
|
-
#### Defined in
|
|
34
|
-
|
|
35
|
-
[packages/notifications/utils/configuration.ts:5](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L5)
|
|
36
|
-
|
|
37
|
-
___
|
|
38
|
-
|
|
39
|
-
### baseOptions
|
|
40
|
-
|
|
41
|
-
• `Optional` **baseOptions**: `any`
|
|
42
|
-
|
|
43
|
-
#### Defined in
|
|
44
|
-
|
|
45
|
-
[packages/notifications/utils/configuration.ts:10](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L10)
|
|
46
|
-
|
|
47
|
-
___
|
|
48
|
-
|
|
49
|
-
### basePath
|
|
50
|
-
|
|
51
|
-
• `Optional` **basePath**: `string`
|
|
52
|
-
|
|
53
|
-
#### Defined in
|
|
54
|
-
|
|
55
|
-
[packages/notifications/utils/configuration.ts:9](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L9)
|
|
56
|
-
|
|
57
|
-
___
|
|
58
|
-
|
|
59
|
-
### formDataCtor
|
|
60
|
-
|
|
61
|
-
• `Optional` **formDataCtor**: () => `any`
|
|
62
|
-
|
|
63
|
-
#### Type declaration
|
|
64
|
-
|
|
65
|
-
• **new ConfigurationParameters**()
|
|
66
|
-
|
|
67
|
-
#### Defined in
|
|
68
|
-
|
|
69
|
-
[packages/notifications/utils/configuration.ts:11](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L11)
|
|
70
|
-
|
|
71
|
-
___
|
|
72
|
-
|
|
73
|
-
### password
|
|
74
|
-
|
|
75
|
-
• `Optional` **password**: `string`
|
|
76
|
-
|
|
77
|
-
#### Defined in
|
|
78
|
-
|
|
79
|
-
[packages/notifications/utils/configuration.ts:7](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L7)
|
|
80
|
-
|
|
81
|
-
___
|
|
82
|
-
|
|
83
|
-
### username
|
|
84
|
-
|
|
85
|
-
• `Optional` **username**: `string`
|
|
86
|
-
|
|
87
|
-
#### Defined in
|
|
88
|
-
|
|
89
|
-
[packages/notifications/utils/configuration.ts:6](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/notifications/utils/configuration.ts#L6)
|