emissions-api-sdk 1.0.0

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the [project team](./MAINTAINERS.md). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

package/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+## Contributing In General
+Our project welcomes external contributions. If you have an itch, please feel
+free to scratch it.
+
+To contribute notebooks or documentation, please submit a [pull request](https://github.com/IBM/ibm-envizi-emissions-api-nodejs-sdk/pulls).
+
+A good way to familiarize yourself with the notebooks and contribution process is
+to look for an issue in the [issue tracker](https://github.com/IBM/ibm-envizi-emissions-api-nodejs-sdk/issues).
+
+Before embarking on a more ambitious contribution, please [raise an issue](https://github.com/IBM/ibm-envizi-emissions-api-nodejs-sdk/issues).
+
+**Note: We appreciate your effort, and want to avoid a situation where a contribution
+requires extensive rework (by you or by us), sits in backlog for a long time, or
+cannot be accepted at all!**
+
+### Proposing new features
+
+If you would like to add a new notebook, please [raise an issue](https://github.com/IBM/ibm-envizi-emissions-api-nodejs-sdk/issues)
+before sending a pull request so the contribution can be discussed. 
+
+### Fixing bugs
+
+If you would like to fix a bug, please [raise an issue](https://github.com/IBM/ibm-envizi-emissions-api-nodejs-sdk/issues) before sending a
+pull request so it can be tracked.
+
+### Merge approval
+
+The project maintainers use LGTM (Looks Good To Me) in comments on the code
+review to indicate acceptance. A change requires a LGTM from a repository maintainer
+or from a notebook maintainer (in the area of the contribution).
+
+For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page.
+
+## Legal
+
+Each source file must include a license header for the Apache
+Software License 2.0. Using the SPDX format is the simplest approach.
+e.g.
+
+```
+/*
+Copyright <holder> All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+```
+
+We have tried to make it as easy as possible to make contributions. This
+applies to how we handle the legal aspects of contribution. We use the
+same approach - the [Developer's Certificate of Origin 1.1 (DCO)](https://github.com/hyperledger/fabric/blob/master/docs/source/DCO1.1.txt) - that the Linux® Kernel [community](https://elinux.org/Developer_Certificate_Of_Origin)
+uses to manage code contributions.
+
+We simply ask that when submitting a patch for review, the developer
+must include a sign-off statement in the commit message.
+
+Here is an example Signed-off-by line, which indicates that the
+submitter accepts the DCO:
+
+```
+Signed-off-by: John Doe <john.doe@example.com>
+```
+
+You can include this automatically when you commit a change to your
+local git repository using the following command:
+
+```
+git commit -s
+```

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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/MAINTAINERS.md

@@ -0,0 +1,10 @@
+# MAINTAINERS
+
+This project relates to [IBM Envizi - Emissions API](https://www.ibm.com/products/envizi)- maintained by IBM Software.
+
+Repository Maintainers:
+- Steffan J. Taylor (taylorsteffanj)
+- Santhosh Ramalingam T (santhosh0703)
+- Prakhar Sahu (prakhar-sahu)
+
+

package/README.md

@@ -0,0 +1,89 @@
+# IBM Envizi - Emissions API Node.js SDK
+
+IBM Envizi - Emissions API (Emissions API) is a managed factor database and calculation engine for embedding greenhouse gas (GHG) emissions calculations into operational decision making.
+
+The `emissions-api-sdk` is a Node.js SDK for using Emissions API in your projects.
+
+## Sign up for the Preview
+
+To get started with the Emissions API follow these steps:
+
+- Sign up for the preview waitlist [IBMid sign up](https://www.ibm.com/account/reg/us-en/signup?formid=urx-53659) page.
+- You will be sent an invite email to join to create an account.
+- Read the [Introduction](https://developer.ibm.com/apis/catalog/ghgemissions--ibm-envizi-emissions-api/Introduction) page to get an overview of the Emissions API.
+
+## Installation
+
+```bash
+npm install emissions-api-sdk
+# or
+yarn install emissions-api-sdk
+```
+
+## Quick Start
+
+```javascript
+import { Client, Location } from 'emissions-api-sdk';
+
+// Initialize client
+await Client.getClient({
+  apiKey: process.env.ENVIZI_API_KEY,
+  clientId: process.env.ENVIZI_CLIENT_ID,
+  orgId: process.env.ENVIZI_ORG_ID
+});
+
+// Calculate emissions
+const result = await Location.calculate({
+  "location": {
+    "country": "USA",
+    "stateProvince": "california"
+  },
+  "activity": {
+    "type": "electricity",
+    "value": 1,
+    "unit": "kWh"
+  }
+});
+```
+
+## Authentication
+
+The SDK supports two authentication methods:
+
+### API Key (Recommended)
+
+```javascript
+await Client.getClient({
+  apiKey: process.env.ENVIZI_API_KEY,
+  clientId: process.env.ENVIZI_CLIENT_ID,
+  orgId: process.env.ENVIZI_ORG_ID
+});
+```
+
+### Pre-generated Token
+
+```javascript
+await Client.getClient({
+  token: process.env.JWT_TOKEN,
+  clientId: process.env.ENVIZI_CLIENT_ID
+});
+```
+
+## Documentation
+
+For detailed [documentation](https://ibm.github.io/ibm-envizi-emissions-api-nodejs-sdk/), see:
+
+- [Getting Started](https://ibm.github.io/ibm-envizi-emissions-api-nodejs-sdk/getting_started.html)
+- [Authentication](https://ibm.github.io/ibm-envizi-emissions-api-nodejs-sdk/authentication.html)
+- [Client Configuration](https://ibm.github.io/ibm-envizi-emissions-api-nodejs-sdk/client.html)
+- [API Reference](https://ibm.github.io/ibm-envizi-emissions-api-nodejs-sdk/reference.html)
+
+Other resources:
+
+- [APIHub](https://developer.ibm.com/apis/catalog/ghgemissions--ibm-envizi-emissions-api/api/API--ghgemissions--authentication) - API documentation (OpenAPI)
+- [Tutorials & Sample Applications](https://ibm.github.io/ibm-envizi-emissions-api/)
+- [IBM Envizi for Excel](https://ibm.github.io/ibm-envizi-emissions-api-excel-addin) - Emissions API Excel Add-in.
+
+## License
+
+This project is licensed under the terms of the [LICENSE](LICENSE) file.

package/dist/Client.js

@@ -0,0 +1,227 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const axios_1 = __importDefault(require("axios"));
+const utils_1 = require("./utils");
+const Constants_1 = require("./Constants");
+class Client {
+    constructor(token, config, isUserProvidedToken = false) {
+        const { apiKey = "", clientId, orgId = "", host, authUrl, isExcelAddIn = false } = config;
+        this.token = token;
+        this.clientId = clientId;
+        if (isUserProvidedToken) {
+            this.apiKey = "";
+            this.orgId = "";
+        }
+        else {
+            this.apiKey = apiKey;
+            this.orgId = orgId;
+        }
+        const exp = (0, utils_1.findExpiryTime)(token);
+        this.expiresAt = exp;
+        this.domain = host !== null && host !== void 0 ? host : Constants_1.API_DOMAIN;
+        this.tokenDomain = authUrl !== null && authUrl !== void 0 ? authUrl : Constants_1.TOKEN_GENERATION_API;
+        this.isUserProvidedToken = isUserProvidedToken;
+        this.clientSource = isExcelAddIn === true ? Constants_1.CLIENT_SOURCE_EXCEL : Constants_1.CLIENT_SOURCE_SDK;
+    }
+    /**
+     * Initializes and returns a Client instance with the provided configuration.
+     *
+     * @static
+     * @param {ClientConfig} config - The client configuration object
+     * @return {Promise<void>} A promise that resolves when the client is initialized
+     * @throws {Error} Throws an error if:
+     *  - custom "host" is provided without "authUrl"
+     *  - token is provided without "clientId"
+     *  - apiKey is provided without "clientId" or "orgId"
+     *
+     * @example
+     * // Initialize with authentication URL
+     * await Client.getClient({
+     *   host: 'https://api.example.com',
+     *   authUrl: 'https://auth.example.com',
+     *   clientId: 'client123',
+     *   orgId: 'org456'
+     * });
+     *
+     * // Initialize with existing token
+     * await Client.getClient({
+     *   token: 'existing-jwt-token',
+     *   clientId: 'client123'
+     * });
+     *
+     * // Initialize with API key
+     * await Client.getClient({
+     *   apiKey: 'your-api-key',
+     *   clientId: 'client123',
+     *   orgId: 'org456'
+     * });
+     */
+    static async getClient(config) {
+        if (config.host && !config.authUrl) {
+            throw new Error('If custom "host" is provided, "authUrl" must also be provided.');
+        }
+        if (config.token && !config.clientId) {
+            throw new Error('If token is provided directly, "clientId" must also be provided.');
+        }
+        if (config.apiKey && (!config.orgId || !config.clientId)) {
+            throw new Error('If apiKey is provided , "clientId" and "OrgId" must also be provided.');
+        }
+        let token;
+        let isUserProvidedToken = false;
+        if (config.token && config.clientId) {
+            token = config.token;
+            isUserProvidedToken = true;
+        }
+        else
+            token = await Client.requestToken(config);
+        Client.instance = new Client(token, config, isUserProvidedToken);
+    }
+    /**
+     * Returns the domain URL configured for the client.
+     *
+     * @return {string} The domain URL string
+     *
+     * @example
+     * const client = Client.getInstance();
+     * const apiDomain = client.getDomain();
+     * console.log(apiDomain); // e.g., 'https://api.example.com'
+     */
+    getDomain() {
+        return this.domain;
+    }
+    /**
+     * Returns the singleton instance of the Client.
+     *
+     * @static
+     * @return {Client} The singleton Client instance
+     * @throws {Error} Throws an error if the Client has not been initialized with getClient()
+     *
+     * @example
+     * // First initialize the client
+     * await Client.getClient({
+     *   clientId: 'client123',
+     *   orgId: 'org456'
+     * });
+     *
+     * // Then get the instance
+     * const client = Client.getInstance();
+     * // Use the client...
+     */
+    static getInstance() {
+        if (!Client.instance) {
+            throw new Error("Client is not initialized. Call Client.getClient() first.");
+        }
+        return Client.instance;
+    }
+    /**
+     * Refreshes the authentication token if it's about to expire.
+     * Only refreshes if the token was not provided by the user and is expiring within 60 seconds.
+     *
+     * @return {Promise<void>} A promise that resolves when the token refresh is complete
+     *
+     * @example
+     * const client = Client.getInstance();
+     * // Ensure token is fresh before making API requests
+     * await client.refreshToken();
+     * // Proceed with API requests...
+     */
+    async refreshToken() {
+        if (!this.isUserProvidedToken) {
+            const now = Math.floor(Date.now() / 1000);
+            if (this.expiresAt - now < 60) {
+                console.log("[SDK] Refreshing token...");
+                const token = await Client.requestToken({
+                    apiKey: this.apiKey,
+                    clientId: this.clientId,
+                    orgId: this.orgId,
+                    authUrl: this.tokenDomain,
+                });
+                this.token = token;
+                this.expiresAt = (0, utils_1.findExpiryTime)(token);
+            }
+        }
+    }
+    /**
+     * Returns the authorization header object with the Bearer token.
+     *
+     * @return {Record<string, string>} An object containing the Authorization header with the Bearer token
+     *
+     * @example
+     * const client = Client.getInstance();
+     * const headers = {
+     *   'Content-Type': 'application/json',
+     *   ...client.getAuthHeader()
+     * };
+     * // headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer token...' }
+     */
+    getAuthHeader() {
+        return { Authorization: `Bearer ${this.token}` };
+    }
+    /**
+     * Returns the client ID configured for this client instance.
+     *
+     * @return {string} The client ID string
+     *
+     * @example
+     * const client = Client.getInstance();
+     * const clientId = client.getClientId();
+     * console.log(clientId); // e.g., 'client123'
+     */
+    getClientId() {
+        return this.clientId;
+    }
+    /**
+     * Returns the client source identifier for this client instance.
+     *
+     * @return {string} The client source string
+     *
+     * @example
+     * const client = Client.getInstance();
+     * const source = client.getClientSource();
+     * console.log(source); // e.g., 'web', 'mobile', 'sdk'
+     */
+    getClientSource() {
+        return this.clientSource;
+    }
+    /**
+     * Requests an authentication token from the token generation API.
+     *
+     * @private
+     * @static
+     * @param {ClientConfig} config - The client configuration containing authentication details
+     * @return {Promise<string>} A promise that resolves to the authentication token string
+     * @throws {Error} Throws an error if the token response is empty
+     *
+     * @example
+     * // Internal usage within the Client class
+     * const token = await Client.requestToken({
+     *   apiKey: 'your-api-key',
+     *   clientId: 'client123',
+     *   orgId: 'org456',
+     *   authUrl: 'https://custom-auth.example.com/token'
+     * });
+     */
+    static async requestToken(config) {
+        var _a;
+        const tokenUrl = (_a = config.authUrl) !== null && _a !== void 0 ? _a : Constants_1.TOKEN_GENERATION_API;
+        const res = await axios_1.default.get(tokenUrl, {
+            headers: {
+                "X-Api-Key": config.apiKey,
+                "X-IBM-Client-Id": `saascore-${config.clientId}`,
+                accept: "application/json",
+            },
+            params: {
+                orgId: config.orgId
+            }
+        });
+        if (!res.data)
+            throw new Error("Token response is empty");
+        return String(res.data).trim();
+    }
+}
+exports.Client = Client;
+Client.instance = null;