ibm-cloud-sdk-core 3.2.2-beta-4 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (238) hide show
  1. package/.cra/.cveignore +2 -0
  2. package/.secrets.baseline +542 -0
  3. package/Authentication.md +525 -0
  4. package/CHANGELOG.md +713 -0
  5. package/LICENSE.md +201 -0
  6. package/MIGRATION-V1.md +42 -0
  7. package/README.md +116 -0
  8. package/api-extractor.json +39 -0
  9. package/appscan-config.xml +7 -0
  10. package/auth/authenticators/basic-authenticator.d.ts +1 -1
  11. package/auth/authenticators/bearer-token-authenticator.d.ts +1 -1
  12. package/auth/authenticators/token-request-based-authenticator.d.ts +1 -1
  13. package/auth/token-managers/container-token-manager.js +1 -1
  14. package/auth/token-managers/jwt-token-manager.d.ts +1 -1
  15. package/auth/token-managers/token-manager.d.ts +1 -1
  16. package/auth/token-managers/vpc-instance-token-manager.js +1 -1
  17. package/build/docs/ibm-cloud-sdk-core.atleastone.md +27 -0
  18. package/build/docs/ibm-cloud-sdk-core.atmostone.md +27 -0
  19. package/build/docs/ibm-cloud-sdk-core.authenticator._constructor_.md +18 -0
  20. package/build/docs/ibm-cloud-sdk-core.authenticator.authenticate.md +28 -0
  21. package/build/docs/ibm-cloud-sdk-core.authenticator.authenticationtype.md +19 -0
  22. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_basic.md +13 -0
  23. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md +11 -0
  24. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_container.md +11 -0
  25. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_cp4d.md +11 -0
  26. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_iam.md +11 -0
  27. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_noauth.md +11 -0
  28. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_unknown.md +11 -0
  29. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_vpc.md +11 -0
  30. package/build/docs/ibm-cloud-sdk-core.authenticator.md +41 -0
  31. package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md +24 -0
  32. package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md +17 -0
  33. package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.md +21 -0
  34. package/build/docs/ibm-cloud-sdk-core.baseservice._constructor_.md +20 -0
  35. package/build/docs/ibm-cloud-sdk-core.baseservice.baseoptions.md +11 -0
  36. package/build/docs/ibm-cloud-sdk-core.baseservice.configureservice.md +24 -0
  37. package/build/docs/ibm-cloud-sdk-core.baseservice.createrequest.md +26 -0
  38. package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_name.md +11 -0
  39. package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_url.md +11 -0
  40. package/build/docs/ibm-cloud-sdk-core.baseservice.disableretries.md +17 -0
  41. package/build/docs/ibm-cloud-sdk-core.baseservice.enableretries.md +24 -0
  42. package/build/docs/ibm-cloud-sdk-core.baseservice.getauthenticator.md +19 -0
  43. package/build/docs/ibm-cloud-sdk-core.baseservice.gethttpclient.md +17 -0
  44. package/build/docs/ibm-cloud-sdk-core.baseservice.md +44 -0
  45. package/build/docs/ibm-cloud-sdk-core.baseservice.setdefaultheaders.md +24 -0
  46. package/build/docs/ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md +24 -0
  47. package/build/docs/ibm-cloud-sdk-core.baseservice.setserviceurl.md +24 -0
  48. package/build/docs/ibm-cloud-sdk-core.basicauthenticator._constructor_.md +24 -0
  49. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticate.md +26 -0
  50. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticationtype.md +19 -0
  51. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authheader.md +13 -0
  52. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.md +39 -0
  53. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.requiredoptions.md +11 -0
  54. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md +24 -0
  55. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md +26 -0
  56. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticationtype.md +19 -0
  57. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.md +39 -0
  58. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md +11 -0
  59. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.md +24 -0
  60. package/build/docs/ibm-cloud-sdk-core.buildrequestfileobject.md +26 -0
  61. package/build/docs/ibm-cloud-sdk-core.checkcredentials.md +27 -0
  62. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md +24 -0
  63. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md +19 -0
  64. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.md +38 -0
  65. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md +11 -0
  66. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md +11 -0
  67. package/build/docs/ibm-cloud-sdk-core.computebasicauthheader.md +27 -0
  68. package/build/docs/ibm-cloud-sdk-core.constructfilepath.md +22 -0
  69. package/build/docs/ibm-cloud-sdk-core.constructserviceurl.md +28 -0
  70. package/build/docs/ibm-cloud-sdk-core.containerauthenticator._constructor_.md +24 -0
  71. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.authenticationtype.md +19 -0
  72. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.md +40 -0
  73. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setcrtokenfilename.md +24 -0
  74. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofileid.md +24 -0
  75. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofilename.md +24 -0
  76. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.tokenmanager.md +11 -0
  77. package/build/docs/ibm-cloud-sdk-core.containertokenmanager._constructor_.md +20 -0
  78. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.md +30 -0
  79. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.requesttoken.md +19 -0
  80. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md +24 -0
  81. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md +24 -0
  82. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md +24 -0
  83. package/build/docs/ibm-cloud-sdk-core.contenttype.md +14 -0
  84. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md +20 -0
  85. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.md +35 -0
  86. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md +15 -0
  87. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md +11 -0
  88. package/build/docs/ibm-cloud-sdk-core.fileexistsatpath.md +22 -0
  89. package/build/docs/ibm-cloud-sdk-core.fileobject.md +27 -0
  90. package/build/docs/ibm-cloud-sdk-core.fileobject.options.md +11 -0
  91. package/build/docs/ibm-cloud-sdk-core.fileobject.value.md +11 -0
  92. package/build/docs/ibm-cloud-sdk-core.fileoptions.contenttype.md +11 -0
  93. package/build/docs/ibm-cloud-sdk-core.fileoptions.filename.md +11 -0
  94. package/build/docs/ibm-cloud-sdk-core.fileoptions.md +19 -0
  95. package/build/docs/ibm-cloud-sdk-core.filestream.md +19 -0
  96. package/build/docs/ibm-cloud-sdk-core.filestream.path.md +11 -0
  97. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.contenttype.md +11 -0
  98. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.data.md +11 -0
  99. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.filename.md +11 -0
  100. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.md +20 -0
  101. package/build/docs/ibm-cloud-sdk-core.getauthenticatorfromenvironment.md +26 -0
  102. package/build/docs/ibm-cloud-sdk-core.getcontenttype.md +26 -0
  103. package/build/docs/ibm-cloud-sdk-core.getcurrenttime.md +19 -0
  104. package/build/docs/ibm-cloud-sdk-core.getformat.md +29 -0
  105. package/build/docs/ibm-cloud-sdk-core.getmissingparams.md +29 -0
  106. package/build/docs/ibm-cloud-sdk-core.getnewlogger.md +30 -0
  107. package/build/docs/ibm-cloud-sdk-core.getqueryparam.md +31 -0
  108. package/build/docs/ibm-cloud-sdk-core.iamauthenticator._constructor_.md +24 -0
  109. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.authenticationtype.md +19 -0
  110. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.md +38 -0
  111. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md +11 -0
  112. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md +11 -0
  113. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator._constructor_.md +24 -0
  114. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientid.md +11 -0
  115. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientsecret.md +11 -0
  116. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.getrefreshtoken.md +19 -0
  117. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.md +38 -0
  118. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.scope.md +11 -0
  119. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md +25 -0
  120. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md +24 -0
  121. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.tokenmanager.md +11 -0
  122. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md +20 -0
  123. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md +11 -0
  124. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md +19 -0
  125. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md +38 -0
  126. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md +11 -0
  127. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md +19 -0
  128. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md +26 -0
  129. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md +27 -0
  130. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md +26 -0
  131. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientid.md +11 -0
  132. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md +11 -0
  133. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.md +23 -0
  134. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.scope.md +11 -0
  135. package/build/docs/ibm-cloud-sdk-core.iamtokenmanager._constructor_.md +20 -0
  136. package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.md +27 -0
  137. package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.requiredoptions.md +11 -0
  138. package/build/docs/ibm-cloud-sdk-core.isemptyobject.md +22 -0
  139. package/build/docs/ibm-cloud-sdk-core.isfiledata.md +22 -0
  140. package/build/docs/ibm-cloud-sdk-core.isfilewithmetadata.md +22 -0
  141. package/build/docs/ibm-cloud-sdk-core.ishtml.md +26 -0
  142. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager._constructor_.md +20 -0
  143. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.md +35 -0
  144. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md +19 -0
  145. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md +26 -0
  146. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.md +11 -0
  147. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokenname.md +11 -0
  148. package/build/docs/ibm-cloud-sdk-core.jwttokenmanageroptions.md +15 -0
  149. package/build/docs/ibm-cloud-sdk-core.md +96 -0
  150. package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticate.md +22 -0
  151. package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticationtype.md +19 -0
  152. package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.md +22 -0
  153. package/build/docs/ibm-cloud-sdk-core.onlyone.md +27 -0
  154. package/build/docs/ibm-cloud-sdk-core.qs.md +21 -0
  155. package/build/docs/ibm-cloud-sdk-core.readcredentialsfile.md +17 -0
  156. package/build/docs/ibm-cloud-sdk-core.readcrtokenfile.md +22 -0
  157. package/build/docs/ibm-cloud-sdk-core.readexternalsources.md +26 -0
  158. package/build/docs/ibm-cloud-sdk-core.removesuffix.md +27 -0
  159. package/build/docs/ibm-cloud-sdk-core.sdklogger.debug.md +11 -0
  160. package/build/docs/ibm-cloud-sdk-core.sdklogger.error.md +11 -0
  161. package/build/docs/ibm-cloud-sdk-core.sdklogger.info.md +11 -0
  162. package/build/docs/ibm-cloud-sdk-core.sdklogger.md +22 -0
  163. package/build/docs/ibm-cloud-sdk-core.sdklogger.verbose.md +11 -0
  164. package/build/docs/ibm-cloud-sdk-core.sdklogger.warn.md +11 -0
  165. package/build/docs/ibm-cloud-sdk-core.streamtopromise.md +24 -0
  166. package/build/docs/ibm-cloud-sdk-core.striptrailingslash.md +24 -0
  167. package/build/docs/ibm-cloud-sdk-core.tokenmanager._constructor_.md +20 -0
  168. package/build/docs/ibm-cloud-sdk-core.tokenmanager.accesstoken.md +11 -0
  169. package/build/docs/ibm-cloud-sdk-core.tokenmanager.disablesslverification.md +11 -0
  170. package/build/docs/ibm-cloud-sdk-core.tokenmanager.expiretime.md +11 -0
  171. package/build/docs/ibm-cloud-sdk-core.tokenmanager.gettoken.md +17 -0
  172. package/build/docs/ibm-cloud-sdk-core.tokenmanager.headers.md +11 -0
  173. package/build/docs/ibm-cloud-sdk-core.tokenmanager.md +43 -0
  174. package/build/docs/ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md +19 -0
  175. package/build/docs/ibm-cloud-sdk-core.tokenmanager.refreshtime.md +11 -0
  176. package/build/docs/ibm-cloud-sdk-core.tokenmanager.requesttoken.md +19 -0
  177. package/build/docs/ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md +11 -0
  178. package/build/docs/ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md +26 -0
  179. package/build/docs/ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md +26 -0
  180. package/build/docs/ibm-cloud-sdk-core.tokenmanager.setheaders.md +26 -0
  181. package/build/docs/ibm-cloud-sdk-core.tokenmanager.url.md +11 -0
  182. package/build/docs/ibm-cloud-sdk-core.tokenmanageroptions.md +18 -0
  183. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md +20 -0
  184. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md +26 -0
  185. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md +11 -0
  186. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md +11 -0
  187. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md +42 -0
  188. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md +24 -0
  189. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md +24 -0
  190. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.tokenmanager.md +11 -0
  191. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.url.md +11 -0
  192. package/build/docs/ibm-cloud-sdk-core.tolowerkeys.md +26 -0
  193. package/build/docs/ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md +26 -0
  194. package/build/docs/ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md +28 -0
  195. package/build/docs/ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md +28 -0
  196. package/build/docs/ibm-cloud-sdk-core.unittestutils.checkuserheader.md +28 -0
  197. package/build/docs/ibm-cloud-sdk-core.unittestutils.expecttobepromise.md +26 -0
  198. package/build/docs/ibm-cloud-sdk-core.unittestutils.getoptions.md +26 -0
  199. package/build/docs/ibm-cloud-sdk-core.unittestutils.md +17 -0
  200. package/build/docs/ibm-cloud-sdk-core.useroptions.authenticator.md +13 -0
  201. package/build/docs/ibm-cloud-sdk-core.useroptions.disablesslverification.md +13 -0
  202. package/build/docs/ibm-cloud-sdk-core.useroptions.headers.md +13 -0
  203. package/build/docs/ibm-cloud-sdk-core.useroptions.jar.md +13 -0
  204. package/build/docs/ibm-cloud-sdk-core.useroptions.md +26 -0
  205. package/build/docs/ibm-cloud-sdk-core.useroptions.serviceurl.md +13 -0
  206. package/build/docs/ibm-cloud-sdk-core.useroptions.url.md +13 -0
  207. package/build/docs/ibm-cloud-sdk-core.useroptions.version.md +13 -0
  208. package/build/docs/ibm-cloud-sdk-core.validateinput.md +23 -0
  209. package/build/docs/ibm-cloud-sdk-core.validateparams.md +30 -0
  210. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md +20 -0
  211. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md +19 -0
  212. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.md +39 -0
  213. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md +24 -0
  214. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md +24 -0
  215. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md +11 -0
  216. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md +20 -0
  217. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.md +29 -0
  218. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md +15 -0
  219. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md +24 -0
  220. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md +24 -0
  221. package/build/docs/index.md +12 -0
  222. package/docs/ibm-cloud-sdk-core.api.json +2 -2
  223. package/es/auth/authenticators/basic-authenticator.d.ts +1 -1
  224. package/es/auth/authenticators/bearer-token-authenticator.d.ts +1 -1
  225. package/es/auth/authenticators/token-request-based-authenticator.d.ts +1 -1
  226. package/es/auth/token-managers/jwt-token-manager.d.ts +1 -1
  227. package/es/auth/token-managers/token-manager.d.ts +1 -1
  228. package/es/lib/cookie-support.js +3 -4
  229. package/es/lib/request-wrapper.js +4 -2
  230. package/es/tsdoc-metadata.json +11 -0
  231. package/etc/ibm-cloud-sdk-core.api.md +483 -0
  232. package/lib/cookie-support.js +24 -24
  233. package/lib/helper.js +1 -1
  234. package/lib/request-wrapper.js +6 -6
  235. package/package.json +3 -37
  236. package/temp/ibm-cloud-sdk-core.api.json +7571 -0
  237. package/temp/ibm-cloud-sdk-core.api.md +483 -0
  238. package/tsconfig-es6.json +9 -0
@@ -0,0 +1,17 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md)
4
+
5
+ ## unitTestUtils namespace
6
+
7
+ ## Functions
8
+
9
+ | Function | Description |
10
+ | --- | --- |
11
+ | [checkForSuccessfulExecution(createRequestMock)](./ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md) | This method simply ensures that the method executed without any issues by extracting the argument from the mock object for the <code>createRequest</code> method and verifying that it is an object. |
12
+ | [checkMediaHeaders(createRequestMock, accept, contentType)](./ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md) | Takes the mock object for the <code>createRequest</code> method, extracts the headers that were sent with the call, and checks for the expected values for <code>Accept</code> and <code>Content-Type</code>. This to verify that the SDK sets the correct values in the code. |
13
+ | [checkUrlAndMethod(options, url, method)](./ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md) | Takes the request options constructed by the SDK and checks that the <code>url</code> and <code>method</code> properties were set to their correct values. |
14
+ | [checkUserHeader(createRequestMock, userHeaderName, userHeaderValue)](./ibm-cloud-sdk-core.unittestutils.checkuserheader.md) | Takes the mock object for the <code>createRequest</code> 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. |
15
+ | [expectToBePromise(sdkPromise)](./ibm-cloud-sdk-core.unittestutils.expecttobepromise.md) | This method simply ensures that the SDK methods return Promises by checking for the <code>then</code> function - common way to assess whether or not an object is a Promise. |
16
+ | [getOptions(createRequestMock)](./ibm-cloud-sdk-core.unittestutils.getoptions.md) | This method extracts the <code>options</code> property from the object passed into <code>createRequest</code>. This property is an object containing all of the SDK method-specific information (like <code>path</code> and <code>body</code>) 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. |
17
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [authenticator](./ibm-cloud-sdk-core.useroptions.authenticator.md)
4
+
5
+ ## UserOptions.authenticator property
6
+
7
+ The Authenticator object used to authenticate requests to the service
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ authenticator?: AuthenticatorInterface;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [disableSslVerification](./ibm-cloud-sdk-core.useroptions.disablesslverification.md)
4
+
5
+ ## UserOptions.disableSslVerification property
6
+
7
+ Set to `true` to allow unauthorized requests - not recommended for production use.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ disableSslVerification?: boolean;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [headers](./ibm-cloud-sdk-core.useroptions.headers.md)
4
+
5
+ ## UserOptions.headers property
6
+
7
+ Default headers that shall be included with every request to the service.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ headers?: OutgoingHttpHeaders;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [jar](./ibm-cloud-sdk-core.useroptions.jar.md)
4
+
5
+ ## UserOptions.jar property
6
+
7
+ Set your own cookie jar object
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ jar?: CookieJar | boolean;
13
+ ```
@@ -0,0 +1,26 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md)
4
+
5
+ ## UserOptions interface
6
+
7
+ Configuration values for a service.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export interface UserOptions
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ | Property | Type | Description |
18
+ | --- | --- | --- |
19
+ | [authenticator?](./ibm-cloud-sdk-core.useroptions.authenticator.md) | [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) | <i>(Optional)</i> The Authenticator object used to authenticate requests to the service |
20
+ | [disableSslVerification?](./ibm-cloud-sdk-core.useroptions.disablesslverification.md) | boolean | <i>(Optional)</i> Set to <code>true</code> to allow unauthorized requests - not recommended for production use. |
21
+ | [headers?](./ibm-cloud-sdk-core.useroptions.headers.md) | OutgoingHttpHeaders | <i>(Optional)</i> Default headers that shall be included with every request to the service. |
22
+ | [jar?](./ibm-cloud-sdk-core.useroptions.jar.md) | CookieJar \| boolean | <i>(Optional)</i> Set your own cookie jar object |
23
+ | [serviceUrl?](./ibm-cloud-sdk-core.useroptions.serviceurl.md) | string | <i>(Optional)</i> The base url to use when contacting the service. The base url may differ between IBM Cloud regions. |
24
+ | [url?](./ibm-cloud-sdk-core.useroptions.url.md) | string | <i>(Optional)</i> Deprecated. Use <code>serviceUrl</code> instead. |
25
+ | [version?](./ibm-cloud-sdk-core.useroptions.version.md) | string | <i>(Optional)</i> The API version date to use with the service, in "YYYY-MM-DD" format. |
26
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [serviceUrl](./ibm-cloud-sdk-core.useroptions.serviceurl.md)
4
+
5
+ ## UserOptions.serviceUrl property
6
+
7
+ The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ serviceUrl?: string;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [url](./ibm-cloud-sdk-core.useroptions.url.md)
4
+
5
+ ## UserOptions.url property
6
+
7
+ Deprecated. Use `serviceUrl` instead.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ url?: string;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [version](./ibm-cloud-sdk-core.useroptions.version.md)
4
+
5
+ ## UserOptions.version property
6
+
7
+ The API version date to use with the service, in "YYYY-MM-DD" format.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ version?: string;
13
+ ```
@@ -0,0 +1,23 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [validateInput](./ibm-cloud-sdk-core.validateinput.md)
4
+
5
+ ## validateInput() function
6
+
7
+ <b>Signature:</b>
8
+
9
+ ```typescript
10
+ export declare function validateInput(options: any, requiredOptions: string[]): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | options | any | A configuration options object. |
18
+ | requiredOptions | string\[\] | The list of properties that must be specified. |
19
+
20
+ <b>Returns:</b>
21
+
22
+ void
23
+
@@ -0,0 +1,30 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [validateParams](./ibm-cloud-sdk-core.validateparams.md)
4
+
5
+ ## validateParams() function
6
+
7
+ 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.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export declare function validateParams(params: {
13
+ [key: string]: any;
14
+ }, requiredParams: string[], allParams: string[]): null | Error;
15
+ ```
16
+
17
+ ## Parameters
18
+
19
+ | Parameter | Type | Description |
20
+ | --- | --- | --- |
21
+ | params | { \[key: string\]: any; } | the "params" object passed into an operation containing method parameters. |
22
+ | requiredParams | string\[\] | the names of required parameters. If null, then the "required params" check is bypassed. |
23
+ | allParams | string\[\] | the names of all valid parameters. If null, then the "valid params" check is bypassed. |
24
+
25
+ <b>Returns:</b>
26
+
27
+ null \| Error
28
+
29
+ {<!-- -->Error\|null<!-- -->}
30
+
@@ -0,0 +1,20 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md)
4
+
5
+ ## VpcInstanceAuthenticator.(constructor)
6
+
7
+ Create a new \[\[VpcInstanceAuthenticator\]\] instance.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ constructor(options: Options);
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | options | Options | Configuration options for VpcInstance authentication. |
20
+
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md)
4
+
5
+ ## VpcInstanceAuthenticator.authenticationType() method
6
+
7
+ Returns the authenticator's type ('vpc').
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ authenticationType(): string;
13
+ ```
14
+ <b>Returns:</b>
15
+
16
+ string
17
+
18
+ a string that indicates the authenticator's type
19
+
@@ -0,0 +1,39 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md)
4
+
5
+ ## VpcInstanceAuthenticator class
6
+
7
+ 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).
8
+
9
+ The resulting IAM access token is then added to outbound requests in an Authorization header
10
+
11
+ Authorization: Bearer <access-token>
12
+
13
+ <b>Signature:</b>
14
+
15
+ ```typescript
16
+ export declare class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator
17
+ ```
18
+ <b>Extends:</b> [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
19
+
20
+ ## Constructors
21
+
22
+ | Constructor | Modifiers | Description |
23
+ | --- | --- | --- |
24
+ | [(constructor)(options)](./ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md) | | Create a new \[\[VpcInstanceAuthenticator\]\] instance. |
25
+
26
+ ## Properties
27
+
28
+ | Property | Modifiers | Type | Description |
29
+ | --- | --- | --- | --- |
30
+ | [tokenManager](./ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md) | | [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) | |
31
+
32
+ ## Methods
33
+
34
+ | Method | Modifiers | Description |
35
+ | --- | --- | --- |
36
+ | [authenticationType()](./ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md) | | Returns the authenticator's type ('vpc'). |
37
+ | [setIamProfileCrn(iamProfileCrn)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md) | | Setter for the "profile\_crn" parameter to use when fetching the bearer token from the IAM token server. |
38
+ | [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md) | | Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server. |
39
+
@@ -0,0 +1,24 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [setIamProfileCrn](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md)
4
+
5
+ ## VpcInstanceAuthenticator.setIamProfileCrn() method
6
+
7
+ Setter for the "profile\_crn" parameter to use when fetching the bearer token from the IAM token server.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ setIamProfileCrn(iamProfileCrn: string): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | iamProfileCrn | string | |
20
+
21
+ <b>Returns:</b>
22
+
23
+ void
24
+
@@ -0,0 +1,24 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [setIamProfileId](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md)
4
+
5
+ ## VpcInstanceAuthenticator.setIamProfileId() method
6
+
7
+ Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ setIamProfileId(iamProfileId: string): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | iamProfileId | string | |
20
+
21
+ <b>Returns:</b>
22
+
23
+ void
24
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md)
4
+
5
+ ## VpcInstanceAuthenticator.tokenManager property
6
+
7
+ <b>Signature:</b>
8
+
9
+ ```typescript
10
+ protected tokenManager: VpcInstanceTokenManager;
11
+ ```
@@ -0,0 +1,20 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md)
4
+
5
+ ## VpcInstanceTokenManager.(constructor)
6
+
7
+ Create a new \[\[VpcInstanceTokenManager\]\] instance.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ constructor(options: Options);
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | options | Options | Configuration options. |
20
+
@@ -0,0 +1,29 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md)
4
+
5
+ ## VpcInstanceTokenManager class
6
+
7
+ Token Manager for VPC Instance Authentication.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export declare class VpcInstanceTokenManager extends JwtTokenManager
13
+ ```
14
+ <b>Extends:</b> [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
15
+
16
+ ## Constructors
17
+
18
+ | Constructor | Modifiers | Description |
19
+ | --- | --- | --- |
20
+ | [(constructor)(options)](./ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md) | | Create a new \[\[VpcInstanceTokenManager\]\] instance. |
21
+
22
+ ## Methods
23
+
24
+ | Method | Modifiers | Description |
25
+ | --- | --- | --- |
26
+ | [requestToken()](./ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md) | | |
27
+ | [setIamProfileCrn(iamProfileCrn)](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md) | | Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server. |
28
+ | [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md) | | Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server. |
29
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [requestToken](./ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md)
4
+
5
+ ## VpcInstanceTokenManager.requestToken() method
6
+
7
+ <b>Signature:</b>
8
+
9
+ ```typescript
10
+ protected requestToken(): Promise<any>;
11
+ ```
12
+ <b>Returns:</b>
13
+
14
+ Promise&lt;any&gt;
15
+
@@ -0,0 +1,24 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [setIamProfileCrn](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md)
4
+
5
+ ## VpcInstanceTokenManager.setIamProfileCrn() method
6
+
7
+ Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ setIamProfileCrn(iamProfileCrn: string): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | iamProfileCrn | string | A string that makes up the iamProfileCrn parameter |
20
+
21
+ <b>Returns:</b>
22
+
23
+ void
24
+
@@ -0,0 +1,24 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [setIamProfileId](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md)
4
+
5
+ ## VpcInstanceTokenManager.setIamProfileId() method
6
+
7
+ Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ setIamProfileId(iamProfileId: string): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | iamProfileId | string | A string that makes up the iamProfileId parameter |
20
+
21
+ <b>Returns:</b>
22
+
23
+ void
24
+
@@ -0,0 +1,12 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md)
4
+
5
+ ## API Reference
6
+
7
+ ## Packages
8
+
9
+ | Package | Description |
10
+ | --- | --- |
11
+ | [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) | |
12
+
@@ -4894,7 +4894,7 @@
4894
4894
  "excerptTokens": [
4895
4895
  {
4896
4896
  "kind": "Content",
4897
- "text": "export declare type JwtTokenManagerOptions = "
4897
+ "text": "export type JwtTokenManagerOptions = "
4898
4898
  },
4899
4899
  {
4900
4900
  "kind": "Reference",
@@ -6020,7 +6020,7 @@
6020
6020
  "excerptTokens": [
6021
6021
  {
6022
6022
  "kind": "Content",
6023
- "text": "export declare type TokenManagerOptions = "
6023
+ "text": "export type TokenManagerOptions = "
6024
6024
  },
6025
6025
  {
6026
6026
  "kind": "Content",
@@ -16,7 +16,7 @@
16
16
  import { Authenticator } from './authenticator';
17
17
  import { AuthenticateOptions } from './authenticator-interface';
18
18
  /** Configuration options for basic authentication. */
19
- export declare type Options = {
19
+ export type Options = {
20
20
  /** The username to be used in basic authorization. */
21
21
  username: string;
22
22
  /** The password to be used in basic authorization. */
@@ -16,7 +16,7 @@
16
16
  import { Authenticator } from './authenticator';
17
17
  import { AuthenticateOptions } from './authenticator-interface';
18
18
  /** Configuration options for bearer authentication. */
19
- export declare type Options = {
19
+ export type Options = {
20
20
  /** The bearer token to be added to requests. */
21
21
  bearerToken: string;
22
22
  };
@@ -19,7 +19,7 @@ import { JwtTokenManager } from '../token-managers';
19
19
  import { Authenticator } from './authenticator';
20
20
  import { AuthenticateOptions } from './authenticator-interface';
21
21
  /** Configuration options for token-based authentication. */
22
- export declare type BaseOptions = {
22
+ export type BaseOptions = {
23
23
  /** Headers to be sent with every outbound HTTP requests to token services. */
24
24
  headers?: OutgoingHttpHeaders;
25
25
  /**
@@ -1,6 +1,6 @@
1
1
  import { TokenManager, TokenManagerOptions } from './token-manager';
2
2
  /** Configuration options for JWT token retrieval. */
3
- export declare type JwtTokenManagerOptions = TokenManagerOptions;
3
+ export type JwtTokenManagerOptions = TokenManagerOptions;
4
4
  /**
5
5
  * A class for shared functionality for parsing, storing, and requesting
6
6
  * JWT tokens. Intended to be used as a parent to be extended for token
@@ -17,7 +17,7 @@
17
17
  import { OutgoingHttpHeaders } from 'http';
18
18
  import { RequestWrapper } from '../../lib/request-wrapper';
19
19
  /** Configuration options for token retrieval. */
20
- export declare type TokenManagerOptions = {
20
+ export type TokenManagerOptions = {
21
21
  /** The endpoint for token requests. */
22
22
  url?: string;
23
23
  /** Headers to be sent with every service token request. */
@@ -69,10 +69,9 @@ export class CookieInterceptor {
69
69
  logger.debug('CookieInterceptor: checking for set-cookie headers.');
70
70
  const cookies = response.headers['set-cookie'];
71
71
  if (cookies) {
72
- logger.debug('CookieInterceptor: setting cookies in jar.');
73
- cookies.forEach((cookie) => __awaiter(this, void 0, void 0, function* () {
74
- yield this.cookieJar.setCookie(cookie, response.request.url);
75
- }));
72
+ logger.debug(`CookieInterceptor: setting cookies in jar for URL ${response.config.url}.`);
73
+ // Write cookies sequentially by chaining the promises in a reduce
74
+ yield cookies.reduce((cookiePromise, cookie) => cookiePromise.then(() => this.cookieJar.setCookie(cookie, response.config.url)), Promise.resolve(null));
76
75
  }
77
76
  else {
78
77
  logger.debug('CookieInterceptor: no set-cookie headers.');
@@ -73,8 +73,10 @@ export class RequestWrapper {
73
73
  // if a cookie jar is provided, wrap the axios instance and update defaults
74
74
  if (axiosOptions.jar) {
75
75
  const cookieInterceptor = new CookieInterceptor(axiosOptions.jar);
76
- this.axiosInstance.interceptors.request.use((config) => cookieInterceptor.requestInterceptor(config));
77
- this.axiosInstance.interceptors.response.use((response) => cookieInterceptor.responseInterceptor(response));
76
+ const requestCookieInterceptor = (config) => cookieInterceptor.requestInterceptor(config);
77
+ const responseCookieInterceptor = (response) => cookieInterceptor.responseInterceptor(response);
78
+ this.axiosInstance.interceptors.request.use(requestCookieInterceptor);
79
+ this.axiosInstance.interceptors.response.use(responseCookieInterceptor);
78
80
  }
79
81
  // get retry config properties and conditionally enable retries
80
82
  if (axiosOptions.enableRetries) {
@@ -0,0 +1,11 @@
1
+ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
+ // It should be published with your NPM package. It should not be tracked by Git.
3
+ {
4
+ "tsdocVersion": "0.12",
5
+ "toolPackages": [
6
+ {
7
+ "packageName": "@microsoft/api-extractor",
8
+ "packageVersion": "7.20.0"
9
+ }
10
+ ]
11
+ }