ibm-cloud-sdk-core 5.0.0 → 5.0.2

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

@@ -1,87 +0,0 @@
-<!-- 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

@@ -1,55 +0,0 @@
-<!-- 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

@@ -1,55 +0,0 @@
-<!-- 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

@@ -1,19 +0,0 @@
-<!-- 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

@@ -1,69 +0,0 @@
-<!-- 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

@@ -1,73 +0,0 @@
-<!-- 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

@@ -1,59 +0,0 @@
-<!-- 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

@@ -1,71 +0,0 @@
-<!-- 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.iamauthenticator._constructor_.md

@@ -1,54 +0,0 @@
-<!-- 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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.iamauthenticator._constructor_.md)
-
-## IamAuthenticator.(constructor)
-
-Create a new IamAuthenticator 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: - url: (optional) the endpoint URL for the token service - apikey: (required) the IAM api key - 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.iamauthenticator.authenticationtype.md

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

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

@@ -1,149 +0,0 @@
-<!-- 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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md)
-
-## IamAuthenticator class
-
-The IamAuthenticator will use the user-supplied `apikey` value 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 "clientId" and "clientSecret" 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 &lt;<!-- -->bearer-token<!-- -->&gt;
-
-**Signature:**
-
-```typescript
-export declare class IamAuthenticator extends IamRequestBasedAuthenticator 
-```
-**Extends:** [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md)
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(options)](./ibm-cloud-sdk-core.iamauthenticator._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Create a new IamAuthenticator 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>
-
-[requiredOptions](./ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[tokenManager](./ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-[IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.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.iamauthenticator.authenticationtype.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Returns the authenticator's type ('iam').
-
-
-</td></tr>
-</tbody></table>