npm - ibm-cloud-sdk-core - Versions diffs - 4.0.7 → 4.0.9 - Mend

ibm-cloud-sdk-core 4.0.7 → 4.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (266) hide show

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

@@ -6,7 +6,7 @@
 This function retrieves the content type of the input.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer): Promise<string>;
@@ -18,7 +18,7 @@ export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer
 |  --- | --- | --- |
 |  inputData | NodeJS.ReadableStream \| Buffer | The data to retrieve content type for. |
-<b>Returns:</b>
+**Returns:**
 Promise&lt;string&gt;

package/build/docs/ibm-cloud-sdk-core.getcurrenttime.md CHANGED Viewed

@@ -6,12 +6,12 @@
 Gets the current time.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getCurrentTime(): number;
 ```
-<b>Returns:</b>
+**Returns:**
 number

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

@@ -6,7 +6,7 @@
 Returns the first match from formats that is key the params map otherwise null
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getFormat(params: {
@@ -21,7 +21,7 @@ export declare function getFormat(params: {
 |  params | { \[key: string\]: any; } | The parameters. |
 |  formats | string\[\] |  |
-<b>Returns:</b>
+**Returns:**
 string

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

@@ -6,7 +6,7 @@
 Validates that all required params are provided
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getMissingParams(params: {
@@ -21,7 +21,7 @@ export declare function getMissingParams(params: {
 |  params | { \[key: string\]: any; } | the method parameters. |
 |  requires | string\[\] | the required parameter names. |
-<b>Returns:</b>
+**Returns:**
 null \| Error

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

@@ -10,7 +10,7 @@ The logger will be an instance of the `debug` package and utilizes its support f
 Additionally, the logger will be turned on automatically if the "NODE\_DEBUG" environment variable is set to "axios".
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getNewLogger(moduleName: string): SDKLogger;
@@ -22,7 +22,7 @@ export declare function getNewLogger(moduleName: string): SDKLogger;
 |  --- | --- | --- |
 |  moduleName | string | the namespace for the logger. The name will appear in the logs and it will be the name used for configuring the log level. |
-<b>Returns:</b>
+**Returns:**
 [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md)

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

@@ -6,7 +6,7 @@
 Return a query parameter value from a URL
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getQueryParam(urlStr: string, param: string): string;
@@ -19,7 +19,7 @@ export declare function getQueryParam(urlStr: string, param: string): string;
 |  urlStr | string | the url string. |
 |  param | string | the name of the query parameter whose value should be returned |
-<b>Returns:</b>
+**Returns:**
 string

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

@@ -6,7 +6,7 @@
 Create a new IamAuthenticator instance.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 constructor(options: Options);

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

@@ -6,12 +6,12 @@
 Returns the authenticator's type ('iam').
-<b>Signature:</b>
+**Signature:**
 ```typescript
 authenticationType(): string;
 ```
-<b>Returns:</b>
+**Returns:**
 string

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

@@ -10,12 +10,12 @@ The bearer token will be sent as an Authorization header in the form:
 Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class IamAuthenticator extends IamRequestBasedAuthenticator
 ```
-<b>Extends:</b> [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md)
+**Extends:** [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md)
 ## Constructors

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

@@ -4,7 +4,7 @@
 ## IamAuthenticator.requiredOptions property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected requiredOptions: string[];

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

@@ -4,7 +4,7 @@
 ## IamAuthenticator.tokenManager property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected tokenManager: IamTokenManager;

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator._constructor_.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Create a new IamRequestBasedAuthenticator instance.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 constructor(options: IamRequestOptions);

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientid.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## IamRequestBasedAuthenticator.clientId property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected clientId: string;

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientsecret.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## IamRequestBasedAuthenticator.clientSecret property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected clientSecret: string;

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.getrefreshtoken.md CHANGED Viewed

@@ -6,12 +6,12 @@
 Return the most recently stored refresh token.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 getRefreshToken(): string;
 ```
-<b>Returns:</b>
+**Returns:**
 string

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.md CHANGED Viewed

@@ -6,12 +6,12 @@
 The IamRequestBasedAuthenticator provides shared configuration and functionality for authenticators that interact with the IAM token service. This authenticator is not meant for use on its own.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator
 ```
-<b>Extends:</b> [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
+**Extends:** [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
 ## Constructors

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.scope.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## IamRequestBasedAuthenticator.scope property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected scope: string;

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Setter for the mutually inclusive "clientId" and the "clientSecret" fields.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setClientIdAndSecret(clientId: string, clientSecret: string): void;
@@ -19,7 +19,7 @@ setClientIdAndSecret(clientId: string, clientSecret: string): void;
 |  clientId | string | the "clientId" value used to form a Basic Authorization header for IAM token requests |
 |  clientSecret | string | the "clientSecret" value used to form a Basic Authorization header for IAM token requests |
-<b>Returns:</b>
+**Returns:**
 void

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Setter for the "scope" parameter to use when fetching the bearer token from the IAM token server.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setScope(scope: string): void;
@@ -18,7 +18,7 @@ setScope(scope: string): void;
 |  --- | --- | --- |
 |  scope | string | (optional) a space-separated string that specifies one or more scopes to be associated with IAM token requests |
-<b>Returns:</b>
+**Returns:**
 void

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.tokenmanager.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## IamRequestBasedAuthenticator.tokenManager property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected tokenManager: IamRequestBasedTokenManager;

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Create a new IamRequestBasedTokenManager instance.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 constructor(options: IamRequestOptions);

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## IamRequestBasedTokenManager.formData property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected formData: any;

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md CHANGED Viewed

@@ -6,12 +6,12 @@
 Returns the most recently stored refresh token.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 getRefreshToken(): string;
 ```
-<b>Returns:</b>
+**Returns:**
 string

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md CHANGED Viewed

@@ -6,12 +6,12 @@
 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.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class IamRequestBasedTokenManager extends JwtTokenManager
 ```
-<b>Extends:</b> [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
+**Extends:** [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
 ## Constructors

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## IamRequestBasedTokenManager.refreshToken property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected refreshToken: string;

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md CHANGED Viewed

@@ -6,12 +6,12 @@
 Request an IAM access token using an API key.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected requestToken(): Promise<any>;
 ```
-<b>Returns:</b>
+**Returns:**
 Promise&lt;any&gt;

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Extend this method from the parent class to extract the refresh token from the request and save it.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected saveTokenInfo(tokenResponse: any): void;
@@ -18,7 +18,7 @@ protected saveTokenInfo(tokenResponse: any): void;
 |  --- | --- | --- |
 |  tokenResponse | any | the response object from JWT service request |
-<b>Returns:</b>
+**Returns:**
 void

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Sets the IAM "clientId" and "clientSecret" values. These values are used to compute the Authorization header used when retrieving the IAM access token. If these values are not set, no Authorization header will be set on the request (it is not required).
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setClientIdAndSecret(clientId: string, clientSecret: string): void;
@@ -19,7 +19,7 @@ setClientIdAndSecret(clientId: string, clientSecret: string): void;
 |  clientId | string | the client id. |
 |  clientSecret | string | the client secret. |
-<b>Returns:</b>
+**Returns:**
 void

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Sets the IAM "scope" value. This value is sent as the "scope" form parameter within the request sent to the IAM token service.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setScope(scope: string): void;
@@ -18,7 +18,7 @@ setScope(scope: string): void;
 |  --- | --- | --- |
 |  scope | string | a space-separated string that contains one or more scope names |
-<b>Returns:</b>
+**Returns:**
 void

package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientid.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## IamRequestOptions.clientId property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 clientId?: string;

package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## IamRequestOptions.clientSecret property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 clientSecret?: string;

package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.md CHANGED Viewed

@@ -6,18 +6,18 @@
 Configuration options for IAM token retrieval.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export interface IamRequestOptions extends JwtTokenManagerOptions
 ```
-<b>Extends:</b> [JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md)
+**Extends:** [JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md)
 ## Properties
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [clientId?](./ibm-cloud-sdk-core.iamrequestoptions.clientid.md) |  | string | <i>(Optional)</i> |
-|  [clientSecret?](./ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md) |  | string | <i>(Optional)</i> |
-|  [scope?](./ibm-cloud-sdk-core.iamrequestoptions.scope.md) |  | string | <i>(Optional)</i> |
+|  [clientId?](./ibm-cloud-sdk-core.iamrequestoptions.clientid.md) |  | string | _(Optional)_ |
+|  [clientSecret?](./ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md) |  | string | _(Optional)_ |
+|  [scope?](./ibm-cloud-sdk-core.iamrequestoptions.scope.md) |  | string | _(Optional)_ |

package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.scope.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## IamRequestOptions.scope property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 scope?: string;

package/build/docs/ibm-cloud-sdk-core.iamtokenmanager._constructor_.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Create a new IamTokenManager instance.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 constructor(options: Options);

package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.md CHANGED Viewed

@@ -6,12 +6,12 @@
 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 "clientId" and "clientSecret" pair.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class IamTokenManager extends IamRequestBasedTokenManager
 ```
-<b>Extends:</b> [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md)
+**Extends:** [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md)
 ## Constructors

package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.requiredoptions.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## IamTokenManager.requiredOptions property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected requiredOptions: string[];

package/build/docs/ibm-cloud-sdk-core.isemptyobject.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## isEmptyObject() function
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function isEmptyObject(obj: any): boolean;
@@ -16,7 +16,7 @@ export declare function isEmptyObject(obj: any): boolean;
 |  --- | --- | --- |
 |  obj | any |  |
-<b>Returns:</b>
+**Returns:**
 boolean

package/build/docs/ibm-cloud-sdk-core.isfiledata.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## isFileData() function
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function isFileData(obj: any): obj is NodeJS.ReadableStream | Buffer;
@@ -16,7 +16,7 @@ export declare function isFileData(obj: any): obj is NodeJS.ReadableStream | Buf
 |  --- | --- | --- |
 |  obj | any |  |
-<b>Returns:</b>
+**Returns:**
 obj is NodeJS.ReadableStream \| Buffer

package/build/docs/ibm-cloud-sdk-core.isfilewithmetadata.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## isFileWithMetadata() function
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function isFileWithMetadata(obj: any): obj is FileWithMetadata;
@@ -16,7 +16,7 @@ export declare function isFileWithMetadata(obj: any): obj is FileWithMetadata;
 |  --- | --- | --- |
 |  obj | any |  |
-<b>Returns:</b>
+**Returns:**
 obj is [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md)

package/build/docs/ibm-cloud-sdk-core.ishtml.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Return true if 'text' is html
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function isHTML(text: string): boolean;
@@ -18,7 +18,7 @@ export declare function isHTML(text: string): boolean;
 |  --- | --- | --- |
 |  text | string | The 'text' to analyze |
-<b>Returns:</b>
+**Returns:**
 boolean

package/build/docs/ibm-cloud-sdk-core.isjsonmimetype.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Returns true if and only if "mimeType" is a "JSON-like" mime type (e.g. "application/json; charset=utf-8").
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function isJsonMimeType(mimeType: string): boolean;
@@ -18,7 +18,7 @@ export declare function isJsonMimeType(mimeType: string): boolean;
 |  --- | --- | --- |
 |  mimeType | string | the mimeType string |
-<b>Returns:</b>
+**Returns:**
 boolean

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager._constructor_.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Create a new JwtTokenManager instance.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 constructor(options: JwtTokenManagerOptions);

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

@@ -6,12 +6,12 @@
 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 `requestToken()` to retrieve the bearer token from intended sources.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class JwtTokenManager extends TokenManager
 ```
-<b>Extends:</b> [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md)
+**Extends:** [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md)
 ## Constructors

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md CHANGED Viewed

@@ -6,12 +6,12 @@
 Request a JWT using an API key.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected requestToken(): Promise<any>;
 ```
-<b>Returns:</b>
+**Returns:**
 Promise&lt;any&gt;