ibm-cloud-sdk-core 4.3.3 → 5.0.1

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

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

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

@@ -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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md)
-
-## VpcInstanceTokenManager.(constructor)
-
-Create a new VpcInstanceTokenManager 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. This should be an object containing these fields: - url: (optional) the endpoint URL for the VPC Instance Metadata Service (default value: "http://169.254.169.254") - iamProfileCrn: (optional) the CRN of the linked IAM trusted profile to be used to obtain the IAM access token - iamProfileId: (optional) the ID of the linked IAM trusted profile to be used to obtain the IAM access token
-
-
-</td></tr>
-</tbody></table>
-
-## Remarks
-
-At most one of "iamProfileCrn" or "iamProfileId" may be specified. If neither one is specified, then the default IAM profile defined for the compute resource will be used.
-

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

@@ -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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [isTokenExpired](./ibm-cloud-sdk-core.vpcinstancetokenmanager.istokenexpired.md)
-
-## VpcInstanceTokenManager.isTokenExpired() method
-
-Returns true iff the currently-cached IAM access token is expired. We'll consider an access token as expired when we reach its IAM server-reported expiration time minus our expiration window (10 secs). We do this to avoid using an access token that might expire in the middle of a long-running transaction within an IBM Cloud service.
-
-**Signature:**
-
-```typescript
-protected isTokenExpired(): boolean;
-```
-**Returns:**
-
-boolean
-
-true if the token has expired, false otherwise
-

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

@@ -1,126 +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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md)
-
-## VpcInstanceTokenManager class
-
-Token Manager for VPC Instance Authentication.
-
-**Signature:**
-
-```typescript
-export declare class VpcInstanceTokenManager extends JwtTokenManager 
-```
-**Extends:** [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.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.vpcinstancetokenmanager._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Create a new VpcInstanceTokenManager instance.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[isTokenExpired()](./ibm-cloud-sdk-core.vpcinstancetokenmanager.istokenexpired.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-Returns true iff the currently-cached IAM access token is expired. We'll consider an access token as expired when we reach its IAM server-reported expiration time minus our expiration window (10 secs). We do this to avoid using an access token that might expire in the middle of a long-running transaction within an IBM Cloud service.
-
-
-</td></tr>
-<tr><td>
-
-[requestToken()](./ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[setIamProfileCrn(iamProfileCrn)](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Sets the CRN of the IAM trusted profile to use when fetching the access token from the IAM token server.
-
-
-</td></tr>
-<tr><td>
-
-[setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Sets the Id of the IAM trusted profile to use when fetching the access token from the IAM token server.
-
-
-</td></tr>
-</tbody></table>

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

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

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

@@ -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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [setIamProfileCrn](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md)
-
-## VpcInstanceTokenManager.setIamProfileCrn() method
-
-Sets the CRN of the IAM trusted profile to use when fetching the access token from the IAM token server.
-
-**Signature:**
-
-```typescript
-setIamProfileCrn(iamProfileCrn: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-iamProfileCrn
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-the CRN of the IAM trusted profile
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

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

@@ -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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [setIamProfileId](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md)
-
-## VpcInstanceTokenManager.setIamProfileId() method
-
-Sets the Id of the IAM trusted profile to use when fetching the access token from the IAM token server.
-
-**Signature:**
-
-```typescript
-setIamProfileId(iamProfileId: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-iamProfileId
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-the ID of the IAM trusted profile
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

package/build/docs/index.md

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

package/es/lib/sdk-test-helpers.browser.d.ts

@@ -1,21 +0,0 @@
-/**
- * Copyright 2021 IBM Corp. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
-export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
-export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
-export declare function checkForSuccessfulExecution(createRequestMock: any): void;
-export declare function getOptions(createRequestMock: any): void;
-export declare function expectToBePromise(sdkPromise: any): void;

package/es/lib/sdk-test-helpers.browser.js

@@ -1,23 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/**
- * Copyright 2021 IBM Corp. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-// Dummy for browser
-export function checkUrlAndMethod(options, url, method) { }
-export function checkMediaHeaders(createRequestMock, accept, contentType) { }
-export function checkUserHeader(createRequestMock, userHeaderName, userHeaderValue) { }
-export function checkForSuccessfulExecution(createRequestMock) { }
-export function getOptions(createRequestMock) { }
-export function expectToBePromise(sdkPromise) { }

package/es/lib/sdk-test-helpers.d.ts

@@ -1,72 +0,0 @@
-/**
- * (C) Copyright IBM Corp. 2019, 2022.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * This module provides a set of helper methods used to reduce code duplication in the generated unit tests
- * for the SDKs that depend on this core package. Note that these methods are not used by the tests for this
- * package - they are meant to be exported and made available to dependent libraries.
- */
-/**
- * Takes the request options constructed by the SDK and checks that the `url` and `method` properties
- * were set to their correct values.
- *
- * @param options - the options object put together by the SDK, retrieved from the createRequest mock
- * @param url - The URL path of the service endpoint, from the paths section of the API definition
- * @param method - The HTTP method for the request, from the API definition
- */
-export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
-/**
- * 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.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param accept - the expected value for the `Accept` header
- * @param contentType - the expected value for the `Content-Type` header
- */
-export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
-/**
- * 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.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
- * @param userHeaderValue - the expected value for the header passed by the user
- */
-export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
-/**
- * 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.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- */
-export declare function checkForSuccessfulExecution(createRequestMock: any): void;
-/**
- * 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.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @returns Object
- */
-export declare function getOptions(createRequestMock: any): any;
-/**
- * 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.
- *
- * @param sdkPromise - the Promise returned by an SDK method
- */
-export declare function expectToBePromise(sdkPromise: any): void;

package/es/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// 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.43.1"
-    }
-  ]
-}

package/lib/sdk-test-helpers.browser.d.ts

@@ -1,21 +0,0 @@
-/**
- * Copyright 2021 IBM Corp. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
-export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
-export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
-export declare function checkForSuccessfulExecution(createRequestMock: any): void;
-export declare function getOptions(createRequestMock: any): void;
-export declare function expectToBePromise(sdkPromise: any): void;

package/lib/sdk-test-helpers.browser.js

@@ -1,32 +0,0 @@
-"use strict";
-/* eslint-disable @typescript-eslint/no-unused-vars */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.expectToBePromise = exports.getOptions = exports.checkForSuccessfulExecution = exports.checkUserHeader = exports.checkMediaHeaders = exports.checkUrlAndMethod = void 0;
-/**
- * Copyright 2021 IBM Corp. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-// Dummy for browser
-function checkUrlAndMethod(options, url, method) { }
-exports.checkUrlAndMethod = checkUrlAndMethod;
-function checkMediaHeaders(createRequestMock, accept, contentType) { }
-exports.checkMediaHeaders = checkMediaHeaders;
-function checkUserHeader(createRequestMock, userHeaderName, userHeaderValue) { }
-exports.checkUserHeader = checkUserHeader;
-function checkForSuccessfulExecution(createRequestMock) { }
-exports.checkForSuccessfulExecution = checkForSuccessfulExecution;
-function getOptions(createRequestMock) { }
-exports.getOptions = getOptions;
-function expectToBePromise(sdkPromise) { }
-exports.expectToBePromise = expectToBePromise;

package/lib/sdk-test-helpers.d.ts

@@ -1,72 +0,0 @@
-/**
- * (C) Copyright IBM Corp. 2019, 2022.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * This module provides a set of helper methods used to reduce code duplication in the generated unit tests
- * for the SDKs that depend on this core package. Note that these methods are not used by the tests for this
- * package - they are meant to be exported and made available to dependent libraries.
- */
-/**
- * Takes the request options constructed by the SDK and checks that the `url` and `method` properties
- * were set to their correct values.
- *
- * @param options - the options object put together by the SDK, retrieved from the createRequest mock
- * @param url - The URL path of the service endpoint, from the paths section of the API definition
- * @param method - The HTTP method for the request, from the API definition
- */
-export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
-/**
- * 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.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param accept - the expected value for the `Accept` header
- * @param contentType - the expected value for the `Content-Type` header
- */
-export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
-/**
- * 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.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
- * @param userHeaderValue - the expected value for the header passed by the user
- */
-export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
-/**
- * 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.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- */
-export declare function checkForSuccessfulExecution(createRequestMock: any): void;
-/**
- * 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.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @returns Object
- */
-export declare function getOptions(createRequestMock: any): any;
-/**
- * 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.
- *
- * @param sdkPromise - the Promise returned by an SDK method
- */
-export declare function expectToBePromise(sdkPromise: any): void;