compass_api_sdk 2.2.77rc2__tar.gz → 2.2.78rc1__tar.gz

{compass_api_sdk-2.2.77rc2 → compass_api_sdk-2.2.78rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compass_api_sdk
-Version: 2.2.77rc2
+Version: 2.2.78rc1
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.10
@@ -246,6 +246,7 @@ with CompassAPI(
 * [credit_create_account](docs/sdks/credit/README.md#credit_create_account) - Create credit account
 * [credit_borrow](docs/sdks/credit/README.md#credit_borrow) - Borrow against collateral
 * [credit_loop](docs/sdks/credit/README.md#credit_loop) - Open a leveraged loop
+* [credit_unloop](docs/sdks/credit/README.md#credit_unloop) - Unwind a leveraged loop
 * [credit_transfer](docs/sdks/credit/README.md#credit_transfer) - Transfer tokens to/from Credit Account
 * [credit_repay](docs/sdks/credit/README.md#credit_repay) - Repay debt and withdraw collateral
 * [credit_bundle](docs/sdks/credit/README.md#credit_bundle) - Execute multiple credit actions
@@ -511,9 +512,9 @@ with CompassAPI(
 
 
 **Inherit from [`CompassAPIError`](./src/compass_api_sdk/errors/compassapierror.py)**:
-* [`TokenizedAssetsErrorResponse`](./src/compass_api_sdk/errors/tokenizedassetserrorresponse.py): Standard error envelope returned by every non-2xx response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 12 of 140 methods.*
-* [`OnrampErrorResponse`](./src/compass_api_sdk/errors/onramperrorresponse.py): Standard error envelope returned by every non-2xx on-ramp response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 3 of 140 methods.*
-* [`MintPrepareNotFoundResponseError`](./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 140 methods.*
+* [`TokenizedAssetsErrorResponse`](./src/compass_api_sdk/errors/tokenizedassetserrorresponse.py): Standard error envelope returned by every non-2xx response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 12 of 141 methods.*
+* [`OnrampErrorResponse`](./src/compass_api_sdk/errors/onramperrorresponse.py): Standard error envelope returned by every non-2xx on-ramp response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 3 of 141 methods.*
+* [`MintPrepareNotFoundResponseError`](./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 141 methods.*
 * [`ResponseValidationError`](./src/compass_api_sdk/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
 
 </details>

{compass_api_sdk-2.2.77rc2 → compass_api_sdk-2.2.78rc1}/README-PYPI.md

@@ -228,6 +228,7 @@ with CompassAPI(
 * [credit_create_account](docs/sdks/credit/README.md#credit_create_account) - Create credit account
 * [credit_borrow](docs/sdks/credit/README.md#credit_borrow) - Borrow against collateral
 * [credit_loop](docs/sdks/credit/README.md#credit_loop) - Open a leveraged loop
+* [credit_unloop](docs/sdks/credit/README.md#credit_unloop) - Unwind a leveraged loop
 * [credit_transfer](docs/sdks/credit/README.md#credit_transfer) - Transfer tokens to/from Credit Account
 * [credit_repay](docs/sdks/credit/README.md#credit_repay) - Repay debt and withdraw collateral
 * [credit_bundle](docs/sdks/credit/README.md#credit_bundle) - Execute multiple credit actions
@@ -493,9 +494,9 @@ with CompassAPI(
 
 
 **Inherit from [`CompassAPIError`](./src/compass_api_sdk/errors/compassapierror.py)**:
-* [`TokenizedAssetsErrorResponse`](./src/compass_api_sdk/errors/tokenizedassetserrorresponse.py): Standard error envelope returned by every non-2xx response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 12 of 140 methods.*
-* [`OnrampErrorResponse`](./src/compass_api_sdk/errors/onramperrorresponse.py): Standard error envelope returned by every non-2xx on-ramp response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 3 of 140 methods.*
-* [`MintPrepareNotFoundResponseError`](./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 140 methods.*
+* [`TokenizedAssetsErrorResponse`](./src/compass_api_sdk/errors/tokenizedassetserrorresponse.py): Standard error envelope returned by every non-2xx response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 12 of 141 methods.*
+* [`OnrampErrorResponse`](./src/compass_api_sdk/errors/onramperrorresponse.py): Standard error envelope returned by every non-2xx on-ramp response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 3 of 141 methods.*
+* [`MintPrepareNotFoundResponseError`](./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 141 methods.*
 * [`ResponseValidationError`](./src/compass_api_sdk/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
 
 </details>

{compass_api_sdk-2.2.77rc2 → compass_api_sdk-2.2.78rc1}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "compass_api_sdk"
-version = "2.2.77rc2"
+version = "2.2.78rc1"
 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.77rc2"
+version = "2.2.78rc1"
 description = "Compass API SDK."
 authors = ["Compass Labs"]
 repository = "https://github.com/CompassLabs/mono.git"

{compass_api_sdk-2.2.77rc2 → compass_api_sdk-2.2.78rc1}/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.915.0"
-__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.915.0 0.0.1 compass_api_sdk"
+__gen_version__: str = "2.915.1"
+__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.915.1 0.0.1 compass_api_sdk"
 
 try:
     if __package__ is not None:

{compass_api_sdk-2.2.77rc2 → compass_api_sdk-2.2.78rc1}/src/compass_api_sdk/credit.py

@@ -1865,6 +1865,320 @@ class Credit(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
+    def credit_unloop(
+        self,
+        *,
+        owner: str,
+        chain: models.Chain,
+        collateral_token: str,
+        borrow_token: str,
+        protocol: Optional[models.CreditProtocol] = None,
+        market_id: OptionalNullable[str] = UNSET,
+        target_multiplier: OptionalNullable[
+            Union[models.TargetMultiplier, models.TargetMultiplierTypedDict]
+        ] = UNSET,
+        max_slippage_percent: Optional[
+            Union[
+                models.CreditUnloopRequestMaxSlippagePercent,
+                models.CreditUnloopRequestMaxSlippagePercentTypedDict,
+            ]
+        ] = None,
+        allow_partial: Optional[bool] = None,
+        gas_sponsorship: Optional[bool] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.CreditUnloopResponse:
+        r"""Unwind a leveraged loop
+
+        Unwind an Aave or Morpho loop in ONE atomic transaction.
+
+        Repeatedly withdraws collateral, swaps it to the borrow token at a GUARANTEED
+        minimum output (enforced on-chain), and repays. The floor discipline means a
+        swap filling anywhere within the slippage tolerance can never break a later
+        step; any positive surplus stays in the Credit Account as borrow-token dust
+        (the preview reports the bound as estimated_max_dust).
+
+        Omit target_multiplier for a full close: the debt is cleared exactly —
+        accrued interest included — and the pair collateral is returned to the Credit
+        Account. Pass 1 to clear the debt but keep the collateral supplied, or a value
+        above 1 to delever to that multiplier (it must be below the position's current
+        multiplier).
+
+        Each withdrawal is sized to keep the position's health factor ≥ 1.02 at that
+        step, so a position opened very close to the liquidation threshold may need
+        more than one transaction to fully close — set allow_partial=true to return
+        the maximum single-transaction progress (preview.fully_unwound=false), then
+        call unloop again to finish. Very large unwinds relative to pool depth can
+        still exceed the slippage tolerance through their own cumulative price impact.
+
+        For protocol=MORPHO pass a market_id from /v2/credit/morpho_markets; inspect
+        open loops via /v2/credit/looped_positions.
+
+        :param owner: The address that owns the Credit Account.
+        :param chain: The chain to use.
+        :param collateral_token: Token supplied as collateral in the loop being unwound. For MORPHO it must be the market's collateral token.
+        :param borrow_token: Token borrowed in the loop; withdrawn collateral is swapped back to it and used to repay. For MORPHO it must be the market's loan token.
+        :param protocol: Which lending protocol a credit action targets.
+
+            ``AAVE`` is the default so existing callers (which never send a ``protocol``
+            field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the
+            Euler V2 path, where the market is identified by EVK vault address(es).
+            ``MORPHO`` identifies Morpho Blue lending markets (bytes32 market id) and is
+            currently read-only: positions and market discovery only — transaction
+            builders land with the looping work (COM-7106/7107/7108), so transact
+            endpoints reject it with a 422.
+        :param market_id: Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO.
+        :param target_multiplier: Target leverage after the unwind. Omit (null) for a FULL unwind: the debt is cleared exactly — accrued interest included — and all pair collateral is withdrawn back to the Credit Account. `1` runs the same exact debt close but leaves the collateral supplied (earning). A value greater than 1 delevers the position to that multiplier. Must be below the position's current multiplier.
+        :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 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
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.CreditUnloopRequest(
+            owner=owner,
+            chain=chain,
+            protocol=protocol,
+            market_id=market_id,
+            collateral_token=collateral_token,
+            borrow_token=borrow_token,
+            target_multiplier=target_multiplier,
+            max_slippage_percent=max_slippage_percent,
+            allow_partial=allow_partial,
+            gas_sponsorship=gas_sponsorship,
+        )
+
+        req = self._build_request(
+            method="POST",
+            path="/v2/credit/unloop",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request, False, False, "json", models.CreditUnloopRequest
+            ),
+            allow_empty_value=None,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="v2_credit_unloop",
+                oauth2_scopes=None,
+                security_source=self.sdk_configuration.security,
+                tags=["Credit"],
+                extensions=None,
+            ),
+            request=req,
+            is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.CreditUnloopResponse, http_res)
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.HTTPValidationErrorData, http_res
+            )
+            raise errors.HTTPValidationError(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    async def credit_unloop_async(
+        self,
+        *,
+        owner: str,
+        chain: models.Chain,
+        collateral_token: str,
+        borrow_token: str,
+        protocol: Optional[models.CreditProtocol] = None,
+        market_id: OptionalNullable[str] = UNSET,
+        target_multiplier: OptionalNullable[
+            Union[models.TargetMultiplier, models.TargetMultiplierTypedDict]
+        ] = UNSET,
+        max_slippage_percent: Optional[
+            Union[
+                models.CreditUnloopRequestMaxSlippagePercent,
+                models.CreditUnloopRequestMaxSlippagePercentTypedDict,
+            ]
+        ] = None,
+        allow_partial: Optional[bool] = None,
+        gas_sponsorship: Optional[bool] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.CreditUnloopResponse:
+        r"""Unwind a leveraged loop
+
+        Unwind an Aave or Morpho loop in ONE atomic transaction.
+
+        Repeatedly withdraws collateral, swaps it to the borrow token at a GUARANTEED
+        minimum output (enforced on-chain), and repays. The floor discipline means a
+        swap filling anywhere within the slippage tolerance can never break a later
+        step; any positive surplus stays in the Credit Account as borrow-token dust
+        (the preview reports the bound as estimated_max_dust).
+
+        Omit target_multiplier for a full close: the debt is cleared exactly —
+        accrued interest included — and the pair collateral is returned to the Credit
+        Account. Pass 1 to clear the debt but keep the collateral supplied, or a value
+        above 1 to delever to that multiplier (it must be below the position's current
+        multiplier).
+
+        Each withdrawal is sized to keep the position's health factor ≥ 1.02 at that
+        step, so a position opened very close to the liquidation threshold may need
+        more than one transaction to fully close — set allow_partial=true to return
+        the maximum single-transaction progress (preview.fully_unwound=false), then
+        call unloop again to finish. Very large unwinds relative to pool depth can
+        still exceed the slippage tolerance through their own cumulative price impact.
+
+        For protocol=MORPHO pass a market_id from /v2/credit/morpho_markets; inspect
+        open loops via /v2/credit/looped_positions.
+
+        :param owner: The address that owns the Credit Account.
+        :param chain: The chain to use.
+        :param collateral_token: Token supplied as collateral in the loop being unwound. For MORPHO it must be the market's collateral token.
+        :param borrow_token: Token borrowed in the loop; withdrawn collateral is swapped back to it and used to repay. For MORPHO it must be the market's loan token.
+        :param protocol: Which lending protocol a credit action targets.
+
+            ``AAVE`` is the default so existing callers (which never send a ``protocol``
+            field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the
+            Euler V2 path, where the market is identified by EVK vault address(es).
+            ``MORPHO`` identifies Morpho Blue lending markets (bytes32 market id) and is
+            currently read-only: positions and market discovery only — transaction
+            builders land with the looping work (COM-7106/7107/7108), so transact
+            endpoints reject it with a 422.
+        :param market_id: Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO.
+        :param target_multiplier: Target leverage after the unwind. Omit (null) for a FULL unwind: the debt is cleared exactly — accrued interest included — and all pair collateral is withdrawn back to the Credit Account. `1` runs the same exact debt close but leaves the collateral supplied (earning). A value greater than 1 delevers the position to that multiplier. Must be below the position's current multiplier.
+        :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 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
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.CreditUnloopRequest(
+            owner=owner,
+            chain=chain,
+            protocol=protocol,
+            market_id=market_id,
+            collateral_token=collateral_token,
+            borrow_token=borrow_token,
+            target_multiplier=target_multiplier,
+            max_slippage_percent=max_slippage_percent,
+            allow_partial=allow_partial,
+            gas_sponsorship=gas_sponsorship,
+        )
+
+        req = self._build_request_async(
+            method="POST",
+            path="/v2/credit/unloop",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request, False, False, "json", models.CreditUnloopRequest
+            ),
+            allow_empty_value=None,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="v2_credit_unloop",
+                oauth2_scopes=None,
+                security_source=self.sdk_configuration.security,
+                tags=["Credit"],
+                extensions=None,
+            ),
+            request=req,
+            is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.CreditUnloopResponse, http_res)
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.HTTPValidationErrorData, http_res
+            )
+            raise errors.HTTPValidationError(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
     def credit_transfer(
         self,
         *,

{compass_api_sdk-2.2.77rc2 → compass_api_sdk-2.2.78rc1}/src/compass_api_sdk/models/__init__.py

@@ -524,6 +524,19 @@ if TYPE_CHECKING:
         CreditTransferToAddressParamsAmountTypedDict,
         CreditTransferToAddressParamsTypedDict,
     )
+    from .creditunlooppreview import CreditUnloopPreview, CreditUnloopPreviewTypedDict
+    from .creditunlooprequest import (
+        CreditUnloopRequest,
+        CreditUnloopRequestMaxSlippagePercent,
+        CreditUnloopRequestMaxSlippagePercentTypedDict,
+        CreditUnloopRequestTypedDict,
+        TargetMultiplier,
+        TargetMultiplierTypedDict,
+    )
+    from .creditunloopresponse import (
+        CreditUnloopResponse,
+        CreditUnloopResponseTypedDict,
+    )
     from .credituseroperation import (
         CreditUserOperation,
         CreditUserOperationBody,
@@ -1479,6 +1492,7 @@ if TYPE_CHECKING:
         UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawalTypedDict,
         UniswapWithdrawLiquidityProvisionRequestTypedDict,
     )
+    from .unlooplegpreview import UnloopLegPreview, UnloopLegPreviewTypedDict
     from .unsignedmulticalltransaction import (
         UnsignedMulticallTransaction,
         UnsignedMulticallTransactionTypedDict,
@@ -2260,6 +2274,14 @@ __all__ = [
     "CreditTransferToAddressParamsAmount",
     "CreditTransferToAddressParamsAmountTypedDict",
     "CreditTransferToAddressParamsTypedDict",
+    "CreditUnloopPreview",
+    "CreditUnloopPreviewTypedDict",
+    "CreditUnloopRequest",
+    "CreditUnloopRequestMaxSlippagePercent",
+    "CreditUnloopRequestMaxSlippagePercentTypedDict",
+    "CreditUnloopRequestTypedDict",
+    "CreditUnloopResponse",
+    "CreditUnloopResponseTypedDict",
     "CreditUserOperation",
     "CreditUserOperationBody",
     "CreditUserOperationBodyTypedDict",
@@ -2809,6 +2831,8 @@ __all__ = [
     "SwapInfoTypedDict",
     "SyPosition",
     "SyPositionTypedDict",
+    "TargetMultiplier",
+    "TargetMultiplierTypedDict",
     "TokenAmount",
     "TokenAmountTypedDict",
     "TokenBalanceResponse",
@@ -2986,6 +3010,8 @@ __all__ = [
     "UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawal",
     "UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawalTypedDict",
     "UniswapWithdrawLiquidityProvisionRequestTypedDict",
+    "UnloopLegPreview",
+    "UnloopLegPreviewTypedDict",
     "UnsignedMulticallTransaction",
     "UnsignedMulticallTransactionTypedDict",
     "UnsignedTransaction",
@@ -3618,6 +3644,16 @@ _dynamic_imports: dict[str, str] = {
     "CreditTransferToAddressParamsAmount": ".credittransfertoaddressparams",
     "CreditTransferToAddressParamsAmountTypedDict": ".credittransfertoaddressparams",
     "CreditTransferToAddressParamsTypedDict": ".credittransfertoaddressparams",
+    "CreditUnloopPreview": ".creditunlooppreview",
+    "CreditUnloopPreviewTypedDict": ".creditunlooppreview",
+    "CreditUnloopRequest": ".creditunlooprequest",
+    "CreditUnloopRequestMaxSlippagePercent": ".creditunlooprequest",
+    "CreditUnloopRequestMaxSlippagePercentTypedDict": ".creditunlooprequest",
+    "CreditUnloopRequestTypedDict": ".creditunlooprequest",
+    "TargetMultiplier": ".creditunlooprequest",
+    "TargetMultiplierTypedDict": ".creditunlooprequest",
+    "CreditUnloopResponse": ".creditunloopresponse",
+    "CreditUnloopResponseTypedDict": ".creditunloopresponse",
     "CreditUserOperation": ".credituseroperation",
     "CreditUserOperationBody": ".credituseroperation",
     "CreditUserOperationBodyTypedDict": ".credituseroperation",
@@ -4331,6 +4367,8 @@ _dynamic_imports: dict[str, str] = {
     "UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawal": ".uniswapwithdrawliquidityprovisionrequest",
     "UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawalTypedDict": ".uniswapwithdrawliquidityprovisionrequest",
     "UniswapWithdrawLiquidityProvisionRequestTypedDict": ".uniswapwithdrawliquidityprovisionrequest",
+    "UnloopLegPreview": ".unlooplegpreview",
+    "UnloopLegPreviewTypedDict": ".unlooplegpreview",
     "UnsignedMulticallTransaction": ".unsignedmulticalltransaction",
     "UnsignedMulticallTransactionTypedDict": ".unsignedmulticalltransaction",
     "UnsignedTransaction": ".unsignedtransaction",

compass_api_sdk-2.2.78rc1/src/compass_api_sdk/models/creditunlooppreview.py

@@ -0,0 +1,88 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .unlooplegpreview import UnloopLegPreview, UnloopLegPreviewTypedDict
+from compass_api_sdk.types import BaseModel, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class CreditUnloopPreviewTypedDict(TypedDict):
+    r"""Projected end state of the unwind, computed on GUARANTEED swap floors."""
+
+    iterations: int
+    r"""Number of swap-bearing unwind iterations bundled (the final collateral sweep leg does not count)."""
+    total_collateral_withdrawn: str
+    r"""Guaranteed minimum total collateral withdrawn (token units)."""
+    total_debt_repaid: str
+    r"""Guaranteed minimum total debt repaid (borrow-token units); actual can only be higher (swap fills above the floor repay more)."""
+    ending_collateral: str
+    r"""Pair collateral left supplied after the unwind (token units). On a full close this is 0, except when non-pair Aave debt still needs this collateral as backing — then the final sweep is capped and this reports the residual left supplied."""
+    ending_debt: str
+    r"""Projected remaining debt (borrow-token units); 0 on a full close."""
+    ending_multiplier: str
+    r"""Projected leverage after the unwind; 1 when the debt is cleared. Never promises more deleverage than is guaranteed."""
+    projected_ltv: str
+    r"""Projected end loan-to-value in percent, at the sizing oracle prices; 0 when the debt is cleared."""
+    projected_health_factor: str
+    r"""Projected health factor (Aave account-level / Morpho market-level). Never overstated at the 1.0 boundary."""
+    estimated_max_dust: str
+    r"""Upper bound of borrow-token surplus the unwind can leave in the Credit Account — the sum of each swap's quote minus its guaranteed floor plus the full-close overshoot. It accumulates in the Credit Account, is recoverable, and is never lost."""
+    fully_unwound: bool
+    r"""True when the requested target was fully reached in this transaction. False on a partial-progress plan (allow_partial=true) — call unloop again to finish."""
+    legs: NotRequired[List[UnloopLegPreviewTypedDict]]
+    r"""Per-iteration breakdown."""
+
+
+class CreditUnloopPreview(BaseModel):
+    r"""Projected end state of the unwind, computed on GUARANTEED swap floors."""
+
+    iterations: int
+    r"""Number of swap-bearing unwind iterations bundled (the final collateral sweep leg does not count)."""
+
+    total_collateral_withdrawn: str
+    r"""Guaranteed minimum total collateral withdrawn (token units)."""
+
+    total_debt_repaid: str
+    r"""Guaranteed minimum total debt repaid (borrow-token units); actual can only be higher (swap fills above the floor repay more)."""
+
+    ending_collateral: str
+    r"""Pair collateral left supplied after the unwind (token units). On a full close this is 0, except when non-pair Aave debt still needs this collateral as backing — then the final sweep is capped and this reports the residual left supplied."""
+
+    ending_debt: str
+    r"""Projected remaining debt (borrow-token units); 0 on a full close."""
+
+    ending_multiplier: str
+    r"""Projected leverage after the unwind; 1 when the debt is cleared. Never promises more deleverage than is guaranteed."""
+
+    projected_ltv: str
+    r"""Projected end loan-to-value in percent, at the sizing oracle prices; 0 when the debt is cleared."""
+
+    projected_health_factor: str
+    r"""Projected health factor (Aave account-level / Morpho market-level). Never overstated at the 1.0 boundary."""
+
+    estimated_max_dust: str
+    r"""Upper bound of borrow-token surplus the unwind can leave in the Credit Account — the sum of each swap's quote minus its guaranteed floor plus the full-close overshoot. It accumulates in the Credit Account, is recoverable, and is never lost."""
+
+    fully_unwound: bool
+    r"""True when the requested target was fully reached in this transaction. False on a partial-progress plan (allow_partial=true) — call unloop again to finish."""
+
+    legs: Optional[List[UnloopLegPreview]] = None
+    r"""Per-iteration breakdown."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["legs"])
+        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))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m