@redhat-cloud-services/notifications-client 2.3.2 → 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.
Files changed (164) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/DrawerResourceV1GetDrawerEntries/index.d.ts +1 -1
  3. package/dist/DrawerResourceV1GetDrawerEntries/index.d.ts.map +1 -1
  4. package/dist/DrawerResourceV1GetDrawerEntries/index.js +1 -1
  5. package/dist/DrawerResourceV1GetDrawerEntries/index.js.map +1 -1
  6. package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.d.ts +1 -1
  7. package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.d.ts.map +1 -1
  8. package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.js +1 -1
  9. package/dist/DrawerResourceV1UpdateNotificationReadStatus/index.js.map +1 -1
  10. package/dist/EventResourceV1GetEvents/index.d.ts +2 -2
  11. package/dist/EventResourceV1GetEvents/index.d.ts.map +1 -1
  12. package/dist/EventResourceV1GetEvents/index.js +2 -2
  13. package/dist/EventResourceV1GetEvents/index.js.map +1 -1
  14. package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.d.ts +1 -1
  15. package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.d.ts.map +1 -1
  16. package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.js +1 -1
  17. package/dist/NotificationResourceV1AppendBehaviorGroupToEventType/index.js.map +1 -1
  18. package/dist/NotificationResourceV1CreateBehaviorGroup/index.d.ts +1 -1
  19. package/dist/NotificationResourceV1CreateBehaviorGroup/index.d.ts.map +1 -1
  20. package/dist/NotificationResourceV1CreateBehaviorGroup/index.js +1 -1
  21. package/dist/NotificationResourceV1CreateBehaviorGroup/index.js.map +1 -1
  22. package/dist/NotificationResourceV1DeleteBehaviorGroup/index.d.ts +1 -1
  23. package/dist/NotificationResourceV1DeleteBehaviorGroup/index.d.ts.map +1 -1
  24. package/dist/NotificationResourceV1DeleteBehaviorGroup/index.js +1 -1
  25. package/dist/NotificationResourceV1DeleteBehaviorGroup/index.js.map +1 -1
  26. package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.d.ts +1 -1
  27. package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.d.ts.map +1 -1
  28. package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.js +1 -1
  29. package/dist/NotificationResourceV1DeleteBehaviorGroupFromEventType/index.js.map +1 -1
  30. package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.d.ts +1 -1
  31. package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.d.ts.map +1 -1
  32. package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.js +1 -1
  33. package/dist/NotificationResourceV1FindBehaviorGroupsByBundleId/index.js.map +1 -1
  34. package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.d.ts +2 -2
  35. package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.d.ts.map +1 -1
  36. package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.js +2 -2
  37. package/dist/NotificationResourceV1GetApplicationByNameAndBundleName/index.js.map +1 -1
  38. package/dist/NotificationResourceV1GetApplicationsFacets/index.d.ts +2 -2
  39. package/dist/NotificationResourceV1GetApplicationsFacets/index.d.ts.map +1 -1
  40. package/dist/NotificationResourceV1GetApplicationsFacets/index.js +2 -2
  41. package/dist/NotificationResourceV1GetApplicationsFacets/index.js.map +1 -1
  42. package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.d.ts +1 -1
  43. package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.d.ts.map +1 -1
  44. package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.js +1 -1
  45. package/dist/NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpoint/index.js.map +1 -1
  46. package/dist/NotificationResourceV1GetBundleByName/index.d.ts +1 -1
  47. package/dist/NotificationResourceV1GetBundleByName/index.d.ts.map +1 -1
  48. package/dist/NotificationResourceV1GetBundleByName/index.js +1 -1
  49. package/dist/NotificationResourceV1GetBundleByName/index.js.map +1 -1
  50. package/dist/NotificationResourceV1GetBundleFacets/index.d.ts +2 -2
  51. package/dist/NotificationResourceV1GetBundleFacets/index.d.ts.map +1 -1
  52. package/dist/NotificationResourceV1GetBundleFacets/index.js +2 -2
  53. package/dist/NotificationResourceV1GetBundleFacets/index.js.map +1 -1
  54. package/dist/NotificationResourceV1GetEventTypes/index.d.ts +2 -2
  55. package/dist/NotificationResourceV1GetEventTypes/index.d.ts.map +1 -1
  56. package/dist/NotificationResourceV1GetEventTypes/index.js +2 -2
  57. package/dist/NotificationResourceV1GetEventTypes/index.js.map +1 -1
  58. package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.d.ts +1 -1
  59. package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.d.ts.map +1 -1
  60. package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.js +1 -1
  61. package/dist/NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroup/index.js.map +1 -1
  62. package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.d.ts +2 -2
  63. package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.d.ts.map +1 -1
  64. package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.js +2 -2
  65. package/dist/NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationName/index.js.map +1 -1
  66. package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.d.ts +1 -1
  67. package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.d.ts.map +1 -1
  68. package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.js +1 -1
  69. package/dist/NotificationResourceV1GetLinkedBehaviorGroups/index.js.map +1 -1
  70. package/dist/NotificationResourceV1UpdateBehaviorGroup/index.d.ts +2 -2
  71. package/dist/NotificationResourceV1UpdateBehaviorGroup/index.d.ts.map +1 -1
  72. package/dist/NotificationResourceV1UpdateBehaviorGroup/index.js +1 -1
  73. package/dist/NotificationResourceV1UpdateBehaviorGroup/index.js.map +1 -1
  74. package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.d.ts +2 -2
  75. package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.d.ts.map +1 -1
  76. package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.js +2 -2
  77. package/dist/NotificationResourceV1UpdateBehaviorGroupActions/index.js.map +1 -1
  78. package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.d.ts +1 -1
  79. package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.d.ts.map +1 -1
  80. package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.js +1 -1
  81. package/dist/NotificationResourceV1UpdateEventTypeBehaviors/index.js.map +1 -1
  82. package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.d.ts +1 -1
  83. package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.d.ts.map +1 -1
  84. package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.js +1 -1
  85. package/dist/OrgConfigResourceV1GetDailyDigestTimePreference/index.js.map +1 -1
  86. package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.d.ts +1 -1
  87. package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.d.ts.map +1 -1
  88. package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.js +1 -1
  89. package/dist/OrgConfigResourceV1SaveDailyDigestTimePreference/index.js.map +1 -1
  90. package/dist/api.d.ts +76 -70
  91. package/dist/api.d.ts.map +1 -1
  92. package/dist/api.js +34 -34
  93. package/dist/api.js.map +1 -1
  94. package/dist/base.d.ts +2 -2
  95. package/dist/base.js +1 -1
  96. package/dist/common.d.ts +1 -1
  97. package/dist/common.js +1 -1
  98. package/dist/configuration.d.ts +12 -1
  99. package/dist/configuration.d.ts.map +1 -1
  100. package/dist/configuration.js +11 -0
  101. package/dist/configuration.js.map +1 -1
  102. package/dist/index.d.ts +1 -3
  103. package/dist/index.d.ts.map +1 -1
  104. package/dist/index.js +1 -3
  105. package/dist/index.js.map +1 -1
  106. package/dist/types/index.d.ts +43 -37
  107. package/dist/types/index.d.ts.map +1 -1
  108. package/dist/types/index.js.map +1 -1
  109. package/doc/classes/BaseAPI.md +12 -74
  110. package/doc/classes/RequiredError.md +2 -2
  111. package/doc/enums/HttpType.md +3 -3
  112. package/doc/enums/NotificationStatus.md +5 -5
  113. package/doc/enums/Status.md +2 -2
  114. package/doc/enums/SubscriptionType.md +3 -3
  115. package/doc/interfaces/CamelProperties.md +8 -8
  116. package/doc/interfaces/CurrentStatus.md +4 -4
  117. package/doc/interfaces/EventType.md +18 -3
  118. package/doc/interfaces/EventTypeBehavior.md +3 -3
  119. package/doc/interfaces/EventTypeBehaviorId.md +2 -2
  120. package/doc/interfaces/EventTypeSettingsValue.md +3 -3
  121. package/doc/interfaces/Facet.md +4 -4
  122. package/doc/interfaces/InstantEmailTemplate.md +9 -9
  123. package/doc/interfaces/InternalApplicationUserPermission.md +3 -3
  124. package/doc/interfaces/InternalRoleAccess.md +7 -7
  125. package/doc/interfaces/InternalUserPermissions.md +7 -7
  126. package/doc/interfaces/MessageValidationResponse.md +1 -1
  127. package/doc/interfaces/Meta.md +1 -1
  128. package/doc/interfaces/NotificationHistory.md +9 -9
  129. package/doc/interfaces/PageBehaviorGroup.md +3 -3
  130. package/doc/interfaces/PageDrawerEntryPayload.md +3 -3
  131. package/doc/interfaces/PageEventLogEntry.md +3 -3
  132. package/doc/interfaces/PageEventType.md +3 -3
  133. package/doc/interfaces/PageNotificationHistory.md +3 -3
  134. package/doc/interfaces/RenderEmailTemplateRequest.md +2 -2
  135. package/doc/interfaces/RequestArgs.md +6 -28
  136. package/doc/interfaces/RequestDefaultBehaviorGroupPropertyList.md +2 -2
  137. package/doc/interfaces/RequestSystemSubscriptionProperties.md +5 -5
  138. package/doc/interfaces/ServerInfo.md +1 -1
  139. package/doc/interfaces/SettingsValuesByEventType.md +1 -1
  140. package/doc/interfaces/SystemSubscriptionProperties.md +7 -7
  141. package/doc/interfaces/Template.md +6 -6
  142. package/doc/interfaces/TriggerDailyDigestRequest.md +5 -5
  143. package/doc/interfaces/UpdateApplicationRequest.md +3 -3
  144. package/doc/interfaces/UpdateBehaviorGroupRequest.md +4 -4
  145. package/doc/interfaces/UpdateNotificationDrawerStatus.md +5 -5
  146. package/doc/interfaces/WebhookProperties.md +13 -13
  147. package/doc/interfaces/X509Certificate.md +5 -5
  148. package/doc/modules.md +53 -410
  149. package/package.json +3 -2
  150. package/dist/utils/base.d.ts +0 -85
  151. package/dist/utils/base.d.ts.map +0 -1
  152. package/dist/utils/base.js +0 -191
  153. package/dist/utils/base.js.map +0 -1
  154. package/dist/utils/common.d.ts +0 -55
  155. package/dist/utils/common.d.ts.map +0 -1
  156. package/dist/utils/common.js +0 -196
  157. package/dist/utils/common.js.map +0 -1
  158. package/dist/utils/configuration.d.ts +0 -73
  159. package/dist/utils/configuration.d.ts.map +0 -1
  160. package/dist/utils/configuration.js +0 -34
  161. package/dist/utils/configuration.js.map +0 -1
  162. package/doc/classes/Configuration.md +0 -202
  163. package/doc/interfaces/ApiConfig.md +0 -30
  164. package/doc/interfaces/ConfigurationParameters.md +0 -93
@@ -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,202 +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?`): [`Configuration`](Configuration.md)
30
-
31
- #### Parameters
32
-
33
- | Name | Type |
34
- | :------ | :------ |
35
- | `param` | [`ConfigurationParameters`](../interfaces/ConfigurationParameters.md) |
36
-
37
- #### Returns
38
-
39
- [`Configuration`](Configuration.md)
40
-
41
- #### Defined in
42
-
43
- [packages/notifications/utils/configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L65)
44
-
45
- ## Properties
46
-
47
- ### accessToken
48
-
49
- • `Optional` **accessToken**: `string` \| `Promise`\<`string`\> \| (`name?`: `string`, `scopes?`: `string`[]) => `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `Promise`\<`string`\>
50
-
51
- parameter for oauth2 security
52
-
53
- **`Param`**
54
-
55
- security name
56
-
57
- **`Param`**
58
-
59
- oauth2 scope
60
-
61
- **`Memberof`**
62
-
63
- Configuration
64
-
65
- #### Defined in
66
-
67
- [packages/notifications/utils/configuration.ts:41](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L41)
68
-
69
- ___
70
-
71
- ### apiKey
72
-
73
- • `Optional` **apiKey**: `string` \| `Promise`\<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`\<`string`\>
74
-
75
- parameter for apiKey security
76
-
77
- **`Param`**
78
-
79
- security name
80
-
81
- **`Memberof`**
82
-
83
- Configuration
84
-
85
- #### Defined in
86
-
87
- [packages/notifications/utils/configuration.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L20)
88
-
89
- ___
90
-
91
- ### baseOptions
92
-
93
- • `Optional` **baseOptions**: `any`
94
-
95
- base options for axios calls
96
-
97
- **`Memberof`**
98
-
99
- Configuration
100
-
101
- #### Defined in
102
-
103
- [packages/notifications/utils/configuration.ts:55](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L55)
104
-
105
- ___
106
-
107
- ### basePath
108
-
109
- • `Optional` **basePath**: `string`
110
-
111
- override base path
112
-
113
- **`Memberof`**
114
-
115
- Configuration
116
-
117
- #### Defined in
118
-
119
- [packages/notifications/utils/configuration.ts:48](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L48)
120
-
121
- ___
122
-
123
- ### formDataCtor
124
-
125
- • `Optional` **formDataCtor**: () => `any`
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
- #### Type declaration
132
-
133
- • **new formDataCtor**(): `any`
134
-
135
- ##### Returns
136
-
137
- `any`
138
-
139
- #### Defined in
140
-
141
- [packages/notifications/utils/configuration.ts:63](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L63)
142
-
143
- ___
144
-
145
- ### password
146
-
147
- • `Optional` **password**: `string`
148
-
149
- parameter for basic security
150
-
151
- **`Memberof`**
152
-
153
- Configuration
154
-
155
- #### Defined in
156
-
157
- [packages/notifications/utils/configuration.ts:34](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L34)
158
-
159
- ___
160
-
161
- ### username
162
-
163
- • `Optional` **username**: `string`
164
-
165
- parameter for basic security
166
-
167
- **`Memberof`**
168
-
169
- Configuration
170
-
171
- #### Defined in
172
-
173
- [packages/notifications/utils/configuration.ts:27](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L27)
174
-
175
- ## Methods
176
-
177
- ### isJsonMime
178
-
179
- ▸ **isJsonMime**(`mime`): `boolean`
180
-
181
- Check if the given MIME is a JSON MIME.
182
- JSON MIME examples:
183
- application/json
184
- application/json; charset=UTF8
185
- APPLICATION/JSON
186
- application/vnd.company+json
187
-
188
- #### Parameters
189
-
190
- | Name | Type | Description |
191
- | :------ | :------ | :------ |
192
- | `mime` | `string` | MIME (Multipurpose Internet Mail Extensions) |
193
-
194
- #### Returns
195
-
196
- `boolean`
197
-
198
- True if the given MIME is JSON, false otherwise.
199
-
200
- #### Defined in
201
-
202
- [packages/notifications/utils/configuration.ts:85](https://github.com/RedHatInsights/javascript-clients/blob/main/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/main/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/main/packages/notifications/utils/base.ts#L42)
@@ -1,93 +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/main/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/main/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/main/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/main/packages/notifications/utils/configuration.ts#L9)
56
-
57
- ___
58
-
59
- ### formDataCtor
60
-
61
- • `Optional` **formDataCtor**: () => `any`
62
-
63
- #### Type declaration
64
-
65
- • **new formDataCtor**(): `any`
66
-
67
- ##### Returns
68
-
69
- `any`
70
-
71
- #### Defined in
72
-
73
- [packages/notifications/utils/configuration.ts:11](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L11)
74
-
75
- ___
76
-
77
- ### password
78
-
79
- • `Optional` **password**: `string`
80
-
81
- #### Defined in
82
-
83
- [packages/notifications/utils/configuration.ts:7](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L7)
84
-
85
- ___
86
-
87
- ### username
88
-
89
- • `Optional` **username**: `string`
90
-
91
- #### Defined in
92
-
93
- [packages/notifications/utils/configuration.ts:6](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/notifications/utils/configuration.ts#L6)