ibm-cloud-sdk-core 4.0.0 → 4.0.2

package/temp/ibm-cloud-sdk-core.api.md

@@ -86,7 +86,7 @@ export class BasicAuthenticator extends Authenticator {
 
 // @public
 export class BearerTokenAuthenticator extends Authenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_2" needs to be exported by the entry point index.d.ts
     constructor(options: Options_2);
     authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     authenticationType(): string;
@@ -115,7 +115,7 @@ function checkUserHeader(createRequestMock: any, userHeaderName: string, userHea
 
 // @public
 export class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_4" needs to be exported by the entry point index.d.ts
     constructor(options: Options_4);
     authenticationType(): string;
     // (undocumented)
@@ -135,7 +135,7 @@ export function constructServiceUrl(parameterizedUrl: string, defaultUrlVariable
 
 // @public
 export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_8" needs to be exported by the entry point index.d.ts
     constructor(options: Options_8);
     authenticationType(): string;
     setCrTokenFilename(crTokenFilename: string): void;
@@ -147,7 +147,7 @@ export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
 
 // @public
 export class ContainerTokenManager extends IamRequestBasedTokenManager {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_7" needs to be exported by the entry point index.d.ts
     constructor(options: Options_7);
     protected requestToken(): Promise<any>;
     setCrTokenFilename(crTokenFilename: string): void;
@@ -163,7 +163,7 @@ export const contentType: {
 
 // @public
 export class Cp4dTokenManager extends JwtTokenManager {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_3" needs to be exported by the entry point index.d.ts
     constructor(options: Options_3);
     // (undocumented)
     protected requestToken(): Promise<any>;
@@ -239,7 +239,7 @@ export function getQueryParam(urlStr: string, param: string): string;
 
 // @public
 export class IamAuthenticator extends IamRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_6" needs to be exported by the entry point index.d.ts
     constructor(options: Options_6);
     authenticationType(): string;
     // (undocumented)
@@ -250,7 +250,7 @@ export class IamAuthenticator extends IamRequestBasedAuthenticator {
 
 // @public
 export class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "IamRequestOptions" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "IamRequestOptions_2" needs to be exported by the entry point index.d.ts
     constructor(options: IamRequestOptions_2);
     // (undocumented)
     protected clientId: string;
@@ -291,7 +291,7 @@ export interface IamRequestOptions extends JwtTokenManagerOptions {
 
 // @public
 export class IamTokenManager extends IamRequestBasedTokenManager {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_5" needs to be exported by the entry point index.d.ts
     constructor(options: Options_5);
     // (undocumented)
     protected requiredOptions: string[];
@@ -367,7 +367,7 @@ export interface SDKLogger {
 // @public
 export function streamToPromise(stream: Stream): Promise<any>;
 
-// @public (undocumented)
+// @public
 export function stripTrailingSlash(url: string): string;
 
 // @public
@@ -449,7 +449,7 @@ export interface UserOptions {
     version?: string;
 }
 
-// @public (undocumented)
+// @public
 export function validateInput(options: any, requiredOptions: string[]): void;
 
 // @public
@@ -459,7 +459,7 @@ export function validateParams(params: {
 
 // @public
 export class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_10" needs to be exported by the entry point index.d.ts
     constructor(options: Options_10);
     authenticationType(): string;
     setIamProfileCrn(iamProfileCrn: string): void;
@@ -470,7 +470,7 @@ export class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator {
 
 // @public
 export class VpcInstanceTokenManager extends JwtTokenManager {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_9" needs to be exported by the entry point index.d.ts
     constructor(options: Options_9);
     // (undocumented)
     protected requestToken(): Promise<any>;

package/MIGRATION-V1.md

@@ -1,42 +0,0 @@
-# Migration Guide for v1
-
-## Breaking Changes
-
-### Node Versions
-Node versions 6 and 8 are no longer supported.
-
-### Promises replaced callbacks
-None of the methods in any modules of the core accept callbacks as arguments anymore. Now, all asynchronous methods (inlcuding all `authenticate` methods) return Promises.
-
-### Callback arguments
-The old callback argument structure of `(error, body, response)` has been changed to `(error, response)`. The body is available under the `result` property of the response. The `data` property has been removed in favor of `result`.
-
-### Authentication
-Credentials are no longer passed in as constructor parameters. Rather, a single `Authenticator` is instantiated and passed in to the constructor. Example:
-
-```js
-const authenticator = new IamAuthenticator({
-  apikey: 'abc-123',
-});
-
-const service = new MyService({
-  authenticator,
-});
-```
-
-- The method `getServiceCredentials` has been removed from the `BaseService` class. This is replaced by `getAuthenticator`, which returns the authenticator instance.
-- Reading credentials from external sources (like environment variables) no longer happens for _credentials_ by default if none are passed to the `Authenticator` (The service URL can still be read automatically). The method `getAuthenticatorFromEnvironment` will return an `Authenticator` by reading from the external sources.
-  - Note that this method will only read from _one external source at a time_. It will not combine credentials from multiple sources, which was the behavior previously.
-
-#### Token Managers
-- `Icp4dTokenManagerV1` renamed to `Cp4dTokenManager`
-- `IamTokenManagerV1` renamed to `IamTokenManager`
-- `JwtTokenManagerV1` renamed to `JwtTokenManager`
-- Token managers no longer support the `accessToken` parameter. There is no need for a token manager when a user is managing their own token. This behavior is replaced by the `BearerTokenAuthenticator` class.
-- In the IAM Token Manager: the method `setAuthorizationInfo` is renamed to `setClientIdAndSecret`
-
-#### URL parameter name changed
-The variable name for the stored, URL parameter has been changed from `url` to `serviceUrl`. Note that `url` can still be compatibility passed into the constructor as an alias for `serviceUrl`. However, if you try to access the `url` property directly in your code, this is a breaking change.
-
-#### Reading Credentials File
-The order of priority has changed to give a file in the current working directory higher priority than one in the home directory. This will only impact your code if you have different files in each location.