emissions-api-sdk 1.0.5 → 1.0.6

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 (90) hide show
  1. package/README.md +19 -26
  2. package/dist/Constants.js +4 -29
  3. package/dist/api/Calculation.js +0 -63
  4. package/dist/api/EconomicActivity.js +0 -60
  5. package/dist/api/Factor.js +0 -82
  6. package/dist/api/Fugitive.js +0 -63
  7. package/dist/api/Location.js +0 -61
  8. package/dist/api/Metadata.js +155 -0
  9. package/dist/api/Mobile.js +0 -64
  10. package/dist/api/RealEstate.js +0 -61
  11. package/dist/api/Stationary.js +0 -63
  12. package/dist/api/TransportationAndDistribution.js +0 -63
  13. package/dist/coverage/clover.xml +132 -239
  14. package/dist/coverage/coverage-final.json +14 -13
  15. package/dist/coverage/lcov-report/index.html +20 -20
  16. package/dist/coverage/lcov-report/src/Client.ts.html +28 -28
  17. package/dist/coverage/lcov-report/src/Constants.ts.html +29 -110
  18. package/dist/coverage/lcov-report/src/api/Calculation.ts.html +7 -217
  19. package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +7 -214
  20. package/dist/coverage/lcov-report/src/api/Factor.ts.html +6 -285
  21. package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
  22. package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +7 -223
  23. package/dist/coverage/lcov-report/src/api/Location.ts.html +6 -222
  24. package/dist/coverage/lcov-report/src/api/Metadata.ts.html +604 -0
  25. package/dist/coverage/lcov-report/src/api/Mobile.ts.html +6 -231
  26. package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +6 -219
  27. package/dist/coverage/lcov-report/src/api/Stationary.ts.html +6 -225
  28. package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +7 -223
  29. package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
  30. package/dist/coverage/lcov-report/src/api/index.html +48 -33
  31. package/dist/coverage/lcov-report/src/index.html +7 -7
  32. package/dist/coverage/lcov-report/src/request.ts.html +5 -5
  33. package/dist/coverage/lcov-report/src/utils.ts.html +6 -6
  34. package/dist/coverage/lcov-report/test/index.html +1 -1
  35. package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
  36. package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
  37. package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
  38. package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
  39. package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +1 -1
  40. package/dist/coverage/lcov-report/test/mocks/index.html +1 -1
  41. package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
  42. package/dist/coverage/lcov.info +221 -354
  43. package/dist/index.js +2 -1
  44. package/dist/types/Constants.d.ts +3 -28
  45. package/dist/types/api/Calculation.d.ts +0 -41
  46. package/dist/types/api/EconomicActivity.d.ts +0 -38
  47. package/dist/types/api/Factor.d.ts +0 -52
  48. package/dist/types/api/Fugitive.d.ts +0 -41
  49. package/dist/types/api/Location.d.ts +0 -39
  50. package/dist/types/api/Metadata.d.ts +99 -0
  51. package/dist/types/api/Mobile.d.ts +0 -42
  52. package/dist/types/api/RealEstate.d.ts +0 -39
  53. package/dist/types/api/Stationary.d.ts +0 -41
  54. package/dist/types/api/TransportationAndDistribution.d.ts +0 -41
  55. package/dist/types/index.d.ts +1 -0
  56. package/docs/_sources/reference.rst.txt +14 -50
  57. package/docs/_static/basic.css +8 -0
  58. package/docs/_static/pygments.css +146 -164
  59. package/docs/_static/searchtools.js +5 -8
  60. package/docs/_static/styles/furo.css +1 -1
  61. package/docs/_static/styles/furo.css.map +1 -1
  62. package/docs/authentication.html +28 -19
  63. package/docs/client.html +28 -19
  64. package/docs/genindex.html +41 -84
  65. package/docs/getting_started.html +28 -19
  66. package/docs/index.html +29 -20
  67. package/docs/objects.inv +0 -0
  68. package/docs/reference.html +102 -502
  69. package/docs/sdk.html +28 -19
  70. package/docs/search.html +28 -19
  71. package/docs/searchindex.js +1 -1
  72. package/docs/troubleshooting.html +28 -19
  73. package/package.json +5 -3
  74. package/sphinx-build/source/reference.rst +14 -50
  75. package/src/Constants.ts +4 -31
  76. package/src/api/Calculation.ts +1 -72
  77. package/src/api/EconomicActivity.ts +1 -71
  78. package/src/api/Factor.ts +1 -94
  79. package/src/api/Fugitive.ts +1 -74
  80. package/src/api/Location.ts +1 -73
  81. package/src/api/Metadata.ts +174 -0
  82. package/src/api/Mobile.ts +1 -76
  83. package/src/api/RealEstate.ts +1 -72
  84. package/src/api/Stationary.ts +1 -74
  85. package/src/api/TransportationAndDistribution.ts +1 -74
  86. package/src/index.ts +1 -0
  87. package/test/apiTest.test.ts +0 -205
  88. package/test/metadata.test.ts +224 -0
  89. package/test/request.test.ts +0 -1
  90. package/sphinx-build/.secrets.baseline +0 -150
@@ -1,9 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.calculate = calculate;
4
- exports.getTypes = getTypes;
5
- exports.getArea = getArea;
6
- exports.getUnits = getUnits;
7
4
  const request_1 = require("../request");
8
5
  const Constants_1 = require("../Constants");
9
6
  const Client_1 = require("../Client");
@@ -42,64 +39,3 @@ async function calculate(payload) {
42
39
  data: payload,
43
40
  });
44
41
  }
45
- /**
46
- * Retrieves available mobile emission calculation types by making a GET request to the API endpoint.
47
- *
48
- * @export
49
- * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available mobile emission types
50
- * @throws {Error} May throw an error if the API request fails
51
- *
52
- * @example
53
- * // Get all available mobile emission types
54
- * const types = await getTypes();
55
- */
56
- async function getTypes() {
57
- const client = Client_1.Client.getInstance();
58
- const url = client.getDomain() + Constants_1.MOBILE_API_TYPES;
59
- return (0, request_1.makeApiRequest)({
60
- method: Constants_1.GET,
61
- url
62
- });
63
- }
64
- /**
65
- * Retrieves information about geographical areas supported by the mobile emissions API.
66
- *
67
- * @export
68
- * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the supported geographical areas
69
- * @throws {Error} May throw an error if the API request fails
70
- *
71
- * @example
72
- * const areas = await getArea();
73
- */
74
- async function getArea() {
75
- const client = Client_1.Client.getInstance();
76
- const url = client.getDomain() + Constants_1.MOBILE_API_AREA;
77
- return (0, request_1.makeApiRequest)({
78
- method: Constants_1.GET,
79
- url
80
- });
81
- }
82
- /**
83
- * Retrieves available units for a specific mobile emission type.
84
- *
85
- * @export
86
- * @param {string} type - The mobile emission type to get units for (e.g., "Diesel Fuel")
87
- * @return {Promise<UnitResponse>} A promise that resolves to a UnitResponse containing the available units
88
- * @throws {Error} May throw an error if the API request fails
89
- *
90
- * @example
91
- * Get units for the "Cars:B20:(NE)" emission mobile type with subtype
92
- * const units = await getUnits("Cars:B20:(NE)");
93
-
94
- * Get units for the "Cars by Size - Large Car - Hybrid" emission mobile type without subtype
95
- * const units = await getUnits("Cars by Size - Large Car - Hybrid");
96
- */
97
- async function getUnits(type) {
98
- const client = Client_1.Client.getInstance();
99
- const url = client.getDomain() + Constants_1.MOBILE_API_UNITS;
100
- return (0, request_1.makeApiRequest)({
101
- method: Constants_1.GET,
102
- url,
103
- params: { type }
104
- });
105
- }
@@ -1,9 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.calculate = calculate;
4
- exports.getTypes = getTypes;
5
- exports.getArea = getArea;
6
- exports.getUnits = getUnits;
7
4
  const Client_1 = require("../Client");
8
5
  const Constants_1 = require("../Constants");
9
6
  const request_1 = require("../request");
@@ -41,61 +38,3 @@ async function calculate(payload) {
41
38
  data: payload,
42
39
  });
43
40
  }
44
- /**
45
- * Retrieves available Real estate emission calculation types by making a GET request to the API endpoint.
46
- *
47
- * @export
48
- * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available Real estate emission types
49
- * @throws {Error} May throw an error if the API request fails
50
- *
51
- * @example
52
- * const types = await getTypes();
53
- */
54
- async function getTypes() {
55
- const client = Client_1.Client.getInstance();
56
- const url = client.getDomain() + Constants_1.REAL_ESTATE_API_TYPES;
57
- return (0, request_1.makeApiRequest)({
58
- method: Constants_1.GET,
59
- url
60
- });
61
- }
62
- /**
63
- * Retrieves information about geographical areas supported by the real estate emissions API.
64
- *
65
- * @export
66
- * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the supported geographical areas
67
- * @throws {Error} May throw an error if the API request fails
68
- *
69
- * @example
70
- * const areas = await getArea();
71
- */
72
- async function getArea() {
73
- const client = Client_1.Client.getInstance();
74
- const url = client.getDomain() + Constants_1.REAL_ESTATE_API_AREA;
75
- return (0, request_1.makeApiRequest)({
76
- method: Constants_1.GET,
77
- url
78
- });
79
- }
80
- /**
81
- * Retrieves available units for a specific Real estate emission type.
82
- *
83
- * @export
84
- * @param {string} type - The Real estate emission type to get units for (e.g., "R134A")
85
- * @return {Promise<UnitResponse>} A promise that resolves to a UnitResponse containing the available units
86
- * @throws {Error} May throw an error if the API request fails
87
- *
88
- * @example
89
- * // Get units for the "Commercial Real Estate:Industrial distribution warehouse" emission real estate type with subtype
90
- * const units = await getUnits("Commercial Real Estate:Industrial distribution warehouse");
91
-
92
- */
93
- async function getUnits(type) {
94
- const client = Client_1.Client.getInstance();
95
- const url = client.getDomain() + Constants_1.REAL_ESTATE_API_UNITS;
96
- return (0, request_1.makeApiRequest)({
97
- method: Constants_1.GET,
98
- url,
99
- params: { type }
100
- });
101
- }
@@ -1,9 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.calculate = calculate;
4
- exports.getTypes = getTypes;
5
- exports.getArea = getArea;
6
- exports.getUnits = getUnits;
7
4
  const Client_1 = require("../Client");
8
5
  const Constants_1 = require("../Constants");
9
6
  const request_1 = require("../request");
@@ -42,63 +39,3 @@ async function calculate(payload) {
42
39
  data: payload,
43
40
  });
44
41
  }
45
- /**
46
- * Retrieves available stationary emission calculation types by making a GET request to the API endpoint.
47
- *
48
- * @export
49
- * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available stationary emission types
50
- * @throws {Error} May throw an error if the API request fails
51
- *
52
- * @example
53
- * const types = await getTypes();
54
- */
55
- async function getTypes() {
56
- const client = Client_1.Client.getInstance();
57
- const url = client.getDomain() + Constants_1.STATIONARY_API_TYPES;
58
- return (0, request_1.makeApiRequest)({
59
- method: Constants_1.GET,
60
- url
61
- });
62
- }
63
- /**
64
- * Retrieves information about geographical areas supported by the stationary emissions API.
65
- *
66
- * @export
67
- * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the supported geographical areas
68
- * @throws {Error} May throw an error if the API request fails
69
- *
70
- * @example
71
- * const areas = await getArea();
72
- */
73
- async function getArea() {
74
- const client = Client_1.Client.getInstance();
75
- const url = client.getDomain() + Constants_1.STATIONARY_API_AREA;
76
- return (0, request_1.makeApiRequest)({
77
- method: Constants_1.GET,
78
- url
79
- });
80
- }
81
- /**
82
- * Retrieves available units for a specific stationary emission type.
83
- *
84
- * @export
85
- * @param {string} type - The stationary emission type to get units for (e.g., "Coal - Lignite")
86
- * @return {Promise<UnitResponse>} A promise that resolves to a UnitResponse containing the available units
87
- * @throws {Error} May throw an error if the API request fails
88
- *
89
- * @example
90
- * Get units for the "Petroleum Based Greases - NC:A" emission stationary type with subtype
91
- * const units = await getUnits("Petroleum Based Greases - NC:A");
92
-
93
- * Get units for the "Jet Kerosene" emission stationary type without subtype
94
- * const units = await getUnits("Jet Kerosene");
95
- */
96
- async function getUnits(type) {
97
- const client = Client_1.Client.getInstance();
98
- const url = client.getDomain() + Constants_1.STATIONARY_API_UNITS;
99
- return (0, request_1.makeApiRequest)({
100
- method: Constants_1.GET,
101
- url,
102
- params: { type }
103
- });
104
- }
@@ -1,9 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.calculate = calculate;
4
- exports.getTypes = getTypes;
5
- exports.getArea = getArea;
6
- exports.getUnits = getUnits;
7
4
  const Client_1 = require("../Client");
8
5
  const Constants_1 = require("../Constants");
9
6
  const request_1 = require("../request");
@@ -41,63 +38,3 @@ async function calculate(payload) {
41
38
  data: payload,
42
39
  });
43
40
  }
44
- /**
45
- * Retrieves available transportation and distribution calculation types by making a GET request to the API endpoint.
46
- *
47
- * @export
48
- * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available transportation and distribution calculation types
49
- * @throws {Error} May throw an error if the API request fails
50
- *
51
- * @example
52
- * const types = await getTypes();
53
- */
54
- async function getTypes() {
55
- const client = Client_1.Client.getInstance();
56
- const url = client.getDomain() + Constants_1.TRANSPORTATION_AND_DISTRIBUTION_API_TYPES;
57
- return (0, request_1.makeApiRequest)({
58
- method: Constants_1.GET,
59
- url
60
- });
61
- }
62
- /**
63
- * Retrieves information about geographical areas supported by the transportation and distribution API.
64
- *
65
- * @export
66
- * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the supported geographical areas
67
- * @throws {Error} May throw an error if the API request fails
68
- *
69
- * @example
70
- * const areas = await getArea();
71
- */
72
- async function getArea() {
73
- const client = Client_1.Client.getInstance();
74
- const url = client.getDomain() + Constants_1.TRANSPORTATION_AND_DISTRIBUTION_API_AREA;
75
- return (0, request_1.makeApiRequest)({
76
- method: Constants_1.GET,
77
- url
78
- });
79
- }
80
- /**
81
- * Retrieves available units for a specific transportation and distribution calculation type.
82
- *
83
- * @export
84
- * @param {string} type - The transportation and distribution calculation type to get units for (e.g., "Freight - Cargo Ship")
85
- * @return {Promise<UnitResponse>} A promise that resolves to a UnitResponse containing the available units
86
- * @throws {Error} May throw an error if the API request fails
87
- *
88
- * @example
89
- * // Get units for the "Business Travel - Cars:Diesel - Small" transportation and distribution type without subtype
90
- * const units = await getUnits("Business Travel - Cars:Diesel - Small");
91
- *
92
- * // Get units for the "Business Travel - Cars" transportation and distribution type with subtype
93
- * const units = await getUnits("Business Travel - Cars");
94
- */
95
- async function getUnits(type) {
96
- const client = Client_1.Client.getInstance();
97
- const url = client.getDomain() + Constants_1.TRANSPORTATION_AND_DISTRIBUTION_API_UNITS;
98
- return (0, request_1.makeApiRequest)({
99
- method: Constants_1.GET,
100
- url,
101
- params: { type }
102
- });
103
- }