npm - ibm-cloud-sdk-core - Versions diffs - 5.1.2 → 5.1.3 - Mend

ibm-cloud-sdk-core 5.1.2 → 5.1.3

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 (246) hide show

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_container.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md)
-## Authenticator.AUTHTYPE\_CONTAINER property
-**Signature:**
-```typescript
-static AUTHTYPE_CONTAINER: string;
-```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_cp4d.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md)
-## Authenticator.AUTHTYPE\_CP4D property
-**Signature:**
-```typescript
-static AUTHTYPE_CP4D: string;
-```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_iam.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md)
-## Authenticator.AUTHTYPE\_IAM property
-**Signature:**
-```typescript
-static AUTHTYPE_IAM: string;
-```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_iam_assume.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_IAM\_ASSUME](./ibm-cloud-sdk-core.authenticator.authtype_iam_assume.md)
-## Authenticator.AUTHTYPE\_IAM\_ASSUME property
-**Signature:**
-```typescript
-static AUTHTYPE_IAM_ASSUME: string;
-```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_mcsp.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_MCSP](./ibm-cloud-sdk-core.authenticator.authtype_mcsp.md)
-## Authenticator.AUTHTYPE\_MCSP property
-**Signature:**
-```typescript
-static AUTHTYPE_MCSP: string;
-```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_noauth.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md)
-## Authenticator.AUTHTYPE\_NOAUTH property
-**Signature:**
-```typescript
-static AUTHTYPE_NOAUTH: string;
-```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_unknown.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_UNKNOWN](./ibm-cloud-sdk-core.authenticator.authtype_unknown.md)
-## Authenticator.AUTHTYPE\_UNKNOWN property
-**Signature:**
-```typescript
-static AUTHTYPE_UNKNOWN: string;
-```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_vpc.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_VPC](./ibm-cloud-sdk-core.authenticator.authtype_vpc.md)
-## Authenticator.AUTHTYPE\_VPC property
-**Signature:**
-```typescript
-static AUTHTYPE_VPC: string;
-```

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

@@ -1,313 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
-## Authenticator class
-Base Authenticator class for other Authenticators to extend. Not intended to be used as a stand-alone authenticator.
-**Signature:**
-```typescript
-export declare class Authenticator implements AuthenticatorInterface
-```
-**Implements:** [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)
-## Constructors
-<table><thead><tr><th>
-Constructor
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[(constructor)()](./ibm-cloud-sdk-core.authenticator._constructor_.md)
-</td><td>
-</td><td>
-Create a new Authenticator instance.
-</td></tr>
-</tbody></table>
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[AUTHTYPE\_BASIC](./ibm-cloud-sdk-core.authenticator.authtype_basic.md)
-</td><td>
-`static`
-</td><td>
-string
-</td><td>
-Constants that define the various authenticator types.
-</td></tr>
-<tr><td>
-[AUTHTYPE\_BEARERTOKEN](./ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md)
-</td><td>
-`static`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md)
-</td><td>
-`static`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md)
-</td><td>
-`static`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[AUTHTYPE\_IAM\_ASSUME](./ibm-cloud-sdk-core.authenticator.authtype_iam_assume.md)
-</td><td>
-`static`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md)
-</td><td>
-`static`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[AUTHTYPE\_MCSP](./ibm-cloud-sdk-core.authenticator.authtype_mcsp.md)
-</td><td>
-`static`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md)
-</td><td>
-`static`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[AUTHTYPE\_UNKNOWN](./ibm-cloud-sdk-core.authenticator.authtype_unknown.md)
-</td><td>
-`static`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[AUTHTYPE\_VPC](./ibm-cloud-sdk-core.authenticator.authtype_vpc.md)
-</td><td>
-`static`
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticator.authenticate.md)
-</td><td>
-</td><td>
-Augment the request with authentication information.
-</td></tr>
-<tr><td>
-[authenticationType()](./ibm-cloud-sdk-core.authenticator.authenticationtype.md)
-</td><td>
-</td><td>
-Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the &lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class.
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- 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; [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) &gt; [authenticate](./ibm-cloud-sdk-core.authenticatorinterface.authenticate.md)
-## AuthenticatorInterface.authenticate() method
-Add authentication information to the specified request.
-**Signature:**
-```typescript
-authenticate(requestOptions: AuthenticateOptions): Promise<void>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-requestOptions
-</td><td>
-AuthenticateOptions
-</td><td>
-The request to which authentication information is added (in the headers field).
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;void&gt;

package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md DELETED Viewed

@@ -1,17 +0,0 @@
-<!-- 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; [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) &gt; [authenticationType](./ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md)
-## AuthenticatorInterface.authenticationType() method
-Returns a string that indicates the authentication type.
-**Signature:**
-```typescript
-authenticationType(): string;
-```
-**Returns:**
-string

package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- 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; [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)
-## AuthenticatorInterface interface
-This interface defines the common methods associated with an Authenticator implementation.
-**Signature:**
-```typescript
-export interface AuthenticatorInterface
-```
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticatorinterface.authenticate.md)
-</td><td>
-Add authentication information to the specified request.
-</td></tr>
-<tr><td>
-[authenticationType()](./ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md)
-</td><td>
-Returns a string that indicates the authentication type.
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.baseservice._constructor_.md DELETED Viewed

@@ -1,49 +0,0 @@
-<!-- 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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [(constructor)](./ibm-cloud-sdk-core.baseservice._constructor_.md)
-## BaseService.(constructor)
-Configuration values for a service.
-**Signature:**
-```typescript
-constructor(userOptions: UserOptions);
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-userOptions
-</td><td>
-[UserOptions](./ibm-cloud-sdk-core.useroptions.md)
-</td><td>
-the configuration options to set on the service instance. This should be an object with the following fields: - authenticator: (required) an Object used to authenticate requests to the service. - serviceUrl: (optional) the base url to use when contacting the service. The base url may differ between IBM Cloud regions. - headers: (optional) a set of HTTP headers that should be included with every request sent to the service - disableSslVerification: (optional) a flag that indicates whether verification of the server's SSL certificate should be disabled or not.
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.baseservice.baseoptions.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- 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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [baseOptions](./ibm-cloud-sdk-core.baseservice.baseoptions.md)
-## BaseService.baseOptions property
-**Signature:**
-```typescript
-protected baseOptions: BaseServiceOptions;
-```

package/build/docs/ibm-cloud-sdk-core.baseservice.configureservice.md DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- 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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [configureService](./ibm-cloud-sdk-core.baseservice.configureservice.md)
-## BaseService.configureService() method
-Configure the service using external configuration
-**Signature:**
-```typescript
-protected configureService(serviceName: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-serviceName
-</td><td>
-string
-</td><td>
-the name of the service. This will be used to read from external configuration.
-</td></tr>
-</tbody></table>
-**Returns:**
-void