npm - ibm-cloud-sdk-core - Versions diffs - 5.0.0 → 5.0.1 - Mend

ibm-cloud-sdk-core 5.0.0 → 5.0.1

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

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

@@ -1,19 +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; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md)
-## CloudPakForDataAuthenticator.authenticationType() method
-Returns the authenticator's type ('cp4d').
-**Signature:**
-```typescript
-authenticationType(): string;
-```
-**Returns:**
-string
-a string that indicates the authenticator's type

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

@@ -1,149 +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; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md)
-## CloudPakForDataAuthenticator class
-The CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server.
-The bearer token will be sent as an Authorization header in the form:
-Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
-**Signature:**
-```typescript
-export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator
-```
-**Extends:** [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
-## Constructors
-<table><thead><tr><th>
-Constructor
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[(constructor)(options)](./ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md)
-</td><td>
-</td><td>
-Create a new CloudPakForDataAuthenticator 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>
-[requiredOptions](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md)
-</td><td>
-`protected`
-</td><td>
-string\[\]
-</td><td>
-</td></tr>
-<tr><td>
-[tokenManager](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md)
-</td><td>
-`protected`
-</td><td>
-[Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md)
-</td><td>
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[authenticationType()](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md)
-</td><td>
-</td><td>
-Returns the authenticator's type ('cp4d').
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.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; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) &gt; [requiredOptions](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md)
-## CloudPakForDataAuthenticator.requiredOptions property
-**Signature:**
-```typescript
-protected requiredOptions: string[];
-```

package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.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; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md)
-## CloudPakForDataAuthenticator.tokenManager property
-**Signature:**
-```typescript
-protected tokenManager: Cp4dTokenManager;
-```

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

@@ -1,71 +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; [computeBasicAuthHeader](./ibm-cloud-sdk-core.computebasicauthheader.md)
-## computeBasicAuthHeader() function
-Compute and return a Basic Authorization header from a username and password.
-**Signature:**
-```typescript
-export declare function computeBasicAuthHeader(username: string, password: string): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-username
-</td><td>
-string
-</td><td>
-The username or client id
-</td></tr>
-<tr><td>
-password
-</td><td>
-string
-</td><td>
-The password or client secret
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-a Basic Auth header with format "Basic <encoded-credentials>"

package/build/docs/ibm-cloud-sdk-core.constructfilepath.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; [constructFilepath](./ibm-cloud-sdk-core.constructfilepath.md)
-## constructFilepath() function
-**Signature:**
-```typescript
-export declare function constructFilepath(filepath: string): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-filepath
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-string

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

@@ -1,87 +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; [constructServiceUrl](./ibm-cloud-sdk-core.constructserviceurl.md)
-## constructServiceUrl() function
-Constructs a service URL by formatting a parameterized URL.
-**Signature:**
-```typescript
-export declare function constructServiceUrl(parameterizedUrl: string, defaultUrlVariables: Map<string, string>, providedUrlVariables: Map<string, string> | null): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-parameterizedUrl
-</td><td>
-string
-</td><td>
-a URL that contains variable placeholders, e.g. '<!-- -->{<!-- -->scheme<!-- -->}<!-- -->://ibm.com'.
-</td></tr>
-<tr><td>
-defaultUrlVariables
-</td><td>
-Map&lt;string, string&gt;
-</td><td>
-a Map of variable names to default values. Each variable in the parameterized URL must have a default value specified in this map.
-</td></tr>
-<tr><td>
-providedUrlVariables
-</td><td>
-Map&lt;string, string&gt; \| null
-</td><td>
-a Map of variable names to desired values. If a variable is not provided in this map, the default variable value will be used instead.
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-the formatted URL with all variable placeholders replaced by values.

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

@@ -1,54 +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; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.containerauthenticator._constructor_.md)
-## ContainerAuthenticator.(constructor)
-Create a new ContainerAuthenticator instance.
-**Signature:**
-```typescript
-constructor(options: Options);
-```
-## Parameters
-<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 IAM authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - crTokenFilename: (optional) the file containing the compute resource token - iamProfileName: (optional) the name of the IAM trusted profile associated with the compute resource token (required if iamProfileId is not specified) - iamProfileId\]: (optional) the ID of the IAM trusted profile associated with the compute resource token (required if iamProfileName is not specified) - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
-</td></tr>
-</tbody></table>
-## Exceptions
-Error: the configuration options are not valid.

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

@@ -1,19 +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; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.containerauthenticator.authenticationtype.md)
-## ContainerAuthenticator.authenticationType() method
-Returns the authenticator's type ('container').
-**Signature:**
-```typescript
-authenticationType(): string;
-```
-**Returns:**
-string
-a string that indicates the authenticator's type

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

@@ -1,172 +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; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md)
-## ContainerAuthenticator class
-The ContainerAuthenticator will read a compute resource token from the file system and use this value to obtain a bearer token from the IAM token server. When the bearer token expires, a new token is obtained from the token server.
-The bearer token will be sent as an Authorization header in the form:
-Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
-**Signature:**
-```typescript
-export declare class ContainerAuthenticator extends IamRequestBasedAuthenticator
-```
-**Extends:** [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md)
-## Constructors
-<table><thead><tr><th>
-Constructor
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[(constructor)(options)](./ibm-cloud-sdk-core.containerauthenticator._constructor_.md)
-</td><td>
-</td><td>
-Create a new ContainerAuthenticator 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>
-[tokenManager](./ibm-cloud-sdk-core.containerauthenticator.tokenmanager.md)
-</td><td>
-`protected`
-</td><td>
-[ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md)
-</td><td>
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[authenticationType()](./ibm-cloud-sdk-core.containerauthenticator.authenticationtype.md)
-</td><td>
-</td><td>
-Returns the authenticator's type ('container').
-</td></tr>
-<tr><td>
-[setCrTokenFilename(crTokenFilename)](./ibm-cloud-sdk-core.containerauthenticator.setcrtokenfilename.md)
-</td><td>
-</td><td>
-Setter for the filename of the compute resource token.
-</td></tr>
-<tr><td>
-[setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.containerauthenticator.setiamprofileid.md)
-</td><td>
-</td><td>
-Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server.
-</td></tr>
-<tr><td>
-[setIamProfileName(iamProfileName)](./ibm-cloud-sdk-core.containerauthenticator.setiamprofilename.md)
-</td><td>
-</td><td>
-Setter for the "profile\_name" parameter to use when fetching the bearer token from the IAM token server.
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setcrtokenfilename.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; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) &gt; [setCrTokenFilename](./ibm-cloud-sdk-core.containerauthenticator.setcrtokenfilename.md)
-## ContainerAuthenticator.setCrTokenFilename() method
-Setter for the filename of the compute resource token.
-**Signature:**
-```typescript
-setCrTokenFilename(crTokenFilename: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-crTokenFilename
-</td><td>
-string
-</td><td>
-A string containing a path to the CR token file
-</td></tr>
-</tbody></table>
-**Returns:**
-void