ibm-cloud-sdk-core 4.2.5 → 4.3.0

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

@@ -6,12 +6,81 @@
 
 ## Functions
 
-|  Function | Description |
-|  --- | --- |
-|  [checkForSuccessfulExecution(createRequestMock)](./ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md) | This method simply ensures that the method executed without any issues by extracting the argument from the mock object for the <code>createRequest</code> method and verifying that it is an object. |
-|  [checkMediaHeaders(createRequestMock, accept, contentType)](./ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md) | Takes the mock object for the <code>createRequest</code> method, extracts the headers that were sent with the call, and checks for the expected values for <code>Accept</code> and <code>Content-Type</code>. This to verify that the SDK sets the correct values in the code. |
-|  [checkUrlAndMethod(options, url, method)](./ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md) | Takes the request options constructed by the SDK and checks that the <code>url</code> and <code>method</code> properties were set to their correct values. |
-|  [checkUserHeader(createRequestMock, userHeaderName, userHeaderValue)](./ibm-cloud-sdk-core.unittestutils.checkuserheader.md) | Takes the mock object for the <code>createRequest</code> method, extracts the headers that were sent with the call, and checks for the expected value for a user-defined header. This is verify that the SDK accepts header parameters and sends them as headers in the request. |
-|  [expectToBePromise(sdkPromise)](./ibm-cloud-sdk-core.unittestutils.expecttobepromise.md) | This method simply ensures that the SDK methods return Promises by checking for the <code>then</code> function - common way to assess whether or not an object is a Promise. |
-|  [getOptions(createRequestMock)](./ibm-cloud-sdk-core.unittestutils.getoptions.md) | This method extracts the <code>options</code> property from the object passed into <code>createRequest</code>. This property is an object containing all of the SDK method-specific information (like <code>path</code> and <code>body</code>) used to build a request. This method is just a convenience method for the unit tests to be able to make assertions on the items in the request. |
+<table><thead><tr><th>
 
+Function
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[checkForSuccessfulExecution(createRequestMock)](./ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md)
+
+
+</td><td>
+
+This method simply ensures that the method executed without any issues by extracting the argument from the mock object for the `createRequest` method and verifying that it is an object.
+
+
+</td></tr>
+<tr><td>
+
+[checkMediaHeaders(createRequestMock, accept, contentType)](./ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md)
+
+
+</td><td>
+
+Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call, and checks for the expected values for `Accept` and `Content-Type`<!-- -->. This to verify that the SDK sets the correct values in the code.
+
+
+</td></tr>
+<tr><td>
+
+[checkUrlAndMethod(options, url, method)](./ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md)
+
+
+</td><td>
+
+Takes the request options constructed by the SDK and checks that the `url` and `method` properties were set to their correct values.
+
+
+</td></tr>
+<tr><td>
+
+[checkUserHeader(createRequestMock, userHeaderName, userHeaderValue)](./ibm-cloud-sdk-core.unittestutils.checkuserheader.md)
+
+
+</td><td>
+
+Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call, and checks for the expected value for a user-defined header. This is verify that the SDK accepts header parameters and sends them as headers in the request.
+
+
+</td></tr>
+<tr><td>
+
+[expectToBePromise(sdkPromise)](./ibm-cloud-sdk-core.unittestutils.expecttobepromise.md)
+
+
+</td><td>
+
+This method simply ensures that the SDK methods return Promises by checking for the `then` function - common way to assess whether or not an object is a Promise.
+
+
+</td></tr>
+<tr><td>
+
+[getOptions(createRequestMock)](./ibm-cloud-sdk-core.unittestutils.getoptions.md)
+
+
+</td><td>
+
+This method extracts the `options` property from the object passed into `createRequest`<!-- -->. This property is an object containing all of the SDK method-specific information (like `path` and `body`<!-- -->) used to build a request. This method is just a convenience method for the unit tests to be able to make assertions on the items in the request.
+
+
+</td></tr>
+</tbody></table>

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

@@ -14,13 +14,158 @@ export interface UserOptions
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [authenticator?](./ibm-cloud-sdk-core.useroptions.authenticator.md) |  | [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) | _(Optional)_ The Authenticator object used to authenticate requests to the service |
-|  [disableSslVerification?](./ibm-cloud-sdk-core.useroptions.disablesslverification.md) |  | boolean | _(Optional)_ Set to <code>true</code> to allow unauthorized requests - not recommended for production use. |
-|  [headers?](./ibm-cloud-sdk-core.useroptions.headers.md) |  | OutgoingHttpHeaders | _(Optional)_ Default headers that shall be included with every request to the service. |
-|  [jar?](./ibm-cloud-sdk-core.useroptions.jar.md) |  | CookieJar \| boolean | _(Optional)_ Set your own cookie jar object |
-|  [serviceUrl?](./ibm-cloud-sdk-core.useroptions.serviceurl.md) |  | string | _(Optional)_ The base url to use when contacting the service. The base url may differ between IBM Cloud regions. |
-|  [url?](./ibm-cloud-sdk-core.useroptions.url.md) |  | string | _(Optional)_ Deprecated. Use <code>serviceUrl</code> instead. |
-|  [version?](./ibm-cloud-sdk-core.useroptions.version.md) |  | string | _(Optional)_ The API version date to use with the service, in "YYYY-MM-DD" format. |
+<table><thead><tr><th>
 
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticator?](./ibm-cloud-sdk-core.useroptions.authenticator.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)
+
+
+</td><td>
+
+_(Optional)_ The Authenticator object used to authenticate requests to the service
+
+
+</td></tr>
+<tr><td>
+
+[disableSslVerification?](./ibm-cloud-sdk-core.useroptions.disablesslverification.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Set to `true` to allow unauthorized requests - not recommended for production use.
+
+
+</td></tr>
+<tr><td>
+
+[headers?](./ibm-cloud-sdk-core.useroptions.headers.md)
+
+
+</td><td>
+
+
+</td><td>
+
+OutgoingHttpHeaders
+
+
+</td><td>
+
+_(Optional)_ Default headers that shall be included with every request to the service.
+
+
+</td></tr>
+<tr><td>
+
+[jar?](./ibm-cloud-sdk-core.useroptions.jar.md)
+
+
+</td><td>
+
+
+</td><td>
+
+CookieJar \| boolean
+
+
+</td><td>
+
+_(Optional)_ Set your own cookie jar object
+
+
+</td></tr>
+<tr><td>
+
+[serviceUrl?](./ibm-cloud-sdk-core.useroptions.serviceurl.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
+
+
+</td></tr>
+<tr><td>
+
+[url?](./ibm-cloud-sdk-core.useroptions.url.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ Deprecated. Use `serviceUrl` instead.
+
+
+</td></tr>
+<tr><td>
+
+[version?](./ibm-cloud-sdk-core.useroptions.version.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The API version date to use with the service, in "YYYY-MM-DD" format.
+
+
+</td></tr>
+</tbody></table>

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

@@ -14,11 +14,55 @@ export declare function validateInput(options: any, requiredOptions: string[]):
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | any | a configuration options object |
-|  requiredOptions | string\[\] | the list of properties that must be present in "options" |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+a configuration options object
+
+
+</td></tr>
+<tr><td>
+
+requiredOptions
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+the list of properties that must be present in "options"
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

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

@@ -16,12 +16,71 @@ export declare function validateParams(params: {
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  params | { \[key: string\]: any; } | the "params" object passed into an operation containing method parameters. |
-|  requiredParams | string\[\] | the names of required parameters. If null, then the "required params" check is bypassed. |
-|  allParams | string\[\] | the names of all valid parameters. If null, then the "valid params" check is bypassed. |
+<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 "params" object passed into an operation containing method parameters.
+
+
+</td></tr>
+<tr><td>
+
+requiredParams
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+the names of required parameters. If null, then the "required params" check is bypassed.
+
+
+</td></tr>
+<tr><td>
+
+allParams
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+the names of all valid parameters. If null, then the "valid params" check is bypassed.
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 null \| Error

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

@@ -14,9 +14,39 @@ constructor(options: Options);
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | Options | Configuration options for VpcInstance authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the VPC Instance Metadata Service (default value: "http://169.254.169.254") - iamProfileCrn: (optional) the CRN of the linked IAM trusted profile to be used to obtain the IAM access token - iamProfileId: (optional) the ID of the linked IAM trusted profile to be used to obtain the IAM access token |
+<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 VpcInstance authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the VPC Instance Metadata Service (default value: "http://169.254.169.254") - iamProfileCrn: (optional) the CRN of the linked IAM trusted profile to be used to obtain the IAM access token - iamProfileId: (optional) the ID of the linked IAM trusted profile to be used to obtain the IAM access token
+
+
+</td></tr>
+</tbody></table>
 
 ## Remarks
 

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

@@ -19,21 +19,140 @@ export declare class VpcInstanceAuthenticator extends TokenRequestBasedAuthentic
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md) |  | Create a new VpcInstanceAuthenticator instance. |
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new VpcInstanceAuthenticator instance.
+
+
+</td></tr>
+</tbody></table>
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [tokenManager](./ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md) | <code>protected</code> | [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[tokenManager](./ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+[VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [authenticationType()](./ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('vpc'). |
-|  [setIamProfileCrn(iamProfileCrn)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md) |  | Sets the "iamProfileCrn" value to be used when obtaining an IAM access token |
-|  [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md) |  | Sets the "iamProfileId" value to be used when obtaining an IAM access token |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticationType()](./ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Returns the authenticator's type ('vpc').
+
+
+</td></tr>
+<tr><td>
+
+[setIamProfileCrn(iamProfileCrn)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the "iamProfileCrn" value to be used when obtaining an IAM access token
+
+
+</td></tr>
+<tr><td>
+
+[setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the "iamProfileId" value to be used when obtaining an IAM access token
+
 
+</td></tr>
+</tbody></table>

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md

@@ -14,10 +14,39 @@ setIamProfileCrn(iamProfileCrn: string): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  iamProfileCrn | string | the CRN of the linked IAM trusted profile to use when obtaining an IAM access token |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+iamProfileCrn
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the CRN of the linked IAM trusted profile to use when obtaining an IAM access token
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md

@@ -14,10 +14,39 @@ setIamProfileId(iamProfileId: string): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  iamProfileId | string | the ID of the linked IAM trusted profile to use when obtaining an IAM access token |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+iamProfileId
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the ID of the linked IAM trusted profile to use when obtaining an IAM access token
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void