compass_api_sdk 2.2.97rc2__tar.gz → 2.2.97rc4__tar.gz

{compass_api_sdk-2.2.97rc2 → compass_api_sdk-2.2.97rc4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compass_api_sdk
-Version: 2.2.97rc2
+Version: 2.2.97rc4
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.10

{compass_api_sdk-2.2.97rc2 → compass_api_sdk-2.2.97rc4}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "compass_api_sdk"
-version = "2.2.97rc2"
+version = "2.2.97rc4"
 description = "Compass API SDK."
 authors = [{ name = "royalnine" },]
 readme = "README-PYPI.md"
@@ -14,7 +14,7 @@ dependencies = [
 
 [tool.poetry]
 name = "compass_api_sdk"
-version = "2.2.97rc2"
+version = "2.2.97rc4"
 description = "Compass API SDK."
 authors = ["Compass Labs"]
 repository = "https://github.com/CompassLabs/mono.git"

{compass_api_sdk-2.2.97rc2 → compass_api_sdk-2.2.97rc4}/src/compass_api_sdk/_version.py

@@ -5,8 +5,8 @@ import importlib.metadata
 __title__: str = "compass_api_sdk"
 __version__: str = "2.0.0"
 __openapi_doc_version__: str = "0.0.1"
-__gen_version__: str = "2.926.8"
-__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.926.8 0.0.1 compass_api_sdk"
+__gen_version__: str = "2.928.0"
+__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.928.0 0.0.1 compass_api_sdk"
 
 try:
     if __package__ is not None:

{compass_api_sdk-2.2.97rc2 → compass_api_sdk-2.2.97rc4}/src/compass_api_sdk/credit.py

@@ -1603,6 +1603,7 @@ class Credit(BaseSDK):
         ] = None,
         emode_category: OptionalNullable[int] = UNSET,
         gas_sponsorship: Optional[bool] = None,
+        preview: Optional[bool] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -1657,6 +1658,7 @@ class Credit(BaseSDK):
         :param max_slippage_percent: Per-swap slippage tolerance in percent. Loop dust is bounded by this per iteration, so tighter slippage means less dust.
         :param emode_category: Aave only: e-mode category to enable before looping (higher LTV for correlated pairs, e.g. ETH-correlated).
         :param gas_sponsorship: If true, returns EIP-712 typed data for gas-sponsored execution instead of an unsigned transaction.
+        :param preview: If true, build a display ESTIMATE: swap legs always route through the default aggregator and no firm RFQ quotes are requested (quote_expires_at stays null). Set it on every call made while a user is exploring parameters, and leave it false only for the build they actually intend to sign — firm quotes are single-use maker commitments, and requesting them for displays that are never executed degrades the pricing this API is offered.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -1688,6 +1690,7 @@ class Credit(BaseSDK):
             max_slippage_percent=max_slippage_percent,
             emode_category=emode_category,
             gas_sponsorship=gas_sponsorship,
+            preview=preview,
         )
 
         req = self._build_request(
@@ -1782,6 +1785,7 @@ class Credit(BaseSDK):
         ] = None,
         emode_category: OptionalNullable[int] = UNSET,
         gas_sponsorship: Optional[bool] = None,
+        preview: Optional[bool] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -1836,6 +1840,7 @@ class Credit(BaseSDK):
         :param max_slippage_percent: Per-swap slippage tolerance in percent. Loop dust is bounded by this per iteration, so tighter slippage means less dust.
         :param emode_category: Aave only: e-mode category to enable before looping (higher LTV for correlated pairs, e.g. ETH-correlated).
         :param gas_sponsorship: If true, returns EIP-712 typed data for gas-sponsored execution instead of an unsigned transaction.
+        :param preview: If true, build a display ESTIMATE: swap legs always route through the default aggregator and no firm RFQ quotes are requested (quote_expires_at stays null). Set it on every call made while a user is exploring parameters, and leave it false only for the build they actually intend to sign — firm quotes are single-use maker commitments, and requesting them for displays that are never executed degrades the pricing this API is offered.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -1867,6 +1872,7 @@ class Credit(BaseSDK):
             max_slippage_percent=max_slippage_percent,
             emode_category=emode_category,
             gas_sponsorship=gas_sponsorship,
+            preview=preview,
         )
 
         req = self._build_request_async(
@@ -1955,6 +1961,7 @@ class Credit(BaseSDK):
         ] = None,
         allow_partial: Optional[bool] = None,
         gas_sponsorship: Optional[bool] = None,
+        preview: Optional[bool] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -2023,6 +2030,7 @@ class Credit(BaseSDK):
         :param max_slippage_percent: Per-swap slippage tolerance in percent. Unwind dust is bounded by this per iteration, so tighter slippage means less dust.
         :param allow_partial: If the target cannot be reached in one transaction (e.g. a position opened very close to the liquidation threshold), return the maximum-progress plan (preview.fully_unwound=false) instead of a 400. A second unloop call, now from a much lower leverage, finishes the job.
         :param gas_sponsorship: If true, returns EIP-712 typed data for gas-sponsored execution instead of an unsigned transaction.
+        :param preview: If true, build a display estimate only: the swap legs are priced at market rate and no single-use firm quote is ever spent. Set it on every parameter-exploration call and omit it only on the build the user is about to sign.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -2052,6 +2060,7 @@ class Credit(BaseSDK):
             max_slippage_percent=max_slippage_percent,
             allow_partial=allow_partial,
             gas_sponsorship=gas_sponsorship,
+            preview=preview,
         )
 
         req = self._build_request(
@@ -2140,6 +2149,7 @@ class Credit(BaseSDK):
         ] = None,
         allow_partial: Optional[bool] = None,
         gas_sponsorship: Optional[bool] = None,
+        preview: Optional[bool] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -2208,6 +2218,7 @@ class Credit(BaseSDK):
         :param max_slippage_percent: Per-swap slippage tolerance in percent. Unwind dust is bounded by this per iteration, so tighter slippage means less dust.
         :param allow_partial: If the target cannot be reached in one transaction (e.g. a position opened very close to the liquidation threshold), return the maximum-progress plan (preview.fully_unwound=false) instead of a 400. A second unloop call, now from a much lower leverage, finishes the job.
         :param gas_sponsorship: If true, returns EIP-712 typed data for gas-sponsored execution instead of an unsigned transaction.
+        :param preview: If true, build a display estimate only: the swap legs are priced at market rate and no single-use firm quote is ever spent. Set it on every parameter-exploration call and omit it only on the build the user is about to sign.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -2237,6 +2248,7 @@ class Credit(BaseSDK):
             max_slippage_percent=max_slippage_percent,
             allow_partial=allow_partial,
             gas_sponsorship=gas_sponsorship,
+            preview=preview,
         )
 
         req = self._build_request_async(

{compass_api_sdk-2.2.97rc2 → compass_api_sdk-2.2.97rc4}/src/compass_api_sdk/models/__init__.py

@@ -482,7 +482,11 @@ if TYPE_CHECKING:
         CreditLoopRequestMultiplierTypedDict,
         CreditLoopRequestTypedDict,
     )
-    from .creditloopresponse import CreditLoopResponse, CreditLoopResponseTypedDict
+    from .creditloopresponse import (
+        CreditLoopResponse,
+        CreditLoopResponseSwapProvider,
+        CreditLoopResponseTypedDict,
+    )
     from .creditpositionsresponse import (
         CreditPositionsResponse,
         CreditPositionsResponseTypedDict,
@@ -559,6 +563,7 @@ if TYPE_CHECKING:
     )
     from .creditunloopresponse import (
         CreditUnloopResponse,
+        CreditUnloopResponseSwapProvider,
         CreditUnloopResponseTypedDict,
     )
     from .credituseroperation import (
@@ -1947,6 +1952,10 @@ if TYPE_CHECKING:
         WildcatGetMarketResponse,
         WildcatGetMarketResponseTypedDict,
     )
+    from .wisdomtreecredentials import (
+        WisdomTreeCredentials,
+        WisdomTreeCredentialsTypedDict,
+    )
     from .withdraw import Withdraw, WithdrawTypedDict
     from .withdrawalevent import WithdrawalEvent, WithdrawalEventTypedDict
     from .wrapethparams import (
@@ -2289,6 +2298,7 @@ __all__ = [
     "CreditLoopRequestMultiplierTypedDict",
     "CreditLoopRequestTypedDict",
     "CreditLoopResponse",
+    "CreditLoopResponseSwapProvider",
     "CreditLoopResponseTypedDict",
     "CreditLoopedPositionsResponse",
     "CreditLoopedPositionsResponseTypedDict",
@@ -2343,6 +2353,7 @@ __all__ = [
     "CreditUnloopRequestTargetMultiplierTypedDict",
     "CreditUnloopRequestTypedDict",
     "CreditUnloopResponse",
+    "CreditUnloopResponseSwapProvider",
     "CreditUnloopResponseTypedDict",
     "CreditUserOperation",
     "CreditUserOperationBody",
@@ -3347,6 +3358,8 @@ __all__ = [
     "WeeklyApysTypedDict",
     "WildcatGetMarketResponse",
     "WildcatGetMarketResponseTypedDict",
+    "WisdomTreeCredentials",
+    "WisdomTreeCredentialsTypedDict",
     "Withdraw",
     "WithdrawAmount",
     "WithdrawAmountTypedDict",
@@ -3691,6 +3704,7 @@ _dynamic_imports: dict[str, str] = {
     "CreditLoopRequestMultiplierTypedDict": ".creditlooprequest",
     "CreditLoopRequestTypedDict": ".creditlooprequest",
     "CreditLoopResponse": ".creditloopresponse",
+    "CreditLoopResponseSwapProvider": ".creditloopresponse",
     "CreditLoopResponseTypedDict": ".creditloopresponse",
     "CreditPositionsResponse": ".creditpositionsresponse",
     "CreditPositionsResponseTypedDict": ".creditpositionsresponse",
@@ -3747,6 +3761,7 @@ _dynamic_imports: dict[str, str] = {
     "CreditUnloopRequestTargetMultiplierTypedDict": ".creditunlooprequest",
     "CreditUnloopRequestTypedDict": ".creditunlooprequest",
     "CreditUnloopResponse": ".creditunloopresponse",
+    "CreditUnloopResponseSwapProvider": ".creditunloopresponse",
     "CreditUnloopResponseTypedDict": ".creditunloopresponse",
     "CreditUserOperation": ".credituseroperation",
     "CreditUserOperationBody": ".credituseroperation",
@@ -4751,6 +4766,8 @@ _dynamic_imports: dict[str, str] = {
     "WeeklyApysTypedDict": ".weeklyapys",
     "WildcatGetMarketResponse": ".wildcatgetmarketresponse",
     "WildcatGetMarketResponseTypedDict": ".wildcatgetmarketresponse",
+    "WisdomTreeCredentials": ".wisdomtreecredentials",
+    "WisdomTreeCredentialsTypedDict": ".wisdomtreecredentials",
     "Withdraw": ".withdraw",
     "WithdrawTypedDict": ".withdraw",
     "WithdrawalEvent": ".withdrawalevent",

{compass_api_sdk-2.2.97rc2 → compass_api_sdk-2.2.97rc4}/src/compass_api_sdk/models/creditlooprequest.py

@@ -118,6 +118,8 @@ class CreditLoopRequestTypedDict(TypedDict):
     r"""Aave only: e-mode category to enable before looping (higher LTV for correlated pairs, e.g. ETH-correlated)."""
     gas_sponsorship: NotRequired[bool]
     r"""If true, returns EIP-712 typed data for gas-sponsored execution instead of an unsigned transaction."""
+    preview: NotRequired[bool]
+    r"""If true, build a display ESTIMATE: swap legs always route through the default aggregator and no firm RFQ quotes are requested (quote_expires_at stays null). Set it on every call made while a user is exploring parameters, and leave it false only for the build they actually intend to sign — firm quotes are single-use maker commitments, and requesting them for displays that are never executed degrades the pricing this API is offered."""
 
 
 class CreditLoopRequest(BaseModel):
@@ -179,6 +181,9 @@ class CreditLoopRequest(BaseModel):
     gas_sponsorship: Optional[bool] = None
     r"""If true, returns EIP-712 typed data for gas-sponsored execution instead of an unsigned transaction."""
 
+    preview: Optional[bool] = None
+    r"""If true, build a display ESTIMATE: swap legs always route through the default aggregator and no firm RFQ quotes are requested (quote_expires_at stays null). Set it on every call made while a user is exploring parameters, and leave it false only for the build they actually intend to sign — firm quotes are single-use maker commitments, and requesting them for displays that are never executed degrades the pricing this API is offered."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = set(
@@ -191,6 +196,7 @@ class CreditLoopRequest(BaseModel):
                 "max_slippage_percent",
                 "emode_category",
                 "gas_sponsorship",
+                "preview",
             ]
         )
         nullable_fields = set(

compass_api_sdk-2.2.97rc4/src/compass_api_sdk/models/creditloopresponse.py

@@ -0,0 +1,102 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .batchedsafeoperationsresponse_output import (
+    BatchedSafeOperationsResponseOutput,
+    BatchedSafeOperationsResponseOutputTypedDict,
+)
+from .creditlooppreview import CreditLoopPreview, CreditLoopPreviewTypedDict
+from .unsignedtransaction import UnsignedTransaction, UnsignedTransactionTypedDict
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from datetime import datetime
+from enum import Enum
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class CreditLoopResponseSwapProvider(str, Enum):
+    r"""Which venue priced the swap leg(s): 'one_inch' (iterative loop, slippage-bounded floors) or 'bebop' (firm zero-slippage quotes, one per swap leg, each partially filled at the leg's size — exact fills, zero dust). On preview=true responses, 'bebop' means the numbers are INDICATIVE, computed from the firm venue's live maker price levels without spending any quote; execution fetches the firm quotes at signing time. Always present, including on fallbacks."""
+
+    ONE_INCH = "one_inch"
+    BEBOP = "bebop"
+
+
+class CreditLoopResponseTypedDict(TypedDict):
+    r"""The atomic loop transaction plus its guaranteed-floor preview."""
+
+    preview: CreditLoopPreviewTypedDict
+    r"""Projected end state of the loop, computed on GUARANTEED swap floors."""
+    transaction: NotRequired[Nullable[UnsignedTransactionTypedDict]]
+    r"""Unsigned transaction for direct execution by the owner. Present when gas_sponsorship=false — except firm-priced previews (preview=true with swap_provider='bebop'), which carry numbers only: the firm quotes are fetched at execution time, so there is no payload to sign yet."""
+    eip_712: NotRequired[Nullable[BatchedSafeOperationsResponseOutputTypedDict]]
+    r"""EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true."""
+    swap_provider: NotRequired[CreditLoopResponseSwapProvider]
+    r"""Which venue priced the swap leg(s): 'one_inch' (iterative loop, slippage-bounded floors) or 'bebop' (firm zero-slippage quotes, one per swap leg, each partially filled at the leg's size — exact fills, zero dust). On preview=true responses, 'bebop' means the numbers are INDICATIVE, computed from the firm venue's live maker price levels without spending any quote; execution fetches the firm quotes at signing time. Always present, including on fallbacks."""
+    quote_expires_at: NotRequired[Nullable[datetime]]
+    r"""Deadline of the firm swap quotes (the earliest across the loop's swap legs) — sign and broadcast before it or the transaction reverts on-chain; refresh by re-calling this endpoint (discard the previous payload). Present only on executable swap_provider='bebop' builds; null on previews (no quote is spent for a preview)."""
+    max_firm_multiplier: NotRequired[Nullable[str]]
+    r"""Multiplier bound firm zero-slippage quotes can fill for the requested position size, LTV and target (estimated without spending any quote). The requested multiplier is firm-servable iff it is <= this value; above it the loop executes at market rate with slippage-bounded floors instead. Present only on preview=true responses when a firm-quote venue covers the pair; null otherwise. Recompute per parameter change - minimum-size floors make reachability target-dependent."""
+
+
+class CreditLoopResponse(BaseModel):
+    r"""The atomic loop transaction plus its guaranteed-floor preview."""
+
+    preview: CreditLoopPreview
+    r"""Projected end state of the loop, computed on GUARANTEED swap floors."""
+
+    transaction: OptionalNullable[UnsignedTransaction] = UNSET
+    r"""Unsigned transaction for direct execution by the owner. Present when gas_sponsorship=false — except firm-priced previews (preview=true with swap_provider='bebop'), which carry numbers only: the firm quotes are fetched at execution time, so there is no payload to sign yet."""
+
+    eip_712: OptionalNullable[BatchedSafeOperationsResponseOutput] = UNSET
+    r"""EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true."""
+
+    swap_provider: Optional[CreditLoopResponseSwapProvider] = None
+    r"""Which venue priced the swap leg(s): 'one_inch' (iterative loop, slippage-bounded floors) or 'bebop' (firm zero-slippage quotes, one per swap leg, each partially filled at the leg's size — exact fills, zero dust). On preview=true responses, 'bebop' means the numbers are INDICATIVE, computed from the firm venue's live maker price levels without spending any quote; execution fetches the firm quotes at signing time. Always present, including on fallbacks."""
+
+    quote_expires_at: OptionalNullable[datetime] = UNSET
+    r"""Deadline of the firm swap quotes (the earliest across the loop's swap legs) — sign and broadcast before it or the transaction reverts on-chain; refresh by re-calling this endpoint (discard the previous payload). Present only on executable swap_provider='bebop' builds; null on previews (no quote is spent for a preview)."""
+
+    max_firm_multiplier: OptionalNullable[str] = UNSET
+    r"""Multiplier bound firm zero-slippage quotes can fill for the requested position size, LTV and target (estimated without spending any quote). The requested multiplier is firm-servable iff it is <= this value; above it the loop executes at market rate with slippage-bounded floors instead. Present only on preview=true responses when a firm-quote venue covers the pair; null otherwise. Recompute per parameter change - minimum-size floors make reachability target-dependent."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "transaction",
+                "eip_712",
+                "swap_provider",
+                "quote_expires_at",
+                "max_firm_multiplier",
+            ]
+        )
+        nullable_fields = set(
+            ["transaction", "eip_712", "quote_expires_at", "max_firm_multiplier"]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m

{compass_api_sdk-2.2.97rc2 → compass_api_sdk-2.2.97rc4}/src/compass_api_sdk/models/creditunlooprequest.py

@@ -92,6 +92,8 @@ class CreditUnloopRequestTypedDict(TypedDict):
     r"""If the target cannot be reached in one transaction (e.g. a position opened very close to the liquidation threshold), return the maximum-progress plan (preview.fully_unwound=false) instead of a 400. A second unloop call, now from a much lower leverage, finishes the job."""
     gas_sponsorship: NotRequired[bool]
     r"""If true, returns EIP-712 typed data for gas-sponsored execution instead of an unsigned transaction."""
+    preview: NotRequired[bool]
+    r"""If true, build a display estimate only: the swap legs are priced at market rate and no single-use firm quote is ever spent. Set it on every parameter-exploration call and omit it only on the build the user is about to sign."""
 
 
 class CreditUnloopRequest(BaseModel):
@@ -147,6 +149,9 @@ class CreditUnloopRequest(BaseModel):
     gas_sponsorship: Optional[bool] = None
     r"""If true, returns EIP-712 typed data for gas-sponsored execution instead of an unsigned transaction."""
 
+    preview: Optional[bool] = None
+    r"""If true, build a display estimate only: the swap legs are priced at market rate and no single-use firm quote is ever spent. Set it on every parameter-exploration call and omit it only on the build the user is about to sign."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = set(
@@ -160,6 +165,7 @@ class CreditUnloopRequest(BaseModel):
                 "max_slippage_percent",
                 "allow_partial",
                 "gas_sponsorship",
+                "preview",
             ]
         )
         nullable_fields = set(

compass_api_sdk-2.2.97rc4/src/compass_api_sdk/models/creditunloopresponse.py

@@ -0,0 +1,102 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .batchedsafeoperationsresponse_output import (
+    BatchedSafeOperationsResponseOutput,
+    BatchedSafeOperationsResponseOutputTypedDict,
+)
+from .creditunlooppreview import CreditUnloopPreview, CreditUnloopPreviewTypedDict
+from .unsignedtransaction import UnsignedTransaction, UnsignedTransactionTypedDict
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from datetime import datetime
+from enum import Enum
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class CreditUnloopResponseSwapProvider(str, Enum):
+    r"""Which venue priced the swap leg(s): 'one_inch' (market route, slippage-bounded floors) or 'bebop' (firm quotes, one per swap leg, each partially filled at the leg's size). On preview=true responses, 'bebop' means the numbers are INDICATIVE, computed from the firm venue's live maker price levels without spending any quote; execution fetches the firm quotes at signing time. Always present, including on fallbacks."""
+
+    ONE_INCH = "one_inch"
+    BEBOP = "bebop"
+
+
+class CreditUnloopResponseTypedDict(TypedDict):
+    r"""The atomic unwind transaction plus its guaranteed-floor preview."""
+
+    preview: CreditUnloopPreviewTypedDict
+    r"""Projected end state of the unwind, computed on GUARANTEED swap floors."""
+    transaction: NotRequired[Nullable[UnsignedTransactionTypedDict]]
+    r"""Unsigned transaction for direct execution by the owner. Present when gas_sponsorship=false — except firm-priced previews (preview=true with swap_provider='bebop'), which carry numbers only: the firm quotes are fetched at execution time, so there is no payload to sign yet."""
+    eip_712: NotRequired[Nullable[BatchedSafeOperationsResponseOutputTypedDict]]
+    r"""EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true."""
+    swap_provider: NotRequired[CreditUnloopResponseSwapProvider]
+    r"""Which venue priced the swap leg(s): 'one_inch' (market route, slippage-bounded floors) or 'bebop' (firm quotes, one per swap leg, each partially filled at the leg's size). On preview=true responses, 'bebop' means the numbers are INDICATIVE, computed from the firm venue's live maker price levels without spending any quote; execution fetches the firm quotes at signing time. Always present, including on fallbacks."""
+    quote_expires_at: NotRequired[Nullable[datetime]]
+    r"""Deadline of the firm swap quotes (the earliest across the unwind's swap legs) — sign and broadcast before it or the transaction reverts on-chain; refresh by re-calling this endpoint (discard the previous payload). Present only on executable swap_provider='bebop' builds; null on previews (no quote is spent for a preview)."""
+    firm_available: NotRequired[Nullable[bool]]
+    r"""Preview-only advisory: whether a firm-quote venue can serve this unwind's swap legs (estimated without spending any quote). Present only on preview=true responses; null otherwise."""
+
+
+class CreditUnloopResponse(BaseModel):
+    r"""The atomic unwind transaction plus its guaranteed-floor preview."""
+
+    preview: CreditUnloopPreview
+    r"""Projected end state of the unwind, computed on GUARANTEED swap floors."""
+
+    transaction: OptionalNullable[UnsignedTransaction] = UNSET
+    r"""Unsigned transaction for direct execution by the owner. Present when gas_sponsorship=false — except firm-priced previews (preview=true with swap_provider='bebop'), which carry numbers only: the firm quotes are fetched at execution time, so there is no payload to sign yet."""
+
+    eip_712: OptionalNullable[BatchedSafeOperationsResponseOutput] = UNSET
+    r"""EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true."""
+
+    swap_provider: Optional[CreditUnloopResponseSwapProvider] = None
+    r"""Which venue priced the swap leg(s): 'one_inch' (market route, slippage-bounded floors) or 'bebop' (firm quotes, one per swap leg, each partially filled at the leg's size). On preview=true responses, 'bebop' means the numbers are INDICATIVE, computed from the firm venue's live maker price levels without spending any quote; execution fetches the firm quotes at signing time. Always present, including on fallbacks."""
+
+    quote_expires_at: OptionalNullable[datetime] = UNSET
+    r"""Deadline of the firm swap quotes (the earliest across the unwind's swap legs) — sign and broadcast before it or the transaction reverts on-chain; refresh by re-calling this endpoint (discard the previous payload). Present only on executable swap_provider='bebop' builds; null on previews (no quote is spent for a preview)."""
+
+    firm_available: OptionalNullable[bool] = UNSET
+    r"""Preview-only advisory: whether a firm-quote venue can serve this unwind's swap legs (estimated without spending any quote). Present only on preview=true responses; null otherwise."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "transaction",
+                "eip_712",
+                "swap_provider",
+                "quote_expires_at",
+                "firm_available",
+            ]
+        )
+        nullable_fields = set(
+            ["transaction", "eip_712", "quote_expires_at", "firm_available"]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m

{compass_api_sdk-2.2.97rc2 → compass_api_sdk-2.2.97rc4}/src/compass_api_sdk/models/tokenizedassetstraderequest.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 from .chain import Chain
 from .tokenizedassetsfee import TokenizedAssetsFee, TokenizedAssetsFeeTypedDict
+from .wisdomtreecredentials import WisdomTreeCredentials, WisdomTreeCredentialsTypedDict
 from compass_api_sdk.types import (
     BaseModel,
     Nullable,
@@ -60,6 +61,8 @@ class TokenizedAssetsTradeRequestTypedDict(TypedDict):
     r"""Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%)."""
     gas_sponsorship: NotRequired[bool]
     r"""When true, returns an EIP-712 payload for gas-sponsored execution instead of an unsigned transaction."""
+    wisdomtree: NotRequired[Nullable[WisdomTreeCredentialsTypedDict]]
+    r"""WisdomTree Connect API credentials, required only when trading a WisdomTree money-market fund. Each organization authenticates with its own credentials, which are exchanged for a short-lived token to look up the settlement wallet for this trade. They are never stored and are masked in logs."""
     fee: NotRequired[Nullable[TokenizedAssetsFeeTypedDict]]
     r"""Optional partner fee charged when selling (exiting). It is taken from the payout-token (USDC) proceeds and sent to your fee recipient inside the same execution."""
 
@@ -92,13 +95,16 @@ class TokenizedAssetsTradeRequest(BaseModel):
     gas_sponsorship: Optional[bool] = None
     r"""When true, returns an EIP-712 payload for gas-sponsored execution instead of an unsigned transaction."""
 
+    wisdomtree: OptionalNullable[WisdomTreeCredentials] = UNSET
+    r"""WisdomTree Connect API credentials, required only when trading a WisdomTree money-market fund. Each organization authenticates with its own credentials, which are exchanged for a short-lived token to look up the settlement wallet for this trade. They are never stored and are masked in logs."""
+
     fee: OptionalNullable[TokenizedAssetsFee] = UNSET
     r"""Optional partner fee charged when selling (exiting). It is taken from the payout-token (USDC) proceeds and sent to your fee recipient inside the same execution."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = set(["slippage", "gas_sponsorship", "fee"])
-        nullable_fields = set(["fee"])
+        optional_fields = set(["slippage", "gas_sponsorship", "wisdomtree", "fee"])
+        nullable_fields = set(["wisdomtree", "fee"])
         serialized = handler(self)
         m = {}
 

compass_api_sdk-2.2.97rc4/src/compass_api_sdk/models/wisdomtreecredentials.py

@@ -0,0 +1,38 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class WisdomTreeCredentialsTypedDict(TypedDict):
+    r"""Per-organization WisdomTree Connect API credentials.
+
+    Supplied per request rather than configured on the service: each
+    organization has its own WisdomTree account, whitelisted wallets and KYC,
+    so there is no single service-level credential that could serve every
+    caller. The secret is a ``SecretStr`` so it cannot be printed by accident,
+    and the error logger masks it in request bodies.
+    """
+
+    client_id: str
+    r"""WisdomTree Connect client id for your organization."""
+    client_secret: str
+    r"""WisdomTree Connect client secret for your organization."""
+
+
+class WisdomTreeCredentials(BaseModel):
+    r"""Per-organization WisdomTree Connect API credentials.
+
+    Supplied per request rather than configured on the service: each
+    organization has its own WisdomTree account, whitelisted wallets and KYC,
+    so there is no single service-level credential that could serve every
+    caller. The secret is a ``SecretStr`` so it cannot be printed by accident,
+    and the error logger masks it in request bodies.
+    """
+
+    client_id: str
+    r"""WisdomTree Connect client id for your organization."""
+
+    client_secret: str
+    r"""WisdomTree Connect client secret for your organization."""