ibm-cloud-sdk-core 5.1.0 → 5.1.2

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

@@ -0,0 +1,87 @@
+<!-- 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; [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md)
+
+## FileWithMetadata interface
+
+**Signature:**
+
+```typescript
+export interface FileWithMetadata 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[contentType](./ibm-cloud-sdk-core.filewithmetadata.contenttype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[data](./ibm-cloud-sdk-core.filewithmetadata.data.md)
+
+
+</td><td>
+
+
+</td><td>
+
+NodeJS.ReadableStream \| Buffer
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[filename](./ibm-cloud-sdk-core.filewithmetadata.filename.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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

@@ -0,0 +1,55 @@
+<!-- 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; [getAuthenticatorFromEnvironment](./ibm-cloud-sdk-core.getauthenticatorfromenvironment.md)
+
+## getAuthenticatorFromEnvironment() function
+
+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)
+
+**Signature:**
+
+```typescript
+export declare function getAuthenticatorFromEnvironment(serviceName: string): Authenticator;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+serviceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the service name prefix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+

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

@@ -0,0 +1,55 @@
+<!-- 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; [getContentType](./ibm-cloud-sdk-core.getcontenttype.md)
+
+## getContentType() function
+
+This function retrieves the content type of the input.
+
+**Signature:**
+
+```typescript
+export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer): Promise<string>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+inputData
+
+
+</td><td>
+
+NodeJS.ReadableStream \| Buffer
+
+
+</td><td>
+
+The data to retrieve content type for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;string&gt;
+
+the content type of the input.
+

package/build/docs/ibm-cloud-sdk-core.getcurrenttime.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; [getCurrentTime](./ibm-cloud-sdk-core.getcurrenttime.md)
+
+## getCurrentTime() function
+
+Gets the current time.
+
+**Signature:**
+
+```typescript
+export declare function getCurrentTime(): number;
+```
+**Returns:**
+
+number
+
+the current time in seconds.
+

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

@@ -0,0 +1,69 @@
+<!-- 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; [getFormat](./ibm-cloud-sdk-core.getformat.md)
+
+## getFormat() function
+
+Returns the first match from formats that is key the params map otherwise null
+
+**Signature:**
+
+```typescript
+export declare function getFormat(params: {
+    [key: string]: any;
+}, formats: string[]): string;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+params
+
+
+</td><td>
+
+{ \[key: string\]: any; }
+
+
+</td><td>
+
+The parameters.
+
+
+</td></tr>
+<tr><td>
+
+formats
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+string
+

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

@@ -0,0 +1,73 @@
+<!-- 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; [getMissingParams](./ibm-cloud-sdk-core.getmissingparams.md)
+
+## getMissingParams() function
+
+Validates that all required params are provided
+
+**Signature:**
+
+```typescript
+export declare function getMissingParams(params: {
+    [key: string]: any;
+}, requires: string[]): null | Error;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+params
+
+
+</td><td>
+
+{ \[key: string\]: any; }
+
+
+</td><td>
+
+the method parameters.
+
+
+</td></tr>
+<tr><td>
+
+requires
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+the required parameter names.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+null \| Error
+
+null if no errors found, otherwise an Error instance
+

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

@@ -0,0 +1,59 @@
+<!-- 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; [getNewLogger](./ibm-cloud-sdk-core.getnewlogger.md)
+
+## getNewLogger() function
+
+Return a new logger, formatted with a particular name. The logging functions, in order of increasing verbosity, are: `error`<!-- -->, `warn`<!-- -->, `info`<!-- -->, `verbose`<!-- -->, and `debug`<!-- -->.
+
+The logger will be an instance of the `debug` 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".
+
+**Signature:**
+
+```typescript
+export declare function getNewLogger(moduleName: string): SDKLogger;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+moduleName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the namespace for the logger. The name will appear in the logs and it will be the name used for configuring the log level.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[SDKLogger](./ibm-cloud-sdk-core.sdklogger.md)
+
+the new logger
+

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

@@ -0,0 +1,71 @@
+<!-- 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; [getQueryParam](./ibm-cloud-sdk-core.getqueryparam.md)
+
+## getQueryParam() function
+
+Return a query parameter value from a URL
+
+**Signature:**
+
+```typescript
+export declare function getQueryParam(urlStr: string, param: string): string;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+urlStr
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the url string.
+
+
+</td></tr>
+<tr><td>
+
+param
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the name of the query parameter whose value should be returned
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+string
+
+the value of the "param" query parameter
+

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

@@ -0,0 +1,54 @@
+<!-- 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; [IamAssumeAuthenticator](./ibm-cloud-sdk-core.iamassumeauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.iamassumeauthenticator._constructor_.md)
+
+## IamAssumeAuthenticator.(constructor)
+
+Create a new IamAssumeAuthenticator instance.
+
+**Signature:**
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+Options
+
+
+</td><td>
+
+Configuration options for IAM authentication. This should be an object containing these fields: - apikey: (required) the IAM api key for initial token request - iamProfileId: (optional) the ID of the trusted profile to use - iamProfileCrn: (optional) the CRN of the trusted profile to use - iamProfileName: (optional) the name of the trusted profile to use (must be specified with iamAccountId) - iamAccountId: (optional) the ID of the account the trusted profile is in (must be specified with iamProfileName) - url: (optional) the endpoint URL for the token service - 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 - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+
+
+</td></tr>
+</tbody></table>
+
+## Exceptions
+
+Error: the configuration options are not valid.
+

package/build/docs/ibm-cloud-sdk-core.iamassumeauthenticator.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; [IamAssumeAuthenticator](./ibm-cloud-sdk-core.iamassumeauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.iamassumeauthenticator.authenticationtype.md)
+
+## IamAssumeAuthenticator.authenticationType() method
+
+Returns the authenticator's type ('iamAssume').
+
+**Signature:**
+
+```typescript
+authenticationType(): string;
+```
+**Returns:**
+
+string
+
+a string that indicates the authenticator's type
+

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

@@ -0,0 +1,130 @@
+<!-- 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; [IamAssumeAuthenticator](./ibm-cloud-sdk-core.iamassumeauthenticator.md)
+
+## IamAssumeAuthenticator class
+
+The IamAssumeAuthenticator obtains an IAM access token using the IAM "get-token" operation's "assume" grant type. The authenticator obtains an initial IAM access token from a user-supplied apikey, then exchanges this initial IAM access token for another IAM access token that has "assumed the identity" of the specified trusted profile.
+
+The bearer token will be sent as an Authorization header in the form:
+
+Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
+
+**Signature:**
+
+```typescript
+export declare class IamAssumeAuthenticator extends IamRequestBasedAuthenticatorImmutable 
+```
+**Extends:** IamRequestBasedAuthenticatorImmutable
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.iamassumeauthenticator._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new IamAssumeAuthenticator instance.
+
+
+</td></tr>
+</tbody></table>
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[tokenManager](./ibm-cloud-sdk-core.iamassumeauthenticator.tokenmanager.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+[IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticationType()](./ibm-cloud-sdk-core.iamassumeauthenticator.authenticationtype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Returns the authenticator's type ('iamAssume').
+
+
+</td></tr>
+</tbody></table>

package/build/docs/ibm-cloud-sdk-core.iamassumeauthenticator.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; [IamAssumeAuthenticator](./ibm-cloud-sdk-core.iamassumeauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.iamassumeauthenticator.tokenmanager.md)
+
+## IamAssumeAuthenticator.tokenManager property
+
+**Signature:**
+
+```typescript
+protected tokenManager: IamAssumeTokenManager;
+```