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

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. |
+

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.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; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [setIamProfileCrn](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md)
+
+## VpcInstanceAuthenticator.setIamProfileCrn() method
+
+Setter for the "profile\_crn" parameter to use when fetching the bearer token from the IAM token server.
+
+<b>Signature:</b>
+
+```typescript
+setIamProfileCrn(iamProfileCrn: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  iamProfileCrn | string |  |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.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; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [setIamProfileId](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md)
+
+## VpcInstanceAuthenticator.setIamProfileId() method
+
+Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server.
+
+<b>Signature:</b>
+
+```typescript
+setIamProfileId(iamProfileId: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  iamProfileId | string |  |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.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; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md)
+
+## VpcInstanceAuthenticator.tokenManager property
+
+<b>Signature:</b>
+
+```typescript
+protected tokenManager: VpcInstanceTokenManager;
+```

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager._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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md)
+
+## VpcInstanceTokenManager.(constructor)
+
+Create a new \[\[VpcInstanceTokenManager\]\] instance.
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | Options | Configuration options. |
+

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

@@ -0,0 +1,29 @@
+<!-- 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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md)
+
+## VpcInstanceTokenManager class
+
+Token Manager for VPC Instance Authentication.
+
+<b>Signature:</b>
+
+```typescript
+export declare class VpcInstanceTokenManager extends JwtTokenManager 
+```
+<b>Extends:</b> [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md) |  | Create a new \[\[VpcInstanceTokenManager\]\] instance. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [requestToken()](./ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md) |  |  |
+|  [setIamProfileCrn(iamProfileCrn)](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md) |  | Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server. |
+|  [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md) |  | Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server. |
+

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

@@ -0,0 +1,15 @@
+<!-- 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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [requestToken](./ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md)
+
+## VpcInstanceTokenManager.requestToken() method
+
+<b>Signature:</b>
+
+```typescript
+protected requestToken(): Promise<any>;
+```
+<b>Returns:</b>
+
+Promise&lt;any&gt;
+

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [setIamProfileCrn](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md)
+
+## VpcInstanceTokenManager.setIamProfileCrn() method
+
+Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server.
+
+<b>Signature:</b>
+
+```typescript
+setIamProfileCrn(iamProfileCrn: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  iamProfileCrn | string | A string that makes up the iamProfileCrn parameter |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [setIamProfileId](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md)
+
+## VpcInstanceTokenManager.setIamProfileId() method
+
+Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server.
+
+<b>Signature:</b>
+
+```typescript
+setIamProfileId(iamProfileId: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  iamProfileId | string | A string that makes up the iamProfileId parameter |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) |  |
+

package/es/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.20.0"
+    }
+  ]
+}