ibm-cloud-sdk-core 4.2.5 → 4.3.1

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

@@ -15,28 +15,280 @@ export declare class Authenticator implements AuthenticatorInterface
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)()](./ibm-cloud-sdk-core.authenticator._constructor_.md) |  | Create a new Authenticator instance. |
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)()](./ibm-cloud-sdk-core.authenticator._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new Authenticator instance.
+
+
+</td></tr>
+</tbody></table>
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [AUTHTYPE\_BASIC](./ibm-cloud-sdk-core.authenticator.authtype_basic.md) | <code>static</code> | string | Constants that define the various authenticator types. |
-|  [AUTHTYPE\_BEARERTOKEN](./ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_MCSP](./ibm-cloud-sdk-core.authenticator.authtype_mcsp.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_UNKNOWN](./ibm-cloud-sdk-core.authenticator.authtype_unknown.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_VPC](./ibm-cloud-sdk-core.authenticator.authtype_vpc.md) | <code>static</code> | string |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[AUTHTYPE\_BASIC](./ibm-cloud-sdk-core.authenticator.authtype_basic.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+Constants that define the various authenticator types.
+
+
+</td></tr>
+<tr><td>
+
+[AUTHTYPE\_BEARERTOKEN](./ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[AUTHTYPE\_MCSP](./ibm-cloud-sdk-core.authenticator.authtype_mcsp.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[AUTHTYPE\_UNKNOWN](./ibm-cloud-sdk-core.authenticator.authtype_unknown.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[AUTHTYPE\_VPC](./ibm-cloud-sdk-core.authenticator.authtype_vpc.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticator.authenticate.md) |  | Augment the request with authentication information. |
-|  [authenticationType()](./ibm-cloud-sdk-core.authenticator.authenticationtype.md) |  | 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. |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticator.authenticate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Augment the request with authentication information.
+
+
+</td></tr>
+<tr><td>
+
+[authenticationType()](./ibm-cloud-sdk-core.authenticator.authenticationtype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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.
+
 
+</td></tr>
+</tbody></table>

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

@@ -14,10 +14,39 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  requestOptions | AuthenticateOptions | The request to which authentication information is added (in the headers field). |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+requestOptions
+
+
+</td><td>
+
+AuthenticateOptions
+
+
+</td><td>
+
+The request to which authentication information is added (in the headers field).
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 Promise&lt;void&gt;

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

@@ -14,8 +14,37 @@ export interface AuthenticatorInterface
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticatorinterface.authenticate.md) | Add authentication information to the specified request. |
-|  [authenticationType()](./ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md) | Returns a string that indicates the authentication type. |
+<table><thead><tr><th>
 
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticatorinterface.authenticate.md)
+
+
+</td><td>
+
+Add authentication information to the specified request.
+
+
+</td></tr>
+<tr><td>
+
+[authenticationType()](./ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md)
+
+
+</td><td>
+
+Returns a string that indicates the authentication type.
+
+
+</td></tr>
+</tbody></table>

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

@@ -14,7 +14,36 @@ constructor(userOptions: UserOptions);
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  userOptions | [UserOptions](./ibm-cloud-sdk-core.useroptions.md) | the configuration options to set on the service instance. This should be an object with the following fields: - authenticator: (required) an Object used to authenticate requests to the service. - serviceUrl: (optional) the base url to use when contacting the service. The base url may differ between IBM Cloud regions. - headers: (optional) a set of HTTP headers that should be included with every request sent to the service - disableSslVerification: (optional) a flag that indicates whether verification of the server's SSL certificate should be disabled or not. |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+userOptions
+
+
+</td><td>
+
+[UserOptions](./ibm-cloud-sdk-core.useroptions.md)
+
+
+</td><td>
+
+the configuration options to set on the service instance. This should be an object with the following fields: - authenticator: (required) an Object used to authenticate requests to the service. - serviceUrl: (optional) the base url to use when contacting the service. The base url may differ between IBM Cloud regions. - headers: (optional) a set of HTTP headers that should be included with every request sent to the service - disableSslVerification: (optional) a flag that indicates whether verification of the server's SSL certificate should be disabled or not.
+
+
+</td></tr>
+</tbody></table>

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

@@ -14,10 +14,39 @@ protected configureService(serviceName: string): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  serviceName | string | the name of the service. This will be used to read from external configuration. |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+serviceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the name of the service. This will be used to read from external configuration.
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

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

@@ -14,12 +14,71 @@ static convertModel(input: any, converterFn: any, isMap?: boolean): any;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  input | any | the input model object |
-|  converterFn | any | the function that is applied on the input object |
-|  isMap | boolean | _(Optional)_ is <code>true</code> when the input object should be handled as a map |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+input
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the input model object
+
+
+</td></tr>
+<tr><td>
+
+converterFn
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the function that is applied on the input object
+
+
+</td></tr>
+<tr><td>
+
+isMap
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ is `true` when the input object should be handled as a map
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 any

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

@@ -14,10 +14,39 @@ protected createRequest(parameters: any): Promise<any>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  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 |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+parameters
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+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
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 Promise&lt;any&gt;

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

@@ -14,12 +14,71 @@ protected createRequestAndDeserializeResponse(parameters: any, deserializerFn: (
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  parameters | any | see <code>parameters</code> in <code>createRequest</code> |
-|  deserializerFn | (any: any) =&gt; any | the deserializer function that is applied on the response object |
-|  isMap | boolean | _(Optional)_ is <code>true</code> when the response object should be handled as a map |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+parameters
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+see `parameters` in `createRequest`
+
+
+</td></tr>
+<tr><td>
+
+deserializerFn
+
+
+</td><td>
+
+(any: any) =&gt; any
+
+
+</td><td>
+
+the deserializer function that is applied on the response object
+
+
+</td></tr>
+<tr><td>
+
+isMap
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ is `true` when the response object should be handled as a map
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 Promise&lt;any&gt;

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

@@ -14,10 +14,39 @@ enableRetries(retryOptions?: RetryOptions): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  retryOptions | RetryOptions | _(Optional)_ the configuration for retries |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+retryOptions
+
+
+</td><td>
+
+RetryOptions
+
+
+</td><td>
+
+_(Optional)_ the configuration for retries
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void