@compass-labs/api-sdk 2.2.110 → 2.2.112-rc.0

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 (137) hide show
  1. package/dist/commonjs/models/components/accountsummary.d.ts +2 -3
  2. package/dist/commonjs/models/components/accountsummary.d.ts.map +1 -1
  3. package/dist/commonjs/models/components/accountsummary.js.map +1 -1
  4. package/dist/commonjs/models/components/collateralposition.d.ts +2 -3
  5. package/dist/commonjs/models/components/collateralposition.d.ts.map +1 -1
  6. package/dist/commonjs/models/components/collateralposition.js.map +1 -1
  7. package/dist/commonjs/models/components/creditborrowparams.d.ts +2 -3
  8. package/dist/commonjs/models/components/creditborrowparams.d.ts.map +1 -1
  9. package/dist/commonjs/models/components/creditborrowparams.js.map +1 -1
  10. package/dist/commonjs/models/components/creditborrowrequest.d.ts +2 -3
  11. package/dist/commonjs/models/components/creditborrowrequest.d.ts.map +1 -1
  12. package/dist/commonjs/models/components/creditborrowrequest.js.map +1 -1
  13. package/dist/commonjs/models/components/creditenablecollateralparams.d.ts +2 -3
  14. package/dist/commonjs/models/components/creditenablecollateralparams.d.ts.map +1 -1
  15. package/dist/commonjs/models/components/creditenablecollateralparams.js.map +1 -1
  16. package/dist/commonjs/models/components/creditlooprequest.d.ts +2 -3
  17. package/dist/commonjs/models/components/creditlooprequest.d.ts.map +1 -1
  18. package/dist/commonjs/models/components/creditlooprequest.js.map +1 -1
  19. package/dist/commonjs/models/components/creditprotocol.d.ts +4 -6
  20. package/dist/commonjs/models/components/creditprotocol.d.ts.map +1 -1
  21. package/dist/commonjs/models/components/creditprotocol.js +2 -3
  22. package/dist/commonjs/models/components/creditprotocol.js.map +1 -1
  23. package/dist/commonjs/models/components/creditrepayparams.d.ts +2 -3
  24. package/dist/commonjs/models/components/creditrepayparams.d.ts.map +1 -1
  25. package/dist/commonjs/models/components/creditrepayparams.js.map +1 -1
  26. package/dist/commonjs/models/components/creditrepayrequest.d.ts +2 -3
  27. package/dist/commonjs/models/components/creditrepayrequest.d.ts.map +1 -1
  28. package/dist/commonjs/models/components/creditrepayrequest.js.map +1 -1
  29. package/dist/commonjs/models/components/creditsupplyparams.d.ts +2 -3
  30. package/dist/commonjs/models/components/creditsupplyparams.d.ts.map +1 -1
  31. package/dist/commonjs/models/components/creditsupplyparams.js.map +1 -1
  32. package/dist/commonjs/models/components/creditunlooprequest.d.ts +2 -3
  33. package/dist/commonjs/models/components/creditunlooprequest.d.ts.map +1 -1
  34. package/dist/commonjs/models/components/creditunlooprequest.js.map +1 -1
  35. package/dist/commonjs/models/components/creditwithdrawparams.d.ts +2 -3
  36. package/dist/commonjs/models/components/creditwithdrawparams.d.ts.map +1 -1
  37. package/dist/commonjs/models/components/creditwithdrawparams.js.map +1 -1
  38. package/dist/commonjs/models/components/debtposition.d.ts +2 -3
  39. package/dist/commonjs/models/components/debtposition.d.ts.map +1 -1
  40. package/dist/commonjs/models/components/debtposition.js.map +1 -1
  41. package/dist/commonjs/models/components/loopedposition.d.ts +2 -3
  42. package/dist/commonjs/models/components/loopedposition.d.ts.map +1 -1
  43. package/dist/commonjs/models/components/loopedposition.js.map +1 -1
  44. package/dist/commonjs/models/components/rebalancetarget.d.ts +17 -3
  45. package/dist/commonjs/models/components/rebalancetarget.d.ts.map +1 -1
  46. package/dist/commonjs/models/components/rebalancetarget.js +6 -0
  47. package/dist/commonjs/models/components/rebalancetarget.js.map +1 -1
  48. package/dist/commonjs/models/components/rebalancetargetpreview.d.ts +17 -6
  49. package/dist/commonjs/models/components/rebalancetargetpreview.d.ts.map +1 -1
  50. package/dist/commonjs/models/components/rebalancetargetpreview.js +7 -1
  51. package/dist/commonjs/models/components/rebalancetargetpreview.js.map +1 -1
  52. package/dist/esm/models/components/accountsummary.d.ts +2 -3
  53. package/dist/esm/models/components/accountsummary.d.ts.map +1 -1
  54. package/dist/esm/models/components/accountsummary.js.map +1 -1
  55. package/dist/esm/models/components/collateralposition.d.ts +2 -3
  56. package/dist/esm/models/components/collateralposition.d.ts.map +1 -1
  57. package/dist/esm/models/components/collateralposition.js.map +1 -1
  58. package/dist/esm/models/components/creditborrowparams.d.ts +2 -3
  59. package/dist/esm/models/components/creditborrowparams.d.ts.map +1 -1
  60. package/dist/esm/models/components/creditborrowparams.js.map +1 -1
  61. package/dist/esm/models/components/creditborrowrequest.d.ts +2 -3
  62. package/dist/esm/models/components/creditborrowrequest.d.ts.map +1 -1
  63. package/dist/esm/models/components/creditborrowrequest.js.map +1 -1
  64. package/dist/esm/models/components/creditenablecollateralparams.d.ts +2 -3
  65. package/dist/esm/models/components/creditenablecollateralparams.d.ts.map +1 -1
  66. package/dist/esm/models/components/creditenablecollateralparams.js.map +1 -1
  67. package/dist/esm/models/components/creditlooprequest.d.ts +2 -3
  68. package/dist/esm/models/components/creditlooprequest.d.ts.map +1 -1
  69. package/dist/esm/models/components/creditlooprequest.js.map +1 -1
  70. package/dist/esm/models/components/creditprotocol.d.ts +4 -6
  71. package/dist/esm/models/components/creditprotocol.d.ts.map +1 -1
  72. package/dist/esm/models/components/creditprotocol.js +2 -3
  73. package/dist/esm/models/components/creditprotocol.js.map +1 -1
  74. package/dist/esm/models/components/creditrepayparams.d.ts +2 -3
  75. package/dist/esm/models/components/creditrepayparams.d.ts.map +1 -1
  76. package/dist/esm/models/components/creditrepayparams.js.map +1 -1
  77. package/dist/esm/models/components/creditrepayrequest.d.ts +2 -3
  78. package/dist/esm/models/components/creditrepayrequest.d.ts.map +1 -1
  79. package/dist/esm/models/components/creditrepayrequest.js.map +1 -1
  80. package/dist/esm/models/components/creditsupplyparams.d.ts +2 -3
  81. package/dist/esm/models/components/creditsupplyparams.d.ts.map +1 -1
  82. package/dist/esm/models/components/creditsupplyparams.js.map +1 -1
  83. package/dist/esm/models/components/creditunlooprequest.d.ts +2 -3
  84. package/dist/esm/models/components/creditunlooprequest.d.ts.map +1 -1
  85. package/dist/esm/models/components/creditunlooprequest.js.map +1 -1
  86. package/dist/esm/models/components/creditwithdrawparams.d.ts +2 -3
  87. package/dist/esm/models/components/creditwithdrawparams.d.ts.map +1 -1
  88. package/dist/esm/models/components/creditwithdrawparams.js.map +1 -1
  89. package/dist/esm/models/components/debtposition.d.ts +2 -3
  90. package/dist/esm/models/components/debtposition.d.ts.map +1 -1
  91. package/dist/esm/models/components/debtposition.js.map +1 -1
  92. package/dist/esm/models/components/loopedposition.d.ts +2 -3
  93. package/dist/esm/models/components/loopedposition.d.ts.map +1 -1
  94. package/dist/esm/models/components/loopedposition.js.map +1 -1
  95. package/dist/esm/models/components/rebalancetarget.d.ts +17 -3
  96. package/dist/esm/models/components/rebalancetarget.d.ts.map +1 -1
  97. package/dist/esm/models/components/rebalancetarget.js +6 -0
  98. package/dist/esm/models/components/rebalancetarget.js.map +1 -1
  99. package/dist/esm/models/components/rebalancetargetpreview.d.ts +17 -6
  100. package/dist/esm/models/components/rebalancetargetpreview.d.ts.map +1 -1
  101. package/dist/esm/models/components/rebalancetargetpreview.js +7 -1
  102. package/dist/esm/models/components/rebalancetargetpreview.js.map +1 -1
  103. package/docs/models/components/accountsummary.md +11 -11
  104. package/docs/models/components/collateralposition.md +17 -17
  105. package/docs/models/components/creditborrowparams.md +11 -11
  106. package/docs/models/components/creditborrowrequest.md +21 -21
  107. package/docs/models/components/creditenablecollateralparams.md +7 -7
  108. package/docs/models/components/creditlooprequest.md +19 -19
  109. package/docs/models/components/creditprotocol.md +2 -3
  110. package/docs/models/components/creditrepayparams.md +10 -10
  111. package/docs/models/components/creditrepayrequest.md +20 -20
  112. package/docs/models/components/creditsupplyparams.md +9 -9
  113. package/docs/models/components/creditunlooprequest.md +17 -17
  114. package/docs/models/components/creditwithdrawparams.md +9 -9
  115. package/docs/models/components/debtposition.md +16 -16
  116. package/docs/models/components/loopedposition.md +17 -17
  117. package/docs/models/components/rebalancetarget.md +13 -10
  118. package/docs/models/components/rebalancetargetpreview.md +19 -16
  119. package/docs/models/components/rebalancetargetpreviewhealthfactorscope.md +1 -1
  120. package/openapi_prepped_for_speakeasy.json +78 -4
  121. package/package.json +1 -1
  122. package/src/models/components/accountsummary.ts +2 -3
  123. package/src/models/components/collateralposition.ts +2 -3
  124. package/src/models/components/creditborrowparams.ts +2 -3
  125. package/src/models/components/creditborrowrequest.ts +2 -3
  126. package/src/models/components/creditenablecollateralparams.ts +2 -3
  127. package/src/models/components/creditlooprequest.ts +2 -3
  128. package/src/models/components/creditprotocol.ts +4 -6
  129. package/src/models/components/creditrepayparams.ts +2 -3
  130. package/src/models/components/creditrepayrequest.ts +2 -3
  131. package/src/models/components/creditsupplyparams.ts +2 -3
  132. package/src/models/components/creditunlooprequest.ts +2 -3
  133. package/src/models/components/creditwithdrawparams.ts +2 -3
  134. package/src/models/components/debtposition.ts +2 -3
  135. package/src/models/components/loopedposition.ts +2 -3
  136. package/src/models/components/rebalancetarget.ts +23 -3
  137. package/src/models/components/rebalancetargetpreview.ts +23 -6
package/docs/models/components/accountsummary.md CHANGED
@@ -23,14 +23,14 @@ let value: AccountSummary = {
23
23
 
24
24
  ## Fields
25
25
 
26
- | Field | Type | Required | Description | Example |
27
- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
28
- | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path; markets are named by token<br/>symbol. ``MORPHO`` identifies Morpho Blue lending markets by their bytes32<br/>``market_id``. ``EULER`` identifies Euler V2 markets by their EVK<br/>``collateral_vault`` + ``borrow_vault`` addresses and supports isolated<br/>per-sub-account positions (``sub_account_id``).<br/><br/>Deployment is per chain, so a valid protocol can still 422 on a given chain:<br/>AAVE on Ethereum, Base, Arbitrum, BSC and HyperEVM (where it is Hyperlend, the<br/>chain's Aave V3 deployment); MORPHO on Ethereum, Base, Arbitrum and HyperEVM<br/>(where it is Felix); EULER on Ethereum, Base, Arbitrum and BSC.<br/><br/>All three support ``/v2/credit/loop``, ``/v2/credit/unloop`` and<br/>``/v2/credit/looped_positions``. The one gap is ``/v2/credit/rebalance``,<br/>which rejects EULER with a 422. | |
29
- | `subAccountId` | *number* | :heavy_minus_sign: | Euler only: the EVC sub-account (0–255) this summary describes. Euler health is per-sub-account. Null for Aave/Morpho. | |
30
- | `healthFactor` | *string* | :heavy_check_mark: | Health factor. Above 1 is safe; below 1 risks liquidation. | |
31
- | `totalCollateralUsd` | *string* | :heavy_check_mark: | Total collateral value in USD. | |
32
- | `totalDebtUsd` | *string* | :heavy_check_mark: | Total debt value in USD. | |
33
- | `availableBorrowsUsd` | *string* | :heavy_check_mark: | Available borrow capacity in USD. | |
34
- | `ltv` | *string* | :heavy_check_mark: | Current loan-to-value ratio. | |
35
- | `emodeCategoryId` | *number* | :heavy_minus_sign: | E-Mode category ID. 0 = disabled. E-Mode gives higher LTV when collateral and debt are price-correlated (e.g. stablecoin-to-stablecoin or ETH-to-ETH-derivative). | 0 |
36
- | `emodeLabel` | *string* | :heavy_minus_sign: | Human-readable E-Mode category name (e.g. 'Stablecoins', 'ETH correlated'). Null when E-Mode is disabled (category 0). | |
26
+ | Field | Type | Required | Description | Example |
27
+ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
28
+ | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path; markets are named by token<br/>symbol. ``MORPHO`` identifies Morpho Blue lending markets by their bytes32<br/>``market_id``. ``EULER`` identifies Euler V2 markets by their EVK<br/>``collateral_vault`` + ``borrow_vault`` addresses and supports isolated<br/>per-sub-account positions (``sub_account_id``).<br/><br/>Deployment is per chain, so a valid protocol can still 422 on a given chain:<br/>AAVE on Ethereum, Base, Arbitrum, BSC and HyperEVM (where it is Hyperlend, the<br/>chain's Aave V3 deployment); MORPHO on Ethereum, Base, Arbitrum and HyperEVM<br/>(where it is Felix); EULER on Ethereum, Base, Arbitrum and BSC.<br/><br/>All three support ``/v2/credit/loop``, ``/v2/credit/unloop``,<br/>``/v2/credit/looped_positions`` and ``/v2/credit/rebalance``. | |
29
+ | `subAccountId` | *number* | :heavy_minus_sign: | Euler only: the EVC sub-account (0–255) this summary describes. Euler health is per-sub-account. Null for Aave/Morpho. | |
30
+ | `healthFactor` | *string* | :heavy_check_mark: | Health factor. Above 1 is safe; below 1 risks liquidation. | |
31
+ | `totalCollateralUsd` | *string* | :heavy_check_mark: | Total collateral value in USD. | |
32
+ | `totalDebtUsd` | *string* | :heavy_check_mark: | Total debt value in USD. | |
33
+ | `availableBorrowsUsd` | *string* | :heavy_check_mark: | Available borrow capacity in USD. | |
34
+ | `ltv` | *string* | :heavy_check_mark: | Current loan-to-value ratio. | |
35
+ | `emodeCategoryId` | *number* | :heavy_minus_sign: | E-Mode category ID. 0 = disabled. E-Mode gives higher LTV when collateral and debt are price-correlated (e.g. stablecoin-to-stablecoin or ETH-to-ETH-derivative). | 0 |
36
+ | `emodeLabel` | *string* | :heavy_minus_sign: | Human-readable E-Mode category name (e.g. 'Stablecoins', 'ETH correlated'). Null when E-Mode is disabled (category 0). | |