ibm-cloud-sdk-core 4.0.0 → 4.0.2

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 (233) hide show
  1. package/.secrets.baseline +20 -30
  2. package/CHANGELOG.md +16 -4
  3. package/MIGRATION-V4.md +54 -0
  4. package/auth/authenticators/authenticator-interface.d.ts +3 -4
  5. package/auth/authenticators/authenticator-interface.js +1 -1
  6. package/auth/authenticators/authenticator.d.ts +5 -9
  7. package/auth/authenticators/authenticator.js +4 -8
  8. package/auth/authenticators/basic-authenticator.d.ts +12 -12
  9. package/auth/authenticators/basic-authenticator.js +12 -12
  10. package/auth/authenticators/bearer-token-authenticator.d.ts +11 -14
  11. package/auth/authenticators/bearer-token-authenticator.js +11 -14
  12. package/auth/authenticators/cloud-pak-for-data-authenticator.d.ts +15 -15
  13. package/auth/authenticators/cloud-pak-for-data-authenticator.js +15 -15
  14. package/auth/authenticators/container-authenticator.d.ts +23 -23
  15. package/auth/authenticators/container-authenticator.js +23 -23
  16. package/auth/authenticators/iam-authenticator.d.ts +20 -20
  17. package/auth/authenticators/iam-authenticator.js +20 -20
  18. package/auth/authenticators/iam-request-based-authenticator.d.ts +23 -25
  19. package/auth/authenticators/iam-request-based-authenticator.js +23 -25
  20. package/auth/authenticators/token-request-based-authenticator.d.ts +19 -24
  21. package/auth/authenticators/token-request-based-authenticator.js +19 -24
  22. package/auth/authenticators/vpc-instance-authenticator.d.ts +17 -16
  23. package/auth/authenticators/vpc-instance-authenticator.js +17 -16
  24. package/auth/token-managers/container-token-manager.d.ts +23 -25
  25. package/auth/token-managers/container-token-manager.js +23 -25
  26. package/auth/token-managers/cp4d-token-manager.d.ts +13 -13
  27. package/auth/token-managers/cp4d-token-manager.js +13 -13
  28. package/auth/token-managers/iam-request-based-token-manager.d.ts +26 -31
  29. package/auth/token-managers/iam-request-based-token-manager.js +26 -31
  30. package/auth/token-managers/iam-token-manager.d.ts +17 -16
  31. package/auth/token-managers/iam-token-manager.js +17 -16
  32. package/auth/token-managers/jwt-token-manager.d.ts +10 -13
  33. package/auth/token-managers/jwt-token-manager.js +13 -16
  34. package/auth/token-managers/token-manager.d.ts +23 -35
  35. package/auth/token-managers/token-manager.js +22 -34
  36. package/auth/token-managers/vpc-instance-token-manager.d.ts +15 -15
  37. package/auth/token-managers/vpc-instance-token-manager.js +15 -15
  38. package/auth/utils/get-authenticator-from-environment.d.ts +2 -2
  39. package/auth/utils/get-authenticator-from-environment.js +2 -2
  40. package/auth/utils/helpers.d.ts +34 -32
  41. package/auth/utils/helpers.js +34 -32
  42. package/auth/utils/read-external-sources.d.ts +2 -1
  43. package/auth/utils/read-external-sources.js +5 -4
  44. package/build/docs/ibm-cloud-sdk-core.atleastone.md +4 -4
  45. package/build/docs/ibm-cloud-sdk-core.atmostone.md +2 -2
  46. package/build/docs/ibm-cloud-sdk-core.authenticator._constructor_.md +1 -1
  47. package/build/docs/ibm-cloud-sdk-core.authenticator.authenticate.md +1 -1
  48. package/build/docs/ibm-cloud-sdk-core.authenticator.authenticationtype.md +1 -1
  49. package/build/docs/ibm-cloud-sdk-core.authenticator.md +1 -1
  50. package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md +1 -1
  51. package/build/docs/ibm-cloud-sdk-core.baseservice._constructor_.md +1 -1
  52. package/build/docs/ibm-cloud-sdk-core.baseservice.configureservice.md +1 -1
  53. package/build/docs/ibm-cloud-sdk-core.baseservice.createrequest.md +2 -2
  54. package/build/docs/ibm-cloud-sdk-core.baseservice.enableretries.md +1 -1
  55. package/build/docs/ibm-cloud-sdk-core.baseservice.getauthenticator.md +1 -1
  56. package/build/docs/ibm-cloud-sdk-core.baseservice.md +3 -3
  57. package/build/docs/ibm-cloud-sdk-core.baseservice.setdefaultheaders.md +1 -1
  58. package/build/docs/ibm-cloud-sdk-core.baseservice.setserviceurl.md +1 -1
  59. package/build/docs/ibm-cloud-sdk-core.basicauthenticator._constructor_.md +2 -2
  60. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticate.md +1 -1
  61. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.md +3 -3
  62. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md +2 -2
  63. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md +2 -2
  64. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.md +3 -3
  65. package/build/docs/ibm-cloud-sdk-core.buildrequestfileobject.md +2 -2
  66. package/build/docs/ibm-cloud-sdk-core.checkcredentials.md +3 -3
  67. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md +3 -3
  68. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.md +5 -5
  69. package/build/docs/ibm-cloud-sdk-core.computebasicauthheader.md +1 -1
  70. package/build/docs/ibm-cloud-sdk-core.constructserviceurl.md +4 -4
  71. package/build/docs/ibm-cloud-sdk-core.containerauthenticator._constructor_.md +3 -3
  72. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.md +4 -4
  73. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setcrtokenfilename.md +1 -1
  74. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofileid.md +1 -1
  75. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofilename.md +1 -1
  76. package/build/docs/ibm-cloud-sdk-core.containertokenmanager._constructor_.md +6 -2
  77. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.md +5 -5
  78. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.requesttoken.md +0 -2
  79. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md +2 -2
  80. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md +2 -2
  81. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md +2 -2
  82. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md +6 -2
  83. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.md +3 -3
  84. package/build/docs/ibm-cloud-sdk-core.fileobject.md +5 -5
  85. package/build/docs/ibm-cloud-sdk-core.fileoptions.md +4 -4
  86. package/build/docs/ibm-cloud-sdk-core.filestream.md +3 -3
  87. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.md +5 -5
  88. package/build/docs/ibm-cloud-sdk-core.getauthenticatorfromenvironment.md +1 -1
  89. package/build/docs/ibm-cloud-sdk-core.getcontenttype.md +1 -1
  90. package/build/docs/ibm-cloud-sdk-core.getcurrenttime.md +2 -2
  91. package/build/docs/ibm-cloud-sdk-core.getformat.md +0 -2
  92. package/build/docs/ibm-cloud-sdk-core.getmissingparams.md +1 -1
  93. package/build/docs/ibm-cloud-sdk-core.getnewlogger.md +1 -1
  94. package/build/docs/ibm-cloud-sdk-core.getqueryparam.md +1 -5
  95. package/build/docs/ibm-cloud-sdk-core.iamauthenticator._constructor_.md +3 -3
  96. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.md +5 -5
  97. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator._constructor_.md +3 -3
  98. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.getrefreshtoken.md +1 -1
  99. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.md +7 -7
  100. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md +3 -3
  101. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md +1 -1
  102. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md +6 -2
  103. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md +2 -2
  104. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md +8 -8
  105. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md +2 -2
  106. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md +1 -3
  107. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md +3 -5
  108. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md +2 -4
  109. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.md +5 -5
  110. package/build/docs/ibm-cloud-sdk-core.iamtokenmanager._constructor_.md +6 -2
  111. package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.md +3 -3
  112. package/build/docs/ibm-cloud-sdk-core.ishtml.md +1 -1
  113. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager._constructor_.md +2 -2
  114. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.md +5 -5
  115. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md +1 -1
  116. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md +1 -3
  117. package/build/docs/ibm-cloud-sdk-core.md +24 -24
  118. package/build/docs/ibm-cloud-sdk-core.onlyone.md +2 -2
  119. package/build/docs/ibm-cloud-sdk-core.qs.md +1 -1
  120. package/build/docs/ibm-cloud-sdk-core.readexternalsources.md +1 -1
  121. package/build/docs/ibm-cloud-sdk-core.removesuffix.md +4 -4
  122. package/build/docs/ibm-cloud-sdk-core.sdklogger.md +7 -7
  123. package/build/docs/ibm-cloud-sdk-core.streamtopromise.md +3 -1
  124. package/build/docs/ibm-cloud-sdk-core.striptrailingslash.md +4 -2
  125. package/build/docs/ibm-cloud-sdk-core.tokenmanager._constructor_.md +2 -2
  126. package/build/docs/ibm-cloud-sdk-core.tokenmanager.gettoken.md +1 -1
  127. package/build/docs/ibm-cloud-sdk-core.tokenmanager.md +15 -15
  128. package/build/docs/ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md +1 -1
  129. package/build/docs/ibm-cloud-sdk-core.tokenmanager.requesttoken.md +1 -1
  130. package/build/docs/ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md +1 -3
  131. package/build/docs/ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md +1 -3
  132. package/build/docs/ibm-cloud-sdk-core.tokenmanager.setheaders.md +2 -4
  133. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md +2 -2
  134. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md +2 -2
  135. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md +9 -9
  136. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md +1 -1
  137. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md +1 -1
  138. package/build/docs/ibm-cloud-sdk-core.tolowerkeys.md +1 -1
  139. package/build/docs/ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md +0 -2
  140. package/build/docs/ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md +0 -2
  141. package/build/docs/ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md +1 -3
  142. package/build/docs/ibm-cloud-sdk-core.unittestutils.checkuserheader.md +0 -2
  143. package/build/docs/ibm-cloud-sdk-core.unittestutils.expecttobepromise.md +0 -2
  144. package/build/docs/ibm-cloud-sdk-core.unittestutils.getoptions.md +1 -1
  145. package/build/docs/ibm-cloud-sdk-core.useroptions.md +9 -9
  146. package/build/docs/ibm-cloud-sdk-core.validateinput.md +8 -2
  147. package/build/docs/ibm-cloud-sdk-core.validateparams.md +1 -1
  148. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md +6 -2
  149. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.md +6 -6
  150. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md +2 -2
  151. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md +2 -2
  152. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md +6 -2
  153. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.md +4 -4
  154. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md +2 -2
  155. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md +2 -2
  156. package/docs/ibm-cloud-sdk-core.api.json +516 -241
  157. package/es/auth/authenticators/authenticator-interface.d.ts +3 -4
  158. package/es/auth/authenticators/authenticator-interface.js +1 -1
  159. package/es/auth/authenticators/authenticator.d.ts +5 -9
  160. package/es/auth/authenticators/authenticator.js +4 -8
  161. package/es/auth/authenticators/basic-authenticator.d.ts +12 -12
  162. package/es/auth/authenticators/basic-authenticator.js +12 -12
  163. package/es/auth/authenticators/bearer-token-authenticator.d.ts +11 -14
  164. package/es/auth/authenticators/bearer-token-authenticator.js +11 -14
  165. package/es/auth/authenticators/cloud-pak-for-data-authenticator.d.ts +15 -15
  166. package/es/auth/authenticators/cloud-pak-for-data-authenticator.js +15 -15
  167. package/es/auth/authenticators/container-authenticator.d.ts +23 -23
  168. package/es/auth/authenticators/container-authenticator.js +23 -23
  169. package/es/auth/authenticators/iam-authenticator.d.ts +20 -20
  170. package/es/auth/authenticators/iam-authenticator.js +20 -20
  171. package/es/auth/authenticators/iam-request-based-authenticator.d.ts +23 -25
  172. package/es/auth/authenticators/iam-request-based-authenticator.js +23 -25
  173. package/es/auth/authenticators/token-request-based-authenticator.d.ts +19 -24
  174. package/es/auth/authenticators/token-request-based-authenticator.js +19 -24
  175. package/es/auth/authenticators/vpc-instance-authenticator.d.ts +17 -16
  176. package/es/auth/authenticators/vpc-instance-authenticator.js +17 -16
  177. package/es/auth/token-managers/container-token-manager.d.ts +23 -25
  178. package/es/auth/token-managers/container-token-manager.js +23 -25
  179. package/es/auth/token-managers/cp4d-token-manager.d.ts +13 -13
  180. package/es/auth/token-managers/cp4d-token-manager.js +13 -13
  181. package/es/auth/token-managers/iam-request-based-token-manager.d.ts +26 -31
  182. package/es/auth/token-managers/iam-request-based-token-manager.js +26 -31
  183. package/es/auth/token-managers/iam-token-manager.d.ts +17 -16
  184. package/es/auth/token-managers/iam-token-manager.js +17 -16
  185. package/es/auth/token-managers/jwt-token-manager.d.ts +10 -13
  186. package/es/auth/token-managers/jwt-token-manager.js +13 -16
  187. package/es/auth/token-managers/token-manager.d.ts +23 -35
  188. package/es/auth/token-managers/token-manager.js +22 -34
  189. package/es/auth/token-managers/vpc-instance-token-manager.d.ts +15 -15
  190. package/es/auth/token-managers/vpc-instance-token-manager.js +15 -15
  191. package/es/auth/utils/get-authenticator-from-environment.d.ts +2 -2
  192. package/es/auth/utils/get-authenticator-from-environment.js +2 -2
  193. package/es/auth/utils/helpers.d.ts +34 -32
  194. package/es/auth/utils/helpers.js +34 -32
  195. package/es/auth/utils/read-external-sources.d.ts +2 -1
  196. package/es/auth/utils/read-external-sources.js +5 -4
  197. package/es/lib/base-service.d.ts +31 -32
  198. package/es/lib/base-service.js +31 -32
  199. package/es/lib/content-type.js +5 -5
  200. package/es/lib/get-new-logger.d.ts +2 -2
  201. package/es/lib/get-new-logger.js +2 -2
  202. package/es/lib/helper.d.ts +24 -31
  203. package/es/lib/helper.js +25 -32
  204. package/es/lib/querystring.d.ts +1 -1
  205. package/es/lib/querystring.js +3 -3
  206. package/es/lib/request-wrapper.d.ts +4 -6
  207. package/es/lib/request-wrapper.js +17 -23
  208. package/es/lib/sdk-test-helpers.d.ts +14 -19
  209. package/es/lib/sdk-test-helpers.js +14 -19
  210. package/es/lib/stream-to-promise.d.ts +3 -3
  211. package/es/lib/stream-to-promise.js +3 -3
  212. package/es/tsdoc-metadata.json +1 -1
  213. package/etc/ibm-cloud-sdk-core.api.md +12 -12
  214. package/ibm-cloud-sdk-core.d.ts +1402 -1449
  215. package/lib/base-service.d.ts +31 -32
  216. package/lib/base-service.js +31 -32
  217. package/lib/content-type.js +5 -5
  218. package/lib/get-new-logger.d.ts +2 -2
  219. package/lib/get-new-logger.js +2 -2
  220. package/lib/helper.d.ts +24 -31
  221. package/lib/helper.js +25 -32
  222. package/lib/querystring.d.ts +1 -1
  223. package/lib/querystring.js +3 -3
  224. package/lib/request-wrapper.d.ts +4 -6
  225. package/lib/request-wrapper.js +17 -23
  226. package/lib/sdk-test-helpers.d.ts +14 -19
  227. package/lib/sdk-test-helpers.js +14 -19
  228. package/lib/stream-to-promise.d.ts +3 -3
  229. package/lib/stream-to-promise.js +3 -3
  230. package/package.json +2 -2
  231. package/temp/ibm-cloud-sdk-core.api.json +516 -241
  232. package/temp/ibm-cloud-sdk-core.api.md +12 -12
  233. package/MIGRATION-V1.md +0 -42
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "metadata": {
3
3
  "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.20.0",
5
- "schemaVersion": 1005,
4
+ "toolVersion": "7.33.7",
5
+ "schemaVersion": 1010,
6
6
  "oldestForwardsCompatibleVersion": 1001,
7
7
  "tsdocConfig": {
8
8
  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
@@ -156,23 +156,26 @@
156
156
  "@betaDocumentation": true,
157
157
  "@internalRemarks": true,
158
158
  "@preapproved": true
159
- }
159
+ },
160
+ "reportUnsupportedHtmlElements": false
160
161
  }
161
162
  },
162
163
  "kind": "Package",
163
164
  "canonicalReference": "ibm-cloud-sdk-core!",
164
165
  "docComment": "",
165
166
  "name": "ibm-cloud-sdk-core",
167
+ "preserveMemberOrder": false,
166
168
  "members": [
167
169
  {
168
170
  "kind": "EntryPoint",
169
171
  "canonicalReference": "ibm-cloud-sdk-core!",
170
172
  "name": "",
173
+ "preserveMemberOrder": false,
171
174
  "members": [
172
175
  {
173
176
  "kind": "Function",
174
177
  "canonicalReference": "ibm-cloud-sdk-core!atLeastOne:function(1)",
175
- "docComment": "/**\n * Check for at least one of two elements being defined. Returns true if a or b is defined. Returns false if both are undefined.\n *\n * @param a - The first object\n *\n * @param b - The second object\n *\n * @returns {boolean}\n */\n",
178
+ "docComment": "/**\n * Checks for at least one of two elements being defined.\n *\n * @param a - the first object\n *\n * @param b - the second object\n *\n * @returns true if a or b is defined; false if both are undefined\n */\n",
176
179
  "excerptTokens": [
177
180
  {
178
181
  "kind": "Content",
@@ -203,6 +206,7 @@
203
206
  "text": ";"
204
207
  }
205
208
  ],
209
+ "fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
206
210
  "returnTypeTokenRange": {
207
211
  "startIndex": 5,
208
212
  "endIndex": 6
@@ -232,7 +236,7 @@
232
236
  {
233
237
  "kind": "Function",
234
238
  "canonicalReference": "ibm-cloud-sdk-core!atMostOne:function(1)",
235
- "docComment": "/**\n * Verify that both properties are not specified. Returns true if only a, only b, or neither is defined. Returns false if both are defined.\n *\n * @param a - The first object\n *\n * @param b - The second object\n *\n * @returns {boolean}\n */\n",
239
+ "docComment": "/**\n * Verifies that both properties are not specified.\n *\n * @param a - The first object\n *\n * @param b - The second object\n *\n * @returns false if a and b are both defined, true otherwise\n */\n",
236
240
  "excerptTokens": [
237
241
  {
238
242
  "kind": "Content",
@@ -263,6 +267,7 @@
263
267
  "text": ";"
264
268
  }
265
269
  ],
270
+ "fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
266
271
  "returnTypeTokenRange": {
267
272
  "startIndex": 5,
268
273
  "endIndex": 6
@@ -308,13 +313,15 @@
308
313
  "text": " "
309
314
  }
310
315
  ],
316
+ "fileUrlPath": "dist/es/auth/authenticators/authenticator.d.ts",
311
317
  "releaseTag": "Public",
312
318
  "name": "Authenticator",
319
+ "preserveMemberOrder": false,
313
320
  "members": [
314
321
  {
315
322
  "kind": "Constructor",
316
323
  "canonicalReference": "ibm-cloud-sdk-core!Authenticator:constructor(1)",
317
- "docComment": "/**\n * Create a new Authenticator instance.\n *\n * @throws\n *\n * {Error} The `new` keyword was not used to create construct the authenticator.\n */\n",
324
+ "docComment": "/**\n * Create a new Authenticator instance.\n *\n * @throws\n *\n * Error: the \"new\" keyword was not used to construct the authenticator.\n */\n",
318
325
  "excerptTokens": [
319
326
  {
320
327
  "kind": "Content",
@@ -322,13 +329,14 @@
322
329
  }
323
330
  ],
324
331
  "releaseTag": "Public",
332
+ "isProtected": false,
325
333
  "overloadIndex": 1,
326
334
  "parameters": []
327
335
  },
328
336
  {
329
337
  "kind": "Method",
330
338
  "canonicalReference": "ibm-cloud-sdk-core!Authenticator#authenticate:member(1)",
331
- "docComment": "/**\n * Augment the request with authentication information.\n *\n * @param requestOptions - The request to augment with authentication information.\n *\n * @param - {object.<string, string>} requestOptions.headers - The headers the authentication information will be added too.\n *\n * @throws\n *\n * {Error} - The authenticate method was not implemented by a subclass.\n */\n",
339
+ "docComment": "/**\n * Augment the request with authentication information.\n *\n * @param requestOptions - The request to augment with authentication information.\n *\n * @throws\n *\n * Error: The authenticate method was not implemented by a subclass.\n */\n",
332
340
  "excerptTokens": [
333
341
  {
334
342
  "kind": "Content",
@@ -337,7 +345,7 @@
337
345
  {
338
346
  "kind": "Reference",
339
347
  "text": "AuthenticateOptions",
340
- "canonicalReference": "ibm-cloud-sdk-core!AuthenticateOptions:interface"
348
+ "canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface"
341
349
  },
342
350
  {
343
351
  "kind": "Content",
@@ -357,13 +365,13 @@
357
365
  "text": ";"
358
366
  }
359
367
  ],
360
- "isOptional": false,
361
368
  "isStatic": false,
362
369
  "returnTypeTokenRange": {
363
370
  "startIndex": 3,
364
371
  "endIndex": 5
365
372
  },
366
373
  "releaseTag": "Public",
374
+ "isProtected": false,
367
375
  "overloadIndex": 1,
368
376
  "parameters": [
369
377
  {
@@ -375,12 +383,13 @@
375
383
  "isOptional": false
376
384
  }
377
385
  ],
386
+ "isOptional": false,
378
387
  "name": "authenticate"
379
388
  },
380
389
  {
381
390
  "kind": "Method",
382
391
  "canonicalReference": "ibm-cloud-sdk-core!Authenticator#authenticationType:member(1)",
383
- "docComment": "/**\n * Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the \"<service_name>_AUTH_TYPE\" configuration property (e.g. \"basic\", \"iam\", etc.). This function should be overridden in each authenticator implementation class that extends this class.\n *\n * @returns a string that indicates the authenticator's type\n */\n",
392
+ "docComment": "/**\n * Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the \\<service_name\\>_AUTH_TYPE configuration property (e.g. \"basic\", \"iam\", etc.). This function should be overridden in each authenticator implementation class that extends this class.\n *\n * @returns a string that indicates the authenticator's type\n */\n",
384
393
  "excerptTokens": [
385
394
  {
386
395
  "kind": "Content",
@@ -395,15 +404,16 @@
395
404
  "text": ";"
396
405
  }
397
406
  ],
398
- "isOptional": false,
399
407
  "isStatic": false,
400
408
  "returnTypeTokenRange": {
401
409
  "startIndex": 1,
402
410
  "endIndex": 2
403
411
  },
404
412
  "releaseTag": "Public",
413
+ "isProtected": false,
405
414
  "overloadIndex": 1,
406
415
  "parameters": [],
416
+ "isOptional": false,
407
417
  "name": "authenticationType"
408
418
  },
409
419
  {
@@ -424,6 +434,7 @@
424
434
  "text": ";"
425
435
  }
426
436
  ],
437
+ "isReadonly": false,
427
438
  "isOptional": false,
428
439
  "releaseTag": "Public",
429
440
  "name": "AUTHTYPE_BASIC",
@@ -431,7 +442,8 @@
431
442
  "startIndex": 1,
432
443
  "endIndex": 2
433
444
  },
434
- "isStatic": true
445
+ "isStatic": true,
446
+ "isProtected": false
435
447
  },
436
448
  {
437
449
  "kind": "Property",
@@ -451,6 +463,7 @@
451
463
  "text": ";"
452
464
  }
453
465
  ],
466
+ "isReadonly": false,
454
467
  "isOptional": false,
455
468
  "releaseTag": "Public",
456
469
  "name": "AUTHTYPE_BEARERTOKEN",
@@ -458,7 +471,8 @@
458
471
  "startIndex": 1,
459
472
  "endIndex": 2
460
473
  },
461
- "isStatic": true
474
+ "isStatic": true,
475
+ "isProtected": false
462
476
  },
463
477
  {
464
478
  "kind": "Property",
@@ -478,6 +492,7 @@
478
492
  "text": ";"
479
493
  }
480
494
  ],
495
+ "isReadonly": false,
481
496
  "isOptional": false,
482
497
  "releaseTag": "Public",
483
498
  "name": "AUTHTYPE_CONTAINER",
@@ -485,7 +500,8 @@
485
500
  "startIndex": 1,
486
501
  "endIndex": 2
487
502
  },
488
- "isStatic": true
503
+ "isStatic": true,
504
+ "isProtected": false
489
505
  },
490
506
  {
491
507
  "kind": "Property",
@@ -505,6 +521,7 @@
505
521
  "text": ";"
506
522
  }
507
523
  ],
524
+ "isReadonly": false,
508
525
  "isOptional": false,
509
526
  "releaseTag": "Public",
510
527
  "name": "AUTHTYPE_CP4D",
@@ -512,7 +529,8 @@
512
529
  "startIndex": 1,
513
530
  "endIndex": 2
514
531
  },
515
- "isStatic": true
532
+ "isStatic": true,
533
+ "isProtected": false
516
534
  },
517
535
  {
518
536
  "kind": "Property",
@@ -532,6 +550,7 @@
532
550
  "text": ";"
533
551
  }
534
552
  ],
553
+ "isReadonly": false,
535
554
  "isOptional": false,
536
555
  "releaseTag": "Public",
537
556
  "name": "AUTHTYPE_IAM",
@@ -539,7 +558,8 @@
539
558
  "startIndex": 1,
540
559
  "endIndex": 2
541
560
  },
542
- "isStatic": true
561
+ "isStatic": true,
562
+ "isProtected": false
543
563
  },
544
564
  {
545
565
  "kind": "Property",
@@ -559,6 +579,7 @@
559
579
  "text": ";"
560
580
  }
561
581
  ],
582
+ "isReadonly": false,
562
583
  "isOptional": false,
563
584
  "releaseTag": "Public",
564
585
  "name": "AUTHTYPE_NOAUTH",
@@ -566,7 +587,8 @@
566
587
  "startIndex": 1,
567
588
  "endIndex": 2
568
589
  },
569
- "isStatic": true
590
+ "isStatic": true,
591
+ "isProtected": false
570
592
  },
571
593
  {
572
594
  "kind": "Property",
@@ -586,6 +608,7 @@
586
608
  "text": ";"
587
609
  }
588
610
  ],
611
+ "isReadonly": false,
589
612
  "isOptional": false,
590
613
  "releaseTag": "Public",
591
614
  "name": "AUTHTYPE_UNKNOWN",
@@ -593,7 +616,8 @@
593
616
  "startIndex": 1,
594
617
  "endIndex": 2
595
618
  },
596
- "isStatic": true
619
+ "isStatic": true,
620
+ "isProtected": false
597
621
  },
598
622
  {
599
623
  "kind": "Property",
@@ -613,6 +637,7 @@
613
637
  "text": ";"
614
638
  }
615
639
  ],
640
+ "isReadonly": false,
616
641
  "isOptional": false,
617
642
  "releaseTag": "Public",
618
643
  "name": "AUTHTYPE_VPC",
@@ -620,13 +645,14 @@
620
645
  "startIndex": 1,
621
646
  "endIndex": 2
622
647
  },
623
- "isStatic": true
648
+ "isStatic": true,
649
+ "isProtected": false
624
650
  }
625
651
  ],
626
652
  "implementsTokenRanges": [
627
653
  {
628
654
  "startIndex": 1,
629
- "endIndex": 3
655
+ "endIndex": 2
630
656
  }
631
657
  ]
632
658
  },
@@ -640,13 +666,15 @@
640
666
  "text": "export interface AuthenticatorInterface "
641
667
  }
642
668
  ],
669
+ "fileUrlPath": "dist/es/auth/authenticators/authenticator-interface.d.ts",
643
670
  "releaseTag": "Public",
644
671
  "name": "AuthenticatorInterface",
672
+ "preserveMemberOrder": false,
645
673
  "members": [
646
674
  {
647
675
  "kind": "MethodSignature",
648
676
  "canonicalReference": "ibm-cloud-sdk-core!AuthenticatorInterface#authenticate:member(1)",
649
- "docComment": "/**\n * Add authentication information to the specified request.\n *\n * @param requestOptions - The request to augment with authentication information.\n *\n * @param - {object.<string, string>} requestOptions.headers The headers the authentication information will be added to.\n */\n",
677
+ "docComment": "/**\n * Add authentication information to the specified request.\n *\n * @param requestOptions - The request to which authentication information is added (in the headers field).\n */\n",
650
678
  "excerptTokens": [
651
679
  {
652
680
  "kind": "Content",
@@ -655,7 +683,7 @@
655
683
  {
656
684
  "kind": "Reference",
657
685
  "text": "AuthenticateOptions",
658
- "canonicalReference": "ibm-cloud-sdk-core!AuthenticateOptions:interface"
686
+ "canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface"
659
687
  },
660
688
  {
661
689
  "kind": "Content",
@@ -735,13 +763,15 @@
735
763
  "text": "export declare class BaseService "
736
764
  }
737
765
  ],
766
+ "fileUrlPath": "dist/es/lib/base-service.d.ts",
738
767
  "releaseTag": "Public",
739
768
  "name": "BaseService",
769
+ "preserveMemberOrder": false,
740
770
  "members": [
741
771
  {
742
772
  "kind": "Constructor",
743
773
  "canonicalReference": "ibm-cloud-sdk-core!BaseService:constructor(1)",
744
- "docComment": "/**\n * Configuration values for a service.\n *\n * @param - {Authenticator} userOptions.authenticator Object used to authenticate requests to the service.\n *\n * @param - {string} [userOptions.serviceUrl] The base url to use when contacting the service. The base url may differ between IBM Cloud regions.\n *\n * @param - {object<string, string>} [userOptions.headers] Default headers that shall be included with every request to the service.\n *\n * @param - {string} [userOptions.version] The API version date to use with the service, in \"YYYY-MM-DD\" format.\n *\n * @param - {boolean} [userOptions.disableSslVerification] A flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n */\n",
774
+ "docComment": "/**\n * Configuration values for a service.\n *\n * @param userOptions - the configuration options to set on the service instance. This should be an object with the following fields: - authenticator: (required) an Object used to authenticate requests to the service. - serviceUrl: (optional) the base url to use when contacting the service. The base url may differ between IBM Cloud regions. - headers: (optional) a set of HTTP headers that should be included with every request sent to the service - disableSslVerification: (optional) a flag that indicates whether verification of the server's SSL certificate should be disabled or not.\n */\n",
745
775
  "excerptTokens": [
746
776
  {
747
777
  "kind": "Content",
@@ -758,6 +788,7 @@
758
788
  }
759
789
  ],
760
790
  "releaseTag": "Public",
791
+ "isProtected": false,
761
792
  "overloadIndex": 1,
762
793
  "parameters": [
763
794
  {
@@ -782,13 +813,14 @@
782
813
  {
783
814
  "kind": "Reference",
784
815
  "text": "BaseServiceOptions",
785
- "canonicalReference": "ibm-cloud-sdk-core!BaseServiceOptions:interface"
816
+ "canonicalReference": "ibm-cloud-sdk-core!~BaseServiceOptions:interface"
786
817
  },
787
818
  {
788
819
  "kind": "Content",
789
820
  "text": ";"
790
821
  }
791
822
  ],
823
+ "isReadonly": false,
792
824
  "isOptional": false,
793
825
  "releaseTag": "Public",
794
826
  "name": "baseOptions",
@@ -796,12 +828,13 @@
796
828
  "startIndex": 1,
797
829
  "endIndex": 2
798
830
  },
799
- "isStatic": false
831
+ "isStatic": false,
832
+ "isProtected": true
800
833
  },
801
834
  {
802
835
  "kind": "Method",
803
836
  "canonicalReference": "ibm-cloud-sdk-core!BaseService#configureService:member(1)",
804
- "docComment": "/**\n * Configure the service using external configuration\n *\n * @param serviceName - The name of the service. Will be used to read from external configuration.\n */\n",
837
+ "docComment": "/**\n * Configure the service using external configuration\n *\n * @param serviceName - the name of the service. This will be used to read from external configuration.\n */\n",
805
838
  "excerptTokens": [
806
839
  {
807
840
  "kind": "Content",
@@ -824,13 +857,13 @@
824
857
  "text": ";"
825
858
  }
826
859
  ],
827
- "isOptional": false,
828
860
  "isStatic": false,
829
861
  "returnTypeTokenRange": {
830
862
  "startIndex": 3,
831
863
  "endIndex": 4
832
864
  },
833
865
  "releaseTag": "Public",
866
+ "isProtected": true,
834
867
  "overloadIndex": 1,
835
868
  "parameters": [
836
869
  {
@@ -842,12 +875,13 @@
842
875
  "isOptional": false
843
876
  }
844
877
  ],
878
+ "isOptional": false,
845
879
  "name": "configureService"
846
880
  },
847
881
  {
848
882
  "kind": "Method",
849
883
  "canonicalReference": "ibm-cloud-sdk-core!BaseService#createRequest:member(1)",
850
- "docComment": "/**\n * Wrapper around `sendRequest` that enforces the request will be authenticated.\n *\n * @param parameters - Service request options passed in by user.\n *\n * @param - {string} parameters.options.method The http method.\n *\n * @param - {string} parameters.options.url The path portion of the URL to be appended to the serviceUrl.\n *\n * @param - {object} [parameters.options.path] The path parameters to be inserted into the URL.\n *\n * @param - {object} [parameters.options.qs] The querystring to be included in the URL.\n *\n * @param - {object} [parameters.options.body] The data to be sent as the request body.\n *\n * @param - {object} [parameters.options.form] An object containing the key/value pairs for a www-form-urlencoded request.\n *\n * @param - {object} [parameters.options.formData] An object containing the contents for a multipart/form-data request The following processing is performed on formData values: - string: no special processing -- the value is sent as is - object: the value is converted to a JSON string before insertion into the form body - NodeJS.ReadableStream|Buffer|FileWithMetadata: sent as a file, with any associated metadata - array: each element of the array is sent as a separate form part using any special processing as described above\n *\n * @param - {object} parameters.defaultOptions\n *\n * @param - {string} parameters.defaultOptions.serviceUrl The base URL of the service.\n *\n * @param - {OutgoingHttpHeaders} parameters.defaultOptions.headers Additional headers to be passed on the request.\n *\n * @returns {Promise<any>}\n */\n",
884
+ "docComment": "/**\n * Wrapper around `sendRequest` that enforces the request will be authenticated.\n *\n * @param parameters - Service request options passed in by user. This should be an object with the following fields: - options.method: the http method - options.url: the path portion of the URL to be appended to the serviceUrl - options.path: the path parameters to be inserted into the URL - options.qs: the querystring to be included in the URL - options.body: the data to be sent as the request body - options.form: an object containing the key/value pairs for a www-form-urlencoded request. - options.formData: an object containing the contents for a multipart/form-data request The following processing is performed on formData values: - string: no special processing -- the value is sent as is - object: the value is converted to a JSON string before insertion into the form body - NodeJS.ReadableStream|Buffer|FileWithMetadata: sent as a file, with any associated metadata - array: each element of the array is sent as a separate form part using any special processing as described above - defaultOptions.serviceUrl: the base URL of the service - defaultOptions.headers: additional HTTP headers to be sent with the request\n *\n * @returns a Promise\n */\n",
851
885
  "excerptTokens": [
852
886
  {
853
887
  "kind": "Content",
@@ -875,13 +909,13 @@
875
909
  "text": ";"
876
910
  }
877
911
  ],
878
- "isOptional": false,
879
912
  "isStatic": false,
880
913
  "returnTypeTokenRange": {
881
914
  "startIndex": 3,
882
915
  "endIndex": 5
883
916
  },
884
917
  "releaseTag": "Public",
918
+ "isProtected": true,
885
919
  "overloadIndex": 1,
886
920
  "parameters": [
887
921
  {
@@ -893,6 +927,7 @@
893
927
  "isOptional": false
894
928
  }
895
929
  ],
930
+ "isOptional": false,
896
931
  "name": "createRequest"
897
932
  },
898
933
  {
@@ -913,6 +948,7 @@
913
948
  "text": ";"
914
949
  }
915
950
  ],
951
+ "isReadonly": false,
916
952
  "isOptional": false,
917
953
  "releaseTag": "Public",
918
954
  "name": "DEFAULT_SERVICE_NAME",
@@ -920,7 +956,8 @@
920
956
  "startIndex": 1,
921
957
  "endIndex": 2
922
958
  },
923
- "isStatic": true
959
+ "isStatic": true,
960
+ "isProtected": false
924
961
  },
925
962
  {
926
963
  "kind": "Property",
@@ -940,6 +977,7 @@
940
977
  "text": ";"
941
978
  }
942
979
  ],
980
+ "isReadonly": false,
943
981
  "isOptional": false,
944
982
  "releaseTag": "Public",
945
983
  "name": "DEFAULT_SERVICE_URL",
@@ -947,7 +985,8 @@
947
985
  "startIndex": 1,
948
986
  "endIndex": 2
949
987
  },
950
- "isStatic": true
988
+ "isStatic": true,
989
+ "isProtected": false
951
990
  },
952
991
  {
953
992
  "kind": "Method",
@@ -967,21 +1006,22 @@
967
1006
  "text": ";"
968
1007
  }
969
1008
  ],
970
- "isOptional": false,
971
1009
  "isStatic": false,
972
1010
  "returnTypeTokenRange": {
973
1011
  "startIndex": 1,
974
1012
  "endIndex": 2
975
1013
  },
976
1014
  "releaseTag": "Public",
1015
+ "isProtected": false,
977
1016
  "overloadIndex": 1,
978
1017
  "parameters": [],
1018
+ "isOptional": false,
979
1019
  "name": "disableRetries"
980
1020
  },
981
1021
  {
982
1022
  "kind": "Method",
983
1023
  "canonicalReference": "ibm-cloud-sdk-core!BaseService#enableRetries:member(1)",
984
- "docComment": "/**\n * Enable retries for unfulfilled requests.\n *\n * @param retryOptions - configuration for retries\n */\n",
1024
+ "docComment": "/**\n * Enable retries for unfulfilled requests.\n *\n * @param retryOptions - the configuration for retries\n */\n",
985
1025
  "excerptTokens": [
986
1026
  {
987
1027
  "kind": "Content",
@@ -990,7 +1030,7 @@
990
1030
  {
991
1031
  "kind": "Reference",
992
1032
  "text": "RetryOptions",
993
- "canonicalReference": "ibm-cloud-sdk-core!RetryOptions:interface"
1033
+ "canonicalReference": "ibm-cloud-sdk-core!~RetryOptions:interface"
994
1034
  },
995
1035
  {
996
1036
  "kind": "Content",
@@ -1005,13 +1045,13 @@
1005
1045
  "text": ";"
1006
1046
  }
1007
1047
  ],
1008
- "isOptional": false,
1009
1048
  "isStatic": false,
1010
1049
  "returnTypeTokenRange": {
1011
1050
  "startIndex": 3,
1012
1051
  "endIndex": 4
1013
1052
  },
1014
1053
  "releaseTag": "Public",
1054
+ "isProtected": false,
1015
1055
  "overloadIndex": 1,
1016
1056
  "parameters": [
1017
1057
  {
@@ -1023,12 +1063,13 @@
1023
1063
  "isOptional": true
1024
1064
  }
1025
1065
  ],
1066
+ "isOptional": false,
1026
1067
  "name": "enableRetries"
1027
1068
  },
1028
1069
  {
1029
1070
  "kind": "Method",
1030
1071
  "canonicalReference": "ibm-cloud-sdk-core!BaseService#getAuthenticator:member(1)",
1031
- "docComment": "/**\n * Get the instance of the authenticator set on the service.\n *\n * @returns {Authenticator}\n */\n",
1072
+ "docComment": "/**\n * Get the instance of the authenticator set on the service.\n *\n * @returns the Authenticator instance\n */\n",
1032
1073
  "excerptTokens": [
1033
1074
  {
1034
1075
  "kind": "Content",
@@ -1043,15 +1084,16 @@
1043
1084
  "text": ";"
1044
1085
  }
1045
1086
  ],
1046
- "isOptional": false,
1047
1087
  "isStatic": false,
1048
1088
  "returnTypeTokenRange": {
1049
1089
  "startIndex": 1,
1050
1090
  "endIndex": 2
1051
1091
  },
1052
1092
  "releaseTag": "Public",
1093
+ "isProtected": false,
1053
1094
  "overloadIndex": 1,
1054
1095
  "parameters": [],
1096
+ "isOptional": false,
1055
1097
  "name": "getAuthenticator"
1056
1098
  },
1057
1099
  {
@@ -1077,21 +1119,22 @@
1077
1119
  "text": ";"
1078
1120
  }
1079
1121
  ],
1080
- "isOptional": false,
1081
1122
  "isStatic": false,
1082
1123
  "returnTypeTokenRange": {
1083
1124
  "startIndex": 1,
1084
1125
  "endIndex": 3
1085
1126
  },
1086
1127
  "releaseTag": "Public",
1128
+ "isProtected": false,
1087
1129
  "overloadIndex": 1,
1088
1130
  "parameters": [],
1131
+ "isOptional": false,
1089
1132
  "name": "getHttpClient"
1090
1133
  },
1091
1134
  {
1092
1135
  "kind": "Method",
1093
1136
  "canonicalReference": "ibm-cloud-sdk-core!BaseService#setDefaultHeaders:member(1)",
1094
- "docComment": "/**\n * Set the HTTP headers to be sent in every request.\n *\n * @param headers - The map of headers to include in requests.\n */\n",
1137
+ "docComment": "/**\n * Set the HTTP headers to be sent in every request.\n *\n * @param headers - the map of headers to include in requests.\n */\n",
1095
1138
  "excerptTokens": [
1096
1139
  {
1097
1140
  "kind": "Content",
@@ -1115,13 +1158,13 @@
1115
1158
  "text": ";"
1116
1159
  }
1117
1160
  ],
1118
- "isOptional": false,
1119
1161
  "isStatic": false,
1120
1162
  "returnTypeTokenRange": {
1121
1163
  "startIndex": 3,
1122
1164
  "endIndex": 4
1123
1165
  },
1124
1166
  "releaseTag": "Public",
1167
+ "isProtected": false,
1125
1168
  "overloadIndex": 1,
1126
1169
  "parameters": [
1127
1170
  {
@@ -1133,6 +1176,7 @@
1133
1176
  "isOptional": false
1134
1177
  }
1135
1178
  ],
1179
+ "isOptional": false,
1136
1180
  "name": "setDefaultHeaders"
1137
1181
  },
1138
1182
  {
@@ -1161,13 +1205,13 @@
1161
1205
  "text": ";"
1162
1206
  }
1163
1207
  ],
1164
- "isOptional": false,
1165
1208
  "isStatic": false,
1166
1209
  "returnTypeTokenRange": {
1167
1210
  "startIndex": 3,
1168
1211
  "endIndex": 4
1169
1212
  },
1170
1213
  "releaseTag": "Public",
1214
+ "isProtected": false,
1171
1215
  "overloadIndex": 1,
1172
1216
  "parameters": [
1173
1217
  {
@@ -1179,12 +1223,13 @@
1179
1223
  "isOptional": false
1180
1224
  }
1181
1225
  ],
1226
+ "isOptional": false,
1182
1227
  "name": "setEnableGzipCompression"
1183
1228
  },
1184
1229
  {
1185
1230
  "kind": "Method",
1186
1231
  "canonicalReference": "ibm-cloud-sdk-core!BaseService#setServiceUrl:member(1)",
1187
- "docComment": "/**\n * Set the service URL to send requests to.\n *\n * @param url - The base URL for the service.\n */\n",
1232
+ "docComment": "/**\n * Set the service URL to send requests to.\n *\n * @param url - the base URL for the service.\n */\n",
1188
1233
  "excerptTokens": [
1189
1234
  {
1190
1235
  "kind": "Content",
@@ -1207,13 +1252,13 @@
1207
1252
  "text": ";"
1208
1253
  }
1209
1254
  ],
1210
- "isOptional": false,
1211
1255
  "isStatic": false,
1212
1256
  "returnTypeTokenRange": {
1213
1257
  "startIndex": 3,
1214
1258
  "endIndex": 4
1215
1259
  },
1216
1260
  "releaseTag": "Public",
1261
+ "isProtected": false,
1217
1262
  "overloadIndex": 1,
1218
1263
  "parameters": [
1219
1264
  {
@@ -1225,6 +1270,7 @@
1225
1270
  "isOptional": false
1226
1271
  }
1227
1272
  ],
1273
+ "isOptional": false,
1228
1274
  "name": "setServiceUrl"
1229
1275
  }
1230
1276
  ],
@@ -1233,7 +1279,7 @@
1233
1279
  {
1234
1280
  "kind": "Class",
1235
1281
  "canonicalReference": "ibm-cloud-sdk-core!BasicAuthenticator:class",
1236
- "docComment": "/**\n * The BasicAuthenticator is used to add basic authentication information to requests.\n *\n * Basic Authorization will be sent as an Authorization header in the form:\n *\n * Authorization: Basic <encoded username and password>\n */\n",
1282
+ "docComment": "/**\n * The BasicAuthenticator is used to add basic authentication information to requests.\n *\n * Basic Authorization will be sent as an Authorization header in the form:\n *\n * Authorization: Basic \\<encoded username and password\\>\n */\n",
1237
1283
  "excerptTokens": [
1238
1284
  {
1239
1285
  "kind": "Content",
@@ -1249,13 +1295,15 @@
1249
1295
  "text": " "
1250
1296
  }
1251
1297
  ],
1298
+ "fileUrlPath": "dist/es/auth/authenticators/basic-authenticator.d.ts",
1252
1299
  "releaseTag": "Public",
1253
1300
  "name": "BasicAuthenticator",
1301
+ "preserveMemberOrder": false,
1254
1302
  "members": [
1255
1303
  {
1256
1304
  "kind": "Constructor",
1257
1305
  "canonicalReference": "ibm-cloud-sdk-core!BasicAuthenticator:constructor(1)",
1258
- "docComment": "/**\n * Create a new BasicAuthenticator instance.\n *\n * @param options - Configuration options for basic authentication.\n *\n * @param - {string} options.username The username portion of basic authentication.\n *\n * @param - {string} options.password The password portion of basic authentication.\n *\n * @throws\n *\n * {Error} The configuration options are not valid.\n */\n",
1306
+ "docComment": "/**\n * Create a new BasicAuthenticator instance.\n *\n * @param options - Configuration options for basic authentication. This should be an object containing these fields: - username: the username portion of basic authentication - password: the password portion of basic authentication\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n",
1259
1307
  "excerptTokens": [
1260
1308
  {
1261
1309
  "kind": "Content",
@@ -1264,7 +1312,7 @@
1264
1312
  {
1265
1313
  "kind": "Reference",
1266
1314
  "text": "Options",
1267
- "canonicalReference": "ibm-cloud-sdk-core!Options:type"
1315
+ "canonicalReference": "ibm-cloud-sdk-core!~Options:type"
1268
1316
  },
1269
1317
  {
1270
1318
  "kind": "Content",
@@ -1272,6 +1320,7 @@
1272
1320
  }
1273
1321
  ],
1274
1322
  "releaseTag": "Public",
1323
+ "isProtected": false,
1275
1324
  "overloadIndex": 1,
1276
1325
  "parameters": [
1277
1326
  {
@@ -1287,7 +1336,7 @@
1287
1336
  {
1288
1337
  "kind": "Method",
1289
1338
  "canonicalReference": "ibm-cloud-sdk-core!BasicAuthenticator#authenticate:member(1)",
1290
- "docComment": "/**\n * Add basic authentication information to `request`. The basic authentication information will be set in the Authorization property of`request.headers` in the form:\n *\n * Authorization: Basic <encoded username and password>\n *\n * @param requestOptions - The request to augment with authentication information.\n *\n * @param - {object.<string, string>} requestOptions.headers - The headers the authentication information will be added too.\n */\n",
1339
+ "docComment": "/**\n * Add basic authentication information to `requestOptions`. The basic authentication information will be set in the Authorization property of `requestOptions.headers` in the form:\n *\n * Authorization: Basic \\<encoded username and password\\>\n *\n * @param requestOptions - The request to augment with authentication information.\n */\n",
1291
1340
  "excerptTokens": [
1292
1341
  {
1293
1342
  "kind": "Content",
@@ -1296,7 +1345,7 @@
1296
1345
  {
1297
1346
  "kind": "Reference",
1298
1347
  "text": "AuthenticateOptions",
1299
- "canonicalReference": "ibm-cloud-sdk-core!AuthenticateOptions:interface"
1348
+ "canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface"
1300
1349
  },
1301
1350
  {
1302
1351
  "kind": "Content",
@@ -1316,13 +1365,13 @@
1316
1365
  "text": ";"
1317
1366
  }
1318
1367
  ],
1319
- "isOptional": false,
1320
1368
  "isStatic": false,
1321
1369
  "returnTypeTokenRange": {
1322
1370
  "startIndex": 3,
1323
1371
  "endIndex": 5
1324
1372
  },
1325
1373
  "releaseTag": "Public",
1374
+ "isProtected": false,
1326
1375
  "overloadIndex": 1,
1327
1376
  "parameters": [
1328
1377
  {
@@ -1334,6 +1383,7 @@
1334
1383
  "isOptional": false
1335
1384
  }
1336
1385
  ],
1386
+ "isOptional": false,
1337
1387
  "name": "authenticate"
1338
1388
  },
1339
1389
  {
@@ -1354,15 +1404,16 @@
1354
1404
  "text": ";"
1355
1405
  }
1356
1406
  ],
1357
- "isOptional": false,
1358
1407
  "isStatic": false,
1359
1408
  "returnTypeTokenRange": {
1360
1409
  "startIndex": 1,
1361
1410
  "endIndex": 2
1362
1411
  },
1363
1412
  "releaseTag": "Public",
1413
+ "isProtected": false,
1364
1414
  "overloadIndex": 1,
1365
1415
  "parameters": [],
1416
+ "isOptional": false,
1366
1417
  "name": "authenticationType"
1367
1418
  },
1368
1419
  {
@@ -1383,6 +1434,7 @@
1383
1434
  "text": ";"
1384
1435
  }
1385
1436
  ],
1437
+ "isReadonly": false,
1386
1438
  "isOptional": false,
1387
1439
  "releaseTag": "Public",
1388
1440
  "name": "authHeader",
@@ -1390,7 +1442,8 @@
1390
1442
  "startIndex": 1,
1391
1443
  "endIndex": 2
1392
1444
  },
1393
- "isStatic": false
1445
+ "isStatic": false,
1446
+ "isProtected": true
1394
1447
  },
1395
1448
  {
1396
1449
  "kind": "Property",
@@ -1410,6 +1463,7 @@
1410
1463
  "text": ";"
1411
1464
  }
1412
1465
  ],
1466
+ "isReadonly": false,
1413
1467
  "isOptional": false,
1414
1468
  "releaseTag": "Public",
1415
1469
  "name": "requiredOptions",
@@ -1417,19 +1471,20 @@
1417
1471
  "startIndex": 1,
1418
1472
  "endIndex": 2
1419
1473
  },
1420
- "isStatic": false
1474
+ "isStatic": false,
1475
+ "isProtected": true
1421
1476
  }
1422
1477
  ],
1423
1478
  "extendsTokenRange": {
1424
1479
  "startIndex": 1,
1425
- "endIndex": 3
1480
+ "endIndex": 2
1426
1481
  },
1427
1482
  "implementsTokenRanges": []
1428
1483
  },
1429
1484
  {
1430
1485
  "kind": "Class",
1431
1486
  "canonicalReference": "ibm-cloud-sdk-core!BearerTokenAuthenticator:class",
1432
- "docComment": "/**\n * The BearerTokenAuthenticator will set a user-provided bearer token in requests.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer <bearer-token>\n */\n",
1487
+ "docComment": "/**\n * The BearerTokenAuthenticator will set a user-provided bearer token in requests.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer \\<bearer-token\\>\n */\n",
1433
1488
  "excerptTokens": [
1434
1489
  {
1435
1490
  "kind": "Content",
@@ -1445,13 +1500,15 @@
1445
1500
  "text": " "
1446
1501
  }
1447
1502
  ],
1503
+ "fileUrlPath": "dist/es/auth/authenticators/bearer-token-authenticator.d.ts",
1448
1504
  "releaseTag": "Public",
1449
1505
  "name": "BearerTokenAuthenticator",
1506
+ "preserveMemberOrder": false,
1450
1507
  "members": [
1451
1508
  {
1452
1509
  "kind": "Constructor",
1453
1510
  "canonicalReference": "ibm-cloud-sdk-core!BearerTokenAuthenticator:constructor(1)",
1454
- "docComment": "/**\n * Create a new BearerTokenAuthenticator instance.\n *\n * @param options - Configuration options for bearer authentication.\n *\n * @param - {string} options.bearerToken The bearer token to be added to requests.\n *\n * @throws\n *\n * {Error} The configuration bearerToken is not valid, or unspecified.\n */\n",
1511
+ "docComment": "/**\n * Create a new BearerTokenAuthenticator instance.\n *\n * @param options - Configuration options for bearer authentication. This should be an object containing the \"bearerToken\" field.\n *\n * @throws\n *\n * Error: the options.bearerToken field is not valid, or unspecified\n */\n",
1455
1512
  "excerptTokens": [
1456
1513
  {
1457
1514
  "kind": "Content",
@@ -1460,7 +1517,7 @@
1460
1517
  {
1461
1518
  "kind": "Reference",
1462
1519
  "text": "Options",
1463
- "canonicalReference": "ibm-cloud-sdk-core!Options:type"
1520
+ "canonicalReference": "ibm-cloud-sdk-core!~Options_2:type"
1464
1521
  },
1465
1522
  {
1466
1523
  "kind": "Content",
@@ -1468,6 +1525,7 @@
1468
1525
  }
1469
1526
  ],
1470
1527
  "releaseTag": "Public",
1528
+ "isProtected": false,
1471
1529
  "overloadIndex": 1,
1472
1530
  "parameters": [
1473
1531
  {
@@ -1483,7 +1541,7 @@
1483
1541
  {
1484
1542
  "kind": "Method",
1485
1543
  "canonicalReference": "ibm-cloud-sdk-core!BearerTokenAuthenticator#authenticate:member(1)",
1486
- "docComment": "/**\n * Add a bearer token to the `request`. The bearer token information will be set in the Authorization property of`request.headers` in the form:\n *\n * Authorization: Bearer <bearer-token>\n *\n * @param requestOptions - The request to augment with authentication information.\n *\n * @param - {object.<string, string>} requestOptions.headers - The headers the authentication information will be added to.\n */\n",
1544
+ "docComment": "/**\n * Add a bearer token to `requestOptions`. The bearer token information will be set in the Authorization property of \"requestOptions.headers\" in the form:\n *\n * Authorization: Bearer \\<bearer-token\\>\n *\n * @param requestOptions - The request to augment with authentication information.\n */\n",
1487
1545
  "excerptTokens": [
1488
1546
  {
1489
1547
  "kind": "Content",
@@ -1492,7 +1550,7 @@
1492
1550
  {
1493
1551
  "kind": "Reference",
1494
1552
  "text": "AuthenticateOptions",
1495
- "canonicalReference": "ibm-cloud-sdk-core!AuthenticateOptions:interface"
1553
+ "canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface"
1496
1554
  },
1497
1555
  {
1498
1556
  "kind": "Content",
@@ -1512,13 +1570,13 @@
1512
1570
  "text": ";"
1513
1571
  }
1514
1572
  ],
1515
- "isOptional": false,
1516
1573
  "isStatic": false,
1517
1574
  "returnTypeTokenRange": {
1518
1575
  "startIndex": 3,
1519
1576
  "endIndex": 5
1520
1577
  },
1521
1578
  "releaseTag": "Public",
1579
+ "isProtected": false,
1522
1580
  "overloadIndex": 1,
1523
1581
  "parameters": [
1524
1582
  {
@@ -1530,6 +1588,7 @@
1530
1588
  "isOptional": false
1531
1589
  }
1532
1590
  ],
1591
+ "isOptional": false,
1533
1592
  "name": "authenticate"
1534
1593
  },
1535
1594
  {
@@ -1550,15 +1609,16 @@
1550
1609
  "text": ";"
1551
1610
  }
1552
1611
  ],
1553
- "isOptional": false,
1554
1612
  "isStatic": false,
1555
1613
  "returnTypeTokenRange": {
1556
1614
  "startIndex": 1,
1557
1615
  "endIndex": 2
1558
1616
  },
1559
1617
  "releaseTag": "Public",
1618
+ "isProtected": false,
1560
1619
  "overloadIndex": 1,
1561
1620
  "parameters": [],
1621
+ "isOptional": false,
1562
1622
  "name": "authenticationType"
1563
1623
  },
1564
1624
  {
@@ -1579,6 +1639,7 @@
1579
1639
  "text": ";"
1580
1640
  }
1581
1641
  ],
1642
+ "isReadonly": false,
1582
1643
  "isOptional": false,
1583
1644
  "releaseTag": "Public",
1584
1645
  "name": "requiredOptions",
@@ -1586,7 +1647,8 @@
1586
1647
  "startIndex": 1,
1587
1648
  "endIndex": 2
1588
1649
  },
1589
- "isStatic": false
1650
+ "isStatic": false,
1651
+ "isProtected": true
1590
1652
  },
1591
1653
  {
1592
1654
  "kind": "Method",
@@ -1614,13 +1676,13 @@
1614
1676
  "text": ";"
1615
1677
  }
1616
1678
  ],
1617
- "isOptional": false,
1618
1679
  "isStatic": false,
1619
1680
  "returnTypeTokenRange": {
1620
1681
  "startIndex": 3,
1621
1682
  "endIndex": 4
1622
1683
  },
1623
1684
  "releaseTag": "Public",
1685
+ "isProtected": false,
1624
1686
  "overloadIndex": 1,
1625
1687
  "parameters": [
1626
1688
  {
@@ -1632,19 +1694,20 @@
1632
1694
  "isOptional": false
1633
1695
  }
1634
1696
  ],
1697
+ "isOptional": false,
1635
1698
  "name": "setBearerToken"
1636
1699
  }
1637
1700
  ],
1638
1701
  "extendsTokenRange": {
1639
1702
  "startIndex": 1,
1640
- "endIndex": 3
1703
+ "endIndex": 2
1641
1704
  },
1642
1705
  "implementsTokenRanges": []
1643
1706
  },
1644
1707
  {
1645
1708
  "kind": "Function",
1646
1709
  "canonicalReference": "ibm-cloud-sdk-core!buildRequestFileObject:function(1)",
1647
- "docComment": "/**\n * This function builds a `form-data` object for each file parameter.\n *\n * @param fileParam - The file parameter.\n *\n * @param - {NodeJS.ReadableStream|Buffer} fileParam.data The data content of the file.\n *\n * @param - {string} fileParam.filename The filename of the file.\n *\n * @param - {string} fileParam.contentType The content type of the file.\n *\n * @returns {FileObject}\n */\n",
1710
+ "docComment": "/**\n * This function builds a `form-data` object for each file parameter.\n *\n * @param fileParam - The FileWithMetadata instance that contains the file information\n *\n * @returns the FileObject instance\n */\n",
1648
1711
  "excerptTokens": [
1649
1712
  {
1650
1713
  "kind": "Content",
@@ -1682,6 +1745,7 @@
1682
1745
  "text": ";"
1683
1746
  }
1684
1747
  ],
1748
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
1685
1749
  "returnTypeTokenRange": {
1686
1750
  "startIndex": 3,
1687
1751
  "endIndex": 7
@@ -1703,7 +1767,7 @@
1703
1767
  {
1704
1768
  "kind": "Function",
1705
1769
  "canonicalReference": "ibm-cloud-sdk-core!checkCredentials:function(1)",
1706
- "docComment": "/**\n * Checks credentials for common user mistakes of copying {, }, or \" characters from the documentation\n *\n * @param obj - The options object holding credentials\n *\n * @param credsToCheck - An array containing the keys of the credentials to check for problems\n *\n * @returns {string | null} - Returns a string with the error message if there were problems, null if not\n */\n",
1770
+ "docComment": "/**\n * Checks credentials for common user mistakes of copying \\{, \\}, or \\\" characters from the documentation\n *\n * @param obj - the options object holding credentials\n *\n * @param credsToCheck - an array containing the keys of the credentials to check for problems\n *\n * @returns a string with the error message if there were problems, null if not\n */\n",
1707
1771
  "excerptTokens": [
1708
1772
  {
1709
1773
  "kind": "Content",
@@ -1739,6 +1803,7 @@
1739
1803
  "text": ";"
1740
1804
  }
1741
1805
  ],
1806
+ "fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
1742
1807
  "returnTypeTokenRange": {
1743
1808
  "startIndex": 5,
1744
1809
  "endIndex": 7
@@ -1768,7 +1833,7 @@
1768
1833
  {
1769
1834
  "kind": "Class",
1770
1835
  "canonicalReference": "ibm-cloud-sdk-core!CloudPakForDataAuthenticator:class",
1771
- "docComment": "/**\n * The [[CloudPakForDataAuthenticator]] will either use a username/password pair or a username/apikey pair to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer <bearer-token>\n */\n",
1836
+ "docComment": "/**\n * The CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer \\<bearer-token\\>\n */\n",
1772
1837
  "excerptTokens": [
1773
1838
  {
1774
1839
  "kind": "Content",
@@ -1784,13 +1849,15 @@
1784
1849
  "text": " "
1785
1850
  }
1786
1851
  ],
1852
+ "fileUrlPath": "dist/es/auth/authenticators/cloud-pak-for-data-authenticator.d.ts",
1787
1853
  "releaseTag": "Public",
1788
1854
  "name": "CloudPakForDataAuthenticator",
1855
+ "preserveMemberOrder": false,
1789
1856
  "members": [
1790
1857
  {
1791
1858
  "kind": "Constructor",
1792
1859
  "canonicalReference": "ibm-cloud-sdk-core!CloudPakForDataAuthenticator:constructor(1)",
1793
- "docComment": "/**\n * Create a new [[CloudPakForDataAuthenticator]] instance.\n *\n * @param options - Configuration options for CloudPakForData authentication.\n *\n * @param - {string} options.url For HTTP token requests.\n *\n * @param - {string} options.username The username used to obtain a bearer token.\n *\n * @param - {string} [options.password] The password used to obtain a bearer token [required if apikey not specified].\n *\n * @param - {string} [options.apikey] The API key used to obtain a bearer token [required if password not specified].\n *\n * @param - {boolean} [options.disableSslVerification] A flag that indicates whether verification of the token server's SSL certificate should be disabled or not\n *\n * @param - {object<string, string>} [options.headers] to be sent with every.\n *\n * @throws\n *\n * `Error` The username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.\n */\n",
1860
+ "docComment": "/**\n * Create a new CloudPakForDataAuthenticator instance.\n *\n * @param options - Configuration options for CloudPakForData authentication. This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service\n *\n * @throws\n *\n * Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.\n */\n",
1794
1861
  "excerptTokens": [
1795
1862
  {
1796
1863
  "kind": "Content",
@@ -1799,7 +1866,7 @@
1799
1866
  {
1800
1867
  "kind": "Reference",
1801
1868
  "text": "Options",
1802
- "canonicalReference": "ibm-cloud-sdk-core!Options:interface"
1869
+ "canonicalReference": "ibm-cloud-sdk-core!~Options_4:interface"
1803
1870
  },
1804
1871
  {
1805
1872
  "kind": "Content",
@@ -1807,6 +1874,7 @@
1807
1874
  }
1808
1875
  ],
1809
1876
  "releaseTag": "Public",
1877
+ "isProtected": false,
1810
1878
  "overloadIndex": 1,
1811
1879
  "parameters": [
1812
1880
  {
@@ -1837,15 +1905,16 @@
1837
1905
  "text": ";"
1838
1906
  }
1839
1907
  ],
1840
- "isOptional": false,
1841
1908
  "isStatic": false,
1842
1909
  "returnTypeTokenRange": {
1843
1910
  "startIndex": 1,
1844
1911
  "endIndex": 2
1845
1912
  },
1846
1913
  "releaseTag": "Public",
1914
+ "isProtected": false,
1847
1915
  "overloadIndex": 1,
1848
1916
  "parameters": [],
1917
+ "isOptional": false,
1849
1918
  "name": "authenticationType"
1850
1919
  },
1851
1920
  {
@@ -1866,6 +1935,7 @@
1866
1935
  "text": ";"
1867
1936
  }
1868
1937
  ],
1938
+ "isReadonly": false,
1869
1939
  "isOptional": false,
1870
1940
  "releaseTag": "Public",
1871
1941
  "name": "requiredOptions",
@@ -1873,7 +1943,8 @@
1873
1943
  "startIndex": 1,
1874
1944
  "endIndex": 2
1875
1945
  },
1876
- "isStatic": false
1946
+ "isStatic": false,
1947
+ "isProtected": true
1877
1948
  },
1878
1949
  {
1879
1950
  "kind": "Property",
@@ -1894,6 +1965,7 @@
1894
1965
  "text": ";"
1895
1966
  }
1896
1967
  ],
1968
+ "isReadonly": false,
1897
1969
  "isOptional": false,
1898
1970
  "releaseTag": "Public",
1899
1971
  "name": "tokenManager",
@@ -1901,19 +1973,20 @@
1901
1973
  "startIndex": 1,
1902
1974
  "endIndex": 2
1903
1975
  },
1904
- "isStatic": false
1976
+ "isStatic": false,
1977
+ "isProtected": true
1905
1978
  }
1906
1979
  ],
1907
1980
  "extendsTokenRange": {
1908
1981
  "startIndex": 1,
1909
- "endIndex": 3
1982
+ "endIndex": 2
1910
1983
  },
1911
1984
  "implementsTokenRanges": []
1912
1985
  },
1913
1986
  {
1914
1987
  "kind": "Function",
1915
1988
  "canonicalReference": "ibm-cloud-sdk-core!computeBasicAuthHeader:function(1)",
1916
- "docComment": "/**\n * Compute and return a Basic Authorization header from a username and password.\n *\n * @param username - The username or client id\n *\n * @param password - The password or client secret\n *\n * @returns {string} - A Basic Auth header with format \"Basic <encoded-credentials>\"\n */\n",
1989
+ "docComment": "/**\n * Compute and return a Basic Authorization header from a username and password.\n *\n * @param username - The username or client id\n *\n * @param password - The password or client secret\n *\n * @returns a Basic Auth header with format \"Basic <encoded-credentials>\"\n */\n",
1917
1990
  "excerptTokens": [
1918
1991
  {
1919
1992
  "kind": "Content",
@@ -1944,6 +2017,7 @@
1944
2017
  "text": ";"
1945
2018
  }
1946
2019
  ],
2020
+ "fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
1947
2021
  "returnTypeTokenRange": {
1948
2022
  "startIndex": 5,
1949
2023
  "endIndex": 6
@@ -1996,6 +2070,7 @@
1996
2070
  "text": ";"
1997
2071
  }
1998
2072
  ],
2073
+ "fileUrlPath": "dist/es/auth/utils/file-reading-helpers.d.ts",
1999
2074
  "returnTypeTokenRange": {
2000
2075
  "startIndex": 3,
2001
2076
  "endIndex": 4
@@ -2017,7 +2092,7 @@
2017
2092
  {
2018
2093
  "kind": "Function",
2019
2094
  "canonicalReference": "ibm-cloud-sdk-core!constructServiceUrl:function(1)",
2020
- "docComment": "/**\n * Constructs a service URL by formatting a parameterized URL.\n *\n * @param parameterizedUrl - URL that contains variable placeholders, e.g. '{scheme}://ibm.com'.\n *\n * @param defaultUrlVariables - Map from variable names to default values. Each variable in the parameterized URL must have a default value specified in this map.\n *\n * @param providedUrlVariables - Map from variable names to desired values. If a variable is not provided in this map, the default variable value will be used instead.\n *\n * @returns {string} The formatted URL with all variable placeholders replaced by values.\n */\n",
2095
+ "docComment": "/**\n * Constructs a service URL by formatting a parameterized URL.\n *\n * @param parameterizedUrl - a URL that contains variable placeholders, e.g. '\\{scheme\\}://ibm.com'.\n *\n * @param defaultUrlVariables - a Map of variable names to default values. Each variable in the parameterized URL must have a default value specified in this map.\n *\n * @param providedUrlVariables - a Map of variable names to desired values. If a variable is not provided in this map, the default variable value will be used instead.\n *\n * @returns the formatted URL with all variable placeholders replaced by values.\n */\n",
2021
2096
  "excerptTokens": [
2022
2097
  {
2023
2098
  "kind": "Content",
@@ -2066,6 +2141,7 @@
2066
2141
  "text": ";"
2067
2142
  }
2068
2143
  ],
2144
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
2069
2145
  "returnTypeTokenRange": {
2070
2146
  "startIndex": 9,
2071
2147
  "endIndex": 10
@@ -2103,7 +2179,7 @@
2103
2179
  {
2104
2180
  "kind": "Class",
2105
2181
  "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator:class",
2106
- "docComment": "/**\n * The [[ContainerAuthenticator]] will read a compute resource token from the file system and use this value to obtain a bearer token from the IAM token server. When the bearer token expires, a new token is obtained from the token server.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer <bearer-token>\n */\n",
2182
+ "docComment": "/**\n * The ContainerAuthenticator will read a compute resource token from the file system and use this value to obtain a bearer token from the IAM token server. When the bearer token expires, a new token is obtained from the token server.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer \\<bearer-token\\>\n */\n",
2107
2183
  "excerptTokens": [
2108
2184
  {
2109
2185
  "kind": "Content",
@@ -2119,13 +2195,15 @@
2119
2195
  "text": " "
2120
2196
  }
2121
2197
  ],
2198
+ "fileUrlPath": "dist/es/auth/authenticators/container-authenticator.d.ts",
2122
2199
  "releaseTag": "Public",
2123
2200
  "name": "ContainerAuthenticator",
2201
+ "preserveMemberOrder": false,
2124
2202
  "members": [
2125
2203
  {
2126
2204
  "kind": "Constructor",
2127
2205
  "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator:constructor(1)",
2128
- "docComment": "/**\n * Create a new [[ContainerAuthenticator]] instance.\n *\n * @param options - Configuration options for IAM authentication.\n *\n * @param - {string} [options.crTokenFilename] The file containing the compute resource token.\n *\n * @param - {string} [options.iamProfileName] The IAM profile name associated with the compute resource token.\n *\n * @param - {string} [options.iamProfileId] The IAM profile ID associated with the compute resource token.\n *\n * @param - {boolean} [options.disableSslVerification] A flag that indicates whether verification of the token server's SSL certificate should be disabled or not\n *\n * @param - {string} [options.url] for HTTP token requests.\n *\n * @param - {object<string, string>} options.headers to be sent with every\n *\n * @param - {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param - {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param - {string} [options.scope] The \"scope\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @throws\n *\n * {Error} When the configuration options are not valid.\n */\n",
2206
+ "docComment": "/**\n * Create a new ContainerAuthenticator instance.\n *\n * @param options - Configuration options for IAM authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - crTokenFilename: (optional) the file containing the compute resource token - iamProfileName: (optional) the name of the IAM trusted profile associated with the compute resource token (required if iamProfileId is not specified) - iamProfileId]: (optional) the ID of the IAM trusted profile associated with the compute resource token (required if iamProfileName is not specified) - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service - clientId: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the \"scope\" parameter to use when fetching the bearer token from the token service\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n",
2129
2207
  "excerptTokens": [
2130
2208
  {
2131
2209
  "kind": "Content",
@@ -2134,7 +2212,7 @@
2134
2212
  {
2135
2213
  "kind": "Reference",
2136
2214
  "text": "Options",
2137
- "canonicalReference": "ibm-cloud-sdk-core!Options:interface"
2215
+ "canonicalReference": "ibm-cloud-sdk-core!~Options_8:interface"
2138
2216
  },
2139
2217
  {
2140
2218
  "kind": "Content",
@@ -2142,6 +2220,7 @@
2142
2220
  }
2143
2221
  ],
2144
2222
  "releaseTag": "Public",
2223
+ "isProtected": false,
2145
2224
  "overloadIndex": 1,
2146
2225
  "parameters": [
2147
2226
  {
@@ -2172,21 +2251,22 @@
2172
2251
  "text": ";"
2173
2252
  }
2174
2253
  ],
2175
- "isOptional": false,
2176
2254
  "isStatic": false,
2177
2255
  "returnTypeTokenRange": {
2178
2256
  "startIndex": 1,
2179
2257
  "endIndex": 2
2180
2258
  },
2181
2259
  "releaseTag": "Public",
2260
+ "isProtected": false,
2182
2261
  "overloadIndex": 1,
2183
2262
  "parameters": [],
2263
+ "isOptional": false,
2184
2264
  "name": "authenticationType"
2185
2265
  },
2186
2266
  {
2187
2267
  "kind": "Method",
2188
2268
  "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator#setCrTokenFilename:member(1)",
2189
- "docComment": "/**\n * Setter for the filename of the compute resource token.\n *\n * @param A - string containing a path to the CR token file\n */\n",
2269
+ "docComment": "/**\n * Setter for the filename of the compute resource token.\n *\n * @param crTokenFilename - A string containing a path to the CR token file\n */\n",
2190
2270
  "excerptTokens": [
2191
2271
  {
2192
2272
  "kind": "Content",
@@ -2209,13 +2289,13 @@
2209
2289
  "text": ";"
2210
2290
  }
2211
2291
  ],
2212
- "isOptional": false,
2213
2292
  "isStatic": false,
2214
2293
  "returnTypeTokenRange": {
2215
2294
  "startIndex": 3,
2216
2295
  "endIndex": 4
2217
2296
  },
2218
2297
  "releaseTag": "Public",
2298
+ "isProtected": false,
2219
2299
  "overloadIndex": 1,
2220
2300
  "parameters": [
2221
2301
  {
@@ -2227,12 +2307,13 @@
2227
2307
  "isOptional": false
2228
2308
  }
2229
2309
  ],
2310
+ "isOptional": false,
2230
2311
  "name": "setCrTokenFilename"
2231
2312
  },
2232
2313
  {
2233
2314
  "kind": "Method",
2234
2315
  "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator#setIamProfileId:member(1)",
2235
- "docComment": "/**\n * Setter for the \"profile_id\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param A - string that makes up the iamProfileId parameter\n */\n",
2316
+ "docComment": "/**\n * Setter for the \"profile_id\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param iamProfileId - the ID of the IAM trusted profile\n */\n",
2236
2317
  "excerptTokens": [
2237
2318
  {
2238
2319
  "kind": "Content",
@@ -2255,13 +2336,13 @@
2255
2336
  "text": ";"
2256
2337
  }
2257
2338
  ],
2258
- "isOptional": false,
2259
2339
  "isStatic": false,
2260
2340
  "returnTypeTokenRange": {
2261
2341
  "startIndex": 3,
2262
2342
  "endIndex": 4
2263
2343
  },
2264
2344
  "releaseTag": "Public",
2345
+ "isProtected": false,
2265
2346
  "overloadIndex": 1,
2266
2347
  "parameters": [
2267
2348
  {
@@ -2273,12 +2354,13 @@
2273
2354
  "isOptional": false
2274
2355
  }
2275
2356
  ],
2357
+ "isOptional": false,
2276
2358
  "name": "setIamProfileId"
2277
2359
  },
2278
2360
  {
2279
2361
  "kind": "Method",
2280
2362
  "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator#setIamProfileName:member(1)",
2281
- "docComment": "/**\n * Setter for the \"profile_name\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param A - string that makes up the iamProfileName parameter\n */\n",
2363
+ "docComment": "/**\n * Setter for the \"profile_name\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param iamProfileName - the name of the IAM trusted profile\n */\n",
2282
2364
  "excerptTokens": [
2283
2365
  {
2284
2366
  "kind": "Content",
@@ -2301,13 +2383,13 @@
2301
2383
  "text": ";"
2302
2384
  }
2303
2385
  ],
2304
- "isOptional": false,
2305
2386
  "isStatic": false,
2306
2387
  "returnTypeTokenRange": {
2307
2388
  "startIndex": 3,
2308
2389
  "endIndex": 4
2309
2390
  },
2310
2391
  "releaseTag": "Public",
2392
+ "isProtected": false,
2311
2393
  "overloadIndex": 1,
2312
2394
  "parameters": [
2313
2395
  {
@@ -2319,6 +2401,7 @@
2319
2401
  "isOptional": false
2320
2402
  }
2321
2403
  ],
2404
+ "isOptional": false,
2322
2405
  "name": "setIamProfileName"
2323
2406
  },
2324
2407
  {
@@ -2340,6 +2423,7 @@
2340
2423
  "text": ";"
2341
2424
  }
2342
2425
  ],
2426
+ "isReadonly": false,
2343
2427
  "isOptional": false,
2344
2428
  "releaseTag": "Public",
2345
2429
  "name": "tokenManager",
@@ -2347,12 +2431,13 @@
2347
2431
  "startIndex": 1,
2348
2432
  "endIndex": 2
2349
2433
  },
2350
- "isStatic": false
2434
+ "isStatic": false,
2435
+ "isProtected": true
2351
2436
  }
2352
2437
  ],
2353
2438
  "extendsTokenRange": {
2354
2439
  "startIndex": 1,
2355
- "endIndex": 3
2440
+ "endIndex": 2
2356
2441
  },
2357
2442
  "implementsTokenRanges": []
2358
2443
  },
@@ -2375,13 +2460,15 @@
2375
2460
  "text": " "
2376
2461
  }
2377
2462
  ],
2463
+ "fileUrlPath": "dist/es/auth/token-managers/container-token-manager.d.ts",
2378
2464
  "releaseTag": "Public",
2379
2465
  "name": "ContainerTokenManager",
2466
+ "preserveMemberOrder": false,
2380
2467
  "members": [
2381
2468
  {
2382
2469
  "kind": "Constructor",
2383
2470
  "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager:constructor(1)",
2384
- "docComment": "/**\n * Create a new [[ContainerTokenManager]] instance.\n *\n * @param options - Configuration options.\n *\n * @param crTokenFilename - The file containing the compute resource token.\n *\n * @param iamProfileName - The IAM profile name associated with the compute resource token.\n *\n * @param iamProfileId - The IAM profile ID associated with the compute resource token.\n *\n * @param - {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param - {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param url - The IAM endpoint for token requests.\n *\n * @param - {boolean} [options.disableSslVerification] A flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n *\n * @param - {object<string, string>} [options.headers] Headers to be sent with every outbound HTTP requests to token services. @constructor\n */\n",
2471
+ "docComment": "/**\n * Create a new ContainerTokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service (default: \"https://iam.cloud.ibm.com\") - crTokenFilename: (optional) the file containing the compute resource token (default: \"/var/run/secrets/tokens/vault-token\") - iamProfileName: (optional) the name of the IAM trusted profile associated with the compute resource token (required if iamProfileId is not specified) - iamProfileId]: (optional) the ID of the IAM trusted profile associated with the compute resource token (required if iamProfileName is not specified) - headers: (optional) a set of HTTP headers to be sent with each request to the token service - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - clientId: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service\n *\n * @throws\n *\n * Error: the configuration options were invalid\n */\n",
2385
2472
  "excerptTokens": [
2386
2473
  {
2387
2474
  "kind": "Content",
@@ -2390,7 +2477,7 @@
2390
2477
  {
2391
2478
  "kind": "Reference",
2392
2479
  "text": "Options",
2393
- "canonicalReference": "ibm-cloud-sdk-core!~Options:interface"
2480
+ "canonicalReference": "ibm-cloud-sdk-core!~Options_7:interface"
2394
2481
  },
2395
2482
  {
2396
2483
  "kind": "Content",
@@ -2398,6 +2485,7 @@
2398
2485
  }
2399
2486
  ],
2400
2487
  "releaseTag": "Public",
2488
+ "isProtected": false,
2401
2489
  "overloadIndex": 1,
2402
2490
  "parameters": [
2403
2491
  {
@@ -2413,7 +2501,7 @@
2413
2501
  {
2414
2502
  "kind": "Method",
2415
2503
  "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager#requestToken:member(1)",
2416
- "docComment": "/**\n * Request an IAM token using a compute resource token.\n *\n * @returns {Promise}\n */\n",
2504
+ "docComment": "/**\n * Request an IAM token using a compute resource token.\n */\n",
2417
2505
  "excerptTokens": [
2418
2506
  {
2419
2507
  "kind": "Content",
@@ -2433,21 +2521,22 @@
2433
2521
  "text": ";"
2434
2522
  }
2435
2523
  ],
2436
- "isOptional": false,
2437
2524
  "isStatic": false,
2438
2525
  "returnTypeTokenRange": {
2439
2526
  "startIndex": 1,
2440
2527
  "endIndex": 3
2441
2528
  },
2442
2529
  "releaseTag": "Public",
2530
+ "isProtected": true,
2443
2531
  "overloadIndex": 1,
2444
2532
  "parameters": [],
2533
+ "isOptional": false,
2445
2534
  "name": "requestToken"
2446
2535
  },
2447
2536
  {
2448
2537
  "kind": "Method",
2449
2538
  "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager#setCrTokenFilename:member(1)",
2450
- "docComment": "/**\n * Setter for the filename of the compute resource token.\n *\n * @param crTokenFilename - A string containing a path to the CR token file\n */\n",
2539
+ "docComment": "/**\n * Sets the \"crTokenFilename\" field\n *\n * @param crTokenFilename - the name of the file containing the CR token\n */\n",
2451
2540
  "excerptTokens": [
2452
2541
  {
2453
2542
  "kind": "Content",
@@ -2470,13 +2559,13 @@
2470
2559
  "text": ";"
2471
2560
  }
2472
2561
  ],
2473
- "isOptional": false,
2474
2562
  "isStatic": false,
2475
2563
  "returnTypeTokenRange": {
2476
2564
  "startIndex": 3,
2477
2565
  "endIndex": 4
2478
2566
  },
2479
2567
  "releaseTag": "Public",
2568
+ "isProtected": false,
2480
2569
  "overloadIndex": 1,
2481
2570
  "parameters": [
2482
2571
  {
@@ -2488,12 +2577,13 @@
2488
2577
  "isOptional": false
2489
2578
  }
2490
2579
  ],
2580
+ "isOptional": false,
2491
2581
  "name": "setCrTokenFilename"
2492
2582
  },
2493
2583
  {
2494
2584
  "kind": "Method",
2495
2585
  "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager#setIamProfileId:member(1)",
2496
- "docComment": "/**\n * Setter for the \"profile_id\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param iamProfileId - A string that makes up the iamProfileId parameter\n */\n",
2586
+ "docComment": "/**\n * Sets the ID of the IAM trusted profile to use when obtaining an access token from the IAM token server.\n *\n * @param iamProfileId - the ID of the IAM trusted profile\n */\n",
2497
2587
  "excerptTokens": [
2498
2588
  {
2499
2589
  "kind": "Content",
@@ -2516,13 +2606,13 @@
2516
2606
  "text": ";"
2517
2607
  }
2518
2608
  ],
2519
- "isOptional": false,
2520
2609
  "isStatic": false,
2521
2610
  "returnTypeTokenRange": {
2522
2611
  "startIndex": 3,
2523
2612
  "endIndex": 4
2524
2613
  },
2525
2614
  "releaseTag": "Public",
2615
+ "isProtected": false,
2526
2616
  "overloadIndex": 1,
2527
2617
  "parameters": [
2528
2618
  {
@@ -2534,12 +2624,13 @@
2534
2624
  "isOptional": false
2535
2625
  }
2536
2626
  ],
2627
+ "isOptional": false,
2537
2628
  "name": "setIamProfileId"
2538
2629
  },
2539
2630
  {
2540
2631
  "kind": "Method",
2541
2632
  "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager#setIamProfileName:member(1)",
2542
- "docComment": "/**\n * Setter for the \"profile_name\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param iamProfileName - A string that makes up the iamProfileName parameter\n */\n",
2633
+ "docComment": "/**\n * Sets the name of the IAM trusted profile to use when obtaining an access token from the IAM token server.\n *\n * @param iamProfileName - the name of the IAM trusted profile\n */\n",
2543
2634
  "excerptTokens": [
2544
2635
  {
2545
2636
  "kind": "Content",
@@ -2562,13 +2653,13 @@
2562
2653
  "text": ";"
2563
2654
  }
2564
2655
  ],
2565
- "isOptional": false,
2566
2656
  "isStatic": false,
2567
2657
  "returnTypeTokenRange": {
2568
2658
  "startIndex": 3,
2569
2659
  "endIndex": 4
2570
2660
  },
2571
2661
  "releaseTag": "Public",
2662
+ "isProtected": false,
2572
2663
  "overloadIndex": 1,
2573
2664
  "parameters": [
2574
2665
  {
@@ -2580,12 +2671,13 @@
2580
2671
  "isOptional": false
2581
2672
  }
2582
2673
  ],
2674
+ "isOptional": false,
2583
2675
  "name": "setIamProfileName"
2584
2676
  }
2585
2677
  ],
2586
2678
  "extendsTokenRange": {
2587
2679
  "startIndex": 1,
2588
- "endIndex": 3
2680
+ "endIndex": 2
2589
2681
  },
2590
2682
  "implementsTokenRanges": []
2591
2683
  },
@@ -2657,6 +2749,8 @@
2657
2749
  "text": ") => string;\n}"
2658
2750
  }
2659
2751
  ],
2752
+ "fileUrlPath": "dist/es/lib/content-type.d.ts",
2753
+ "isReadonly": true,
2660
2754
  "releaseTag": "Public",
2661
2755
  "name": "contentType",
2662
2756
  "variableTypeTokenRange": {
@@ -2683,13 +2777,15 @@
2683
2777
  "text": " "
2684
2778
  }
2685
2779
  ],
2780
+ "fileUrlPath": "dist/es/auth/token-managers/cp4d-token-manager.d.ts",
2686
2781
  "releaseTag": "Public",
2687
2782
  "name": "Cp4dTokenManager",
2783
+ "preserveMemberOrder": false,
2688
2784
  "members": [
2689
2785
  {
2690
2786
  "kind": "Constructor",
2691
2787
  "canonicalReference": "ibm-cloud-sdk-core!Cp4dTokenManager:constructor(1)",
2692
- "docComment": "/**\n * Create a new [[Cp4dTokenManager]] instance.\n *\n * @param options - Configuration options.\n *\n * @param - {string} options.username The username used to obtain a bearer token.\n *\n * @param - {string} options.password The password used to obtain a bearer token [required if apikey not specified].\n *\n * @param - {string} options.apikey The API key used to obtain a bearer token [required if password not specified].\n *\n * @param - {string} options.url The endpoint for CP4D token requests.\n *\n * @param - {boolean} [options.disableSslVerification] A flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n *\n * @param - {object<string, string>} [options.headers] Headers to be sent with every outbound HTTP requests to token services. @constructor\n */\n",
2788
+ "docComment": "/**\n * Create a new Cp4dTokenManager instance.\n *\n * @param options - Configuration options This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service\n *\n * @throws\n *\n * Error: the configuration options were invalid.\n */\n",
2693
2789
  "excerptTokens": [
2694
2790
  {
2695
2791
  "kind": "Content",
@@ -2698,7 +2794,7 @@
2698
2794
  {
2699
2795
  "kind": "Reference",
2700
2796
  "text": "Options",
2701
- "canonicalReference": "ibm-cloud-sdk-core!~Options:interface"
2797
+ "canonicalReference": "ibm-cloud-sdk-core!~Options_3:interface"
2702
2798
  },
2703
2799
  {
2704
2800
  "kind": "Content",
@@ -2706,6 +2802,7 @@
2706
2802
  }
2707
2803
  ],
2708
2804
  "releaseTag": "Public",
2805
+ "isProtected": false,
2709
2806
  "overloadIndex": 1,
2710
2807
  "parameters": [
2711
2808
  {
@@ -2741,15 +2838,16 @@
2741
2838
  "text": ";"
2742
2839
  }
2743
2840
  ],
2744
- "isOptional": false,
2745
2841
  "isStatic": false,
2746
2842
  "returnTypeTokenRange": {
2747
2843
  "startIndex": 1,
2748
2844
  "endIndex": 3
2749
2845
  },
2750
2846
  "releaseTag": "Public",
2847
+ "isProtected": true,
2751
2848
  "overloadIndex": 1,
2752
2849
  "parameters": [],
2850
+ "isOptional": false,
2753
2851
  "name": "requestToken"
2754
2852
  },
2755
2853
  {
@@ -2770,6 +2868,7 @@
2770
2868
  "text": ";"
2771
2869
  }
2772
2870
  ],
2871
+ "isReadonly": false,
2773
2872
  "isOptional": false,
2774
2873
  "releaseTag": "Public",
2775
2874
  "name": "requiredOptions",
@@ -2777,12 +2876,13 @@
2777
2876
  "startIndex": 1,
2778
2877
  "endIndex": 2
2779
2878
  },
2780
- "isStatic": false
2879
+ "isStatic": false,
2880
+ "isProtected": true
2781
2881
  }
2782
2882
  ],
2783
2883
  "extendsTokenRange": {
2784
2884
  "startIndex": 1,
2785
- "endIndex": 3
2885
+ "endIndex": 2
2786
2886
  },
2787
2887
  "implementsTokenRanges": []
2788
2888
  },
@@ -2812,6 +2912,7 @@
2812
2912
  "text": ";"
2813
2913
  }
2814
2914
  ],
2915
+ "fileUrlPath": "dist/es/auth/utils/file-reading-helpers.d.ts",
2815
2916
  "returnTypeTokenRange": {
2816
2917
  "startIndex": 3,
2817
2918
  "endIndex": 4
@@ -2833,15 +2934,17 @@
2833
2934
  {
2834
2935
  "kind": "Interface",
2835
2936
  "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface",
2836
- "docComment": "/**\n * (C) Copyright IBM Corp. 2014, 2021.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n */\n",
2937
+ "docComment": "/**\n * (C) Copyright IBM Corp. 2014, 2022.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n */\n",
2837
2938
  "excerptTokens": [
2838
2939
  {
2839
2940
  "kind": "Content",
2840
2941
  "text": "export interface FileObject "
2841
2942
  }
2842
2943
  ],
2944
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
2843
2945
  "releaseTag": "Public",
2844
2946
  "name": "FileObject",
2947
+ "preserveMemberOrder": false,
2845
2948
  "members": [
2846
2949
  {
2847
2950
  "kind": "PropertySignature",
@@ -2862,6 +2965,7 @@
2862
2965
  "text": ";"
2863
2966
  }
2864
2967
  ],
2968
+ "isReadonly": false,
2865
2969
  "isOptional": true,
2866
2970
  "releaseTag": "Public",
2867
2971
  "name": "options",
@@ -2902,6 +3006,7 @@
2902
3006
  "text": ";"
2903
3007
  }
2904
3008
  ],
3009
+ "isReadonly": false,
2905
3010
  "isOptional": false,
2906
3011
  "releaseTag": "Public",
2907
3012
  "name": "value",
@@ -2923,8 +3028,10 @@
2923
3028
  "text": "export interface FileOptions "
2924
3029
  }
2925
3030
  ],
3031
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
2926
3032
  "releaseTag": "Public",
2927
3033
  "name": "FileOptions",
3034
+ "preserveMemberOrder": false,
2928
3035
  "members": [
2929
3036
  {
2930
3037
  "kind": "PropertySignature",
@@ -2944,6 +3051,7 @@
2944
3051
  "text": ";"
2945
3052
  }
2946
3053
  ],
3054
+ "isReadonly": false,
2947
3055
  "isOptional": true,
2948
3056
  "releaseTag": "Public",
2949
3057
  "name": "contentType",
@@ -2970,6 +3078,7 @@
2970
3078
  "text": ";"
2971
3079
  }
2972
3080
  ],
3081
+ "isReadonly": false,
2973
3082
  "isOptional": true,
2974
3083
  "releaseTag": "Public",
2975
3084
  "name": "filename",
@@ -3000,8 +3109,10 @@
3000
3109
  "text": " "
3001
3110
  }
3002
3111
  ],
3112
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
3003
3113
  "releaseTag": "Public",
3004
3114
  "name": "FileStream",
3115
+ "preserveMemberOrder": false,
3005
3116
  "members": [
3006
3117
  {
3007
3118
  "kind": "PropertySignature",
@@ -3026,6 +3137,7 @@
3026
3137
  "text": ";"
3027
3138
  }
3028
3139
  ],
3140
+ "isReadonly": false,
3029
3141
  "isOptional": false,
3030
3142
  "releaseTag": "Public",
3031
3143
  "name": "path",
@@ -3038,7 +3150,7 @@
3038
3150
  "extendsTokenRanges": [
3039
3151
  {
3040
3152
  "startIndex": 1,
3041
- "endIndex": 3
3153
+ "endIndex": 2
3042
3154
  }
3043
3155
  ]
3044
3156
  },
@@ -3052,8 +3164,10 @@
3052
3164
  "text": "export interface FileWithMetadata "
3053
3165
  }
3054
3166
  ],
3167
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
3055
3168
  "releaseTag": "Public",
3056
3169
  "name": "FileWithMetadata",
3170
+ "preserveMemberOrder": false,
3057
3171
  "members": [
3058
3172
  {
3059
3173
  "kind": "PropertySignature",
@@ -3073,6 +3187,7 @@
3073
3187
  "text": ";"
3074
3188
  }
3075
3189
  ],
3190
+ "isReadonly": false,
3076
3191
  "isOptional": false,
3077
3192
  "releaseTag": "Public",
3078
3193
  "name": "contentType",
@@ -3109,6 +3224,7 @@
3109
3224
  "text": ";"
3110
3225
  }
3111
3226
  ],
3227
+ "isReadonly": false,
3112
3228
  "isOptional": false,
3113
3229
  "releaseTag": "Public",
3114
3230
  "name": "data",
@@ -3135,6 +3251,7 @@
3135
3251
  "text": ";"
3136
3252
  }
3137
3253
  ],
3254
+ "isReadonly": false,
3138
3255
  "isOptional": false,
3139
3256
  "releaseTag": "Public",
3140
3257
  "name": "filename",
@@ -3149,7 +3266,7 @@
3149
3266
  {
3150
3267
  "kind": "Function",
3151
3268
  "canonicalReference": "ibm-cloud-sdk-core!getAuthenticatorFromEnvironment:function(1)",
3152
- "docComment": "/**\n * Look for external configuration of authenticator.\n *\n * Try to get authenticator from external sources, with the following priority: 1. Credentials file (ibm-credentials.env) 2. Environment variables 3. VCAP Services (Cloud Foundry)\n *\n * @param serviceName - The service name prefix.\n */\n",
3269
+ "docComment": "/**\n * Look for external configuration of authenticator.\n *\n * Try to get authenticator from external sources, with the following priority: 1. Credentials file (ibm-credentials.env) 2. Environment variables 3. VCAP Services (Cloud Foundry)\n *\n * @param serviceName - the service name prefix.\n */\n",
3153
3270
  "excerptTokens": [
3154
3271
  {
3155
3272
  "kind": "Content",
@@ -3173,6 +3290,7 @@
3173
3290
  "text": ";"
3174
3291
  }
3175
3292
  ],
3293
+ "fileUrlPath": "dist/es/auth/utils/get-authenticator-from-environment.d.ts",
3176
3294
  "returnTypeTokenRange": {
3177
3295
  "startIndex": 3,
3178
3296
  "endIndex": 4
@@ -3194,7 +3312,7 @@
3194
3312
  {
3195
3313
  "kind": "Function",
3196
3314
  "canonicalReference": "ibm-cloud-sdk-core!getContentType:function(1)",
3197
- "docComment": "/**\n * This function retrieves the content type of the input.\n *\n * @param inputData - The data to retrieve content type for.\n *\n * @returns {string} the content type of the input.\n */\n",
3315
+ "docComment": "/**\n * This function retrieves the content type of the input.\n *\n * @param inputData - The data to retrieve content type for.\n *\n * @returns the content type of the input.\n */\n",
3198
3316
  "excerptTokens": [
3199
3317
  {
3200
3318
  "kind": "Content",
@@ -3232,6 +3350,7 @@
3232
3350
  "text": ";"
3233
3351
  }
3234
3352
  ],
3353
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
3235
3354
  "returnTypeTokenRange": {
3236
3355
  "startIndex": 5,
3237
3356
  "endIndex": 7
@@ -3253,7 +3372,7 @@
3253
3372
  {
3254
3373
  "kind": "Function",
3255
3374
  "canonicalReference": "ibm-cloud-sdk-core!getCurrentTime:function(1)",
3256
- "docComment": "/**\n * Get the current time\n *\n * @returns {number} - Returns the current time in seconds.\n */\n",
3375
+ "docComment": "/**\n * Gets the current time.\n *\n * @returns the current time in seconds.\n */\n",
3257
3376
  "excerptTokens": [
3258
3377
  {
3259
3378
  "kind": "Content",
@@ -3268,6 +3387,7 @@
3268
3387
  "text": ";"
3269
3388
  }
3270
3389
  ],
3390
+ "fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
3271
3391
  "returnTypeTokenRange": {
3272
3392
  "startIndex": 1,
3273
3393
  "endIndex": 2
@@ -3280,7 +3400,7 @@
3280
3400
  {
3281
3401
  "kind": "Function",
3282
3402
  "canonicalReference": "ibm-cloud-sdk-core!getFormat:function(1)",
3283
- "docComment": "/**\n * Returns the first match from formats that is key the params map otherwise null\n *\n * @param params - The parameters.\n *\n * @param requires - The keys we want to check\n *\n * @returns {string|null}\n */\n",
3403
+ "docComment": "/**\n * Returns the first match from formats that is key the params map otherwise null\n *\n * @param params - The parameters.\n *\n * @param requires - The keys we want to check\n */\n",
3284
3404
  "excerptTokens": [
3285
3405
  {
3286
3406
  "kind": "Content",
@@ -3311,6 +3431,7 @@
3311
3431
  "text": ";"
3312
3432
  }
3313
3433
  ],
3434
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
3314
3435
  "returnTypeTokenRange": {
3315
3436
  "startIndex": 5,
3316
3437
  "endIndex": 6
@@ -3340,7 +3461,7 @@
3340
3461
  {
3341
3462
  "kind": "Function",
3342
3463
  "canonicalReference": "ibm-cloud-sdk-core!getMissingParams:function(1)",
3343
- "docComment": "/**\n * Validates that all required params are provided\n *\n * @param params - the method parameters.\n *\n * @param requires - the required parameter names.\n *\n * @returns {Error|null}\n */\n",
3464
+ "docComment": "/**\n * Validates that all required params are provided\n *\n * @param params - the method parameters.\n *\n * @param requires - the required parameter names.\n *\n * @returns null if no errors found, otherwise an Error instance\n */\n",
3344
3465
  "excerptTokens": [
3345
3466
  {
3346
3467
  "kind": "Content",
@@ -3376,6 +3497,7 @@
3376
3497
  "text": ";"
3377
3498
  }
3378
3499
  ],
3500
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
3379
3501
  "returnTypeTokenRange": {
3380
3502
  "startIndex": 5,
3381
3503
  "endIndex": 7
@@ -3405,7 +3527,7 @@
3405
3527
  {
3406
3528
  "kind": "Function",
3407
3529
  "canonicalReference": "ibm-cloud-sdk-core!getNewLogger:function(1)",
3408
- "docComment": "/**\n * Return a new logger, formatted with a particular name. The logging functions, in order of increasing verbosity, are: `error`, `warn`, `info`, `verbose`, and `debug`.\n *\n * The logger will be an instance of the `debug` package and utilizes its support for configuration with environment variables.\n *\n * Additionally, the logger will be turned on automatically if the \"NODE_DEBUG\" environment variable is set to \"axios\".\n *\n * @param moduleName - the namespace for the logger. The name will appear in the logs and it will be the name used for configuring the log level.\n *\n * @returns {SDKLogger} the new logger\n */\n",
3530
+ "docComment": "/**\n * Return a new logger, formatted with a particular name. The logging functions, in order of increasing verbosity, are: `error`, `warn`, `info`, `verbose`, and `debug`.\n *\n * The logger will be an instance of the `debug` package and utilizes its support for configuration with environment variables.\n *\n * Additionally, the logger will be turned on automatically if the \"NODE_DEBUG\" environment variable is set to \"axios\".\n *\n * @param moduleName - the namespace for the logger. The name will appear in the logs and it will be the name used for configuring the log level.\n *\n * @returns the new logger\n */\n",
3409
3531
  "excerptTokens": [
3410
3532
  {
3411
3533
  "kind": "Content",
@@ -3429,6 +3551,7 @@
3429
3551
  "text": ";"
3430
3552
  }
3431
3553
  ],
3554
+ "fileUrlPath": "dist/es/lib/get-new-logger.d.ts",
3432
3555
  "returnTypeTokenRange": {
3433
3556
  "startIndex": 3,
3434
3557
  "endIndex": 4
@@ -3450,7 +3573,7 @@
3450
3573
  {
3451
3574
  "kind": "Function",
3452
3575
  "canonicalReference": "ibm-cloud-sdk-core!getQueryParam:function(1)",
3453
- "docComment": "/**\n * Return a query parameter value from a URL\n *\n * @param urlStr - the url string.\n *\n * @param param - the name of the query parameter whose value should be returned\n *\n * @returns {string} the value of the `param` query parameter\n *\n * @throws\n *\n * if urlStr is an invalid URL\n */\n",
3576
+ "docComment": "/**\n * Return a query parameter value from a URL\n *\n * @param urlStr - the url string.\n *\n * @param param - the name of the query parameter whose value should be returned\n *\n * @returns the value of the \"param\" query parameter\n */\n",
3454
3577
  "excerptTokens": [
3455
3578
  {
3456
3579
  "kind": "Content",
@@ -3481,6 +3604,7 @@
3481
3604
  "text": ";"
3482
3605
  }
3483
3606
  ],
3607
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
3484
3608
  "returnTypeTokenRange": {
3485
3609
  "startIndex": 5,
3486
3610
  "endIndex": 6
@@ -3510,7 +3634,7 @@
3510
3634
  {
3511
3635
  "kind": "Class",
3512
3636
  "canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator:class",
3513
- "docComment": "/**\n * The [[IamAuthenticator]] will use the user-supplied `apikey` values to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server. If specified, the optional, mutually inclusive `clientId` and`clientSecret` pair can be used to influence rate-limiting for requests to the IAM token server.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer <bearer-token>\n */\n",
3637
+ "docComment": "/**\n * The IamAuthenticator will use the user-supplied `apikey` value to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server. If specified, the optional, mutually inclusive \"clientId\" and \"clientSecret\" pair can be used to influence rate-limiting for requests to the IAM token server.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer \\<bearer-token\\>\n */\n",
3514
3638
  "excerptTokens": [
3515
3639
  {
3516
3640
  "kind": "Content",
@@ -3526,13 +3650,15 @@
3526
3650
  "text": " "
3527
3651
  }
3528
3652
  ],
3653
+ "fileUrlPath": "dist/es/auth/authenticators/iam-authenticator.d.ts",
3529
3654
  "releaseTag": "Public",
3530
3655
  "name": "IamAuthenticator",
3656
+ "preserveMemberOrder": false,
3531
3657
  "members": [
3532
3658
  {
3533
3659
  "kind": "Constructor",
3534
3660
  "canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator:constructor(1)",
3535
- "docComment": "/**\n * Create a new [[IamAuthenticator]] instance.\n *\n * @param options - Configuration options for IAM authentication.\n *\n * @param - {boolean} options.disableSslVerification A flag that indicates whether verification of the token server's SSL certificate should be disabled or not\n *\n * @param - {string} options.url for HTTP token requests.\n *\n * @param - {object<string, string>} options.headers to be sent with every\n *\n * @param - {string} options.apikey The IAM api key.\n *\n * @param - {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param - {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param - {string} [options.scope] The \"scope\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @throws\n *\n * {Error} When the configuration options are not valid.\n */\n",
3661
+ "docComment": "/**\n * Create a new IamAuthenticator instance.\n *\n * @param options - Configuration options for IAM authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - apikey: (required) the IAM api key - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service - clientId: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the \"scope\" parameter to use when fetching the bearer token from the token service\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n",
3536
3662
  "excerptTokens": [
3537
3663
  {
3538
3664
  "kind": "Content",
@@ -3541,7 +3667,7 @@
3541
3667
  {
3542
3668
  "kind": "Reference",
3543
3669
  "text": "Options",
3544
- "canonicalReference": "ibm-cloud-sdk-core!Options:interface"
3670
+ "canonicalReference": "ibm-cloud-sdk-core!~Options_6:interface"
3545
3671
  },
3546
3672
  {
3547
3673
  "kind": "Content",
@@ -3549,6 +3675,7 @@
3549
3675
  }
3550
3676
  ],
3551
3677
  "releaseTag": "Public",
3678
+ "isProtected": false,
3552
3679
  "overloadIndex": 1,
3553
3680
  "parameters": [
3554
3681
  {
@@ -3579,15 +3706,16 @@
3579
3706
  "text": ";"
3580
3707
  }
3581
3708
  ],
3582
- "isOptional": false,
3583
3709
  "isStatic": false,
3584
3710
  "returnTypeTokenRange": {
3585
3711
  "startIndex": 1,
3586
3712
  "endIndex": 2
3587
3713
  },
3588
3714
  "releaseTag": "Public",
3715
+ "isProtected": false,
3589
3716
  "overloadIndex": 1,
3590
3717
  "parameters": [],
3718
+ "isOptional": false,
3591
3719
  "name": "authenticationType"
3592
3720
  },
3593
3721
  {
@@ -3608,6 +3736,7 @@
3608
3736
  "text": ";"
3609
3737
  }
3610
3738
  ],
3739
+ "isReadonly": false,
3611
3740
  "isOptional": false,
3612
3741
  "releaseTag": "Public",
3613
3742
  "name": "requiredOptions",
@@ -3615,7 +3744,8 @@
3615
3744
  "startIndex": 1,
3616
3745
  "endIndex": 2
3617
3746
  },
3618
- "isStatic": false
3747
+ "isStatic": false,
3748
+ "isProtected": true
3619
3749
  },
3620
3750
  {
3621
3751
  "kind": "Property",
@@ -3636,6 +3766,7 @@
3636
3766
  "text": ";"
3637
3767
  }
3638
3768
  ],
3769
+ "isReadonly": false,
3639
3770
  "isOptional": false,
3640
3771
  "releaseTag": "Public",
3641
3772
  "name": "tokenManager",
@@ -3643,19 +3774,20 @@
3643
3774
  "startIndex": 1,
3644
3775
  "endIndex": 2
3645
3776
  },
3646
- "isStatic": false
3777
+ "isStatic": false,
3778
+ "isProtected": true
3647
3779
  }
3648
3780
  ],
3649
3781
  "extendsTokenRange": {
3650
3782
  "startIndex": 1,
3651
- "endIndex": 3
3783
+ "endIndex": 2
3652
3784
  },
3653
3785
  "implementsTokenRanges": []
3654
3786
  },
3655
3787
  {
3656
3788
  "kind": "Class",
3657
3789
  "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator:class",
3658
- "docComment": "/**\n * The [[IamRequestBasedAuthenticator]] provides shared configuration and functionality for authenticators that interact with the IAM service to inherit. This authenticator is not meant for use on its own.\n */\n",
3790
+ "docComment": "/**\n * The IamRequestBasedAuthenticator provides shared configuration and functionality for authenticators that interact with the IAM token service. This authenticator is not meant for use on its own.\n */\n",
3659
3791
  "excerptTokens": [
3660
3792
  {
3661
3793
  "kind": "Content",
@@ -3671,13 +3803,15 @@
3671
3803
  "text": " "
3672
3804
  }
3673
3805
  ],
3806
+ "fileUrlPath": "dist/es/auth/authenticators/iam-request-based-authenticator.d.ts",
3674
3807
  "releaseTag": "Public",
3675
3808
  "name": "IamRequestBasedAuthenticator",
3809
+ "preserveMemberOrder": false,
3676
3810
  "members": [
3677
3811
  {
3678
3812
  "kind": "Constructor",
3679
3813
  "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator:constructor(1)",
3680
- "docComment": "/**\n * Create a new [[IamRequestBasedAuthenticator]] instance.\n *\n * @param options - Configuration options for IAM authentication.\n *\n * @param - {boolean} options.disableSslVerification A flag that indicates whether verification of the token server's SSL certificate should be disabled or not\n *\n * @param - {string} options.url for HTTP token requests.\n *\n * @param - {object<string, string>} options.headers to be sent with every IAM token request\n *\n * @param - {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param - {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param - {string} [options.scope] The \"scope\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @throws\n *\n * {Error} When the configuration options are not valid.\n */\n",
3814
+ "docComment": "/**\n * Create a new IamRequestBasedAuthenticator instance.\n *\n * @param options - Configuration options for IAM authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service - clientId: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the \"scope\" parameter to use when fetching the bearer token from the token service\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n",
3681
3815
  "excerptTokens": [
3682
3816
  {
3683
3817
  "kind": "Content",
@@ -3686,7 +3820,7 @@
3686
3820
  {
3687
3821
  "kind": "Reference",
3688
3822
  "text": "IamRequestOptions",
3689
- "canonicalReference": "ibm-cloud-sdk-core!IamRequestOptions:interface"
3823
+ "canonicalReference": "ibm-cloud-sdk-core!~IamRequestOptions_2:interface"
3690
3824
  },
3691
3825
  {
3692
3826
  "kind": "Content",
@@ -3694,6 +3828,7 @@
3694
3828
  }
3695
3829
  ],
3696
3830
  "releaseTag": "Public",
3831
+ "isProtected": false,
3697
3832
  "overloadIndex": 1,
3698
3833
  "parameters": [
3699
3834
  {
@@ -3724,6 +3859,7 @@
3724
3859
  "text": ";"
3725
3860
  }
3726
3861
  ],
3862
+ "isReadonly": false,
3727
3863
  "isOptional": false,
3728
3864
  "releaseTag": "Public",
3729
3865
  "name": "clientId",
@@ -3731,7 +3867,8 @@
3731
3867
  "startIndex": 1,
3732
3868
  "endIndex": 2
3733
3869
  },
3734
- "isStatic": false
3870
+ "isStatic": false,
3871
+ "isProtected": true
3735
3872
  },
3736
3873
  {
3737
3874
  "kind": "Property",
@@ -3751,6 +3888,7 @@
3751
3888
  "text": ";"
3752
3889
  }
3753
3890
  ],
3891
+ "isReadonly": false,
3754
3892
  "isOptional": false,
3755
3893
  "releaseTag": "Public",
3756
3894
  "name": "clientSecret",
@@ -3758,12 +3896,13 @@
3758
3896
  "startIndex": 1,
3759
3897
  "endIndex": 2
3760
3898
  },
3761
- "isStatic": false
3899
+ "isStatic": false,
3900
+ "isProtected": true
3762
3901
  },
3763
3902
  {
3764
3903
  "kind": "Method",
3765
3904
  "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#getRefreshToken:member(1)",
3766
- "docComment": "/**\n * Return the most recently stored refresh token.\n *\n * @returns {string}\n *\n * @public\n */\n",
3905
+ "docComment": "/**\n * Return the most recently stored refresh token.\n *\n * @returns the refresh token string\n */\n",
3767
3906
  "excerptTokens": [
3768
3907
  {
3769
3908
  "kind": "Content",
@@ -3778,15 +3917,16 @@
3778
3917
  "text": ";"
3779
3918
  }
3780
3919
  ],
3781
- "isOptional": false,
3782
3920
  "isStatic": false,
3783
3921
  "returnTypeTokenRange": {
3784
3922
  "startIndex": 1,
3785
3923
  "endIndex": 2
3786
3924
  },
3787
3925
  "releaseTag": "Public",
3926
+ "isProtected": false,
3788
3927
  "overloadIndex": 1,
3789
3928
  "parameters": [],
3929
+ "isOptional": false,
3790
3930
  "name": "getRefreshToken"
3791
3931
  },
3792
3932
  {
@@ -3807,6 +3947,7 @@
3807
3947
  "text": ";"
3808
3948
  }
3809
3949
  ],
3950
+ "isReadonly": false,
3810
3951
  "isOptional": false,
3811
3952
  "releaseTag": "Public",
3812
3953
  "name": "scope",
@@ -3814,12 +3955,13 @@
3814
3955
  "startIndex": 1,
3815
3956
  "endIndex": 2
3816
3957
  },
3817
- "isStatic": false
3958
+ "isStatic": false,
3959
+ "isProtected": true
3818
3960
  },
3819
3961
  {
3820
3962
  "kind": "Method",
3821
3963
  "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#setClientIdAndSecret:member(1)",
3822
- "docComment": "/**\n * Setter for the mutually inclusive `clientId` and the `clientSecret`.\n *\n * @param clientId - The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param clientSecret - The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n */\n",
3964
+ "docComment": "/**\n * Setter for the mutually inclusive \"clientId\" and the \"clientSecret\" fields.\n *\n * @param clientId - the \"clientId\" value used to form a Basic Authorization header for IAM token requests\n *\n * @param clientSecret - the \"clientSecret\" value used to form a Basic Authorization header for IAM token requests\n */\n",
3823
3965
  "excerptTokens": [
3824
3966
  {
3825
3967
  "kind": "Content",
@@ -3850,13 +3992,13 @@
3850
3992
  "text": ";"
3851
3993
  }
3852
3994
  ],
3853
- "isOptional": false,
3854
3995
  "isStatic": false,
3855
3996
  "returnTypeTokenRange": {
3856
3997
  "startIndex": 5,
3857
3998
  "endIndex": 6
3858
3999
  },
3859
4000
  "releaseTag": "Public",
4001
+ "isProtected": false,
3860
4002
  "overloadIndex": 1,
3861
4003
  "parameters": [
3862
4004
  {
@@ -3876,12 +4018,13 @@
3876
4018
  "isOptional": false
3877
4019
  }
3878
4020
  ],
4021
+ "isOptional": false,
3879
4022
  "name": "setClientIdAndSecret"
3880
4023
  },
3881
4024
  {
3882
4025
  "kind": "Method",
3883
4026
  "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#setScope:member(1)",
3884
- "docComment": "/**\n * Setter for the \"scope\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param scope - A space seperated string that makes up the scope parameter\n */\n",
4027
+ "docComment": "/**\n * Setter for the \"scope\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param scope - (optional) a space-separated string that specifies one or more scopes to be associated with IAM token requests\n */\n",
3885
4028
  "excerptTokens": [
3886
4029
  {
3887
4030
  "kind": "Content",
@@ -3904,13 +4047,13 @@
3904
4047
  "text": ";"
3905
4048
  }
3906
4049
  ],
3907
- "isOptional": false,
3908
4050
  "isStatic": false,
3909
4051
  "returnTypeTokenRange": {
3910
4052
  "startIndex": 3,
3911
4053
  "endIndex": 4
3912
4054
  },
3913
4055
  "releaseTag": "Public",
4056
+ "isProtected": false,
3914
4057
  "overloadIndex": 1,
3915
4058
  "parameters": [
3916
4059
  {
@@ -3922,6 +4065,7 @@
3922
4065
  "isOptional": false
3923
4066
  }
3924
4067
  ],
4068
+ "isOptional": false,
3925
4069
  "name": "setScope"
3926
4070
  },
3927
4071
  {
@@ -3943,6 +4087,7 @@
3943
4087
  "text": ";"
3944
4088
  }
3945
4089
  ],
4090
+ "isReadonly": false,
3946
4091
  "isOptional": false,
3947
4092
  "releaseTag": "Public",
3948
4093
  "name": "tokenManager",
@@ -3950,12 +4095,13 @@
3950
4095
  "startIndex": 1,
3951
4096
  "endIndex": 2
3952
4097
  },
3953
- "isStatic": false
4098
+ "isStatic": false,
4099
+ "isProtected": true
3954
4100
  }
3955
4101
  ],
3956
4102
  "extendsTokenRange": {
3957
4103
  "startIndex": 1,
3958
- "endIndex": 3
4104
+ "endIndex": 2
3959
4105
  },
3960
4106
  "implementsTokenRanges": []
3961
4107
  },
@@ -3978,13 +4124,15 @@
3978
4124
  "text": " "
3979
4125
  }
3980
4126
  ],
4127
+ "fileUrlPath": "dist/es/auth/token-managers/iam-request-based-token-manager.d.ts",
3981
4128
  "releaseTag": "Public",
3982
4129
  "name": "IamRequestBasedTokenManager",
4130
+ "preserveMemberOrder": false,
3983
4131
  "members": [
3984
4132
  {
3985
4133
  "kind": "Constructor",
3986
4134
  "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager:constructor(1)",
3987
- "docComment": "/**\n * Create a new [[IamRequestBasedTokenManager]] instance.\n *\n * @param options - Configuration options.\n *\n * @param - {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param - {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param url - The IAM endpoint for token requests.\n *\n * @param - {boolean} [options.disableSslVerification] A flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n *\n * @param - {object<string, string>} [options.headers] Headers to be sent with every outbound HTTP requests to token services. @constructor\n */\n",
4135
+ "docComment": "/**\n * Create a new IamRequestBasedTokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service (default value: \"https://iam.cloud.ibm.com\") - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service - clientId: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the \"scope\" parameter to use when fetching the bearer token from the token service\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n",
3988
4136
  "excerptTokens": [
3989
4137
  {
3990
4138
  "kind": "Content",
@@ -4001,6 +4149,7 @@
4001
4149
  }
4002
4150
  ],
4003
4151
  "releaseTag": "Public",
4152
+ "isProtected": false,
4004
4153
  "overloadIndex": 1,
4005
4154
  "parameters": [
4006
4155
  {
@@ -4031,6 +4180,7 @@
4031
4180
  "text": ";"
4032
4181
  }
4033
4182
  ],
4183
+ "isReadonly": false,
4034
4184
  "isOptional": false,
4035
4185
  "releaseTag": "Public",
4036
4186
  "name": "formData",
@@ -4038,12 +4188,13 @@
4038
4188
  "startIndex": 1,
4039
4189
  "endIndex": 2
4040
4190
  },
4041
- "isStatic": false
4191
+ "isStatic": false,
4192
+ "isProtected": true
4042
4193
  },
4043
4194
  {
4044
4195
  "kind": "Method",
4045
4196
  "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#getRefreshToken:member(1)",
4046
- "docComment": "/**\n * Return the most recently stored refresh token.\n *\n * @returns {string}\n *\n * @public\n */\n",
4197
+ "docComment": "/**\n * Returns the most recently stored refresh token.\n *\n * @returns the refresh token\n */\n",
4047
4198
  "excerptTokens": [
4048
4199
  {
4049
4200
  "kind": "Content",
@@ -4058,15 +4209,16 @@
4058
4209
  "text": ";"
4059
4210
  }
4060
4211
  ],
4061
- "isOptional": false,
4062
4212
  "isStatic": false,
4063
4213
  "returnTypeTokenRange": {
4064
4214
  "startIndex": 1,
4065
4215
  "endIndex": 2
4066
4216
  },
4067
4217
  "releaseTag": "Public",
4218
+ "isProtected": false,
4068
4219
  "overloadIndex": 1,
4069
4220
  "parameters": [],
4221
+ "isOptional": false,
4070
4222
  "name": "getRefreshToken"
4071
4223
  },
4072
4224
  {
@@ -4087,6 +4239,7 @@
4087
4239
  "text": ";"
4088
4240
  }
4089
4241
  ],
4242
+ "isReadonly": false,
4090
4243
  "isOptional": false,
4091
4244
  "releaseTag": "Public",
4092
4245
  "name": "refreshToken",
@@ -4094,12 +4247,13 @@
4094
4247
  "startIndex": 1,
4095
4248
  "endIndex": 2
4096
4249
  },
4097
- "isStatic": false
4250
+ "isStatic": false,
4251
+ "isProtected": true
4098
4252
  },
4099
4253
  {
4100
4254
  "kind": "Method",
4101
4255
  "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#requestToken:member(1)",
4102
- "docComment": "/**\n * Request an IAM token using an API key.\n *\n * @returns {Promise}\n */\n",
4256
+ "docComment": "/**\n * Request an IAM access token using an API key.\n *\n * @returns Promise\n */\n",
4103
4257
  "excerptTokens": [
4104
4258
  {
4105
4259
  "kind": "Content",
@@ -4119,21 +4273,22 @@
4119
4273
  "text": ";"
4120
4274
  }
4121
4275
  ],
4122
- "isOptional": false,
4123
4276
  "isStatic": false,
4124
4277
  "returnTypeTokenRange": {
4125
4278
  "startIndex": 1,
4126
4279
  "endIndex": 3
4127
4280
  },
4128
4281
  "releaseTag": "Public",
4282
+ "isProtected": true,
4129
4283
  "overloadIndex": 1,
4130
4284
  "parameters": [],
4285
+ "isOptional": false,
4131
4286
  "name": "requestToken"
4132
4287
  },
4133
4288
  {
4134
4289
  "kind": "Method",
4135
4290
  "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#saveTokenInfo:member(1)",
4136
- "docComment": "/**\n * Extend this method from the parent class to extract the refresh token from the request and save it.\n *\n * @param tokenResponse - Response object from JWT service request @protected\n *\n * @returns {void}\n */\n",
4291
+ "docComment": "/**\n * Extend this method from the parent class to extract the refresh token from the request and save it.\n *\n * @param tokenResponse - the response object from JWT service request\n */\n",
4137
4292
  "excerptTokens": [
4138
4293
  {
4139
4294
  "kind": "Content",
@@ -4156,13 +4311,13 @@
4156
4311
  "text": ";"
4157
4312
  }
4158
4313
  ],
4159
- "isOptional": false,
4160
4314
  "isStatic": false,
4161
4315
  "returnTypeTokenRange": {
4162
4316
  "startIndex": 3,
4163
4317
  "endIndex": 4
4164
4318
  },
4165
4319
  "releaseTag": "Public",
4320
+ "isProtected": true,
4166
4321
  "overloadIndex": 1,
4167
4322
  "parameters": [
4168
4323
  {
@@ -4174,12 +4329,13 @@
4174
4329
  "isOptional": false
4175
4330
  }
4176
4331
  ],
4332
+ "isOptional": false,
4177
4333
  "name": "saveTokenInfo"
4178
4334
  },
4179
4335
  {
4180
4336
  "kind": "Method",
4181
4337
  "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#setClientIdAndSecret:member(1)",
4182
- "docComment": "/**\n * Set the IAM `clientId` and `clientSecret` values. These values are used to compute the Authorization header used when retrieving the IAM access token. If these values are not set, no Authorization header will be set on the request (it is not required).\n *\n * @param clientId - The client id.\n *\n * @param clientSecret - The client secret.\n *\n * @returns {void}\n */\n",
4338
+ "docComment": "/**\n * Sets the IAM \"clientId\" and \"clientSecret\" values. These values are used to compute the Authorization header used when retrieving the IAM access token. If these values are not set, no Authorization header will be set on the request (it is not required).\n *\n * @param clientId - the client id.\n *\n * @param clientSecret - the client secret.\n */\n",
4183
4339
  "excerptTokens": [
4184
4340
  {
4185
4341
  "kind": "Content",
@@ -4210,13 +4366,13 @@
4210
4366
  "text": ";"
4211
4367
  }
4212
4368
  ],
4213
- "isOptional": false,
4214
4369
  "isStatic": false,
4215
4370
  "returnTypeTokenRange": {
4216
4371
  "startIndex": 5,
4217
4372
  "endIndex": 6
4218
4373
  },
4219
4374
  "releaseTag": "Public",
4375
+ "isProtected": false,
4220
4376
  "overloadIndex": 1,
4221
4377
  "parameters": [
4222
4378
  {
@@ -4236,12 +4392,13 @@
4236
4392
  "isOptional": false
4237
4393
  }
4238
4394
  ],
4395
+ "isOptional": false,
4239
4396
  "name": "setClientIdAndSecret"
4240
4397
  },
4241
4398
  {
4242
4399
  "kind": "Method",
4243
4400
  "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#setScope:member(1)",
4244
- "docComment": "/**\n * Set the IAM `scope` value. This value is the form parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param scope - A space seperated string that makes up the scope parameter.\n *\n * @returns {void}\n */\n",
4401
+ "docComment": "/**\n * Sets the IAM \"scope\" value. This value is sent as the \"scope\" form parameter within the request sent to the IAM token service.\n *\n * @param scope - a space-separated string that contains one or more scope names\n */\n",
4245
4402
  "excerptTokens": [
4246
4403
  {
4247
4404
  "kind": "Content",
@@ -4264,13 +4421,13 @@
4264
4421
  "text": ";"
4265
4422
  }
4266
4423
  ],
4267
- "isOptional": false,
4268
4424
  "isStatic": false,
4269
4425
  "returnTypeTokenRange": {
4270
4426
  "startIndex": 3,
4271
4427
  "endIndex": 4
4272
4428
  },
4273
4429
  "releaseTag": "Public",
4430
+ "isProtected": false,
4274
4431
  "overloadIndex": 1,
4275
4432
  "parameters": [
4276
4433
  {
@@ -4282,12 +4439,13 @@
4282
4439
  "isOptional": false
4283
4440
  }
4284
4441
  ],
4442
+ "isOptional": false,
4285
4443
  "name": "setScope"
4286
4444
  }
4287
4445
  ],
4288
4446
  "extendsTokenRange": {
4289
4447
  "startIndex": 1,
4290
- "endIndex": 3
4448
+ "endIndex": 2
4291
4449
  },
4292
4450
  "implementsTokenRanges": []
4293
4451
  },
@@ -4310,8 +4468,10 @@
4310
4468
  "text": " "
4311
4469
  }
4312
4470
  ],
4471
+ "fileUrlPath": "dist/es/auth/token-managers/iam-request-based-token-manager.d.ts",
4313
4472
  "releaseTag": "Public",
4314
4473
  "name": "IamRequestOptions",
4474
+ "preserveMemberOrder": false,
4315
4475
  "members": [
4316
4476
  {
4317
4477
  "kind": "PropertySignature",
@@ -4331,6 +4491,7 @@
4331
4491
  "text": ";"
4332
4492
  }
4333
4493
  ],
4494
+ "isReadonly": false,
4334
4495
  "isOptional": true,
4335
4496
  "releaseTag": "Public",
4336
4497
  "name": "clientId",
@@ -4357,6 +4518,7 @@
4357
4518
  "text": ";"
4358
4519
  }
4359
4520
  ],
4521
+ "isReadonly": false,
4360
4522
  "isOptional": true,
4361
4523
  "releaseTag": "Public",
4362
4524
  "name": "clientSecret",
@@ -4383,6 +4545,7 @@
4383
4545
  "text": ";"
4384
4546
  }
4385
4547
  ],
4548
+ "isReadonly": false,
4386
4549
  "isOptional": true,
4387
4550
  "releaseTag": "Public",
4388
4551
  "name": "scope",
@@ -4395,14 +4558,14 @@
4395
4558
  "extendsTokenRanges": [
4396
4559
  {
4397
4560
  "startIndex": 1,
4398
- "endIndex": 3
4561
+ "endIndex": 2
4399
4562
  }
4400
4563
  ]
4401
4564
  },
4402
4565
  {
4403
4566
  "kind": "Class",
4404
4567
  "canonicalReference": "ibm-cloud-sdk-core!IamTokenManager:class",
4405
- "docComment": "/**\n * The IAMTokenManager takes an api key and performs the necessary interactions with the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager will retrieve bearer tokens via basic auth using a supplied `clientId` and `clientSecret` pair.\n */\n",
4568
+ "docComment": "/**\n * The IAMTokenManager takes an api key and performs the necessary interactions with the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager will retrieve bearer tokens via basic auth using a supplied \"clientId\" and \"clientSecret\" pair.\n */\n",
4406
4569
  "excerptTokens": [
4407
4570
  {
4408
4571
  "kind": "Content",
@@ -4418,13 +4581,15 @@
4418
4581
  "text": " "
4419
4582
  }
4420
4583
  ],
4584
+ "fileUrlPath": "dist/es/auth/token-managers/iam-token-manager.d.ts",
4421
4585
  "releaseTag": "Public",
4422
4586
  "name": "IamTokenManager",
4587
+ "preserveMemberOrder": false,
4423
4588
  "members": [
4424
4589
  {
4425
4590
  "kind": "Constructor",
4426
4591
  "canonicalReference": "ibm-cloud-sdk-core!IamTokenManager:constructor(1)",
4427
- "docComment": "/**\n * Create a new [[IamTokenManager]] instance.\n *\n * @param options - Configuration options.\n *\n * @param - {string} options.apikey The IAM api key.\n *\n * @param - {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param - {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a \"basic\" authorization header for IAM token requests.\n *\n * @param url - The IAM endpoint for token requests.\n *\n * @param - {boolean} [options.disableSslVerification] A flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n *\n * @param - {object<string, string>} [options.headers] Headers to be sent with every outbound HTTP requests to token services. @constructor\n */\n",
4592
+ "docComment": "/**\n * Create a new IamTokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the IAM token service (default value: \"https://iam.cloud.ibm.com\") - apikey: (required) the IAM api key - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service - clientId: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the \"scope\" parameter to use when fetching the bearer token from the token service\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n",
4428
4593
  "excerptTokens": [
4429
4594
  {
4430
4595
  "kind": "Content",
@@ -4433,7 +4598,7 @@
4433
4598
  {
4434
4599
  "kind": "Reference",
4435
4600
  "text": "Options",
4436
- "canonicalReference": "ibm-cloud-sdk-core!~Options:interface"
4601
+ "canonicalReference": "ibm-cloud-sdk-core!~Options_5:interface"
4437
4602
  },
4438
4603
  {
4439
4604
  "kind": "Content",
@@ -4441,6 +4606,7 @@
4441
4606
  }
4442
4607
  ],
4443
4608
  "releaseTag": "Public",
4609
+ "isProtected": false,
4444
4610
  "overloadIndex": 1,
4445
4611
  "parameters": [
4446
4612
  {
@@ -4471,6 +4637,7 @@
4471
4637
  "text": ";"
4472
4638
  }
4473
4639
  ],
4640
+ "isReadonly": false,
4474
4641
  "isOptional": false,
4475
4642
  "releaseTag": "Public",
4476
4643
  "name": "requiredOptions",
@@ -4478,12 +4645,13 @@
4478
4645
  "startIndex": 1,
4479
4646
  "endIndex": 2
4480
4647
  },
4481
- "isStatic": false
4648
+ "isStatic": false,
4649
+ "isProtected": true
4482
4650
  }
4483
4651
  ],
4484
4652
  "extendsTokenRange": {
4485
4653
  "startIndex": 1,
4486
- "endIndex": 3
4654
+ "endIndex": 2
4487
4655
  },
4488
4656
  "implementsTokenRanges": []
4489
4657
  },
@@ -4513,6 +4681,7 @@
4513
4681
  "text": ";"
4514
4682
  }
4515
4683
  ],
4684
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
4516
4685
  "returnTypeTokenRange": {
4517
4686
  "startIndex": 3,
4518
4687
  "endIndex": 4
@@ -4576,6 +4745,7 @@
4576
4745
  "text": ";"
4577
4746
  }
4578
4747
  ],
4748
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
4579
4749
  "returnTypeTokenRange": {
4580
4750
  "startIndex": 3,
4581
4751
  "endIndex": 8
@@ -4630,6 +4800,7 @@
4630
4800
  "text": ";"
4631
4801
  }
4632
4802
  ],
4803
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
4633
4804
  "returnTypeTokenRange": {
4634
4805
  "startIndex": 3,
4635
4806
  "endIndex": 6
@@ -4651,7 +4822,7 @@
4651
4822
  {
4652
4823
  "kind": "Function",
4653
4824
  "canonicalReference": "ibm-cloud-sdk-core!isHTML:function(1)",
4654
- "docComment": "/**\n * Return true if 'text' is html\n *\n * @param text - The 'text' to analyze\n *\n * @returns {boolean} true if 'text' has html tags\n */\n",
4825
+ "docComment": "/**\n * Return true if 'text' is html\n *\n * @param text - The 'text' to analyze\n *\n * @returns true if 'text' has html tags\n */\n",
4655
4826
  "excerptTokens": [
4656
4827
  {
4657
4828
  "kind": "Content",
@@ -4674,6 +4845,7 @@
4674
4845
  "text": ";"
4675
4846
  }
4676
4847
  ],
4848
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
4677
4849
  "returnTypeTokenRange": {
4678
4850
  "startIndex": 3,
4679
4851
  "endIndex": 4
@@ -4711,13 +4883,15 @@
4711
4883
  "text": " "
4712
4884
  }
4713
4885
  ],
4886
+ "fileUrlPath": "dist/es/auth/token-managers/jwt-token-manager.d.ts",
4714
4887
  "releaseTag": "Public",
4715
4888
  "name": "JwtTokenManager",
4889
+ "preserveMemberOrder": false,
4716
4890
  "members": [
4717
4891
  {
4718
4892
  "kind": "Constructor",
4719
4893
  "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:constructor(1)",
4720
- "docComment": "/**\n * Create a new [[JwtTokenManager]] instance. @constructor\n *\n * @param options - Configuration options.\n *\n * @param - {string} options.url for HTTP token requests.\n *\n * @param - {boolean} [options.disableSslVerification] A flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n *\n * @param - {object<string, string>} [options.headers] Headers to be sent with every outbound HTTP requests to token services.\n */\n",
4894
+ "docComment": "/**\n * Create a new JwtTokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service\n */\n",
4721
4895
  "excerptTokens": [
4722
4896
  {
4723
4897
  "kind": "Content",
@@ -4734,6 +4908,7 @@
4734
4908
  }
4735
4909
  ],
4736
4910
  "releaseTag": "Public",
4911
+ "isProtected": false,
4737
4912
  "overloadIndex": 1,
4738
4913
  "parameters": [
4739
4914
  {
@@ -4749,7 +4924,7 @@
4749
4924
  {
4750
4925
  "kind": "Method",
4751
4926
  "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager#requestToken:member(1)",
4752
- "docComment": "/**\n * Request a JWT using an API key.\n *\n * @returns {Promise}\n */\n",
4927
+ "docComment": "/**\n * Request a JWT using an API key.\n *\n * @returns Promise\n */\n",
4753
4928
  "excerptTokens": [
4754
4929
  {
4755
4930
  "kind": "Content",
@@ -4769,21 +4944,22 @@
4769
4944
  "text": ";"
4770
4945
  }
4771
4946
  ],
4772
- "isOptional": false,
4773
4947
  "isStatic": false,
4774
4948
  "returnTypeTokenRange": {
4775
4949
  "startIndex": 1,
4776
4950
  "endIndex": 3
4777
4951
  },
4778
4952
  "releaseTag": "Public",
4953
+ "isProtected": true,
4779
4954
  "overloadIndex": 1,
4780
4955
  "parameters": [],
4956
+ "isOptional": false,
4781
4957
  "name": "requestToken"
4782
4958
  },
4783
4959
  {
4784
4960
  "kind": "Method",
4785
4961
  "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager#saveTokenInfo:member(1)",
4786
- "docComment": "/**\n * Save the JWT service response and the calculated expiration time to the object's state.\n *\n * @param tokenResponse - Response object from JWT service request @protected\n *\n * @returns {void}\n */\n",
4962
+ "docComment": "/**\n * Save the JWT service response and the calculated expiration time to the object's state.\n *\n * @param tokenResponse - the response object from JWT service request\n */\n",
4787
4963
  "excerptTokens": [
4788
4964
  {
4789
4965
  "kind": "Content",
@@ -4806,13 +4982,13 @@
4806
4982
  "text": ";"
4807
4983
  }
4808
4984
  ],
4809
- "isOptional": false,
4810
4985
  "isStatic": false,
4811
4986
  "returnTypeTokenRange": {
4812
4987
  "startIndex": 3,
4813
4988
  "endIndex": 4
4814
4989
  },
4815
4990
  "releaseTag": "Public",
4991
+ "isProtected": true,
4816
4992
  "overloadIndex": 1,
4817
4993
  "parameters": [
4818
4994
  {
@@ -4824,6 +5000,7 @@
4824
5000
  "isOptional": false
4825
5001
  }
4826
5002
  ],
5003
+ "isOptional": false,
4827
5004
  "name": "saveTokenInfo"
4828
5005
  },
4829
5006
  {
@@ -4844,6 +5021,7 @@
4844
5021
  "text": ";"
4845
5022
  }
4846
5023
  ],
5024
+ "isReadonly": false,
4847
5025
  "isOptional": false,
4848
5026
  "releaseTag": "Public",
4849
5027
  "name": "tokenInfo",
@@ -4851,7 +5029,8 @@
4851
5029
  "startIndex": 1,
4852
5030
  "endIndex": 2
4853
5031
  },
4854
- "isStatic": false
5032
+ "isStatic": false,
5033
+ "isProtected": true
4855
5034
  },
4856
5035
  {
4857
5036
  "kind": "Property",
@@ -4871,6 +5050,7 @@
4871
5050
  "text": ";"
4872
5051
  }
4873
5052
  ],
5053
+ "isReadonly": false,
4874
5054
  "isOptional": false,
4875
5055
  "releaseTag": "Public",
4876
5056
  "name": "tokenName",
@@ -4878,12 +5058,13 @@
4878
5058
  "startIndex": 1,
4879
5059
  "endIndex": 2
4880
5060
  },
4881
- "isStatic": false
5061
+ "isStatic": false,
5062
+ "isProtected": true
4882
5063
  }
4883
5064
  ],
4884
5065
  "extendsTokenRange": {
4885
5066
  "startIndex": 1,
4886
- "endIndex": 3
5067
+ "endIndex": 2
4887
5068
  },
4888
5069
  "implementsTokenRanges": []
4889
5070
  },
@@ -4906,6 +5087,7 @@
4906
5087
  "text": ";"
4907
5088
  }
4908
5089
  ],
5090
+ "fileUrlPath": "dist/es/auth/token-managers/jwt-token-manager.d.ts",
4909
5091
  "releaseTag": "Public",
4910
5092
  "name": "JwtTokenManagerOptions",
4911
5093
  "typeTokenRange": {
@@ -4932,8 +5114,10 @@
4932
5114
  "text": " "
4933
5115
  }
4934
5116
  ],
5117
+ "fileUrlPath": "dist/es/auth/authenticators/no-auth-authenticator.d.ts",
4935
5118
  "releaseTag": "Public",
4936
5119
  "name": "NoAuthAuthenticator",
5120
+ "preserveMemberOrder": false,
4937
5121
  "members": [
4938
5122
  {
4939
5123
  "kind": "Method",
@@ -4947,7 +5131,7 @@
4947
5131
  {
4948
5132
  "kind": "Reference",
4949
5133
  "text": "AuthenticateOptions",
4950
- "canonicalReference": "ibm-cloud-sdk-core!AuthenticateOptions:interface"
5134
+ "canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface"
4951
5135
  },
4952
5136
  {
4953
5137
  "kind": "Content",
@@ -4967,13 +5151,13 @@
4967
5151
  "text": ";"
4968
5152
  }
4969
5153
  ],
4970
- "isOptional": false,
4971
5154
  "isStatic": false,
4972
5155
  "returnTypeTokenRange": {
4973
5156
  "startIndex": 3,
4974
5157
  "endIndex": 5
4975
5158
  },
4976
5159
  "releaseTag": "Public",
5160
+ "isProtected": false,
4977
5161
  "overloadIndex": 1,
4978
5162
  "parameters": [
4979
5163
  {
@@ -4985,6 +5169,7 @@
4985
5169
  "isOptional": false
4986
5170
  }
4987
5171
  ],
5172
+ "isOptional": false,
4988
5173
  "name": "authenticate"
4989
5174
  },
4990
5175
  {
@@ -5005,28 +5190,29 @@
5005
5190
  "text": ";"
5006
5191
  }
5007
5192
  ],
5008
- "isOptional": false,
5009
5193
  "isStatic": false,
5010
5194
  "returnTypeTokenRange": {
5011
5195
  "startIndex": 1,
5012
5196
  "endIndex": 2
5013
5197
  },
5014
5198
  "releaseTag": "Public",
5199
+ "isProtected": false,
5015
5200
  "overloadIndex": 1,
5016
5201
  "parameters": [],
5202
+ "isOptional": false,
5017
5203
  "name": "authenticationType"
5018
5204
  }
5019
5205
  ],
5020
5206
  "extendsTokenRange": {
5021
5207
  "startIndex": 1,
5022
- "endIndex": 3
5208
+ "endIndex": 2
5023
5209
  },
5024
5210
  "implementsTokenRanges": []
5025
5211
  },
5026
5212
  {
5027
5213
  "kind": "Function",
5028
5214
  "canonicalReference": "ibm-cloud-sdk-core!onlyOne:function(1)",
5029
- "docComment": "/**\n * Check for only one of two elements being defined. Returns true if a is defined and b is undefined, or vice versa. Returns false if both are defined or both are undefined.\n *\n * @param a - The first object\n *\n * @param b - The second object\n *\n * @returns {boolean}\n */\n",
5215
+ "docComment": "/**\n * Checks for only one of two elements being defined. Returns true if a is defined and b is undefined, or vice versa. Returns false if both are defined or both are undefined.\n *\n * @param a - The first object\n *\n * @param b - The second object\n *\n * @returns true if and only if exactly one of a or b is defined\n */\n",
5030
5216
  "excerptTokens": [
5031
5217
  {
5032
5218
  "kind": "Content",
@@ -5057,6 +5243,7 @@
5057
5243
  "text": ";"
5058
5244
  }
5059
5245
  ],
5246
+ "fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
5060
5247
  "returnTypeTokenRange": {
5061
5248
  "startIndex": 5,
5062
5249
  "endIndex": 6
@@ -5086,7 +5273,7 @@
5086
5273
  {
5087
5274
  "kind": "Variable",
5088
5275
  "canonicalReference": "ibm-cloud-sdk-core!qs:var",
5089
- "docComment": "/**\n * (C) Copyright IBM Corp. 2019, 2021.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n */\n",
5276
+ "docComment": "/**\n * (C) Copyright IBM Corp. 2019, 2022.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n */\n",
5090
5277
  "excerptTokens": [
5091
5278
  {
5092
5279
  "kind": "Content",
@@ -5106,6 +5293,8 @@
5106
5293
  "text": ") => string;\n}"
5107
5294
  }
5108
5295
  ],
5296
+ "fileUrlPath": "dist/es/lib/querystring.d.ts",
5297
+ "isReadonly": true,
5109
5298
  "releaseTag": "Public",
5110
5299
  "name": "qs",
5111
5300
  "variableTypeTokenRange": {
@@ -5131,6 +5320,7 @@
5131
5320
  "text": ";"
5132
5321
  }
5133
5322
  ],
5323
+ "fileUrlPath": "dist/es/auth/utils/file-reading-helpers.d.ts",
5134
5324
  "returnTypeTokenRange": {
5135
5325
  "startIndex": 1,
5136
5326
  "endIndex": 2
@@ -5166,6 +5356,7 @@
5166
5356
  "text": ";"
5167
5357
  }
5168
5358
  ],
5359
+ "fileUrlPath": "dist/es/auth/utils/file-reading-helpers.d.ts",
5169
5360
  "returnTypeTokenRange": {
5170
5361
  "startIndex": 3,
5171
5362
  "endIndex": 4
@@ -5187,7 +5378,7 @@
5187
5378
  {
5188
5379
  "kind": "Function",
5189
5380
  "canonicalReference": "ibm-cloud-sdk-core!readExternalSources:function(1)",
5190
- "docComment": "/**\n * Read properties stored in external sources like Environment Variables, the credentials file, VCAP services, etc. and return them as an object. The keys of this object will have the service name prefix removed and will be converted to lower camel case.\n *\n * Only one source will be used at a time.\n *\n * @param serviceName - The service name prefix.\n */\n",
5381
+ "docComment": "/**\n * Read properties stored in external sources like Environment Variables, the credentials file, VCAP services, etc. and return them as an object. The keys of this object will have the service name prefix removed and will be converted to lower camel case.\n *\n * Only one source will be used at a time.\n *\n * @param serviceName - the service name prefix\n */\n",
5191
5382
  "excerptTokens": [
5192
5383
  {
5193
5384
  "kind": "Content",
@@ -5210,6 +5401,7 @@
5210
5401
  "text": ";"
5211
5402
  }
5212
5403
  ],
5404
+ "fileUrlPath": "dist/es/auth/utils/read-external-sources.d.ts",
5213
5405
  "returnTypeTokenRange": {
5214
5406
  "startIndex": 3,
5215
5407
  "endIndex": 4
@@ -5231,7 +5423,7 @@
5231
5423
  {
5232
5424
  "kind": "Function",
5233
5425
  "canonicalReference": "ibm-cloud-sdk-core!removeSuffix:function(1)",
5234
- "docComment": "/**\n * Remove a given suffix if it exists.\n *\n * @param str - The base string to operate on\n *\n * @param suffix - The suffix to remove, if present\n *\n * @returns {string}\n */\n",
5426
+ "docComment": "/**\n * Removes a given suffix if it exists.\n *\n * @param str - the base string to operate on\n *\n * @param suffix - the suffix to remove, if present\n *\n * @returns the substring of \"str\" that remains after the suffix is removed\n */\n",
5235
5427
  "excerptTokens": [
5236
5428
  {
5237
5429
  "kind": "Content",
@@ -5262,6 +5454,7 @@
5262
5454
  "text": ";"
5263
5455
  }
5264
5456
  ],
5457
+ "fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
5265
5458
  "returnTypeTokenRange": {
5266
5459
  "startIndex": 5,
5267
5460
  "endIndex": 6
@@ -5298,8 +5491,10 @@
5298
5491
  "text": "export interface SDKLogger "
5299
5492
  }
5300
5493
  ],
5494
+ "fileUrlPath": "dist/es/lib/get-new-logger.d.ts",
5301
5495
  "releaseTag": "Public",
5302
5496
  "name": "SDKLogger",
5497
+ "preserveMemberOrder": false,
5303
5498
  "members": [
5304
5499
  {
5305
5500
  "kind": "PropertySignature",
@@ -5313,13 +5508,14 @@
5313
5508
  {
5314
5509
  "kind": "Reference",
5315
5510
  "text": "Debugger",
5316
- "canonicalReference": "@types/debug!~debug.Debugger:interface"
5511
+ "canonicalReference": "@types/debug!debug.Debugger:interface"
5317
5512
  },
5318
5513
  {
5319
5514
  "kind": "Content",
5320
5515
  "text": ";"
5321
5516
  }
5322
5517
  ],
5518
+ "isReadonly": false,
5323
5519
  "isOptional": false,
5324
5520
  "releaseTag": "Public",
5325
5521
  "name": "debug",
@@ -5340,13 +5536,14 @@
5340
5536
  {
5341
5537
  "kind": "Reference",
5342
5538
  "text": "Debugger",
5343
- "canonicalReference": "@types/debug!~debug.Debugger:interface"
5539
+ "canonicalReference": "@types/debug!debug.Debugger:interface"
5344
5540
  },
5345
5541
  {
5346
5542
  "kind": "Content",
5347
5543
  "text": ";"
5348
5544
  }
5349
5545
  ],
5546
+ "isReadonly": false,
5350
5547
  "isOptional": false,
5351
5548
  "releaseTag": "Public",
5352
5549
  "name": "error",
@@ -5367,13 +5564,14 @@
5367
5564
  {
5368
5565
  "kind": "Reference",
5369
5566
  "text": "Debugger",
5370
- "canonicalReference": "@types/debug!~debug.Debugger:interface"
5567
+ "canonicalReference": "@types/debug!debug.Debugger:interface"
5371
5568
  },
5372
5569
  {
5373
5570
  "kind": "Content",
5374
5571
  "text": ";"
5375
5572
  }
5376
5573
  ],
5574
+ "isReadonly": false,
5377
5575
  "isOptional": false,
5378
5576
  "releaseTag": "Public",
5379
5577
  "name": "info",
@@ -5394,13 +5592,14 @@
5394
5592
  {
5395
5593
  "kind": "Reference",
5396
5594
  "text": "Debugger",
5397
- "canonicalReference": "@types/debug!~debug.Debugger:interface"
5595
+ "canonicalReference": "@types/debug!debug.Debugger:interface"
5398
5596
  },
5399
5597
  {
5400
5598
  "kind": "Content",
5401
5599
  "text": ";"
5402
5600
  }
5403
5601
  ],
5602
+ "isReadonly": false,
5404
5603
  "isOptional": false,
5405
5604
  "releaseTag": "Public",
5406
5605
  "name": "verbose",
@@ -5421,13 +5620,14 @@
5421
5620
  {
5422
5621
  "kind": "Reference",
5423
5622
  "text": "Debugger",
5424
- "canonicalReference": "@types/debug!~debug.Debugger:interface"
5623
+ "canonicalReference": "@types/debug!debug.Debugger:interface"
5425
5624
  },
5426
5625
  {
5427
5626
  "kind": "Content",
5428
5627
  "text": ";"
5429
5628
  }
5430
5629
  ],
5630
+ "isReadonly": false,
5431
5631
  "isOptional": false,
5432
5632
  "releaseTag": "Public",
5433
5633
  "name": "warn",
@@ -5442,7 +5642,7 @@
5442
5642
  {
5443
5643
  "kind": "Function",
5444
5644
  "canonicalReference": "ibm-cloud-sdk-core!streamToPromise:function(1)",
5445
- "docComment": "/**\n * Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer or array of text chunks Essentially a smaller version of concat-stream wrapped in a promise\n *\n * @param stream - Optional stream param for when not bound to an existing stream instance. @return {Promise}\n */\n",
5645
+ "docComment": "/**\n * Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer or array of text chunks Essentially a smaller version of concat-stream wrapped in a promise\n *\n * @param stream - optional stream param for when not bound to an existing stream instance.\n *\n * @returns Promise\n */\n",
5446
5646
  "excerptTokens": [
5447
5647
  {
5448
5648
  "kind": "Content",
@@ -5451,7 +5651,7 @@
5451
5651
  {
5452
5652
  "kind": "Reference",
5453
5653
  "text": "Stream",
5454
- "canonicalReference": "!internal.Stream:class"
5654
+ "canonicalReference": "!\"\\\"stream\\\"\".internal.Stream:class"
5455
5655
  },
5456
5656
  {
5457
5657
  "kind": "Content",
@@ -5471,6 +5671,7 @@
5471
5671
  "text": ";"
5472
5672
  }
5473
5673
  ],
5674
+ "fileUrlPath": "dist/es/lib/stream-to-promise.d.ts",
5474
5675
  "returnTypeTokenRange": {
5475
5676
  "startIndex": 3,
5476
5677
  "endIndex": 5
@@ -5492,7 +5693,7 @@
5492
5693
  {
5493
5694
  "kind": "Function",
5494
5695
  "canonicalReference": "ibm-cloud-sdk-core!stripTrailingSlash:function(1)",
5495
- "docComment": "/**\n * @param url - the url string.\n *\n * @returns {string}\n */\n",
5696
+ "docComment": "/**\n * Strips trailing slashes from \"url\", if present.\n *\n * @param url - the url string\n *\n * @returns the url with any trailing slashes removed\n */\n",
5496
5697
  "excerptTokens": [
5497
5698
  {
5498
5699
  "kind": "Content",
@@ -5515,6 +5716,7 @@
5515
5716
  "text": ";"
5516
5717
  }
5517
5718
  ],
5719
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
5518
5720
  "returnTypeTokenRange": {
5519
5721
  "startIndex": 3,
5520
5722
  "endIndex": 4
@@ -5536,20 +5738,22 @@
5536
5738
  {
5537
5739
  "kind": "Class",
5538
5740
  "canonicalReference": "ibm-cloud-sdk-core!TokenManager:class",
5539
- "docComment": "/**\n * A class for shared functionality for storing, and requesting tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement `requestToken()` to retrieve the token from intended sources and `saveTokenInfo(tokenResponse)` to parse and save token information from the response.\n */\n",
5741
+ "docComment": "/**\n * A class for shared functionality for storing, and requesting tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement \"requestToken()\" to retrieve the token from intended sources and \"saveTokenInfo(tokenResponse)\" to parse and save token information from the response.\n */\n",
5540
5742
  "excerptTokens": [
5541
5743
  {
5542
5744
  "kind": "Content",
5543
5745
  "text": "export declare class TokenManager "
5544
5746
  }
5545
5747
  ],
5748
+ "fileUrlPath": "dist/es/auth/token-managers/token-manager.d.ts",
5546
5749
  "releaseTag": "Public",
5547
5750
  "name": "TokenManager",
5751
+ "preserveMemberOrder": false,
5548
5752
  "members": [
5549
5753
  {
5550
5754
  "kind": "Constructor",
5551
5755
  "canonicalReference": "ibm-cloud-sdk-core!TokenManager:constructor(1)",
5552
- "docComment": "/**\n * Create a new [[TokenManager]] instance. @constructor\n *\n * @param options - Configuration options.\n *\n * @param - {string} options.url for HTTP token requests.\n *\n * @param - {boolean} [options.disableSslVerification] A flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n *\n * @param - {object<string, string>} [options.headers] Headers to be sent with every outbound HTTP requests to token services.\n */\n",
5756
+ "docComment": "/**\n * Create a new TokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service\n */\n",
5553
5757
  "excerptTokens": [
5554
5758
  {
5555
5759
  "kind": "Content",
@@ -5566,6 +5770,7 @@
5566
5770
  }
5567
5771
  ],
5568
5772
  "releaseTag": "Public",
5773
+ "isProtected": false,
5569
5774
  "overloadIndex": 1,
5570
5775
  "parameters": [
5571
5776
  {
@@ -5596,6 +5801,7 @@
5596
5801
  "text": ";"
5597
5802
  }
5598
5803
  ],
5804
+ "isReadonly": false,
5599
5805
  "isOptional": false,
5600
5806
  "releaseTag": "Public",
5601
5807
  "name": "accessToken",
@@ -5603,7 +5809,8 @@
5603
5809
  "startIndex": 1,
5604
5810
  "endIndex": 2
5605
5811
  },
5606
- "isStatic": false
5812
+ "isStatic": false,
5813
+ "isProtected": true
5607
5814
  },
5608
5815
  {
5609
5816
  "kind": "Property",
@@ -5623,6 +5830,7 @@
5623
5830
  "text": ";"
5624
5831
  }
5625
5832
  ],
5833
+ "isReadonly": false,
5626
5834
  "isOptional": false,
5627
5835
  "releaseTag": "Public",
5628
5836
  "name": "disableSslVerification",
@@ -5630,7 +5838,8 @@
5630
5838
  "startIndex": 1,
5631
5839
  "endIndex": 2
5632
5840
  },
5633
- "isStatic": false
5841
+ "isStatic": false,
5842
+ "isProtected": true
5634
5843
  },
5635
5844
  {
5636
5845
  "kind": "Property",
@@ -5650,6 +5859,7 @@
5650
5859
  "text": ";"
5651
5860
  }
5652
5861
  ],
5862
+ "isReadonly": false,
5653
5863
  "isOptional": false,
5654
5864
  "releaseTag": "Public",
5655
5865
  "name": "expireTime",
@@ -5657,12 +5867,13 @@
5657
5867
  "startIndex": 1,
5658
5868
  "endIndex": 2
5659
5869
  },
5660
- "isStatic": false
5870
+ "isStatic": false,
5871
+ "isProtected": true
5661
5872
  },
5662
5873
  {
5663
5874
  "kind": "Method",
5664
5875
  "canonicalReference": "ibm-cloud-sdk-core!TokenManager#getToken:member(1)",
5665
- "docComment": "/**\n * Retrieve a new token using `requestToken()` in the case there is not a currently stored token from a previous call, or the previous token has expired.\n */\n",
5876
+ "docComment": "/**\n * Retrieves a new token using \"requestToken()\" if there is not a currently stored token from a previous call, or the previous token has expired.\n */\n",
5666
5877
  "excerptTokens": [
5667
5878
  {
5668
5879
  "kind": "Content",
@@ -5682,15 +5893,16 @@
5682
5893
  "text": ";"
5683
5894
  }
5684
5895
  ],
5685
- "isOptional": false,
5686
5896
  "isStatic": false,
5687
5897
  "returnTypeTokenRange": {
5688
5898
  "startIndex": 1,
5689
5899
  "endIndex": 3
5690
5900
  },
5691
5901
  "releaseTag": "Public",
5902
+ "isProtected": false,
5692
5903
  "overloadIndex": 1,
5693
5904
  "parameters": [],
5905
+ "isOptional": false,
5694
5906
  "name": "getToken"
5695
5907
  },
5696
5908
  {
@@ -5712,6 +5924,7 @@
5712
5924
  "text": ";"
5713
5925
  }
5714
5926
  ],
5927
+ "isReadonly": false,
5715
5928
  "isOptional": false,
5716
5929
  "releaseTag": "Public",
5717
5930
  "name": "headers",
@@ -5719,12 +5932,13 @@
5719
5932
  "startIndex": 1,
5720
5933
  "endIndex": 2
5721
5934
  },
5722
- "isStatic": false
5935
+ "isStatic": false,
5936
+ "isProtected": true
5723
5937
  },
5724
5938
  {
5725
5939
  "kind": "Method",
5726
5940
  "canonicalReference": "ibm-cloud-sdk-core!TokenManager#pacedRequestToken:member(1)",
5727
- "docComment": "/**\n * Paces requests to request_token.\n *\n * This method pseudo-serializes requests for an access_token when the current token is undefined or expired. The first caller to this method records its `requestTime` and then issues the token request. Subsequent callers will check the `requestTime` to see if a request is active (has been issued within the past 60 seconds), and if so will queue their promise for the active requestor to resolve when that request completes.\n */\n",
5941
+ "docComment": "/**\n * Paces requests to requestToken().\n *\n * This method pseudo-serializes requests for an access_token when the current token is undefined or expired. The first caller to this method records its `requestTime` and then issues the token request. Subsequent callers will check the `requestTime` to see if a request is active (has been issued within the past 60 seconds), and if so will queue their promise for the active requestor to resolve when that request completes.\n */\n",
5728
5942
  "excerptTokens": [
5729
5943
  {
5730
5944
  "kind": "Content",
@@ -5744,15 +5958,16 @@
5744
5958
  "text": ";"
5745
5959
  }
5746
5960
  ],
5747
- "isOptional": false,
5748
5961
  "isStatic": false,
5749
5962
  "returnTypeTokenRange": {
5750
5963
  "startIndex": 1,
5751
5964
  "endIndex": 3
5752
5965
  },
5753
5966
  "releaseTag": "Public",
5967
+ "isProtected": true,
5754
5968
  "overloadIndex": 1,
5755
5969
  "parameters": [],
5970
+ "isOptional": false,
5756
5971
  "name": "pacedRequestToken"
5757
5972
  },
5758
5973
  {
@@ -5773,6 +5988,7 @@
5773
5988
  "text": ";"
5774
5989
  }
5775
5990
  ],
5991
+ "isReadonly": false,
5776
5992
  "isOptional": false,
5777
5993
  "releaseTag": "Public",
5778
5994
  "name": "refreshTime",
@@ -5780,12 +5996,13 @@
5780
5996
  "startIndex": 1,
5781
5997
  "endIndex": 2
5782
5998
  },
5783
- "isStatic": false
5999
+ "isStatic": false,
6000
+ "isProtected": true
5784
6001
  },
5785
6002
  {
5786
6003
  "kind": "Method",
5787
6004
  "canonicalReference": "ibm-cloud-sdk-core!TokenManager#requestToken:member(1)",
5788
- "docComment": "/**\n * Request a token using an API endpoint.\n *\n * @returns {Promise}\n */\n",
6005
+ "docComment": "/**\n * Request a token using an API endpoint.\n *\n * @returns Promise\n */\n",
5789
6006
  "excerptTokens": [
5790
6007
  {
5791
6008
  "kind": "Content",
@@ -5805,15 +6022,16 @@
5805
6022
  "text": ";"
5806
6023
  }
5807
6024
  ],
5808
- "isOptional": false,
5809
6025
  "isStatic": false,
5810
6026
  "returnTypeTokenRange": {
5811
6027
  "startIndex": 1,
5812
6028
  "endIndex": 3
5813
6029
  },
5814
6030
  "releaseTag": "Public",
6031
+ "isProtected": true,
5815
6032
  "overloadIndex": 1,
5816
6033
  "parameters": [],
6034
+ "isOptional": false,
5817
6035
  "name": "requestToken"
5818
6036
  },
5819
6037
  {
@@ -5828,13 +6046,14 @@
5828
6046
  {
5829
6047
  "kind": "Reference",
5830
6048
  "text": "RequestWrapper",
5831
- "canonicalReference": "ibm-cloud-sdk-core!RequestWrapper:class"
6049
+ "canonicalReference": "ibm-cloud-sdk-core!~RequestWrapper:class"
5832
6050
  },
5833
6051
  {
5834
6052
  "kind": "Content",
5835
6053
  "text": ";"
5836
6054
  }
5837
6055
  ],
6056
+ "isReadonly": false,
5838
6057
  "isOptional": false,
5839
6058
  "releaseTag": "Public",
5840
6059
  "name": "requestWrapperInstance",
@@ -5842,12 +6061,13 @@
5842
6061
  "startIndex": 1,
5843
6062
  "endIndex": 2
5844
6063
  },
5845
- "isStatic": false
6064
+ "isStatic": false,
6065
+ "isProtected": true
5846
6066
  },
5847
6067
  {
5848
6068
  "kind": "Method",
5849
6069
  "canonicalReference": "ibm-cloud-sdk-core!TokenManager#saveTokenInfo:member(1)",
5850
- "docComment": "/**\n * Parse and save token information from the response. Save the requested token into field `accessToken`. Calculate expiration and refresh time from the received info and store them in fields `expireTime` and `refreshTime`.\n *\n * @param tokenResponse - Response object from a token service request @protected\n *\n * @returns {void}\n */\n",
6070
+ "docComment": "/**\n * Parse and save token information from the response. Save the requested token into field `accessToken`. Calculate expiration and refresh time from the received info and store them in fields `expireTime` and `refreshTime`.\n *\n * @param tokenResponse - the response object from a token service request\n */\n",
5851
6071
  "excerptTokens": [
5852
6072
  {
5853
6073
  "kind": "Content",
@@ -5870,13 +6090,13 @@
5870
6090
  "text": ";"
5871
6091
  }
5872
6092
  ],
5873
- "isOptional": false,
5874
6093
  "isStatic": false,
5875
6094
  "returnTypeTokenRange": {
5876
6095
  "startIndex": 3,
5877
6096
  "endIndex": 4
5878
6097
  },
5879
6098
  "releaseTag": "Public",
6099
+ "isProtected": true,
5880
6100
  "overloadIndex": 1,
5881
6101
  "parameters": [
5882
6102
  {
@@ -5888,12 +6108,13 @@
5888
6108
  "isOptional": false
5889
6109
  }
5890
6110
  ],
6111
+ "isOptional": false,
5891
6112
  "name": "saveTokenInfo"
5892
6113
  },
5893
6114
  {
5894
6115
  "kind": "Method",
5895
6116
  "canonicalReference": "ibm-cloud-sdk-core!TokenManager#setDisableSslVerification:member(1)",
5896
- "docComment": "/**\n * Setter for the disableSslVerification property.\n *\n * @param value - the new value for the disableSslVerification property\n *\n * @returns {void}\n */\n",
6117
+ "docComment": "/**\n * Sets the \"disableSslVerification\" property.\n *\n * @param value - the new value for the disableSslVerification property\n */\n",
5897
6118
  "excerptTokens": [
5898
6119
  {
5899
6120
  "kind": "Content",
@@ -5916,13 +6137,13 @@
5916
6137
  "text": ";"
5917
6138
  }
5918
6139
  ],
5919
- "isOptional": false,
5920
6140
  "isStatic": false,
5921
6141
  "returnTypeTokenRange": {
5922
6142
  "startIndex": 3,
5923
6143
  "endIndex": 4
5924
6144
  },
5925
6145
  "releaseTag": "Public",
6146
+ "isProtected": false,
5926
6147
  "overloadIndex": 1,
5927
6148
  "parameters": [
5928
6149
  {
@@ -5934,12 +6155,13 @@
5934
6155
  "isOptional": false
5935
6156
  }
5936
6157
  ],
6158
+ "isOptional": false,
5937
6159
  "name": "setDisableSslVerification"
5938
6160
  },
5939
6161
  {
5940
6162
  "kind": "Method",
5941
6163
  "canonicalReference": "ibm-cloud-sdk-core!TokenManager#setHeaders:member(1)",
5942
- "docComment": "/**\n * Set a completely new set of headers.\n *\n * @param headers - the new set of headers as an object\n *\n * @returns {void}\n */\n",
6164
+ "docComment": "/**\n * Sets the headers to be included with each outbound request to the token server.\n *\n * @param headers - the set of headers to send with each request to the token server\n */\n",
5943
6165
  "excerptTokens": [
5944
6166
  {
5945
6167
  "kind": "Content",
@@ -5963,13 +6185,13 @@
5963
6185
  "text": ";"
5964
6186
  }
5965
6187
  ],
5966
- "isOptional": false,
5967
6188
  "isStatic": false,
5968
6189
  "returnTypeTokenRange": {
5969
6190
  "startIndex": 3,
5970
6191
  "endIndex": 4
5971
6192
  },
5972
6193
  "releaseTag": "Public",
6194
+ "isProtected": false,
5973
6195
  "overloadIndex": 1,
5974
6196
  "parameters": [
5975
6197
  {
@@ -5981,6 +6203,7 @@
5981
6203
  "isOptional": false
5982
6204
  }
5983
6205
  ],
6206
+ "isOptional": false,
5984
6207
  "name": "setHeaders"
5985
6208
  },
5986
6209
  {
@@ -6001,6 +6224,7 @@
6001
6224
  "text": ";"
6002
6225
  }
6003
6226
  ],
6227
+ "isReadonly": false,
6004
6228
  "isOptional": false,
6005
6229
  "releaseTag": "Public",
6006
6230
  "name": "url",
@@ -6008,7 +6232,8 @@
6008
6232
  "startIndex": 1,
6009
6233
  "endIndex": 2
6010
6234
  },
6011
- "isStatic": false
6235
+ "isStatic": false,
6236
+ "isProtected": true
6012
6237
  }
6013
6238
  ],
6014
6239
  "implementsTokenRanges": []
@@ -6040,6 +6265,7 @@
6040
6265
  "text": ";"
6041
6266
  }
6042
6267
  ],
6268
+ "fileUrlPath": "dist/es/auth/token-managers/token-manager.d.ts",
6043
6269
  "releaseTag": "Public",
6044
6270
  "name": "TokenManagerOptions",
6045
6271
  "typeTokenRange": {
@@ -6050,7 +6276,7 @@
6050
6276
  {
6051
6277
  "kind": "Class",
6052
6278
  "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator:class",
6053
- "docComment": "/**\n * Class for common functionality shared by token-request authenticators. [[TokenRequestBasedAuthenticator]]s use token managers to retrieve, store, and refresh tokens. Not intended to be used as stand-alone authenticator, but as parent class to authenticators that have their own token manager implementations.\n *\n * The tokens will be added as an Authorization headers in the form:\n *\n * Authorization: Bearer <bearer-token>\n */\n",
6279
+ "docComment": "/**\n * Class for common functionality shared by token-request authenticators. TokenRequestBasedAuthenticators use token managers to retrieve, store, and refresh tokens. Not intended to be used as stand-alone authenticator, but as base class to authenticators that have their own token manager implementations.\n *\n * The token will be added as an Authorization header in the form:\n *\n * Authorization: Bearer \\<bearer-token\\>\n */\n",
6054
6280
  "excerptTokens": [
6055
6281
  {
6056
6282
  "kind": "Content",
@@ -6066,13 +6292,15 @@
6066
6292
  "text": " "
6067
6293
  }
6068
6294
  ],
6295
+ "fileUrlPath": "dist/es/auth/authenticators/token-request-based-authenticator.d.ts",
6069
6296
  "releaseTag": "Public",
6070
6297
  "name": "TokenRequestBasedAuthenticator",
6298
+ "preserveMemberOrder": false,
6071
6299
  "members": [
6072
6300
  {
6073
6301
  "kind": "Constructor",
6074
6302
  "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator:constructor(1)",
6075
- "docComment": "/**\n * Create a new [[TokenRequestBasedAuthenticator]] instance with an internal [[JwtTokenManager]].\n *\n * @param options - Configuration options.\n *\n * @param - {string} options.url for HTTP token requests.\n *\n * @param - {boolean} [options.disableSslVerification] A flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n *\n * @param - {object<string, string>} [options.headers] to be sent with every outbound HTTP requests to token services.\n */\n",
6303
+ "docComment": "/**\n * Create a new TokenRequestBasedAuthenticator instance with an internal JwtTokenManager.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service\n */\n",
6076
6304
  "excerptTokens": [
6077
6305
  {
6078
6306
  "kind": "Content",
@@ -6081,7 +6309,7 @@
6081
6309
  {
6082
6310
  "kind": "Reference",
6083
6311
  "text": "BaseOptions",
6084
- "canonicalReference": "ibm-cloud-sdk-core!BaseOptions:type"
6312
+ "canonicalReference": "ibm-cloud-sdk-core!~BaseOptions:type"
6085
6313
  },
6086
6314
  {
6087
6315
  "kind": "Content",
@@ -6089,6 +6317,7 @@
6089
6317
  }
6090
6318
  ],
6091
6319
  "releaseTag": "Public",
6320
+ "isProtected": false,
6092
6321
  "overloadIndex": 1,
6093
6322
  "parameters": [
6094
6323
  {
@@ -6104,7 +6333,7 @@
6104
6333
  {
6105
6334
  "kind": "Method",
6106
6335
  "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator#authenticate:member(1)",
6107
- "docComment": "/**\n * Adds bearer token information to `request`. The bearer token information will be set in the Authorization property of`request.headers` in the form:\n *\n * Authorization: Bearer <bearer-token>\n *\n * @param requestOptions - The request to augment with authentication information.\n *\n * @param - {object.<string, string>} requestOptions.headers - The headers the authentication information will be added too. Overrides default headers where there's conflict.\n */\n",
6336
+ "docComment": "/**\n * Adds bearer token information to \"requestOptions\". The bearer token information will be set in the Authorization property of \"requestOptions.headers\" in the form:\n *\n * Authorization: Bearer \\<bearer-token\\>\n *\n * @param requestOptions - The request to augment with authentication information.\n */\n",
6108
6337
  "excerptTokens": [
6109
6338
  {
6110
6339
  "kind": "Content",
@@ -6113,7 +6342,7 @@
6113
6342
  {
6114
6343
  "kind": "Reference",
6115
6344
  "text": "AuthenticateOptions",
6116
- "canonicalReference": "ibm-cloud-sdk-core!AuthenticateOptions:interface"
6345
+ "canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface"
6117
6346
  },
6118
6347
  {
6119
6348
  "kind": "Content",
@@ -6133,13 +6362,13 @@
6133
6362
  "text": ";"
6134
6363
  }
6135
6364
  ],
6136
- "isOptional": false,
6137
6365
  "isStatic": false,
6138
6366
  "returnTypeTokenRange": {
6139
6367
  "startIndex": 3,
6140
6368
  "endIndex": 5
6141
6369
  },
6142
6370
  "releaseTag": "Public",
6371
+ "isProtected": false,
6143
6372
  "overloadIndex": 1,
6144
6373
  "parameters": [
6145
6374
  {
@@ -6151,6 +6380,7 @@
6151
6380
  "isOptional": false
6152
6381
  }
6153
6382
  ],
6383
+ "isOptional": false,
6154
6384
  "name": "authenticate"
6155
6385
  },
6156
6386
  {
@@ -6171,6 +6401,7 @@
6171
6401
  "text": ";"
6172
6402
  }
6173
6403
  ],
6404
+ "isReadonly": false,
6174
6405
  "isOptional": false,
6175
6406
  "releaseTag": "Public",
6176
6407
  "name": "disableSslVerification",
@@ -6178,7 +6409,8 @@
6178
6409
  "startIndex": 1,
6179
6410
  "endIndex": 2
6180
6411
  },
6181
- "isStatic": false
6412
+ "isStatic": false,
6413
+ "isProtected": true
6182
6414
  },
6183
6415
  {
6184
6416
  "kind": "Property",
@@ -6199,6 +6431,7 @@
6199
6431
  "text": ";"
6200
6432
  }
6201
6433
  ],
6434
+ "isReadonly": false,
6202
6435
  "isOptional": false,
6203
6436
  "releaseTag": "Public",
6204
6437
  "name": "headers",
@@ -6206,12 +6439,13 @@
6206
6439
  "startIndex": 1,
6207
6440
  "endIndex": 2
6208
6441
  },
6209
- "isStatic": false
6442
+ "isStatic": false,
6443
+ "isProtected": true
6210
6444
  },
6211
6445
  {
6212
6446
  "kind": "Method",
6213
6447
  "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator#setDisableSslVerification:member(1)",
6214
- "docComment": "/**\n * Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.\n *\n * @param value - A flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n */\n",
6448
+ "docComment": "/**\n * Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.\n *\n * @param value - a flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n */\n",
6215
6449
  "excerptTokens": [
6216
6450
  {
6217
6451
  "kind": "Content",
@@ -6234,13 +6468,13 @@
6234
6468
  "text": ";"
6235
6469
  }
6236
6470
  ],
6237
- "isOptional": false,
6238
6471
  "isStatic": false,
6239
6472
  "returnTypeTokenRange": {
6240
6473
  "startIndex": 3,
6241
6474
  "endIndex": 4
6242
6475
  },
6243
6476
  "releaseTag": "Public",
6477
+ "isProtected": false,
6244
6478
  "overloadIndex": 1,
6245
6479
  "parameters": [
6246
6480
  {
@@ -6252,12 +6486,13 @@
6252
6486
  "isOptional": false
6253
6487
  }
6254
6488
  ],
6489
+ "isOptional": false,
6255
6490
  "name": "setDisableSslVerification"
6256
6491
  },
6257
6492
  {
6258
6493
  "kind": "Method",
6259
6494
  "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator#setHeaders:member(1)",
6260
- "docComment": "/**\n * Set headers.\n *\n * @param headers - Default headers to be sent with every Cloud Pak For Data token request. Overwrites previous default headers.\n */\n",
6495
+ "docComment": "/**\n * Set headers.\n *\n * @param headers - a set of HTTP headers to be sent with each outbound token server request. Overwrites previous default headers.\n */\n",
6261
6496
  "excerptTokens": [
6262
6497
  {
6263
6498
  "kind": "Content",
@@ -6281,13 +6516,13 @@
6281
6516
  "text": ";"
6282
6517
  }
6283
6518
  ],
6284
- "isOptional": false,
6285
6519
  "isStatic": false,
6286
6520
  "returnTypeTokenRange": {
6287
6521
  "startIndex": 3,
6288
6522
  "endIndex": 4
6289
6523
  },
6290
6524
  "releaseTag": "Public",
6525
+ "isProtected": false,
6291
6526
  "overloadIndex": 1,
6292
6527
  "parameters": [
6293
6528
  {
@@ -6299,6 +6534,7 @@
6299
6534
  "isOptional": false
6300
6535
  }
6301
6536
  ],
6537
+ "isOptional": false,
6302
6538
  "name": "setHeaders"
6303
6539
  },
6304
6540
  {
@@ -6320,6 +6556,7 @@
6320
6556
  "text": ";"
6321
6557
  }
6322
6558
  ],
6559
+ "isReadonly": false,
6323
6560
  "isOptional": false,
6324
6561
  "releaseTag": "Public",
6325
6562
  "name": "tokenManager",
@@ -6327,7 +6564,8 @@
6327
6564
  "startIndex": 1,
6328
6565
  "endIndex": 2
6329
6566
  },
6330
- "isStatic": false
6567
+ "isStatic": false,
6568
+ "isProtected": true
6331
6569
  },
6332
6570
  {
6333
6571
  "kind": "Property",
@@ -6347,6 +6585,7 @@
6347
6585
  "text": ";"
6348
6586
  }
6349
6587
  ],
6588
+ "isReadonly": false,
6350
6589
  "isOptional": false,
6351
6590
  "releaseTag": "Public",
6352
6591
  "name": "url",
@@ -6354,19 +6593,20 @@
6354
6593
  "startIndex": 1,
6355
6594
  "endIndex": 2
6356
6595
  },
6357
- "isStatic": false
6596
+ "isStatic": false,
6597
+ "isProtected": true
6358
6598
  }
6359
6599
  ],
6360
6600
  "extendsTokenRange": {
6361
6601
  "startIndex": 1,
6362
- "endIndex": 3
6602
+ "endIndex": 2
6363
6603
  },
6364
6604
  "implementsTokenRanges": []
6365
6605
  },
6366
6606
  {
6367
6607
  "kind": "Function",
6368
6608
  "canonicalReference": "ibm-cloud-sdk-core!toLowerKeys:function(1)",
6369
- "docComment": "/**\n * This function converts an object's keys to lower case. note: does not convert nested keys\n *\n * @param obj - The object to convert the keys of.\n *\n * @returns {Object}\n */\n",
6609
+ "docComment": "/**\n * This function converts an object's keys to lower case. note: does not convert nested keys\n *\n * @param obj - The object to convert the keys of.\n *\n * @returns the object with keys folded to lowercase\n */\n",
6370
6610
  "excerptTokens": [
6371
6611
  {
6372
6612
  "kind": "Content",
@@ -6391,6 +6631,7 @@
6391
6631
  "text": ";"
6392
6632
  }
6393
6633
  ],
6634
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
6394
6635
  "returnTypeTokenRange": {
6395
6636
  "startIndex": 3,
6396
6637
  "endIndex": 4
@@ -6414,13 +6655,15 @@
6414
6655
  "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils:namespace",
6415
6656
  "docComment": "",
6416
6657
  "excerptTokens": [],
6658
+ "fileUrlPath": "dist/es/index.d.ts",
6417
6659
  "releaseTag": "None",
6418
6660
  "name": "unitTestUtils",
6661
+ "preserveMemberOrder": false,
6419
6662
  "members": [
6420
6663
  {
6421
6664
  "kind": "Function",
6422
6665
  "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.checkForSuccessfulExecution:function(1)",
6423
- "docComment": "/**\n * This method simply ensures that the method executed without any issues by extracting the argument from the mock object for the `createRequest` method and verifying that it is an object.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @returns {void}\n */\n",
6666
+ "docComment": "/**\n * This method simply ensures that the method executed without any issues by extracting the argument from the mock object for the `createRequest` method and verifying that it is an object.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n */\n",
6424
6667
  "excerptTokens": [
6425
6668
  {
6426
6669
  "kind": "Content",
@@ -6443,6 +6686,7 @@
6443
6686
  "text": ";"
6444
6687
  }
6445
6688
  ],
6689
+ "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
6446
6690
  "returnTypeTokenRange": {
6447
6691
  "startIndex": 3,
6448
6692
  "endIndex": 4
@@ -6464,7 +6708,7 @@
6464
6708
  {
6465
6709
  "kind": "Function",
6466
6710
  "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.checkMediaHeaders:function(1)",
6467
- "docComment": "/**\n * Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call, and checks for the expected values for `Accept` and `Content-Type`. This to verify that the SDK sets the correct values in the code.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @param accept - the expected value for the `Accept` header\n *\n * @param contentType - the expected value for the `Content-Type` header\n *\n * @returns {void}\n */\n",
6711
+ "docComment": "/**\n * Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call, and checks for the expected values for `Accept` and `Content-Type`. This to verify that the SDK sets the correct values in the code.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @param accept - the expected value for the `Accept` header\n *\n * @param contentType - the expected value for the `Content-Type` header\n */\n",
6468
6712
  "excerptTokens": [
6469
6713
  {
6470
6714
  "kind": "Content",
@@ -6503,6 +6747,7 @@
6503
6747
  "text": ";"
6504
6748
  }
6505
6749
  ],
6750
+ "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
6506
6751
  "returnTypeTokenRange": {
6507
6752
  "startIndex": 7,
6508
6753
  "endIndex": 8
@@ -6540,7 +6785,7 @@
6540
6785
  {
6541
6786
  "kind": "Function",
6542
6787
  "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.checkUrlAndMethod:function(1)",
6543
- "docComment": "/**\n * Takes the request options constructed by the SDK and checks that the `url` and `method` properties were set to their correct values.\n *\n * @param options - the options object put together by the SDK, retrieved from the createRequest mock\n *\n * @param url - The URL path of the service endpoint, from the paths section of the API definition\n *\n * @param string - The HTTP method for the request, from the API definition\n *\n * @returns {void}\n */\n",
6788
+ "docComment": "/**\n * Takes the request options constructed by the SDK and checks that the `url` and `method` properties were set to their correct values.\n *\n * @param options - the options object put together by the SDK, retrieved from the createRequest mock\n *\n * @param url - The URL path of the service endpoint, from the paths section of the API definition\n *\n * @param method - The HTTP method for the request, from the API definition\n */\n",
6544
6789
  "excerptTokens": [
6545
6790
  {
6546
6791
  "kind": "Content",
@@ -6579,6 +6824,7 @@
6579
6824
  "text": ";"
6580
6825
  }
6581
6826
  ],
6827
+ "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
6582
6828
  "returnTypeTokenRange": {
6583
6829
  "startIndex": 7,
6584
6830
  "endIndex": 8
@@ -6616,7 +6862,7 @@
6616
6862
  {
6617
6863
  "kind": "Function",
6618
6864
  "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.checkUserHeader:function(1)",
6619
- "docComment": "/**\n * Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call, and checks for the expected value for a user-defined header. This is verify that the SDK accepts header parameters and sends them as headers in the request.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`\n *\n * @param userHeaderValue - the expected value for the header passed by the user\n *\n * @returns {void}\n */\n",
6865
+ "docComment": "/**\n * Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call, and checks for the expected value for a user-defined header. This is verify that the SDK accepts header parameters and sends them as headers in the request.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`\n *\n * @param userHeaderValue - the expected value for the header passed by the user\n */\n",
6620
6866
  "excerptTokens": [
6621
6867
  {
6622
6868
  "kind": "Content",
@@ -6655,6 +6901,7 @@
6655
6901
  "text": ";"
6656
6902
  }
6657
6903
  ],
6904
+ "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
6658
6905
  "returnTypeTokenRange": {
6659
6906
  "startIndex": 7,
6660
6907
  "endIndex": 8
@@ -6692,7 +6939,7 @@
6692
6939
  {
6693
6940
  "kind": "Function",
6694
6941
  "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.expectToBePromise:function(1)",
6695
- "docComment": "/**\n * This method simply ensures that the SDK methods return Promises by checking for the `then` function - common way to assess whether or not an object is a Promise.\n *\n * @param sdkPromise - the Promise returned by an SDK method\n *\n * @returns {void}\n */\n",
6942
+ "docComment": "/**\n * This method simply ensures that the SDK methods return Promises by checking for the `then` function - common way to assess whether or not an object is a Promise.\n *\n * @param sdkPromise - the Promise returned by an SDK method\n */\n",
6696
6943
  "excerptTokens": [
6697
6944
  {
6698
6945
  "kind": "Content",
@@ -6715,6 +6962,7 @@
6715
6962
  "text": ";"
6716
6963
  }
6717
6964
  ],
6965
+ "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
6718
6966
  "returnTypeTokenRange": {
6719
6967
  "startIndex": 3,
6720
6968
  "endIndex": 4
@@ -6736,7 +6984,7 @@
6736
6984
  {
6737
6985
  "kind": "Function",
6738
6986
  "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.getOptions:function(1)",
6739
- "docComment": "/**\n * This method extracts the `options` property from the object passed into `createRequest`. This property is an object containing all of the SDK method-specific information (like `path` and `body`) used to build a request. This method is just a convenience method for the unit tests to be able to make assertions on the items in the request.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @returns {Object}\n */\n",
6987
+ "docComment": "/**\n * This method extracts the `options` property from the object passed into `createRequest`. This property is an object containing all of the SDK method-specific information (like `path` and `body`) used to build a request. This method is just a convenience method for the unit tests to be able to make assertions on the items in the request.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @returns Object\n */\n",
6740
6988
  "excerptTokens": [
6741
6989
  {
6742
6990
  "kind": "Content",
@@ -6759,6 +7007,7 @@
6759
7007
  "text": ";"
6760
7008
  }
6761
7009
  ],
7010
+ "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
6762
7011
  "returnTypeTokenRange": {
6763
7012
  "startIndex": 3,
6764
7013
  "endIndex": 4
@@ -6789,8 +7038,10 @@
6789
7038
  "text": "export interface UserOptions "
6790
7039
  }
6791
7040
  ],
7041
+ "fileUrlPath": "dist/es/lib/base-service.d.ts",
6792
7042
  "releaseTag": "Public",
6793
7043
  "name": "UserOptions",
7044
+ "preserveMemberOrder": false,
6794
7045
  "members": [
6795
7046
  {
6796
7047
  "kind": "IndexSignature",
@@ -6818,6 +7069,7 @@
6818
7069
  "text": ";"
6819
7070
  }
6820
7071
  ],
7072
+ "isReadonly": false,
6821
7073
  "returnTypeTokenRange": {
6822
7074
  "startIndex": 3,
6823
7075
  "endIndex": 4
@@ -6854,6 +7106,7 @@
6854
7106
  "text": ";"
6855
7107
  }
6856
7108
  ],
7109
+ "isReadonly": false,
6857
7110
  "isOptional": true,
6858
7111
  "releaseTag": "Public",
6859
7112
  "name": "authenticator",
@@ -6880,6 +7133,7 @@
6880
7133
  "text": ";"
6881
7134
  }
6882
7135
  ],
7136
+ "isReadonly": false,
6883
7137
  "isOptional": true,
6884
7138
  "releaseTag": "Public",
6885
7139
  "name": "disableSslVerification",
@@ -6907,6 +7161,7 @@
6907
7161
  "text": ";"
6908
7162
  }
6909
7163
  ],
7164
+ "isReadonly": false,
6910
7165
  "isOptional": true,
6911
7166
  "releaseTag": "Public",
6912
7167
  "name": "headers",
@@ -6938,6 +7193,7 @@
6938
7193
  "text": ";"
6939
7194
  }
6940
7195
  ],
7196
+ "isReadonly": false,
6941
7197
  "isOptional": true,
6942
7198
  "releaseTag": "Public",
6943
7199
  "name": "jar",
@@ -6964,6 +7220,7 @@
6964
7220
  "text": ";"
6965
7221
  }
6966
7222
  ],
7223
+ "isReadonly": false,
6967
7224
  "isOptional": true,
6968
7225
  "releaseTag": "Public",
6969
7226
  "name": "serviceUrl",
@@ -6990,6 +7247,7 @@
6990
7247
  "text": ";"
6991
7248
  }
6992
7249
  ],
7250
+ "isReadonly": false,
6993
7251
  "isOptional": true,
6994
7252
  "releaseTag": "Public",
6995
7253
  "name": "url",
@@ -7016,6 +7274,7 @@
7016
7274
  "text": ";"
7017
7275
  }
7018
7276
  ],
7277
+ "isReadonly": false,
7019
7278
  "isOptional": true,
7020
7279
  "releaseTag": "Public",
7021
7280
  "name": "version",
@@ -7030,7 +7289,7 @@
7030
7289
  {
7031
7290
  "kind": "Function",
7032
7291
  "canonicalReference": "ibm-cloud-sdk-core!validateInput:function(1)",
7033
- "docComment": "/**\n * @param options - A configuration options object.\n *\n * @param requiredOptions - The list of properties that must be specified.\n */\n",
7292
+ "docComment": "/**\n * Validates \"options\".\n *\n * @param options - a configuration options object\n *\n * @param requiredOptions - the list of properties that must be present in \"options\"\n *\n * @throws\n *\n * Error: \"options\" failed validation\n */\n",
7034
7293
  "excerptTokens": [
7035
7294
  {
7036
7295
  "kind": "Content",
@@ -7061,6 +7320,7 @@
7061
7320
  "text": ";"
7062
7321
  }
7063
7322
  ],
7323
+ "fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
7064
7324
  "returnTypeTokenRange": {
7065
7325
  "startIndex": 5,
7066
7326
  "endIndex": 6
@@ -7090,7 +7350,7 @@
7090
7350
  {
7091
7351
  "kind": "Function",
7092
7352
  "canonicalReference": "ibm-cloud-sdk-core!validateParams:function(1)",
7093
- "docComment": "/**\n * Validates that \"params\" contains a value for each key listed in \"requiredParams\", and that each key contained in \"params\" is a valid key listed in \"allParams\". In essence, we want params to contain only valid keys and we want params to contain at least the required keys.\n *\n * @param params - the \"params\" object passed into an operation containing method parameters.\n *\n * @param requiredParams - the names of required parameters. If null, then the \"required params\" check is bypassed.\n *\n * @param allParams - the names of all valid parameters. If null, then the \"valid params\" check is bypassed.\n *\n * @returns {Error|null}\n */\n",
7353
+ "docComment": "/**\n * Validates that \"params\" contains a value for each key listed in \"requiredParams\", and that each key contained in \"params\" is a valid key listed in \"allParams\". In essence, we want params to contain only valid keys and we want params to contain at least the required keys.\n *\n * @param params - the \"params\" object passed into an operation containing method parameters.\n *\n * @param requiredParams - the names of required parameters. If null, then the \"required params\" check is bypassed.\n *\n * @param allParams - the names of all valid parameters. If null, then the \"valid params\" check is bypassed.\n *\n * @returns null if no errors found, otherwise an Error instance\n */\n",
7094
7354
  "excerptTokens": [
7095
7355
  {
7096
7356
  "kind": "Content",
@@ -7134,6 +7394,7 @@
7134
7394
  "text": ";"
7135
7395
  }
7136
7396
  ],
7397
+ "fileUrlPath": "dist/es/lib/helper.d.ts",
7137
7398
  "returnTypeTokenRange": {
7138
7399
  "startIndex": 7,
7139
7400
  "endIndex": 9
@@ -7171,7 +7432,7 @@
7171
7432
  {
7172
7433
  "kind": "Class",
7173
7434
  "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceAuthenticator:class",
7174
- "docComment": "/**\n * The [[VpcInstanceAuthenticator]] implements an authentication scheme in which it retrieves an \"instance identity token\" and exchanges that for an IAM access token using the VPC Instance Metadata Service API which is available on the local compute resource (VM). The instance identity token is similar to an IAM apikey, except that it is managed automatically by the compute resource provider (VPC).\n *\n * The resulting IAM access token is then added to outbound requests in an Authorization header\n *\n * Authorization: Bearer <access-token>\n */\n",
7435
+ "docComment": "/**\n * The VpcInstanceAuthenticator implements an authentication scheme in which it retrieves an \"instance identity token\" and exchanges that for an IAM access token using the VPC Instance Metadata Service API which is available on the local compute resource (VM). The instance identity token is similar to an IAM apikey, except that it is managed automatically by the compute resource provider (VPC).\n *\n * The resulting IAM access token is then added to outbound requests in an Authorization header\n *\n * Authorization: Bearer \\<access-token\\>\n */\n",
7175
7436
  "excerptTokens": [
7176
7437
  {
7177
7438
  "kind": "Content",
@@ -7187,13 +7448,15 @@
7187
7448
  "text": " "
7188
7449
  }
7189
7450
  ],
7451
+ "fileUrlPath": "dist/es/auth/authenticators/vpc-instance-authenticator.d.ts",
7190
7452
  "releaseTag": "Public",
7191
7453
  "name": "VpcInstanceAuthenticator",
7454
+ "preserveMemberOrder": false,
7192
7455
  "members": [
7193
7456
  {
7194
7457
  "kind": "Constructor",
7195
7458
  "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceAuthenticator:constructor(1)",
7196
- "docComment": "/**\n * Create a new [[VpcInstanceAuthenticator]] instance.\n *\n * @param options - Configuration options for VpcInstance authentication.\n *\n * @param - {string} [options.iamProfileCrn] The CRN of the linked trusted IAM profile to be used as the identity of the compute resource. At most one of iamProfileCrn or iamProfileId may be specified. If neither one is specified, then the default IAM profile defined for the compute resource will be used.\n *\n * @param - {string} [options.iamProfileId] The ID of the linked trusted IAM profile to be used when obtaining the IAM access token. At most one of iamProfileCrn or iamProfileId may be specified. If neither one is specified, then the default IAM profile defined for the compute resource will be used.\n *\n * @param - {string} [options.url] The VPC Instance Metadata Service's base endpoint URL. Default value: \"http://169.254.169.254\"\n */\n",
7459
+ "docComment": "/**\n * Create a new VpcInstanceAuthenticator instance.\n *\n * @remarks\n *\n * At most one of \"iamProfileCrn\" or \"iamProfileId\" may be specified. If neither one is specified, then the default IAM profile defined for the compute resource will be used.\n *\n * @param options - Configuration options for VpcInstance authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the VPC Instance Metadata Service (default value: \"http://169.254.169.254\") - iamProfileCrn: (optional) the CRN of the linked IAM trusted profile to be used to obtain the IAM access token - iamProfileId: (optional) the ID of the linked IAM trusted profile to be used to obtain the IAM access token\n */\n",
7197
7460
  "excerptTokens": [
7198
7461
  {
7199
7462
  "kind": "Content",
@@ -7202,7 +7465,7 @@
7202
7465
  {
7203
7466
  "kind": "Reference",
7204
7467
  "text": "Options",
7205
- "canonicalReference": "ibm-cloud-sdk-core!Options:interface"
7468
+ "canonicalReference": "ibm-cloud-sdk-core!~Options_10:interface"
7206
7469
  },
7207
7470
  {
7208
7471
  "kind": "Content",
@@ -7210,6 +7473,7 @@
7210
7473
  }
7211
7474
  ],
7212
7475
  "releaseTag": "Public",
7476
+ "isProtected": false,
7213
7477
  "overloadIndex": 1,
7214
7478
  "parameters": [
7215
7479
  {
@@ -7240,21 +7504,22 @@
7240
7504
  "text": ";"
7241
7505
  }
7242
7506
  ],
7243
- "isOptional": false,
7244
7507
  "isStatic": false,
7245
7508
  "returnTypeTokenRange": {
7246
7509
  "startIndex": 1,
7247
7510
  "endIndex": 2
7248
7511
  },
7249
7512
  "releaseTag": "Public",
7513
+ "isProtected": false,
7250
7514
  "overloadIndex": 1,
7251
7515
  "parameters": [],
7516
+ "isOptional": false,
7252
7517
  "name": "authenticationType"
7253
7518
  },
7254
7519
  {
7255
7520
  "kind": "Method",
7256
7521
  "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceAuthenticator#setIamProfileCrn:member(1)",
7257
- "docComment": "/**\n * Setter for the \"profile_crn\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param A - string that makes up the iamProfileCrn parameter\n */\n",
7522
+ "docComment": "/**\n * Sets the \"iamProfileCrn\" value to be used when obtaining an IAM access token\n *\n * @param iamProfileCrn - the CRN of the linked IAM trusted profile to use when obtaining an IAM access token\n */\n",
7258
7523
  "excerptTokens": [
7259
7524
  {
7260
7525
  "kind": "Content",
@@ -7277,13 +7542,13 @@
7277
7542
  "text": ";"
7278
7543
  }
7279
7544
  ],
7280
- "isOptional": false,
7281
7545
  "isStatic": false,
7282
7546
  "returnTypeTokenRange": {
7283
7547
  "startIndex": 3,
7284
7548
  "endIndex": 4
7285
7549
  },
7286
7550
  "releaseTag": "Public",
7551
+ "isProtected": false,
7287
7552
  "overloadIndex": 1,
7288
7553
  "parameters": [
7289
7554
  {
@@ -7295,12 +7560,13 @@
7295
7560
  "isOptional": false
7296
7561
  }
7297
7562
  ],
7563
+ "isOptional": false,
7298
7564
  "name": "setIamProfileCrn"
7299
7565
  },
7300
7566
  {
7301
7567
  "kind": "Method",
7302
7568
  "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceAuthenticator#setIamProfileId:member(1)",
7303
- "docComment": "/**\n * Setter for the \"profile_id\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param A - string that makes up the iamProfileId parameter\n */\n",
7569
+ "docComment": "/**\n * Sets the \"iamProfileId\" value to be used when obtaining an IAM access token\n *\n * @param iamProfileId - the ID of the linked IAM trusted profile to use when obtaining an IAM access token\n */\n",
7304
7570
  "excerptTokens": [
7305
7571
  {
7306
7572
  "kind": "Content",
@@ -7323,13 +7589,13 @@
7323
7589
  "text": ";"
7324
7590
  }
7325
7591
  ],
7326
- "isOptional": false,
7327
7592
  "isStatic": false,
7328
7593
  "returnTypeTokenRange": {
7329
7594
  "startIndex": 3,
7330
7595
  "endIndex": 4
7331
7596
  },
7332
7597
  "releaseTag": "Public",
7598
+ "isProtected": false,
7333
7599
  "overloadIndex": 1,
7334
7600
  "parameters": [
7335
7601
  {
@@ -7341,6 +7607,7 @@
7341
7607
  "isOptional": false
7342
7608
  }
7343
7609
  ],
7610
+ "isOptional": false,
7344
7611
  "name": "setIamProfileId"
7345
7612
  },
7346
7613
  {
@@ -7362,6 +7629,7 @@
7362
7629
  "text": ";"
7363
7630
  }
7364
7631
  ],
7632
+ "isReadonly": false,
7365
7633
  "isOptional": false,
7366
7634
  "releaseTag": "Public",
7367
7635
  "name": "tokenManager",
@@ -7369,12 +7637,13 @@
7369
7637
  "startIndex": 1,
7370
7638
  "endIndex": 2
7371
7639
  },
7372
- "isStatic": false
7640
+ "isStatic": false,
7641
+ "isProtected": true
7373
7642
  }
7374
7643
  ],
7375
7644
  "extendsTokenRange": {
7376
7645
  "startIndex": 1,
7377
- "endIndex": 3
7646
+ "endIndex": 2
7378
7647
  },
7379
7648
  "implementsTokenRanges": []
7380
7649
  },
@@ -7397,13 +7666,15 @@
7397
7666
  "text": " "
7398
7667
  }
7399
7668
  ],
7669
+ "fileUrlPath": "dist/es/auth/token-managers/vpc-instance-token-manager.d.ts",
7400
7670
  "releaseTag": "Public",
7401
7671
  "name": "VpcInstanceTokenManager",
7672
+ "preserveMemberOrder": false,
7402
7673
  "members": [
7403
7674
  {
7404
7675
  "kind": "Constructor",
7405
7676
  "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceTokenManager:constructor(1)",
7406
- "docComment": "/**\n * Create a new [[VpcInstanceTokenManager]] instance.\n *\n * @param options - Configuration options.\n *\n * @param - {string} [options.iamProfileCrn] The CRN of the linked trusted IAM profile to be used as the identity of the compute resource. At most one of iamProfileCrn or iamProfileId may be specified. If neither one is specified, then the default IAM profile defined for the compute resource will be used.\n *\n * @param - {string} [options.iamProfileId] The ID of the linked trusted IAM profile to be used when obtaining the IAM access token. At most one of iamProfileCrn or iamProfileId may be specified. If neither one is specified, then the default IAM profile defined for the compute resource will be used.\n *\n * @param - {string} [options.url] The VPC Instance Metadata Service's base endpoint URL. Default value: \"http://169.254.169.254\" @constructor\n */\n",
7677
+ "docComment": "/**\n * Create a new VpcInstanceTokenManager instance.\n *\n * @remarks\n *\n * At most one of \"iamProfileCrn\" or \"iamProfileId\" may be specified. If neither one is specified, then the default IAM profile defined for the compute resource will be used.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the VPC Instance Metadata Service (default value: \"http://169.254.169.254\") - iamProfileCrn: (optional) the CRN of the linked IAM trusted profile to be used to obtain the IAM access token - iamProfileId: (optional) the ID of the linked IAM trusted profile to be used to obtain the IAM access token\n */\n",
7407
7678
  "excerptTokens": [
7408
7679
  {
7409
7680
  "kind": "Content",
@@ -7412,7 +7683,7 @@
7412
7683
  {
7413
7684
  "kind": "Reference",
7414
7685
  "text": "Options",
7415
- "canonicalReference": "ibm-cloud-sdk-core!~Options:interface"
7686
+ "canonicalReference": "ibm-cloud-sdk-core!~Options_9:interface"
7416
7687
  },
7417
7688
  {
7418
7689
  "kind": "Content",
@@ -7420,6 +7691,7 @@
7420
7691
  }
7421
7692
  ],
7422
7693
  "releaseTag": "Public",
7694
+ "isProtected": false,
7423
7695
  "overloadIndex": 1,
7424
7696
  "parameters": [
7425
7697
  {
@@ -7455,21 +7727,22 @@
7455
7727
  "text": ";"
7456
7728
  }
7457
7729
  ],
7458
- "isOptional": false,
7459
7730
  "isStatic": false,
7460
7731
  "returnTypeTokenRange": {
7461
7732
  "startIndex": 1,
7462
7733
  "endIndex": 3
7463
7734
  },
7464
7735
  "releaseTag": "Public",
7736
+ "isProtected": true,
7465
7737
  "overloadIndex": 1,
7466
7738
  "parameters": [],
7739
+ "isOptional": false,
7467
7740
  "name": "requestToken"
7468
7741
  },
7469
7742
  {
7470
7743
  "kind": "Method",
7471
7744
  "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceTokenManager#setIamProfileCrn:member(1)",
7472
- "docComment": "/**\n * Setter for the \"trusted_profile\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param iamProfileCrn - A string that makes up the iamProfileCrn parameter\n */\n",
7745
+ "docComment": "/**\n * Sets the CRN of the IAM trusted profile to use when fetching the access token from the IAM token server.\n *\n * @param iamProfileCrn - the CRN of the IAM trusted profile\n */\n",
7473
7746
  "excerptTokens": [
7474
7747
  {
7475
7748
  "kind": "Content",
@@ -7492,13 +7765,13 @@
7492
7765
  "text": ";"
7493
7766
  }
7494
7767
  ],
7495
- "isOptional": false,
7496
7768
  "isStatic": false,
7497
7769
  "returnTypeTokenRange": {
7498
7770
  "startIndex": 3,
7499
7771
  "endIndex": 4
7500
7772
  },
7501
7773
  "releaseTag": "Public",
7774
+ "isProtected": false,
7502
7775
  "overloadIndex": 1,
7503
7776
  "parameters": [
7504
7777
  {
@@ -7510,12 +7783,13 @@
7510
7783
  "isOptional": false
7511
7784
  }
7512
7785
  ],
7786
+ "isOptional": false,
7513
7787
  "name": "setIamProfileCrn"
7514
7788
  },
7515
7789
  {
7516
7790
  "kind": "Method",
7517
7791
  "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceTokenManager#setIamProfileId:member(1)",
7518
- "docComment": "/**\n * Setter for the \"trusted_profile\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param iamProfileId - A string that makes up the iamProfileId parameter\n */\n",
7792
+ "docComment": "/**\n * Sets the Id of the IAM trusted profile to use when fetching the access token from the IAM token server.\n *\n * @param iamProfileId - the ID of the IAM trusted profile\n */\n",
7519
7793
  "excerptTokens": [
7520
7794
  {
7521
7795
  "kind": "Content",
@@ -7538,13 +7812,13 @@
7538
7812
  "text": ";"
7539
7813
  }
7540
7814
  ],
7541
- "isOptional": false,
7542
7815
  "isStatic": false,
7543
7816
  "returnTypeTokenRange": {
7544
7817
  "startIndex": 3,
7545
7818
  "endIndex": 4
7546
7819
  },
7547
7820
  "releaseTag": "Public",
7821
+ "isProtected": false,
7548
7822
  "overloadIndex": 1,
7549
7823
  "parameters": [
7550
7824
  {
@@ -7556,12 +7830,13 @@
7556
7830
  "isOptional": false
7557
7831
  }
7558
7832
  ],
7833
+ "isOptional": false,
7559
7834
  "name": "setIamProfileId"
7560
7835
  }
7561
7836
  ],
7562
7837
  "extendsTokenRange": {
7563
7838
  "startIndex": 1,
7564
- "endIndex": 3
7839
+ "endIndex": 2
7565
7840
  },
7566
7841
  "implementsTokenRanges": []
7567
7842
  }