ibm-cloud-sdk-core 4.2.4 → 4.3.0

package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md

@@ -14,10 +14,39 @@ setIamProfileName(iamProfileName: string): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  iamProfileName | string | the name of the IAM trusted profile |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+iamProfileName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the name of the IAM trusted profile
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

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

@@ -14,9 +14,39 @@ constructor(options: Options);
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | Options | Configuration options This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - 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 |
+<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 This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - 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
+
+
+</td></tr>
+</tbody></table>
 
 ## Exceptions
 

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

@@ -17,19 +17,112 @@ export declare class Cp4dTokenManager extends JwtTokenManager
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md) |  | Create a new Cp4dTokenManager instance. |
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new Cp4dTokenManager instance.
+
+
+</td></tr>
+</tbody></table>
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [requiredOptions](./ibm-cloud-sdk-core.cp4dtokenmanager.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>
+
+[requiredOptions](./ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [requestToken()](./ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md) | <code>protected</code> |  |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[requestToken()](./ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
 
+</td></tr>
+</tbody></table>

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

@@ -12,10 +12,37 @@ export declare function fileExistsAtPath(filepath: string): boolean;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  filepath | string |  |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+filepath
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 boolean

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

@@ -20,8 +20,61 @@ export interface FileObject
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [options?](./ibm-cloud-sdk-core.fileobject.options.md) |  | [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) | _(Optional)_ |
-|  [value](./ibm-cloud-sdk-core.fileobject.value.md) |  | NodeJS.ReadableStream \| Buffer \| string |  |
+<table><thead><tr><th>
 
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[options?](./ibm-cloud-sdk-core.fileobject.options.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[FileOptions](./ibm-cloud-sdk-core.fileoptions.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[value](./ibm-cloud-sdk-core.fileobject.value.md)
+
+
+</td><td>
+
+
+</td><td>
+
+NodeJS.ReadableStream \| Buffer \| string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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

@@ -12,8 +12,63 @@ export interface FileOptions
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [contentType?](./ibm-cloud-sdk-core.fileoptions.contenttype.md) |  | string | _(Optional)_ |
-|  [filename?](./ibm-cloud-sdk-core.fileoptions.filename.md) |  | string | _(Optional)_ |
+<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.fileoptions.contenttype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[filename?](./ibm-cloud-sdk-core.fileoptions.filename.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>

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

@@ -13,7 +13,42 @@ export interface FileStream extends NodeJS.ReadableStream
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [path](./ibm-cloud-sdk-core.filestream.path.md) |  | string \| Buffer |  |
+<table><thead><tr><th>
 
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[path](./ibm-cloud-sdk-core.filestream.path.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| Buffer
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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

@@ -12,9 +12,76 @@ export interface FileWithMetadata
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [contentType](./ibm-cloud-sdk-core.filewithmetadata.contenttype.md) |  | string |  |
-|  [data](./ibm-cloud-sdk-core.filewithmetadata.data.md) |  | NodeJS.ReadableStream \| Buffer |  |
-|  [filename](./ibm-cloud-sdk-core.filewithmetadata.filename.md) |  | string |  |
+<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

@@ -16,10 +16,39 @@ export declare function getAuthenticatorFromEnvironment(serviceName: string): Au
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  serviceName | string | the service name prefix. |
+<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

@@ -14,10 +14,39 @@ export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  inputData | NodeJS.ReadableStream \| Buffer | The data to retrieve content type for. |
+<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;

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

@@ -16,11 +16,53 @@ export declare function getFormat(params: {
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  params | { \[key: string\]: any; } | The parameters. |
-|  formats | string\[\] |  |
+<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

@@ -16,11 +16,55 @@ export declare function getMissingParams(params: {
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  params | { \[key: string\]: any; } | the method parameters. |
-|  requires | string\[\] | the required parameter names. |
+<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