publicdotcom-cli 1.3.1__tar.gz → 1.3.2__tar.gz

{publicdotcom_cli-1.3.1 → publicdotcom_cli-1.3.2}/CHANGELOG.md

@@ -5,6 +5,41 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.3.2] - 2026-08-05
+
+### Added
+- `public instruments bonds` command covering the new
+  `GET /userapigateway/trading/instruments/bonds` endpoint: paged, filtered
+  fixed-income search with options for issuer, bond status/type, treasury
+  subtype, S&P rating/outlook/creditwatch, coupon, maturity dates, current
+  yield, par value, liquidity rating, and callable/perpetual/partial-par flags.
+- `public market bond-details SYMBOL` command covering the new
+  `GET /userapigateway/marketdata/{accountId}/bond-details/{symbol}` endpoint,
+  returning comprehensive bond pricing, rating, coupon, and maturity/call data.
+- `--quantity` and `--amount` overrides on `public order replace`, mirroring the
+  cancel-replace request schema's new notional `amount` field. The two are
+  mutually exclusive (enforced before submission, including when both fields
+  appear in the request file). Replacement is now supported for equity, option,
+  and crypto quantity orders.
+- `examples/order.replace.notional.json` demonstrating a notional (`amount`)
+  cancel-replace payload.
+- README sections for bond search, bond details, and order replacement.
+
+### Changed
+- Regenerated `_generated/` from the updated `spec.yaml`:
+  - New `search-bonds` and `get-bond-details` endpoint modules and models
+    (`InstrumentDto`, `BondDetailsResponse`, Spring page/pageable/sort, and the
+    bond search filter enums).
+  - `amount` added to `ApiCancelReplaceOrderRequest` (mutually exclusive with
+    `quantity`).
+  - `AGGREGATE` added to the tax-lot `OutOfDateStatus` `type` enum.
+  - Refreshed endpoint docstrings (instruments list/get, quotes, greeks,
+    history, replace-order) to match the updated spec text; `get-instrument`
+    now documents 400/404 responses.
+- `scripts/generate_client.py` now injects `x-enum-varnames` for enum values
+  that collide after sanitization (e.g. S&P ratings `AA+`/`AA`/`AA-`), which
+  the bonds `rating` filter requires for generation to succeed.
+
 ## [1.3.1] - 2026-07-24
 
 ### Changed

{publicdotcom_cli-1.3.1 → publicdotcom_cli-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: publicdotcom-cli
-Version: 1.3.1
+Version: 1.3.2
 Summary: Command-line client for the Public.com Trading API
 Project-URL: Homepage, https://github.com/publicdotcom/publicdotcom-cli
 Project-URL: Repository, https://github.com/publicdotcom/publicdotcom-cli
@@ -182,7 +182,9 @@ public accounts set-default ACCOUNT_ID
 public portfolio show
 public history list --page-size 25
 public instruments get AAPL EQUITY
+public instruments bonds --bond-type TREASURY --rating AAA
 public market quotes AAPL MSFT --type EQUITY
+public market bond-details 912828XG0-BOND
 public market option-expirations AAPL
 public market option-chain AAPL 2026-05-15
 public options greeks "AAPL  260515C00200000"
@@ -226,6 +228,7 @@ Trading requests use JSON files so the exact payload is visible before submissio
 ```bash
 public order preflight-single --file examples/order.single-leg.market-buy.json
 public order place --file examples/order.single-leg.market-buy.json
+public order replace --file examples/order.replace.notional.json
 public order get ORDER_ID
 public order cancel ORDER_ID
 ```
@@ -245,6 +248,18 @@ Order-placement and single-leg preflight payloads also accept an optional
 which tax lots to close when selling equity. See
 `examples/order.single-leg.tax-lot-matching.json` for a sample.
 
+`order replace` submits a cancel-replace request for an open order. The replacement can
+specify either a `quantity` or a notional `amount` — the two fields are mutually
+exclusive. `--quantity` and `--amount` override the corresponding field in the request
+file. Replacement is supported for equity, option, and crypto quantity orders, and is
+asynchronous: verify order status after submitting. See
+`examples/order.replace.notional.json` for a sample notional replacement payload.
+
+```bash
+public order replace --file examples/order.replace.notional.json
+public order replace --file examples/order.replace.notional.json --amount 250.00
+```
+
 ## Tax Lots
 
 Inspect unrealized tax lots for the configured (or `--account-id`) account:
@@ -276,6 +291,32 @@ The request body is a `StrategyQuoteRequest` with a `baseSymbol` and an `optionL
 (each leg is `{symbol, side, openCloseIndicator, ratioQuantity}`), plus an optional
 `equityLeg`. See `examples/strategy-quote.request.json` for a sample.
 
+## Bonds
+
+Search fixed income instruments with optional filtering, sorting, and pagination:
+
+```bash
+public instruments bonds
+public instruments bonds --bond-type TREASURY --treasury-subtype NOTE --min-coupon 4
+public instruments bonds --rating AAA --rating AA+ --max-maturity-date 2030-12-31
+public instruments bonds --page-size 50 --sort-property maturityDate --sort-direction ASC
+```
+
+Filters cover issuer, bond status/type, treasury subtype, S&P ratings and outlook,
+coupon, maturity dates, current yield, par value, liquidity rating, and
+callable/perpetual/partial-par flags. Repeatable options (for example `--rating`) can be
+passed multiple times. Results are returned as a page with `content` plus paging
+metadata. The API defaults the minimum maturity date to today + 14 days to exclude bonds
+nearing maturity with volatile yields; pass `--min-maturity-date` to override.
+
+Retrieve comprehensive details for a single bond — pricing, ratings, coupon, and
+maturity/call information — using the configured (or `--account-id`) account. The bond
+symbol is typically in `CUSIP-BOND` format:
+
+```bash
+public market bond-details 912828XG0-BOND
+```
+
 ## JSON Output
 
 Use `--json` before the command group to print raw JSON:

{publicdotcom_cli-1.3.1 → publicdotcom_cli-1.3.2}/README.md

@@ -144,7 +144,9 @@ public accounts set-default ACCOUNT_ID
 public portfolio show
 public history list --page-size 25
 public instruments get AAPL EQUITY
+public instruments bonds --bond-type TREASURY --rating AAA
 public market quotes AAPL MSFT --type EQUITY
+public market bond-details 912828XG0-BOND
 public market option-expirations AAPL
 public market option-chain AAPL 2026-05-15
 public options greeks "AAPL  260515C00200000"
@@ -188,6 +190,7 @@ Trading requests use JSON files so the exact payload is visible before submissio
 ```bash
 public order preflight-single --file examples/order.single-leg.market-buy.json
 public order place --file examples/order.single-leg.market-buy.json
+public order replace --file examples/order.replace.notional.json
 public order get ORDER_ID
 public order cancel ORDER_ID
 ```
@@ -207,6 +210,18 @@ Order-placement and single-leg preflight payloads also accept an optional
 which tax lots to close when selling equity. See
 `examples/order.single-leg.tax-lot-matching.json` for a sample.
 
+`order replace` submits a cancel-replace request for an open order. The replacement can
+specify either a `quantity` or a notional `amount` — the two fields are mutually
+exclusive. `--quantity` and `--amount` override the corresponding field in the request
+file. Replacement is supported for equity, option, and crypto quantity orders, and is
+asynchronous: verify order status after submitting. See
+`examples/order.replace.notional.json` for a sample notional replacement payload.
+
+```bash
+public order replace --file examples/order.replace.notional.json
+public order replace --file examples/order.replace.notional.json --amount 250.00
+```
+
 ## Tax Lots
 
 Inspect unrealized tax lots for the configured (or `--account-id`) account:
@@ -238,6 +253,32 @@ The request body is a `StrategyQuoteRequest` with a `baseSymbol` and an `optionL
 (each leg is `{symbol, side, openCloseIndicator, ratioQuantity}`), plus an optional
 `equityLeg`. See `examples/strategy-quote.request.json` for a sample.
 
+## Bonds
+
+Search fixed income instruments with optional filtering, sorting, and pagination:
+
+```bash
+public instruments bonds
+public instruments bonds --bond-type TREASURY --treasury-subtype NOTE --min-coupon 4
+public instruments bonds --rating AAA --rating AA+ --max-maturity-date 2030-12-31
+public instruments bonds --page-size 50 --sort-property maturityDate --sort-direction ASC
+```
+
+Filters cover issuer, bond status/type, treasury subtype, S&P ratings and outlook,
+coupon, maturity dates, current yield, par value, liquidity rating, and
+callable/perpetual/partial-par flags. Repeatable options (for example `--rating`) can be
+passed multiple times. Results are returned as a page with `content` plus paging
+metadata. The API defaults the minimum maturity date to today + 14 days to exclude bonds
+nearing maturity with volatile yields; pass `--min-maturity-date` to override.
+
+Retrieve comprehensive details for a single bond — pricing, ratings, coupon, and
+maturity/call information — using the configured (or `--account-id`) account. The bond
+symbol is typically in `CUSIP-BOND` format:
+
+```bash
+public market bond-details 912828XG0-BOND
+```
+
 ## JSON Output
 
 Use `--json` before the command group to print raw JSON:

publicdotcom_cli-1.3.2/examples/order.replace.notional.json

@@ -0,0 +1,10 @@
+{
+  "orderId": "11111111-1111-1111-1111-111111111111",
+  "requestId": "22222222-2222-2222-2222-222222222222",
+  "orderType": "LIMIT",
+  "expiration": {
+    "timeInForce": "DAY"
+  },
+  "amount": "100.00",
+  "limitPrice": "50.00"
+}

{publicdotcom_cli-1.3.1 → publicdotcom_cli-1.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "publicdotcom-cli"
-version = "1.3.1"
+version = "1.3.2"
 description = "Command-line client for the Public.com Trading API"
 readme = "README.md"
 requires-python = ">=3.10"

publicdotcom_cli-1.3.2/scripts/generate_client.py

@@ -0,0 +1,108 @@
+from __future__ import annotations
+
+import re
+import shutil
+import subprocess
+import tempfile
+from pathlib import Path
+
+ROOT = Path(__file__).resolve().parents[1]
+SPEC_PATH = ROOT / "spec.yaml"
+OUTPUT_PATH = ROOT / "src" / "publicdotcom_cli" / "_generated"
+
+
+def normalized_spec_text() -> str:
+    if not SPEC_PATH.exists():
+        raise SystemExit(
+            f"OpenAPI spec not found at {SPEC_PATH}. "
+            "Place the local, uncommitted spec at the repository root as spec.yaml."
+        )
+    text = SPEC_PATH.read_text(encoding="utf-8")
+    text = re.sub(r"^(\s*)'\*/\*':", r"\1application/json:", text, flags=re.MULTILINE)
+    return _inject_enum_varnames(text)
+
+
+def _enum_collision_key(value: str) -> str:
+    """Approximate the enum member key openapi-python-client derives from a value."""
+    return "_".join(re.findall(r"[A-Za-z0-9]+", value)).upper()
+
+
+def _enum_varname(value: str, index: int) -> str:
+    """Build a distinct, valid enum member name for a value like `AA+` or `SP-1`."""
+    name = value.strip().upper()
+    if not name or not name[0].isalpha():
+        return f"VALUE_{index}"
+    name = name.replace("+", "_PLUS")
+    if name.endswith("-"):
+        name = f"{name[:-1]}_MINUS"
+    return re.sub(r"[^A-Z0-9]+", "_", name).strip("_")
+
+
+def _inject_enum_varnames(text: str) -> str:
+    """Add `x-enum-varnames` to enum blocks whose values collide after sanitization.
+
+    openapi-python-client derives enum member names by stripping symbols, so values
+    such as `AA+`, `AA`, and `AA-` (S&P bond ratings) all map to `AA` and generation
+    fails with a duplicate-key error. Providing explicit `x-enum-varnames` keeps the
+    enum values faithful to the spec while giving each member a distinct name.
+    """
+    lines = text.split("\n")
+    out: list[str] = []
+    i = 0
+    enum_re = re.compile(r"^(\s*)enum:\s*$")
+    while i < len(lines):
+        out.append(lines[i])
+        match = enum_re.match(lines[i])
+        if not match:
+            i += 1
+            continue
+        indent = match.group(1)
+        item_re = re.compile(rf"^({re.escape(indent)}\s+)- (\S.*?)\s*$")
+        values: list[str] = []
+        item_indent = ""
+        j = i + 1
+        while j < len(lines):
+            item = item_re.match(lines[j])
+            if not item:
+                break
+            item_indent = item.group(1)
+            values.append(item.group(2).strip("'\""))
+            out.append(lines[j])
+            j += 1
+        keys = [_enum_collision_key(value) for value in values]
+        if values and len(set(keys)) != len(keys):
+            varnames = [_enum_varname(value, index) for index, value in enumerate(values)]
+            if len(set(varnames)) != len(varnames):
+                raise SystemExit(f"Could not build distinct x-enum-varnames for enum: {values}")
+            out.append(f"{indent}x-enum-varnames:")
+            out.extend(f"{item_indent}- {varname}" for varname in varnames)
+        i = j
+    return "\n".join(out)
+
+
+def main() -> None:
+    with tempfile.TemporaryDirectory() as tmp:
+        normalized_spec = Path(tmp) / "spec.codegen.yaml"
+        normalized_spec.write_text(normalized_spec_text(), encoding="utf-8")
+        subprocess.run(
+            [
+                "uvx",
+                "openapi-python-client",
+                "generate",
+                "--path",
+                str(normalized_spec),
+                "--output-path",
+                str(OUTPUT_PATH),
+                "--overwrite",
+                "--meta",
+                "none",
+            ],
+            check=True,
+            cwd=ROOT,
+        )
+
+    shutil.rmtree(OUTPUT_PATH / ".ruff_cache", ignore_errors=True)
+
+
+if __name__ == "__main__":
+    main()

{publicdotcom_cli-1.3.1 → publicdotcom_cli-1.3.2}/src/publicdotcom_cli/__init__.py

@@ -1,3 +1,3 @@
 """Command-line tools for the Public API."""
 
-__version__ = "1.3.1"
+__version__ = "1.3.2"

{publicdotcom_cli-1.3.1 → publicdotcom_cli-1.3.2}/src/publicdotcom_cli/_generated/api/account_details/get_history.py

@@ -95,8 +95,9 @@ def sync_detailed(
 ) -> Response[Any | ComHellopublicUserapigatewayApiRestHistoryGatewayHistoryResponsePage]:
     """Retrieve account history
 
-     Fetches a paginated list of historical events for the specified account. Supports optional time
-    range filtering and pagination via a continuation token.
+     Fetches a paginated list of historical account events — including trades, money movements, and
+    position adjustments — for the specified account. Supports optional time-range filtering (start/end)
+    and pagination via the nextToken continuation token.
 
     Args:
         account_id (str):
@@ -139,8 +140,9 @@ def sync(
 ) -> Any | ComHellopublicUserapigatewayApiRestHistoryGatewayHistoryResponsePage | None:
     """Retrieve account history
 
-     Fetches a paginated list of historical events for the specified account. Supports optional time
-    range filtering and pagination via a continuation token.
+     Fetches a paginated list of historical account events — including trades, money movements, and
+    position adjustments — for the specified account. Supports optional time-range filtering (start/end)
+    and pagination via the nextToken continuation token.
 
     Args:
         account_id (str):
@@ -178,8 +180,9 @@ async def asyncio_detailed(
 ) -> Response[Any | ComHellopublicUserapigatewayApiRestHistoryGatewayHistoryResponsePage]:
     """Retrieve account history
 
-     Fetches a paginated list of historical events for the specified account. Supports optional time
-    range filtering and pagination via a continuation token.
+     Fetches a paginated list of historical account events — including trades, money movements, and
+    position adjustments — for the specified account. Supports optional time-range filtering (start/end)
+    and pagination via the nextToken continuation token.
 
     Args:
         account_id (str):
@@ -220,8 +223,9 @@ async def asyncio(
 ) -> Any | ComHellopublicUserapigatewayApiRestHistoryGatewayHistoryResponsePage | None:
     """Retrieve account history
 
-     Fetches a paginated list of historical events for the specified account. Supports optional time
-    range filtering and pagination via a continuation token.
+     Fetches a paginated list of historical account events — including trades, money movements, and
+    position adjustments — for the specified account. Supports optional time-range filtering (start/end)
+    and pagination via the nextToken continuation token.
 
     Args:
         account_id (str):

{publicdotcom_cli-1.3.1 → publicdotcom_cli-1.3.2}/src/publicdotcom_cli/_generated/api/instrument_details/get_all_instruments.py

@@ -127,7 +127,7 @@ def sync_detailed(
     option_spread_trading_filter: list[GetAllInstrumentsOptionSpreadTradingFilterItem]
     | Unset = UNSET,
 ) -> Response[ComHellopublicUserapigatewayApiRestOrderApiInstrumentResponse]:
-    """Retrieves all available trading instruments with optional filtering capabilities.
+    """Retrieve all trading instruments
 
      Retrieves all available trading instruments with optional filtering capabilities.
 
@@ -176,7 +176,7 @@ def sync(
     option_spread_trading_filter: list[GetAllInstrumentsOptionSpreadTradingFilterItem]
     | Unset = UNSET,
 ) -> ComHellopublicUserapigatewayApiRestOrderApiInstrumentResponse | None:
-    """Retrieves all available trading instruments with optional filtering capabilities.
+    """Retrieve all trading instruments
 
      Retrieves all available trading instruments with optional filtering capabilities.
 
@@ -220,7 +220,7 @@ async def asyncio_detailed(
     option_spread_trading_filter: list[GetAllInstrumentsOptionSpreadTradingFilterItem]
     | Unset = UNSET,
 ) -> Response[ComHellopublicUserapigatewayApiRestOrderApiInstrumentResponse]:
-    """Retrieves all available trading instruments with optional filtering capabilities.
+    """Retrieve all trading instruments
 
      Retrieves all available trading instruments with optional filtering capabilities.
 
@@ -267,7 +267,7 @@ async def asyncio(
     option_spread_trading_filter: list[GetAllInstrumentsOptionSpreadTradingFilterItem]
     | Unset = UNSET,
 ) -> ComHellopublicUserapigatewayApiRestOrderApiInstrumentResponse | None:
-    """Retrieves all available trading instruments with optional filtering capabilities.
+    """Retrieve all trading instruments
 
      Retrieves all available trading instruments with optional filtering capabilities.
 

{publicdotcom_cli-1.3.1 → publicdotcom_cli-1.3.2}/src/publicdotcom_cli/_generated/api/instrument_details/get_instrument.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any
+from typing import Any, cast
 from urllib.parse import quote
 
 import httpx
@@ -31,7 +31,7 @@ def _get_kwargs(
 
 def _parse_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto | None:
+) -> Any | ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto | None:
     if response.status_code == 200:
         response_200 = ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto.from_dict(
             response.json()
@@ -39,6 +39,14 @@ def _parse_response(
 
         return response_200
 
+    if response.status_code == 400:
+        response_400 = cast(Any, None)
+        return response_400
+
+    if response.status_code == 404:
+        response_404 = cast(Any, None)
+        return response_404
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:
@@ -47,7 +55,7 @@ def _parse_response(
 
 def _build_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> Response[ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto]:
+) -> Response[Any | ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -61,8 +69,12 @@ def sync_detailed(
     type_: GetInstrumentType,
     *,
     client: AuthenticatedClient | Client,
-) -> Response[ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto]:
-    """
+) -> Response[Any | ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto]:
+    """Retrieve a single instrument
+
+     Retrieves detailed reference data for a single trading instrument, identified by its symbol and
+    security type. Use this when you already know the symbol and type.
+
     Args:
         symbol (str):
         type_ (GetInstrumentType):
@@ -72,7 +84,7 @@ def sync_detailed(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto]
+        Response[Any | ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto]
     """
 
     kwargs = _get_kwargs(
@@ -92,8 +104,12 @@ def sync(
     type_: GetInstrumentType,
     *,
     client: AuthenticatedClient | Client,
-) -> ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto | None:
-    """
+) -> Any | ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto | None:
+    """Retrieve a single instrument
+
+     Retrieves detailed reference data for a single trading instrument, identified by its symbol and
+    security type. Use this when you already know the symbol and type.
+
     Args:
         symbol (str):
         type_ (GetInstrumentType):
@@ -103,7 +119,7 @@ def sync(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto
+        Any | ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto
     """
 
     return sync_detailed(
@@ -118,8 +134,12 @@ async def asyncio_detailed(
     type_: GetInstrumentType,
     *,
     client: AuthenticatedClient | Client,
-) -> Response[ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto]:
-    """
+) -> Response[Any | ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto]:
+    """Retrieve a single instrument
+
+     Retrieves detailed reference data for a single trading instrument, identified by its symbol and
+    security type. Use this when you already know the symbol and type.
+
     Args:
         symbol (str):
         type_ (GetInstrumentType):
@@ -129,7 +149,7 @@ async def asyncio_detailed(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto]
+        Response[Any | ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto]
     """
 
     kwargs = _get_kwargs(
@@ -147,8 +167,12 @@ async def asyncio(
     type_: GetInstrumentType,
     *,
     client: AuthenticatedClient | Client,
-) -> ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto | None:
-    """
+) -> Any | ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto | None:
+    """Retrieve a single instrument
+
+     Retrieves detailed reference data for a single trading instrument, identified by its symbol and
+    security type. Use this when you already know the symbol and type.
+
     Args:
         symbol (str):
         type_ (GetInstrumentType):
@@ -158,7 +182,7 @@ async def asyncio(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto
+        Any | ComHellopublicUserapigatewayApiRestOrderApiInstrumentDto
     """
 
     return (