emissions-api-sdk 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/README.md +33 -2
  2. package/dist/Constants.js +23 -1
  3. package/dist/api/Calculation.js +77 -14
  4. package/dist/api/Factor.js +97 -16
  5. package/dist/api/Fugitive.js +75 -12
  6. package/dist/api/Location.js +75 -14
  7. package/dist/api/Mobile.js +66 -0
  8. package/dist/api/Stationary.js +77 -14
  9. package/dist/api/TransportationAndDistribution.js +75 -12
  10. package/dist/types/Constants.d.ts +22 -0
  11. package/dist/types/api/Calculation.d.ts +52 -14
  12. package/dist/types/api/Factor.d.ts +64 -16
  13. package/dist/types/api/Fugitive.d.ts +50 -12
  14. package/dist/types/api/Location.d.ts +50 -14
  15. package/dist/types/api/Mobile.d.ts +41 -0
  16. package/dist/types/api/Stationary.d.ts +52 -14
  17. package/dist/types/api/TransportationAndDistribution.d.ts +50 -12
  18. package/docs/.nojekyll +0 -0
  19. package/docs/_sources/authentication.rst.txt +164 -0
  20. package/docs/_sources/client.rst.txt +137 -0
  21. package/docs/_sources/getting_started.rst.txt +164 -0
  22. package/docs/_sources/index.rst.txt +29 -0
  23. package/docs/_sources/reference.rst.txt +129 -0
  24. package/docs/_sources/sdk.rst.txt +13 -0
  25. package/docs/_static/basic.css +906 -0
  26. package/docs/_static/custom.css +16 -0
  27. package/docs/_static/debug.css +69 -0
  28. package/docs/_static/doctools.js +149 -0
  29. package/docs/_static/documentation_options.js +13 -0
  30. package/docs/_static/file.png +0 -0
  31. package/docs/_static/language_data.js +192 -0
  32. package/docs/_static/minus.png +0 -0
  33. package/docs/_static/plus.png +0 -0
  34. package/docs/_static/pygments.css +250 -0
  35. package/docs/_static/scripts/furo-extensions.js +0 -0
  36. package/docs/_static/scripts/furo.js +3 -0
  37. package/docs/_static/scripts/furo.js.LICENSE.txt +7 -0
  38. package/docs/_static/scripts/furo.js.map +1 -0
  39. package/docs/_static/searchtools.js +635 -0
  40. package/docs/_static/skeleton.css +296 -0
  41. package/docs/_static/sphinx_highlight.js +154 -0
  42. package/docs/_static/sphinx_js.css +0 -0
  43. package/docs/_static/styles/furo-extensions.css +2 -0
  44. package/docs/_static/styles/furo-extensions.css.map +1 -0
  45. package/docs/_static/styles/furo.css +2 -0
  46. package/docs/_static/styles/furo.css.map +1 -0
  47. package/docs/authentication.html +513 -0
  48. package/docs/client.html +467 -0
  49. package/docs/genindex.html +482 -0
  50. package/docs/getting_started.html +481 -0
  51. package/docs/index.html +334 -0
  52. package/docs/objects.inv +0 -0
  53. package/docs/reference.html +1568 -0
  54. package/docs/sdk.html +324 -0
  55. package/docs/search.html +287 -0
  56. package/docs/searchindex.js +1 -0
  57. package/package.json +1 -1
  58. package/sphinx-build/Makefile +49 -0
  59. package/sphinx-build/source/_static/custom.css +16 -0
  60. package/sphinx-build/source/authentication.rst +164 -0
  61. package/sphinx-build/source/client.rst +137 -0
  62. package/sphinx-build/source/conf.py +56 -0
  63. package/sphinx-build/source/getting_started.rst +164 -0
  64. package/sphinx-build/source/index.rst +29 -0
  65. package/sphinx-build/source/reference.rst +129 -0
  66. package/sphinx-build/source/sdk.rst +13 -0
  67. package/src/Constants.ts +26 -0
  68. package/src/api/Calculation.ts +84 -15
  69. package/src/api/Factor.ts +108 -19
  70. package/src/api/Fugitive.ts +83 -13
  71. package/src/api/Location.ts +84 -15
  72. package/src/api/Mobile.ts +75 -1
  73. package/src/api/Stationary.ts +85 -15
  74. package/src/api/TransportationAndDistribution.ts +84 -13
  75. package/test/apiTest.test.ts +172 -5
  76. package/dist/api/Factors.js +0 -98
  77. package/dist/api/FugitiveEmission.js +0 -40
  78. package/dist/api/GenericCalculation.js +0 -41
  79. package/dist/api/LocationEmission.js +0 -41
  80. package/dist/api/MobileEmission.js +0 -41
  81. package/dist/api/StationaryEmission.js +0 -41
  82. package/dist/api/TransportationDistributionEmission.js +0 -40
  83. package/dist/coverage/clover.xml +0 -225
  84. package/dist/coverage/coverage-final.json +0 -19
  85. package/dist/coverage/lcov-report/base.css +0 -224
  86. package/dist/coverage/lcov-report/block-navigation.js +0 -87
  87. package/dist/coverage/lcov-report/favicon.png +0 -0
  88. package/dist/coverage/lcov-report/index.html +0 -161
  89. package/dist/coverage/lcov-report/prettify.css +0 -1
  90. package/dist/coverage/lcov-report/prettify.js +0 -2
  91. package/dist/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  92. package/dist/coverage/lcov-report/sorter.js +0 -210
  93. package/dist/coverage/lcov-report/src/Client.ts.html +0 -838
  94. package/dist/coverage/lcov-report/src/Constants.ts.html +0 -130
  95. package/dist/coverage/lcov-report/src/api/Calculation.ts.html +0 -217
  96. package/dist/coverage/lcov-report/src/api/Factor.ts.html +0 -343
  97. package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +0 -154
  98. package/dist/coverage/lcov-report/src/api/Factors.ts.html +0 -403
  99. package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +0 -214
  100. package/dist/coverage/lcov-report/src/api/FugitiveEmission.ts.html +0 -214
  101. package/dist/coverage/lcov-report/src/api/GenericCalculation.ts.html +0 -217
  102. package/dist/coverage/lcov-report/src/api/Location.ts.html +0 -214
  103. package/dist/coverage/lcov-report/src/api/LocationEmission.ts.html +0 -214
  104. package/dist/coverage/lcov-report/src/api/Mobile.ts.html +0 -220
  105. package/dist/coverage/lcov-report/src/api/MobileEmission.ts.html +0 -220
  106. package/dist/coverage/lcov-report/src/api/Stationary.ts.html +0 -220
  107. package/dist/coverage/lcov-report/src/api/StationaryEmission.ts.html +0 -220
  108. package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +0 -211
  109. package/dist/coverage/lcov-report/src/api/TransportationDistributionEmission.ts.html +0 -211
  110. package/dist/coverage/lcov-report/src/api/index.html +0 -221
  111. package/dist/coverage/lcov-report/src/index.html +0 -161
  112. package/dist/coverage/lcov-report/src/request.ts.html +0 -235
  113. package/dist/coverage/lcov-report/src/utils.ts.html +0 -139
  114. package/dist/coverage/lcov-report/test/index.html +0 -116
  115. package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +0 -142
  116. package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +0 -133
  117. package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +0 -142
  118. package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +0 -139
  119. package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +0 -142
  120. package/dist/coverage/lcov-report/test/mocks/index.html +0 -176
  121. package/dist/coverage/lcov-report/test/testUtils.ts.html +0 -97
  122. package/dist/coverage/lcov.info +0 -404
  123. package/dist/types/api/Factors.d.ts +0 -68
  124. package/dist/types/api/FugitiveEmission.d.ts +0 -27
  125. package/dist/types/api/GenericCalculation.d.ts +0 -28
  126. package/dist/types/api/LocationEmission.d.ts +0 -28
  127. package/dist/types/api/MobileEmission.d.ts +0 -28
  128. package/dist/types/api/StationaryEmission.d.ts +0 -28
  129. package/dist/types/api/TransportationDistributionEmission.d.ts +0 -27
package/docs/_sources/reference.rst.txt ADDED
@@ -0,0 +1,129 @@
1
+ =========
2
+ Reference
3
+ =========
4
+
5
+
6
+ .. js:autoclass:: Client
7
+ :members:
8
+
9
+ .. js:autofunction:: request.makeApiRequest
10
+
11
+ .. js:autofunction:: utils.findExpiryTime
12
+
13
+ API
14
+ ===
15
+
16
+ .. js:autofunction:: Factor.retrieveFactor
17
+
18
+ .. js:autofunction:: Fugitive.calculate
19
+
20
+ .. js:autofunction:: Calculation.calculate
21
+
22
+ .. js:autofunction:: Location.calculate
23
+
24
+ .. js:autofunction:: Mobile.calculate
25
+
26
+ .. js:autofunction:: Stationary.calculate
27
+
28
+ .. js:autofunction:: TransportationAndDistribution.calculate
29
+
30
+ Metadata APIs
31
+ ===========
32
+
33
+ getTypes
34
+ --------
35
+
36
+ .. js:autofunction:: Factor.getTypes
37
+
38
+ .. js:autofunction:: Calculation.getTypes
39
+
40
+ .. js:autofunction:: Location.getTypes
41
+
42
+ .. js:autofunction:: Mobile.getTypes
43
+
44
+ .. js:autofunction:: Stationary.getTypes
45
+
46
+ .. js:autofunction:: TransportationAndDistribution.getTypes
47
+
48
+ .. js:autofunction:: Fugitive.getTypes
49
+
50
+ getArea
51
+ -------
52
+
53
+ .. js:autofunction:: Factor.getArea
54
+
55
+ .. js:autofunction:: Factor.getSearchArea
56
+
57
+ .. js:autofunction:: Calculation.getArea
58
+
59
+ .. js:autofunction:: Location.getArea
60
+
61
+ .. js:autofunction:: Mobile.getArea
62
+
63
+ .. js:autofunction:: Stationary.getArea
64
+
65
+ .. js:autofunction:: TransportationAndDistribution.getArea
66
+
67
+ .. js:autofunction:: Fugitive.getArea
68
+
69
+ getUnits
70
+ --------
71
+
72
+ .. js:autofunction:: Factor.getUnits
73
+
74
+ .. js:autofunction:: Calculation.getUnits
75
+
76
+ .. js:autofunction:: Location.getUnits
77
+
78
+ .. js:autofunction:: Mobile.getUnits
79
+
80
+ .. js:autofunction:: Stationary.getUnits
81
+
82
+ .. js:autofunction:: TransportationAndDistribution.getUnits
83
+
84
+ .. js:autofunction:: Fugitive.getUnits
85
+
86
+ Interfaces
87
+ ==========
88
+
89
+ .. js:autoclass:: Api.LocationRequestWithoutFactorId
90
+
91
+ .. js:autoclass:: Api.LocationRequestWithFactorId
92
+
93
+ .. js:autoclass:: Api.CommonRequestWithoutFactorId
94
+
95
+ .. js:autoclass:: Api.CommonRequestWithFactorId
96
+
97
+ .. js:autoclass:: Api.GenericCalculationRequestWithoutFactorId
98
+
99
+ .. js:autoclass:: Api.GenericCalculationRequestWithFactorId
100
+
101
+ .. js:autoclass:: Api.FactorRequestWithoutFactorId
102
+
103
+ .. js:autoclass:: Api.FactorRequestWithFactorId
104
+
105
+ .. js:autoclass:: Api.SearchRequest
106
+
107
+ .. js:autoclass:: common.Location
108
+
109
+ .. js:autoclass:: common.Time
110
+
111
+ .. js:autoclass:: common.Activity
112
+
113
+ .. js:autoclass:: common.ActivityWithFactorId
114
+
115
+ .. js:autoclass:: common.CombinedUnitsActivity
116
+
117
+ .. js:autoclass:: common.CombinedUnitsActivityWithFactorId
118
+
119
+ .. js:autoclass:: common.FactorActivity
120
+
121
+ .. js:autoclass:: common.FactorActivityWithFactorId
122
+
123
+ .. js:autoclass:: common.SearchActivity
124
+
125
+ .. js:autoclass:: common.Pagination
126
+
127
+ .. js:autoclass:: Config.RequestConfig
128
+
129
+ .. js:autoclass:: Config.ClientConfig
package/docs/_sources/sdk.rst.txt ADDED
@@ -0,0 +1,13 @@
1
+ ===
2
+ SDK
3
+ ===
4
+
5
+ The IBM Envizi - Emissions API Node.js SDK provides a structured approach to interact with the Emissions API. This section covers the key components and usage patterns.
6
+
7
+ .. toctree::
8
+ :maxdepth: 2
9
+
10
+ client
11
+ authentication
12
+
13
+ .. Made with Bob