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

ibm-cloud-sdk-core 4.0.7 → 4.0.8

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 (265) hide show

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

@@ -6,7 +6,7 @@
 Verifies that both properties are not specified.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function atMostOne(a: any, b: any): boolean;
@@ -19,7 +19,7 @@ export declare function atMostOne(a: any, b: any): boolean;
 |  a | any | The first object |
 |  b | any | The second object |
-<b>Returns:</b>
+**Returns:**
 boolean

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

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

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

@@ -6,7 +6,7 @@
 Augment the request with authentication information.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 authenticate(requestOptions: AuthenticateOptions): Promise<void>;
@@ -18,7 +18,7 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 |  --- | --- | --- |
 |  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
-<b>Returns:</b>
+**Returns:**
 Promise&lt;void&gt;

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

@@ -6,12 +6,12 @@
 Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the &lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 authenticationType(): string;
 ```
-<b>Returns:</b>
+**Returns:**
 string

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

@@ -6,7 +6,7 @@
 Constants that define the various authenticator types.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 static AUTHTYPE_BASIC: string;

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

@@ -4,7 +4,7 @@
 ## Authenticator.AUTHTYPE\_BEARERTOKEN property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 static AUTHTYPE_BEARERTOKEN: string;

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

@@ -4,7 +4,7 @@
 ## Authenticator.AUTHTYPE\_CONTAINER property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 static AUTHTYPE_CONTAINER: string;

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

@@ -4,7 +4,7 @@
 ## Authenticator.AUTHTYPE\_CP4D property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 static AUTHTYPE_CP4D: string;

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

@@ -4,7 +4,7 @@
 ## Authenticator.AUTHTYPE\_IAM property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 static AUTHTYPE_IAM: string;

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

@@ -4,7 +4,7 @@
 ## Authenticator.AUTHTYPE\_NOAUTH property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 static AUTHTYPE_NOAUTH: string;

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

@@ -4,7 +4,7 @@
 ## Authenticator.AUTHTYPE\_UNKNOWN property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 static AUTHTYPE_UNKNOWN: string;

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

@@ -4,7 +4,7 @@
 ## Authenticator.AUTHTYPE\_VPC property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 static AUTHTYPE_VPC: string;

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

@@ -6,12 +6,12 @@
 Base Authenticator class for other Authenticators to extend. Not intended to be used as a stand-alone authenticator.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class Authenticator implements AuthenticatorInterface
 ```
-<b>Implements:</b> [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)
+**Implements:** [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)
 ## Constructors

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

@@ -6,7 +6,7 @@
 Add authentication information to the specified request.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 authenticate(requestOptions: AuthenticateOptions): Promise<void>;
@@ -18,7 +18,7 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 |  --- | --- | --- |
 |  requestOptions | AuthenticateOptions | The request to which authentication information is added (in the headers field). |
-<b>Returns:</b>
+**Returns:**
 Promise&lt;void&gt;

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

@@ -6,12 +6,12 @@
 Returns a string that indicates the authentication type.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 authenticationType(): string;
 ```
-<b>Returns:</b>
+**Returns:**
 string

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

@@ -6,7 +6,7 @@
 This interface defines the common methods associated with an Authenticator implementation.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export interface AuthenticatorInterface

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

@@ -6,7 +6,7 @@
 Configuration values for a service.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 constructor(userOptions: UserOptions);

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

@@ -4,7 +4,7 @@
 ## BaseService.baseOptions property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected baseOptions: BaseServiceOptions;

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

@@ -6,7 +6,7 @@
 Configure the service using external configuration
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected configureService(serviceName: string): void;
@@ -18,7 +18,7 @@ protected configureService(serviceName: string): void;
 |  --- | --- | --- |
 |  serviceName | string | the name of the service. This will be used to read from external configuration. |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 Wrapper around `sendRequest` that enforces the request will be authenticated.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected createRequest(parameters: any): Promise<any>;
@@ -18,7 +18,7 @@ protected createRequest(parameters: any): Promise<any>;
 |  --- | --- | --- |
 |  parameters | any | Service request options passed in by user. This should be an object with the following fields: - options.method: the http method - options.url: the path portion of the URL to be appended to the serviceUrl - options.path: the path parameters to be inserted into the URL - options.qs: the querystring to be included in the URL - options.body: the data to be sent as the request body - options.form: an object containing the key/value pairs for a www-form-urlencoded request. - options.formData: an object containing the contents for a multipart/form-data request The following processing is performed on formData values: - string: no special processing -- the value is sent as is - object: the value is converted to a JSON string before insertion into the form body - NodeJS.ReadableStream\|Buffer\|FileWithMetadata: sent as a file, with any associated metadata - array: each element of the array is sent as a separate form part using any special processing as described above - defaultOptions.serviceUrl: the base URL of the service - defaultOptions.headers: additional HTTP headers to be sent with the request |
-<b>Returns:</b>
+**Returns:**
 Promise&lt;any&gt;

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

@@ -4,7 +4,7 @@
 ## BaseService.DEFAULT\_SERVICE\_NAME property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 static DEFAULT_SERVICE_NAME: string;

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

@@ -4,7 +4,7 @@
 ## BaseService.DEFAULT\_SERVICE\_URL property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 static DEFAULT_SERVICE_URL: string;

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

@@ -6,12 +6,12 @@
 Disables retries.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 disableRetries(): void;
 ```
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 Enable retries for unfulfilled requests.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 enableRetries(retryOptions?: RetryOptions): void;
@@ -16,9 +16,9 @@ enableRetries(retryOptions?: RetryOptions): void;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  retryOptions | RetryOptions | <i>(Optional)</i> the configuration for retries |
+|  retryOptions | RetryOptions | _(Optional)_ the configuration for retries |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,12 +6,12 @@
 Get the instance of the authenticator set on the service.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 getAuthenticator(): any;
 ```
-<b>Returns:</b>
+**Returns:**
 any

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

@@ -6,12 +6,12 @@
 Get the Axios instance set on the service. All requests will be made using this instance.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 getHttpClient(): import("axios").AxiosInstance;
 ```
-<b>Returns:</b>
+**Returns:**
 import("axios").AxiosInstance

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

@@ -8,7 +8,7 @@ Common functionality shared by generated service classes.
 The base service authenticates requests via its authenticator, and sends them to the service endpoint.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class BaseService

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

@@ -6,7 +6,7 @@
 Set the HTTP headers to be sent in every request.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setDefaultHeaders(headers: OutgoingHttpHeaders): void;
@@ -18,7 +18,7 @@ setDefaultHeaders(headers: OutgoingHttpHeaders): void;
 |  --- | --- | --- |
 |  headers | OutgoingHttpHeaders | the map of headers to include in requests. |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 Turn request body compression on or off.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setEnableGzipCompression(setting: boolean): void;
@@ -18,7 +18,7 @@ setEnableGzipCompression(setting: boolean): void;
 |  --- | --- | --- |
 |  setting | boolean | Will turn it on if 'true', off if 'false'. |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 Set the service URL to send requests to.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setServiceUrl(url: string): void;
@@ -18,7 +18,7 @@ setServiceUrl(url: string): void;
 |  --- | --- | --- |
 |  url | string | the base URL for the service. |
-<b>Returns:</b>
+**Returns:**
 void

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

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

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

@@ -8,7 +8,7 @@ Add basic authentication information to `requestOptions`<!-- -->. The basic auth
 Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;
-<b>Signature:</b>
+**Signature:**
 ```typescript
 authenticate(requestOptions: AuthenticateOptions): Promise<void>;
@@ -20,7 +20,7 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 |  --- | --- | --- |
 |  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
-<b>Returns:</b>
+**Returns:**
 Promise&lt;void&gt;

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

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

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

@@ -4,7 +4,7 @@
 ## BasicAuthenticator.authHeader property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected authHeader: {

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

@@ -10,12 +10,12 @@ Basic Authorization will be sent as an Authorization header in the form:
 Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class BasicAuthenticator extends Authenticator
 ```
-<b>Extends:</b> [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+**Extends:** [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
 ## Constructors

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

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

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

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

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

@@ -8,7 +8,7 @@ Add a bearer token to `requestOptions`<!-- -->. The bearer token information wil
 Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
-<b>Signature:</b>
+**Signature:**
 ```typescript
 authenticate(requestOptions: AuthenticateOptions): Promise<void>;
@@ -20,7 +20,7 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 |  --- | --- | --- |
 |  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
-<b>Returns:</b>
+**Returns:**
 Promise&lt;void&gt;

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

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

package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.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 BearerTokenAuthenticator extends Authenticator
 ```
-<b>Extends:</b> [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+**Extends:** [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
 ## Constructors

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

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

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

@@ -6,7 +6,7 @@
 Set a new bearer token to be sent in subsequent requests.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setBearerToken(bearerToken: string): void;
@@ -18,7 +18,7 @@ setBearerToken(bearerToken: string): void;
 |  --- | --- | --- |
 |  bearerToken | string | The bearer token that will be sent in service requests. |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 This function builds a `form-data` object for each file parameter.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function buildRequestFileObject(fileParam: FileWithMetadata): Promise<FileObject>;
@@ -18,7 +18,7 @@ export declare function buildRequestFileObject(fileParam: FileWithMetadata): Pro
 |  --- | --- | --- |
 |  fileParam | [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) | The FileWithMetadata instance that contains the file information |
-<b>Returns:</b>
+**Returns:**
 Promise&lt;[FileObject](./ibm-cloud-sdk-core.fileobject.md)<!-- -->&gt;

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

@@ -6,7 +6,7 @@
 Checks credentials for common user mistakes of copying {<!-- -->, }<!-- -->, or " characters from the documentation
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function checkCredentials(obj: any, credsToCheck: string[]): Error | null;
@@ -19,7 +19,7 @@ export declare function checkCredentials(obj: any, credsToCheck: string[]): Erro
 |  obj | any | the options object holding credentials |
 |  credsToCheck | string\[\] | an array containing the keys of the credentials to check for problems |
-<b>Returns:</b>
+**Returns:**
 Error \| null

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

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

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

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