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

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md

@@ -0,0 +1,26 @@
+<!-- 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; [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) &gt; [saveTokenInfo](./ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md)
+
+## JwtTokenManager.saveTokenInfo() method
+
+Save the JWT service response and the calculated expiration time to the object's state.
+
+<b>Signature:</b>
+
+```typescript
+protected saveTokenInfo(tokenResponse: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  tokenResponse | any | Response object from JWT service request  |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.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; [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) &gt; [tokenInfo](./ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.md)
+
+## JwtTokenManager.tokenInfo property
+
+<b>Signature:</b>
+
+```typescript
+protected tokenInfo: any;
+```

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokenname.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; [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) &gt; [tokenName](./ibm-cloud-sdk-core.jwttokenmanager.tokenname.md)
+
+## JwtTokenManager.tokenName property
+
+<b>Signature:</b>
+
+```typescript
+protected tokenName: string;
+```

package/build/docs/ibm-cloud-sdk-core.jwttokenmanageroptions.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; [JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md)
+
+## JwtTokenManagerOptions type
+
+Configuration options for JWT token retrieval.
+
+<b>Signature:</b>
+
+```typescript
+export type JwtTokenManagerOptions = TokenManagerOptions;
+```
+<b>References:</b> [TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.md)
+

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

@@ -0,0 +1,96 @@
+<!-- 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)
+
+## ibm-cloud-sdk-core package
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [Authenticator](./ibm-cloud-sdk-core.authenticator.md) | Base Authenticator class for other Authenticators to extend. Not intended to be used as a stand-alone authenticator. |
+|  [BaseService](./ibm-cloud-sdk-core.baseservice.md) | Common functionality shared by generated service classes.<!-- -->The base service authenticates requests via its authenticator, and sends them to the service endpoint. |
+|  [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md) | The BasicAuthenticator is used to add basic authentication information to requests.<!-- -->Basic Authorization will be sent as an Authorization header in the form:<!-- -->Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt; |
+|  [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md) | The BearerTokenAuthenticator will set a user-provided bearer token in requests.<!-- -->The bearer token will be sent as an Authorization header in the form:<!-- -->Authorization: Bearer <bearer-token> |
+|  [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) | 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.<!-- -->The bearer token will be sent as an Authorization header in the form:<!-- -->Authorization: Bearer <bearer-token> |
+|  [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) | 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.<!-- -->The bearer token will be sent as an Authorization header in the form:<!-- -->Authorization: Bearer <bearer-token> |
+|  [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) | The ContainerTokenManager retrieves a compute resource token from a file on the container. This token is used to perform the necessary interactions with the IAM token service to obtain and store a suitable bearer (access) token. |
+|  [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) | Token Manager of CloudPak for data.<!-- -->The Token Manager performs basic auth with a username and password to acquire CP4D tokens. |
+|  [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) | The \[\[IamAuthenticator\]\] will use the user-supplied <code>apikey</code> 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 <code>clientId</code> and<code>clientSecret</code> pair can be used to influence rate-limiting for requests to the IAM token server.<!-- -->The bearer token will be sent as an Authorization header in the form:<!-- -->Authorization: Bearer <bearer-token> |
+|  [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) | 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. |
+|  [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) | The IamRequestBasedTokenManager class contains code relevant to any token manager that interacts with the IAM service to manage a token. It stores information relevant to all IAM requests, such as the client ID and secret, and performs the token request with a set of request options common to any IAM token management scheme. It is intended that this class be extended with specific implementations. |
+|  [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md) | 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 <code>clientId</code> and <code>clientSecret</code> pair. |
+|  [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) | A class for shared functionality for parsing, storing, and requesting JWT tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement <code>requestToken()</code> to retrieve the bearer token from intended sources. |
+|  [NoAuthAuthenticator](./ibm-cloud-sdk-core.noauthauthenticator.md) | NoAuthAuthenticator is a placeholder authenticator implementation which performs no authentication of outgoing REST API requests. It might be useful during development and testing. |
+|  [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) | 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 <code>requestToken()</code> to retrieve the token from intended sources and <code>saveTokenInfo(tokenResponse)</code> to parse and save token information from the response. |
+|  [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) | 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.<!-- -->The tokens will be added as an Authorization headers in the form:<!-- -->Authorization: Bearer <bearer-token> |
+|  [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) | 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).<!-- -->The resulting IAM access token is then added to outbound requests in an Authorization header<!-- -->Authorization: Bearer <access-token> |
+|  [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) | Token Manager for VPC Instance Authentication. |
+
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [atLeastOne(a, b)](./ibm-cloud-sdk-core.atleastone.md) | Check for at least one of two elements being defined. Returns true if a or b is defined. Returns false if both are undefined. |
+|  [atMostOne(a, b)](./ibm-cloud-sdk-core.atmostone.md) | Verify that both properties are not specified. Returns true if only a, only b, or neither is defined. Returns false if both are defined. |
+|  [buildRequestFileObject(fileParam)](./ibm-cloud-sdk-core.buildrequestfileobject.md) | This function builds a <code>form-data</code> object for each file parameter. |
+|  [checkCredentials(obj, credsToCheck)](./ibm-cloud-sdk-core.checkcredentials.md) | Checks credentials for common user mistakes of copying {<!-- -->, }<!-- -->, or " characters from the documentation |
+|  [computeBasicAuthHeader(username, password)](./ibm-cloud-sdk-core.computebasicauthheader.md) | Compute and return a Basic Authorization header from a username and password. |
+|  [constructFilepath(filepath)](./ibm-cloud-sdk-core.constructfilepath.md) |  |
+|  [constructServiceUrl(parameterizedUrl, defaultUrlVariables, providedUrlVariables)](./ibm-cloud-sdk-core.constructserviceurl.md) | Constructs a service URL by formatting a parameterized URL. |
+|  [fileExistsAtPath(filepath)](./ibm-cloud-sdk-core.fileexistsatpath.md) |  |
+|  [getAuthenticatorFromEnvironment(serviceName)](./ibm-cloud-sdk-core.getauthenticatorfromenvironment.md) | Look for external configuration of authenticator.<!-- -->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) |
+|  [getContentType(inputData)](./ibm-cloud-sdk-core.getcontenttype.md) | This function retrieves the content type of the input. |
+|  [getCurrentTime()](./ibm-cloud-sdk-core.getcurrenttime.md) | Get the current time |
+|  [getFormat(params, formats)](./ibm-cloud-sdk-core.getformat.md) | Returns the first match from formats that is key the params map otherwise null |
+|  [getMissingParams(params, requires)](./ibm-cloud-sdk-core.getmissingparams.md) | Validates that all required params are provided |
+|  [getNewLogger(moduleName)](./ibm-cloud-sdk-core.getnewlogger.md) | Return a new logger, formatted with a particular name. The logging functions, in order of increasing verbosity, are: <code>error</code>, <code>warn</code>, <code>info</code>, <code>verbose</code>, and <code>debug</code>.<!-- -->The logger will be an instance of the <code>debug</code> package and utilizes its support for configuration with environment variables.<!-- -->Additionally, the logger will be turned on automatically if the "NODE\_DEBUG" environment variable is set to "axios". |
+|  [getQueryParam(urlStr, param)](./ibm-cloud-sdk-core.getqueryparam.md) | Return a query parameter value from a URL |
+|  [isEmptyObject(obj)](./ibm-cloud-sdk-core.isemptyobject.md) |  |
+|  [isFileData(obj)](./ibm-cloud-sdk-core.isfiledata.md) |  |
+|  [isFileWithMetadata(obj)](./ibm-cloud-sdk-core.isfilewithmetadata.md) |  |
+|  [isHTML(text)](./ibm-cloud-sdk-core.ishtml.md) | Return true if 'text' is html |
+|  [onlyOne(a, b)](./ibm-cloud-sdk-core.onlyone.md) | 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. |
+|  [readCredentialsFile()](./ibm-cloud-sdk-core.readcredentialsfile.md) | Return a config object based on a credentials file. Credentials files can be specified filepath via the environment variable: <code>IBM_CREDENTIALS_FILE</code>. |
+|  [readCrTokenFile(filepath)](./ibm-cloud-sdk-core.readcrtokenfile.md) |  |
+|  [readExternalSources(serviceName)](./ibm-cloud-sdk-core.readexternalsources.md) | 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.<!-- -->Only one source will be used at a time. |
+|  [removeSuffix(str, suffix)](./ibm-cloud-sdk-core.removesuffix.md) | Remove a given suffix if it exists. |
+|  [streamToPromise(stream)](./ibm-cloud-sdk-core.streamtopromise.md) | 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 |
+|  [stripTrailingSlash(url)](./ibm-cloud-sdk-core.striptrailingslash.md) |  |
+|  [toLowerKeys(obj)](./ibm-cloud-sdk-core.tolowerkeys.md) | This function converts an object's keys to lower case. note: does not convert nested keys |
+|  [validateInput(options, requiredOptions)](./ibm-cloud-sdk-core.validateinput.md) |  |
+|  [validateParams(params, requiredParams, allParams)](./ibm-cloud-sdk-core.validateparams.md) | 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. |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) | This interface defines the common methods associated with an Authenticator implementation. |
+|  [FileObject](./ibm-cloud-sdk-core.fileobject.md) | (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. You may obtain a copy of the License at<!-- -->http://www.apache.org/licenses/LICENSE-2.0<!-- -->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. |
+|  [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) |  |
+|  [FileStream](./ibm-cloud-sdk-core.filestream.md) |  |
+|  [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) |  |
+|  [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) | Configuration options for IAM token retrieval. |
+|  [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) |  |
+|  [UserOptions](./ibm-cloud-sdk-core.useroptions.md) | Configuration values for a service. |
+
+## Namespaces
+
+|  Namespace | Description |
+|  --- | --- |
+|  [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) |  |
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [contentType](./ibm-cloud-sdk-core.contenttype.md) |  |
+|  [qs](./ibm-cloud-sdk-core.qs.md) | (C) Copyright IBM Corp. 2019, 2021.<!-- -->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<!-- -->http://www.apache.org/licenses/LICENSE-2.0<!-- -->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. |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md) | Configuration options for JWT token retrieval. |
+|  [TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.md) | Configuration options for token retrieval. |
+

package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticate.md

@@ -0,0 +1,22 @@
+<!-- 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; [NoAuthAuthenticator](./ibm-cloud-sdk-core.noauthauthenticator.md) &gt; [authenticate](./ibm-cloud-sdk-core.noauthauthenticator.authenticate.md)
+
+## NoAuthAuthenticator.authenticate() method
+
+<b>Signature:</b>
+
+```typescript
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  requestOptions | AuthenticateOptions |  |
+
+<b>Returns:</b>
+
+Promise&lt;void&gt;
+

package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticationtype.md

@@ -0,0 +1,19 @@
+<!-- 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; [NoAuthAuthenticator](./ibm-cloud-sdk-core.noauthauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.noauthauthenticator.authenticationtype.md)
+
+## NoAuthAuthenticator.authenticationType() method
+
+Returns the authenticator's type ('noauth').
+
+<b>Signature:</b>
+
+```typescript
+authenticationType(): string;
+```
+<b>Returns:</b>
+
+string
+
+a string that indicates the authenticator's type
+

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

@@ -0,0 +1,22 @@
+<!-- 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; [NoAuthAuthenticator](./ibm-cloud-sdk-core.noauthauthenticator.md)
+
+## NoAuthAuthenticator class
+
+NoAuthAuthenticator is a placeholder authenticator implementation which performs no authentication of outgoing REST API requests. It might be useful during development and testing.
+
+<b>Signature:</b>
+
+```typescript
+export declare class NoAuthAuthenticator extends Authenticator 
+```
+<b>Extends:</b> [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.noauthauthenticator.authenticate.md) |  |  |
+|  [authenticationType()](./ibm-cloud-sdk-core.noauthauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('noauth'). |
+

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

@@ -0,0 +1,27 @@
+<!-- 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; [onlyOne](./ibm-cloud-sdk-core.onlyone.md)
+
+## onlyOne() function
+
+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.
+
+<b>Signature:</b>
+
+```typescript
+export declare function onlyOne(a: any, b: any): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  a | any | The first object |
+|  b | any | The second object |
+
+<b>Returns:</b>
+
+boolean
+
+{<!-- -->boolean<!-- -->}
+

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

@@ -0,0 +1,21 @@
+<!-- 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; [qs](./ibm-cloud-sdk-core.qs.md)
+
+## qs variable
+
+(C) Copyright IBM Corp. 2019, 2021.
+
+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
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+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.
+
+<b>Signature:</b>
+
+```typescript
+_default: {
+    stringify: (queryParams: Object) => string;
+}
+```

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

@@ -0,0 +1,17 @@
+<!-- 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; [readCredentialsFile](./ibm-cloud-sdk-core.readcredentialsfile.md)
+
+## readCredentialsFile() function
+
+Return a config object based on a credentials file. Credentials files can be specified filepath via the environment variable: `IBM_CREDENTIALS_FILE`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export declare function readCredentialsFile(): any;
+```
+<b>Returns:</b>
+
+any
+

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

@@ -0,0 +1,22 @@
+<!-- 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; [readCrTokenFile](./ibm-cloud-sdk-core.readcrtokenfile.md)
+
+## readCrTokenFile() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function readCrTokenFile(filepath: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  filepath | string |  |
+
+<b>Returns:</b>
+
+string
+

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

@@ -0,0 +1,26 @@
+<!-- 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; [readExternalSources](./ibm-cloud-sdk-core.readexternalsources.md)
+
+## readExternalSources() function
+
+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.
+
+Only one source will be used at a time.
+
+<b>Signature:</b>
+
+```typescript
+export declare function readExternalSources(serviceName: string): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  serviceName | string | The service name prefix. |
+
+<b>Returns:</b>
+
+any
+

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

@@ -0,0 +1,27 @@
+<!-- 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; [removeSuffix](./ibm-cloud-sdk-core.removesuffix.md)
+
+## removeSuffix() function
+
+Remove a given suffix if it exists.
+
+<b>Signature:</b>
+
+```typescript
+export declare function removeSuffix(str: string, suffix: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  str | string | The base string to operate on |
+|  suffix | string | The suffix to remove, if present |
+
+<b>Returns:</b>
+
+string
+
+{<!-- -->string<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.sdklogger.debug.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; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [debug](./ibm-cloud-sdk-core.sdklogger.debug.md)
+
+## SDKLogger.debug property
+
+<b>Signature:</b>
+
+```typescript
+debug: Debugger;
+```

package/build/docs/ibm-cloud-sdk-core.sdklogger.error.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; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [error](./ibm-cloud-sdk-core.sdklogger.error.md)
+
+## SDKLogger.error property
+
+<b>Signature:</b>
+
+```typescript
+error: Debugger;
+```

package/build/docs/ibm-cloud-sdk-core.sdklogger.info.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; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [info](./ibm-cloud-sdk-core.sdklogger.info.md)
+
+## SDKLogger.info property
+
+<b>Signature:</b>
+
+```typescript
+info: Debugger;
+```

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

@@ -0,0 +1,22 @@
+<!-- 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; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md)
+
+## SDKLogger interface
+
+<b>Signature:</b>
+
+```typescript
+export interface SDKLogger 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [debug](./ibm-cloud-sdk-core.sdklogger.debug.md) | Debugger |  |
+|  [error](./ibm-cloud-sdk-core.sdklogger.error.md) | Debugger |  |
+|  [info](./ibm-cloud-sdk-core.sdklogger.info.md) | Debugger |  |
+|  [verbose](./ibm-cloud-sdk-core.sdklogger.verbose.md) | Debugger |  |
+|  [warn](./ibm-cloud-sdk-core.sdklogger.warn.md) | Debugger |  |
+

package/build/docs/ibm-cloud-sdk-core.sdklogger.verbose.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; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [verbose](./ibm-cloud-sdk-core.sdklogger.verbose.md)
+
+## SDKLogger.verbose property
+
+<b>Signature:</b>
+
+```typescript
+verbose: Debugger;
+```

package/build/docs/ibm-cloud-sdk-core.sdklogger.warn.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; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [warn](./ibm-cloud-sdk-core.sdklogger.warn.md)
+
+## SDKLogger.warn property
+
+<b>Signature:</b>
+
+```typescript
+warn: Debugger;
+```

package/build/docs/ibm-cloud-sdk-core.streamtopromise.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; [streamToPromise](./ibm-cloud-sdk-core.streamtopromise.md)
+
+## streamToPromise() function
+
+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
+
+<b>Signature:</b>
+
+```typescript
+export declare function streamToPromise(stream: Stream): Promise<any>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  stream | Stream | Optional stream param for when not bound to an existing stream instance.  {<!-- -->Promise<!-- -->} |
+
+<b>Returns:</b>
+
+Promise&lt;any&gt;
+

package/build/docs/ibm-cloud-sdk-core.striptrailingslash.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; [stripTrailingSlash](./ibm-cloud-sdk-core.striptrailingslash.md)
+
+## stripTrailingSlash() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function stripTrailingSlash(url: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  url | string | the url string. |
+
+<b>Returns:</b>
+
+string
+
+{<!-- -->string<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager._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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.tokenmanager._constructor_.md)
+
+## TokenManager.(constructor)
+
+Create a new \[\[TokenManager\]\] instance. 
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: TokenManagerOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | [TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.md) | Configuration options. |
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager.accesstoken.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [accessToken](./ibm-cloud-sdk-core.tokenmanager.accesstoken.md)
+
+## TokenManager.accessToken property
+
+<b>Signature:</b>
+
+```typescript
+protected accessToken: string;
+```

package/build/docs/ibm-cloud-sdk-core.tokenmanager.disablesslverification.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [disableSslVerification](./ibm-cloud-sdk-core.tokenmanager.disablesslverification.md)
+
+## TokenManager.disableSslVerification property
+
+<b>Signature:</b>
+
+```typescript
+protected disableSslVerification: boolean;
+```

package/build/docs/ibm-cloud-sdk-core.tokenmanager.expiretime.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [expireTime](./ibm-cloud-sdk-core.tokenmanager.expiretime.md)
+
+## TokenManager.expireTime property
+
+<b>Signature:</b>
+
+```typescript
+protected expireTime: number;
+```

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

@@ -0,0 +1,17 @@
+<!-- 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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [getToken](./ibm-cloud-sdk-core.tokenmanager.gettoken.md)
+
+## TokenManager.getToken() method
+
+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.
+
+<b>Signature:</b>
+
+```typescript
+getToken(): Promise<any>;
+```
+<b>Returns:</b>
+
+Promise&lt;any&gt;
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager.headers.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [headers](./ibm-cloud-sdk-core.tokenmanager.headers.md)
+
+## TokenManager.headers property
+
+<b>Signature:</b>
+
+```typescript
+protected headers: OutgoingHttpHeaders;
+```