ibm-cloud-sdk-core 3.2.2-beta-5 → 3.2.2

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [disableSslVerification](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md)
+
+## TokenRequestBasedAuthenticator.disableSslVerification property
+
+<b>Signature:</b>
+
+```typescript
+protected disableSslVerification: boolean;
+```

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [headers](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md)
+
+## TokenRequestBasedAuthenticator.headers property
+
+<b>Signature:</b>
+
+```typescript
+protected headers: OutgoingHttpHeaders;
+```

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

@@ -0,0 +1,42 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
+
+## TokenRequestBasedAuthenticator class
+
+Class for common functionality shared by token-request authenticators. \[\[TokenRequestBasedAuthenticator\]\]s use token managers to retrieve, store, and refresh tokens. Not intended to be used as stand-alone authenticator, but as parent class to authenticators that have their own token manager implementations.
+
+The tokens will be added as an Authorization headers in the form:
+
+Authorization: Bearer <bearer-token>
+
+<b>Signature:</b>
+
+```typescript
+export declare class TokenRequestBasedAuthenticator extends Authenticator 
+```
+<b>Extends:</b> [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md) |  | Create a new \[\[TokenRequestBasedAuthenticator\]\] instance with an internal \[\[JwtTokenManager\]\]. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [disableSslVerification](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md) |  | boolean |  |
+|  [headers](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md) |  | OutgoingHttpHeaders |  |
+|  [tokenManager](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.tokenmanager.md) |  | [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) |  |
+|  [url](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.url.md) |  | string |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md) |  | Adds bearer token information to <code>request</code>. The bearer token information will be set in the Authorization property of<code>request.headers</code> in the form:<!-- -->Authorization: Bearer <bearer-token> |
+|  [setDisableSslVerification(value)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md) |  | Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not. |
+|  [setHeaders(headers)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md) |  | Set headers. |
+

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [setDisableSslVerification](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md)
+
+## TokenRequestBasedAuthenticator.setDisableSslVerification() method
+
+Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.
+
+<b>Signature:</b>
+
+```typescript
+setDisableSslVerification(value: boolean): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  value | boolean | A flag that indicates whether verification of the token server's SSL certificate should be disabled or not. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [setHeaders](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md)
+
+## TokenRequestBasedAuthenticator.setHeaders() method
+
+Set headers.
+
+<b>Signature:</b>
+
+```typescript
+setHeaders(headers: OutgoingHttpHeaders): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  headers | OutgoingHttpHeaders | Default headers to be sent with every Cloud Pak For Data token request. Overwrites previous default headers. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.tokenmanager.md)
+
+## TokenRequestBasedAuthenticator.tokenManager property
+
+<b>Signature:</b>
+
+```typescript
+protected tokenManager: JwtTokenManager;
+```

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [url](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.url.md)
+
+## TokenRequestBasedAuthenticator.url property
+
+<b>Signature:</b>
+
+```typescript
+protected url: string;
+```

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [toLowerKeys](./ibm-cloud-sdk-core.tolowerkeys.md)
+
+## toLowerKeys() function
+
+This function converts an object's keys to lower case. note: does not convert nested keys
+
+<b>Signature:</b>
+
+```typescript
+export declare function toLowerKeys(obj: Object): Object;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  obj | Object | The object to convert the keys of. |
+
+<b>Returns:</b>
+
+Object
+
+{<!-- -->Object<!-- -->}
+

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [checkForSuccessfulExecution](./ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md)
+
+## unitTestUtils.checkForSuccessfulExecution() function
+
+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>
+
+```typescript
+export declare function checkForSuccessfulExecution(createRequestMock: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  createRequestMock | any | the jest mock object for the <code>createRequest</code> method in the <code>RequestWrapper</code> class |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [checkMediaHeaders](./ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md)
+
+## unitTestUtils.checkMediaHeaders() function
+
+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>
+
+```typescript
+export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  createRequestMock | any | the jest mock object for the <code>createRequest</code> method in the <code>RequestWrapper</code> class |
+|  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>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [checkUrlAndMethod](./ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md)
+
+## unitTestUtils.checkUrlAndMethod() function
+
+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>
+
+```typescript
+export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | any | the options object put together by the SDK, retrieved from the createRequest mock |
+|  url | string | The URL path of the service endpoint, from the paths section of the API definition |
+|  method | any |  |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [checkUserHeader](./ibm-cloud-sdk-core.unittestutils.checkuserheader.md)
+
+## unitTestUtils.checkUserHeader() function
+
+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>
+
+```typescript
+export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  createRequestMock | any | the jest mock object for the <code>createRequest</code> method in the <code>RequestWrapper</code> class |
+|  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>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [expectToBePromise](./ibm-cloud-sdk-core.unittestutils.expecttobepromise.md)
+
+## unitTestUtils.expectToBePromise() function
+
+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>
+
+```typescript
+export declare function expectToBePromise(sdkPromise: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  sdkPromise | any | the Promise returned by an SDK method |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [getOptions](./ibm-cloud-sdk-core.unittestutils.getoptions.md)
+
+## unitTestUtils.getOptions() function
+
+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>
+
+```typescript
+export declare function getOptions(createRequestMock: any): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  createRequestMock | any | the jest mock object for the <code>createRequest</code> method in the <code>RequestWrapper</code> class |
+
+<b>Returns:</b>
+
+any
+
+{<!-- -->Object<!-- -->}
+

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md)
+
+## unitTestUtils namespace
+
+## 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. |
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [authenticator](./ibm-cloud-sdk-core.useroptions.authenticator.md)
+
+## UserOptions.authenticator property
+
+The Authenticator object used to authenticate requests to the service
+
+<b>Signature:</b>
+
+```typescript
+authenticator?: AuthenticatorInterface;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [disableSslVerification](./ibm-cloud-sdk-core.useroptions.disablesslverification.md)
+
+## UserOptions.disableSslVerification property
+
+Set to `true` to allow unauthorized requests - not recommended for production use.
+
+<b>Signature:</b>
+
+```typescript
+disableSslVerification?: boolean;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [headers](./ibm-cloud-sdk-core.useroptions.headers.md)
+
+## UserOptions.headers property
+
+Default headers that shall be included with every request to the service.
+
+<b>Signature:</b>
+
+```typescript
+headers?: OutgoingHttpHeaders;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [jar](./ibm-cloud-sdk-core.useroptions.jar.md)
+
+## UserOptions.jar property
+
+Set your own cookie jar object
+
+<b>Signature:</b>
+
+```typescript
+jar?: CookieJar | boolean;
+```

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md)
+
+## UserOptions interface
+
+Configuration values for a service.
+
+<b>Signature:</b>
+
+```typescript
+export interface UserOptions 
+```
+
+## Properties
+
+|  Property | 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. |
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [serviceUrl](./ibm-cloud-sdk-core.useroptions.serviceurl.md)
+
+## UserOptions.serviceUrl property
+
+The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
+
+<b>Signature:</b>
+
+```typescript
+serviceUrl?: string;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [url](./ibm-cloud-sdk-core.useroptions.url.md)
+
+## UserOptions.url property
+
+Deprecated. Use `serviceUrl` instead.
+
+<b>Signature:</b>
+
+```typescript
+url?: string;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [version](./ibm-cloud-sdk-core.useroptions.version.md)
+
+## UserOptions.version property
+
+The API version date to use with the service, in "YYYY-MM-DD" format.
+
+<b>Signature:</b>
+
+```typescript
+version?: string;
+```

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [validateInput](./ibm-cloud-sdk-core.validateinput.md)
+
+## validateInput() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function validateInput(options: any, requiredOptions: string[]): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | any | A configuration options object. |
+|  requiredOptions | string\[\] | The list of properties that must be specified. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [validateParams](./ibm-cloud-sdk-core.validateparams.md)
+
+## validateParams() function
+
+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>
+
+```typescript
+export declare function validateParams(params: {
+    [key: string]: any;
+}, requiredParams: string[], allParams: string[]): null | Error;
+```
+
+## 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. |
+
+<b>Returns:</b>
+
+null \| Error
+
+{<!-- -->Error\|null<!-- -->}
+

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md)
+
+## VpcInstanceAuthenticator.(constructor)
+
+Create a new \[\[VpcInstanceAuthenticator\]\] instance.
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | Options | Configuration options for VpcInstance authentication. |
+

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

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md)
+
+## VpcInstanceAuthenticator.authenticationType() method
+
+Returns the authenticator's type ('vpc').
+
+<b>Signature:</b>
+
+```typescript
+authenticationType(): string;
+```
+<b>Returns:</b>
+
+string
+
+a string that indicates the authenticator's type
+

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

@@ -0,0 +1,39 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md)
+
+## VpcInstanceAuthenticator class
+
+The \[\[VpcInstanceAuthenticator\]\] implements an authentication scheme in which it retrieves an "instance identity token" and exchanges that for an IAM access token using the VPC Instance Metadata Service API which is available on the local compute resource (VM). The instance identity token is similar to an IAM apikey, except that it is managed automatically by the compute resource provider (VPC).
+
+The resulting IAM access token is then added to outbound requests in an Authorization header
+
+Authorization: Bearer <access-token>
+
+<b>Signature:</b>
+
+```typescript
+export declare class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator 
+```
+<b>Extends:</b> [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md) |  | Create a new \[\[VpcInstanceAuthenticator\]\] instance. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [tokenManager](./ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md) |  | [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) |  |
+
+## 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) |  | Setter for the "profile\_crn" parameter to use when fetching the bearer token from the IAM token server. |
+|  [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md) |  | Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server. |
+