ibm-cloud-sdk-core 3.2.2-beta-5 → 3.2.2

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[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)
+
+## VpcInstanceAuthenticator.setIamProfileCrn() method
+
+Setter for the "profile\_crn" parameter to use when fetching the bearer token from the IAM token server.
+
+<b>Signature:</b>
+
+```typescript
+setIamProfileCrn(iamProfileCrn: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  iamProfileCrn | string |  |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[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)
+
+## VpcInstanceAuthenticator.setIamProfileId() method
+
+Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server.
+
+<b>Signature:</b>
+
+```typescript
+setIamProfileId(iamProfileId: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  iamProfileId | string |  |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[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)
+
+## VpcInstanceAuthenticator.tokenManager property
+
+<b>Signature:</b>
+
+```typescript
+protected tokenManager: VpcInstanceTokenManager;
+```

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[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)
+
+## VpcInstanceTokenManager.(constructor)
+
+Create a new \[\[VpcInstanceTokenManager\]\] instance.
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | Options | Configuration options. |
+

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md)
+
+## VpcInstanceTokenManager class
+
+Token Manager for VPC Instance Authentication.
+
+<b>Signature:</b>
+
+```typescript
+export declare class VpcInstanceTokenManager extends JwtTokenManager 
+```
+<b>Extends:</b> [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md) |  | Create a new \[\[VpcInstanceTokenManager\]\] instance. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [requestToken()](./ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md) |  |  |
+|  [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. |
+|  [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. |
+

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[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)
+
+## VpcInstanceTokenManager.requestToken() method
+
+<b>Signature:</b>
+
+```typescript
+protected requestToken(): Promise<any>;
+```
+<b>Returns:</b>
+
+Promise&lt;any&gt;
+

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[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)
+
+## VpcInstanceTokenManager.setIamProfileCrn() method
+
+Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server.
+
+<b>Signature:</b>
+
+```typescript
+setIamProfileCrn(iamProfileCrn: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  iamProfileCrn | string | A string that makes up the iamProfileCrn parameter |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[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)
+
+## VpcInstanceTokenManager.setIamProfileId() method
+
+Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server.
+
+<b>Signature:</b>
+
+```typescript
+setIamProfileId(iamProfileId: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  iamProfileId | string | A string that makes up the iamProfileId parameter |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) |  |
+

package/docs/ibm-cloud-sdk-core.api.json

@@ -4894,7 +4894,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export type JwtTokenManagerOptions = "
+              "text": "export declare type JwtTokenManagerOptions = "
             },
             {
               "kind": "Reference",
@@ -6020,7 +6020,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export type TokenManagerOptions = "
+              "text": "export declare type TokenManagerOptions = "
             },
             {
               "kind": "Content",

package/es/auth/authenticators/authenticator-interface.js

@@ -13,4 +13,3 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export {};

package/es/auth/authenticators/basic-authenticator.d.ts

@@ -16,7 +16,7 @@
 import { Authenticator } from './authenticator';
 import { AuthenticateOptions } from './authenticator-interface';
 /** Configuration options for basic authentication. */
-export type Options = {
+export declare type Options = {
     /** The username to be used in basic authorization. */
     username: string;
     /** The password to be used in basic authorization. */

package/es/auth/authenticators/bearer-token-authenticator.d.ts

@@ -16,7 +16,7 @@
 import { Authenticator } from './authenticator';
 import { AuthenticateOptions } from './authenticator-interface';
 /** Configuration options for bearer authentication. */
-export type Options = {
+export declare type Options = {
     /** The bearer token to be added to requests. */
     bearerToken: string;
 };

package/es/auth/authenticators/token-request-based-authenticator.d.ts

@@ -19,7 +19,7 @@ import { JwtTokenManager } from '../token-managers';
 import { Authenticator } from './authenticator';
 import { AuthenticateOptions } from './authenticator-interface';
 /** Configuration options for token-based authentication. */
-export type BaseOptions = {
+export declare type BaseOptions = {
     /** Headers to be sent with every outbound HTTP requests to token services. */
     headers?: OutgoingHttpHeaders;
     /**

package/es/auth/token-managers/jwt-token-manager.d.ts

@@ -1,6 +1,6 @@
 import { TokenManager, TokenManagerOptions } from './token-manager';
 /** Configuration options for JWT token retrieval. */
-export type JwtTokenManagerOptions = TokenManagerOptions;
+export declare type JwtTokenManagerOptions = TokenManagerOptions;
 /**
  * A class for shared functionality for parsing, storing, and requesting
  * JWT tokens. Intended to be used as a parent to be extended for token

package/es/auth/token-managers/token-manager.d.ts

@@ -17,7 +17,7 @@
 import { OutgoingHttpHeaders } from 'http';
 import { RequestWrapper } from '../../lib/request-wrapper';
 /** Configuration options for token retrieval. */
-export type TokenManagerOptions = {
+export declare type TokenManagerOptions = {
     /** The endpoint for token requests. */
     url?: string;
     /** Headers to be sent with every service token request. */

package/es/lib/request-wrapper.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2014, 2022.
+ * (C) Copyright IBM Corp. 2014, 2021.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/es/lib/request-wrapper.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 /**
- * (C) Copyright IBM Corp. 2014, 2022.
+ * (C) Copyright IBM Corp. 2014, 2021.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
  */
 import axios from 'axios';
 import * as rax from 'retry-axios';
+import axiosCookieJarSupport from 'axios-cookiejar-support';
 import extend from 'extend';
 import FormData from 'form-data';
 import { Agent } from 'https';
@@ -34,7 +35,6 @@ import { gzipSync } from 'zlib';
 import { buildRequestFileObject, isEmptyObject, isFileData, isFileWithMetadata, stripTrailingSlash, } from './helper';
 import logger from './logger';
 import { streamToPromise } from './stream-to-promise';
-import { CookieInterceptor } from './cookie-support';
 export class RequestWrapper {
     constructor(axiosOptions) {
         axiosOptions = axiosOptions || {};
@@ -72,11 +72,9 @@ export class RequestWrapper {
         });
         // if a cookie jar is provided, wrap the axios instance and update defaults
         if (axiosOptions.jar) {
-            const cookieInterceptor = new CookieInterceptor(axiosOptions.jar);
-            const requestCookieInterceptor = (config) => cookieInterceptor.requestInterceptor(config);
-            const responseCookieInterceptor = (response) => cookieInterceptor.responseInterceptor(response);
-            this.axiosInstance.interceptors.request.use(requestCookieInterceptor);
-            this.axiosInstance.interceptors.response.use(responseCookieInterceptor);
+            axiosCookieJarSupport(this.axiosInstance);
+            this.axiosInstance.defaults.withCredentials = true;
+            this.axiosInstance.defaults.jar = axiosOptions.jar;
         }
         // get retry config properties and conditionally enable retries
         if (axiosOptions.enableRetries) {
@@ -195,7 +193,7 @@ export class RequestWrapper {
                 data,
                 raxConfig: this.raxConfig,
                 responseType: options.responseType || 'json',
-                paramsSerializer: { serialize: (params) => stringify(params) },
+                paramsSerializer: (params) => stringify(params),
             };
             return this.axiosInstance(requestParams).then((res) => {
                 // sometimes error responses will still trigger the `then` block - escape that behavior here
@@ -299,7 +297,7 @@ export class RequestWrapper {
             instance: axiosInstance,
             backoffType: 'exponential',
             checkRetryAfter: true,
-            maxRetryDelay: 30 * 1000, // default to 30 sec max delay
+            maxRetryDelay: 30 * 1000,
         };
         if (retryOptions) {
             if (typeof retryOptions.maxRetries === 'number') {

package/es/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.20.0"
+    }
+  ]
+}