emissions-api-sdk 1.0.11 → 1.0.13

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 (101) hide show
  1. package/README.md +157 -0
  2. package/dist/Constants.js +4 -1
  3. package/dist/api/AuditLog.js +99 -0
  4. package/dist/api/EconomicActivity.js +24 -0
  5. package/dist/api/Factor.js +72 -1
  6. package/dist/api/PhysicalActivity.js +87 -0
  7. package/dist/api/RealEstate.js +23 -0
  8. package/dist/api/TypeRecommender.js +67 -2
  9. package/dist/coverage/clover.xml +154 -89
  10. package/dist/coverage/coverage-final.json +15 -9
  11. package/dist/coverage/lcov-report/index.html +21 -21
  12. package/dist/coverage/lcov-report/src/Client.ts.html +32 -32
  13. package/dist/coverage/lcov-report/src/Constants.ts.html +36 -27
  14. package/dist/coverage/lcov-report/src/api/AuditLog.ts.html +388 -0
  15. package/dist/coverage/lcov-report/src/api/Calculation.ts.html +1 -1
  16. package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +77 -5
  17. package/dist/coverage/lcov-report/src/api/Factor.ts.html +216 -3
  18. package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
  19. package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +1 -1
  20. package/dist/coverage/lcov-report/src/api/Location.ts.html +1 -1
  21. package/dist/coverage/lcov-report/src/api/Metadata.ts.html +1 -1
  22. package/dist/coverage/lcov-report/src/api/Mobile.ts.html +1 -1
  23. package/dist/coverage/lcov-report/src/api/PhysicalActivity.ts.html +361 -0
  24. package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +74 -5
  25. package/dist/coverage/lcov-report/src/api/Stationary.ts.html +1 -1
  26. package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +1 -1
  27. package/dist/coverage/lcov-report/src/api/TypeRecommender.ts.html +199 -4
  28. package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
  29. package/dist/coverage/lcov-report/src/api/index.html +36 -6
  30. package/dist/coverage/lcov-report/src/index.html +7 -7
  31. package/dist/coverage/lcov-report/src/request.ts.html +5 -5
  32. package/dist/coverage/lcov-report/src/utils.ts.html +6 -6
  33. package/dist/coverage/lcov-report/test/index.html +1 -1
  34. package/dist/coverage/lcov-report/test/mocks/AttributionRequest.ts.html +151 -0
  35. package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
  36. package/dist/coverage/lcov-report/test/mocks/EconomicActivityAttributionRequest.ts.html +148 -0
  37. package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
  38. package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
  39. package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
  40. package/dist/coverage/lcov-report/test/mocks/PhysicalActivityEVICRequest.ts.html +148 -0
  41. package/dist/coverage/lcov-report/test/mocks/PhysicalActivityRequest.ts.html +151 -0
  42. package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +148 -4
  43. package/dist/coverage/lcov-report/test/mocks/index.html +64 -4
  44. package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
  45. package/dist/coverage/lcov.info +254 -124
  46. package/dist/index.js +3 -1
  47. package/dist/interfaces/response/AuditLogResponse.js +2 -0
  48. package/dist/types/Constants.d.ts +3 -0
  49. package/dist/types/api/AuditLog.d.ts +37 -0
  50. package/dist/types/api/EconomicActivity.d.ts +24 -0
  51. package/dist/types/api/Factor.d.ts +72 -1
  52. package/dist/types/api/PhysicalActivity.d.ts +76 -0
  53. package/dist/types/api/RealEstate.d.ts +23 -0
  54. package/dist/types/api/TypeRecommender.d.ts +67 -2
  55. package/dist/types/index.d.ts +4 -0
  56. package/dist/types/interfaces/Api.d.ts +17 -1
  57. package/dist/types/interfaces/common.d.ts +48 -0
  58. package/dist/types/interfaces/response/AuditLogResponse.d.ts +40 -0
  59. package/dist/types/interfaces/response/TypeRecommenderResponse.d.ts +1 -0
  60. package/docs/_sources/authentication.rst.txt +26 -4
  61. package/docs/_sources/getting_started.rst.txt +538 -74
  62. package/docs/_sources/index.rst.txt +11 -0
  63. package/docs/_sources/reference.rst.txt +26 -0
  64. package/docs/_sources/troubleshooting.rst.txt +77 -12
  65. package/docs/_static/base-stemmer.js +476 -0
  66. package/docs/_static/english-stemmer.js +1066 -0
  67. package/docs/authentication.html +31 -5
  68. package/docs/client.html +3 -1
  69. package/docs/genindex.html +22 -2
  70. package/docs/getting_started.html +715 -82
  71. package/docs/index.html +35 -0
  72. package/docs/reference.html +412 -3
  73. package/docs/sdk.html +2 -0
  74. package/docs/search.html +2 -0
  75. package/docs/searchindex.js +1 -1
  76. package/docs/troubleshooting.html +75 -17
  77. package/package.json +7 -3
  78. package/sphinx-build/source/authentication.rst +26 -4
  79. package/sphinx-build/source/getting_started.rst +538 -74
  80. package/sphinx-build/source/index.rst +11 -0
  81. package/sphinx-build/source/reference.rst +26 -0
  82. package/sphinx-build/source/troubleshooting.rst +77 -12
  83. package/src/Constants.ts +3 -0
  84. package/src/api/AuditLog.ts +102 -0
  85. package/src/api/EconomicActivity.ts +24 -0
  86. package/src/api/Factor.ts +72 -1
  87. package/src/api/PhysicalActivity.ts +92 -0
  88. package/src/api/RealEstate.ts +23 -0
  89. package/src/api/TypeRecommender.ts +67 -2
  90. package/src/index.ts +7 -1
  91. package/src/interfaces/Api.ts +22 -6
  92. package/src/interfaces/common.ts +58 -0
  93. package/src/interfaces/response/AuditLogResponse.ts +47 -0
  94. package/src/interfaces/response/TypeRecommenderResponse.ts +2 -0
  95. package/test/apiTest.test.ts +59 -3
  96. package/test/auditLog.test.ts +216 -0
  97. package/test/mocks/AttributionRequest.ts +23 -0
  98. package/test/mocks/EconomicActivityAttributionRequest.ts +22 -0
  99. package/test/mocks/PhysicalActivityEVICRequest.ts +22 -0
  100. package/test/mocks/PhysicalActivityRequest.ts +23 -0
  101. package/test/mocks/SearchRequest.ts +48 -0
package/docs/reference.html CHANGED
@@ -207,6 +207,8 @@
207
207
  <li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
208
208
  </ul>
209
209
  </li>
210
+ <li class="toctree-l1"><a class="reference internal" href="authentication.html">Authentication</a></li>
211
+ <li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
210
212
  <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Reference</a></li>
211
213
  <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
212
214
  </ul>
@@ -543,6 +545,118 @@ Only refreshes if the token was not provided by the user and is expiring within
543
545
  </div>
544
546
  </dd></dl>
545
547
 
548
+ <dl class="js function">
549
+ <dt class="sig sig-object js" id="Factor.search">
550
+ <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">Factor</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">search</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Factor.search" title="Link to this definition">¶</a></dt>
551
+ <dd><p>Performs a search operation by making a POST request to the search API endpoint.</p>
552
+ <dl class="field-list simple">
553
+ <dt class="field-odd">Arguments<span class="colon">:</span></dt>
554
+ <dd class="field-odd"><ul class="simple">
555
+ <li><p><strong>payload</strong> (<span class="sphinx_js-type">SearchRequest</span>) – The search request data to be sent to the API</p></li>
556
+ </ul>
557
+ </dd>
558
+ <dt class="field-even">Returns<span class="colon">:</span></dt>
559
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;SearchResponse&gt;</span> – A promise that resolves to the search results returned by the API</p>
560
+ </dd>
561
+ </dl>
562
+ <div class="admonition-example admonition">
563
+ <p class="admonition-title">Example</p>
564
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Basic search</span>
565
+ <span class="kd">const</span><span class="w"> </span><span class="nx">searchRequest</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
566
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="p">{</span>
567
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2020-06-10&quot;</span>
568
+ <span class="w"> </span><span class="p">},</span>
569
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
570
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;travel&quot;</span>
571
+ <span class="w"> </span><span class="p">},</span>
572
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
573
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;USA&quot;</span>
574
+ <span class="w"> </span><span class="p">}</span>
575
+ <span class="w"> </span><span class="p">};</span>
576
+ <span class="kd">const</span><span class="w"> </span><span class="nx">results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">search</span><span class="p">(</span><span class="nx">searchRequest</span><span class="p">);</span>
577
+ </pre></div>
578
+ </div>
579
+ </div>
580
+ <div class="admonition-example admonition">
581
+ <p class="admonition-title">Example</p>
582
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search without cross-encoder reranking</span>
583
+ <span class="kd">const</span><span class="w"> </span><span class="nx">searchWithoutReranker</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
584
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="p">{</span>
585
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2020-06-10&quot;</span>
586
+ <span class="w"> </span><span class="p">},</span>
587
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
588
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;travel&quot;</span>
589
+ <span class="w"> </span><span class="p">},</span>
590
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
591
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;USA&quot;</span>
592
+ <span class="w"> </span><span class="p">},</span>
593
+ <span class="w"> </span><span class="s2">&quot;enableReranker&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
594
+ <span class="w"> </span><span class="p">};</span>
595
+ <span class="kd">const</span><span class="w"> </span><span class="nx">results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">search</span><span class="p">(</span><span class="nx">searchWithoutReranker</span><span class="p">);</span>
596
+ </pre></div>
597
+ </div>
598
+ </div>
599
+ <div class="admonition-example admonition">
600
+ <p class="admonition-title">Example</p>
601
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with optional unit parameter</span>
602
+ <span class="kd">const</span><span class="w"> </span><span class="nx">searchWithUnit</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
603
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="p">{</span>
604
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2020-06-10&quot;</span>
605
+ <span class="w"> </span><span class="p">},</span>
606
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
607
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;electricity&quot;</span><span class="p">,</span>
608
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;kWh&quot;</span>
609
+ <span class="w"> </span><span class="p">},</span>
610
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
611
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;USA&quot;</span>
612
+ <span class="w"> </span><span class="p">}</span>
613
+ <span class="w"> </span><span class="p">};</span>
614
+ <span class="kd">const</span><span class="w"> </span><span class="nx">results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">search</span><span class="p">(</span><span class="nx">searchWithUnit</span><span class="p">);</span>
615
+ </pre></div>
616
+ </div>
617
+ </div>
618
+ <div class="admonition-example admonition">
619
+ <p class="admonition-title">Example</p>
620
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with optional scope parameter</span>
621
+ <span class="kd">const</span><span class="w"> </span><span class="nx">searchWithScope</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
622
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="p">{</span>
623
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2020-06-10&quot;</span>
624
+ <span class="w"> </span><span class="p">},</span>
625
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
626
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;natural gas&quot;</span><span class="p">,</span>
627
+ <span class="w"> </span><span class="s2">&quot;scope&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;1&quot;</span>
628
+ <span class="w"> </span><span class="p">},</span>
629
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
630
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;USA&quot;</span>
631
+ <span class="w"> </span><span class="p">}</span>
632
+ <span class="w"> </span><span class="p">};</span>
633
+ <span class="kd">const</span><span class="w"> </span><span class="nx">results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">search</span><span class="p">(</span><span class="nx">searchWithScope</span><span class="p">);</span>
634
+ </pre></div>
635
+ </div>
636
+ </div>
637
+ <div class="admonition-example admonition">
638
+ <p class="admonition-title">Example</p>
639
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with both unit and scope parameters</span>
640
+ <span class="kd">const</span><span class="w"> </span><span class="nx">searchWithBoth</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
641
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="p">{</span>
642
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2020-06-10&quot;</span>
643
+ <span class="w"> </span><span class="p">},</span>
644
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
645
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;electricity&quot;</span><span class="p">,</span>
646
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;MWh&quot;</span><span class="p">,</span>
647
+ <span class="w"> </span><span class="s2">&quot;scope&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2&quot;</span>
648
+ <span class="w"> </span><span class="p">},</span>
649
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
650
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;USA&quot;</span><span class="p">,</span>
651
+ <span class="w"> </span><span class="s2">&quot;stateProvince&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;california&quot;</span>
652
+ <span class="w"> </span><span class="p">}</span>
653
+ <span class="w"> </span><span class="p">};</span>
654
+ <span class="kd">const</span><span class="w"> </span><span class="nx">results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">search</span><span class="p">(</span><span class="nx">searchWithBoth</span><span class="p">);</span>
655
+ </pre></div>
656
+ </div>
657
+ </div>
658
+ </dd></dl>
659
+
546
660
  <dl class="js function">
547
661
  <dt class="sig sig-object js" id="Fugitive.calculate">
548
662
  <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">Fugitive</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">calculate</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Fugitive.calculate" title="Link to this definition">¶</a></dt>
@@ -779,7 +893,8 @@ Only refreshes if the token was not provided by the user and is expiring within
779
893
  </dl>
780
894
  <div class="admonition-example admonition">
781
895
  <p class="admonition-title">Example</p>
782
- <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
896
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Basic request without attribution</span>
897
+ <span class="kd">const</span><span class="w"> </span><span class="nx">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
783
898
  <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
784
899
  <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-04&quot;</span>
785
900
  <span class="w"> </span><span class="p">},</span>
@@ -797,12 +912,38 @@ Only refreshes if the token was not provided by the user and is expiring within
797
912
  </pre></div>
798
913
  </div>
799
914
  </div>
915
+ <div class="admonition-example admonition">
916
+ <p class="admonition-title">Example</p>
917
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Request with attribution (property value based)</span>
918
+ <span class="kd">const</span><span class="w"> </span><span class="nx">requestWithAttribution</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
919
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
920
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2022-01-01&quot;</span>
921
+ <span class="w"> </span><span class="p">},</span>
922
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
923
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="p">,</span>
924
+ <span class="w"> </span><span class="s2">&quot;stateProvince&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;new york&quot;</span>
925
+ <span class="w"> </span><span class="p">},</span>
926
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
927
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;Commercial Real Estate:Office&quot;</span><span class="p">,</span>
928
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
929
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;m2&quot;</span>
930
+ <span class="w"> </span><span class="p">},</span>
931
+ <span class="w"> </span><span class="s2">&quot;attribution&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
932
+ <span class="w"> </span><span class="s2">&quot;outstandingAmount&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1000000.0</span><span class="p">,</span>
933
+ <span class="w"> </span><span class="s2">&quot;propertyValue&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">5000000.0</span>
934
+ <span class="w"> </span><span class="p">},</span>
935
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
936
+ <span class="w"> </span><span class="p">};</span>
937
+ </pre></div>
938
+ </div>
939
+ </div>
800
940
  </dd></dl>
801
941
 
802
942
  <dl class="js function">
803
943
  <dt class="sig sig-object js" id="EconomicActivity.calculate">
804
944
  <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">EconomicActivity</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">calculate</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EconomicActivity.calculate" title="Link to this definition">¶</a></dt>
805
- <dd><p>Performs scope 3 Spend based emission calculations by making a POST request to the economic activity API endpoint.</p>
945
+ <dd><p>Performs scope 3 Spend based emission calculations by making a POST request to the economic activity API endpoint.
946
+ Supports optional attribution with revenue for proportional allocation.</p>
806
947
  <dl class="field-list simple">
807
948
  <dt class="field-odd">Arguments<span class="colon">:</span></dt>
808
949
  <dd class="field-odd"><ul class="simple">
@@ -815,7 +956,8 @@ Only refreshes if the token was not provided by the user and is expiring within
815
956
  </dl>
816
957
  <div class="admonition-example admonition">
817
958
  <p class="admonition-title">Example</p>
818
- <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
959
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Basic economic activity request</span>
960
+ <span class="kd">const</span><span class="w"> </span><span class="nx">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
819
961
  <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
820
962
  <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-04&quot;</span>
821
963
  <span class="w"> </span><span class="p">},</span>
@@ -833,6 +975,224 @@ Only refreshes if the token was not provided by the user and is expiring within
833
975
  </pre></div>
834
976
  </div>
835
977
  </div>
978
+ <div class="admonition-example admonition">
979
+ <p class="admonition-title">Example</p>
980
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Economic activity request with revenue attribution</span>
981
+ <span class="kd">const</span><span class="w"> </span><span class="nx">requestWithAttribution</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
982
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
983
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-04&quot;</span>
984
+ <span class="w"> </span><span class="p">},</span>
985
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
986
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span>
987
+ <span class="w"> </span><span class="p">},</span>
988
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
989
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;accomodation&quot;</span><span class="p">,</span>
990
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1500.12</span><span class="p">,</span>
991
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usd&quot;</span>
992
+ <span class="w"> </span><span class="p">},</span>
993
+ <span class="w"> </span><span class="s2">&quot;attribution&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
994
+ <span class="w"> </span><span class="s2">&quot;outstandingAmount&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">500000.0</span><span class="p">,</span>
995
+ <span class="w"> </span><span class="s2">&quot;revenue&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">2000000.0</span>
996
+ <span class="w"> </span><span class="p">},</span>
997
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
998
+ <span class="w"> </span><span class="p">};</span>
999
+ <span class="kd">const</span><span class="w"> </span><span class="nx">resultWithAttribution</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">requestWithAttribution</span><span class="p">);</span>
1000
+ </pre></div>
1001
+ </div>
1002
+ </div>
1003
+ </dd></dl>
1004
+
1005
+ </section>
1006
+ <section id="type-recommender-api">
1007
+ <h2>Type Recommender API<a class="headerlink" href="#type-recommender-api" title="Link to this heading">¶</a></h2>
1008
+ <dl class="js function">
1009
+ <dt class="sig sig-object js" id="TypeRecommender.search">
1010
+ <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">TypeRecommender</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">search</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#TypeRecommender.search" title="Link to this definition">¶</a></dt>
1011
+ <dd><p>Search for activity types using semantic search with location, time, and license context. Supports pagination and optional reranker control.</p>
1012
+ <dl class="field-list simple">
1013
+ <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1014
+ <dd class="field-odd"><ul class="simple">
1015
+ <li><p><strong>payload</strong> (<span class="sphinx_js-type">SearchRequest</span>) – The search request data to be sent to the API</p></li>
1016
+ </ul>
1017
+ </dd>
1018
+ <dt class="field-even">Returns<span class="colon">:</span></dt>
1019
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;TypeRecommenderResponse&gt;</span> – A promise that resolves to the activity types returned by the API</p>
1020
+ </dd>
1021
+ </dl>
1022
+ <div class="admonition-example admonition">
1023
+ <p class="admonition-title">Example</p>
1024
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Basic search</span>
1025
+ <span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">search</span><span class="p">({</span>
1026
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1027
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span>
1028
+ <span class="w"> </span><span class="p">},</span>
1029
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1030
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;electricity&quot;</span>
1031
+ <span class="w"> </span><span class="p">}</span>
1032
+ <span class="w"> </span><span class="p">});</span>
1033
+ </pre></div>
1034
+ </div>
1035
+ </div>
1036
+ <div class="admonition-example admonition">
1037
+ <p class="admonition-title">Example</p>
1038
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with time and pagination</span>
1039
+ <span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">search</span><span class="p">({</span>
1040
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1041
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="p">,</span>
1042
+ <span class="w"> </span><span class="s2">&quot;stateProvince&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;california&quot;</span>
1043
+ <span class="w"> </span><span class="p">},</span>
1044
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1045
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-06-10&quot;</span>
1046
+ <span class="w"> </span><span class="p">},</span>
1047
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1048
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;electricity&quot;</span>
1049
+ <span class="w"> </span><span class="p">},</span>
1050
+ <span class="w"> </span><span class="s2">&quot;pagination&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1051
+ <span class="w"> </span><span class="s2">&quot;page&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span><span class="p">,</span>
1052
+ <span class="w"> </span><span class="s2">&quot;size&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">10</span>
1053
+ <span class="w"> </span><span class="p">}</span>
1054
+ <span class="w"> </span><span class="p">});</span>
1055
+ </pre></div>
1056
+ </div>
1057
+ </div>
1058
+ <div class="admonition-example admonition">
1059
+ <p class="admonition-title">Example</p>
1060
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with power grid</span>
1061
+ <span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">search</span><span class="p">({</span>
1062
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1063
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="p">,</span>
1064
+ <span class="w"> </span><span class="s2">&quot;powerGrid&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;WECC&quot;</span>
1065
+ <span class="w"> </span><span class="p">},</span>
1066
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1067
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;renewable energy&quot;</span>
1068
+ <span class="w"> </span><span class="p">}</span>
1069
+ <span class="w"> </span><span class="p">});</span>
1070
+ </pre></div>
1071
+ </div>
1072
+ </div>
1073
+ <div class="admonition-example admonition">
1074
+ <p class="admonition-title">Example</p>
1075
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search without cross-encoder reranking</span>
1076
+ <span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">search</span><span class="p">({</span>
1077
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1078
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span>
1079
+ <span class="w"> </span><span class="p">},</span>
1080
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1081
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;electricity&quot;</span>
1082
+ <span class="w"> </span><span class="p">},</span>
1083
+ <span class="w"> </span><span class="s2">&quot;enableReranker&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
1084
+ <span class="w"> </span><span class="p">});</span>
1085
+ </pre></div>
1086
+ </div>
1087
+ </div>
1088
+ <div class="admonition-example admonition">
1089
+ <p class="admonition-title">Example</p>
1090
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with optional unit parameter</span>
1091
+ <span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">search</span><span class="p">({</span>
1092
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1093
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span>
1094
+ <span class="w"> </span><span class="p">},</span>
1095
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1096
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;electricity&quot;</span><span class="p">,</span>
1097
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;kWh&quot;</span>
1098
+ <span class="w"> </span><span class="p">}</span>
1099
+ <span class="w"> </span><span class="p">});</span>
1100
+ </pre></div>
1101
+ </div>
1102
+ </div>
1103
+ <div class="admonition-example admonition">
1104
+ <p class="admonition-title">Example</p>
1105
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with optional scope parameter</span>
1106
+ <span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">search</span><span class="p">({</span>
1107
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1108
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span>
1109
+ <span class="w"> </span><span class="p">},</span>
1110
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1111
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;natural gas&quot;</span><span class="p">,</span>
1112
+ <span class="w"> </span><span class="s2">&quot;scope&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;1&quot;</span>
1113
+ <span class="w"> </span><span class="p">}</span>
1114
+ <span class="w"> </span><span class="p">});</span>
1115
+ </pre></div>
1116
+ </div>
1117
+ </div>
1118
+ <div class="admonition-example admonition">
1119
+ <p class="admonition-title">Example</p>
1120
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with both unit and scope parameters</span>
1121
+ <span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">search</span><span class="p">({</span>
1122
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1123
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="p">,</span>
1124
+ <span class="w"> </span><span class="s2">&quot;stateProvince&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;california&quot;</span>
1125
+ <span class="w"> </span><span class="p">},</span>
1126
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1127
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-06-10&quot;</span>
1128
+ <span class="w"> </span><span class="p">},</span>
1129
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1130
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;electricity&quot;</span><span class="p">,</span>
1131
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;MWh&quot;</span><span class="p">,</span>
1132
+ <span class="w"> </span><span class="s2">&quot;scope&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2&quot;</span>
1133
+ <span class="w"> </span><span class="p">},</span>
1134
+ <span class="w"> </span><span class="s2">&quot;pagination&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1135
+ <span class="w"> </span><span class="s2">&quot;page&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span><span class="p">,</span>
1136
+ <span class="w"> </span><span class="s2">&quot;size&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">10</span>
1137
+ <span class="w"> </span><span class="p">}</span>
1138
+ <span class="w"> </span><span class="p">});</span>
1139
+ </pre></div>
1140
+ </div>
1141
+ </div>
1142
+ </dd></dl>
1143
+
1144
+ </section>
1145
+ <section id="audit-log-api">
1146
+ <h2>Audit Log API<a class="headerlink" href="#audit-log-api" title="Link to this heading">¶</a></h2>
1147
+ <p>Controls whether the organization’s API requests and responses are stored for auditing.
1148
+ Organizations can disable storage if they don’t need their API calls to be audited.</p>
1149
+ <dl class="js function">
1150
+ <dt class="sig sig-object js" id="AuditLog.getAuditConfig">
1151
+ <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">AuditLog</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getAuditConfig</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AuditLog.getAuditConfig" title="Link to this definition">¶</a></dt>
1152
+ <dd><p>Retrieves the audit log configuration for the organization.</p>
1153
+ <p>Controls whether the organization’s API requests and responses are stored for auditing.
1154
+ Organizations can disable this if they don’t need their API calls to be audited.</p>
1155
+ <dl class="field-list simple">
1156
+ <dt class="field-odd">Returns<span class="colon">:</span></dt>
1157
+ <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;AuditLogResponse&gt;</span> – Current audit log configuration</p>
1158
+ </dd>
1159
+ </dl>
1160
+ <div class="admonition-example admonition">
1161
+ <p class="admonition-title">Example</p>
1162
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">config</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getConfig</span><span class="p">();</span>
1163
+ <span class="c1">// Output: { logRequest: true, logResponse: false }</span>
1164
+ </pre></div>
1165
+ </div>
1166
+ </div>
1167
+ </dd></dl>
1168
+
1169
+ <dl class="js function">
1170
+ <dt class="sig sig-object js" id="AuditLog.updateAuditConfig">
1171
+ <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">AuditLog</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">updateAuditConfig</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#AuditLog.updateAuditConfig" title="Link to this definition">¶</a></dt>
1172
+ <dd><p>Updates the audit log configuration for the organization.</p>
1173
+ <p>Controls whether the organization’s API requests and responses are stored for auditing.
1174
+ Organizations can disable this if they don’t need their API calls to be audited.</p>
1175
+ <p>Note: If the configuration is already set to the requested values, the API will return
1176
+ a 409 Conflict status with a message indicating no change was made. This is handled
1177
+ gracefully and the current configuration is returned.</p>
1178
+ <dl class="field-list simple">
1179
+ <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1180
+ <dd class="field-odd"><ul class="simple">
1181
+ <li><p><strong>payload</strong> (<span class="sphinx_js-type">AuditLogRequest</span>) – Audit log configuration</p></li>
1182
+ </ul>
1183
+ </dd>
1184
+ <dt class="field-even">Returns<span class="colon">:</span></dt>
1185
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;AuditLogResponse&gt;</span> – Updated configuration or current configuration if no change</p>
1186
+ </dd>
1187
+ </dl>
1188
+ <div class="admonition-example admonition">
1189
+ <p class="admonition-title">Example</p>
1190
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">update</span><span class="p">({</span><span class="w"> </span><span class="nx">logRequest</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span><span class="p">,</span><span class="w"> </span><span class="nx">logResponse</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span><span class="w"> </span><span class="p">});</span>
1191
+ <span class="c1">// If already set to these values:</span>
1192
+ <span class="c1">// { logRequest: false, logResponse: false, message: &quot;No change in audit log configuration&quot; }</span>
1193
+ </pre></div>
1194
+ </div>
1195
+ </div>
836
1196
  </dd></dl>
837
1197
 
838
1198
  </section>
@@ -1256,6 +1616,41 @@ Used to find relevant factors or activities based on location, time, and search
1256
1616
  <p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Config</span></code></p>
1257
1617
  </dd></dl>
1258
1618
 
1619
+ <dl class="js interface">
1620
+ <dt class="sig sig-object js" id="AuditLogResponse.AuditLogResponse">
1621
+ <em class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">AuditLogResponse</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">AuditLogResponse</span></span></span><a class="headerlink" href="#AuditLogResponse.AuditLogResponse" title="Link to this definition">¶</a></dt>
1622
+ <dd><p>Response interface for audit log configuration.
1623
+ Contains settings for logging requests and responses.</p>
1624
+ <blockquote>
1625
+ <div><p>AuditLogResponse</p>
1626
+ </div></blockquote>
1627
+ <p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.AuditLogResponse</span></code></p>
1628
+ </dd></dl>
1629
+
1630
+ <dl class="js interface">
1631
+ <dt class="sig sig-object js" id="AuditLogResponse.AuditLogRequest">
1632
+ <em class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">AuditLogResponse</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">AuditLogRequest</span></span></span><a class="headerlink" href="#AuditLogResponse.AuditLogRequest" title="Link to this definition">¶</a></dt>
1633
+ <dd><p>Request interface for updating audit log configuration.
1634
+ Used to configure which parts of API interactions should be logged.</p>
1635
+ <blockquote>
1636
+ <div><p>AuditLogRequest</p>
1637
+ </div></blockquote>
1638
+ <p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.AuditLogResponse</span></code></p>
1639
+ </dd></dl>
1640
+
1641
+ <dl class="js interface">
1642
+ <dt class="sig sig-object js" id="TypeRecommenderResponse.TypeRecommenderResponse">
1643
+ <em class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">TypeRecommenderResponse</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">TypeRecommenderResponse</span></span></span><a class="headerlink" href="#TypeRecommenderResponse.TypeRecommenderResponse" title="Link to this definition">¶</a></dt>
1644
+ <dd><p>Interface for type recommender API</p>
1645
+ <p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.TypeRecommenderResponse</span></code></p>
1646
+ </dd></dl>
1647
+
1648
+ <dl class="js interface">
1649
+ <dt class="sig sig-object js" id="TypeRecommenderResponse.ActivityRequest">
1650
+ <em class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">TypeRecommenderResponse</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">ActivityRequest</span></span></span><a class="headerlink" href="#TypeRecommenderResponse.ActivityRequest" title="Link to this definition">¶</a></dt>
1651
+ <dd><p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.TypeRecommenderResponse</span></code></p>
1652
+ </dd></dl>
1653
+
1259
1654
  </section>
1260
1655
  </section>
1261
1656
 
@@ -1329,6 +1724,7 @@ Used to find relevant factors or activities based on location, time, and search
1329
1724
  <li><a class="reference internal" href="#utils.findExpiryTime"><code class="docutils literal notranslate"><span class="pre">utils.findExpiryTime()</span></code></a></li>
1330
1725
  <li><a class="reference internal" href="#api">API</a><ul>
1331
1726
  <li><a class="reference internal" href="#Factor.retrieveFactor"><code class="docutils literal notranslate"><span class="pre">Factor.retrieveFactor()</span></code></a></li>
1727
+ <li><a class="reference internal" href="#Factor.search"><code class="docutils literal notranslate"><span class="pre">Factor.search()</span></code></a></li>
1332
1728
  <li><a class="reference internal" href="#Fugitive.calculate"><code class="docutils literal notranslate"><span class="pre">Fugitive.calculate()</span></code></a></li>
1333
1729
  <li><a class="reference internal" href="#Calculation.calculate"><code class="docutils literal notranslate"><span class="pre">Calculation.calculate()</span></code></a></li>
1334
1730
  <li><a class="reference internal" href="#Location.calculate"><code class="docutils literal notranslate"><span class="pre">Location.calculate()</span></code></a></li>
@@ -1339,6 +1735,15 @@ Used to find relevant factors or activities based on location, time, and search
1339
1735
  <li><a class="reference internal" href="#EconomicActivity.calculate"><code class="docutils literal notranslate"><span class="pre">EconomicActivity.calculate()</span></code></a></li>
1340
1736
  </ul>
1341
1737
  </li>
1738
+ <li><a class="reference internal" href="#type-recommender-api">Type Recommender API</a><ul>
1739
+ <li><a class="reference internal" href="#TypeRecommender.search"><code class="docutils literal notranslate"><span class="pre">TypeRecommender.search()</span></code></a></li>
1740
+ </ul>
1741
+ </li>
1742
+ <li><a class="reference internal" href="#audit-log-api">Audit Log API</a><ul>
1743
+ <li><a class="reference internal" href="#AuditLog.getAuditConfig"><code class="docutils literal notranslate"><span class="pre">AuditLog.getAuditConfig()</span></code></a></li>
1744
+ <li><a class="reference internal" href="#AuditLog.updateAuditConfig"><code class="docutils literal notranslate"><span class="pre">AuditLog.updateAuditConfig()</span></code></a></li>
1745
+ </ul>
1746
+ </li>
1342
1747
  <li><a class="reference internal" href="#global-metadata-api">Global Metadata API</a><ul>
1343
1748
  <li><a class="reference internal" href="#gettypes">getTypes</a><ul>
1344
1749
  <li><a class="reference internal" href="#Metadata.getTypes"><code class="docutils literal notranslate"><span class="pre">Metadata.getTypes()</span></code></a></li>
@@ -1383,6 +1788,10 @@ Used to find relevant factors or activities based on location, time, and search
1383
1788
  <li><a class="reference internal" href="#common.Pagination"><code class="docutils literal notranslate"><span class="pre">common.Pagination</span></code></a></li>
1384
1789
  <li><a class="reference internal" href="#Config.RequestConfig"><code class="docutils literal notranslate"><span class="pre">Config.RequestConfig</span></code></a></li>
1385
1790
  <li><a class="reference internal" href="#Config.ClientConfig"><code class="docutils literal notranslate"><span class="pre">Config.ClientConfig</span></code></a></li>
1791
+ <li><a class="reference internal" href="#AuditLogResponse.AuditLogResponse"><code class="docutils literal notranslate"><span class="pre">AuditLogResponse.AuditLogResponse</span></code></a></li>
1792
+ <li><a class="reference internal" href="#AuditLogResponse.AuditLogRequest"><code class="docutils literal notranslate"><span class="pre">AuditLogResponse.AuditLogRequest</span></code></a></li>
1793
+ <li><a class="reference internal" href="#TypeRecommenderResponse.TypeRecommenderResponse"><code class="docutils literal notranslate"><span class="pre">TypeRecommenderResponse.TypeRecommenderResponse</span></code></a></li>
1794
+ <li><a class="reference internal" href="#TypeRecommenderResponse.ActivityRequest"><code class="docutils literal notranslate"><span class="pre">TypeRecommenderResponse.ActivityRequest</span></code></a></li>
1386
1795
  </ul>
1387
1796
  </li>
1388
1797
  </ul>
package/docs/sdk.html CHANGED
@@ -207,6 +207,8 @@
207
207
  <li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
208
208
  </ul>
209
209
  </li>
210
+ <li class="toctree-l1"><a class="reference internal" href="authentication.html">Authentication</a></li>
211
+ <li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
210
212
  <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
211
213
  <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
212
214
  </ul>
package/docs/search.html CHANGED
@@ -207,6 +207,8 @@
207
207
  <li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
208
208
  </ul>
209
209
  </li>
210
+ <li class="toctree-l1"><a class="reference internal" href="authentication.html">Authentication</a></li>
211
+ <li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
210
212
  <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
211
213
  <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
212
214
  </ul>