ibm-cloud-sdk-core 4.3.0 → 4.3.2-beta

package/LICENSE.md

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   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.

package/MIGRATION-V4.md

@@ -1,54 +0,0 @@
-# Migration Guide for v4
-
-## Breaking Changes
-
-### Node Version
-Node version 12 is no longer supported - 14 is the minimum version supported.
-
-### TypeScript Version
-The `typescript` development dependnecy is now required to be at least version 4.
-
-Run `npm install -D typescript@4` to upgrade to version 4.
-
-Code produced by the IBM OpenAPI SDK Generator should already be compliant with TypeScript v4.
-
-Additionally, you may need to upgrade `@typescript-eslint/eslint-plugin` and `@typescript-eslint/parser` to
-v5 to be compatible with the new version of TypeScript. This upgrade should be safe and compatible.
-
-Run `npm i -D '@typescript-eslint/eslint-plugin@latest' '@typescript-eslint/parser@latest'` to upgrade.
-
-### Jest Version
-The `jest` development dependency is now required to be at least version 29.
-
-Run `npm install -D jest@29` to upgrade to version 29.
-
-Code produced by the IBM OpenAPI Generator should already be compliant with Jest v29.
-
-Note: Ensure your test code does not contain the anti-pattern of using a `done` callback with an `async` function.
-This is no longer permitted in Jest 29, whereas it was discouraged but permitted in previous versions. An old version of the IBM OpenAPI SDK Generator included a bug that generated this pattern. If your generated test code has not been updated since then, you may run into this issue.
-
-Example diff showing proper resolution:
-```
-diff --git a/test/integration/example.v1.test.js b/test/integration/example.v1.test.js
-index be0bec3..62f03f8 100644
---- a/test/integration/example.v1.test.js
-+++ b/test/integration/example.v1.test.js
-@@ -38,7 +38,7 @@ describe('ExampleV1_integration', () => {
-   jest.setTimeout(timeout);
-   let example;
- 
--  beforeAll(async (done) => {
-+  beforeAll(async () => {
-     example = ExampleV1.newInstance({});
- 
-     const config = readExternalSources(ExampleV1.DEFAULT_SERVICE_NAME);
-@@ -58,8 +58,6 @@ describe('ExampleV1_integration', () => {
- 
-     log(`Service URL: ${example.baseOptions.serviceUrl}`);
-     log('Finished setup.');
--
--    done();
-   });
- 
-   test('getSomething()', async () => {
-```

package/README.md

@@ -1,118 +0,0 @@
-[![Build Status](https://app.travis-ci.com/IBM/node-sdk-core.svg?branch=main)](https://app.travis-ci.com/IBM/node-sdk-core)
-[![npm-version](https://img.shields.io/npm/v/ibm-cloud-sdk-core.svg)](https://www.npmjs.com/package/ibm-cloud-sdk-core)
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
-[![CLA assistant](https://cla-assistant.io/readme/badge/ibm/node-sdk-core)](https://cla-assistant.io/ibm/node-sdk-core)
-
-# IBM Node.js SDK Core
-This project contains core functionality required by Node.js code generated by the IBM Cloud OpenAPI SDK Generator
-(openapi-sdkgen).
-
-## Installation
-```bash
-`npm install ibm-cloud-sdk-core`
-```
-
-## Prerequisites
-- Node.js version 14 or newer
-- Note that v14 is technically *supported* but not officially *guaranteed* as we only test on v16 and higher
-
-## Usage
-This package exports a single object containing a number of modules as top level properties.
-
-Example:
-```js
-// this is TypeScript, since the `openapi-sdkgen` project generates TypeScript
-import { BaseService } from 'ibm-cloud-sdk-core';
-
-class YourSDK extends BaseService { ... }
-```
-
-## Authentication
-The node-sdk-core project supports the following types of authentication:
-- Basic Authentication
-- Bearer Token Authentication
-- Identity and Access Management (IAM) Authentication
-- Container Authentication
-- VPC Instance Authentication
-- Cloud Pak for Data Authentication
-- No Authentication (for testing)
-
-There are two ways to create an authenticator:
-1. Creating an instance and providing credentials programmatically
-2. Using the `getAuthenticatorFromEnvironment` function to create an authenticator from externally-provided configuration
-
-For more information about the various authentication types and how to use them with your services, click [here](Authentication.md).
-
-### Examples
-
-#### Programmatic
-```js
-import { IamAuthenticator } from 'ibm-cloud-sdk-core';
-
-const authenticator = new IamAuthenticator({
-  apikey: '{apikey}',
-});
-```
-
-#### External configuration
-```js
-import { getAuthenticatorFromEnvironment } from 'ibm-cloud-sdk-core';
-
-// env vars
-// MY_SERVICE_AUTH_TYPE=iam
-// MY_SERVICE_APIKEY=<apikey>
-const iamAuthenticator = getAuthenticatorFromEnvironment('my-service');
-```
-
-## Logging
-This package uses [debug](https://www.npmjs.com/package/debug) for logging.
-
-- Logging is disabled by default.
-- Logging has been configured to use log levels which are assumed to be numerically ascending from most important to least important.
-- In order to see the log output, set the environment variable ``DEBUG`` including the desired log level.
-  - ```DEBUG=ibm-cloud-sdk-core:error``` enables error logs
-  - ```DEBUG=ibm-cloud-sdk-core:warning``` enables warning logs and below
-  - ```DEBUG=ibm-cloud-sdk-core:info``` enables info logs and below
-  - ```DEBUG=ibm-cloud-sdk-core:verbose``` enables verbose logs and below
-  - ```DEBUG=ibm-cloud-sdk-core:debug``` enables debug logs and below
-
-To see the output from all of the debugging levels you can use:
-
-``DEBUG=ibm-cloud-sdk-core*``
-
-The debug logger can be configured to be used for more than one library. In example, you can set a comma-separated string:
-
-``DEBUG=ibm-cloud-sdk-core:debug,other-lib:debug``
-
-## Cookie Jar Support
-By default, cookies are not supported in the SDK requests.  If your SDK would benefit from this functionality, simply edit your code to instantiate a cookie jar (or instruct your users to do so) and pass it in the object containing configuration options to the `BaseService` class, as shown below. If the Boolean value `true` is given for the `jar` field, the SDK core will create a default instance of a [Tough Cookie](https://www.npmjs.com/package/tough-cookie).
-
-```ts
-import tough = require('tough-cookie');
-
-class MyClass extends BaseService {
-  constructor(options: MyOptions) {
-    // pass the cookie jar object or simply pass the value `true`
-    // and a tough-cookie instance will be created by default
-    options.jar = new tough.CookieJar();
-    super(options);
-  }
-}
-```
-
-## Issues
-If you encounter an issue with this project, you are welcome to submit a [bug report](https://github.com/IBM/node-sdk-core/issues).
-Before opening a new issue, please search for similar issues. It's possible that someone has already reported it.
-
-## Tests
-Run all test suites:
-```bash
-npm test
-```
-
-## Contributing
-See [CONTRIBUTING](CONTRIBUTING.md).
-
-## License
-This library is licensed under Apache 2.0. Full license text is
-available in [LICENSE](LICENSE.md).

package/api-extractor.json

@@ -1,39 +0,0 @@
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "mainEntryPointFilePath": "<projectFolder>/dist/es/index.d.ts",
-  "bundledPackages": [],
-  "apiReport": {
-    "enabled": true
-  },
-  "docModel": {
-    "enabled": true
-  },
-  "dtsRollup": {
-    "enabled": true
-  },
-  "tsdocMetadata": {
-    "enabled": true
-  },
-  "messages": {
-    "compilerMessageReporting": {
-      "default": {
-        "logLevel": "warning"
-      }
-    },
-
-    "extractorMessageReporting": {
-      "default": {
-        "logLevel": "warning"
-      },
-      "ae-missing-release-tag": {
-        "logLevel": "none"
-      }
-    },
-
-    "tsdocMessageReporting": {
-      "default": {
-        "logLevel": "warning"
-      }
-    }
-  }
-}

package/appscan-config.xml

@@ -1,8 +0,0 @@
-<Configuration>
-  <Targets>
-    <Target path=".">
-      <Exclude>scripts/</Exclude>
-      <Exclude>test/</Exclude>
-    </Target>
-  </Targets>
-</Configuration>

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

@@ -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; [atLeastOne](./ibm-cloud-sdk-core.atleastone.md)
-
-## atLeastOne() function
-
-Checks for at least one of two elements being defined.
-
-**Signature:**
-
-```typescript
-export declare function atLeastOne(a: any, b: any): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-a
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-the first object
-
-
-</td></tr>
-<tr><td>
-
-b
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-the second object
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-boolean
-
-true if a or b is defined; false if both are undefined
-

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

@@ -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; [atMostOne](./ibm-cloud-sdk-core.atmostone.md)
-
-## atMostOne() function
-
-Verifies that both properties are not specified.
-
-**Signature:**
-
-```typescript
-export declare function atMostOne(a: any, b: any): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-a
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-The first object
-
-
-</td></tr>
-<tr><td>
-
-b
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-The second object
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-boolean
-
-false if a and b are both defined, true otherwise
-

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

@@ -1,18 +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; [(constructor)](./ibm-cloud-sdk-core.authenticator._constructor_.md)
-
-## Authenticator.(constructor)
-
-Create a new Authenticator instance.
-
-**Signature:**
-
-```typescript
-constructor();
-```
-
-## Exceptions
-
-Error: the "new" keyword was not used to construct the authenticator.
-

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

@@ -1,57 +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; [authenticate](./ibm-cloud-sdk-core.authenticator.authenticate.md)
-
-## Authenticator.authenticate() method
-
-Augment the request with authentication information.
-
-**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 augment with authentication information.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-Promise&lt;void&gt;
-
-## Exceptions
-
-Error: The authenticate method was not implemented by a subclass.
-

package/build/docs/ibm-cloud-sdk-core.authenticator.authenticationtype.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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.authenticator.authenticationtype.md)
-
-## Authenticator.authenticationType() method
-
-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.
-
-**Signature:**
-
-```typescript
-authenticationType(): string;
-```
-**Returns:**
-
-string
-
-a string that indicates the authenticator's type
-

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

@@ -1,13 +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\_BASIC](./ibm-cloud-sdk-core.authenticator.authtype_basic.md)
-
-## Authenticator.AUTHTYPE\_BASIC property
-
-Constants that define the various authenticator types.
-
-**Signature:**
-
-```typescript
-static AUTHTYPE_BASIC: string;
-```