ibm-cloud-sdk-core 4.1.5 → 4.2.1

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

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.38.3",
+    "toolVersion": "7.39.0",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -569,6 +569,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_MCSP:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "static AUTHTYPE_MCSP: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "AUTHTYPE_MCSP",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": true,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_NOAUTH:member",
@@ -5415,6 +5445,294 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Class",
+          "canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator:class",
+          "docComment": "/**\n * The McspAuthenticator uses an apikey to obtain an access token from the MCSP token server. When the access token expires, a new access token is obtained from the token server. The access token will be added to outbound requests via the Authorization header of the form: \"Authorization: Bearer <access-token>\"\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class McspAuthenticator extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "TokenRequestBasedAuthenticator",
+              "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator:class"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "dist/es/auth/authenticators/mcsp-authenticator.d.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "McspAuthenticator",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Constructor",
+              "canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator:constructor(1)",
+              "docComment": "/**\n * Create a new McspAuthenticator 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",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "constructor(options: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Options",
+                  "canonicalReference": "ibm-cloud-sdk-core!~Options_12:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ");"
+                }
+              ],
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "options",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ]
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator#authenticationType:member(1)",
+              "docComment": "/**\n * Returns the authenticator's type ('cp4d').\n *\n * @returns a string that indicates the authenticator's type\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "authenticationType(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "authenticationType"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator#requiredOptions:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected requiredOptions: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "requiredOptions",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": true,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator#tokenManager:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected tokenManager: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "McspTokenManager",
+                  "canonicalReference": "ibm-cloud-sdk-core!McspTokenManager:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "tokenManager",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": true,
+              "isAbstract": false
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
+        {
+          "kind": "Class",
+          "canonicalReference": "ibm-cloud-sdk-core!McspTokenManager:class",
+          "docComment": "/**\n * Token Manager for Multi-Cloud Saas Platform (MCSP) authenticator.\n *\n * The Token Manager will invoke the MCSP token service's 'POST /siusermgr/api/1.0/apikeys/token' operation to obtain an MCSP access token for a user-supplied apikey.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class McspTokenManager extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "JwtTokenManager",
+              "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:class"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "dist/es/auth/token-managers/mcsp-token-manager.d.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "McspTokenManager",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Constructor",
+              "canonicalReference": "ibm-cloud-sdk-core!McspTokenManager:constructor(1)",
+              "docComment": "/**\n * Create a new McspTokenManager instance.\n *\n * @param options - Configuration options This should be an object containing these fields: - url: (required) the base endpoint URL for the MCSP token service - apikey: (required) the API key used to obtain the MCSP access token. - 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",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "constructor(options: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Options",
+                  "canonicalReference": "ibm-cloud-sdk-core!~Options_11:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ");"
+                }
+              ],
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "options",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ]
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "ibm-cloud-sdk-core!McspTokenManager#requestToken:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected requestToken(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<any>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "releaseTag": "Public",
+              "isProtected": true,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "requestToken"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "ibm-cloud-sdk-core!McspTokenManager#requiredOptions:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected requiredOptions: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "requiredOptions",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": true,
+              "isAbstract": false
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
         {
           "kind": "Class",
           "canonicalReference": "ibm-cloud-sdk-core!NoAuthAuthenticator:class",

package/temp/ibm-cloud-sdk-core.api.md

@@ -34,6 +34,8 @@ export class Authenticator implements AuthenticatorInterface {
     // (undocumented)
     static AUTHTYPE_IAM: string;
     // (undocumented)
+    static AUTHTYPE_MCSP: string;
+    // (undocumented)
     static AUTHTYPE_NOAUTH: string;
     // (undocumented)
     static AUTHTYPE_UNKNOWN: string;
@@ -329,6 +331,27 @@ export class JwtTokenManager extends TokenManager {
 // @public
 export type JwtTokenManagerOptions = TokenManagerOptions;
 
+// @public
+export class McspAuthenticator extends TokenRequestBasedAuthenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options_12" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_12);
+    authenticationType(): string;
+    // (undocumented)
+    protected requiredOptions: string[];
+    // (undocumented)
+    protected tokenManager: McspTokenManager;
+}
+
+// @public
+export class McspTokenManager extends JwtTokenManager {
+    // Warning: (ae-forgotten-export) The symbol "Options_11" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_11);
+    // (undocumented)
+    protected requestToken(): Promise<any>;
+    // (undocumented)
+    protected requiredOptions: string[];
+}
+
 // @public
 export class NoAuthAuthenticator extends Authenticator {
     // (undocumented)