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

ibm-cloud-sdk-core 4.0.6 → 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 (275) hide show

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

@@ -6,7 +6,7 @@
 Set headers.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setHeaders(headers: OutgoingHttpHeaders): void;
@@ -18,7 +18,7 @@ setHeaders(headers: OutgoingHttpHeaders): void;
 |  --- | --- | --- |
 |  headers | OutgoingHttpHeaders | a set of HTTP headers to be sent with each outbound token server request. Overwrites previous default headers. |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -4,7 +4,7 @@
 ## TokenRequestBasedAuthenticator.tokenManager property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected tokenManager: JwtTokenManager;

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

@@ -4,7 +4,7 @@
 ## TokenRequestBasedAuthenticator.url property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected url: string;

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

@@ -6,7 +6,7 @@
 This function converts an object's keys to lower case. note: does not convert nested keys
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function toLowerKeys(obj: Object): Object;
@@ -18,7 +18,7 @@ export declare function toLowerKeys(obj: Object): Object;
 |  --- | --- | --- |
 |  obj | Object | The object to convert the keys of. |
-<b>Returns:</b>
+**Returns:**
 Object

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

@@ -6,7 +6,7 @@
 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.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function checkForSuccessfulExecution(createRequestMock: any): void;
@@ -18,7 +18,7 @@ export declare function checkForSuccessfulExecution(createRequestMock: any): voi
 |  --- | --- | --- |
 |  createRequestMock | any | the jest mock object for the <code>createRequest</code> method in the <code>RequestWrapper</code> class |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 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.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
@@ -20,7 +20,7 @@ export declare function checkMediaHeaders(createRequestMock: any, accept: string
 |  accept | string | the expected value for the <code>Accept</code> header |
 |  contentType | string | the expected value for the <code>Content-Type</code> header |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 Takes the request options constructed by the SDK and checks that the `url` and `method` properties were set to their correct values.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
@@ -20,7 +20,7 @@ export declare function checkUrlAndMethod(options: any, url: string, method: any
 |  url | string | The URL path of the service endpoint, from the paths section of the API definition |
 |  method | any | The HTTP method for the request, from the API definition |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 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.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
@@ -20,7 +20,7 @@ export declare function checkUserHeader(createRequestMock: any, userHeaderName:
 |  userHeaderName | string | the name of the header passed by the user, e.g. <code>Contained-Content-Type</code> |
 |  userHeaderValue | string | the expected value for the header passed by the user |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 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.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function expectToBePromise(sdkPromise: any): void;
@@ -18,7 +18,7 @@ export declare function expectToBePromise(sdkPromise: any): void;
 |  --- | --- | --- |
 |  sdkPromise | any | the Promise returned by an SDK method |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 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.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getOptions(createRequestMock: any): any;
@@ -18,7 +18,7 @@ export declare function getOptions(createRequestMock: any): any;
 |  --- | --- | --- |
 |  createRequestMock | any | the jest mock object for the <code>createRequest</code> method in the <code>RequestWrapper</code> class |
-<b>Returns:</b>
+**Returns:**
 any

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

@@ -6,7 +6,7 @@
 The Authenticator object used to authenticate requests to the service
-<b>Signature:</b>
+**Signature:**
 ```typescript
 authenticator?: AuthenticatorInterface;

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

@@ -6,7 +6,7 @@
 Set to `true` to allow unauthorized requests - not recommended for production use.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 disableSslVerification?: boolean;

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

@@ -6,7 +6,7 @@
 Default headers that shall be included with every request to the service.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 headers?: OutgoingHttpHeaders;

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

@@ -6,7 +6,7 @@
 Set your own cookie jar object
-<b>Signature:</b>
+**Signature:**
 ```typescript
 jar?: CookieJar | boolean;

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

@@ -6,7 +6,7 @@
 Configuration values for a service.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export interface UserOptions
@@ -16,11 +16,11 @@ export interface UserOptions
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [authenticator?](./ibm-cloud-sdk-core.useroptions.authenticator.md) |  | [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) | <i>(Optional)</i> The Authenticator object used to authenticate requests to the service |
-|  [disableSslVerification?](./ibm-cloud-sdk-core.useroptions.disablesslverification.md) |  | boolean | <i>(Optional)</i> Set to <code>true</code> to allow unauthorized requests - not recommended for production use. |
-|  [headers?](./ibm-cloud-sdk-core.useroptions.headers.md) |  | OutgoingHttpHeaders | <i>(Optional)</i> Default headers that shall be included with every request to the service. |
-|  [jar?](./ibm-cloud-sdk-core.useroptions.jar.md) |  | CookieJar \| boolean | <i>(Optional)</i> Set your own cookie jar object |
-|  [serviceUrl?](./ibm-cloud-sdk-core.useroptions.serviceurl.md) |  | string | <i>(Optional)</i> 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 | <i>(Optional)</i> Deprecated. Use <code>serviceUrl</code> instead. |
-|  [version?](./ibm-cloud-sdk-core.useroptions.version.md) |  | string | <i>(Optional)</i> The API version date to use with the service, in "YYYY-MM-DD" format. |
+|  [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. |

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

@@ -6,7 +6,7 @@
 The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 serviceUrl?: string;

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

@@ -6,7 +6,7 @@
 Deprecated. Use `serviceUrl` instead.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 url?: string;

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

@@ -6,7 +6,7 @@
 The API version date to use with the service, in "YYYY-MM-DD" format.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 version?: string;

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

@@ -6,7 +6,7 @@
 Validates "options".
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function validateInput(options: any, requiredOptions: string[]): void;
@@ -19,7 +19,7 @@ export declare function validateInput(options: any, requiredOptions: string[]):
 |  options | any | a configuration options object |
 |  requiredOptions | string\[\] | the list of properties that must be present in "options" |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 Validates that "params" contains a value for each key listed in "requiredParams", and that each key contained in "params" is a valid key listed in "allParams". In essence, we want params to contain only valid keys and we want params to contain at least the required keys.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function validateParams(params: {
@@ -22,7 +22,7 @@ export declare function validateParams(params: {
 |  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. |
-<b>Returns:</b>
+**Returns:**
 null \| Error

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

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

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

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

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

@@ -10,12 +10,12 @@ The resulting IAM access token is then added to outbound requests in an Authoriz
 Authorization: Bearer &lt;<!-- -->access-token<!-- -->&gt;
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator
 ```
-<b>Extends:</b> [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
+**Extends:** [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
 ## Constructors

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

@@ -6,7 +6,7 @@
 Sets the "iamProfileCrn" value to be used when obtaining an IAM access token
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setIamProfileCrn(iamProfileCrn: string): void;
@@ -18,7 +18,7 @@ setIamProfileCrn(iamProfileCrn: string): void;
 |  --- | --- | --- |
 |  iamProfileCrn | string | the CRN of the linked IAM trusted profile to use when obtaining an IAM access token |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 Sets the "iamProfileId" value to be used when obtaining an IAM access token
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setIamProfileId(iamProfileId: string): void;
@@ -18,7 +18,7 @@ setIamProfileId(iamProfileId: string): void;
 |  --- | --- | --- |
 |  iamProfileId | string | the ID of the linked IAM trusted profile to use when obtaining an IAM access token |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -4,7 +4,7 @@
 ## VpcInstanceAuthenticator.tokenManager property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected tokenManager: VpcInstanceTokenManager;

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

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

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

@@ -6,12 +6,12 @@
 Token Manager for VPC Instance Authentication.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class VpcInstanceTokenManager extends JwtTokenManager
 ```
-<b>Extends:</b> [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
+**Extends:** [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
 ## Constructors

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

@@ -4,12 +4,12 @@
 ## VpcInstanceTokenManager.requestToken() method
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected requestToken(): Promise<any>;
 ```
-<b>Returns:</b>
+**Returns:**
 Promise&lt;any&gt;

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

@@ -6,7 +6,7 @@
 Sets the CRN of the IAM trusted profile to use when fetching the access token from the IAM token server.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setIamProfileCrn(iamProfileCrn: string): void;
@@ -18,7 +18,7 @@ setIamProfileCrn(iamProfileCrn: string): void;
 |  --- | --- | --- |
 |  iamProfileCrn | string | the CRN of the IAM trusted profile |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 Sets the Id of the IAM trusted profile to use when fetching the access token from the IAM token server.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setIamProfileId(iamProfileId: string): void;
@@ -18,7 +18,7 @@ setIamProfileId(iamProfileId: string): void;
 |  --- | --- | --- |
 |  iamProfileId | string | the ID of the IAM trusted profile |
-<b>Returns:</b>
+**Returns:**
 void