Update CHANGELOG for version 0.1.2; fix Account model validation, correct CustomTagMapping documentation, and enhance model generation script to patch OpenAPI spec issues.

Author: bharara

CHANGELOG.md

@@ -7,6 +7,21 @@ All notable changes to this project are documented here. Format follows
 
 ## [Unreleased]
 
+## [0.1.2] - 2026-07-23
+
+### Fixed
+
+- `Account.model_validate()` no longer raises on `client.accounts.list(include_tags=True)`.
+  The generated `Account` model was missing the `tags` field the API embeds per account
+  when `include_tags=true` is set, so every call crashed against real data
+  (`extra="forbid"` rejected the extra `tags` array).
+- Corrected the reversed `resource_type` mapping in the generated `CustomTagMapping` /
+  `ResourceType` docs. It previously read "1 for campaigns or 2 for accounts", the
+  opposite of what the API and `custom_tags.py` actually use (`1` = Account, `2` =
+  Campaign) -- purely a doc/docstring fix, the underlying values were never wrong.
+- `scripts/generate_models.py` now patches both gaps in the upstream OpenAPI spec
+  before codegen runs, so future regenerations don't silently reintroduce them.
+
 ## [0.1.0] - 2026-07-22
 
 ### Added

scripts/generate_models.py

@@ -14,6 +14,7 @@
 from __future__ import annotations
 
 import ast
+import json
 import subprocess
 import sys
 import urllib.request
@@ -45,12 +46,63 @@
 
 
 def fetch_spec(source: str) -> Path:
+    dest = MODELS_DIR / ".openapi-spec.json"
     if source.startswith("http://") or source.startswith("https://"):
-        dest = MODELS_DIR / ".openapi-spec.json"
         with urllib.request.urlopen(source) as response:
             dest.write_bytes(response.read())
-        return dest
-    return Path(source)
+    else:
+        dest.write_bytes(Path(source).read_bytes())
+    return dest
+
+
+def patch_spec(spec_path: Path) -> None:
+    """Correct known gaps/bugs in the upstream spec before codegen sees it.
+
+    Both patches below are tracked as issues against Instantly's published
+    OpenAPI document; they live here (rather than as post-codegen edits to
+    ``_generated.py``) so they survive the next regeneration.
+    """
+    spec = json.loads(spec_path.read_text())
+    schemas = spec["components"]["schemas"]
+
+    # `GET /accounts?include_tags=true` embeds a `tags` array per account, but
+    # the spec only declares that on an anonymous inline extension of the
+    # `Account` schema used by that one response, not on `Account` itself.
+    # datamodel-code-generator drops the inline extension, so the generated
+    # `Account` model (which has `extra="forbid"`) has no `tags` field and
+    # raises a `ValidationError` on every `include_tags=True` call. Move the
+    # property onto `Account` directly, matching what the API actually sends.
+    schemas["Account"]["properties"]["tags"] = {
+        "type": ["array", "null"],
+        "description": "Tags associated with the account, set to `include_tags` to populate",
+        "items": {
+            "type": "object",
+            "properties": {
+                "id": {
+                    "type": "string",
+                    "description": "Unique identifier for the custom tag",
+                },
+                "label": {
+                    "type": "string",
+                    "description": "Display label for the custom tag",
+                },
+                "description": {
+                    "type": ["string", "null"],
+                    "description": "Detailed description of the custom tag purpose",
+                },
+            },
+        },
+    }
+
+    # `CustomTagMapping.resource_type`'s free-text description has the
+    # account/campaign mapping backwards relative to its own
+    # `x-enumDescriptions` (1: Account, 2: Campaign) and relative to the
+    # `toggle-resource` endpoint, which agrees with `x-enumDescriptions`.
+    schemas["CustomTagMapping"]["properties"]["resource_type"]["description"] = (
+        "Resource type of custom tag, can be 1 for accounts or 2 for campaigns"
+    )
+
+    spec_path.write_text(json.dumps(spec))
 
 
 def run_codegen(spec_path: Path) -> None:
@@ -99,6 +151,7 @@ def write_init(names: list[str]) -> None:
 def main() -> None:
     source = sys.argv[1] if len(sys.argv) > 1 else DEFAULT_SPEC_URL
     spec_path = fetch_spec(source)
+    patch_spec(spec_path)
     run_codegen(spec_path)
     names = top_level_names(GENERATED_FILE.read_text())
     write_init(names)

src/instantlyai/_version.py

@@ -4,4 +4,4 @@
 build backend (``pyproject.toml`` -> ``[tool.hatch.version]``).
 """
 
-__version__ = "0.1.1"
+__version__ = "0.1.2"

src/instantlyai/models/__init__.py

@@ -118,6 +118,7 @@
     Step1,
     SubsequenceSchedule,
     SuperSearchEnrichment,
+    TagsItem,
     TemplateType,
     Then,
     Timezone,
@@ -262,6 +263,7 @@
     "Step1",
     "SubsequenceSchedule",
     "SuperSearchEnrichment",
+    "TagsItem",
     "TemplateType",
     "Then",
     "Timezone",

src/instantlyai/models/_generated.py

@@ -135,6 +135,27 @@ class ProviderCode(Enum):
     number_8 = 8
 
 
+class TagsItem(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    id: str | None = Field(
+        None,
+        description="Unique identifier for the custom tag",
+        examples=["019f8c44-f5cf-74e9-b3e4-2b4151efd79b"],
+    )
+    label: str | None = Field(
+        None,
+        description="Display label for the custom tag",
+        examples=["Important tag"],
+    )
+    description: str | None = Field(
+        None,
+        description="Detailed description of the custom tag purpose",
+        examples=[None],
+    )
+
+
 class Account(BaseModel):
     """
     An email account that can be used to send campaigns
@@ -257,6 +278,10 @@ class Account(BaseModel):
         description="Whether automatic reconnection attempts have failed. null = in progress, true = failed, false = succeeded.",
         examples=[False],
     )
+    tags: list[TagsItem] | None = Field(
+        None,
+        description="Tags associated with the account, set to `include_tags` to populate",
+    )
 
 
 class Status1(Enum):
@@ -2453,7 +2478,7 @@ class CustomTag(BaseModel):
 
 class ResourceType(Enum):
     """
-    Resource type of custom tag, can be 1 for campaigns or 2 for accounts
+    Resource type of custom tag, can be 1 for accounts or 2 for campaigns
     """
 
     number_1 = 1
@@ -2485,7 +2510,7 @@ class CustomTagMapping(BaseModel):
     )
     resource_type: ResourceType = Field(
         ...,
-        description="Resource type of custom tag, can be 1 for campaigns or 2 for accounts",
+        description="Resource type of custom tag, can be 1 for accounts or 2 for campaigns",
         examples=[1],
     )
     timestamp_created: AwareDatetime = Field(