emissions-api-sdk 1.0.11 → 1.0.13

package/docs/searchindex.js

@@ -1 +1 @@
-Search.setIndex({"alltitles": {"1. Missing Auth URL with Custom Host": [[6, "missing-auth-url-with-custom-host"]], "2. Missing Client ID with Token": [[6, "missing-client-id-with-token"]], "3. Missing Parameters with API Key": [[6, "missing-parameters-with-api-key"]], "4. Invalid API Key": [[6, "invalid-api-key"]], "5. Invalid Organization ID": [[6, "invalid-organization-id"]], "6. Invalid Client ID": [[6, "invalid-client-id"]], "7. Empty Token Response": [[6, "empty-token-response"]], "8. Missing Expiry Field in Token": [[6, "missing-expiry-field-in-token"]], "API": [[4, "api"]], "API Key Authentication (Recommended)": [[0, "api-key-authentication-recommended"], [6, "api-key-authentication-recommended"]], "Architecture Diagram": [[0, "architecture-diagram"]], "Authentication": [[0, null], [2, "authentication"]], "Authentication Errors (HTTP 401)": [[6, "authentication-errors-http-401"]], "Authentication Flow": [[0, "authentication-flow"]], "Authentication Headers": [[0, "authentication-headers"]], "Authentication Integration": [[1, "authentication-integration"]], "Authentication Methods": [[0, "authentication-methods"]], "Automatic Token Refresh": [[6, "automatic-token-refresh"]], "Basic Import": [[2, "basic-import"]], "Best Practices": [[1, "best-practices"]], "Client": [[1, null]], "Client Initialization": [[1, "client-initialization"]], "Client Instance Errors": [[6, "client-instance-errors"]], "Client Not Initialized": [[6, "client-not-initialized"]], "Client Responsibilities": [[1, "client-responsibilities"]], "Common Scenarios": [[6, "common-scenarios"]], "Configuration Errors": [[6, "configuration-errors"]], "Configuration Options": [[1, "configuration-options"]], "Contents:": [[3, null]], "Error Handling": [[1, "error-handling"]], "Error Summary Table": [[6, "error-summary-table"]], "Example": [[4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null]], "Example Response": [[2, "example-response"]], "First API Call": [[2, "first-api-call"]], "Getting Started": [[2, null]], "Global Metadata API": [[4, "global-metadata-api"]], "IBM Envizi - Emissions API Node.js SDK": [[3, null]], "Initialization Checklist": [[6, "initialization-checklist"]], "Installation": [[2, "installation"]], "Interfaces": [[4, "interfaces"]], "Introduction": [[3, "introduction"]], "Overview": [[0, "overview"], [1, "overview"], [6, "overview"]], "Pre-generated Token Authentication": [[0, "pre-generated-token-authentication"]], "Prerequisites": [[2, "prerequisites"]], "Reference": [[4, null]], "Required Configuration Parameters": [[6, "required-configuration-parameters"]], "SDK": [[5, null]], "SDK Initialization Errors": [[6, "sdk-initialization-errors"]], "Scenario 1: Application Startup": [[6, "scenario-1-application-startup"]], "Scenario 2: Invalid Credentials": [[6, "scenario-2-invalid-credentials"]], "Scenario 3: Missing Configuration": [[6, "scenario-3-missing-configuration"]], "Scenario 4: Client Not Initialized": [[6, "scenario-4-client-not-initialized"]], "Security Best Practices": [[0, "security-best-practices"]], "Support": [[6, "support"]], "Supported Emission Types": [[3, "supported-emission-types"]], "Token Authentication": [[6, "token-authentication"]], "Token Management": [[6, "token-management"]], "Token lifetime & refresh": [[0, "token-lifetime-refresh"]], "Token retrieval": [[0, "token-retrieval"]], "Troubleshooting Guide": [[6, null]], "Troubleshooting Steps": [[6, "troubleshooting-steps"]], "Usage API": [[4, "usage-api"]], "Using API Key (Recommended)": [[2, "using-api-key-recommended"]], "Using Pre-generated Token": [[2, "using-pre-generated-token"]], "getArea": [[4, "getarea"]], "getTypes": [[4, "gettypes"]], "getUnits": [[4, "getunits"]]}, "docnames": ["authentication", "client", "getting_started", "index", "reference", "sdk", "troubleshooting"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["authentication.rst", "client.rst", "getting_started.rst", "index.rst", "reference.rst", "sdk.rst", "troubleshooting.rst"], "indexentries": {"api.commonrequestwithfactorid() (interface)": [[4, "Api.CommonRequestWithFactorId", false]], "api.commonrequestwithoutfactorid() (interface)": [[4, "Api.CommonRequestWithoutFactorId", false]], "api.factorrequestwithfactorid() (interface)": [[4, "Api.FactorRequestWithFactorId", false]], "api.factorrequestwithoutfactorid() (interface)": [[4, "Api.FactorRequestWithoutFactorId", false]], "api.genericcalculationrequestwithfactorid() (interface)": [[4, "Api.GenericCalculationRequestWithFactorId", false]], "api.genericcalculationrequestwithoutfactorid() (interface)": [[4, "Api.GenericCalculationRequestWithoutFactorId", false]], "api.locationrequestwithfactorid() (interface)": [[4, "Api.LocationRequestWithFactorId", false]], "api.locationrequestwithoutfactorid() (interface)": [[4, "Api.LocationRequestWithoutFactorId", false]], "api.searchrequest() (interface)": [[4, "Api.SearchRequest", false]], "calculation.calculate() (calculation method)": [[4, "Calculation.calculate", false]], "client() (class)": [[4, "Client", false]], "client.getauthheader() (client method)": [[4, "Client.getAuthHeader", false]], "client.getclient() (client method)": [[4, "Client.getClient", false]], "client.getclientid() (client method)": [[4, "Client.getClientId", false]], "client.getclientsource() (client method)": [[4, "Client.getClientSource", false]], "client.getdomain() (client method)": [[4, "Client.getDomain", false]], "client.getinstance() (client method)": [[4, "Client.getInstance", false]], "client.refreshtoken() (client method)": [[4, "Client.refreshToken", false]], "common.activity() (interface)": [[4, "common.Activity", false]], "common.activitywithfactorid() (interface)": [[4, "common.ActivityWithFactorId", false]], "common.combinedunitsactivity() (interface)": [[4, "common.CombinedUnitsActivity", false]], "common.combinedunitsactivitywithfactorid() (interface)": [[4, "common.CombinedUnitsActivityWithFactorId", false]], "common.factoractivity() (interface)": [[4, "common.FactorActivity", false]], "common.factoractivitywithfactorid() (interface)": [[4, "common.FactorActivityWithFactorId", false]], "common.location() (interface)": [[4, "common.Location", false]], "common.pagination() (interface)": [[4, "common.Pagination", false]], "common.searchactivity() (interface)": [[4, "common.SearchActivity", false]], "common.time() (interface)": [[4, "common.Time", false]], "config.clientconfig() (interface)": [[4, "Config.ClientConfig", false]], "config.requestconfig() (interface)": [[4, "Config.RequestConfig", false]], "economicactivity.calculate() (economicactivity method)": [[4, "EconomicActivity.calculate", false]], "factor.retrievefactor() (factor method)": [[4, "Factor.retrieveFactor", false]], "fugitive.calculate() (fugitive method)": [[4, "Fugitive.calculate", false]], "location.calculate() (location method)": [[4, "Location.calculate", false]], "metadata.getarea() (metadata method)": [[4, "Metadata.getArea", false]], "metadata.gettypes() (metadata method)": [[4, "Metadata.getTypes", false]], "metadata.getunits() (metadata method)": [[4, "Metadata.getUnits", false]], "metadata.postarea() (metadata method)": [[4, "Metadata.postArea", false]], "metadata.posttypes() (metadata method)": [[4, "Metadata.postTypes", false]], "metadata.postunits() (metadata method)": [[4, "Metadata.postUnits", false]], "mobile.calculate() (mobile method)": [[4, "Mobile.calculate", false]], "realestate.calculate() (realestate method)": [[4, "RealEstate.calculate", false]], "request.makeapirequest() (request method)": [[4, "request.makeApiRequest", false]], "stationary.calculate() (stationary method)": [[4, "Stationary.calculate", false]], "transportationanddistribution.calculate() (transportationanddistribution method)": [[4, "TransportationAndDistribution.calculate", false]], "usage.getusage() (usage method)": [[4, "Usage.getUsage", false]], "utils.findexpirytime() (utils method)": [[4, "utils.findExpiryTime", false]]}, "objects": {"": [[4, 2, 1, "", "Client"]], "Api": [[4, 0, 1, "", "CommonRequestWithFactorId"], [4, 0, 1, "", "CommonRequestWithoutFactorId"], [4, 0, 1, "", "FactorRequestWithFactorId"], [4, 0, 1, "", "FactorRequestWithoutFactorId"], [4, 0, 1, "", "GenericCalculationRequestWithFactorId"], [4, 0, 1, "", "GenericCalculationRequestWithoutFactorId"], [4, 0, 1, "", "LocationRequestWithFactorId"], [4, 0, 1, "", "LocationRequestWithoutFactorId"], [4, 0, 1, "", "SearchRequest"]], "Calculation": [[4, 1, 1, "", "calculate"]], "Client": [[4, 1, 1, "", "getAuthHeader"], [4, 1, 1, "", "getClient"], [4, 1, 1, "", "getClientId"], [4, 1, 1, "", "getClientSource"], [4, 1, 1, "", "getDomain"], [4, 1, 1, "", "getInstance"], [4, 1, 1, "", "refreshToken"]], "Config": [[4, 0, 1, "", "ClientConfig"], [4, 0, 1, "", "RequestConfig"]], "EconomicActivity": [[4, 1, 1, "", "calculate"]], "Factor": [[4, 1, 1, "", "retrieveFactor"]], "Fugitive": [[4, 1, 1, "", "calculate"]], "Location": [[4, 1, 1, "", "calculate"]], "Metadata": [[4, 1, 1, "", "getArea"], [4, 1, 1, "", "getTypes"], [4, 1, 1, "", "getUnits"], [4, 1, 1, "", "postArea"], [4, 1, 1, "", "postTypes"], [4, 1, 1, "", "postUnits"]], "Mobile": [[4, 1, 1, "", "calculate"]], "RealEstate": [[4, 1, 1, "", "calculate"]], "Stationary": [[4, 1, 1, "", "calculate"]], "TransportationAndDistribution": [[4, 1, 1, "", "calculate"]], "Usage": [[4, 1, 1, "", "getUsage"]], "common": [[4, 0, 1, "", "Activity"], [4, 0, 1, "", "ActivityWithFactorId"], [4, 0, 1, "", "CombinedUnitsActivity"], [4, 0, 1, "", "CombinedUnitsActivityWithFactorId"], [4, 0, 1, "", "FactorActivity"], [4, 0, 1, "", "FactorActivityWithFactorId"], [4, 0, 1, "", "Location"], [4, 0, 1, "", "Pagination"], [4, 0, 1, "", "SearchActivity"], [4, 0, 1, "", "Time"]], "request": [[4, 1, 1, "", "makeApiRequest"]], "utils": [[4, 1, 1, "", "findExpiryTime"]]}, "objnames": {"0": ["js", "interface", "JavaScript interface"], "1": ["js", "function", "JavaScript function"], "2": ["js", "class", "JavaScript class"]}, "objtypes": {"0": "js:interface", "1": "js:function", "2": "js:class"}, "terms": {"": [0, 2, 4, 6], "0": [0, 2, 4, 6], "00033022": 2, "00036061": 2, "01": [4, 6], "01115131": 2, "02ae": 2, "04": [4, 6], "1": [2, 4], "1000": 4, "11": 6, "12": 4, "121": 4, "1223123": 4, "123": 4, "12345": [4, 6], "14123143": 4, "150": 4, "1500": 4, "1500000": 4, "17000": 4, "2": [0, 4], "2022": [2, 4], "2025": [4, 6], "20681091": 2, "20750174": 2, "24": 6, "3": 4, "47a3": 2, "60": [4, 6], "831bfca7cecd": 2, "95a7efe7": 2, "9999": 4, "A": [0, 4, 6], "For": [0, 1, 6], "If": [0, 2, 4, 6], "In": 0, "It": 1, "No": 1, "OR": [1, 4], "Or": [2, 6], "That": 6, "The": [0, 1, 2, 3, 4, 5, 6], "Then": 4, "These": 6, "a7fd": 2, "about": [0, 1, 4, 6], "accept": [0, 1, 2, 4], "access": [0, 1, 4, 6], "accomod": 4, "account": 6, "across": [1, 4], "activ": [2, 3, 4, 6], "activitywithfactorid": 4, "add": [0, 1], "after": 2, "all": [1, 4, 6], "allow": 6, "allunit": 4, "alreadi": [2, 4], "also": 6, "alwai": 6, "an": [2, 4, 6], "ani": [4, 6], "api": [1, 5], "apidomain": 4, "apikei": [0, 1, 2, 4, 6], "applic": [0, 1, 2, 3, 4], "approach": [0, 5], "appropri": [1, 4], "ar": [2, 6], "architectur": 5, "area": [2, 4], "arearespons": 4, "argument": 4, "async": [2, 4], "attempt": 6, "auth": 4, "authent": [3, 4, 5], "author": [0, 4], "authurl": [0, 1, 4, 6], "autom": 3, "automat": [0, 1], "avail": [2, 4, 6], "await": [0, 1, 2, 4, 6], "axio": 0, "base": [2, 3, 4, 6], "bearer": [0, 4], "befor": [0, 1, 2, 4, 6], "best": 5, "bill": 4, "bodi": 6, "boolean": 4, "both": 6, "build": 3, "bulk": 4, "busi": 3, "cach": 0, "calcul": [2, 3, 4, 6], "calculateemiss": 2, "calculationrequest": 4, "california": 2, "call": [0, 3, 4, 6], "can": [2, 4, 6], "cannot": 6, "carbon": 3, "cargo": 4, "carrier": 4, "catch": [1, 2], "caus": 6, "central": 1, "ch4": 2, "chain": 3, "check": [0, 6], "checklist": 3, "claim": 6, "class": 4, "client": [0, 2, 3, 4, 5], "client123": [4, 6], "clientconfig": 4, "clientid": [0, 1, 2, 4, 6], "climat": 2, "close": 1, "cloud": 6, "co2": 2, "coal": [4, 6], "code": [0, 6], "com": [0, 2, 4, 6], "combin": 6, "combinedunitsact": 4, "combinedunitsactivitywithfactorid": 4, "combust": 4, "commerci": [3, 4], "common": [3, 4], "commonrequest": 4, "commonrequestwithfactorid": 4, "commonrequestwithoutfactorid": 4, "complet": [4, 6], "complex": 4, "compon": [1, 5], "config": 4, "configur": [3, 4, 5], "confirm": 6, "connect": [1, 2, 6], "consist": 1, "consol": [1, 2, 4, 6], "const": [2, 4, 6], "consumpt": 3, "contact": 6, "contain": [4, 6], "content": 4, "control": 0, "convert": 4, "correct": 6, "correctli": 6, "correspond": 6, "countri": [2, 4, 6], "cover": [5, 6], "coverag": 6, "credenti": [0, 1, 2], "criteria": 4, "current": 4, "custom": [1, 3, 4], "dashboard": 3, "data": [1, 4], "databas": 3, "dataset": 3, "date": [4, 6], "debug": 6, "decis": 3, "decod": 0, "default": [0, 1, 4], "deploy": 0, "descript": [1, 2], "design": [1, 3], "detail": [0, 1, 4, 6], "detect": 0, "determin": 4, "diagram": 5, "diesel": 4, "differ": 4, "directli": [2, 6], "distribut": [3, 4], "document": 6, "doe": 6, "doesn": [4, 6], "domain": [0, 4, 6], "dure": 6, "dwt": 4, "e": [2, 4, 6], "each": 0, "econom": [3, 4], "economicact": 4, "egrid": 2, "either": 1, "electr": [2, 4], "email": 4, "embed": 3, "emiss": [0, 1, 2, 4, 5, 6], "emissionrespons": 4, "emissionresponsewithdetail": 4, "enabl": 6, "endpoint": [0, 1, 2, 4, 6], "energi": 4, "engin": 3, "enotfound": 6, "ensur": [1, 2, 4, 6], "entir": 2, "env": [0, 1], "environ": [0, 1, 6], "envizi": [0, 1, 5], "envizi_api_kei": [0, 1], "envizi_client_id": [0, 1], "envizi_org_id": [0, 1], "envizisdk": 2, "equip": 3, "error": [2, 3, 5], "estat": [3, 4], "etc": 6, "exact": 4, "exampl": [3, 6], "excel": 0, "exclud": 6, "exist": [1, 4, 6], "exp": [0, 6], "expect": 4, "expir": [0, 1, 4, 6], "expiri": [0, 4], "expirytim": 4, "explain": 0, "export": 4, "extern": 0, "extract": 4, "factor": [2, 3, 4], "factoract": 4, "factoractivitywithfactorid": 4, "factorid": 4, "factorrequest": 4, "factorrequestwithfactorid": 4, "factorrequestwithoutfactorid": 4, "factorrespons": 4, "fail": [2, 6], "failur": [1, 6], "fals": 4, "fetch": 1, "find": 4, "findexpirytim": [3, 4], "firewal": 6, "first": [3, 4, 6], "fix": 3, "flag": 4, "flow": 5, "follow": [0, 1, 2, 6], "footprint": 3, "format": [0, 2], "freight": 4, "fresh": [0, 4], "from": [0, 1, 2, 3, 4, 6], "fuel": [3, 4], "fugit": [3, 4, 6], "fugitivearea": 4, "fugitv": 4, "full": 4, "function": [2, 6], "futur": 0, "g": [4, 6], "ga": [3, 4], "gener": [1, 3, 4, 6], "genericcalculationrequestwithfactorid": 4, "genericcalculationrequestwithoutfactorid": 4, "geograph": 4, "get": [0, 3, 4, 6], "getauthhead": 4, "getclient": [0, 1, 2, 4, 6], "getclientid": 4, "getclientsourc": 4, "getdomain": 4, "getinst": [4, 6], "getunit": 6, "getusag": 4, "ghg": 3, "ghgemiss": 0, "give": 4, "global": 3, "gracefulli": 1, "greenhous": 3, "guid": 3, "ha": 6, "handl": [0, 5, 6], "hardcod": 0, "have": [2, 4], "header": [1, 2, 4, 5, 6], "here": 2, "histor": 4, "histori": 4, "host": [0, 1, 4], "http": [0, 1, 2, 4], "httpcode": 6, "httpmessag": 6, "i": [0, 1, 3, 4, 6], "ibm": [0, 1, 2, 5, 6], "ibmid": 2, "id": [0, 1, 2, 4], "identifi": [0, 4], "implement": [0, 1, 6], "import": [0, 1], "includ": [0, 4, 6], "includedetail": 4, "indirectco2": 2, "industri": 4, "inform": [0, 1, 4], "init": 0, "initi": [0, 2, 3, 4, 5], "instal": 3, "instanc": [1, 3, 4], "instead": [4, 6], "integr": 5, "interact": 5, "interfac": [1, 3], "internet": 2, "invalid_api_key_12345": 6, "involv": 4, "issu": 6, "isuserprovidedtoken": 4, "j": [0, 1, 2, 5, 6], "jet": 4, "jetkeroseneunit": 4, "json": [0, 2, 4], "jwt": [0, 4, 6], "jwt_token": 0, "jwttoken": 4, "kei": [1, 4, 5], "kerosen": 4, "kg": 4, "kgco2e": 2, "kj": [4, 6], "km": 4, "known": 4, "kwh": [2, 4], "l": 4, "lack": 6, "larg": 3, "last": 6, "layer": 0, "leader": 2, "leak": 3, "least": 0, "let": 1, "lignit": [4, 6], "list": 6, "ll": 6, "locat": [2, 3, 4, 6], "locationemiss": 2, "locationrequest": 4, "locationrequestwithfactorid": 4, "locationrequestwithoutfactorid": 4, "locationtyp": 4, "log": [2, 4], "logist": 3, "look": 4, "m2": 4, "mai": 4, "maintain": 1, "make": [2, 3, 4], "makeapirequest": [0, 3, 4], "malform": 6, "manag": [0, 1, 2, 3], "match": 6, "measur": 4, "messag": [1, 6], "metadata": 3, "method": [1, 2, 4, 5, 6], "metric": 4, "mobil": [3, 4, 6], "mobilearea": 4, "mode": 0, "modul": [1, 2], "more": [0, 6], "moreinform": 6, "multipl": 4, "must": 6, "n": 6, "n2o": 2, "name": 4, "natur": 4, "naturalgasunit": 4, "necessari": 0, "need": [0, 4], "network": 6, "never": 0, "new": [0, 4], "node": [0, 1, 2, 5, 6], "note": 6, "npm": 2, "null": 6, "oauth": 0, "object": 4, "obtain": [1, 2], "occur": [0, 6], "old": 0, "onc": [0, 1], "one": [0, 1], "onli": [0, 1, 4, 6], "oper": [1, 3, 4, 6], "optim": 1, "option": [0, 4, 5], "org": [2, 6], "org456": [4, 6], "organ": [0, 1, 4], "orgid": [0, 1, 2, 4, 6], "other": [4, 6], "otherwis": 4, "overview": [2, 3, 5], "page": [0, 1, 2], "pagin": 4, "param": [0, 4], "paramet": [0, 1, 3, 4], "pass": 6, "pat": 4, "pattern": 5, "pattoken": 4, "payload": 4, "perform": 4, "period": 4, "permiss": 6, "person": 4, "point": [4, 6], "post": 4, "postarea": 4, "posttyp": 4, "postunit": 4, "practic": 5, "pre": [1, 6], "prerequisit": 3, "preview": 2, "principl": 0, "privileg": 0, "proce": 4, "process": [0, 1], "product": [0, 1], "project": [2, 3], "promis": 4, "proper": [0, 1, 6], "properli": 6, "properti": 3, "provid": [0, 1, 2, 4, 5, 6], "purchas": 4, "purpos": 4, "queri": [0, 4], "r134a": 4, "re": [0, 6], "real": [3, 4], "realest": 4, "record": 4, "refer": 3, "refresh": [1, 4], "refreshtoken": 4, "regener": 6, "region": [2, 3], "relat": [4, 6], "relev": 4, "replac": 0, "repres": 4, "reproduc": 6, "request": [0, 1, 3, 4], "requestconfig": 4, "requir": [0, 1, 2, 3], "residenti": 3, "resolv": 4, "respond": 6, "respons": [0, 3, 4, 5], "restart": 6, "result": [2, 4], "retriev": [2, 4], "retrievefactor": 4, "return": [0, 2, 4, 6], "reus": 1, "review": 6, "revok": 6, "run": [0, 2], "saascor": [0, 2], "sampl": 6, "scale": 3, "scenario": [0, 3], "scope": 4, "sdk": [0, 1, 2, 4], "search": 4, "searchact": 4, "searchrequest": 4, "second": [4, 6], "secret": 6, "section": 5, "secur": [1, 5, 6], "see": [0, 1], "send": 0, "sensit": 6, "sent": 4, "server": 6, "servic": [0, 1, 6], "set": [2, 6], "sever": 1, "ship": 4, "sign": 2, "singl": 4, "singleton": [0, 1, 4], "solut": 6, "sourc": [0, 3, 4], "specif": [1, 3, 4, 6], "specifi": 4, "spend": [3, 4], "stack": 6, "standard": [4, 6], "start": [3, 6], "startup": 1, "state": 2, "stateprovinc": [2, 4], "static": 4, "stationari": [3, 4, 6], "stationarytyp": 4, "statu": [1, 6], "steam": 6, "steel": 4, "step": [0, 3], "store": [0, 1, 6], "string": [0, 4], "structur": 5, "subsequ": 6, "successfulli": [2, 6], "summari": 3, "suppli": 3, "support": [1, 4], "sustain": 3, "t": [4, 6], "tabl": [3, 4], "target": 6, "tenantid": 2, "thei": 6, "thi": [0, 2, 4, 5, 6], "three": 6, "throw": 6, "thrown": 6, "time": [0, 4, 6], "timestamp": 4, "togeth": 6, "toisostr": 4, "token": [1, 3, 4], "totalco2": 2, "trace": 6, "track": 3, "transactionid": 2, "transport": [3, 4], "transportationanddistribut": 4, "trim": 0, "troubleshoot": 3, "true": 4, "try": [1, 2], "two": [0, 2], "type": [2, 4, 6], "typerespons": 4, "u": 2, "unauthor": 6, "unifi": [1, 4], "unit": [2, 4, 6], "unitrespons": 4, "unix": 4, "unless": 1, "unreach": 6, "uom": 4, "up": [2, 4, 6], "updat": 6, "url": [0, 4], "us": [0, 1, 3, 4, 6], "usa": [2, 4, 6], "usag": [1, 3, 5], "usagerespons": 4, "usd": 4, "user": [0, 1, 4, 6], "userdata": 4, "util": [3, 4], "v": [0, 1], "valid": [0, 1, 6], "valu": [2, 4, 6], "variabl": [0, 1, 6], "vehicl": 3, "verifi": [1, 6], "version": 6, "void": 4, "wa": [2, 4, 6], "wai": 4, "waitlist": 2, "warehous": 4, "wast": 4, "web": 4, "when": [0, 4, 6], "where": [0, 4], "which": 0, "within": [4, 6], "without": [4, 6], "work": 1, "wrong": 6, "x": [0, 2, 4], "yarn": 2, "ye": 1, "year": 2, "york": 4, "you": [0, 2, 6], "your": [0, 1, 2, 3, 4, 6]}, "titles": ["Authentication", "Client", "Getting Started", "IBM Envizi - Emissions API Node.js SDK", "Reference", "SDK", "Troubleshooting Guide"], "titleterms": {"1": 6, "2": 6, "3": 6, "4": 6, "401": 6, "5": 6, "6": 6, "7": 6, "8": 6, "Not": 6, "api": [0, 2, 3, 4, 6], "applic": 6, "architectur": 0, "auth": 6, "authent": [0, 1, 2, 6], "automat": 6, "basic": 2, "best": [0, 1], "call": 2, "checklist": 6, "client": [1, 6], "common": 6, "configur": [1, 6], "content": 3, "credenti": 6, "custom": 6, "diagram": 0, "emiss": 3, "empti": 6, "envizi": 3, "error": [1, 6], "exampl": [2, 4], "expiri": 6, "field": 6, "first": 2, "flow": 0, "gener": [0, 2], "get": 2, "getarea": 4, "gettyp": 4, "getunit": 4, "global": 4, "guid": 6, "handl": 1, "header": 0, "host": 6, "http": 6, "ibm": 3, "id": 6, "import": 2, "initi": [1, 6], "instal": 2, "instanc": 6, "integr": 1, "interfac": 4, "introduct": 3, "invalid": 6, "j": 3, "kei": [0, 2, 6], "lifetim": 0, "manag": 6, "metadata": 4, "method": 0, "miss": 6, "node": 3, "option": 1, "organ": 6, "overview": [0, 1, 6], "paramet": 6, "practic": [0, 1], "pre": [0, 2], "prerequisit": 2, "recommend": [0, 2, 6], "refer": 4, "refresh": [0, 6], "requir": 6, "respons": [1, 2, 6], "retriev": 0, "scenario": 6, "sdk": [3, 5, 6], "secur": 0, "start": 2, "startup": 6, "step": 6, "summari": 6, "support": [3, 6], "tabl": 6, "token": [0, 2, 6], "troubleshoot": 6, "type": 3, "url": 6, "us": 2, "usag": 4}})
+Search.setIndex({"alltitles": {"1. Missing Auth URL with Custom Host": [[6, "missing-auth-url-with-custom-host"]], "10. Missing Expiry Field in Token": [[6, "missing-expiry-field-in-token"]], "2. Missing Client ID with Token": [[6, "missing-client-id-with-token"]], "3. Missing Parameters with API Key": [[6, "missing-parameters-with-api-key"]], "4. Missing Client ID with PAT Token": [[6, "missing-client-id-with-pat-token"]], "5. Organization ID Provided with PAT Token": [[6, "organization-id-provided-with-pat-token"]], "6. Invalid API Key": [[6, "invalid-api-key"]], "7. Invalid Organization ID": [[6, "invalid-organization-id"]], "8. Invalid Client ID": [[6, "invalid-client-id"]], "9. Empty Token Response": [[6, "empty-token-response"]], "API": [[4, "api"]], "API Key Authentication": [[0, "api-key-authentication"], [6, "api-key-authentication"]], "Additional capabilities": [[3, "additional-capabilities"]], "Architecture Diagram": [[0, "architecture-diagram"]], "Audit Log API": [[4, "audit-log-api"]], "Authentication": [[0, null], [2, "authentication"]], "Authentication Errors (HTTP 401)": [[6, "authentication-errors-http-401"]], "Authentication Flow": [[0, "authentication-flow"]], "Authentication Headers": [[0, "authentication-headers"]], "Authentication Integration": [[1, "authentication-integration"]], "Authentication Methods": [[0, "authentication-methods"]], "Automatic Token Refresh": [[6, "automatic-token-refresh"]], "Basic Import": [[2, "basic-import"]], "Best Practices": [[1, "best-practices"]], "Client": [[1, null]], "Client Initialization": [[1, "client-initialization"]], "Client Instance Errors": [[6, "client-instance-errors"]], "Client Not Initialized": [[6, "client-not-initialized"]], "Client Responsibilities": [[1, "client-responsibilities"]], "Common Scenarios": [[6, "common-scenarios"]], "Configuration Errors": [[6, "configuration-errors"]], "Configuration Options": [[1, "configuration-options"]], "Contents:": [[3, null]], "Currency Conversion Support": [[2, "currency-conversion-support"]], "Error Handling": [[1, "error-handling"]], "Error Summary Table": [[6, "error-summary-table"]], "Example": [[4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null]], "Example Response": [[2, "example-response"]], "Example Response with Details": [[2, "example-response-with-details"]], "Exchange Rate Data": [[2, "exchange-rate-data"]], "First API Call": [[2, "first-api-call"]], "Getting Started": [[2, null]], "Global Metadata API": [[4, "global-metadata-api"]], "IBM Envizi - Emissions API Node.js SDK": [[3, null]], "Initialization Checklist": [[6, "initialization-checklist"]], "Installation": [[2, "installation"]], "Interfaces": [[4, "interfaces"]], "Introduction": [[3, "introduction"]], "Overview": [[0, "overview"], [1, "overview"], [2, "overview"], [6, "overview"]], "Personal Access Token (PAT) Authentication (Recommended)": [[0, "personal-access-token-pat-authentication-recommended"], [6, "personal-access-token-pat-authentication-recommended"]], "Pre-generated Token Authentication": [[0, "pre-generated-token-authentication"]], "Prerequisites": [[2, "prerequisites"]], "Reference": [[4, null]], "Required Configuration Parameters": [[6, "required-configuration-parameters"]], "Response Structure Details": [[2, "response-structure-details"]], "SDK": [[5, null]], "SDK Initialization Errors": [[6, "sdk-initialization-errors"]], "Scenario 1: Application Startup": [[6, "scenario-1-application-startup"]], "Scenario 2: Invalid Credentials": [[6, "scenario-2-invalid-credentials"]], "Scenario 3: Missing Configuration": [[6, "scenario-3-missing-configuration"]], "Scenario 4: Client Not Initialized": [[6, "scenario-4-client-not-initialized"]], "Security Best Practices": [[0, "security-best-practices"]], "Support": [[6, "support"]], "Supported Currencies": [[2, "supported-currencies"]], "Supported Emission Types": [[3, "supported-emission-types"]], "Token Authentication": [[6, "token-authentication"]], "Token Management": [[6, "token-management"]], "Token lifetime & refresh": [[0, "token-lifetime-refresh"]], "Token retrieval": [[0, "token-retrieval"]], "Troubleshooting Guide": [[6, null]], "Troubleshooting Steps": [[6, "troubleshooting-steps"]], "Type Recommender API": [[4, "type-recommender-api"]], "Usage API": [[4, "usage-api"]], "Using API Key": [[2, "using-api-key"]], "Using Personal Access Token (PAT)": [[2, "using-personal-access-token-pat"]], "Using Pre-generated JWT Token": [[2, "using-pre-generated-jwt-token"]], "getArea": [[4, "getarea"]], "getTypes": [[4, "gettypes"]], "getUnits": [[4, "getunits"]]}, "docnames": ["authentication", "client", "getting_started", "index", "reference", "sdk", "troubleshooting"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["authentication.rst", "client.rst", "getting_started.rst", "index.rst", "reference.rst", "sdk.rst", "troubleshooting.rst"], "indexentries": {"api.commonrequestwithfactorid() (interface)": [[4, "Api.CommonRequestWithFactorId", false]], "api.commonrequestwithoutfactorid() (interface)": [[4, "Api.CommonRequestWithoutFactorId", false]], "api.factorrequestwithfactorid() (interface)": [[4, "Api.FactorRequestWithFactorId", false]], "api.factorrequestwithoutfactorid() (interface)": [[4, "Api.FactorRequestWithoutFactorId", false]], "api.genericcalculationrequestwithfactorid() (interface)": [[4, "Api.GenericCalculationRequestWithFactorId", false]], "api.genericcalculationrequestwithoutfactorid() (interface)": [[4, "Api.GenericCalculationRequestWithoutFactorId", false]], "api.locationrequestwithfactorid() (interface)": [[4, "Api.LocationRequestWithFactorId", false]], "api.locationrequestwithoutfactorid() (interface)": [[4, "Api.LocationRequestWithoutFactorId", false]], "api.searchrequest() (interface)": [[4, "Api.SearchRequest", false]], "auditlog.getauditconfig() (auditlog method)": [[4, "AuditLog.getAuditConfig", false]], "auditlog.updateauditconfig() (auditlog method)": [[4, "AuditLog.updateAuditConfig", false]], "auditlogresponse.auditlogrequest() (interface)": [[4, "AuditLogResponse.AuditLogRequest", false]], "auditlogresponse.auditlogresponse() (interface)": [[4, "AuditLogResponse.AuditLogResponse", false]], "calculation.calculate() (calculation method)": [[4, "Calculation.calculate", false]], "client() (class)": [[4, "Client", false]], "client.getauthheader() (client method)": [[4, "Client.getAuthHeader", false]], "client.getclient() (client method)": [[4, "Client.getClient", false]], "client.getclientid() (client method)": [[4, "Client.getClientId", false]], "client.getclientsource() (client method)": [[4, "Client.getClientSource", false]], "client.getdomain() (client method)": [[4, "Client.getDomain", false]], "client.getinstance() (client method)": [[4, "Client.getInstance", false]], "client.refreshtoken() (client method)": [[4, "Client.refreshToken", false]], "common.activity() (interface)": [[4, "common.Activity", false]], "common.activitywithfactorid() (interface)": [[4, "common.ActivityWithFactorId", false]], "common.combinedunitsactivity() (interface)": [[4, "common.CombinedUnitsActivity", false]], "common.combinedunitsactivitywithfactorid() (interface)": [[4, "common.CombinedUnitsActivityWithFactorId", false]], "common.factoractivity() (interface)": [[4, "common.FactorActivity", false]], "common.factoractivitywithfactorid() (interface)": [[4, "common.FactorActivityWithFactorId", false]], "common.location() (interface)": [[4, "common.Location", false]], "common.pagination() (interface)": [[4, "common.Pagination", false]], "common.searchactivity() (interface)": [[4, "common.SearchActivity", false]], "common.time() (interface)": [[4, "common.Time", false]], "config.clientconfig() (interface)": [[4, "Config.ClientConfig", false]], "config.requestconfig() (interface)": [[4, "Config.RequestConfig", false]], "economicactivity.calculate() (economicactivity method)": [[4, "EconomicActivity.calculate", false]], "factor.retrievefactor() (factor method)": [[4, "Factor.retrieveFactor", false]], "factor.search() (factor method)": [[4, "Factor.search", false]], "fugitive.calculate() (fugitive method)": [[4, "Fugitive.calculate", false]], "location.calculate() (location method)": [[4, "Location.calculate", false]], "metadata.getarea() (metadata method)": [[4, "Metadata.getArea", false]], "metadata.gettypes() (metadata method)": [[4, "Metadata.getTypes", false]], "metadata.getunits() (metadata method)": [[4, "Metadata.getUnits", false]], "metadata.postarea() (metadata method)": [[4, "Metadata.postArea", false]], "metadata.posttypes() (metadata method)": [[4, "Metadata.postTypes", false]], "metadata.postunits() (metadata method)": [[4, "Metadata.postUnits", false]], "mobile.calculate() (mobile method)": [[4, "Mobile.calculate", false]], "realestate.calculate() (realestate method)": [[4, "RealEstate.calculate", false]], "request.makeapirequest() (request method)": [[4, "request.makeApiRequest", false]], "stationary.calculate() (stationary method)": [[4, "Stationary.calculate", false]], "transportationanddistribution.calculate() (transportationanddistribution method)": [[4, "TransportationAndDistribution.calculate", false]], "typerecommender.search() (typerecommender method)": [[4, "TypeRecommender.search", false]], "typerecommenderresponse.activityrequest() (interface)": [[4, "TypeRecommenderResponse.ActivityRequest", false]], "typerecommenderresponse.typerecommenderresponse() (interface)": [[4, "TypeRecommenderResponse.TypeRecommenderResponse", false]], "usage.getusage() (usage method)": [[4, "Usage.getUsage", false]], "utils.findexpirytime() (utils method)": [[4, "utils.findExpiryTime", false]]}, "objects": {"": [[4, 2, 1, "", "Client"]], "Api": [[4, 0, 1, "", "CommonRequestWithFactorId"], [4, 0, 1, "", "CommonRequestWithoutFactorId"], [4, 0, 1, "", "FactorRequestWithFactorId"], [4, 0, 1, "", "FactorRequestWithoutFactorId"], [4, 0, 1, "", "GenericCalculationRequestWithFactorId"], [4, 0, 1, "", "GenericCalculationRequestWithoutFactorId"], [4, 0, 1, "", "LocationRequestWithFactorId"], [4, 0, 1, "", "LocationRequestWithoutFactorId"], [4, 0, 1, "", "SearchRequest"]], "AuditLog": [[4, 1, 1, "", "getAuditConfig"], [4, 1, 1, "", "updateAuditConfig"]], "AuditLogResponse": [[4, 0, 1, "", "AuditLogRequest"], [4, 0, 1, "", "AuditLogResponse"]], "Calculation": [[4, 1, 1, "", "calculate"]], "Client": [[4, 1, 1, "", "getAuthHeader"], [4, 1, 1, "", "getClient"], [4, 1, 1, "", "getClientId"], [4, 1, 1, "", "getClientSource"], [4, 1, 1, "", "getDomain"], [4, 1, 1, "", "getInstance"], [4, 1, 1, "", "refreshToken"]], "Config": [[4, 0, 1, "", "ClientConfig"], [4, 0, 1, "", "RequestConfig"]], "EconomicActivity": [[4, 1, 1, "", "calculate"]], "Factor": [[4, 1, 1, "", "retrieveFactor"], [4, 1, 1, "", "search"]], "Fugitive": [[4, 1, 1, "", "calculate"]], "Location": [[4, 1, 1, "", "calculate"]], "Metadata": [[4, 1, 1, "", "getArea"], [4, 1, 1, "", "getTypes"], [4, 1, 1, "", "getUnits"], [4, 1, 1, "", "postArea"], [4, 1, 1, "", "postTypes"], [4, 1, 1, "", "postUnits"]], "Mobile": [[4, 1, 1, "", "calculate"]], "RealEstate": [[4, 1, 1, "", "calculate"]], "Stationary": [[4, 1, 1, "", "calculate"]], "TransportationAndDistribution": [[4, 1, 1, "", "calculate"]], "TypeRecommender": [[4, 1, 1, "", "search"]], "TypeRecommenderResponse": [[4, 0, 1, "", "ActivityRequest"], [4, 0, 1, "", "TypeRecommenderResponse"]], "Usage": [[4, 1, 1, "", "getUsage"]], "common": [[4, 0, 1, "", "Activity"], [4, 0, 1, "", "ActivityWithFactorId"], [4, 0, 1, "", "CombinedUnitsActivity"], [4, 0, 1, "", "CombinedUnitsActivityWithFactorId"], [4, 0, 1, "", "FactorActivity"], [4, 0, 1, "", "FactorActivityWithFactorId"], [4, 0, 1, "", "Location"], [4, 0, 1, "", "Pagination"], [4, 0, 1, "", "SearchActivity"], [4, 0, 1, "", "Time"]], "request": [[4, 1, 1, "", "makeApiRequest"]], "utils": [[4, 1, 1, "", "findExpiryTime"]]}, "objnames": {"0": ["js", "interface", "JavaScript interface"], "1": ["js", "function", "JavaScript function"], "2": ["js", "class", "JavaScript class"]}, "objtypes": {"0": "js:interface", "1": "js:function", "2": "js:class"}, "terms": {"": [0, 2, 4, 6], "0": [0, 2, 4, 6], "0000000000002": 2, "00001": 2, "00033022": 2, "00035": 2, "00036061": 2, "0067": 2, "01": [2, 4, 6], "01115131": 2, "0292": 2, "02956": 2, "02ae": 2, "04": [4, 6], "05": 6, "06": 4, "1": [2, 4], "10": [2, 4], "1000": 4, "1000000": 4, "12": 4, "121": 4, "1223123": 4, "123": 4, "12345": [4, 6], "123456": 4, "1340000": 2, "14123143": 4, "150": 4, "1500": 4, "1500000": 4, "170": 2, "17000": 4, "190405": 2, "2": [0, 2, 4], "2000": 2, "2000000": 4, "2001": 2, "2020": 4, "2022": [2, 4], "2024": 2, "2025": [2, 4, 6], "2026": 6, "20681091": 2, "20750174": 2, "29df5ecd": 2, "3": [2, 4], "31": [2, 6], "4": 2, "409": 4, "4797": 2, "47a3": 2, "500000": 4, "5000000": 4, "5840000": 2, "5912000": 2, "60": [4, 6], "70000": 2, "831bfca7cecd": 2, "9": 2, "95a7efe7": 2, "9999": [2, 4], "A": [0, 4, 6], "AED": 2, "For": [0, 1, 6], "If": [0, 2, 4, 6], "In": 0, "It": 1, "No": [1, 4], "OR": [1, 4], "Or": [2, 6], "That": 6, "The": [0, 1, 2, 3, 4, 5, 6], "Then": 4, "These": 6, "a7fd": 2, "about": [0, 1, 2, 4, 6], "accept": [0, 1, 2, 4], "access": [1, 4], "accomod": 4, "account": [2, 6], "across": [1, 2, 3, 4], "activ": [2, 3, 4, 6], "activityrequest": 4, "activitysubtyp": 2, "activitytyp": 2, "activitywithfactorid": 4, "adb": 2, "add": [0, 1], "afghani": 2, "afn": 2, "after": 2, "air": 2, "algerian": 2, "all": [1, 2, 4, 6], "alloc": 4, "allow": [2, 6], "allunit": 4, "alreadi": 4, "also": 6, "alwai": [2, 6], "amd": 2, "amend": 2, "an": [2, 4, 6], "ang": 2, "anga": 2, "ani": [4, 6], "antillean": 2, "aoa": 2, "api": [1, 5], "apidomain": 4, "apikei": [0, 1, 2, 4, 6], "appli": 2, "applic": [0, 1, 2, 3, 4], "approach": [0, 5], "appropri": [1, 2, 4], "ar": [2, 3, 4, 6], "arab": 2, "architectur": [3, 5], "area": [2, 3, 4], "areanam": 2, "arearespons": 4, "areatyp": 2, "argentin": 2, "argument": 4, "ariari": 2, "armenian": 2, "aruban": 2, "async": 4, "attempt": 6, "attribut": 4, "aud": 2, "audit": 3, "auditlog": 4, "auditlogrequest": 4, "auditlogrespons": 4, "australian": 2, "auth": 4, "authent": [3, 4, 5], "author": [0, 4], "authurl": [0, 1, 4, 6], "autom": 3, "automat": [0, 1, 2], "avail": [2, 4, 6], "await": [0, 1, 2, 4, 6], "awg": 2, "axio": 0, "azerbaijan": 2, "azn": 2, "b6fd": 2, "bahamian": 2, "bahraini": 2, "baht": 2, "balboa": 2, "bam": 2, "barbado": 2, "base": [2, 3, 4, 6], "basi": 2, "basic": 4, "bbd": 2, "bceao": 2, "bdt": 2, "beac": 2, "bearer": [0, 2, 4], "becom": 2, "befor": [0, 1, 2, 4, 6], "belarusian": 2, "beliz": 2, "bermudian": 2, "best": [3, 5], "bgn": 2, "bhd": 2, "bif": 2, "bill": [3, 4], "birr": 2, "bmd": 2, "bnd": 2, "bob": 2, "bodi": 6, "boliviano": 2, "bol\u00edvar": 2, "boolean": 4, "both": [4, 6], "bov": 2, "brazilian": 2, "britain": 2, "brl": 2, "brunei": 2, "bsd": 2, "btn": 2, "build": 3, "bulgarian": 2, "bulk": [2, 4], "bureau": 2, "burundi": 2, "busi": 3, "bwp": 2, "byn": 2, "bzd": 2, "cabo": 2, "cach": 0, "cad": 2, "calcul": [2, 3, 4, 6], "calculationrequest": 4, "california": [2, 4], "call": [0, 3, 4, 6], "can": [2, 4, 6], "canadian": 2, "cannot": 6, "captur": 2, "carbon": [2, 3], "cargo": [2, 4], "caribbean": 2, "carrier": [2, 4], "catch": 1, "caus": 6, "cayman": 2, "cdf": 2, "cedi": 2, "central": 1, "cfa": 2, "cfp": 2, "ch4": 2, "chain": 3, "chang": 4, "che": 2, "check": [0, 6], "checklist": 3, "chf": 2, "chilean": 2, "chw": 2, "citat": 2, "claim": 6, "class": 4, "classif": 2, "clf": 2, "client": [0, 2, 3, 4, 5], "client123": [4, 6], "clientconfig": 4, "clientid": [0, 1, 2, 4, 6], "climat": 2, "close": 1, "cloud": 6, "clp": 2, "cny": 2, "co2": 2, "coal": [4, 6], "code": [0, 6], "colombian": 2, "colon": 2, "com": [0, 4, 6], "combin": 6, "combinedunitsact": 4, "combinedunitsactivitywithfactorid": 4, "combust": 4, "commerci": [3, 4], "common": [3, 4], "commonrequest": 4, "commonrequestwithfactorid": 4, "commonrequestwithoutfactorid": 4, "comorian": 2, "complet": [4, 6], "complex": 4, "compon": [1, 2, 5], "comprehens": 2, "config": 4, "configur": [3, 4, 5], "confirm": 6, "conflict": 4, "congoles": 2, "connect": [1, 2, 6], "consist": 1, "consol": [1, 4, 6], "const": [2, 4, 6], "consumpt": 3, "contact": 6, "contain": [4, 6], "content": 4, "context": 4, "control": [0, 3, 4], "convers": 3, "conversionratio": 2, "convert": [2, 4], "cop": 2, "cordoba": 2, "correct": 6, "correctli": 6, "correspond": 6, "costa": 2, "cou": 2, "countri": [2, 4, 6], "cover": [2, 5, 6], "coverag": [2, 6], "crc": 2, "credenti": [0, 1, 2], "criteria": 4, "cross": 4, "cuban": 2, "cup": 2, "currenc": 3, "current": [2, 4], "custom": [1, 3, 4], "cve": 2, "czech": 2, "czk": 2, "da03bc007f30": 2, "dai": 2, "dalasi": 2, "danish": 2, "dashboard": 3, "data": [1, 4], "databas": [2, 3], "dataset": 3, "date": [2, 4, 6], "de": 2, "debug": 6, "decis": 3, "decod": 0, "default": [0, 1, 2, 4, 6], "defra": 2, "denar": 2, "depart": 2, "deploy": 0, "descript": [1, 2], "design": [1, 3], "detail": [0, 1, 3, 4, 6], "detect": 0, "determin": 4, "deviat": 2, "diagram": [3, 5], "diesel": 4, "differ": 4, "dinar": 2, "dioxid": 2, "directli": [0, 6], "dirham": 2, "disabl": 4, "distribut": [3, 4], "djf": 2, "djibouti": 2, "dkk": 2, "do": [0, 2, 6], "dobra": 2, "doc": 2, "document": [2, 6], "doe": 6, "doesn": [4, 6], "dollar": 2, "domain": [0, 4, 6], "dominican": 2, "don": 4, "dong": 2, "dop": 2, "dram": 2, "draw": 2, "dure": 6, "dwt": [2, 4], "dzd": 2, "e": [2, 4, 6], "each": 0, "earlier": 2, "earliest": 2, "earth": 2, "east": 2, "econom": [3, 4], "economicact": [2, 4], "egp": 2, "egrid": 2, "egyptian": 2, "either": 1, "el": 2, "electr": [2, 4], "email": 4, "embed": 3, "emiss": [0, 1, 2, 4, 5, 6], "emissionrespons": 4, "emissionresponsewithdetail": 4, "en": 2, "enabl": 6, "enablererank": 4, "encod": 4, "endpoint": [0, 1, 3, 4, 6], "energi": [2, 4], "engin": 3, "enotfound": 6, "ensur": [1, 2, 4, 6], "entir": 2, "env": [0, 1, 2], "environ": [0, 1, 6], "envizi": [0, 1, 5], "envizi_api_kei": [0, 1, 2], "envizi_client_id": [0, 1, 2], "envizi_org_id": [0, 1, 2], "envizi_pat_token": [0, 2], "envizisdk": 2, "epa": 2, "equip": 3, "equival": 2, "ern": 2, "error": [3, 5], "escudo": 2, "especi": 2, "estat": [3, 4], "etb": 2, "etc": 6, "ethiopian": 2, "eur": 2, "euro": 2, "european": 2, "exact": 4, "exampl": [3, 6], "excel": 0, "exclud": 6, "exist": [1, 4, 6], "exp": [0, 6], "expect": 4, "expir": [0, 1, 4, 6], "expiri": [0, 4], "expirytim": 4, "explain": 0, "export": 4, "extern": 0, "extract": 4, "factor": [2, 3, 4], "factoract": 4, "factoractivitywithfactorid": 4, "factorid": [2, 4], "factorrequest": 4, "factorrequestwithfactorid": 4, "factorrequestwithoutfactorid": 4, "factorrespons": 4, "factorset": 2, "fail": 6, "failur": [1, 6], "falkland": 2, "fals": 4, "fc3b": 2, "featur": 2, "fetch": 1, "field": 2, "fiji": 2, "filter": 3, "find": 4, "findexpirytim": [3, 4], "firewal": 6, "first": [3, 4, 6], "fiscal": 2, "fiscal_servic": 2, "fiscaldata": 2, "fix": 3, "fjd": 2, "fkp": 2, "flag": 4, "florin": 2, "flow": [3, 5], "follow": [0, 1, 2, 6], "fomento": 2, "footprint": 3, "forint": 2, "format": [0, 2], "franc": 2, "freight": [2, 4], "frequenc": 2, "fresh": [0, 4], "from": [0, 1, 2, 3, 4, 6], "fuel": [3, 4], "fugit": [3, 4, 6], "fugitivearea": 4, "fugitv": 4, "full": 4, "function": 6, "futur": 0, "g": [2, 4, 6], "ga": [2, 3, 4], "gbp": 2, "gel": 2, "gener": [1, 3, 4, 6], "genericcalculationrequestwithfactorid": 4, "genericcalculationrequestwithoutfactorid": 4, "geograph": [2, 4], "get": [0, 3, 4, 6], "getauditconfig": 4, "getauthhead": 4, "getclient": [0, 1, 2, 4, 6], "getclientid": 4, "getclientsourc": 4, "getconfig": 4, "getdomain": 4, "getinst": [4, 6], "getunit": 6, "getusag": 4, "gh": 2, "ghana": 2, "ghg": [2, 3], "ghgemiss": 0, "gibraltar": 2, "gip": 2, "give": 4, "global": [2, 3], "gmd": 2, "gnf": 2, "gold": 2, "gourd": 2, "gov": 2, "govern": 2, "gracefulli": [1, 4], "great": 2, "greenhous": [2, 3], "grid": 4, "gtq": 2, "guarani": 2, "guid": 3, "guilder": 2, "guinean": 2, "guyana": 2, "gyd": 2, "ha": 6, "handl": [0, 3, 4, 5, 6], "hardcod": 0, "have": [2, 4], "header": [1, 3, 4, 5, 6], "helena": 2, "here": 2, "hi": 2, "histor": [2, 3, 4], "histori": 4, "hkd": 2, "hnl": 2, "hong": 2, "host": [0, 1, 4], "hryvnia": 2, "htg": 2, "http": [0, 1, 2, 4], "httpcode": 6, "httpmessag": 6, "huf": 2, "human": 2, "i": [0, 1, 2, 3, 4, 6], "ibm": [0, 1, 5, 6], "ibmid": 2, "iceland": 2, "id": [0, 1, 4], "identifi": [0, 2, 3, 4], "idr": 2, "il": 2, "implement": [0, 1, 6], "import": [0, 1], "includ": [0, 2, 4, 6], "includedetail": 4, "indexada": 2, "indian": 2, "indic": 4, "indirect": 2, "indirectco2": 2, "industri": 4, "inform": [0, 1, 2, 4], "init": 0, "initi": [0, 2, 3, 4, 5], "input": 2, "inputunit": 2, "inr": 2, "instal": 3, "instanc": [1, 3, 4], "instead": [4, 6], "integr": [3, 5], "intend": 2, "interact": [4, 5], "interfac": [1, 3], "internet": 2, "introduct": 2, "invalid_api_key_12345": 6, "invers": 2, "involv": 4, "iqd": 2, "iranian": 2, "iraqi": 2, "ireland": 2, "irr": 2, "isk": 2, "island": 2, "isra": 2, "issu": [2, 6], "isuserprovidedtoken": 4, "j": [0, 1, 2, 5, 6], "jamaican": 2, "jet": 4, "jetkeroseneunit": 4, "jmd": 2, "jod": 2, "jordanian": 2, "jpy": 2, "json": [0, 2, 4], "jwt": [0, 4, 6], "jwt_token": [0, 2], "jwttoken": 4, "ke": 2, "kei": [1, 4, 5], "kenyan": 2, "kerosen": 4, "kg": [2, 4], "kgco2e": 2, "khr": 2, "kina": 2, "kingdom": 2, "kip": 2, "kj": [4, 6], "km": [2, 4], "kmf": 2, "known": 4, "kong": 2, "korean": 2, "koruna": 2, "kpw": 2, "krona": 2, "krone": 2, "krw": 2, "kuwaiti": 2, "kwacha": 2, "kwanza": 2, "kwd": 2, "kwh": [2, 4], "kyat": 2, "kyd": 2, "kzt": 2, "l": 4, "lack": 6, "lak": 2, "lanka": 2, "lao": 2, "larg": 3, "lari": 2, "last": 6, "layer": 0, "lbp": 2, "leader": 2, "leak": 3, "least": 0, "lebanes": 2, "lek": 2, "lempira": 2, "leon": 2, "let": 1, "leu": 2, "lev": 2, "level": 2, "liberian": 2, "libyan": 2, "licenc": 2, "licens": [2, 4], "lignit": [4, 6], "like": 3, "lilangeni": 2, "lira": 2, "list": 6, "lkr": 2, "ll": 6, "locat": [2, 3, 4, 6], "locationemiss": 2, "locationrequest": 4, "locationrequestwithfactorid": 4, "locationrequestwithoutfactorid": 4, "locationtyp": 4, "log": 3, "logist": 3, "logrequest": 4, "logrespons": 4, "look": 4, "loti": 2, "lrd": 2, "lsl": 2, "lyd": 2, "m2": 4, "mad": 2, "made": 4, "mai": 4, "maintain": 1, "majesti": 2, "make": [2, 3, 4], "makeapirequest": [0, 3, 4], "malagasi": 2, "malawi": 2, "malaysian": 2, "malform": 6, "manag": [0, 1, 2, 3], "manat": 2, "mani": 2, "march": 2, "mark": 2, "match": 6, "mauritiu": 2, "mdl": 2, "measur": [2, 4], "messag": [1, 4, 6], "metadata": 3, "methan": 2, "method": [1, 2, 3, 4, 5, 6], "methodologi": 2, "metic": 2, "metric": 4, "mexican": 2, "mga": 2, "mkd": 2, "mmk": 2, "mnt": 2, "mobil": [3, 4, 6], "mobilearea": 4, "mode": 0, "modul": [1, 2], "moldovan": 2, "monetari": 2, "mop": 2, "more": [0, 2, 6], "moreinform": 6, "moroccan": 2, "most": 2, "mozambiqu": 2, "mru": 2, "multipl": 4, "mur": 2, "must": 6, "mvdol": 2, "mvr": 2, "mwh": 4, "mwk": 2, "mxn": 2, "mxv": 2, "myr": 2, "mzn": 2, "n": 6, "n2o": 2, "nad": 2, "naira": 2, "nakfa": 2, "name": [2, 4], "namibia": 2, "nationalarch": 2, "natur": 4, "naturalgasunit": 4, "necessari": 0, "need": [0, 2, 4], "nepales": 2, "net": 2, "netherland": 2, "network": 6, "never": 0, "new": [0, 2, 4], "next": 2, "ngn": 2, "ngultrum": 2, "nio": 2, "nitrou": 2, "node": [0, 1, 2, 5, 6], "nok": 2, "north": 2, "northern": 2, "norwegian": 2, "note": [4, 6], "npm": 2, "npr": 2, "null": 6, "nzd": 2, "oauth": 0, "object": [2, 4], "obtain": [1, 2], "occur": [0, 6], "offic": 4, "offici": 2, "old": 0, "omani": 2, "omr": 2, "onc": [0, 1], "one": [0, 1], "onli": [0, 1, 4, 6], "onward": 2, "open": 2, "oper": [1, 3, 4, 6], "optim": 1, "option": [0, 3, 4, 5, 6], "org": 6, "org456": [4, 6], "organ": [0, 1, 2, 3, 4], "orgid": [0, 1, 2, 4, 6], "oro": 2, "other": [4, 6], "otherwis": 4, "ouguiya": 2, "output": 4, "outsid": 2, "outstandingamount": 4, "overview": [3, 5], "oxid": 2, "pa": 2, "pab": 2, "page": [0, 1, 2, 4], "pagin": 4, "pakistan": 2, "param": [0, 4], "paramet": [0, 1, 3, 4], "part": 4, "pass": 6, "pat": 4, "pataca": 2, "pattern": 5, "pattoken": [0, 2, 4, 6], "payload": 4, "pen": 2, "per": 2, "perform": 4, "period": [3, 4], "permiss": 6, "person": 4, "peso": 2, "pgk": 2, "philippin": 2, "php": 2, "physicalact": 2, "pkr": 2, "planet": 2, "pln": 2, "point": [4, 6], "polici": 2, "post": 4, "postarea": 4, "posttyp": 4, "postunit": 4, "pound": 2, "power": 4, "powergrid": 4, "practic": [3, 5], "pre": [1, 6], "prefer": 2, "prerequisit": 3, "prevision": 2, "primarili": 2, "principl": 0, "privileg": 0, "proce": 4, "process": [0, 1, 2], "product": [0, 1], "project": [2, 3], "promis": 4, "proper": [0, 1, 6], "properli": 6, "properti": [3, 4], "propertyvalu": 4, "proport": 4, "protocol": 2, "provid": [0, 1, 2, 4, 5], "public": 2, "publish": 2, "publishedfrom": 2, "pula": 2, "purchas": 4, "purpos": [2, 4], "pyg": 2, "qar": 2, "qatari": 2, "quarterli": 2, "queri": [0, 3, 4], "quetzal": 2, "quick": 2, "r134a": 4, "rand": 2, "ratio": 2, "re": [0, 6], "read": 2, "readabl": 2, "real": [2, 3, 4], "realest": [2, 4], "recommend": [2, 3], "record": 4, "refer": 3, "refresh": [1, 2, 4], "refreshtoken": 4, "regener": 6, "region": [2, 3], "relat": [2, 4, 6], "relev": 4, "remov": 6, "renew": 4, "renminbi": 2, "replac": 0, "report": 2, "repres": 4, "reproduc": 6, "request": [0, 1, 2, 3, 4], "requestconfig": 4, "requestwithattribut": 4, "requir": [0, 1, 2, 3], "rerank": [3, 4], "residenti": 3, "resolv": 4, "respond": 6, "respons": [0, 3, 4, 5], "restart": 6, "result": [2, 3, 4], "resultwithattribut": 4, "retriev": [2, 3, 4], "retrievefactor": 4, "return": [0, 2, 4, 6], "reus": 1, "revenu": 4, "review": 6, "revok": 6, "rial": 2, "rican": 2, "riel": 2, "right": 2, "ringgit": 2, "riyal": 2, "romanian": 2, "ron": 2, "rsd": 2, "rub": 2, "rubl": 2, "rufiyaa": 2, "run": 0, "rupe": 2, "rupiah": 2, "russian": 2, "rwanda": 2, "rwf": 2, "saascor": 0, "saint": 2, "salvador": 2, "sampl": 6, "sar": 2, "saudi": 2, "sbd": 2, "scale": 3, "scenario": [0, 3], "scope": [2, 3, 4], "scr": 2, "sdg": 2, "sdk": [0, 1, 2, 4], "sdr": 2, "search": [3, 4], "searchact": 4, "searchrequest": 4, "searchrespons": 4, "searchwithboth": 4, "searchwithoutrerank": 4, "searchwithscop": 4, "searchwithunit": 4, "second": [4, 6], "secret": 6, "section": 5, "secur": [1, 2, 3, 5, 6], "see": [0, 1], "sek": 2, "select": 2, "semant": [3, 4], "send": 0, "sensit": 6, "sent": 4, "serbian": 2, "server": 6, "servic": [0, 1, 2, 6], "set": [2, 4, 6], "sever": 1, "seychel": 2, "sgd": 2, "sheqel": 2, "shill": 2, "ship": [2, 4], "should": [4, 6], "shp": 2, "sign": 2, "singapor": 2, "singl": 4, "singleton": [0, 1, 4], "site": 2, "size": 4, "sle": 2, "so": 2, "soberano": 2, "sol": 2, "solomon": 2, "solut": 6, "som": 2, "somali": 2, "somoni": 2, "soon": 2, "sourc": [0, 2, 3, 4], "sourceurl": 2, "south": 2, "special": 2, "specif": [1, 2, 3, 4, 6], "specifi": [2, 4], "spend": [3, 4], "srd": 2, "sri": 2, "ssp": 2, "stack": 6, "standard": [4, 6], "start": [3, 6], "startup": 1, "state": 2, "stateprovinc": [2, 4], "static": 4, "stationari": [3, 4, 6], "stationarytyp": 4, "statu": [1, 4, 6], "steam": 6, "steel": 4, "step": [0, 3], "sterl": 2, "stn": 2, "storag": 4, "store": [0, 1, 3, 4, 6], "string": [0, 4], "structur": 5, "subsequ": 6, "subtyp": 2, "successfulli": 6, "sucr": 2, "sudanes": 2, "sum": 2, "summari": 3, "suppli": 3, "support": [1, 4], "surinam": 2, "sustain": 3, "svc": 2, "swedish": 2, "swiss": 2, "symbol": 2, "synchron": 2, "syp": 2, "syrian": 2, "system": 2, "szl": 2, "t": [2, 4, 6], "tabl": [3, 4], "taiwan": 2, "taka": 2, "tala": 2, "tanzanian": 2, "target": 6, "teng": 2, "than": 2, "thb": 2, "thei": [2, 4, 6], "them": 2, "thi": [0, 2, 4, 5, 6], "three": [0, 2, 6], "throw": 6, "thrown": 6, "time": [0, 4, 6], "timestamp": 4, "tj": 2, "tmt": 2, "tnd": 2, "tobago": 2, "togeth": 6, "toisostr": 4, "token": [1, 3, 4], "tonn": 2, "top": 2, "total": 2, "totalco2": 2, "trace": 6, "track": 3, "transactionid": 2, "transport": [2, 3, 4], "transportationanddistribut": 4, "travel": [2, 4], "treasuri": 2, "trim": 0, "trinidad": 2, "troubleshoot": 3, "true": 4, "try": [1, 2], "ttd": 2, "tugrik": 2, "tunisian": 2, "turkish": 2, "turkmenistan": 2, "twd": 2, "type": [2, 6], "typerecommend": 4, "typerecommenderrespons": 4, "typerespons": 4, "typic": 2, "tz": 2, "u": 2, "uae": 2, "uah": 2, "udi": 2, "uganda": 2, "ugx": 2, "ui": 2, "uk": 2, "unauthor": 6, "unidad": 2, "unifi": [1, 4], "uniqu": 2, "unit": [2, 3, 4, 6], "unitrespons": 4, "unix": 4, "unless": 1, "unreach": 6, "uom": 4, "up": [2, 4, 6], "updat": [2, 4, 6], "updateauditconfig": 4, "url": [0, 2, 4], "uruguai": 2, "uruguayo": 2, "us": [0, 1, 3, 4, 6], "usa": [2, 4, 6], "usag": [1, 3, 5], "usagerespons": 4, "usd": [2, 4], "user": [0, 1, 2, 4, 6], "userdata": 4, "usn": 2, "util": [3, 4], "uyi": 2, "uyu": 2, "uyw": 2, "uz": 2, "uzbekistan": 2, "v": [0, 1], "valid": [0, 1, 2, 6], "valor": 2, "valu": [2, 4, 6], "variabl": [0, 1, 6], "vatu": 2, "ve": 2, "ved": 2, "vehicl": 3, "verd": 2, "verifi": [1, 6], "version": [2, 6], "vnd": 2, "void": 4, "vuv": 2, "wa": [2, 4, 6], "wai": 4, "warehous": 4, "wast": 4, "web": 4, "wecc": 4, "when": [0, 2, 4, 6], "where": [0, 2, 4], "whether": [3, 4], "which": [0, 2, 4], "while": 2, "wir": 2, "within": [4, 6], "without": [4, 6], "won": 2, "work": 1, "wrong": 6, "wst": 2, "www": 2, "x": [0, 4], "xad": 2, "xaf": 2, "xcd": 2, "xcg": 2, "xdr": 2, "xof": 2, "xpf": 2, "xsu": 2, "xua": 2, "yarn": 2, "ye": 1, "year": 2, "yemeni": 2, "yen": 2, "yer": 2, "york": 4, "you": [0, 2, 6], "your": [0, 1, 2, 3, 4, 6], "yuan": 2, "zambian": 2, "zar": 2, "zealand": 2, "zero": 2, "zimbabw": 2, "zloti": 2, "zmw": 2, "zwg": 2}, "titles": ["Authentication", "Client", "Getting Started", "IBM Envizi - Emissions API Node.js SDK", "Reference", "SDK", "Troubleshooting Guide"], "titleterms": {"1": 6, "10": 6, "2": 6, "3": 6, "4": 6, "401": 6, "5": 6, "6": 6, "7": 6, "8": 6, "9": 6, "Not": 6, "access": [0, 2, 6], "addit": 3, "api": [0, 2, 3, 4, 6], "applic": 6, "architectur": 0, "audit": 4, "auth": 6, "authent": [0, 1, 2, 6], "automat": 6, "basic": 2, "best": [0, 1], "call": 2, "capabl": 3, "checklist": 6, "client": [1, 6], "common": 6, "configur": [1, 6], "content": 3, "convers": 2, "credenti": 6, "currenc": 2, "custom": 6, "data": 2, "detail": 2, "diagram": 0, "emiss": 3, "empti": 6, "envizi": 3, "error": [1, 6], "exampl": [2, 4], "exchang": 2, "expiri": 6, "field": 6, "first": 2, "flow": 0, "gener": [0, 2], "get": 2, "getarea": 4, "gettyp": 4, "getunit": 4, "global": 4, "guid": 6, "handl": 1, "header": 0, "host": 6, "http": 6, "ibm": 3, "id": 6, "import": 2, "initi": [1, 6], "instal": 2, "instanc": 6, "integr": 1, "interfac": 4, "introduct": 3, "invalid": 6, "j": 3, "jwt": 2, "kei": [0, 2, 6], "lifetim": 0, "log": 4, "manag": 6, "metadata": 4, "method": 0, "miss": 6, "node": 3, "option": 1, "organ": 6, "overview": [0, 1, 2, 6], "paramet": 6, "pat": [0, 2, 6], "person": [0, 2, 6], "practic": [0, 1], "pre": [0, 2], "prerequisit": 2, "provid": 6, "rate": 2, "recommend": [0, 4, 6], "refer": 4, "refresh": [0, 6], "requir": 6, "respons": [1, 2, 6], "retriev": 0, "scenario": 6, "sdk": [3, 5, 6], "secur": 0, "start": 2, "startup": 6, "step": 6, "structur": 2, "summari": 6, "support": [2, 3, 6], "tabl": 6, "token": [0, 2, 6], "troubleshoot": 6, "type": [3, 4], "url": 6, "us": 2, "usag": 4}})

package/docs/troubleshooting.html

@@ -207,6 +207,8 @@
 <li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="authentication.html">Authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Troubleshooting Guide</a></li>
 </ul>
@@ -322,13 +324,48 @@
 </pre></div>
 </div>
 </section>
+<hr class="docutils" />
+<section id="missing-client-id-with-pat-token">
+<h4>4. Missing Client ID with PAT Token<a class="headerlink" href="#missing-client-id-with-pat-token" title="Link to this heading">¶</a></h4>
+<p><strong>Error Message:</strong></p>
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Error: If patToken is provided, &quot;clientId&quot; must also be provided.
+</pre></div>
+</div>
+<p><strong>Cause:</strong> Personal Access Token (PAT) provided without client ID</p>
+<p><strong>Solution:</strong> Provide <code class="docutils literal notranslate"><span class="pre">clientId</span></code> parameter when using a PAT token</p>
+<p><strong>Sample Function Call That Causes This Error:</strong></p>
+<div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">patToken</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;your-pat-token&#39;</span>
+<span class="w">  </span><span class="c1">// Missing clientId parameter</span>
+<span class="p">});</span>
+</pre></div>
+</div>
+</section>
+<hr class="docutils" />
+<section id="organization-id-provided-with-pat-token">
+<h4>5. Organization ID Provided with PAT Token<a class="headerlink" href="#organization-id-provided-with-pat-token" title="Link to this heading">¶</a></h4>
+<p><strong>Error Message:</strong></p>
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Error: orgId should not be provided when using patToken.
+</pre></div>
+</div>
+<p><strong>Cause:</strong> Organization ID should not be used with Personal Access Token authentication</p>
+<p><strong>Solution:</strong> Remove <code class="docutils literal notranslate"><span class="pre">orgId</span></code> parameter when using PAT token authentication</p>
+<p><strong>Sample Function Call That Causes This Error:</strong></p>
+<div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">patToken</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;your-pat-token&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;client123&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;org456&#39;</span><span class="w">  </span><span class="c1">// This should not be provided with PAT token</span>
+<span class="p">});</span>
+</pre></div>
+</div>
+</section>
 </section>
 <hr class="docutils" />
 <section id="authentication-errors-http-401">
 <h3>Authentication Errors (HTTP 401)<a class="headerlink" href="#authentication-errors-http-401" title="Link to this heading">¶</a></h3>
 <p>These errors occur when authentication credentials are invalid or expired.</p>
 <section id="invalid-api-key">
-<h4>4. Invalid API Key<a class="headerlink" href="#invalid-api-key" title="Link to this heading">¶</a></h4>
+<h4>6. Invalid API Key<a class="headerlink" href="#invalid-api-key" title="Link to this heading">¶</a></h4>
 <p><strong>Error Response:</strong></p>
 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 <span class="w">  </span><span class="nt">&quot;httpCode&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;401&quot;</span><span class="p">,</span>
@@ -352,7 +389,7 @@
 </section>
 <hr class="docutils" />
 <section id="invalid-organization-id">
-<h4>5. Invalid Organization ID<a class="headerlink" href="#invalid-organization-id" title="Link to this heading">¶</a></h4>
+<h4>7. Invalid Organization ID<a class="headerlink" href="#invalid-organization-id" title="Link to this heading">¶</a></h4>
 <p><strong>Error Response:</strong></p>
 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 <span class="w">  </span><span class="nt">&quot;httpCode&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;401&quot;</span><span class="p">,</span>
@@ -376,7 +413,7 @@
 </section>
 <hr class="docutils" />
 <section id="invalid-client-id">
-<h4>6. Invalid Client ID<a class="headerlink" href="#invalid-client-id" title="Link to this heading">¶</a></h4>
+<h4>8. Invalid Client ID<a class="headerlink" href="#invalid-client-id" title="Link to this heading">¶</a></h4>
 <p><strong>Error Response:</strong></p>
 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 <span class="w">  </span><span class="nt">&quot;httpCode&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;401&quot;</span><span class="p">,</span>
@@ -400,7 +437,7 @@
 </section>
 <hr class="docutils" />
 <section id="empty-token-response">
-<h4>7. Empty Token Response<a class="headerlink" href="#empty-token-response" title="Link to this heading">¶</a></h4>
+<h4>9. Empty Token Response<a class="headerlink" href="#empty-token-response" title="Link to this heading">¶</a></h4>
 <p><strong>Error Message:</strong></p>
 <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Error: Token response is empty
 </pre></div>
@@ -429,7 +466,7 @@
 </section>
 <hr class="docutils" />
 <section id="missing-expiry-field-in-token">
-<h4>8. Missing Expiry Field in Token<a class="headerlink" href="#missing-expiry-field-in-token" title="Link to this heading">¶</a></h4>
+<h4>10. Missing Expiry Field in Token<a class="headerlink" href="#missing-expiry-field-in-token" title="Link to this heading">¶</a></h4>
 <p><strong>Error Message:</strong></p>
 <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Error: exp field is missing in the token
 </pre></div>
@@ -531,6 +568,16 @@
 <td><p>N/A</p></td>
 <td><p>Provide all three parameters</p></td>
 </tr>
+<tr class="row-odd"><td><p>Configuration</p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">If</span> <span class="pre">patToken</span> <span class="pre">is</span> <span class="pre">provided,</span> <span class="pre">&quot;clientId&quot;</span> <span class="pre">must</span> <span class="pre">also</span> <span class="pre">be</span> <span class="pre">provided.</span></code></p></td>
+<td><p>N/A</p></td>
+<td><p>Provide clientId with PAT token</p></td>
+</tr>
+<tr class="row-even"><td><p>Configuration</p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">orgId</span> <span class="pre">should</span> <span class="pre">not</span> <span class="pre">be</span> <span class="pre">provided</span> <span class="pre">when</span> <span class="pre">using</span> <span class="pre">patToken.</span></code></p></td>
+<td><p>N/A</p></td>
+<td><p>Remove orgId when using PAT token</p></td>
+</tr>
 <tr class="row-odd"><td><p>Authentication</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">Cannot</span> <span class="pre">pass</span> <span class="pre">the</span> <span class="pre">security</span> <span class="pre">checks...</span></code></p></td>
 <td><p>401</p></td>
@@ -564,14 +611,22 @@
 <section id="required-configuration-parameters">
 <h2>Required Configuration Parameters<a class="headerlink" href="#required-configuration-parameters" title="Link to this heading">¶</a></h2>
 <p>When calling <code class="docutils literal notranslate"><span class="pre">Client.getClient()</span></code>, the following parameters are required based on authentication method:</p>
-<section id="api-key-authentication-recommended">
-<h3>API Key Authentication (Recommended)<a class="headerlink" href="#api-key-authentication-recommended" title="Link to this heading">¶</a></h3>
+<section id="personal-access-token-pat-authentication-recommended">
+<h3>Personal Access Token (PAT) Authentication (Recommended)<a class="headerlink" href="#personal-access-token-pat-authentication-recommended" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">patToken</span></code> - Your Personal Access Token</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">clientId</span></code> - Your client ID</p></li>
+</ul>
+<p><strong>Note:</strong> Do not provide <code class="docutils literal notranslate"><span class="pre">orgId</span></code> when using PAT token authentication.</p>
+</section>
+<section id="api-key-authentication">
+<h3>API Key Authentication<a class="headerlink" href="#api-key-authentication" title="Link to this heading">¶</a></h3>
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">apiKey</span></code> - Your IBM Cloud API key</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">clientId</span></code> - Your client ID</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">orgId</span></code> - Your organization ID</p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">host</span></code> - API host URL</p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">authUrl</span></code> - Authentication URL</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">host</span></code> - API host URL (optional, uses default if not provided)</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">authUrl</span></code> - Authentication URL (optional, uses default if not provided)</p></li>
 </ul>
 </section>
 <section id="token-authentication">
@@ -671,8 +726,8 @@
 </li>
 </ol>
 <hr class="docutils" />
-<p><strong>Last Updated:</strong> 2025-11-24</p>
-<p><strong>SDK Version:</strong> 1.0.1</p>
+<p><strong>Last Updated:</strong> 2026-05-31</p>
+<p><strong>SDK Version:</strong> 1.0.2</p>
 <p><strong>Coverage:</strong> SDK initialization, client instance, and authentication errors</p>
 </section>
 </section>
@@ -731,14 +786,16 @@
 <li><a class="reference internal" href="#missing-auth-url-with-custom-host">1. Missing Auth URL with Custom Host</a></li>
 <li><a class="reference internal" href="#missing-client-id-with-token">2. Missing Client ID with Token</a></li>
 <li><a class="reference internal" href="#missing-parameters-with-api-key">3. Missing Parameters with API Key</a></li>
+<li><a class="reference internal" href="#missing-client-id-with-pat-token">4. Missing Client ID with PAT Token</a></li>
+<li><a class="reference internal" href="#organization-id-provided-with-pat-token">5. Organization ID Provided with PAT Token</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#authentication-errors-http-401">Authentication Errors (HTTP 401)</a><ul>
-<li><a class="reference internal" href="#invalid-api-key">4. Invalid API Key</a></li>
-<li><a class="reference internal" href="#invalid-organization-id">5. Invalid Organization ID</a></li>
-<li><a class="reference internal" href="#invalid-client-id">6. Invalid Client ID</a></li>
-<li><a class="reference internal" href="#empty-token-response">7. Empty Token Response</a></li>
-<li><a class="reference internal" href="#missing-expiry-field-in-token">8. Missing Expiry Field in Token</a></li>
+<li><a class="reference internal" href="#invalid-api-key">6. Invalid API Key</a></li>
+<li><a class="reference internal" href="#invalid-organization-id">7. Invalid Organization ID</a></li>
+<li><a class="reference internal" href="#invalid-client-id">8. Invalid Client ID</a></li>
+<li><a class="reference internal" href="#empty-token-response">9. Empty Token Response</a></li>
+<li><a class="reference internal" href="#missing-expiry-field-in-token">10. Missing Expiry Field in Token</a></li>
 </ul>
 </li>
 </ul>
@@ -753,7 +810,8 @@
 </li>
 <li><a class="reference internal" href="#error-summary-table">Error Summary Table</a></li>
 <li><a class="reference internal" href="#required-configuration-parameters">Required Configuration Parameters</a><ul>
-<li><a class="reference internal" href="#api-key-authentication-recommended">API Key Authentication (Recommended)</a></li>
+<li><a class="reference internal" href="#personal-access-token-pat-authentication-recommended">Personal Access Token (PAT) Authentication (Recommended)</a></li>
+<li><a class="reference internal" href="#api-key-authentication">API Key Authentication</a></li>
 <li><a class="reference internal" href="#token-authentication">Token Authentication</a></li>
 </ul>
 </li>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "emissions-api-sdk",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "sdk for IBM Emissions APIs",
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",
@@ -35,14 +35,18 @@
   "author": "santhosh0703,Prakhar-sahu,taylorsteffanj",
   "license": "Apache-2.0",
   "resolutions": {
+    "@babel/core": "^7.29.6",
+    "brace-expansion": "^5.0.6",
     "follow-redirects": "^1.16.0",
+    "form-data": "^4.0.6",
     "handlebars": "^4.7.9",
-    "markdown-it": "^14.1.1",
+    "js-yaml": "^4.2.0",
+    "markdown-it": "^14.2.0",
     "minimatch": "^10.2.5",
     "test-exclude": "^7.0.1"
   },
   "dependencies": {
-    "axios": "1.15.2"
+    "axios": "1.16.0"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",

package/sphinx-build/source/authentication.rst

@@ -10,17 +10,39 @@ The IBM Envizi - Emissions API Node.js SDK uses OAuth 2.0 Bearer Tokens for auth
 Authentication Methods
 ----------------------
 
-The SDK provides two authentication methods:
+The SDK provides three authentication methods:
 
-API Key Authentication (Recommended)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Personal Access Token (PAT) Authentication (Recommended)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This method uses a personal access token directly:
+
+.. code-block:: javascript
+
+    import { Client } from 'emissions-api-sdk';
+
+    await Client.getClient({
+      patToken: process.env.ENVIZI_PAT_TOKEN,
+      clientId: process.env.ENVIZI_CLIENT_ID
+    });
+
+**Required parameters:**
+    - ``patToken``: Your personal access token
+    - ``clientId``: Your client identifier
+
+.. note::
+
+   When using a PAT token, do not provide ``orgId``.
+
+API Key Authentication
+~~~~~~~~~~~~~~~~~~~~~~
 
 This method automatically handles token generation and refreshing:
 
 .. code-block:: javascript
 
     import { Client } from 'emissions-api-sdk';
-    
+
     await Client.getClient({
       apiKey: process.env.ENVIZI_API_KEY,
       clientId: process.env.ENVIZI_CLIENT_ID,