docs(inboxes): inactive inbox status and the inbox_inactive error - #230
Open
josephfeleke wants to merge 2 commits into
Open
josephfeleke wants to merge 2 commits into
josephfeleke wants to merge 2 commits into
Conversation
…ive error InboxStatus (active | inactive) on the Inbox type and on the create and update requests, with the sparse-response rule stated: status is only present when the inbox is inactive. errors.mdx gains inbox_inactive under Sending (403), next to message_rejected, pointing at the PATCH that lifts it.
📋 View the side-by-side API change reviewThe link expires in 7 days. 🔒 Your API specs are encrypted in CI before they're uploaded. The decryption key stays in this link's URL fragment (after the #), which browsers never send to a server, so oasdiff cannot read your specs. How it works → Posted automatically by the oasdiff GitHub Action. To turn this off (no spec upload, no comment), set |
✨ API Changes# API Changelog n/a vs. n/a
## API Changes
### GET /v0/inboxes
- added the optional property `inboxes/items/status` to the response with the `200` status
### POST /v0/inboxes
- added the new optional request property `status`
- added the optional property `status` to the response with the `200` status
### GET /v0/inboxes/search
- added the optional property `inboxes/items/status` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}
- added the optional property `status` to the response with the `200` status
### PATCH /v0/inboxes/{inbox_id}
- added the new optional request property `status`
- added the optional property `status` to the response with the `200` status
### GET /v0/pods/{pod_id}/inboxes
- added the optional property `inboxes/items/status` to the response with the `200` status
### POST /v0/pods/{pod_id}/inboxes
- added the new optional request property `status`
- added the optional property `status` to the response with the `200` status
### GET /v0/pods/{pod_id}/inboxes/search
- added the optional property `inboxes/items/status` to the response with the `200` status
### GET /v0/pods/{pod_id}/inboxes/{inbox_id}
- added the optional property `status` to the response with the `200` status
### PATCH /v0/pods/{pod_id}/inboxes/{inbox_id}
- added the new optional request property `status`
- added the optional property `status` to the response with the `200` status💡 Download |
…point that raises it Adds the InboxInactiveError Fern error (403, inbox_inactive) so the regenerated reference and SDKs surface it like the sibling MessageRejectedError, and lists it on send, reply, reply-all, forward, and draft create, update, and send. Corrects the UpdateInboxRequest.status text: inbound mail to an inactive inbox is dropped, it never raises the error. Gives inbox_inactive its own section on the errors page, since it covers drafts as well as sending.
Contributor
Author
|
Review pass (against the merged API implementation, agentmail-api #1126). Three findings, all fixed in the latest commit:
|
✨ API Changes# API Changelog n/a vs. n/a
## API Changes
### GET /v0/inboxes
- added the optional property `inboxes/items/status` to the response with the `200` status
### POST /v0/inboxes
- added the new optional request property `status`
- added the optional property `status` to the response with the `200` status
### GET /v0/inboxes/search
- added the optional property `inboxes/items/status` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}
- added the optional property `status` to the response with the `200` status
### PATCH /v0/inboxes/{inbox_id}
- added the new optional request property `status`
- added the optional property `status` to the response with the `200` status
### POST /v0/inboxes/{inbox_id}/drafts
- added the non-success response with the status `403`
### PATCH /v0/inboxes/{inbox_id}/drafts/{draft_id}
- added the non-success response with the status `403`
### GET /v0/pods/{pod_id}/inboxes
- added the optional property `inboxes/items/status` to the response with the `200` status
### POST /v0/pods/{pod_id}/inboxes
- added the new optional request property `status`
- added the optional property `status` to the response with the `200` status
### GET /v0/pods/{pod_id}/inboxes/search
- added the optional property `inboxes/items/status` to the response with the `200` status
### GET /v0/pods/{pod_id}/inboxes/{inbox_id}
- added the optional property `status` to the response with the `200` status
### PATCH /v0/pods/{pod_id}/inboxes/{inbox_id}
- added the new optional request property `status`
- added the optional property `status` to the response with the `200` status💡 Download |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Documents the inbox on/off switch shipped in agentmail-api #1126 (merged; spec #1125).
InboxStatusenum (active|inactive). It appears on theInboxtype (documented as only present when the inbox is inactive — an active inbox has nostatusfield) and onCreateInboxRequestandUpdateInboxRequest. The update-request "at least one of" wording now listsstatus.inbox_inactiveentry under Sending (403), next tomessage_rejected, saying what is blocked (sending, drafts, inbound) and thePATCHthat lifts it.Merge after the API PR deploys, since the SDKs regenerate from this definition.