docs: update api.md file to reflect latest code

Signed-off-by: Phil Adams <[email protected]>
IBM · Jan 10, 2025 · 8fd2212 · 8fd2212
1 parent 290c1fa
commit 8fd2212
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 30 deletions.
diff --git a/.secrets.baseline b/.secrets.baseline
@@ -3,7 +3,7 @@
     "files": "package-lock.json|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2024-10-10T20:59:14Z",
+  "generated_at": "2025-01-10T16:03:07Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -128,7 +128,7 @@
         "hashed_secret": "bc2f74c22f98f7b6ffbc2f67453dbfa99bce9a32",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 214,
+        "line_number": 221,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -394,7 +394,7 @@
         "hashed_secret": "45c43fe97e3a06ab078b0eeff6fbe622cc417a25",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 286,
+        "line_number": 292,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -686,7 +686,7 @@
       }
     ]
   },
-  "version": "0.13.1+ibm.56.dss",
+  "version": "0.13.1+ibm.62.dss",
   "word_list": {
     "file": null,
     "hash": null

diff --git a/etc/ibm-cloud-sdk-core.api.md b/etc/ibm-cloud-sdk-core.api.md
@@ -132,6 +132,7 @@ export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
     // Warning: (ae-forgotten-export) The symbol "Options_8" needs to be exported by the entry point index.d.ts
     constructor(options: Options_8);
     authenticationType(): string;
+    getRefreshToken(): string;
     setCrTokenFilename(crTokenFilename: string): void;
     setIamProfileId(iamProfileId: string): void;
     setIamProfileName(iamProfileName: string): void;
@@ -144,6 +145,7 @@ export class ContainerTokenManager extends IamRequestBasedTokenManager {
     // Warning: (ae-forgotten-export) The symbol "Options_7" needs to be exported by the entry point index.d.ts
     constructor(options: Options_7);
     protected getCrToken(): string;
+    getRefreshToken(): string;
     protected requestToken(): Promise<any>;
     setCrTokenFilename(crTokenFilename: string): void;
     setIamProfileId(iamProfileId: string): void;
@@ -226,8 +228,10 @@ export function getNewLogger(moduleName: string): SDKLogger;
 // @public
 export function getQueryParam(urlStr: string, param: string): string;
 
+// Warning: (ae-forgotten-export) The symbol "IamRequestBasedAuthenticatorImmutable" needs to be exported by the entry point index.d.ts
+//
 // @public
-export class IamAssumeAuthenticator extends IamRequestBasedAuthenticator {
+export class IamAssumeAuthenticator extends IamRequestBasedAuthenticatorImmutable {
     // Warning: (ae-forgotten-export) The symbol "Options_14" needs to be exported by the entry point index.d.ts
     constructor(options: Options_14);
     authenticationType(): string;
@@ -242,47 +246,49 @@ export class IamAssumeTokenManager extends IamRequestBasedTokenManager {
     protected requestToken(): Promise<any>;
     // (undocumented)
     protected requiredOptions: string[];
+    protected saveTokenInfo(tokenResponse: any): void;
+    setClientIdAndSecret(clientId: string, clientSecret: string): void;
+    setDisableSslVerification(value: boolean): void;
+    setHeaders(headers: OutgoingHttpHeaders): void;
+    setScope(scope: string): void;
 }
 
 // @public
 export class IamAuthenticator extends IamRequestBasedAuthenticator {
     // Warning: (ae-forgotten-export) The symbol "Options_6" needs to be exported by the entry point index.d.ts
     constructor(options: Options_6);
     authenticationType(): string;
+    getRefreshToken(): string;
     // (undocumented)
     protected requiredOptions: string[];
     // (undocumented)
     protected tokenManager: IamTokenManager;
 }
 
 // @public
-export class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "IamRequestOptions_2" needs to be exported by the entry point index.d.ts
-    constructor(options: IamRequestOptions_2);
-    // (undocumented)
-    protected clientId: string;
-    // (undocumented)
-    protected clientSecret: string;
-    getRefreshToken(): string;
-    // (undocumented)
-    protected scope: string;
+export class IamRequestBasedAuthenticator extends IamRequestBasedAuthenticatorImmutable {
     setClientIdAndSecret(clientId: string, clientSecret: string): void;
+    setDisableSslVerification(value: boolean): void;
+    setHeaders(headers: OutgoingHttpHeaders): void;
     setScope(scope: string): void;
-    // (undocumented)
-    protected tokenManager: IamRequestBasedTokenManager;
 }
 
 // @public
 export class IamRequestBasedTokenManager extends JwtTokenManager {
     constructor(options: IamRequestOptions);
     // (undocumented)
+    protected clientId: string;
+    // (undocumented)
+    protected clientSecret: string;
+    // (undocumented)
     protected formData: any;
-    getRefreshToken(): string;
     protected isTokenExpired(): boolean;
     // (undocumented)
     protected refreshToken: string;
     protected requestToken(): Promise<any>;
     protected saveTokenInfo(tokenResponse: any): void;
+    // (undocumented)
+    protected scope: string;
     setClientIdAndSecret(clientId: string, clientSecret: string): void;
     setScope(scope: string): void;
 }
@@ -301,6 +307,7 @@ export interface IamRequestOptions extends JwtTokenManagerOptions {
 export class IamTokenManager extends IamRequestBasedTokenManager {
     // Warning: (ae-forgotten-export) The symbol "Options_5" needs to be exported by the entry point index.d.ts
     constructor(options: Options_5);
+    getRefreshToken(): string;
     // (undocumented)
     protected requiredOptions: string[];
 }
@@ -440,21 +447,12 @@ export type TokenManagerOptions = {
     [propName: string]: any;
 };
 
+// Warning: (ae-forgotten-export) The symbol "TokenRequestBasedAuthenticatorImmutable" needs to be exported by the entry point index.d.ts
+//
 // @public
-export class TokenRequestBasedAuthenticator extends Authenticator {
-    // Warning: (ae-forgotten-export) The symbol "BaseOptions" needs to be exported by the entry point index.d.ts
-    constructor(options: BaseOptions);
-    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
-    // (undocumented)
-    protected disableSslVerification: boolean;
-    // (undocumented)
-    protected headers: OutgoingHttpHeaders;
+export class TokenRequestBasedAuthenticator extends TokenRequestBasedAuthenticatorImmutable {
     setDisableSslVerification(value: boolean): void;
     setHeaders(headers: OutgoingHttpHeaders): void;
-    // (undocumented)
-    protected tokenManager: JwtTokenManager;
-    // (undocumented)
-    protected url: string;
 }
 
 // @public