update package version and response return tyupe for delete domain api

[KMKoushik]

Summary by cubic

Standardized the Delete Domain API to return a minimal status payload and updated SDKs and docs to match. This makes the response consistent and easier to handle across clients.

• Refactors

  • 200 response now returns { id, success, message }.
  • Updated OpenAPI spec and TypeScript types to reflect the new shape.
  • Public API handler returns the new payload.
  • Added the delete-domain page to the API Reference.

• Dependencies

  • usesend-js bumped to 1.5.5.
  • Python SDK bumped to 0.2.6; delete() now returns DomainDeleteResponse.

Summary by CodeRabbit

• Refactor
  • Simplified domain API responses: DELETE now returns success/message; path id can be nullable; error bodies streamlined to a single error string.
• Documentation
  • Updated API reference to reflect new domain response shapes; added delete-domain page; formatting improvements across docs.
• Chores
  • Updated SDKs to align with new responses, including type updates for delete-domain and version bumps.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
unsend-marketing	Ready	Preview	Comment	Oct 10, 2025 7:37pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This PR updates domain API schemas and SDK types. In OpenAPI, domain responses are simplified, DELETE /v1/domains/{id} path id becomes nullable and not required, and error bodies are reduced to an "error" string. Web route for delete-domain now returns { id, success, message } and defines 403/404 payloads. Docs navigation adds the delete-domain page and formatting changes. Python SDK: version bump, new DomainDeleteResponse type, and Domains.delete return type updated. JS SDK: version bump and schema.d.ts changes reflecting the new response shapes, including replacing dnsRecords in GET /v1/domains with success/message.

Possibly related PRs

• feat: expose domain dns records via api #259: Modifies domain API surface and schemas, overlapping with this PR’s OpenAPI and response shape changes.
• delete-domain route added #267: Introduces/adjusts DELETE /v1/domains/{id}; directly related to this PR’s delete-domain route and response updates.

Suggested labels

codex

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch km/2025-10-11-delete-domain-cleanup

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3f6a02a and d2efb3f.

📒 Files selected for processing (8)

• apps/docs/api-reference/openapi.json (2 hunks)
• apps/docs/docs.json (4 hunks)
• apps/web/src/server/public-api/api/domains/delete-domain.ts (1 hunks)
• packages/python-sdk/pyproject.toml (1 hunks)
• packages/python-sdk/usesend/domains.py (2 hunks)
• packages/python-sdk/usesend/types.py (1 hunks)
• packages/sdk/package.json (1 hunks)
• packages/sdk/types/schema.d.ts (2 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[cubic-dev-ai]

1 issue found across 8 files

Prompt for AI agents (all 1 issues)

Understand the root cause of the following 1 issues and fix them.


<file name="apps/docs/api-reference/openapi.json">

<violation number="1" location="apps/docs/api-reference/openapi.json:632">
Path parameters that appear in the URL template must remain required—setting `id` to optional makes the specification invalid for `/v1/domains/{id}`. Please keep the path parameter required so generated clients and validators work correctly.</violation>
</file>

_{React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai to give feedback, ask questions, or re-run the review.}

[cubic-dev-ai]

Path parameters that appear in the URL template must remain required—setting id to optional makes the specification invalid for /v1/domains/{id}. Please keep the path parameter required so generated clients and validators work correctly.

Prompt for AI agents

Address the following comment on apps/docs/api-reference/openapi.json at line 632:

<comment>Path parameters that appear in the URL template must remain required—setting `id` to optional makes the specification invalid for `/v1/domains/{id}`. Please keep the path parameter required so generated clients and validators work correctly.</comment>

<file context>
@@ -626,10 +626,10 @@
               &quot;example&quot;: 1
             },
-            &quot;required&quot;: true,
+            &quot;required&quot;: false,
             &quot;name&quot;: &quot;id&quot;,
             &quot;in&quot;: &quot;path&quot;
</file context>

Suggested change

	"required": false,
	"required": true,