diff --git a/developer-tools/mailbox-api/calendars.mdx b/developer-tools/mailbox-api/calendars.mdx deleted file mode 100644 index 723e165..0000000 --- a/developer-tools/mailbox-api/calendars.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: "Manage mailbox calendars and events" -description: "Create private calendars, save non-sending events, apply conditional changes, and synchronise event state." -keywords: ["mailbox calendars", "calendar events", "calendar sync", "event ETag", "Calendar API"] ---- - -Use the Mailbox API to keep private calendars and non-sending events for an authorised mailbox. Calendar events do not include participants, recurrence, alerts, invitations, or scheduling messages. - - - Authorise every request with a Mailbox credential. Use `calendar.read` for - reads. Use `calendar.write` for creates, updates, and deletes. - - If your connected-app token has several granted mailboxes, list them with - `GET /mailbox/mailboxes`. Pass the selected mailbox's returned `id` as - `mailbox_id` on every request below. Omit `mailbox_id` for manual mailbox - credentials and assigned agent tokens. - - - - - List calendars before creating another one. Keep the returned cursor unchanged when you request the next page. - - ```bash - curl "https://app.qubrics.com/api/v1/mailbox/calendars?limit=50" \ - -H "Authorization: Bearer $QUBRICS_API_KEY" - ``` - - Create a private calendar with a local time zone. Retain one `Idempotency-Key` for the logical create and reuse it after a lost response. Do not send the same body with a new key while the outcome is uncertain. - - ```bash - curl -X POST "https://app.qubrics.com/api/v1/mailbox/calendars" \ - -H "Authorization: Bearer $QUBRICS_API_KEY" \ - -H "Content-Type: application/json" \ - -H "Idempotency-Key: calendar-appointments-v1" \ - -d '{"name":"Appointments","time_zone":"Australia/Melbourne"}' - ``` - - - - Save a caller-held `uid` before dispatch. Send a local `start` without an offset, its `time_zone`, and an ISO 8601 `duration`. - - ```bash - curl -X POST "https://app.qubrics.com/api/v1/mailbox/calendar-events" \ - -H "Authorization: Bearer $QUBRICS_API_KEY" \ - -H "Content-Type: application/json" \ - -H "Idempotency-Key: appointment-2026-11-20-v1" \ - -d '{ - "calendar_id": "calendar_123", - "uid": "appointment-2026-11-20@example.com", - "title": "Appointment", - "start": "2026-11-20T10:00:00", - "time_zone": "Australia/Melbourne", - "duration": "PT1H" - }' - ``` - - If the response is uncertain, look up the exact UID with `GET /mailbox/calendar-events?uid=...`. UID search is eventually consistent, so an empty immediate result does not authorise another create. Keep reconciling the original UID and idempotency key. - - - - Read the event immediately before an update or delete and retain its `ETag`. Send that exact value in `If-Match`. If the mutation returns `409 conflict`, read the event again and review the current version before another mutation. - - ```bash - curl -X PATCH "https://app.qubrics.com/api/v1/mailbox/calendar-events/event_123" \ - -H "Authorization: Bearer $QUBRICS_API_KEY" \ - -H "Content-Type: application/json" \ - -H 'If-Match: "event-etag"' \ - -d '{"title":"Updated appointment"}' - ``` - - Include `If-Match` when you delete an event. Deleting an event does not send a cancellation email. Confirm the event before you delete it. To delete a calendar, first remove its events, then read the calendar and send its exact `ETag` in `If-Match`. A non-empty calendar returns `409 conflict`. - - - - Call `GET /mailbox/calendar-events/changes` without `since_state` to establish a baseline. Then list the current events and call changes again with the baseline state to include edits that happened during the list. - - For each changes response, read every created or updated ID, remove every destroyed ID, then store its `new_state`. Continue while `has_more` is true, always passing the last applied `new_state`. Changes are coalesced, not a complete activity history. When `sync_required` is true or a saved state has expired, establish a new baseline and repeat the full list workflow. - - - -## Client operation names - -| Task | MCP tool | CLI command | TypeScript SDK | -| --- | --- | --- | --- | -| List calendars | `mailbox_list_calendars` | `mailbox:list-calendars` | `mailboxListCalendars` | -| Create calendar | `mailbox_create_calendar` | `mailbox:create-calendar` | `mailboxCreateCalendar` | -| Read calendar | `mailbox_get_calendar` | `mailbox:get-calendar` | `mailboxGetCalendar` | -| Delete calendar | `mailbox_delete_calendar` | `mailbox:delete-calendar` | `mailboxDeleteCalendar` | -| List events | `mailbox_list_calendar_events` | `mailbox:list-calendar-events` | `mailboxListCalendarEvents` | -| Create event | `mailbox_create_calendar_event` | `mailbox:create-calendar-event` | `mailboxCreateCalendarEvent` | -| Read event | `mailbox_get_calendar_event` | `mailbox:get-calendar-event` | `mailboxGetCalendarEvent` | -| Update event | `mailbox_update_calendar_event` | `mailbox:update-calendar-event` | `mailboxUpdateCalendarEvent` | -| Delete event | `mailbox_delete_calendar_event` | `mailbox:delete-calendar-event` | `mailboxDeleteCalendarEvent` | -| Read event changes | `mailbox_get_calendar_event_changes` | `mailbox:get-calendar-event-changes` | `mailboxGetCalendarEventChanges` | - -## Next steps - - - - - diff --git a/developer-tools/mailbox-api/operations-and-usage.mdx b/developer-tools/mailbox-api/operations-and-usage.mdx index 45ee98e..0f2c843 100644 --- a/developer-tools/mailbox-api/operations-and-usage.mdx +++ b/developer-tools/mailbox-api/operations-and-usage.mdx @@ -153,6 +153,5 @@ Poll `GET /mailbox/quotas/changes?since_state=...` to sync quota changes. ## Next steps - diff --git a/docs.json b/docs.json index 5aea3be..1fac563 100644 --- a/docs.json +++ b/docs.json @@ -61,7 +61,6 @@ "pages": [ "developer-tools/mailbox-api/targeting-and-capabilities", "developer-tools/mailbox-api/operations-and-usage", - "developer-tools/mailbox-api/calendars", "developer-tools/mailbox-api/threads", "developer-tools/mailbox-api/saved-drafts", "developer-tools/mailbox-api/search-and-batch", @@ -413,21 +412,6 @@ "DELETE /mailbox/folders/{folder_id}" ] }, - { - "group": "Calendars", - "pages": [ - "GET /mailbox/calendars", - "POST /mailbox/calendars", - "GET /mailbox/calendars/{calendar_id}", - "DELETE /mailbox/calendars/{calendar_id}", - "GET /mailbox/calendar-events", - "POST /mailbox/calendar-events", - "GET /mailbox/calendar-events/{event_id}", - "PATCH /mailbox/calendar-events/{event_id}", - "DELETE /mailbox/calendar-events/{event_id}", - "GET /mailbox/calendar-events/changes" - ] - }, { "group": "Submissions", "pages": [ diff --git a/evidence/sdk344-calendar-docs-20261120.md b/evidence/sdk344-calendar-docs-20261120.md new file mode 100644 index 0000000..ddcb194 --- /dev/null +++ b/evidence/sdk344-calendar-docs-20261120.md @@ -0,0 +1,39 @@ +# Calendar teaching removal + +Standing operator rule 12, 20 November 2026, authorises source removal through normal PRs after preserving calendar on one named branch per repository. Published versions remain unchanged. This is source preparation only; no merge, deployment, registry, tag or release action is performed here. + +## Preservation + +Before any source edit, GitHub `refs/heads/archive/calendar` was absent. A non-force create preserved current docs main `4ffdf27ff251860132b939e26970e5c5c9c70cd4`. Independent GET readback returned that exact branch and SHA. This includes the preceding favicon PR90. Normal revert is the source rollback; the archive branch remains intact. + +## Scope + +- Remove the active mailbox-calendar guide, its next-step card and calendar guide/endpoint navigation. +- Retain top-level tabs and all neighbouring mail guides and endpoint groups. +- Keep historical changelog and compatibility statements, generic date arithmetic and negative coverage. +- Keep `openapi-app.json` and generated Postman truthful to their still-live producer. Repository `AGENTS.md` says producer repositories own these snapshots and collections must be generated, never hand-edited. The live-endpoint hold until infra-migration step 1f remains a separate source-removal gate. + +Canonical approach: Mintlify navigation lists the pages and endpoint groups to publish ([navigation reference](https://www.mintlify.com/docs/organize/navigation)); remove the held feature's active teaching and navigation together. No replacement prose or announcement is added. + +Placement: Guides → Developer tools → Mailbox API guides, and Mailbox API → Calendars. Disposition: remove the held feature's entries. Reader task: find mail integration guidance. Existing groups and sequence remain unchanged. + +Polish pass: skipped — deletion-only change, with no new or rewritten reader-facing prose. Preservation reductions are intentional under the operator's source-removal ruling; unchanged material remains byte-for-byte. + +## Qualification + +The final deletion-only working tree passed: + +- `npm run confidentiality:check` and `npm run external-links:check`: exit 0. +- `mint broken-links`: exit 0, no broken links. +- `mint validate`: exit 0, build and validation passed. +- `git diff --check`: exit 0. +- JSON/navigation and guide-absence assertion: PASS; all four top-level tabs retained. +- `git diff --exit-code origin/main -- openapi-app.json openapi-sending.json postman/`: exit 0, producer snapshots and generated collections unchanged. + +Local `mint dev --no-open` preview verified expanded guide navigation, remaining Threads next-step card and previous/next mail pagination, with no calendar link. Screenshot: `operations-next-steps.png` in the raw evidence folder. The unchanged Threads icon requests `messages-square.svg` from the icon vendor CDN and receives HTTP 403; card text/link and navigation render correctly. No unrelated icon or tooling change is included. + +Owned preview tab closed and `isClosed()` returned true; owned preview process exited 0 after Ctrl-C. No dependency install or task-local build cache was created. PR CI and review remain pending; no claim of merge or deployment. + +Ops relayed the `docs75/favicon` lease release at 10:38 AEDT; the old claim was absent before navigation editing. A normal rebase to current main `0f03b209d77cfc8c4210ed3c744970e524855312` preserved its unrelated artwork changelog addition. `archive/calendar` remains at its original preservation SHA and was not overwritten. + +Raw run evidence: `/Users/rj/Desktop/GIT-REPOS/sendmux-docs/.claude/artifacts/rebrand-qubrics-sdk344-calendar-docs/`.