ibm-cloud-sdk-core 4.2.5 → 4.3.1

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

@@ -16,31 +16,298 @@ export declare class BaseService
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(userOptions)](./ibm-cloud-sdk-core.baseservice._constructor_.md) |  | Configuration values for a service. |
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(userOptions)](./ibm-cloud-sdk-core.baseservice._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Configuration values for a service.
+
+
+</td></tr>
+</tbody></table>
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [baseOptions](./ibm-cloud-sdk-core.baseservice.baseoptions.md) | <code>protected</code> | BaseServiceOptions |  |
-|  [DEFAULT\_SERVICE\_NAME](./ibm-cloud-sdk-core.baseservice.default_service_name.md) | <code>static</code> | string |  |
-|  [DEFAULT\_SERVICE\_URL](./ibm-cloud-sdk-core.baseservice.default_service_url.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>
+
+[baseOptions](./ibm-cloud-sdk-core.baseservice.baseoptions.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+BaseServiceOptions
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[DEFAULT\_SERVICE\_NAME](./ibm-cloud-sdk-core.baseservice.default_service_name.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[DEFAULT\_SERVICE\_URL](./ibm-cloud-sdk-core.baseservice.default_service_url.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [configureService(serviceName)](./ibm-cloud-sdk-core.baseservice.configureservice.md) | <code>protected</code> | Configure the service using external configuration |
-|  [convertModel(input, converterFn, isMap)](./ibm-cloud-sdk-core.baseservice.convertmodel.md) | <code>static</code> | Applies a given modifier function on a model object. Since the model object can be a map, or an array, or a model, these types needs different handling. Considering whether the input object is a map happens with an explicit parameter. |
-|  [createRequest(parameters)](./ibm-cloud-sdk-core.baseservice.createrequest.md) | <code>protected</code> | Wrapper around <code>sendRequest</code> that enforces the request will be authenticated. |
-|  [createRequestAndDeserializeResponse(parameters, deserializerFn, isMap)](./ibm-cloud-sdk-core.baseservice.createrequestanddeserializeresponse.md) | <code>protected</code> | Wrapper around <code>createRequest</code> that enforces arrived response to be deserialized. |
-|  [disableRetries()](./ibm-cloud-sdk-core.baseservice.disableretries.md) |  | Disables retries. |
-|  [enableRetries(retryOptions)](./ibm-cloud-sdk-core.baseservice.enableretries.md) |  | Enable retries for unfulfilled requests. |
-|  [getAuthenticator()](./ibm-cloud-sdk-core.baseservice.getauthenticator.md) |  | Get the instance of the authenticator set on the service. |
-|  [getHttpClient()](./ibm-cloud-sdk-core.baseservice.gethttpclient.md) |  | Get the Axios instance set on the service. All requests will be made using this instance. |
-|  [setDefaultHeaders(headers)](./ibm-cloud-sdk-core.baseservice.setdefaultheaders.md) |  | Set the HTTP headers to be sent in every request. |
-|  [setEnableGzipCompression(setting)](./ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md) |  | Turn request body compression on or off. |
-|  [setServiceUrl(url)](./ibm-cloud-sdk-core.baseservice.setserviceurl.md) |  | Set the service URL to send requests to. |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[configureService(serviceName)](./ibm-cloud-sdk-core.baseservice.configureservice.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Configure the service using external configuration
+
+
+</td></tr>
+<tr><td>
+
+[convertModel(input, converterFn, isMap)](./ibm-cloud-sdk-core.baseservice.convertmodel.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Applies a given modifier function on a model object. Since the model object can be a map, or an array, or a model, these types needs different handling. Considering whether the input object is a map happens with an explicit parameter.
+
+
+</td></tr>
+<tr><td>
+
+[createRequest(parameters)](./ibm-cloud-sdk-core.baseservice.createrequest.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Wrapper around `sendRequest` that enforces the request will be authenticated.
+
+
+</td></tr>
+<tr><td>
+
+[createRequestAndDeserializeResponse(parameters, deserializerFn, isMap)](./ibm-cloud-sdk-core.baseservice.createrequestanddeserializeresponse.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Wrapper around `createRequest` that enforces arrived response to be deserialized.
+
+
+</td></tr>
+<tr><td>
+
+[disableRetries()](./ibm-cloud-sdk-core.baseservice.disableretries.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Disables retries.
+
+
+</td></tr>
+<tr><td>
+
+[enableRetries(retryOptions)](./ibm-cloud-sdk-core.baseservice.enableretries.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Enable retries for unfulfilled requests.
+
+
+</td></tr>
+<tr><td>
+
+[getAuthenticator()](./ibm-cloud-sdk-core.baseservice.getauthenticator.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get the instance of the authenticator set on the service.
+
+
+</td></tr>
+<tr><td>
+
+[getHttpClient()](./ibm-cloud-sdk-core.baseservice.gethttpclient.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get the Axios instance set on the service. All requests will be made using this instance.
+
+
+</td></tr>
+<tr><td>
+
+[setDefaultHeaders(headers)](./ibm-cloud-sdk-core.baseservice.setdefaultheaders.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Set the HTTP headers to be sent in every request.
+
+
+</td></tr>
+<tr><td>
+
+[setEnableGzipCompression(setting)](./ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Turn request body compression on or off.
+
+
+</td></tr>
+<tr><td>
+
+[setServiceUrl(url)](./ibm-cloud-sdk-core.baseservice.setserviceurl.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Set the service URL to send requests to.
+
 
+</td></tr>
+</tbody></table>

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

@@ -14,10 +14,39 @@ setDefaultHeaders(headers: OutgoingHttpHeaders): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  headers | OutgoingHttpHeaders | the map of headers to include in requests. |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+headers
+
+
+</td><td>
+
+OutgoingHttpHeaders
+
+
+</td><td>
+
+the map of headers to include in requests.
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

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

@@ -14,10 +14,39 @@ setEnableGzipCompression(setting: boolean): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  setting | boolean | Will turn it on if 'true', off if 'false'. |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+setting
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Will turn it on if 'true', off if 'false'.
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

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

@@ -14,10 +14,39 @@ setServiceUrl(url: string): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  url | string | the base URL for the service. |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+url
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the base URL for the service.
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

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

@@ -14,9 +14,39 @@ constructor(options: Options);
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | Options | Configuration options for basic authentication. This should be an object containing these fields: - username: the username portion of basic authentication - password: the password portion of basic authentication |
+<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 basic authentication. This should be an object containing these fields: - username: the username portion of basic authentication - password: the password portion of basic authentication
+
+
+</td></tr>
+</tbody></table>
 
 ## Exceptions
 

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

@@ -16,10 +16,39 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
+<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 augment with authentication information.
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 Promise&lt;void&gt;

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

@@ -19,21 +19,147 @@ export declare class BasicAuthenticator extends Authenticator
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.basicauthenticator._constructor_.md) |  | Create a new BasicAuthenticator instance. |
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.basicauthenticator._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new BasicAuthenticator instance.
+
+
+</td></tr>
+</tbody></table>
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [authHeader](./ibm-cloud-sdk-core.basicauthenticator.authheader.md) | <code>protected</code> | { Authorization: string; } |  |
-|  [requiredOptions](./ibm-cloud-sdk-core.basicauthenticator.requiredoptions.md) | <code>protected</code> | string\[\] |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authHeader](./ibm-cloud-sdk-core.basicauthenticator.authheader.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+{ Authorization: string; }
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[requiredOptions](./ibm-cloud-sdk-core.basicauthenticator.requiredoptions.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.basicauthenticator.authenticate.md) |  | <p>Add basic authentication information to <code>requestOptions</code>. The basic authentication information will be set in the Authorization property of <code>requestOptions.headers</code> in the form:</p><p>Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;</p> |
-|  [authenticationType()](./ibm-cloud-sdk-core.basicauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('basic'). |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticate(requestOptions)](./ibm-cloud-sdk-core.basicauthenticator.authenticate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Add basic authentication information to `requestOptions`<!-- -->. The basic authentication information will be set in the Authorization property of `requestOptions.headers` in the form:
+
+Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;
+
+
+</td></tr>
+<tr><td>
+
+[authenticationType()](./ibm-cloud-sdk-core.basicauthenticator.authenticationtype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Returns the authenticator's type ('basic').
+
 
+</td></tr>
+</tbody></table>