emissions-api-sdk 1.0.0 → 1.0.1

package/docs/searchindex.js

@@ -0,0 +1 @@
+Search.setIndex({"alltitles":{"API":[[4,"api"]],"API Key Authentication (Recommended)":[[0,"api-key-authentication-recommended"]],"Architecture Diagram":[[0,"architecture-diagram"]],"Authentication":[[0,null],[2,"authentication"]],"Authentication Flow":[[0,"authentication-flow"]],"Authentication Headers":[[0,"authentication-headers"]],"Authentication Integration":[[1,"authentication-integration"]],"Authentication Methods":[[0,"authentication-methods"]],"Basic Import":[[2,"basic-import"]],"Best Practices":[[1,"best-practices"]],"Client":[[1,null]],"Client Initialization":[[1,"client-initialization"]],"Client Responsibilities":[[1,"client-responsibilities"]],"Configuration Options":[[1,"configuration-options"]],"Contents:":[[3,null]],"Error Handling":[[1,"error-handling"]],"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]],"Example Response":[[2,"example-response"]],"First API Call":[[2,"first-api-call"]],"Getting Started":[[2,null]],"IBM Envizi - Emissions API Node.js SDK":[[3,null]],"Installation":[[2,"installation"]],"Interfaces":[[4,"interfaces"]],"Introduction":[[3,"introduction"]],"Metadata APIs":[[4,"metadata-apis"]],"Overview":[[0,"overview"],[1,"overview"]],"Pre-generated Token Authentication":[[0,"pre-generated-token-authentication"]],"Prerequisites":[[2,"prerequisites"]],"Reference":[[4,null]],"SDK":[[5,null]],"Security Best Practices":[[0,"security-best-practices"]],"Supported Emission Types":[[3,"supported-emission-types"]],"Token lifetime & refresh":[[0,"token-lifetime-refresh"]],"Token retrieval":[[0,"token-retrieval"]],"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"],"envversion":{"sphinx":65,"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"],"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]],"calculation.getarea() (calculation method)":[[4,"Calculation.getArea",false]],"calculation.gettypes() (calculation method)":[[4,"Calculation.getTypes",false]],"calculation.getunits() (calculation method)":[[4,"Calculation.getUnits",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]],"factor.getarea() (factor method)":[[4,"Factor.getArea",false]],"factor.getsearcharea() (factor method)":[[4,"Factor.getSearchArea",false]],"factor.gettypes() (factor method)":[[4,"Factor.getTypes",false]],"factor.getunits() (factor method)":[[4,"Factor.getUnits",false]],"factor.retrievefactor() (factor method)":[[4,"Factor.retrieveFactor",false]],"fugitive.calculate() (fugitive method)":[[4,"Fugitive.calculate",false]],"fugitive.getarea() (fugitive method)":[[4,"Fugitive.getArea",false]],"fugitive.gettypes() (fugitive method)":[[4,"Fugitive.getTypes",false]],"fugitive.getunits() (fugitive method)":[[4,"Fugitive.getUnits",false]],"location.calculate() (location method)":[[4,"Location.calculate",false]],"location.getarea() (location method)":[[4,"Location.getArea",false]],"location.gettypes() (location method)":[[4,"Location.getTypes",false]],"location.getunits() (location method)":[[4,"Location.getUnits",false]],"mobile.calculate() (mobile method)":[[4,"Mobile.calculate",false]],"mobile.getarea() (mobile method)":[[4,"Mobile.getArea",false]],"mobile.gettypes() (mobile method)":[[4,"Mobile.getTypes",false]],"mobile.getunits() (mobile method)":[[4,"Mobile.getUnits",false]],"request.makeapirequest() (request method)":[[4,"request.makeApiRequest",false]],"stationary.calculate() (stationary method)":[[4,"Stationary.calculate",false]],"stationary.getarea() (stationary method)":[[4,"Stationary.getArea",false]],"stationary.gettypes() (stationary method)":[[4,"Stationary.getTypes",false]],"stationary.getunits() (stationary method)":[[4,"Stationary.getUnits",false]],"transportationanddistribution.calculate() (transportationanddistribution method)":[[4,"TransportationAndDistribution.calculate",false]],"transportationanddistribution.getarea() (transportationanddistribution method)":[[4,"TransportationAndDistribution.getArea",false]],"transportationanddistribution.gettypes() (transportationanddistribution method)":[[4,"TransportationAndDistribution.getTypes",false]],"transportationanddistribution.getunits() (transportationanddistribution method)":[[4,"TransportationAndDistribution.getUnits",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"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"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"]],"Factor":[[4,1,1,"","getArea"],[4,1,1,"","getSearchArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"],[4,1,1,"","retrieveFactor"]],"Fugitive":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Location":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Mobile":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Stationary":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"TransportationAndDistribution":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"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],"0":[0,2,4],"00033022":2,"00036061":2,"01":4,"01115131":2,"02ae":2,"04":4,"1":[2,4],"1000":4,"121":4,"1223123":4,"123":4,"12345":4,"14123143":4,"150":4,"1500000":4,"2":[0,4],"2022":[2,4],"2025":4,"20681091":2,"20750174":2,"263fb":4,"3":4,"426a":4,"47a3":2,"60":4,"831bfca7cecd":2,"95a7efe7":2,"9999":4,"A":[0,4],"For":[0,1],"If":[0,2],"In":0,"It":1,"No":1,"OR":[1,4],"Or":2,"The":[0,1,2,3,4,5],"Then":4,"a7fd":2,"aaa":4,"about":[0,1,4],"accept":[0,1,2],"access":[0,1,4],"across":1,"activ":[2,3,4],"activitywithfactorid":4,"add":[0,1],"after":2,"all":[1,4],"alreadi":[2,4],"an":[2,4],"ani":4,"api":[1,5],"apidomain":4,"apikei":[0,1,2,4],"applic":[0,1,2,3,4],"approach":[0,5],"appropri":[1,4],"ar":2,"architectur":5,"area":[2,4],"argument":4,"async":[2,4],"auth":4,"authent":[3,4,5],"author":[0,4],"authurl":[0,1,4],"autom":3,"automat":[0,1],"avail":[2,4],"await":[0,1,2,4],"axio":0,"b20":4,"base":[2,4],"bearer":[0,4],"befor":[0,1,2,4],"best":5,"boolean":4,"build":3,"bulk":4,"busi":4,"cach":0,"calcul":[2,3,4],"calculateemiss":2,"calculationrequest":4,"california":2,"call":[0,3],"can":[2,4],"car":4,"carbon":3,"cargo":4,"carrier":4,"catch":[1,2],"central":1,"ch4":2,"chain":3,"check":0,"class":4,"client":[0,2,3,4,5],"client123":4,"clientconfig":4,"clientid":[0,1,2,4],"climat":2,"close":1,"co2":2,"coal":4,"code":0,"com":[0,2,4],"combinedunitsact":4,"combinedunitsactivitywithfactorid":4,"combust":4,"common":4,"commonrequest":4,"commonrequestwithfactorid":4,"commonrequestwithoutfactorid":4,"complet":4,"complex":4,"compon":[1,5],"config":4,"configur":[4,5],"connect":[1,2],"consist":1,"consol":[1,2,4],"const":[2,4],"consumpt":3,"contain":4,"content":4,"control":0,"convert":4,"countri":[2,4],"cover":5,"credenti":[0,1,2],"criteria":4,"custom":[1,3,4],"dashboard":3,"data":[1,4],"databas":3,"dataset":3,"date":4,"decis":3,"decod":0,"default":[0,1,4],"deploy":0,"descript":[1,2],"design":[1,3],"detail":[0,1,4],"detect":0,"determin":4,"diagram":5,"diesel":4,"directli":2,"distribut":[3,4],"doesn":4,"domain":[0,4],"dwt":4,"e":[2,4],"each":0,"egrid":2,"either":1,"electr":[2,4],"email":4,"embed":3,"emiss":[0,1,2,4,5],"endpoint":[0,1,2,4],"energi":4,"engin":3,"ensur":[1,2,4],"entir":2,"env":[0,1],"environ":[0,1],"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,5],"exact":4,"exampl":3,"excel":0,"exist":[1,4],"exp":0,"expect":4,"expir":[0,1,4],"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,"fail":2,"failur":1,"fals":4,"fetch":1,"find":4,"findexpirytim":[3,4],"first":[3,4],"fix":3,"flow":5,"follow":[0,1,2],"footprint":3,"format":[0,2],"freight":4,"fresh":[0,4],"from":[0,1,2,3,4],"fuel":[3,4],"fugit":[3,4],"fugitv":4,"function":2,"futur":0,"g":4,"ga":[3,4],"gener":[1,3,4],"genericcalculationrequestwithfactorid":4,"genericcalculationrequestwithoutfactorid":4,"geograph":4,"get":[0,3,4],"getauthhead":4,"getclient":[0,1,2,4],"getclientid":4,"getclientsourc":4,"getdomain":4,"getinst":4,"getsearcharea":4,"ghg":3,"ghgemiss":0,"give":4,"gracefulli":1,"greas":4,"greenhous":3,"handl":[0,5],"hardcod":0,"have":[2,4],"header":[1,2,4,5],"here":2,"hfc":4,"host":[0,1,4],"http":[0,1,2,4],"hybrid":4,"i":[0,1,3,4],"ibm":[0,1,2,5],"ibmid":2,"id":[0,1,2,4],"identifi":[0,4],"implement":[0,1],"import":[0,1],"includ":[0,4],"includedetail":4,"indirectco2":2,"inform":[0,1,4],"init":0,"initi":[0,2,4,5],"instal":3,"instanc":[1,4],"instead":4,"integr":5,"interact":5,"interfac":[1,3],"internet":2,"involv":4,"isuserprovidedtoken":4,"j":[0,1,2,5],"jet":4,"json":[0,2,4],"jwt":[0,4],"jwt_token":0,"jwttoken":4,"kei":[1,4,5],"kerosen":4,"kg":4,"kgco2e":2,"kj":4,"km":4,"known":4,"kwh":[2,4],"l":4,"larg":[3,4],"layer":0,"leader":2,"leak":3,"least":0,"let":1,"lignit":4,"locat":[2,3,4],"locationemiss":2,"locationrequest":4,"locationrequestwithfactorid":4,"locationrequestwithoutfactorid":4,"log":[2,4],"logist":3,"look":4,"mai":4,"maintain":1,"make":[2,3,4],"makeapirequest":[0,3,4],"manag":[0,1,2,3],"measur":4,"messag":1,"metadata":3,"method":[1,2,4,5],"metric":4,"mobil":[3,4],"mode":0,"modul":[1,2],"more":0,"multipl":4,"n2o":2,"name":4,"natur":4,"nc":4,"ne":4,"necessari":0,"need":[0,4],"never":0,"new":[0,4],"node":[0,1,2,5],"npm":2,"oauth":0,"object":4,"obtain":[1,2],"occur":0,"old":0,"onc":[0,1],"one":[0,1],"onli":[0,1,4],"oper":[1,3,4],"optim":1,"option":[0,4,5],"org":2,"org456":4,"organ":[0,1],"orgid":[0,1,2,4],"other":4,"overview":[2,5],"page":[0,1,2],"pagin":4,"param":[0,4],"paramet":[0,1,4],"pars":4,"pattern":5,"payload":4,"perform":4,"petroleum":4,"point":4,"post":4,"practic":5,"pre":1,"prerequisit":3,"preview":2,"principl":0,"privileg":0,"proce":4,"process":[0,1],"product":[0,1],"project":[2,3],"promis":4,"proper":[0,1],"provid":[0,1,2,4,5],"purchas":4,"purpos":4,"queri":[0,4],"r":4,"r134a":4,"re":0,"record":4,"refer":3,"refresh":[1,4],"refreshtoken":4,"region":[2,3],"relat":4,"relev":4,"replac":0,"repres":4,"request":[0,1,3,4],"requestconfig":4,"requir":[0,1,2],"resolv":4,"respons":[0,3,4,5],"result":[2,4],"retriev":[2,4],"retrievefactor":4,"return":[0,2,4],"reus":1,"run":[0,2],"saascor":[0,2],"scale":3,"scenario":0,"scope":4,"sdk":[0,1,2,4],"search":4,"searchact":4,"searchrequest":4,"second":4,"section":5,"secur":[1,5],"see":[0,1],"send":0,"sent":4,"servic":[0,1],"set":2,"sever":1,"ship":4,"sign":2,"singl":4,"singleton":[0,1,4],"size":4,"small":4,"sourc":[0,3,4],"specif":[1,3,4],"specifi":4,"standard":4,"start":3,"startup":1,"state":2,"stateprovinc":[2,4],"static":4,"stationari":[3,4],"statu":1,"steel":4,"step":0,"store":[0,1],"string":[0,4],"structur":5,"subtyp":4,"successfulli":2,"suppli":3,"support":[1,4],"sustain":3,"t":4,"tenantid":2,"thi":[0,2,4,5],"time":[0,4],"timestamp":4,"toisostr":4,"token":[1,4],"totalco2":2,"track":3,"transactionid":2,"transport":[3,4],"transportationanddistribut":4,"travel":4,"trim":0,"true":4,"try":[1,2],"two":[0,2],"type":[2,4],"typesdata":4,"u":2,"unifi":1,"unit":[2,4],"unix":4,"unless":1,"up":[2,4],"url":[0,4],"us":[0,1,3,4],"usa":[2,4],"usag":[1,5],"user":[0,1,4],"userdata":4,"util":[3,4],"v":[0,1],"valid":[0,1],"valu":[2,4],"variabl":[0,1],"vehicl":3,"verifi":1,"void":4,"wa":[2,4],"waitlist":2,"wast":4,"web":4,"when":[0,4],"where":[0,4],"which":0,"within":4,"without":4,"work":1,"x":[0,2,4],"yarn":2,"ye":1,"year":2,"york":4,"you":[0,2],"your":[0,1,2,3,4]},"titles":["Authentication","Client","Getting Started","IBM Envizi - Emissions API Node.js SDK","Reference","SDK"],"titleterms":{"api":[0,2,3,4],"architectur":0,"authent":[0,1,2],"basic":2,"best":[0,1],"call":2,"client":1,"configur":1,"content":3,"diagram":0,"emiss":3,"envizi":3,"error":1,"exampl":[2,4],"first":2,"flow":0,"gener":[0,2],"get":2,"getarea":4,"gettyp":4,"getunit":4,"handl":1,"header":0,"ibm":3,"import":2,"initi":1,"instal":2,"integr":1,"interfac":4,"introduct":3,"j":3,"kei":[0,2],"lifetim":0,"metadata":4,"method":0,"node":3,"option":1,"overview":[0,1],"practic":[0,1],"pre":[0,2],"prerequisit":2,"recommend":[0,2],"refer":4,"refresh":0,"respons":[1,2],"retriev":0,"sdk":[3,5],"secur":0,"start":2,"support":3,"token":[0,2],"type":3,"us":2}})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "emissions-api-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "sdk for IBM Emissions APIs",
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",

package/sphinx-build/Makefile

@@ -0,0 +1,49 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   := sphinx-build
+SOURCEDIR     := source
+BUILDDIR      := build
+DOCS_DIR      := ../docs
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# Clean build directory
+.PHONY: clean
+clean:
+	@echo "Cleaning build directory..."
+	@rm -rf $(BUILDDIR)
+	@echo "Done."
+
+# Build HTML documentation
+.PHONY: html
+html:
+	@echo "Building HTML documentation..."
+	@$(SPHINXBUILD) -b html $(SOURCEDIR) $(BUILDDIR)/html
+	@echo "Done. Output is in $(BUILDDIR)/html"
+
+# Clean and build HTML
+.PHONY: all
+all: clean html
+	@echo "Documentation build complete."
+
+# Copy built HTML to docs directory for GitHub Pages
+.PHONY: pages
+pages: all
+	@echo "Copying documentation to docs directory..."
+	@rm -rf $(DOCS_DIR)/*
+	@mkdir -p $(DOCS_DIR)
+	@cp -r $(BUILDDIR)/html/* $(DOCS_DIR)/
+	@echo "Done. GitHub Pages content is in $(DOCS_DIR)"

package/sphinx-build/source/_static/custom.css

@@ -0,0 +1,16 @@
+div.nbinput.container div.input_area {
+    border: 1px solid #e0e0e0;
+    border-radius: 4px;
+    background: #f8f8f8;
+}
+
+div.nboutput.container div.output_area {
+    border: 1px solid #e0e0e0;
+    border-radius: 4px;
+    background: #fcfcfc;
+}
+
+/* Make code cells more readable */
+.highlight {
+    background: #f8f8f8;
+}

package/sphinx-build/source/authentication.rst

@@ -0,0 +1,164 @@
+==============
+Authentication
+==============
+
+Overview
+--------
+
+The IBM Envizi - Emissions API Node.js SDK uses OAuth 2.0 Bearer Tokens for authentication. This page explains the authentication process, options, and security best practices in detail.
+
+Authentication Methods
+----------------------
+
+The SDK provides two authentication methods:
+
+API Key Authentication (Recommended)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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,
+      orgId: process.env.ENVIZI_ORG_ID
+    });
+
+**Required parameters:**
+    - ``apiKey``: Your API key for authentication
+    - ``clientId``: Your client identifier
+    - ``orgId``: Your organization identifier
+
+Token retrieval
+^^^^^^^^^^^^^^^
+When you call ``Client.getClient()`` with ``apiKey``:
+
+- **Method**: ``GET`` to the token endpoint (default: ``https://api.ibm.com/saascore/run/authentication-retrieve/api-key``)
+- **Headers**:
+  - ``X-Api-Key: <apiKey>``
+  - ``X-IBM-Client-Id: saascore-<clientId>``
+  - ``Accept: application/json``
+- **Query param**: ``orgId=<orgId>``
+- **Response**: a bearer token (string) which the SDK trims, caches, and uses for API calls.
+
+Pre-generated Token Authentication
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For scenarios where token generation is handled externally:
+
+.. code-block:: javascript
+
+    import { Client } from 'emissions-api-sdk';
+    
+    await Client.getClient({
+      token: process.env.JWT_TOKEN,
+      clientId: process.env.ENVIZI_CLIENT_ID
+    });
+
+**Required parameters:**
+    - ``token``: A pre-generated authentication token
+    - ``clientId``: Your client identifier
+
+Token lifetime & refresh
+^^^^^^^^^^^^^^^^^^^^^^^^
+- The SDK decodes the JWT’s ``exp`` and stores it.
+- In user-provided token mode, no refresh occurs; re-initialize with a fresh token when needed.
+
+Authentication Flow
+-------------------
+
+The authentication process follows these steps:
+
+1. **Initialization**:
+    - User provides authentication credentials
+    - Client validates the credentials format
+
+2. **Token Generation** (API Key method):
+    - Client sends API key to authentication service
+    - Authentication service validates credentials
+    - Authentication service returns a token with expiration time
+    - Client stores the token securely
+
+3. **Token Validation**:
+    - Before each API request, token validity is checked
+    - If valid, the token is included in the request
+    - If expired or near expiration, token is refreshed
+
+4. **Token Refreshing**:
+    - Client detects when token is approaching expiration
+    - Client automatically requests a new token
+    - New token replaces the old one for future requests
+
+Authentication Headers
+----------------------
+
+The SDK automatically includes the necessary headers for authentication:
+
+For token generation:
+    - ``X-Api-Key``: Your API key
+    - ``X-IBM-Client-Id``: saascore-{your-client-id}
+
+For API requests:
+    - ``Authorization``: Bearer {token}
+    - ``X-IBM-Client-Id``: ghgemissions-{your-client-id}
+    - ``X-Client-Source``: node-sdk
+
+Architecture Diagram
+--------------------
+
+::
+
+    +-----------------+          +-------------------------+
+    | Your application|          |   Token Service (GET)   |
+    |  (init once)    |          |  authUrl / default URL  |
+    +--------+--------+          +-----------+-------------+
+             |                                ^
+             | getClient({apiKey, clientId,   |  (managed mode only:
+             | orgId, [authUrl], [host]})     |   X-Api-Key, saascore-Client-Id,
+             v                                |   orgId => returns JWT)
+    +--------+--------------------------------+-------------+
+    |                   Client (singleton)                  |
+    |  - token, exp, domain, clientId                       |
+    |  - refresh before expiry (managed mode)               |
+    +--------+--------------------------------+-------------+
+             |                                ^
+             | makeApiRequest(...)            |
+             v                                |
+    +--------+--------------------------------+-------------+
+    |                 Request layer (axios)                 |
+    |  Adds headers:                                        |
+    |   - Authorization: Bearer <token>                     |
+    |   - X-IBM-Client-Id: ghgemissions-<clientId>          |
+    |   - X-Client-Source: excel | node-sdk                 |
+    +--------+--------------------------------+-------------+
+             |
+             v
+    +--------+--------------------------------+-------------+
+    |               Emissions API (host/domain)             |
+    +-------------------------------------------------------+
+
+
+Security Best Practices
+-----------------------
+
+1. **Use environment variables** for credentials:
+
+   .. code-block:: javascript
+
+       await Client.getClient({
+         apiKey: process.env.ENVIZI_API_KEY,
+         clientId: process.env.ENVIZI_CLIENT_ID,
+         orgId: process.env.ENVIZI_ORG_ID
+       });
+
+2. **Never hardcode** credentials in your application code
+3. **Implement proper access controls** for API keys
+4. **Use secure environment variables** for production deployments
+5. **Implement least privilege** principles for API access
+
+
+For more information about the Client that manages authentication, see the :doc:`client` page.
+

package/sphinx-build/source/client.rst

@@ -0,0 +1,137 @@
+======
+Client
+======
+
+Overview
+--------
+
+The Client is the central component of the IBM Envizi - Emissions API Node.js SDK. It handles authentication, maintains connections to the API, and provides a unified interface for all API operations.
+
+.. code-block:: none
+
+   +----------------------+
+   | Application          |<-----------+
+   +----------------------+            |
+            |                          |
+            v                          |
+   +----------------------+            |
+   | Client               |<-----------+
+   +----------------------+            |
+            |                          |
+            v                          |
+   +----------------------+     +----------------------+
+   | Authentication       |---->| API Module Requests  |
+   +----------------------+     +----------------------+
+
+Client Initialization
+---------------------
+
+The Client is designed as a singleton to ensure consistent authentication across your application. Initialize it once at application startup:
+
+1. Managed token (SDK fetches & refreshes)
+
+.. code-block:: javascript
+
+    import { Client } from 'emissions-api-sdk';
+    
+    await Client.getClient({
+      apiKey:   process.env.ENVIZI_API_KEY,
+      clientId: process.env.ENVIZI_CLIENT_ID,
+      orgId:    process.env.ENVIZI_ORG_ID
+    });
+
+2. User-provided token (SDK will **not** refresh it)
+
+.. code-block:: javascript
+
+    import { Client } from "emissions-api-sdk";
+
+    await Client.getClient({
+      clientId: process.env.ENVIZI_CLIENT_ID,
+      token:    process.env.TOKEN
+    });
+
+Configuration Options
+---------------------
+
+The Client accepts the following configuration parameters:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 15 65
+
+   * - Parameter
+     - Required
+     - Description
+   * - apiKey
+     - Yes*
+     - API key for authentication (required unless using token)
+   * - clientId
+     - Yes
+     - Client ID for API access
+   * - orgId
+     - Yes*
+     - Organization ID (required with apiKey)
+   * - token
+     - Yes*
+     - Pre-generated token (required if not using apiKey)
+   * - host
+     - No
+     - Custom API endpoint (defaults to production)
+   * - authUrl
+     - No
+     - Custom authentication endpoint (defaults to production)
+
+.. note::
+    Either ``apiKey+orgId`` OR ``token`` is required
+
+Client Responsibilities
+-----------------------
+
+The Client handles several key responsibilities:
+
+1. **Singleton Management**: Ensures only one Client instance exists
+2. **Configuration Validation**: Verifies required parameters
+3. **Token Generation**: Obtains tokens from the authentication service
+4. **Token Refreshing**: Automatically refreshes tokens before expiration
+5. **Request Authentication**: Adds proper headers to all API requests
+
+Error Handling
+--------------
+
+Handle authentication errors gracefully:
+
+.. code-block:: javascript
+
+    try {
+      await Client.getClient({
+        apiKey: process.env.ENVIZI_API_KEY,
+        clientId: process.env.ENVIZI_CLIENT_ID,
+        orgId: process.env.ENVIZI_ORG_ID
+      });
+    } catch (error) {
+      console.error("Authentication error:", error.message);
+      // Implement appropriate error handling
+      if (error.response) {
+        // Handle specific HTTP error responses
+        console.error("Status:", error.response.status);
+        console.error("Details:", error.response.data);
+      }
+    }
+
+
+Best Practices
+--------------
+
+For optimal Client usage:
+
+1. **Initialize once** at application startup
+2. **Store credentials securely** using environment variables
+3. **Implement proper error handling** for authentication failures
+4. **Let the SDK handle** token refreshing automatically
+5. **Reuse the Client instance** across your application
+
+Authentication Integration
+--------------------------
+
+The Client works closely with the Authentication module to manage tokens. For detailed information about the authentication process, supported methods, and security best practices, see the :doc:`authentication` page.

package/sphinx-build/source/conf.py

@@ -0,0 +1,56 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'IBM Envizi - Emissions API Node.js SDK'
+copyright = '2025, IBM Corporation'
+author = 'Ridham Thumar'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+
+# Language used for content
+language = 'en'
+
+# Source file suffix
+source_suffix = {
+    '.rst': 'restructuredtext',
+}
+
+# The master document
+master_doc = 'index'
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx_js'
+]
+
+js_language = 'typescript'
+
+js_source_path = '../../src'
+
+primary_domain = 'js'
+
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'furo'
+html_static_path = ['_static']
+
+# Add CSS to improve notebook appearance
+html_css_files = [
+    'custom.css',
+]

package/sphinx-build/source/getting_started.rst

@@ -0,0 +1,164 @@
+===============
+Getting Started
+===============
+
+Prerequisites
+-------------
+
+Before using the SDK, ensure you have:
+
+- **Node.js** installed
+- Active internet connection
+- Sign up for the preview waitlist `IBMid sign up <https://www.ibm.com/account/reg/us-en/signup?formid=urx-53659>`_ page.
+- API credentials (``apiKey``, ``tenantId``, ``orgId``), are available on the Emissions API `Overview Page <https://www-dev.supply-chain.ibm.com/envizi/emissions-api-home/overview?cuiURL=%2Femissions-api-home%2Foverview>`_ after sign up
+
+
+Installation
+------------
+
+You can install the SDK using `npm <https://www.npmjs.com/package/emissions-api-sdk>`_ or `yarn <https://yarnpkg.com/package?q=emissions-api-sdk&name=emissions-api-sdk>`_:
+
+Using npm:
+
+.. code-block:: bash
+
+  npm install emissions-api-sdk
+
+
+Using yarn:
+
+.. code-block:: bash
+
+  yarn install emissions-api-sdk
+
+
+Basic Import
+~~~~~~~~~~~~
+
+After installation, you can import the SDK in your project:
+
+.. code-block:: javascript
+
+  // Import the entire SDK
+  const enviziSDK = require('emissions-api-sdk');
+  
+  // Or using ES modules
+  import { Client, LocationEmission } from 'emissions-api-sdk';
+
+
+Authentication
+--------------
+
+Initialize the client with your API credentials:
+
+The SDK provides two authentication methods:
+
+- Using an **API key** with following required Headers:
+    - ``X-Api-Key``: Your API key
+    - ``X-IBM-Client-Id``: saascore-{your-client-id}
+    - ``accept``: application/json
+
+- Using a **Pre-generated token**
+    - Token Generation Endpoint: https://api.ibm.com/saascore/run/authentication-retrieve/api-key
+
+Using API Key (Recommended)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: javascript
+
+  import { Client } from 'emissions-api-sdk';
+  
+  async function initialize() {
+    try {
+      await Client.getClient({
+        apiKey: "your-api-key",
+        clientId: "your-client-id",
+        orgId: "your-org-id"
+      });
+      console.log("Client initialized successfully");
+    } catch (error) {
+      console.error("Failed to initialize client:", error);
+    }
+  }
+  
+  initialize();
+
+Using Pre-generated Token
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you already have a token, you can use it directly:
+
+.. code-block:: javascript
+
+  import { Client } from 'emissions-api-sdk';
+
+  async function initialize() {
+    try {
+      await Client.getClient({
+        token: "your-pre-generated-token",
+        clientId: "your-client-id"
+      });
+      console.log("Client initialized successfully");
+    } catch (error) {
+      console.error("Failed to initialize client:", error);
+    }
+  }
+  
+  initialize();  
+
+First API Call
+--------------
+
+After initializing the client, you can make your first API call. Here's an example of calculating location-based emissions:
+
+.. code-block:: javascript
+
+  import { Client, LocationEmission } from 'emissions-api-sdk';
+  
+  async function calculateEmissions() {
+    try {
+      // Initialize client
+      await Client.getClient({
+        apiKey: "your-api-key",
+        clientId: "your-client-id",
+        orgId: "your-org-id"
+      });
+  
+      // Make API call
+      const result = await LocationEmission.calculate({
+        "location": {
+          "country": "USA",
+          "stateProvince": "california"
+        },
+        "activity": {
+          "type": "electricity",
+          "value": 1,
+          "unit": "kWh"
+        }
+      });
+      
+      console.log("Emission calculation result:", result);
+    } catch (error) {
+      console.error("Error calculating emissions:", error);
+    }
+  }
+  
+  calculateEmissions();
+
+Example Response
+----------------
+
+The API returns emission calculation results in JSON format. Here's an example response:
+
+.. code-block:: json
+
+    {
+      "transactionId": "95a7efe7-02ae-47a3-a7fd-831bfca7cecd",
+      "totalCO2e": 0.20750174,
+      "CO2": 0.20681091,
+      "CH4": 0.00033022,
+      "N2O": 0.00036061,
+      "indirectCO2e": 0.01115131,
+      "unit": "kgCO2e",
+      "description": "The electricity emissions factor used to calculate this result was obtained from the  year 2022 Managed - eGRID & US Climate Leaders factor set for the area United States and the region California."
+    }

package/sphinx-build/source/index.rst

@@ -0,0 +1,29 @@
+IBM Envizi - Emissions API Node.js SDK
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   getting_started
+   sdk
+   reference
+
+Introduction
+============
+
+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.
+
+Supported Emission Types
+------------------------
+
+* **Location** – emissions from region-specific factors  
+* **Fugitive** – emissions from leaks or fugitive sources  
+* **Mobile** – emissions from vehicles and mobile equipment  
+* **Stationary** – emissions from fixed fuel consumption  
+* **Transportation & distribution** – logistics and supply chain activities  
+* **Generic** – custom emission calculations  
+
+The SDK is designed for embedding emission calculations in applications, building sustainability dashboards, automating large-scale datasets, and tracking carbon footprints.