{ "openapi": "3.1.0", "info": { "title": "FastAPI", "version": "0.1.0" }, "paths": { "/auth/config": { "get": { "tags": [ "auth" ], "summary": "Auth Config", "description": "Public auth-flow flags the SPA reads at boot.\n\nAnonymous-readable so the login + register views can adjust their\nchrome (hiding the sign-up link when registration is closed) without\na round-trip to a protected endpoint.", "operationId": "auth_config_auth_config_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Auth Config Auth Config Get" } } } } } } }, "/auth/login": { "post": { "tags": [ "auth" ], "summary": "Login", "description": "Verify credentials, set the session cookie, return the user.\n\nGeneric 401 on any failure — never leak whether the username exists.\n\nWhen the account has 2FA enabled, the password check is only step one:\ninstead of a session we return ``{\"mfa_required\": true, \"mfa_token\": …}``\nand set a short-lived challenge cookie. No session is issued and\n``last_login`` is not stamped until the code step succeeds. Accounts\n*without* 2FA get exactly the response shape they always have, so\nexisting clients (incl. the Swift app) are unaffected unless a user\nopts in.", "operationId": "login_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginPayload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Login Auth Login Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/login/2fa": { "post": { "tags": [ "auth" ], "summary": "Login 2Fa", "description": "Complete login: verify a TOTP code (or a recovery code), open session.\n\nThe challenge is read from (in order) the request body, the\n``kancil_mfa`` cookie, or an ``Authorization: Bearer`` header — so both\nthe SPA and native clients work. A 6-digit input is checked as TOTP; any\nother input is tried as a single-use recovery code. Consecutive bad\ncodes are rate-limited per :data:`TOTP_MAX_ATTEMPTS`.", "operationId": "login_2fa_auth_login_2fa_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_mfa", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Mfa" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Login2faPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Login 2Fa Auth Login 2Fa Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/register": { "post": { "tags": [ "auth" ], "summary": "Register", "description": "Self-serve signup. Creates a ``viewer`` and auto-logs in.\n\nAdmins are still admin-created via ``POST /auth/users/`` —\nself-registration intentionally has no role field on the wire.\nGated by ``KANCIL_REGISTRATION_ENABLED``; when False, returns 403\n(so the SPA can render a friendly \"signups are closed\" message\nrather than a confusing 404).", "operationId": "register_auth_register_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterPayload" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Register Auth Register Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/logout": { "post": { "tags": [ "auth" ], "summary": "Logout", "operationId": "logout_auth_logout_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Logout Auth Logout Post" } } } } } } }, "/auth/me": { "get": { "tags": [ "auth" ], "summary": "Me", "operationId": "me_auth_me_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Me Auth Me Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "auth" ], "summary": "Update Me", "description": "Patch the current user's preferences (shallow-merged).", "operationId": "update_me_auth_me_patch", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreferencesPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Me Auth Me Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/users/lookup": { "get": { "tags": [ "auth" ], "summary": "Lookup Users", "description": "Public user search for any authenticated caller.\n\nUsed by the MembersEditor autocomplete. Returns only username +\nrole so the caller can render a chip; preferences and last_login\nstay restricted to the admin /users/ endpoint.\n\nEmpty ``q`` returns the most recent users — convenient default for\n\"open the picker and see what's there\".", "operationId": "lookup_users_auth_users_lookup_get", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Q" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Lookup Users Auth Users Lookup Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/me/self-contact": { "put": { "tags": [ "auth" ], "summary": "Set Self Contact", "description": "Designate which contact card represents the logged-in user.\n\nStored in ``preferences.self_contact`` so it round-trips through\n``/auth/me``. Validates the contact is actually one of the user's own\nand caches its display name for the \"Add myself\" affordance.", "operationId": "set_self_contact_auth_me_self_contact_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfContactPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Self Contact Auth Me Self Contact Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "auth" ], "summary": "Clear Self Contact", "description": "Forget the user's designated contact card.", "operationId": "clear_self_contact_auth_me_self_contact_delete", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Clear Self Contact Auth Me Self Contact Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/me/password": { "post": { "tags": [ "auth" ], "summary": "Change Password", "operationId": "change_password_auth_me_password_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChangePayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Change Password Auth Me Password Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/2fa/enroll": { "post": { "tags": [ "auth" ], "summary": "Enroll 2Fa", "description": "Begin enrollment: mint a fresh secret, return its QR + otpauth URI.\n\nThe secret is stored *pending* (encrypted) and is not active until\n:func:`enable_2fa` verifies a code from it. Calling this again before\nenabling simply rolls a new pending secret; any live 2FA stays intact.", "operationId": "enroll_2fa_auth_2fa_enroll_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Enroll 2Fa Auth 2Fa Enroll Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/2fa/enable": { "post": { "tags": [ "auth" ], "summary": "Enable 2Fa", "description": "Finish enrollment: verify a code, activate 2FA, return recovery codes.\n\nThe recovery codes are shown here exactly once — only their hashes are\nstored. If the user loses them, they regenerate (invalidating the old\nset), they don't get to re-read these.", "operationId": "enable_2fa_auth_2fa_enable_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotpEnablePayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Enable 2Fa Auth 2Fa Enable Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/2fa/disable": { "post": { "tags": [ "auth" ], "summary": "Disable 2Fa", "description": "Turn off 2FA. Requires the account password (not just a session).", "operationId": "disable_2fa_auth_2fa_disable_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotpPasswordPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Disable 2Fa Auth 2Fa Disable Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/2fa/recovery-codes": { "post": { "tags": [ "auth" ], "summary": "Regenerate Recovery Codes", "description": "Issue a fresh recovery-code set, invalidating the old one.\n\nRequires the password and an already-enabled 2FA. Returns the new\nplaintext codes once.", "operationId": "regenerate_recovery_codes_auth_2fa_recovery_codes_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotpPasswordPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Regenerate Recovery Codes Auth 2Fa Recovery Codes Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/users/": { "get": { "tags": [ "auth" ], "summary": "List Users", "operationId": "list_users_auth_users__get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response List Users Auth Users Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "auth" ], "summary": "Create User", "operationId": "create_user_auth_users__post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserPayload" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create User Auth Users Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/users/{username}": { "patch": { "tags": [ "auth" ], "summary": "Update User", "operationId": "update_user_auth_users__username__patch", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update User Auth Users Username Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "auth" ], "summary": "Delete User", "operationId": "delete_user_auth_users__username__delete", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete User Auth Users Username Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/users/{username}/password": { "post": { "tags": [ "auth" ], "summary": "Admin Reset Password", "operationId": "admin_reset_password_auth_users__username__password_post", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminPasswordResetPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Reset Password Auth Users Username Password Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/db-stats": { "get": { "tags": [ "admin" ], "summary": "Admin Db Stats", "description": "Return the admin dashboard payload.\n\n``stale_days`` controls the threshold for the stale-users list\n(default 14). Recomputed on every request — no caching.", "operationId": "admin_db_stats_admin_db_stats_get", "parameters": [ { "name": "stale_days", "in": "query", "required": false, "schema": { "type": "integer", "default": 14, "title": "Stale Days" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Db Stats Admin Db Stats Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/reminders/run": { "post": { "tags": [ "admin" ], "summary": "Admin Run Reminders", "description": "Run the due-date reminder scan once, now (all users).\n\nThe daily cron only runs on the scheduler-owning instance (production);\nthis button makes the feature testable on develop and lets an admin\nforce a pass after changing data. Idempotent — the per-item dedupe\nmarkers mean a manual run never double-notifies.", "operationId": "admin_run_reminders_admin_reminders_run_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Run Reminders Admin Reminders Run Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/task-history": { "get": { "tags": [ "admin" ], "summary": "Admin Task History", "description": "List recent task runs, newest-first, with optional filters.\n\nAlways returns ``names`` (every distinct task name seen) and\n``counts_by_status`` so the SPA can render its filter dropdown and\nstatus badges in one request.", "operationId": "admin_task_history_admin_task_history_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Task History Admin Task History Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/task-history/{task_id}": { "get": { "tags": [ "admin" ], "summary": "Admin Task History Detail", "operationId": "admin_task_history_detail_admin_task_history__task_id__get", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Task History Detail Admin Task History Task Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/carddav/test": { "post": { "tags": [ "carddav" ], "summary": "Test Connection", "description": "Validate credentials and return discovered addressbooks. Doesn't save.", "operationId": "test_connection_carddav_test_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDavCredentials" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Test Connection Carddav Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/carddav/accounts": { "get": { "tags": [ "carddav" ], "summary": "List Accounts", "description": "All of the user's CardDAV accounts, default first.", "operationId": "list_accounts_carddav_accounts_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Accounts Carddav Accounts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "carddav" ], "summary": "Create Account", "description": "Add a NEW CardDAV account. Validates credentials against the server.\n\nDoesn't pick addressbooks — that's a follow-up PUT to\n``/accounts/{id}/addressbooks``.", "operationId": "create_account_carddav_accounts_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDavAccountIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Account Carddav Accounts Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/carddav/accounts/{account_id}": { "put": { "tags": [ "carddav" ], "summary": "Update Account", "description": "Update one account's credentials (validated against the server).", "operationId": "update_account_carddav_accounts__account_id__put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDavAccountIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Account Carddav Accounts Account Id Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "carddav" ], "summary": "Delete Account", "description": "Remove one account. Cascades its addressbooks (+ contacts, decision (1)).", "operationId": "delete_account_carddav_accounts__account_id__delete", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "delete_contacts", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Delete Contacts" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Account Carddav Accounts Account Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/carddav/accounts/{account_id}/set-default": { "post": { "tags": [ "carddav" ], "summary": "Set Default Account", "description": "Make this account the default (the one legacy endpoints act on).", "operationId": "set_default_account_carddav_accounts__account_id__set_default_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Default Account Carddav Accounts Account Id Set Default Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/carddav/accounts/{account_id}/addressbooks/available": { "get": { "tags": [ "carddav" ], "summary": "List Available Addressbooks For Account", "description": "Re-discover one account's addressbooks from its server.", "operationId": "list_available_addressbooks_for_account_carddav_accounts__account_id__addressbooks_available_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Available Addressbooks For Account Carddav Accounts Account Id Addressbooks Available Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/carddav/accounts/{account_id}/addressbooks": { "get": { "tags": [ "carddav" ], "summary": "List Addressbooks For Account", "description": "The selected addressbooks belonging to one account.", "operationId": "list_addressbooks_for_account_carddav_accounts__account_id__addressbooks_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Addressbooks For Account Carddav Accounts Account Id Addressbooks Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "carddav" ], "summary": "Save Addressbooks For Account", "description": "Set one account's enabled addressbook set (removed books cascade).", "operationId": "save_addressbooks_for_account_carddav_accounts__account_id__addressbooks_put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressBookSelection" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Addressbooks For Account Carddav Accounts Account Id Addressbooks Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/carddav/connection": { "get": { "tags": [ "carddav" ], "summary": "Get Connection", "description": "LEGACY: the default account's connection state (sans password).", "operationId": "get_connection_carddav_connection_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Connection Carddav Connection Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "carddav" ], "summary": "Save Connection", "description": "LEGACY: save credentials — updates the default account, or creates\nthe first one. Validates them against the server first.\n\nDoesn't pick addressbooks — that's a follow-up PUT to /addressbooks.", "operationId": "save_connection_carddav_connection_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDavCredentials" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Connection Carddav Connection Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "carddav" ], "summary": "Delete Connection", "description": "LEGACY: disconnect the user — removes ALL accounts and books.\n\nBy default cascades contacts (decision (1)).", "operationId": "delete_connection_carddav_connection_delete", "parameters": [ { "name": "delete_contacts", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Delete Contacts" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Connection Carddav Connection Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/carddav/addressbooks/available": { "get": { "tags": [ "carddav" ], "summary": "List Available Addressbooks", "description": "LEGACY: re-discover from the DEFAULT account's server.\n\nUsed by the settings UI when the user wants to refresh the picker\nafter adding a book server-side.", "operationId": "list_available_addressbooks_carddav_addressbooks_available_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Available Addressbooks Carddav Addressbooks Available Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/carddav/addressbooks": { "get": { "tags": [ "carddav" ], "summary": "List Addressbooks", "description": "All selected addressbooks across every account.", "operationId": "list_addressbooks_carddav_addressbooks_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Addressbooks Carddav Addressbooks Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "carddav" ], "summary": "Save Addressbooks", "description": "LEGACY: set the DEFAULT account's enabled addressbook set.\n\nDecision (1): removed books cascade. Re-discovers from the server so\nwe know each book's display name and description without trusting\nclient input.", "operationId": "save_addressbooks_carddav_addressbooks_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressBookSelection" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Addressbooks Carddav Addressbooks Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/carddav/sync": { "post": { "tags": [ "carddav" ], "summary": "Sync Now", "description": "Trigger a sync. If ``addressbook_id`` is set, only that book.", "operationId": "sync_now_carddav_sync_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routers__carddav__SyncRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Sync Now Carddav Sync Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/contacts": { "get": { "tags": [ "contacts" ], "summary": "List Contacts", "description": "List the current user's contacts.\n\nOmit ``addressbook_id`` for cross-book results (decision (4)). The\nresponse always carries ``addressbook_id`` on each item so the SPA\ncan render per-row source badges.", "operationId": "list_contacts_contacts_get", "parameters": [ { "name": "addressbook_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressbook Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Contacts Contacts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "contacts" ], "summary": "Create Contact", "description": "Create a contact in one of the user's addressbooks.\n\nBuilds a vCard 4.0, PUTs it to the chosen addressbook, re-fetches the\nserver's canonical copy, and mirrors it locally. Returns the new contact\ndoc (same shape as ``GET /contacts/{ab}/{uid}``).", "operationId": "create_contact_contacts_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCreateIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Contact Contacts Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/contacts/{addressbook_id}/{uid}": { "get": { "tags": [ "contacts" ], "summary": "Get Contact", "description": "One contact, full payload (parsed + raw vCard).", "operationId": "get_contact_contacts__addressbook_id___uid__get", "parameters": [ { "name": "addressbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Addressbook Id" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "title": "Uid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Contact Contacts Addressbook Id Uid Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "contacts" ], "summary": "Update Contact", "description": "Update an existing contact (conditional on its etag).\n\nPreserves the contact's existing UID and resource href. Returns the\nrefreshed contact doc. 404 if the contact is gone locally; 409 if it\nchanged on the server since we last synced (re-open and retry).", "operationId": "update_contact_contacts__addressbook_id___uid__put", "parameters": [ { "name": "addressbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Addressbook Id" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "title": "Uid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactWriteIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Contact Contacts Addressbook Id Uid Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/contacts/{addressbook_id}/{uid}/sync": { "post": { "tags": [ "contacts" ], "summary": "Sync Contact", "description": "Re-fetch this contact from the CardDAV server.\n\nReturns ``{result, contact}`` — ``contact`` is the refreshed doc on\nsuccess, ``null`` if the server returned 404 and we deleted locally.\nOn a UID change, ``result.new_uid`` carries the new identity so the\nSPA can redirect to its detail page.", "operationId": "sync_contact_contacts__addressbook_id___uid__sync_post", "parameters": [ { "name": "addressbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Addressbook Id" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "title": "Uid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Sync Contact Contacts Addressbook Id Uid Sync Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/contacts/{addressbook_id}/{uid}/relocate": { "post": { "tags": [ "contacts" ], "summary": "Relocate Contact", "description": "Move or copy a contact to another addressbook.\n\nBoth PUT the stored ``raw_vcard`` verbatim to the target (so PHOTO / X-* /\nIMPP survive byte-for-byte), then re-GET and mirror locally. A *copy* mints\na fresh UID and leaves the source alone. A *move* keeps the UID, then\nDELETEs the source and rewrites every cross-entity reference to the new\n``addressbook_id::uid`` — but only after the copy is confirmed on the\nserver, so a failed delete leaves a recoverable duplicate rather than\nlosing the card.", "operationId": "relocate_contact_contacts__addressbook_id___uid__relocate_post", "parameters": [ { "name": "addressbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Addressbook Id" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "title": "Uid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelocateIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Relocate Contact Contacts Addressbook Id Uid Relocate Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/test": { "post": { "tags": [ "caldav" ], "summary": "Test Connection", "operationId": "test_connection_caldav_test_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalDavCredentials" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Test Connection Caldav Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/accounts": { "get": { "tags": [ "caldav" ], "summary": "List Accounts", "description": "All of the user's CalDAV accounts, default first.", "operationId": "list_accounts_caldav_accounts_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Accounts Caldav Accounts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "caldav" ], "summary": "Create Account", "description": "Add a NEW CalDAV account. Validates credentials against the server.\n\nDoesn't pick calendars — that's a follow-up PUT to\n``/accounts/{id}/calendars``.", "operationId": "create_account_caldav_accounts_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalDavAccountIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Account Caldav Accounts Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/accounts/{account_id}": { "put": { "tags": [ "caldav" ], "summary": "Update Account", "description": "Update one account's credentials (validated against the server).", "operationId": "update_account_caldav_accounts__account_id__put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalDavAccountIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Account Caldav Accounts Account Id Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "caldav" ], "summary": "Delete Account", "description": "Remove one account. Cascades its calendars (+ events, decision (1)).", "operationId": "delete_account_caldav_accounts__account_id__delete", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "delete_events", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Delete Events" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Account Caldav Accounts Account Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/accounts/{account_id}/set-default": { "post": { "tags": [ "caldav" ], "summary": "Set Default Account", "description": "Make this account the default (the one legacy endpoints act on).", "operationId": "set_default_account_caldav_accounts__account_id__set_default_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Default Account Caldav Accounts Account Id Set Default Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/accounts/{account_id}/window": { "patch": { "tags": [ "caldav" ], "summary": "Update Account Window", "description": "Per-account sliding-window override.", "operationId": "update_account_window_caldav_accounts__account_id__window_patch", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WindowUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Account Window Caldav Accounts Account Id Window Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/accounts/{account_id}/calendars/available": { "get": { "tags": [ "caldav" ], "summary": "List Available Calendars For Account", "description": "Re-discover one account's calendars from its server.", "operationId": "list_available_calendars_for_account_caldav_accounts__account_id__calendars_available_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Available Calendars For Account Caldav Accounts Account Id Calendars Available Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/accounts/{account_id}/calendars": { "get": { "tags": [ "caldav" ], "summary": "List Calendars For Account", "description": "The selected calendars belonging to one account.", "operationId": "list_calendars_for_account_caldav_accounts__account_id__calendars_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Calendars For Account Caldav Accounts Account Id Calendars Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "caldav" ], "summary": "Save Calendars For Account", "description": "Set one account's enabled calendar set (removed calendars cascade).", "operationId": "save_calendars_for_account_caldav_accounts__account_id__calendars_put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarSelection" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Calendars For Account Caldav Accounts Account Id Calendars Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/connection": { "get": { "tags": [ "caldav" ], "summary": "Get Connection", "description": "LEGACY: the default account's connection state (sans password).", "operationId": "get_connection_caldav_connection_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Connection Caldav Connection Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "caldav" ], "summary": "Save Connection", "description": "LEGACY: save credentials — updates the default account, or creates\nthe first one. Validates them against the server first.", "operationId": "save_connection_caldav_connection_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalDavCredentials" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Connection Caldav Connection Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "caldav" ], "summary": "Delete Connection", "description": "LEGACY: disconnect the user — removes ALL accounts and calendars.", "operationId": "delete_connection_caldav_connection_delete", "parameters": [ { "name": "delete_events", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Delete Events" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Connection Caldav Connection Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/connection/window": { "patch": { "tags": [ "caldav" ], "summary": "Update Window", "description": "LEGACY: sliding-window override on the DEFAULT account.", "operationId": "update_window_caldav_connection_window_patch", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WindowUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Window Caldav Connection Window Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/calendars/available": { "get": { "tags": [ "caldav" ], "summary": "List Available Calendars", "description": "LEGACY: re-discover from the DEFAULT account's server.", "operationId": "list_available_calendars_caldav_calendars_available_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Available Calendars Caldav Calendars Available Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/calendars": { "get": { "tags": [ "caldav" ], "summary": "List Calendars", "description": "All selected calendars across every account.", "operationId": "list_calendars_caldav_calendars_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Calendars Caldav Calendars Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "caldav" ], "summary": "Save Calendars", "description": "LEGACY: set the DEFAULT account's enabled calendar set.", "operationId": "save_calendars_caldav_calendars_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarSelection" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Calendars Caldav Calendars Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/sync": { "post": { "tags": [ "caldav" ], "summary": "Sync Now", "operationId": "sync_now_caldav_sync_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routers__caldav__SyncRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Sync Now Caldav Sync Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/events": { "get": { "tags": [ "events" ], "summary": "List Events", "description": "List the current user's events.\n\n``date_from`` / ``date_to`` are ISO 8601 strings. Cross-calendar by\ndefault (decision (4)); pass ``calendar_id`` to filter to one.\n``include_recurring`` also returns recurring masters that began before\n``date_to`` (the calendar week/month views expand them client-side).", "operationId": "list_events_events_get", "parameters": [ { "name": "calendar_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Calendar Id" } }, { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "event", "todo" ], "type": "string" }, { "type": "null" } ], "title": "Kind" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date From" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date To" } }, { "name": "include_recurring", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Recurring" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Events Events Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/events/{calendar_id}/{uid}": { "get": { "tags": [ "events" ], "summary": "Get Event", "description": "One event, full payload (parsed + raw iCal).", "operationId": "get_event_events__calendar_id___uid__get", "parameters": [ { "name": "calendar_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Calendar Id" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "title": "Uid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Event Events Calendar Id Uid Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/events/{calendar_id}/{uid}/sync": { "post": { "tags": [ "events" ], "summary": "Sync Event", "description": "Re-fetch this event from the CalDAV server.", "operationId": "sync_event_events__calendar_id___uid__sync_post", "parameters": [ { "name": "calendar_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Calendar Id" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "title": "Uid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Sync Event Events Calendar Id Uid Sync Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/projects": { "get": { "tags": [ "projects" ], "summary": "List Projects", "operationId": "list_projects_projects_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "active", "on_hold", "done", "archived" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "include_archived", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Archived" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Projects Projects Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "projects" ], "summary": "Create Project", "operationId": "create_project_projects_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Project Projects Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/projects/inbox": { "get": { "tags": [ "projects" ], "summary": "Get Inbox", "description": "Return (or create) the user's Inbox project.", "operationId": "get_inbox_projects_inbox_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Inbox Projects Inbox Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/projects/{project_id}": { "get": { "tags": [ "projects" ], "summary": "Get Project", "operationId": "get_project_projects__project_id__get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Project Projects Project Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "projects" ], "summary": "Update Project", "operationId": "update_project_projects__project_id__patch", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Project Projects Project Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "projects" ], "summary": "Delete Project", "description": "Hard delete a project AND all its tasks/comments/links.\n\nRefuses to delete the Inbox. Archive (PATCH status=archived) is the\nsoft-keep option.", "operationId": "delete_project_projects__project_id__delete", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Project Projects Project Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/projects/{project_id}/children": { "get": { "tags": [ "projects" ], "summary": "List Children", "description": "Direct sub-projects visible to the caller (phase 6 hierarchy).", "operationId": "list_children_projects__project_id__children_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Children Projects Project Id Children Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/projects/{project_id}/descendants": { "get": { "tags": [ "projects" ], "summary": "List Descendants", "description": "Full visible sub-tree under a project (phase 6 hierarchy rollup).\n\nUnlike ``/children`` (one level), this walks the whole tree. Each item\nis a ``public_project`` so the caller gets every descendant's name +\neffective statuses in one round trip — used by the parent's Tasks tab\nto group sub-project tasks and resolve their status labels.", "operationId": "list_descendants_projects__project_id__descendants_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Descendants Projects Project Id Descendants Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/projects/{project_id}/members": { "get": { "tags": [ "projects" ], "summary": "List Members", "operationId": "list_members_projects__project_id__members_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Members Projects Project Id Members Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "projects" ], "summary": "Add Member", "operationId": "add_member_projects__project_id__members_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberAdd" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Member Projects Project Id Members Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/projects/{project_id}/members/{member_username}": { "patch": { "tags": [ "projects" ], "summary": "Change Member Role", "operationId": "change_member_role_projects__project_id__members__member_username__patch", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "member_username", "in": "path", "required": true, "schema": { "type": "string", "title": "Member Username" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberRoleChange" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Change Member Role Projects Project Id Members Member Username Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "projects" ], "summary": "Remove Member", "operationId": "remove_member_projects__project_id__members__member_username__delete", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "member_username", "in": "path", "required": true, "schema": { "type": "string", "title": "Member Username" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Member Projects Project Id Members Member Username Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tasks": { "get": { "tags": [ "tasks" ], "summary": "List Tasks", "description": "Cross-project list with filters.\n\nPass ``status`` and ``tag_id`` multiple times to combine values:\n``?status=backlog&status=in_progress``.\n\n``include_descendants`` (with ``project_id``) rolls up the project and\nits whole visible sub-tree — used by the parent project's Tasks tab.\nThe cap is 500 here (vs the usual 200) so a wide tree isn't silently\ntruncated; the SPA surfaces a hint when ``has_more`` is still true.", "operationId": "list_tasks_tasks_get", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "include_descendants", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Descendants" } }, { "name": "parent_task_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Task Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Status" } }, { "name": "tag_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Tag Id" } }, { "name": "due_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Due Before" } }, { "name": "due_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Due After" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "include_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Tasks Tasks Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tasks" ], "summary": "Create Task", "operationId": "create_task_tasks_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Task Tasks Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tasks/{task_id}": { "get": { "tags": [ "tasks" ], "summary": "Get Task", "operationId": "get_task_tasks__task_id__get", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Task Tasks Task Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "tasks" ], "summary": "Update Task", "operationId": "update_task_tasks__task_id__patch", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Task Tasks Task Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tasks" ], "summary": "Soft Delete Task", "description": "Soft delete (recoverable; decision 4). Cascades comments + links.", "operationId": "soft_delete_task_tasks__task_id__delete", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Soft Delete Task Tasks Task Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tasks/{task_id}/move": { "post": { "tags": [ "tasks" ], "summary": "Move Task", "description": "Move a task (and any descendants) to a different project.", "operationId": "move_task_tasks__task_id__move_post", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routers__tasks__MoveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Move Task Tasks Task Id Move Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tasks/{task_id}/complete": { "post": { "tags": [ "tasks" ], "summary": "Complete Task", "operationId": "complete_task_tasks__task_id__complete_post", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Complete Task Tasks Task Id Complete Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tasks/{task_id}/restore": { "post": { "tags": [ "tasks" ], "summary": "Restore Task", "operationId": "restore_task_tasks__task_id__restore_post", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Restore Task Tasks Task Id Restore Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tasks/reorder": { "post": { "tags": [ "tasks" ], "summary": "Reorder", "description": "Bulk-update ``(status, position)`` for many tasks.\n\nUsed by the kanban board on drag-drop and by list-view manual\nreordering. The client computes the full target ordering for each\naffected column and ships it; the server doesn't recompute.\n\nValidation: every distinct (task, target-status) pair is checked\nagainst the target task's project's effective status list. We fetch\neach task's project once and reuse.", "operationId": "reorder_tasks_reorder_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routers__tasks__ReorderRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Reorder Tasks Reorder Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tasks/bulk": { "post": { "tags": [ "tasks" ], "summary": "Bulk", "description": "Run one action against a list of task ids in one round-trip.\n\nSubtree semantics are NOT applied here — bulk move just moves the\nlisted ids. For \"move this task and its descendants together\", use\nthe per-task ``/tasks/{id}/move`` endpoint.", "operationId": "bulk_tasks_bulk_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Bulk Tasks Bulk Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tags": { "get": { "tags": [ "tags" ], "summary": "List Tags", "operationId": "list_tags_tags_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Tags Tags Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tags" ], "summary": "Create Tag", "operationId": "create_tag_tags_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Tag Tags Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tags/{tag_id}": { "patch": { "tags": [ "tags" ], "summary": "Update Tag", "operationId": "update_tag_tags__tag_id__patch", "parameters": [ { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tag Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Tag Tags Tag Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tags" ], "summary": "Delete Tag", "operationId": "delete_tag_tags__tag_id__delete", "parameters": [ { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tag Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Tag Tags Tag Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/links": { "get": { "tags": [ "links" ], "summary": "List Links", "description": "List links matching the filters.\n\nThree modes:\n - ``from_type`` + ``from_id`` → outgoing edges\n - ``to_type`` + ``to_id`` → incoming edges\n - ``entity_type`` + ``entity_id`` → both directions in one shot\n (what a detail-page \"Related\" panel wants)", "operationId": "list_links_links_get", "parameters": [ { "name": "from_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "task", "project", "contact", "person", "event", "company", "deal", "activity", "bank_transaction" ], "type": "string" }, { "type": "null" } ], "title": "From Type" } }, { "name": "from_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Id" } }, { "name": "to_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "task", "project", "contact", "person", "event", "company", "deal", "activity", "bank_transaction" ], "type": "string" }, { "type": "null" } ], "title": "To Type" } }, { "name": "to_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To Id" } }, { "name": "entity_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "task", "project", "contact", "person", "event", "company", "deal", "activity", "bank_transaction" ], "type": "string" }, { "type": "null" } ], "title": "Entity Type" } }, { "name": "entity_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Links Links Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "links" ], "summary": "Create Link", "operationId": "create_link_links_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Link Links Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/links/{link_id}": { "delete": { "tags": [ "links" ], "summary": "Delete Link", "operationId": "delete_link_links__link_id__delete", "parameters": [ { "name": "link_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Link Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Link Links Link Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/graph/ego": { "get": { "tags": [ "graph" ], "summary": "Ego", "description": "Neighbourhood graph around one seed entity. 404 if the seed is a\nshareable entity the viewer can't read.", "operationId": "ego_graph_ego_get", "parameters": [ { "name": "type", "in": "query", "required": true, "schema": { "type": "string", "title": "Type" } }, { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer", "default": 2, "title": "Depth" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 150, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Ego Graph Ego Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/graph/global": { "get": { "tags": [ "graph" ], "summary": "Global Graph", "description": "The viewer's own links as one capped graph. ``types`` is a comma-separated\nfilter (both endpoints must match).", "operationId": "global_graph_graph_global_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 400, "title": "Limit" } }, { "name": "types", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Types" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Global Graph Graph Global Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/comments": { "get": { "tags": [ "comments" ], "summary": "List Comments", "operationId": "list_comments_comments_get", "parameters": [ { "name": "entity_type", "in": "query", "required": true, "schema": { "enum": [ "task", "project", "contact", "event", "company", "deal" ], "type": "string", "title": "Entity Type" } }, { "name": "entity_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Entity Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Comments Comments Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "comments" ], "summary": "Create Comment", "operationId": "create_comment_comments_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Comment Comments Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/comments/{comment_id}": { "patch": { "tags": [ "comments" ], "summary": "Update Comment", "operationId": "update_comment_comments__comment_id__patch", "parameters": [ { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Comment Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Comment Comments Comment Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "comments" ], "summary": "Delete Comment", "operationId": "delete_comment_comments__comment_id__delete", "parameters": [ { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Comment Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Comment Comments Comment Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/activities": { "get": { "tags": [ "activities" ], "summary": "List Activities", "description": "Team-scope activity feed.\n\nDefault: everything the viewer can see — their own activities plus\nactivities logged by anyone against a shareable entity (project /\ncompany / deal) the viewer can read. Pass ``entity_type`` +\n``entity_id`` to narrow to one record (\"involving X\").\n\nReturns the standard list envelope plus a ``by_type`` breakdown over\nthe full filtered set (for the summary header).", "operationId": "list_activities_activities_get", "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date From" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date To" } }, { "name": "entity_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Type" } }, { "name": "entity_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Activities Activities Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "activities" ], "summary": "Create Activity", "operationId": "create_activity_activities_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Activity Activities Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/activities/for-entity": { "get": { "tags": [ "activities" ], "summary": "List For Entity", "description": "Activities linked to one entity, newest-first.\n\nAccess is gated on the entity: any user who can read it sees all activities\nlogged for it, regardless of author (members of a shared project see each\nother's call notes). For ``contact``/``person`` the timeline is sourced from\nthe shared person (ACL-filtered) so it survives the contact→person migration.", "operationId": "list_for_entity_activities_for_entity_get", "parameters": [ { "name": "entity_type", "in": "query", "required": true, "schema": { "type": "string", "title": "Entity Type" } }, { "name": "entity_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Entity Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List For Entity Activities For Entity Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/activities/{activity_id}": { "get": { "tags": [ "activities" ], "summary": "Get Activity", "operationId": "get_activity_activities__activity_id__get", "parameters": [ { "name": "activity_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Activity Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Activity Activities Activity Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "activities" ], "summary": "Update Activity", "operationId": "update_activity_activities__activity_id__patch", "parameters": [ { "name": "activity_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Activity Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Activity Activities Activity Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "activities" ], "summary": "Delete Activity", "operationId": "delete_activity_activities__activity_id__delete", "parameters": [ { "name": "activity_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Activity Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Activity Activities Activity Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/activities/{activity_id}/participants": { "post": { "tags": [ "activities" ], "summary": "Add Participant", "description": "Link another entity to an existing activity (author only).\n\nRequires read access to the entity being attached — same gate as\ncreate-time linking, so you can't probe for hidden entities.", "operationId": "add_participant_activities__activity_id__participants_post", "parameters": [ { "name": "activity_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Activity Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRefIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Participant Activities Activity Id Participants Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/activities/{activity_id}/participants/{link_id}": { "delete": { "tags": [ "activities" ], "summary": "Remove Participant", "description": "Unlink a participant edge from an activity (author only).", "operationId": "remove_participant_activities__activity_id__participants__link_id__delete", "parameters": [ { "name": "activity_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Activity Id" } }, { "name": "link_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Link Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Participant Activities Activity Id Participants Link Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/activity-types": { "get": { "tags": [ "activities" ], "summary": "List Types", "description": "Built-in defaults + the user's custom types.", "operationId": "list_types_activity_types_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Types Activity Types Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "activities" ], "summary": "Create Type", "operationId": "create_type_activity_types_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Type Activity Types Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/activity-types/{key}": { "patch": { "tags": [ "activities" ], "summary": "Update Type", "description": "Edit a custom type's label and/or icon. The key stays fixed.", "operationId": "update_type_activity_types__key__patch", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "title": "Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Type Activity Types Key Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "activities" ], "summary": "Delete Type", "description": "Remove a custom type. Activities already using it keep their value.", "operationId": "delete_type_activity_types__key__delete", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "title": "Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Type Activity Types Key Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/companies/kvk/search": { "get": { "tags": [ "companies" ], "summary": "Kvk Search", "description": "Search the KVK register by company name or KVK number.", "operationId": "kvk_search_companies_kvk_search_get", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "title": "Q" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Kvk Search Companies Kvk Search Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/companies/kvk/{kvk_number}": { "get": { "tags": [ "companies" ], "summary": "Kvk Profile", "description": "Fetch one company's KVK basisprofiel (structured address) for auto-fill.", "operationId": "kvk_profile_companies_kvk__kvk_number__get", "parameters": [ { "name": "kvk_number", "in": "path", "required": true, "schema": { "type": "string", "title": "Kvk Number" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Kvk Profile Companies Kvk Kvk Number Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/companies": { "get": { "tags": [ "companies" ], "summary": "List Companies", "operationId": "list_companies_companies_get", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Companies Companies Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "companies" ], "summary": "Create Company", "operationId": "create_company_companies_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Company Companies Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/companies/{company_id}": { "get": { "tags": [ "companies" ], "summary": "Get Company", "operationId": "get_company_companies__company_id__get", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Company Companies Company Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "companies" ], "summary": "Update Company", "operationId": "update_company_companies__company_id__patch", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Company Companies Company Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "companies" ], "summary": "Delete Company", "operationId": "delete_company_companies__company_id__delete", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Company Companies Company Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/companies/{company_id}/enrich": { "post": { "tags": [ "companies" ], "summary": "Enrich Company", "description": "Ask DeepSeek to describe this company. **Writes nothing.**\n\nReturns the proposal alongside the current values so the SPA can show them\nside by side; the user applies what they want via the normal PATCH. Scope\nis descriptive only (industry / size / description) — legal and billing\nidentifiers come from KVK and VIES, never from a language model, because\nthey are snapshotted onto invoices.", "operationId": "enrich_company_companies__company_id__enrich_post", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Enrich Company Companies Company Id Enrich Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/companies/{company_id}/validate-vat": { "post": { "tags": [ "companies" ], "summary": "Validate Company Vat", "description": "Validate the company's VAT number against VIES and cache the result.\n\nA definitive valid/invalid answer is stored as such. If VIES (or the\nmember state's system) is unreachable, we store an ``error`` status and\nstill return 200 — the UI shows a \"couldn't verify, try again\" state\nrather than treating it as an invalid number.", "operationId": "validate_company_vat_companies__company_id__validate_vat_post", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Validate Company Vat Companies Company Id Validate Vat Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/companies/discover-from-contacts": { "post": { "tags": [ "companies" ], "summary": "Discover From Contacts", "description": "Scan every contact's ``parsed.organization`` and bootstrap.\n\nFor each non-empty org string:\n - get-or-create a Company by that name\n - get-or-create a ``works_at`` edge from the contact to the company\n\nReturns counts so the SPA can show a summary. Safe to re-run; both\nsides dedupe.", "operationId": "discover_from_contacts_companies_discover_from_contacts_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Discover From Contacts Companies Discover From Contacts Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/companies/{company_id}/members": { "get": { "tags": [ "companies" ], "summary": "List Members", "operationId": "list_members_companies__company_id__members_get", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Members Companies Company Id Members Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "companies" ], "summary": "Add Member", "operationId": "add_member_companies__company_id__members_post", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberAdd" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Member Companies Company Id Members Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/companies/{company_id}/members/{member_username}": { "patch": { "tags": [ "companies" ], "summary": "Change Member Role", "operationId": "change_member_role_companies__company_id__members__member_username__patch", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "member_username", "in": "path", "required": true, "schema": { "type": "string", "title": "Member Username" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberRoleChange" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Change Member Role Companies Company Id Members Member Username Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "companies" ], "summary": "Remove Member", "operationId": "remove_member_companies__company_id__members__member_username__delete", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "member_username", "in": "path", "required": true, "schema": { "type": "string", "title": "Member Username" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Member Companies Company Id Members Member Username Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pipelines": { "get": { "tags": [ "pipelines" ], "summary": "List Pipelines", "operationId": "list_pipelines_pipelines_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Pipelines Pipelines Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pipelines/default": { "get": { "tags": [ "pipelines" ], "summary": "Get Default", "operationId": "get_default_pipelines_default_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Default Pipelines Default Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pipelines/{pipeline_id}": { "get": { "tags": [ "pipelines" ], "summary": "Get Pipeline", "operationId": "get_pipeline_pipelines__pipeline_id__get", "parameters": [ { "name": "pipeline_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pipeline Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Pipeline Pipelines Pipeline Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "pipelines" ], "summary": "Update Pipeline", "operationId": "update_pipeline_pipelines__pipeline_id__patch", "parameters": [ { "name": "pipeline_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pipeline Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Pipeline Pipelines Pipeline Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/deals": { "get": { "tags": [ "deals" ], "summary": "List Deals", "operationId": "list_deals_deals_get", "parameters": [ { "name": "pipeline_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pipeline Id" } }, { "name": "stage_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stage Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "open", "won", "lost" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 200, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Deals Deals Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "deals" ], "summary": "Create Deal", "operationId": "create_deal_deals_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Deal Deals Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/deals/{deal_id}": { "get": { "tags": [ "deals" ], "summary": "Get Deal", "operationId": "get_deal_deals__deal_id__get", "parameters": [ { "name": "deal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deal Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Deal Deals Deal Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "deals" ], "summary": "Update Deal", "operationId": "update_deal_deals__deal_id__patch", "parameters": [ { "name": "deal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deal Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Deal Deals Deal Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "deals" ], "summary": "Delete Deal", "operationId": "delete_deal_deals__deal_id__delete", "parameters": [ { "name": "deal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deal Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Deal Deals Deal Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/deals/reorder": { "post": { "tags": [ "deals" ], "summary": "Reorder", "description": "Kanban drag-drop. Same shape as /tasks/reorder.", "operationId": "reorder_deals_reorder_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routers__deals__ReorderRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Reorder Deals Reorder Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/deals/{deal_id}/members": { "get": { "tags": [ "deals" ], "summary": "List Members", "operationId": "list_members_deals__deal_id__members_get", "parameters": [ { "name": "deal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deal Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Members Deals Deal Id Members Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "deals" ], "summary": "Add Member", "operationId": "add_member_deals__deal_id__members_post", "parameters": [ { "name": "deal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deal Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberAdd" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Member Deals Deal Id Members Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/deals/{deal_id}/members/{member_username}": { "patch": { "tags": [ "deals" ], "summary": "Change Member Role", "operationId": "change_member_role_deals__deal_id__members__member_username__patch", "parameters": [ { "name": "deal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deal Id" } }, { "name": "member_username", "in": "path", "required": true, "schema": { "type": "string", "title": "Member Username" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberRoleChange" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Change Member Role Deals Deal Id Members Member Username Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "deals" ], "summary": "Remove Member", "operationId": "remove_member_deals__deal_id__members__member_username__delete", "parameters": [ { "name": "deal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deal Id" } }, { "name": "member_username", "in": "path", "required": true, "schema": { "type": "string", "title": "Member Username" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Member Deals Deal Id Members Member Username Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search": { "get": { "tags": [ "search" ], "summary": "Search", "description": "Return grouped search hits.\n\n``types`` filters which entity buckets to query (pass repeatedly:\n``?types=task&types=project``). Omit for all.", "operationId": "search_search_get", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Q" } }, { "name": "types", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Types" } }, { "name": "per_type_limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "title": "Per Type Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Search Search Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notifications": { "get": { "tags": [ "notifications" ], "summary": "List Notifications", "operationId": "list_notifications_notifications_get", "parameters": [ { "name": "unread_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unread Only" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Notifications Notifications Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notifications/unread-count": { "get": { "tags": [ "notifications" ], "summary": "Unread Count", "description": "Cheap endpoint for the nav-bar bell badge to poll.", "operationId": "unread_count_notifications_unread_count_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Unread Count Notifications Unread Count Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notifications/{notification_id}/read": { "post": { "tags": [ "notifications" ], "summary": "Mark Read", "operationId": "mark_read_notifications__notification_id__read_post", "parameters": [ { "name": "notification_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Notification Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Mark Read Notifications Notification Id Read Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notifications/read-all": { "post": { "tags": [ "notifications" ], "summary": "Mark All Read", "operationId": "mark_all_read_notifications_read_all_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Mark All Read Notifications Read All Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/custom-fields": { "get": { "tags": [ "custom-fields" ], "summary": "List Definitions", "operationId": "list_definitions_custom_fields_get", "parameters": [ { "name": "entity_type", "in": "query", "required": true, "schema": { "enum": [ "project", "company", "deal", "task" ], "type": "string", "title": "Entity Type" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Definitions Custom Fields Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "custom-fields" ], "summary": "Create Definition", "operationId": "create_definition_custom_fields_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Definition Custom Fields Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/custom-fields/{def_id}": { "patch": { "tags": [ "custom-fields" ], "summary": "Update Definition", "operationId": "update_definition_custom_fields__def_id__patch", "parameters": [ { "name": "def_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Def Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Definition Custom Fields Def Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "custom-fields" ], "summary": "Delete Definition", "description": "Delete the definition. Existing entity values under that key are\nleft intact (so a re-created definition can pick them back up).", "operationId": "delete_definition_custom_fields__def_id__delete", "parameters": [ { "name": "def_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Def Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Definition Custom Fields Def Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/time-entries/running": { "get": { "tags": [ "time-entries" ], "summary": "Get Running", "description": "The user's currently-running timer, or ``{entry: null}``.", "operationId": "get_running_time_entries_running_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Running Time Entries Running Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/time-entries/for-task": { "get": { "tags": [ "time-entries" ], "summary": "List For Task", "operationId": "list_for_task_time_entries_for_task_get", "parameters": [ { "name": "task_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List For Task Time Entries For Task Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/time-entries/totals/project/{project_id}": { "get": { "tags": [ "time-entries" ], "summary": "Project Totals", "description": "Per-user time totals for a project (used by the Time tab).", "operationId": "project_totals_time_entries_totals_project__project_id__get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Project Totals Time Entries Totals Project Project Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/time-entries": { "post": { "tags": [ "time-entries" ], "summary": "Create Manual", "operationId": "create_manual_time_entries_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManualEntry" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Manual Time Entries Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/time-entries/{entry_id}": { "patch": { "tags": [ "time-entries" ], "summary": "Update Entry", "operationId": "update_entry_time_entries__entry_id__patch", "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Entry Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntryUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Entry Time Entries Entry Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "time-entries" ], "summary": "Delete Entry", "operationId": "delete_entry_time_entries__entry_id__delete", "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Entry Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Entry Time Entries Entry Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tasks/{task_id}/timer/start": { "post": { "tags": [ "time-entries" ], "summary": "Start Timer", "operationId": "start_timer_tasks__task_id__timer_start_post", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartTimerBody", "default": {} } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Start Timer Tasks Task Id Timer Start Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tasks/{task_id}/timer/stop": { "post": { "tags": [ "time-entries" ], "summary": "Stop Timer", "description": "Stop the running timer on this task (if it's the user's).\n\nReturns the stopped entry. 404 if no running timer is on this task.", "operationId": "stop_timer_tasks__task_id__timer_stop_post", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Stop Timer Tasks Task Id Timer Stop Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/templates": { "get": { "tags": [ "templates" ], "summary": "List Templates", "operationId": "list_templates_templates_get", "parameters": [ { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "project", "task" ], "type": "string" }, { "type": "null" } ], "title": "Kind" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Templates Templates Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/templates/from-project/{project_id}": { "post": { "tags": [ "templates" ], "summary": "Capture Project", "operationId": "capture_project_templates_from_project__project_id__post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateCapture" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Capture Project Templates From Project Project Id Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/templates/from-task/{task_id}": { "post": { "tags": [ "templates" ], "summary": "Capture Task", "operationId": "capture_task_templates_from_task__task_id__post", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateCapture" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Capture Task Templates From Task Task Id Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/templates/{template_id}/instantiate": { "post": { "tags": [ "templates" ], "summary": "Instantiate", "operationId": "instantiate_templates__template_id__instantiate_post", "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Template Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstantiatePayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Instantiate Templates Template Id Instantiate Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/templates/{template_id}": { "delete": { "tags": [ "templates" ], "summary": "Delete Template", "operationId": "delete_template_templates__template_id__delete", "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Template Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Template Templates Template Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/attachments/for-entity": { "get": { "tags": [ "attachments" ], "summary": "List For Entity", "operationId": "list_for_entity_attachments_for_entity_get", "parameters": [ { "name": "entity_type", "in": "query", "required": true, "schema": { "enum": [ "task", "project", "contact", "event", "company", "deal", "note", "invoice", "expense", "personal_expense" ], "type": "string", "title": "Entity Type" } }, { "name": "entity_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Entity Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List For Entity Attachments For Entity Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/attachments": { "post": { "tags": [ "attachments" ], "summary": "Upload", "operationId": "upload_attachments_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_attachments_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Upload Attachments Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/attachments/{attachment_id}/download": { "get": { "tags": [ "attachments" ], "summary": "Download", "description": "Stream the bytes.\n\n``disposition=inline`` lets the browser render the file in place (the\ndocument viewer frames this URL) instead of offering a save dialog. The\ndefault stays ``attachment`` so every existing download link behaves\nexactly as before. Only previewable types may go inline — otherwise a\n.docx would render as a wall of binary in an iframe.", "operationId": "download_attachments__attachment_id__download_get", "parameters": [ { "name": "attachment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Attachment Id" } }, { "name": "disposition", "in": "query", "required": false, "schema": { "enum": [ "attachment", "inline" ], "type": "string", "default": "attachment", "title": "Disposition" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/attachments/{attachment_id}/meta": { "patch": { "tags": [ "attachments" ], "summary": "Patch Meta", "description": "Update the document metadata block.\n\nSame permission rule as delete: the uploader always may, otherwise you\nneed edit rights on the owning entity.", "operationId": "patch_meta_attachments__attachment_id__meta_patch", "parameters": [ { "name": "attachment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Attachment Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetaPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Patch Meta Attachments Attachment Id Meta Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/attachments/{attachment_id}": { "delete": { "tags": [ "attachments" ], "summary": "Delete Attachment", "operationId": "delete_attachment_attachments__attachment_id__delete", "parameters": [ { "name": "attachment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Attachment Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Attachment Attachments Attachment Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/documents": { "get": { "tags": [ "documents" ], "summary": "List Documents", "description": "One page of visible documents, newest first.\n\n``has_more`` is best-effort: because the ACL pass runs after the query we\nreport whether the store still had rows left, not an exact remaining count.\nA precise total would mean ACL-checking the entire collection on every\nrequest.", "operationId": "list_documents_documents_get", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "doc_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Doc Type" } }, { "name": "entity_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Type" } }, { "name": "untyped", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Untyped" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Documents Documents Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/documents/facets": { "get": { "tags": [ "documents" ], "summary": "Document Facets", "description": "Counts for the filter bar: by doc_type, by entity_type, and how many\nare still unclassified (the \"needs filing\" worklist).", "operationId": "document_facets_documents_facets_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Document Facets Documents Facets Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tasks/{task_id}/export-to-caldav": { "post": { "tags": [ "tasks" ], "summary": "Export", "description": "Push the task to the user's CalDAV calendar as a VTODO.\n\nIdempotent: subsequent calls update the existing remote resource\nusing the stored href + etag. Returns the updated task.", "operationId": "export_tasks__task_id__export_to_caldav_post", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Export Tasks Task Id Export To Caldav Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tasks" ], "summary": "Unexport", "description": "Remove the remote VTODO and clear the export markers locally.", "operationId": "unexport_tasks__task_id__export_to_caldav_delete", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Unexport Tasks Task Id Export To Caldav Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/caldav/connection/export-default": { "put": { "tags": [ "caldav" ], "summary": "Set Default Calendar", "description": "Store / clear the user's default export calendar.\n\nThe flag lives on the calendar doc (``is_export_default``) — a\nconnection no longer identifies a calendar now that a user can have\nseveral accounts.", "operationId": "set_default_calendar_caldav_connection_export_default_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultCalendarBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Default Calendar Caldav Connection Export Default Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/locations/countries": { "get": { "tags": [ "locations", "countries" ], "summary": "List Countries", "description": "All countries.\n\n``details=false`` (default) → slim ``{code, name, region, flag}``\npicker payload. ``details=true`` → the full ``{code, data, meta}``\nenvelope per row. Both ordered alphabetically by common name.", "operationId": "list_countries_locations_countries_get", "parameters": [ { "name": "details", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Details" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response List Countries Locations Countries Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/locations/countries/{cca2}": { "get": { "tags": [ "locations", "countries" ], "summary": "Get Country", "operationId": "get_country_locations_countries__cca2__get", "parameters": [ { "name": "cca2", "in": "path", "required": true, "schema": { "type": "string", "title": "Cca2" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Country Locations Countries Cca2 Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/locations/countries/refresh": { "post": { "tags": [ "locations", "countries" ], "summary": "Refresh Countries", "description": "Pull the latest country dataset from REST Countries (admin only).\n\nRuns the (blocking) HTTP + bulk-upsert off the event loop and records\na ``task_history`` row so the admin panel sees it.", "operationId": "refresh_countries_locations_countries_refresh_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Refresh Countries Locations Countries Refresh Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/locations/regions": { "get": { "tags": [ "locations", "regions" ], "summary": "List Regions", "description": "List subdivisions. ``country`` (cca2) narrows to one country.", "operationId": "list_regions_locations_regions_get", "parameters": [ { "name": "country", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response List Regions Locations Regions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/locations/regions/{region_id}": { "get": { "tags": [ "locations", "regions" ], "summary": "Get Region", "operationId": "get_region_locations_regions__region_id__get", "parameters": [ { "name": "region_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Region Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Region Locations Regions Region Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/locations/regions/refresh": { "post": { "tags": [ "locations", "regions" ], "summary": "Refresh Regions", "description": "Re-import the GeoNames admin1 subdivisions (admin only, audited).", "operationId": "refresh_regions_locations_regions_refresh_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Refresh Regions Locations Regions Refresh Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/locations/cities": { "get": { "tags": [ "locations", "cities" ], "summary": "List Cities", "description": "Paginated city search. Returns ``{rows, total, limit, offset}``.", "operationId": "list_cities_locations_cities_get", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "country", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" } }, { "name": "admin1", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Admin1" } }, { "name": "min_population", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Min Population" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Cities Locations Cities Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/locations/cities/countries": { "get": { "tags": [ "locations", "cities" ], "summary": "List Country Counts", "description": "``[{country_code, count}]`` for the country dropdown.", "operationId": "list_country_counts_locations_cities_countries_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response List Country Counts Locations Cities Countries Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/locations/cities/{geoname_id}": { "get": { "tags": [ "locations", "cities" ], "summary": "Get City", "description": "One city plus its nearest neighbours (self excluded).", "operationId": "get_city_locations_cities__geoname_id__get", "parameters": [ { "name": "geoname_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Geoname Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get City Locations Cities Geoname Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/locations/cities/{geoname_id}/history": { "get": { "tags": [ "locations", "cities" ], "summary": "Get City History", "description": "Per-city change history (most recent first).", "operationId": "get_city_history_locations_cities__geoname_id__history_get", "parameters": [ { "name": "geoname_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Geoname Id" } }, { "name": "skip", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Skip" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get City History Locations Cities Geoname Id History Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/locations/languages": { "get": { "tags": [ "locations", "languages" ], "summary": "List Languages", "description": "Search + filter + paginate. Slim ``{id, ref_name, part1, scope, type, retired}`` rows.", "operationId": "list_languages_locations_languages_get", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "scope", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "I | M | S", "title": "Scope" }, "description": "I | M | S" }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Living | Extinct | …", "title": "Type" }, "description": "Living | Extinct | …" }, { "name": "has_639_1", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has 639 1" } }, { "name": "include_retired", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Retired" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Languages Locations Languages Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/locations/languages/{lang_id}": { "get": { "tags": [ "locations", "languages" ], "summary": "Get Language", "description": "One language, full envelope. For a macrolanguage, resolves its members.", "operationId": "get_language_locations_languages__lang_id__get", "parameters": [ { "name": "lang_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Lang Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Language Locations Languages Lang Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/locations/cities/datasets": { "get": { "tags": [ "admin", "locations" ], "summary": "List Datasets", "description": "Importable GeoNames datasets with label + estimated row count.", "operationId": "list_datasets_admin_locations_cities_datasets_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Datasets Admin Locations Cities Datasets Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/locations/cities/status": { "get": { "tags": [ "admin", "locations" ], "summary": "Cities Status", "description": "Current dataset, total cities, last import + live worker state.", "operationId": "cities_status_admin_locations_cities_status_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cities Status Admin Locations Cities Status Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/locations/cities/stats": { "get": { "tags": [ "admin", "locations" ], "summary": "Cities Stats", "description": "Live distributions + totals over the loaded dataset.", "operationId": "cities_stats_admin_locations_cities_stats_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cities Stats Admin Locations Cities Stats Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/locations/cities/imports": { "get": { "tags": [ "admin", "locations" ], "summary": "List Imports", "description": "Newest-first import-run rows. Optional YYYY-MM-DD bounds.", "operationId": "list_imports_admin_locations_cities_imports_get", "parameters": [ { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "name": "until", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Until" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Imports Admin Locations Cities Imports Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/locations/cities/imports/{import_id}": { "get": { "tags": [ "admin", "locations" ], "summary": "Get Import", "operationId": "get_import_admin_locations_cities_imports__import_id__get", "parameters": [ { "name": "import_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Import Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Import Admin Locations Cities Imports Import Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/locations/cities/imports/run": { "post": { "tags": [ "admin", "locations" ], "summary": "Submit Import", "description": "Queue a cities import. Returns immediately with worker state.", "operationId": "submit_import_admin_locations_cities_imports_run_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportSubmit" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Submit Import Admin Locations Cities Imports Run Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/locations/languages/status": { "get": { "tags": [ "admin", "locations" ], "summary": "Languages Status", "operationId": "languages_status_admin_locations_languages_status_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Languages Status Admin Locations Languages Status Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/locations/languages/stats": { "get": { "tags": [ "admin", "locations" ], "summary": "Languages Stats", "operationId": "languages_stats_admin_locations_languages_stats_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Languages Stats Admin Locations Languages Stats Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/locations/languages/imports": { "get": { "tags": [ "admin", "locations" ], "summary": "List Language Imports", "operationId": "list_language_imports_admin_locations_languages_imports_get", "parameters": [ { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "name": "until", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Until" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Language Imports Admin Locations Languages Imports Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/locations/languages/imports/{import_id}": { "get": { "tags": [ "admin", "locations" ], "summary": "Get Language Import", "operationId": "get_language_import_admin_locations_languages_imports__import_id__get", "parameters": [ { "name": "import_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Import Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Language Import Admin Locations Languages Imports Import Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/locations/languages/imports/run": { "post": { "tags": [ "admin", "locations" ], "summary": "Run Language Import", "description": "Download the SIL tables + upsert (admin only). Runs the blocking work\noff the event loop and returns the resulting import-audit row.", "operationId": "run_language_import_admin_locations_languages_imports_run_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Run Language Import Admin Locations Languages Imports Run Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notebooks": { "get": { "tags": [ "notebooks" ], "summary": "List Notebooks", "operationId": "list_notebooks_notebooks_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Notebooks Notebooks Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "notebooks" ], "summary": "Create Notebook", "operationId": "create_notebook_notebooks_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotebookCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Notebook Notebooks Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notebooks/reorder": { "post": { "tags": [ "notebooks" ], "summary": "Reorder Notebooks", "operationId": "reorder_notebooks_notebooks_reorder_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Reorder Notebooks Notebooks Reorder Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notebooks/{notebook_id}": { "get": { "tags": [ "notebooks" ], "summary": "Get Notebook", "operationId": "get_notebook_notebooks__notebook_id__get", "parameters": [ { "name": "notebook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Notebook Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Notebook Notebooks Notebook Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "notebooks" ], "summary": "Update Notebook", "operationId": "update_notebook_notebooks__notebook_id__patch", "parameters": [ { "name": "notebook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Notebook Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotebookUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Notebook Notebooks Notebook Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "notebooks" ], "summary": "Delete Notebook", "description": "Delete a notebook and all its notes (not the Inbox).", "operationId": "delete_notebook_notebooks__notebook_id__delete", "parameters": [ { "name": "notebook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Notebook Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Notebook Notebooks Notebook Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notebooks/{notebook_id}/members": { "get": { "tags": [ "notebooks" ], "summary": "List Members", "operationId": "list_members_notebooks__notebook_id__members_get", "parameters": [ { "name": "notebook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Notebook Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Members Notebooks Notebook Id Members Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "notebooks" ], "summary": "Add Member", "operationId": "add_member_notebooks__notebook_id__members_post", "parameters": [ { "name": "notebook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Notebook Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberAdd" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Member Notebooks Notebook Id Members Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notebooks/{notebook_id}/members/{member_username}": { "patch": { "tags": [ "notebooks" ], "summary": "Change Member Role", "operationId": "change_member_role_notebooks__notebook_id__members__member_username__patch", "parameters": [ { "name": "notebook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Notebook Id" } }, { "name": "member_username", "in": "path", "required": true, "schema": { "type": "string", "title": "Member Username" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberRoleChange" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Change Member Role Notebooks Notebook Id Members Member Username Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "notebooks" ], "summary": "Remove Member", "operationId": "remove_member_notebooks__notebook_id__members__member_username__delete", "parameters": [ { "name": "notebook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Notebook Id" } }, { "name": "member_username", "in": "path", "required": true, "schema": { "type": "string", "title": "Member Username" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Member Notebooks Notebook Id Members Member Username Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notes": { "get": { "tags": [ "notes" ], "summary": "List Notes", "description": "Notes in a notebook (defaults to Inbox), pinned first.", "operationId": "list_notes_notes_get", "parameters": [ { "name": "notebook_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notebook Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Notes Notes Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "notes" ], "summary": "Create Note", "operationId": "create_note_notes_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Note Notes Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notes/trash": { "get": { "tags": [ "notes" ], "summary": "List Trash", "operationId": "list_trash_notes_trash_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Trash Notes Trash Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notes/for-entity": { "get": { "tags": [ "notes" ], "summary": "List For Entity", "description": "Notes linked to one entity (any author the viewer can see).", "operationId": "list_for_entity_notes_for_entity_get", "parameters": [ { "name": "entity_type", "in": "query", "required": true, "schema": { "type": "string", "title": "Entity Type" } }, { "name": "entity_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Entity Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List For Entity Notes For Entity Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notes/{note_id}": { "get": { "tags": [ "notes" ], "summary": "Get Note", "operationId": "get_note_notes__note_id__get", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Note Notes Note Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "notes" ], "summary": "Update Note", "operationId": "update_note_notes__note_id__patch", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Note Notes Note Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "notes" ], "summary": "Delete Note", "description": "Soft-delete (trash). Recoverable via POST /notes/{id}/restore.", "operationId": "delete_note_notes__note_id__delete", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Note Notes Note Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notes/{note_id}/restore": { "post": { "tags": [ "notes" ], "summary": "Restore Note", "operationId": "restore_note_notes__note_id__restore_post", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Restore Note Notes Note Id Restore Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notes/{note_id}/purge": { "delete": { "tags": [ "notes" ], "summary": "Purge Note", "description": "Permanently delete a trashed note + its links.", "operationId": "purge_note_notes__note_id__purge_delete", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Purge Note Notes Note Id Purge Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notes/{note_id}/links": { "post": { "tags": [ "notes" ], "summary": "Add Link", "description": "Link a note to an entity (the viewer must be able to read both).", "operationId": "add_link_notes__note_id__links_post", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Link Notes Note Id Links Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/people/by-contact": { "get": { "tags": [ "people" ], "summary": "Person By Contact", "description": "The shared person for one of the viewer's OWN contacts (or null).\n\nLets the contact-detail page source the person's cross-user interactions.\n404 if the viewer doesn't own that contact; ``{\"person\": null}`` when the\ncontact has never been linked (so no person exists yet).", "operationId": "person_by_contact_people_by_contact_get", "parameters": [ { "name": "addressbook_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Addressbook Id" } }, { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "title": "Uid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Person By Contact People By Contact Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/people/{person_id}": { "get": { "tags": [ "people" ], "summary": "Get Person", "description": "Display data for a person. 404 unless the viewer can see them (a matching\ncontact, or ≥1 referencing entity they can read) — no existence leak.", "operationId": "get_person_people__person_id__get", "parameters": [ { "name": "person_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Person Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Person People Person Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/test": { "post": { "tags": [ "mail" ], "summary": "Test Connection", "description": "Validate credentials and return discovered folders. Doesn't save.", "operationId": "test_connection_mail_test_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImapCredentials" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Test Connection Mail Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/connection": { "get": { "tags": [ "mail" ], "summary": "Get Connection", "description": "Legacy single-account view — the DEFAULT account.", "operationId": "get_connection_mail_connection_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Connection Mail Connection Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "mail" ], "summary": "Save Connection", "description": "Validate against the server, then save the (encrypted) credentials.\n\nLegacy single-account alias: updates the DEFAULT account in place, or\ncreates the first account when none exists yet.", "operationId": "save_connection_mail_connection_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImapCredentials" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Connection Mail Connection Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "mail" ], "summary": "Delete Connection", "description": "Disconnect ALL accounts. By default cascades synced mail + folders.", "operationId": "delete_connection_mail_connection_delete", "parameters": [ { "name": "delete_emails", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Delete Emails" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Connection Mail Connection Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts": { "get": { "tags": [ "mail" ], "summary": "List Accounts", "operationId": "list_accounts_mail_accounts_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Accounts Mail Accounts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "mail" ], "summary": "Create Account", "description": "Validate against the server, then add a NEW mail account.\n\nThe first account becomes the default automatically.", "operationId": "create_account_mail_accounts_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImapAccountIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Account Mail Accounts Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}": { "put": { "tags": [ "mail" ], "summary": "Update Account", "description": "Validate + update one account's IMAP credentials (and label).", "operationId": "update_account_mail_accounts__account_id__put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImapAccountIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Account Mail Accounts Account Id Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "mail" ], "summary": "Delete Account", "description": "Remove ONE account. By default cascades its synced mail + folders.", "operationId": "delete_account_mail_accounts__account_id__delete", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "delete_emails", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Delete Emails" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Account Mail Accounts Account Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}/set-default": { "post": { "tags": [ "mail" ], "summary": "Set Default Account", "operationId": "set_default_account_mail_accounts__account_id__set_default_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Default Account Mail Accounts Account Id Set Default Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}/test": { "post": { "tags": [ "mail" ], "summary": "Test Account", "description": "Validate one account's saved credentials; returns discovered folders.", "operationId": "test_account_mail_accounts__account_id__test_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Test Account Mail Accounts Account Id Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}/folders/available": { "get": { "tags": [ "mail" ], "summary": "List Account Available Folders", "description": "Re-discover one account's folders using its saved credentials.", "operationId": "list_account_available_folders_mail_accounts__account_id__folders_available_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Account Available Folders Mail Accounts Account Id Folders Available Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}/folders": { "put": { "tags": [ "mail" ], "summary": "Save Account Folders", "description": "Set one account's enabled folder set (see ``save_folders``).", "operationId": "save_account_folders_mail_accounts__account_id__folders_put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderSelection" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Account Folders Mail Accounts Account Id Folders Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/folders/available": { "get": { "tags": [ "mail" ], "summary": "List Available Folders", "description": "Re-discover folders from the server (DEFAULT account, legacy alias).", "operationId": "list_available_folders_mail_folders_available_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Available Folders Mail Folders Available Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/folders": { "get": { "tags": [ "mail" ], "summary": "List Folders", "description": "All accounts' folders, each tagged with its account's label.", "operationId": "list_folders_mail_folders_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Folders Mail Folders Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "mail" ], "summary": "Save Folders", "description": "Set the DEFAULT account's enabled folder set (legacy alias).\n\nRemoved folders cascade their mail away. Re-discovers from the server so\nwe resolve each requested id back to a real path/name without trusting\nclient input.", "operationId": "save_folders_mail_folders_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderSelection" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Folders Mail Folders Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/sync": { "post": { "tags": [ "mail" ], "summary": "Sync Now", "description": "Trigger a sync. ``folder_id`` limits it to one folder, ``account_id``\nto one account; with neither, every account is synced.", "operationId": "sync_now_mail_sync_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routers__mail__SyncRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Sync Now Mail Sync Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/folders/{folder_id}/empty-to-trash": { "post": { "tags": [ "mail" ], "summary": "Empty To Trash", "description": "Move every message in a folder to the Trash folder.\n\nAvailable on any folder EXCEPT the ones a mis-click would wreck — INBOX,\nSent, Drafts, Trash itself and Gmail's All Mail (see\n:func:`api.mail.client.is_protected_from_empty`). Never deletes — the\nmessages are relocated to Trash. Reflects the now-empty folder locally so\nthe UI updates immediately.", "operationId": "empty_to_trash_mail_folders__folder_id__empty_to_trash_post", "parameters": [ { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Folder Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Empty To Trash Mail Folders Folder Id Empty To Trash Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/search": { "get": { "tags": [ "mail" ], "summary": "Search Messages", "description": "Full-text search across all folders and accounts (bodies included).\n\nBacked by the ``email_text`` ``$text`` index — word-based matching,\nunlike the substring regex of the per-folder ``q`` on /messages. Each\nhit carries ``folder_name``/``folder_path``/``account_label`` so result\nrows can show where the message lives.", "operationId": "search_messages_mail_search_get", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Q" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Search Messages Mail Search Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/messages": { "get": { "tags": [ "mail" ], "summary": "List Messages", "operationId": "list_messages_mail_messages_get", "parameters": [ { "name": "folder_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Folder Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "tag", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tag" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Messages Mail Messages Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/tags": { "get": { "tags": [ "mail" ], "summary": "Folder Tags", "description": "Distinct tags (IMAP keywords) with message counts, for the filter bar.", "operationId": "folder_tags_mail_tags_get", "parameters": [ { "name": "folder_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Folder Id" } }, { "name": "account_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Folder Tags Mail Tags Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/messages/{email_id}": { "get": { "tags": [ "mail" ], "summary": "Get Message", "operationId": "get_message_mail_messages__email_id__get", "parameters": [ { "name": "email_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Email Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Message Mail Messages Email Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/contact-emails": { "get": { "tags": [ "mail" ], "summary": "Contact Emails", "description": "Emails where this contact is a sender or recipient (newest first).", "operationId": "contact_emails_mail_contact_emails_get", "parameters": [ { "name": "addressbook_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Addressbook Id" } }, { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "title": "Uid" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Contact Emails Mail Contact Emails Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/messages/{email_id}/read": { "post": { "tags": [ "mail" ], "summary": "Mark Read", "description": "Mark a message read — sets the ``\\Seen`` flag on the server.\n\nNo-op when it's already read (no server round trip). Keeps the local\n``seen`` flag and the folder's unread badge in sync.", "operationId": "mark_read_mail_messages__email_id__read_post", "parameters": [ { "name": "email_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Email Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Mark Read Mail Messages Email Id Read Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/messages/{email_id}/tags": { "post": { "tags": [ "mail" ], "summary": "Set Message Tag", "description": "Add or remove a tag (IMAP keyword) on a message — STOREs it on the server\nso it round-trips with other clients (Thunderbird). Returns the new tags.", "operationId": "set_message_tag_mail_messages__email_id__tags_post", "parameters": [ { "name": "email_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Email Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagAction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Message Tag Mail Messages Email Id Tags Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/messages/{email_id}/move-to-inbox": { "post": { "tags": [ "mail" ], "summary": "Move To Inbox", "description": "Move a message back into the INBOX — e.g. right after whitelisting its\nsender, to pull a quarantined message out of the spam folder.\n\nNo-op when the message is already in the INBOX. The server MOVE assigns\nthe message a fresh UID in the INBOX, so we drop the local copy here and\nlet the next INBOX sync re-import it (now that the sender is whitelisted,\nthe filter leaves it in place). The source folder's counts are refreshed\nso the UI updates immediately.", "operationId": "move_to_inbox_mail_messages__email_id__move_to_inbox_post", "parameters": [ { "name": "email_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Email Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Move To Inbox Mail Messages Email Id Move To Inbox Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/messages/{email_id}/move": { "post": { "tags": [ "mail" ], "summary": "Move Message Endpoint", "description": "Move a message to another folder.\n\nDestination is either a synced folder (``dest_folder_id``) or a special-use\nfolder resolved server-side (``special`` = ``\"archive\"`` / ``\"trash\"``), so\nArchive/Trash work even when those folders aren't synced. The message is\ndropped locally and the source folder's counts refreshed; a move into a\nsynced folder reappears there on the next sync (under its new UID).", "operationId": "move_message_endpoint_mail_messages__email_id__move_post", "parameters": [ { "name": "email_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Email Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routers__mail__MoveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Move Message Endpoint Mail Messages Email Id Move Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/messages/{email_id}/raw": { "get": { "tags": [ "mail" ], "summary": "Download Raw", "description": "Download the full original message as an ``.eml`` (message/rfc822).\n\nServed from GridFS when stored; otherwise fetched live from the server\nonce and persisted (lazy backfill for messages synced before we kept\nraw). 404 if the message is gone from both our store and the server.", "operationId": "download_raw_mail_messages__email_id__raw_get", "parameters": [ { "name": "email_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Email Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/messages/{email_id}/attachments/{part_id}": { "get": { "tags": [ "mail" ], "summary": "Download Attachment", "description": "Fetch one attachment's bytes on demand from the IMAP server (read-only).", "operationId": "download_attachment_mail_messages__email_id__attachments__part_id__get", "parameters": [ { "name": "email_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Email Id" } }, { "name": "part_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Part Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/whitelist": { "get": { "tags": [ "mail" ], "summary": "List Whitelist", "operationId": "list_whitelist_mail_whitelist_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Whitelist Mail Whitelist Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "mail" ], "summary": "Add Whitelist", "operationId": "add_whitelist_mail_whitelist_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhitelistAdd" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Whitelist Mail Whitelist Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/whitelist/{entry_id}": { "delete": { "tags": [ "mail" ], "summary": "Remove Whitelist", "operationId": "remove_whitelist_mail_whitelist__entry_id__delete", "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Entry Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Whitelist Mail Whitelist Entry Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/blocklist": { "get": { "tags": [ "mail" ], "summary": "List Blocklist", "operationId": "list_blocklist_mail_blocklist_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Blocklist Mail Blocklist Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "mail" ], "summary": "Add Blocklist", "operationId": "add_blocklist_mail_blocklist_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlocklistAdd" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Blocklist Mail Blocklist Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/blocklist/{entry_id}": { "delete": { "tags": [ "mail" ], "summary": "Remove Blocklist", "operationId": "remove_blocklist_mail_blocklist__entry_id__delete", "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Entry Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Blocklist Mail Blocklist Entry Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}/rules": { "get": { "tags": [ "mail" ], "summary": "List Rules", "operationId": "list_rules_mail_accounts__account_id__rules_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Rules Mail Accounts Account Id Rules Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "mail" ], "summary": "Add Rule", "operationId": "add_rule_mail_accounts__account_id__rules_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routers__mail__RuleIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Rule Mail Accounts Account Id Rules Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}/rules/reorder": { "put": { "tags": [ "mail" ], "summary": "Reorder Rules", "operationId": "reorder_rules_mail_accounts__account_id__rules_reorder_put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleReorder" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Reorder Rules Mail Accounts Account Id Rules Reorder Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}/rules/{rule_id}": { "put": { "tags": [ "mail" ], "summary": "Update Rule", "operationId": "update_rule_mail_accounts__account_id__rules__rule_id__put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Rule Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routers__mail__RuleIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Rule Mail Accounts Account Id Rules Rule Id Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "mail" ], "summary": "Remove Rule", "operationId": "remove_rule_mail_accounts__account_id__rules__rule_id__delete", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Rule Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Rule Mail Accounts Account Id Rules Rule Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}/rules/{rule_id}/enabled": { "put": { "tags": [ "mail" ], "summary": "Set Rule Enabled", "operationId": "set_rule_enabled_mail_accounts__account_id__rules__rule_id__enabled_put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Rule Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Rule Enabled Mail Accounts Account Id Rules Rule Id Enabled Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/smart-folders": { "get": { "tags": [ "mail" ], "summary": "List Smart Folders", "operationId": "list_smart_folders_mail_smart_folders_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Smart Folders Mail Smart Folders Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "mail" ], "summary": "Add Smart Folder", "operationId": "add_smart_folder_mail_smart_folders_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartFolderIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Smart Folder Mail Smart Folders Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/smart-folders/{sf_id}": { "patch": { "tags": [ "mail" ], "summary": "Update Smart Folder", "operationId": "update_smart_folder_mail_smart_folders__sf_id__patch", "parameters": [ { "name": "sf_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Sf Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartFolderPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Smart Folder Mail Smart Folders Sf Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "mail" ], "summary": "Remove Smart Folder", "operationId": "remove_smart_folder_mail_smart_folders__sf_id__delete", "parameters": [ { "name": "sf_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Sf Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Smart Folder Mail Smart Folders Sf Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/smart-folders/{sf_id}/messages": { "get": { "tags": [ "mail" ], "summary": "List Smart Messages", "operationId": "list_smart_messages_mail_smart_folders__sf_id__messages_get", "parameters": [ { "name": "sf_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Sf Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Smart Messages Mail Smart Folders Sf Id Messages Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/messages/{email_id}/report-spam": { "post": { "tags": [ "mail" ], "summary": "Report Spam", "description": "Block the sender's domain and move this message to the spam folder now.\n\nFuture mail from the domain is auto-routed to the spam folder by the filter\npass on each sync (new mail only). The current message is moved immediately\nso it doesn't sit in the inbox.", "operationId": "report_spam_mail_messages__email_id__report_spam_post", "parameters": [ { "name": "email_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Email Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Report Spam Mail Messages Email Id Report Spam Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/filter": { "get": { "tags": [ "mail" ], "summary": "Get Filter", "operationId": "get_filter_mail_filter_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Filter Mail Filter Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "mail" ], "summary": "Save Filter", "operationId": "save_filter_mail_filter_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterConfig" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Filter Mail Filter Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/filter/run": { "post": { "tags": [ "mail" ], "summary": "Run Filter", "description": "Run the filter once now (see ``_run_filter``).", "operationId": "run_filter_mail_filter_run_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api__routers__mail__SyncRequest" }, { "type": "null" } ], "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Run Filter Mail Filter Run Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}/filter": { "get": { "tags": [ "mail" ], "summary": "Get Account Filter", "operationId": "get_account_filter_mail_accounts__account_id__filter_get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Account Filter Mail Accounts Account Id Filter Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "mail" ], "summary": "Save Account Filter", "operationId": "save_account_filter_mail_accounts__account_id__filter_put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterConfig" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Account Filter Mail Accounts Account Id Filter Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}/filter/run": { "post": { "tags": [ "mail" ], "summary": "Run Account Filter", "description": "Run one account's filter once now (see ``_run_filter``).", "operationId": "run_account_filter_mail_accounts__account_id__filter_run_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/api__routers__mail__SyncRequest" }, { "type": "null" } ], "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Run Account Filter Mail Accounts Account Id Filter Run Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/smtp": { "put": { "tags": [ "mail" ], "summary": "Save Smtp", "description": "Save the sending identity (SMTP host/port/security + From + signature).\n\nSMTP reuses the IMAP login, so an IMAP connection must exist first.\nLegacy alias — operates on the DEFAULT account.", "operationId": "save_smtp_mail_smtp_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmtpConfigIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Smtp Mail Smtp Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/test-smtp": { "post": { "tags": [ "mail" ], "summary": "Test Smtp", "description": "Validate the saved SMTP config (DEFAULT account, legacy alias).", "operationId": "test_smtp_mail_test_smtp_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Test Smtp Mail Test Smtp Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}/smtp": { "put": { "tags": [ "mail" ], "summary": "Save Account Smtp", "description": "Save one account's sending identity (see ``save_smtp``).", "operationId": "save_account_smtp_mail_accounts__account_id__smtp_put", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmtpConfigIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Save Account Smtp Mail Accounts Account Id Smtp Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/accounts/{account_id}/test-smtp": { "post": { "tags": [ "mail" ], "summary": "Test Account Smtp", "description": "Validate one account's SMTP config against the server.", "operationId": "test_account_smtp_mail_accounts__account_id__test_smtp_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Test Account Smtp Mail Accounts Account Id Test Smtp Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/attachments": { "post": { "tags": [ "mail" ], "summary": "Stage Attachment", "description": "Stage an outgoing attachment in GridFS; returns an id to reference on send.", "operationId": "stage_attachment_mail_attachments_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_stage_attachment_mail_attachments_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Stage Attachment Mail Attachments Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/attachments/{attachment_id}": { "delete": { "tags": [ "mail" ], "summary": "Discard Attachment", "description": "Discard a staged outgoing attachment.", "operationId": "discard_attachment_mail_attachments__attachment_id__delete", "parameters": [ { "name": "attachment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Attachment Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Discard Attachment Mail Attachments Attachment Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/messages/{email_id}/reply-draft": { "get": { "tags": [ "mail" ], "summary": "Reply Draft", "description": "Prefill for reply / reply_all / forward.\n\nReturns recipients, subject, a Markdown body seed (quoted original), and\nthreading headers. For ``forward`` the original's attachments are re-staged\nand returned so the composer carries them.", "operationId": "reply_draft_mail_messages__email_id__reply_draft_get", "parameters": [ { "name": "email_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Email Id" } }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string", "default": "reply", "title": "Mode" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Reply Draft Mail Messages Email Id Reply Draft Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/send": { "post": { "tags": [ "mail" ], "summary": "Send Mail", "description": "Build + submit a message over SMTP, file a copy to Sent, and (for a\nreply) flag the original ``\\Answered``.", "operationId": "send_mail_mail_send_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Send Mail Mail Send Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/drafts": { "get": { "tags": [ "mail" ], "summary": "List Drafts", "operationId": "list_drafts_mail_drafts_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Drafts Mail Drafts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "mail" ], "summary": "Create Draft", "operationId": "create_draft_mail_drafts_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Draft Mail Drafts Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mail/drafts/{draft_id}": { "get": { "tags": [ "mail" ], "summary": "Get Draft", "operationId": "get_draft_mail_drafts__draft_id__get", "parameters": [ { "name": "draft_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Draft Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Draft Mail Drafts Draft Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "mail" ], "summary": "Update Draft", "operationId": "update_draft_mail_drafts__draft_id__put", "parameters": [ { "name": "draft_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Draft Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Draft Mail Drafts Draft Id Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "mail" ], "summary": "Delete Draft", "description": "Delete a draft and discard the staged attachments it was holding.", "operationId": "delete_draft_mail_drafts__draft_id__delete", "parameters": [ { "name": "draft_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Draft Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Draft Mail Drafts Draft Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/keywords": { "get": { "tags": [ "admin", "mail" ], "summary": "List Keywords", "operationId": "list_keywords_admin_mail_keywords_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Keywords Admin Mail Keywords Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "admin", "mail" ], "summary": "Add Keyword", "operationId": "add_keyword_admin_mail_keywords_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordAdd" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Keyword Admin Mail Keywords Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/keywords/{keyword_id}": { "patch": { "tags": [ "admin", "mail" ], "summary": "Patch Keyword", "operationId": "patch_keyword_admin_mail_keywords__keyword_id__patch", "parameters": [ { "name": "keyword_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Keyword Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Patch Keyword Admin Mail Keywords Keyword Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "admin", "mail" ], "summary": "Remove Keyword", "operationId": "remove_keyword_admin_mail_keywords__keyword_id__delete", "parameters": [ { "name": "keyword_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Keyword Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Keyword Admin Mail Keywords Keyword Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/global-blocklist": { "get": { "tags": [ "admin", "mail" ], "summary": "List Global Blocklist", "operationId": "list_global_blocklist_admin_mail_global_blocklist_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Global Blocklist Admin Mail Global Blocklist Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "admin", "mail" ], "summary": "Add Global Blocklist", "operationId": "add_global_blocklist_admin_mail_global_blocklist_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainAdd" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Global Blocklist Admin Mail Global Blocklist Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/global-blocklist/{entry_id}": { "delete": { "tags": [ "admin", "mail" ], "summary": "Remove Global Blocklist", "operationId": "remove_global_blocklist_admin_mail_global_blocklist__entry_id__delete", "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Entry Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Global Blocklist Admin Mail Global Blocklist Entry Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/nrd/status": { "get": { "tags": [ "admin", "mail" ], "summary": "Nrd Status", "operationId": "nrd_status_admin_mail_nrd_status_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Nrd Status Admin Mail Nrd Status Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/nrd/stats": { "get": { "tags": [ "admin", "mail" ], "summary": "Nrd Stats", "operationId": "nrd_stats_admin_mail_nrd_stats_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Nrd Stats Admin Mail Nrd Stats Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/nrd/imports": { "get": { "tags": [ "admin", "mail" ], "summary": "List Nrd Imports", "operationId": "list_nrd_imports_admin_mail_nrd_imports_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Nrd Imports Admin Mail Nrd Imports Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/nrd/imports/run": { "post": { "tags": [ "admin", "mail" ], "summary": "Run Nrd Import", "description": "Import the Whoisds NRD list — a specific date, else the daily default.\nRuns the blocking download/upsert off the event loop.", "operationId": "run_nrd_import_admin_mail_nrd_imports_run_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NrdRun" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Run Nrd Import Admin Mail Nrd Imports Run Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/stalwart/health": { "get": { "tags": [ "admin", "mail" ], "summary": "Stalwart Health", "operationId": "stalwart_health_admin_mail_stalwart_health_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Stalwart Health Admin Mail Stalwart Health Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/stalwart/queue": { "get": { "tags": [ "admin", "mail" ], "summary": "Stalwart Queue", "operationId": "stalwart_queue_admin_mail_stalwart_queue_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Stalwart Queue Admin Mail Stalwart Queue Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/stalwart/queue/{message_id}": { "get": { "tags": [ "admin", "mail" ], "summary": "Stalwart Queue Message", "operationId": "stalwart_queue_message_admin_mail_stalwart_queue__message_id__get", "parameters": [ { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Message Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Stalwart Queue Message Admin Mail Stalwart Queue Message Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "admin", "mail" ], "summary": "Stalwart Queue Cancel", "operationId": "stalwart_queue_cancel_admin_mail_stalwart_queue__message_id__delete", "parameters": [ { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Message Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Stalwart Queue Cancel Admin Mail Stalwart Queue Message Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/stalwart/blocked-ips": { "get": { "tags": [ "admin", "mail" ], "summary": "Stalwart Blocked Ips", "operationId": "stalwart_blocked_ips_admin_mail_stalwart_blocked_ips_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Stalwart Blocked Ips Admin Mail Stalwart Blocked Ips Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/stalwart/allowed-ips": { "get": { "tags": [ "admin", "mail" ], "summary": "Stalwart Allowed Ips", "description": "Allowlist + integrity check (are the required Docker subnets still on it?).", "operationId": "stalwart_allowed_ips_admin_mail_stalwart_allowed_ips_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Stalwart Allowed Ips Admin Mail Stalwart Allowed Ips Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/stalwart/queue/{message_id}/retry": { "post": { "tags": [ "admin", "mail" ], "summary": "Stalwart Queue Retry", "operationId": "stalwart_queue_retry_admin_mail_stalwart_queue__message_id__retry_post", "parameters": [ { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Message Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Stalwart Queue Retry Admin Mail Stalwart Queue Message Id Retry Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/mail/stalwart/blocked-ips/{ip}": { "delete": { "tags": [ "admin", "mail" ], "summary": "Stalwart Unblock Ip", "description": "Remove one banned IP from Stalwart's config.\n\nReturns a ``caveat`` the UI must show: the delete clears the *persistent*\nban, but a live in-memory ban may survive until a Stalwart reload/restart\n(learned during the 502 incident). The durable fix is the allowlist, not\nrepeated unblocks.", "operationId": "stalwart_unblock_ip_admin_mail_stalwart_blocked_ips__ip__delete", "parameters": [ { "name": "ip", "in": "path", "required": true, "schema": { "type": "string", "title": "Ip" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Stalwart Unblock Ip Admin Mail Stalwart Blocked Ips Ip Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/conversations": { "get": { "tags": [ "chat" ], "summary": "List Conversations", "description": "The viewer's conversations, newest-active first, with an unread flag.", "operationId": "list_conversations_chat_conversations_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Conversations Chat Conversations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "chat" ], "summary": "Create Conversation", "description": "Open a DM (1 other user, deduped) or create a group (N others).", "operationId": "create_conversation_chat_conversations_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Conversation Chat Conversations Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/conversations/{conv_id}": { "get": { "tags": [ "chat" ], "summary": "Get Conversation", "operationId": "get_conversation_chat_conversations__conv_id__get", "parameters": [ { "name": "conv_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conv Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Conversation Chat Conversations Conv Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/conversations/{conv_id}/read": { "post": { "tags": [ "chat" ], "summary": "Mark Read", "operationId": "mark_read_chat_conversations__conv_id__read_post", "parameters": [ { "name": "conv_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conv Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Mark Read Chat Conversations Conv Id Read Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/conversations/{conv_id}/leave": { "post": { "tags": [ "chat" ], "summary": "Leave Conversation", "description": "Leave a conversation. If it becomes empty, it's destroyed and its\nmessages, read cursors, and attachments are cascaded away.", "operationId": "leave_conversation_chat_conversations__conv_id__leave_post", "parameters": [ { "name": "conv_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conv Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Leave Conversation Chat Conversations Conv Id Leave Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/unread-count": { "get": { "tags": [ "chat" ], "summary": "Unread Count", "description": "Number of conversations with unread messages (the nav badge).", "operationId": "unread_count_chat_unread_count_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Unread Count Chat Unread Count Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/conversations/{conv_id}/messages": { "get": { "tags": [ "chat" ], "summary": "List Messages", "description": "Cursor window of messages as a diff.\n\n- ``before`` → older history (scroll-up); ``new`` carries the older page,\n ``has_more`` reports whether yet-older messages exist.\n- ``after`` → live incremental poll; ``new`` carries messages newer than\n the cursor and ``since`` (if given) yields the ``changed`` set (edits +\n tombstones) so already-rendered bubbles can be patched.\n- neither → initial load; ``new`` is the latest page, ``has_more`` reports\n whether older history exists.", "operationId": "list_messages_chat_conversations__conv_id__messages_get", "parameters": [ { "name": "conv_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conv Id" } }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Before" } }, { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Messages Chat Conversations Conv Id Messages Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "chat" ], "summary": "Send Message", "operationId": "send_message_chat_conversations__conv_id__messages_post", "parameters": [ { "name": "conv_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conv Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Send Message Chat Conversations Conv Id Messages Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/messages/{msg_id}": { "patch": { "tags": [ "chat" ], "summary": "Edit Message", "operationId": "edit_message_chat_messages__msg_id__patch", "parameters": [ { "name": "msg_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Msg Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageEdit" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Edit Message Chat Messages Msg Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "chat" ], "summary": "Delete Message", "operationId": "delete_message_chat_messages__msg_id__delete", "parameters": [ { "name": "msg_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Msg Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Message Chat Messages Msg Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/conversations/{conv_id}/attachments": { "post": { "tags": [ "chat" ], "summary": "Upload Attachment", "operationId": "upload_attachment_chat_conversations__conv_id__attachments_post", "parameters": [ { "name": "conv_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conv Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_attachment_chat_conversations__conv_id__attachments_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Upload Attachment Chat Conversations Conv Id Attachments Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/attachments/{attachment_id}/download": { "get": { "tags": [ "chat" ], "summary": "Download Attachment", "operationId": "download_attachment_chat_attachments__attachment_id__download_get", "parameters": [ { "name": "attachment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Attachment Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/attachments/{attachment_id}": { "delete": { "tags": [ "chat" ], "summary": "Delete Attachment", "description": "Remove a chat attachment (uploader-only) — e.g. an uploaded file the\nuser decides not to send.", "operationId": "delete_attachment_chat_attachments__attachment_id__delete", "parameters": [ { "name": "attachment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Attachment Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Attachment Chat Attachments Attachment Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/accounts": { "get": { "tags": [ "accounting" ], "summary": "List Accounts", "operationId": "list_accounts_accounting_accounts_get", "parameters": [ { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "name": "active_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Active Only" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Accounts Accounting Accounts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "accounting" ], "summary": "Create Account", "operationId": "create_account_accounting_accounts_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Account Accounting Accounts Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/accounts/{account_id}": { "patch": { "tags": [ "accounting" ], "summary": "Update Account", "operationId": "update_account_accounting_accounts__account_id__patch", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Account Accounting Accounts Account Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "accounting" ], "summary": "Delete Account", "operationId": "delete_account_accounting_accounts__account_id__delete", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Account Accounting Accounts Account Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/accounts/sync-defaults": { "post": { "tags": [ "accounting" ], "summary": "Sync Default Accounts", "description": "Add any default (template) accounts missing from the user's chart.\n\nIdempotent — backfills newly-shipped default accounts (e.g. the IT-ZZP\ncost accounts) into an already-seeded chart without touching existing ones.", "operationId": "sync_default_accounts_accounting_accounts_sync_defaults_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Sync Default Accounts Accounting Accounts Sync Defaults Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/btw-codes": { "get": { "tags": [ "accounting" ], "summary": "List Btw Codes", "operationId": "list_btw_codes_accounting_btw_codes_get", "parameters": [ { "name": "active_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Active Only" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Btw Codes Accounting Btw Codes Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/btw-codes/{btw_id}": { "patch": { "tags": [ "accounting" ], "summary": "Update Btw Code", "operationId": "update_btw_code_accounting_btw_codes__btw_id__patch", "parameters": [ { "name": "btw_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Btw Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BtwCodeUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Btw Code Accounting Btw Codes Btw Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/profile": { "get": { "tags": [ "accounting" ], "summary": "Get Profile", "operationId": "get_profile_accounting_profile_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Profile Accounting Profile Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "accounting" ], "summary": "Put Profile", "operationId": "put_profile_accounting_profile_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Put Profile Accounting Profile Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/journal": { "get": { "tags": [ "accounting" ], "summary": "List Journal", "operationId": "list_journal_accounting_journal_get", "parameters": [ { "name": "dagboek", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dagboek" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date From" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date To" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Journal Accounting Journal Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "accounting" ], "summary": "Create Journal Entry", "description": "Post a manual journaalpost (a *memoriaal* booking by default).", "operationId": "create_journal_entry_accounting_journal_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Journal Entry Accounting Journal Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/journal/{entry_id}": { "get": { "tags": [ "accounting" ], "summary": "Get Journal Entry", "operationId": "get_journal_entry_accounting_journal__entry_id__get", "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Entry Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Journal Entry Accounting Journal Entry Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/journal/{entry_id}/reverse": { "post": { "tags": [ "accounting" ], "summary": "Reverse Journal Entry", "description": "Post a reversing entry (correctie / creditnota) for a journaalpost.", "operationId": "reverse_journal_entry_accounting_journal__entry_id__reverse_post", "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Entry Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReverseIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Reverse Journal Entry Accounting Journal Entry Id Reverse Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/ledger/{account_id}": { "get": { "tags": [ "accounting" ], "summary": "Account Ledger", "description": "Every posting line touching an account, with a running saldo.", "operationId": "account_ledger_accounting_ledger__account_id__get", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date From" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date To" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Account Ledger Accounting Ledger Account Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/reports/btw": { "get": { "tags": [ "accounting" ], "summary": "Report Btw", "description": "Quarterly BTW-aangifte figures (rubrieken 1a/1b/1e/4b, 5a, 5b).", "operationId": "report_btw_accounting_reports_btw_get", "parameters": [ { "name": "year", "in": "query", "required": true, "schema": { "type": "integer", "title": "Year" } }, { "name": "quarter", "in": "query", "required": true, "schema": { "type": "integer", "maximum": 4, "minimum": 1, "title": "Quarter" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Report Btw Accounting Reports Btw Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/reports/trial-balance": { "get": { "tags": [ "accounting" ], "summary": "Report Trial Balance", "operationId": "report_trial_balance_accounting_reports_trial_balance_get", "parameters": [ { "name": "date_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date To" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Report Trial Balance Accounting Reports Trial Balance Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/reports/profit-loss": { "get": { "tags": [ "accounting" ], "summary": "Report Profit Loss", "operationId": "report_profit_loss_accounting_reports_profit_loss_get", "parameters": [ { "name": "year", "in": "query", "required": true, "schema": { "type": "integer", "title": "Year" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Report Profit Loss Accounting Reports Profit Loss Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/reports/balance": { "get": { "tags": [ "accounting" ], "summary": "Report Balance", "operationId": "report_balance_accounting_reports_balance_get", "parameters": [ { "name": "date_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date To" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Report Balance Accounting Reports Balance Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounting/reports/open-items": { "get": { "tags": [ "accounting" ], "summary": "Report Open Items", "operationId": "report_open_items_accounting_reports_open_items_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Report Open Items Accounting Reports Open Items Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/invoices": { "get": { "tags": [ "accounting", "invoices" ], "summary": "List Invoices", "operationId": "list_invoices_invoices_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "customer_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Invoices Invoices Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "accounting", "invoices" ], "summary": "Create Invoice", "operationId": "create_invoice_invoices_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Invoice Invoices Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/invoices/{invoice_id}": { "get": { "tags": [ "accounting", "invoices" ], "summary": "Get Invoice", "operationId": "get_invoice_invoices__invoice_id__get", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Invoice Invoices Invoice Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "accounting", "invoices" ], "summary": "Update Invoice", "operationId": "update_invoice_invoices__invoice_id__patch", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Invoice Invoices Invoice Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "accounting", "invoices" ], "summary": "Delete Invoice", "operationId": "delete_invoice_invoices__invoice_id__delete", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Invoice Invoices Invoice Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/invoices/{invoice_id}/preview": { "get": { "tags": [ "accounting", "invoices" ], "summary": "Preview Invoice", "description": "Print-friendly HTML of the invoice (same template as the PDF).\n\nWorks on any host (no native deps) — the frontend embeds it and the browser\ncan print-to-PDF as a fallback. A draft resolves its bill-to on the fly.", "operationId": "preview_invoice_invoices__invoice_id__preview_get", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "text/html": { "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/invoices/{invoice_id}/pdf": { "get": { "tags": [ "accounting", "invoices" ], "summary": "Invoice Pdf", "description": "The invoice as a PDF (WeasyPrint). 501 if the host lacks the native libs\n(production has them) — use the print-friendly preview in that case.", "operationId": "invoice_pdf_invoices__invoice_id__pdf_get", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/invoices/{invoice_id}/email": { "post": { "tags": [ "accounting", "invoices" ], "summary": "Email Invoice", "description": "E-mail the invoice PDF to the customer via the user's own SMTP.\n\nOnly finalized invoices (status ``sent``/``paid``) can be e-mailed — a\ndraft has no number and no booked journaalpost. Sending stamps\n``emailed_at``/``emailed_to`` (distinct from status ``sent``, which means\nfinalized) and logs an activity on the customer's timeline. The\nSent-folder copy is best-effort.", "operationId": "email_invoice_invoices__invoice_id__email_post", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceEmailRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Email Invoice Invoices Invoice Id Email Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/invoices/{invoice_id}/finalize": { "post": { "tags": [ "accounting", "invoices" ], "summary": "Finalize Invoice", "operationId": "finalize_invoice_invoices__invoice_id__finalize_post", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Finalize Invoice Invoices Invoice Id Finalize Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/invoices/{invoice_id}/payment": { "post": { "tags": [ "accounting", "invoices" ], "summary": "Register Payment", "operationId": "register_payment_invoices__invoice_id__payment_post", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Register Payment Invoices Invoice Id Payment Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/invoices/{invoice_id}/credit": { "post": { "tags": [ "accounting", "invoices" ], "summary": "Credit Invoice", "operationId": "credit_invoice_invoices__invoice_id__credit_post", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Credit Invoice Invoices Invoice Id Credit Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/expenses": { "get": { "tags": [ "accounting", "expenses" ], "summary": "List Expenses", "operationId": "list_expenses_expenses_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "supplier_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Supplier Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Expenses Expenses Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "accounting", "expenses" ], "summary": "Create Expense", "operationId": "create_expense_expenses_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Expense Expenses Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/expenses/capture": { "post": { "tags": [ "accounting", "expenses" ], "summary": "Capture Expense", "description": "Upload a receipt (image or PDF) → prefilled draft expense with the receipt\nattached. Digital PDFs read their text layer (no OCR); images/scans use\ntesseract (501 when it's not installed).", "operationId": "capture_expense_expenses_capture_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_capture_expense_expenses_capture_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Capture Expense Expenses Capture Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/expenses/capture-from-email": { "post": { "tags": [ "accounting", "expenses" ], "summary": "Capture Expense From Email", "description": "Capture a receipt straight from an email attachment (PDF/image) — the\ncommon path for emailed invoices — into a prefilled draft expense.", "operationId": "capture_expense_from_email_expenses_capture_from_email_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureFromEmailIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Capture Expense From Email Expenses Capture From Email Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/expenses/{expense_id}": { "get": { "tags": [ "accounting", "expenses" ], "summary": "Get Expense", "operationId": "get_expense_expenses__expense_id__get", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Expense Expenses Expense Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "accounting", "expenses" ], "summary": "Update Expense", "operationId": "update_expense_expenses__expense_id__patch", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Expense Expenses Expense Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "accounting", "expenses" ], "summary": "Delete Expense", "operationId": "delete_expense_expenses__expense_id__delete", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Expense Expenses Expense Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/expenses/{expense_id}/book": { "post": { "tags": [ "accounting", "expenses" ], "summary": "Book Expense", "operationId": "book_expense_expenses__expense_id__book_post", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Book Expense Expenses Expense Id Book Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/expenses/{expense_id}/payment": { "post": { "tags": [ "accounting", "expenses" ], "summary": "Register Payment", "operationId": "register_payment_expenses__expense_id__payment_post", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Register Payment Expenses Expense Id Payment Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/expenses/{expense_id}/credit": { "post": { "tags": [ "accounting", "expenses" ], "summary": "Credit Expense", "operationId": "credit_expense_expenses__expense_id__credit_post", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Credit Expense Expenses Expense Id Credit Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/personal-expenses": { "get": { "tags": [ "personal" ], "summary": "List Personal Expenses", "operationId": "list_personal_expenses_personal_expenses_get", "parameters": [ { "name": "paid", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Paid" } }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "linked", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Linked" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Personal Expenses Personal Expenses Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "personal" ], "summary": "Create Personal Expense", "operationId": "create_personal_expense_personal_expenses_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalExpenseCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Personal Expense Personal Expenses Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/personal-expenses/categories": { "get": { "tags": [ "personal" ], "summary": "List Categories", "operationId": "list_categories_personal_expenses_categories_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Categories Personal Expenses Categories Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/personal-expenses/summary": { "get": { "tags": [ "personal" ], "summary": "Personal Summary", "operationId": "personal_summary_personal_expenses_summary_get", "parameters": [ { "name": "year", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Year" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Personal Summary Personal Expenses Summary Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/personal-expenses/capture": { "post": { "tags": [ "personal" ], "summary": "Capture Personal", "description": "Upload a receipt (image or PDF) → prefilled personal record with the\nreceipt attached. Digital PDFs read their text layer (no OCR); images/scans\nuse tesseract (501 when it's not installed).", "operationId": "capture_personal_personal_expenses_capture_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_capture_personal_personal_expenses_capture_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Capture Personal Personal Expenses Capture Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/personal-expenses/capture-from-email": { "post": { "tags": [ "personal" ], "summary": "Capture Personal From Email", "description": "Capture a receipt straight from an email attachment (PDF/image) into a\nprefilled personal record, and tag the source email ``personal``.", "operationId": "capture_personal_from_email_personal_expenses_capture_from_email_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureFromEmailIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Capture Personal From Email Personal Expenses Capture From Email Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/personal-expenses/{expense_id}": { "get": { "tags": [ "personal" ], "summary": "Get Personal Expense", "operationId": "get_personal_expense_personal_expenses__expense_id__get", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Personal Expense Personal Expenses Expense Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "personal" ], "summary": "Update Personal Expense", "operationId": "update_personal_expense_personal_expenses__expense_id__patch", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalExpenseUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Personal Expense Personal Expenses Expense Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "personal" ], "summary": "Delete Personal Expense", "operationId": "delete_personal_expense_personal_expenses__expense_id__delete", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Personal Expense Personal Expenses Expense Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/personal-expenses/{expense_id}/paid": { "post": { "tags": [ "personal" ], "summary": "Set Personal Paid", "operationId": "set_personal_paid_personal_expenses__expense_id__paid_post", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaidIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Personal Paid Personal Expenses Expense Id Paid Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/import": { "post": { "tags": [ "bank" ], "summary": "Import Bank Statement", "description": "Upload a CAMT.053 (XML) or bank CSV statement → deduped bank transactions on\nthe matching account (created by IBAN on first sight).", "operationId": "import_bank_statement_bank_import_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_bank_statement_bank_import_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Import Bank Statement Bank Import Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/accounts": { "get": { "tags": [ "bank" ], "summary": "List Bank Accounts", "operationId": "list_bank_accounts_bank_accounts_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Bank Accounts Bank Accounts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "bank" ], "summary": "Create Bank Account", "operationId": "create_bank_account_bank_accounts_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Bank Account Bank Accounts Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/accounts/{account_id}": { "patch": { "tags": [ "bank" ], "summary": "Update Bank Account", "operationId": "update_bank_account_bank_accounts__account_id__patch", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Bank Account Bank Accounts Account Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "bank" ], "summary": "Delete Bank Account", "operationId": "delete_bank_account_bank_accounts__account_id__delete", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Bank Account Bank Accounts Account Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/accounts/{account_id}/set-default": { "post": { "tags": [ "bank" ], "summary": "Set Default Bank Account", "operationId": "set_default_bank_account_bank_accounts__account_id__set_default_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Default Bank Account Bank Accounts Account Id Set Default Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/transactions": { "get": { "tags": [ "bank" ], "summary": "List Transactions", "operationId": "list_transactions_bank_transactions_get", "parameters": [ { "name": "account", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Transactions Bank Transactions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/transactions/{txn_id}/match": { "post": { "tags": [ "bank" ], "summary": "Match Transaction", "operationId": "match_transaction_bank_transactions__txn_id__match_post", "parameters": [ { "name": "txn_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Txn Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Match Transaction Bank Transactions Txn Id Match Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/transactions/{txn_id}/unmatch": { "post": { "tags": [ "bank" ], "summary": "Unmatch Transaction", "operationId": "unmatch_transaction_bank_transactions__txn_id__unmatch_post", "parameters": [ { "name": "txn_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Txn Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Unmatch Transaction Bank Transactions Txn Id Unmatch Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/budget-summary": { "get": { "tags": [ "bank" ], "summary": "Budget Summary", "description": "Income/expense rollup for the Budget view. ``from`` is inclusive, ``to``\nexclusive. ``kind`` (business|personal) scopes to every account of that kind;\n``account`` scopes to one. Excluded rows (incl. detected transfers) are omitted.", "operationId": "budget_summary_bank_budget_summary_get", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "To" } }, { "name": "account", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account" } }, { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kind" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Budget Summary Bank Budget Summary Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/transactions/{txn_id}": { "patch": { "tags": [ "bank" ], "summary": "Patch Transaction", "description": "Set the budgeting dimension on a transaction (category / exclude / note).\nIndependent of reconciliation — never touches ``match``/``status``.", "operationId": "patch_transaction_bank_transactions__txn_id__patch", "parameters": [ { "name": "txn_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Txn Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TxnPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Patch Transaction Bank Transactions Txn Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/categories": { "get": { "tags": [ "bank" ], "summary": "List Categories", "operationId": "list_categories_bank_categories_get", "parameters": [ { "name": "include_archived", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Archived" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Categories Bank Categories Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "bank" ], "summary": "Create Category", "operationId": "create_category_bank_categories_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Category Bank Categories Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/categories/{category_id}": { "patch": { "tags": [ "bank" ], "summary": "Update Category", "operationId": "update_category_bank_categories__category_id__patch", "parameters": [ { "name": "category_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Category Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Category Bank Categories Category Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "bank" ], "summary": "Delete Category", "operationId": "delete_category_bank_categories__category_id__delete", "parameters": [ { "name": "category_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Category Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Category Bank Categories Category Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/rules/preview": { "post": { "tags": [ "bank" ], "summary": "Preview Rule", "description": "Count how many existing transactions a rule with these conditions would\nmatch — powers the live \"past op N transacties\" hint before saving.", "operationId": "preview_rule_bank_rules_preview_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulePreviewIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Preview Rule Bank Rules Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/rules": { "get": { "tags": [ "bank" ], "summary": "List Rules", "operationId": "list_rules_bank_rules_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Rules Bank Rules Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "bank" ], "summary": "Create Rule", "operationId": "create_rule_bank_rules_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routers__bank__RuleIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Rule Bank Rules Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/rules/{rule_id}": { "patch": { "tags": [ "bank" ], "summary": "Update Rule", "operationId": "update_rule_bank_rules__rule_id__patch", "parameters": [ { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Rule Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulePatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Rule Bank Rules Rule Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "bank" ], "summary": "Delete Rule", "operationId": "delete_rule_bank_rules__rule_id__delete", "parameters": [ { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Rule Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Rule Bank Rules Rule Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/rules/reorder": { "post": { "tags": [ "bank" ], "summary": "Reorder Rules", "operationId": "reorder_rules_bank_rules_reorder_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Reorder Rules Bank Rules Reorder Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/rules/apply": { "post": { "tags": [ "bank" ], "summary": "Apply Rules", "description": "Retroactively run transfer detection + rules over every account's\nstill-uncategorised rows.", "operationId": "apply_rules_bank_rules_apply_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Apply Rules Bank Rules Apply Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/rules/from-transaction": { "post": { "tags": [ "bank" ], "summary": "Rule From Transaction", "description": "'Categorize like this…' — build a rule from a transaction's counterparty /\nIBAN / description, then apply it across all accounts.", "operationId": "rule_from_transaction_bank_rules_from_transaction_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleFromTxnIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Rule From Transaction Bank Rules From Transaction Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/targets": { "get": { "tags": [ "bank" ], "summary": "List Targets", "operationId": "list_targets_bank_targets_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Targets Bank Targets Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "bank" ], "summary": "Set Target", "description": "Set the monthly target for a category (upsert — one target per category).", "operationId": "set_target_bank_targets_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Target Bank Targets Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/targets/{target_id}": { "patch": { "tags": [ "bank" ], "summary": "Update Target", "operationId": "update_target_bank_targets__target_id__patch", "parameters": [ { "name": "target_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Target Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Target Bank Targets Target Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "bank" ], "summary": "Delete Target", "operationId": "delete_target_bank_targets__target_id__delete", "parameters": [ { "name": "target_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Target Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Target Bank Targets Target Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/institutions": { "get": { "tags": [ "bank" ], "summary": "List Institutions", "operationId": "list_institutions_bank_institutions_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Institutions Bank Institutions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/connections": { "get": { "tags": [ "bank" ], "summary": "List Connections", "operationId": "list_connections_bank_connections_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Connections Bank Connections Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "bank" ], "summary": "Create Connection", "operationId": "create_connection_bank_connections_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Connection Bank Connections Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/connections/{connection_id}/finalize": { "post": { "tags": [ "bank" ], "summary": "Finalize Connection", "description": "Called after the user returns from bank consent: read the granted accounts\nand create a bank_account (business by default) for each.", "operationId": "finalize_connection_bank_connections__connection_id__finalize_post", "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Connection Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Finalize Connection Bank Connections Connection Id Finalize Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/connections/{connection_id}": { "delete": { "tags": [ "bank" ], "summary": "Delete Connection", "operationId": "delete_connection_bank_connections__connection_id__delete", "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Connection Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Connection Bank Connections Connection Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bank/accounts/{account_id}/sync": { "post": { "tags": [ "bank" ], "summary": "Sync Account Now", "operationId": "sync_account_now_bank_accounts__account_id__sync_post", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Sync Account Now Bank Accounts Account Id Sync Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/dashboard": { "get": { "tags": [ "dashboard" ], "summary": "Get Dashboard", "description": "One aggregated payload for the home dashboard.", "operationId": "get_dashboard_dashboard_get", "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 60, "minimum": 1, "default": 7, "title": "Days" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "kancil_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kancil Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Dashboard Dashboard Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/": { "get": { "summary": "Root", "operationId": "root__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/health/": { "get": { "tags": [ "health" ], "summary": "Health", "operationId": "health_health__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } } }, "components": { "schemas": { "AccountCreate": { "properties": { "code": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Code" }, "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "type": { "type": "string", "title": "Type" }, "category": { "type": "string", "title": "Category" }, "btw_code_default": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Btw Code Default" }, "rgs_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rgs Code" } }, "type": "object", "required": [ "code", "name", "type", "category" ], "title": "AccountCreate" }, "AccountUpdate": { "properties": { "code": { "anyOf": [ { "type": "string", "maxLength": 20, "minLength": 1 }, { "type": "null" } ], "title": "Code" }, "name": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "btw_code_default": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Btw Code Default" }, "rgs_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rgs Code" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" } }, "type": "object", "title": "AccountUpdate" }, "ActivityCreate": { "properties": { "type": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Type" }, "subject": { "type": "string", "maxLength": 400, "minLength": 1, "title": "Subject" }, "body_md": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body Md" }, "occurred_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Occurred At" }, "duration_minutes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Duration Minutes" }, "outcome": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Outcome" }, "tag_ids": { "items": { "type": "string" }, "type": "array", "title": "Tag Ids" }, "links": { "items": { "$ref": "#/components/schemas/EntityRefIn" }, "type": "array", "title": "Links" } }, "type": "object", "required": [ "type", "subject" ], "title": "ActivityCreate" }, "ActivityUpdate": { "properties": { "type": { "anyOf": [ { "type": "string", "maxLength": 40, "minLength": 1 }, { "type": "null" } ], "title": "Type" }, "subject": { "anyOf": [ { "type": "string", "maxLength": 400, "minLength": 1 }, { "type": "null" } ], "title": "Subject" }, "body_md": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body Md" }, "occurred_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Occurred At" }, "duration_minutes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Duration Minutes" }, "outcome": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Outcome" }, "tag_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tag Ids" } }, "type": "object", "title": "ActivityUpdate" }, "AddressBookSelection": { "properties": { "urls": { "items": { "type": "string" }, "type": "array", "title": "Urls" } }, "type": "object", "title": "AddressBookSelection" }, "AddressIn": { "properties": { "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "street": { "type": "string", "title": "Street", "default": "" }, "city": { "type": "string", "title": "City", "default": "" }, "region": { "type": "string", "title": "Region", "default": "" }, "code": { "type": "string", "title": "Code", "default": "" }, "country": { "type": "string", "title": "Country", "default": "" }, "extended": { "type": "string", "title": "Extended", "default": "" }, "box": { "type": "string", "title": "Box", "default": "" } }, "type": "object", "title": "AddressIn" }, "AdminPasswordResetPayload": { "properties": { "new_password": { "type": "string", "minLength": 8, "title": "New Password" } }, "type": "object", "required": [ "new_password" ], "title": "AdminPasswordResetPayload" }, "BankAccountCreate": { "properties": { "iban": { "type": "string", "minLength": 5, "title": "Iban" }, "account_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Name" }, "bank_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bank Name" }, "kind": { "type": "string", "title": "Kind", "default": "business" } }, "type": "object", "required": [ "iban" ], "title": "BankAccountCreate" }, "BankAccountPatch": { "properties": { "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kind" }, "ledger_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ledger Account Id" }, "account_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Name" }, "bank_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bank Name" } }, "type": "object", "title": "BankAccountPatch" }, "BillingAddress": { "properties": { "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Street" }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" } }, "type": "object", "title": "BillingAddress" }, "BlocklistAdd": { "properties": { "value": { "type": "string", "maxLength": 320, "minLength": 1, "title": "Value" } }, "type": "object", "required": [ "value" ], "title": "BlocklistAdd" }, "Body_capture_expense_expenses_capture_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_capture_expense_expenses_capture_post" }, "Body_capture_personal_personal_expenses_capture_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_capture_personal_personal_expenses_capture_post" }, "Body_import_bank_statement_bank_import_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_import_bank_statement_bank_import_post" }, "Body_stage_attachment_mail_attachments_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_stage_attachment_mail_attachments_post" }, "Body_upload_attachment_chat_conversations__conv_id__attachments_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_attachment_chat_conversations__conv_id__attachments_post" }, "Body_upload_attachments_post": { "properties": { "entity_type": { "type": "string", "enum": [ "task", "project", "contact", "event", "company", "deal", "note", "invoice", "expense", "personal_expense" ], "title": "Entity Type" }, "entity_id": { "type": "string", "title": "Entity Id" }, "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "entity_type", "entity_id", "file" ], "title": "Body_upload_attachments_post" }, "BtwCodeUpdate": { "properties": { "label": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Label" }, "rate_bp": { "anyOf": [ { "type": "integer", "maximum": 10000, "minimum": 0 }, { "type": "null" } ], "title": "Rate Bp" }, "aangifte_box": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Aangifte Box" }, "payable_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payable Account Id" }, "deductible_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deductible Account Id" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" } }, "type": "object", "title": "BtwCodeUpdate" }, "BulkRequest": { "properties": { "task_ids": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "Task Ids" }, "action": { "type": "string", "enum": [ "complete", "reopen", "delete", "restore", "set_status", "set_priority", "add_tag", "remove_tag", "move" ], "title": "Action" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "tag_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tag Id" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, "type": "object", "required": [ "task_ids", "action" ], "title": "BulkRequest" }, "CalDavAccountIn": { "properties": { "server_url": { "type": "string", "minLength": 1, "title": "Server Url" }, "username": { "type": "string", "minLength": 1, "title": "Username" }, "password": { "type": "string", "minLength": 1, "title": "Password" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" } }, "type": "object", "required": [ "server_url", "username", "password" ], "title": "CalDavAccountIn" }, "CalDavCredentials": { "properties": { "server_url": { "type": "string", "minLength": 1, "title": "Server Url" }, "username": { "type": "string", "minLength": 1, "title": "Username" }, "password": { "type": "string", "minLength": 1, "title": "Password" } }, "type": "object", "required": [ "server_url", "username", "password" ], "title": "CalDavCredentials" }, "CalendarSelection": { "properties": { "urls": { "items": { "type": "string" }, "type": "array", "title": "Urls" } }, "type": "object", "title": "CalendarSelection" }, "CaptureFromEmailIn": { "properties": { "email_id": { "type": "string", "minLength": 1, "title": "Email Id" }, "part_id": { "type": "string", "minLength": 1, "title": "Part Id" } }, "type": "object", "required": [ "email_id", "part_id" ], "title": "CaptureFromEmailIn" }, "CardDavAccountIn": { "properties": { "server_url": { "type": "string", "minLength": 1, "title": "Server Url" }, "username": { "type": "string", "minLength": 1, "title": "Username" }, "password": { "type": "string", "minLength": 1, "title": "Password" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" } }, "type": "object", "required": [ "server_url", "username", "password" ], "title": "CardDavAccountIn" }, "CardDavCredentials": { "properties": { "server_url": { "type": "string", "minLength": 1, "title": "Server Url" }, "username": { "type": "string", "minLength": 1, "title": "Username" }, "password": { "type": "string", "minLength": 1, "title": "Password" } }, "type": "object", "required": [ "server_url", "username", "password" ], "title": "CardDavCredentials" }, "CategoryIn": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name" }, "kind": { "type": "string", "title": "Kind", "default": "expense" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" } }, "type": "object", "required": [ "name" ], "title": "CategoryIn" }, "CategoryPatch": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kind" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Archived" }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" } }, "type": "object", "title": "CategoryPatch" }, "CommentCreate": { "properties": { "entity_type": { "type": "string", "enum": [ "task", "project", "contact", "event", "company", "deal" ], "title": "Entity Type" }, "entity_id": { "type": "string", "minLength": 1, "title": "Entity Id" }, "body": { "type": "string", "maxLength": 20000, "minLength": 1, "title": "Body" }, "mentions": { "items": { "type": "string" }, "type": "array", "title": "Mentions" } }, "type": "object", "required": [ "entity_type", "entity_id", "body" ], "title": "CommentCreate" }, "CommentUpdate": { "properties": { "body": { "type": "string", "maxLength": 20000, "minLength": 1, "title": "Body" }, "mentions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Mentions" } }, "type": "object", "required": [ "body" ], "title": "CommentUpdate" }, "CompanyCreate": { "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry" }, "size": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Size" }, "description": { "anyOf": [ { "type": "string", "maxLength": 400 }, { "type": "null" } ], "title": "Description" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "vat_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vat Number" }, "kvk_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kvk Number" }, "iban": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Iban" }, "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/BillingAddress" }, { "type": "null" } ] }, "notes_md": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes Md" }, "tag_ids": { "items": { "type": "string" }, "type": "array", "title": "Tag Ids" } }, "type": "object", "required": [ "name" ], "title": "CompanyCreate" }, "CompanyUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry" }, "size": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Size" }, "description": { "anyOf": [ { "type": "string", "maxLength": 400 }, { "type": "null" } ], "title": "Description" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "vat_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vat Number" }, "kvk_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kvk Number" }, "iban": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Iban" }, "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/BillingAddress" }, { "type": "null" } ] }, "notes_md": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes Md" }, "tag_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tag Ids" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Custom Fields" } }, "type": "object", "title": "CompanyUpdate" }, "ConnectionIn": { "properties": { "institution_id": { "type": "string", "minLength": 1, "title": "Institution Id" }, "institution_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Institution Name" } }, "type": "object", "required": [ "institution_id" ], "title": "ConnectionIn" }, "ContactCreateIn": { "properties": { "name": { "$ref": "#/components/schemas/NameIn" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "organization": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "emails": { "items": { "$ref": "#/components/schemas/TypedValueIn" }, "type": "array", "title": "Emails" }, "phones": { "items": { "$ref": "#/components/schemas/TypedValueIn" }, "type": "array", "title": "Phones" }, "urls": { "items": { "$ref": "#/components/schemas/TypedValueIn" }, "type": "array", "title": "Urls" }, "addresses": { "items": { "$ref": "#/components/schemas/AddressIn" }, "type": "array", "title": "Addresses" }, "birthday": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Birthday" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "categories": { "items": { "type": "string" }, "type": "array", "title": "Categories" }, "languages": { "items": { "type": "string" }, "type": "array", "title": "Languages" }, "addressbook_id": { "type": "string", "title": "Addressbook Id" } }, "type": "object", "required": [ "addressbook_id" ], "title": "ContactCreateIn" }, "ContactWriteIn": { "properties": { "name": { "$ref": "#/components/schemas/NameIn" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "organization": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "emails": { "items": { "$ref": "#/components/schemas/TypedValueIn" }, "type": "array", "title": "Emails" }, "phones": { "items": { "$ref": "#/components/schemas/TypedValueIn" }, "type": "array", "title": "Phones" }, "urls": { "items": { "$ref": "#/components/schemas/TypedValueIn" }, "type": "array", "title": "Urls" }, "addresses": { "items": { "$ref": "#/components/schemas/AddressIn" }, "type": "array", "title": "Addresses" }, "birthday": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Birthday" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "categories": { "items": { "type": "string" }, "type": "array", "title": "Categories" }, "languages": { "items": { "type": "string" }, "type": "array", "title": "Languages" } }, "type": "object", "title": "ContactWriteIn" }, "ConversationCreate": { "properties": { "participants": { "items": { "type": "string" }, "type": "array", "title": "Participants" }, "title": { "type": "string", "maxLength": 200, "title": "Title", "default": "" } }, "type": "object", "title": "ConversationCreate" }, "CreateUserPayload": { "properties": { "username": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Username" }, "password": { "type": "string", "minLength": 8, "title": "Password" }, "role": { "type": "string", "title": "Role", "default": "viewer" } }, "type": "object", "required": [ "username", "password" ], "title": "CreateUserPayload" }, "CreditIn": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date" } }, "type": "object", "title": "CreditIn" }, "CustomFieldCreate": { "properties": { "entity_type": { "type": "string", "enum": [ "project", "company", "deal", "task" ], "title": "Entity Type" }, "key": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-z0-9_]+$", "title": "Key" }, "label": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Label" }, "kind": { "type": "string", "minLength": 1, "title": "Kind" }, "options": { "items": { "type": "string" }, "type": "array", "title": "Options" }, "required": { "type": "boolean", "title": "Required", "default": false }, "position": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Position" }, "config": { "additionalProperties": true, "type": "object", "title": "Config" } }, "type": "object", "required": [ "entity_type", "key", "label", "kind" ], "title": "CustomFieldCreate" }, "CustomFieldUpdate": { "properties": { "label": { "anyOf": [ { "type": "string", "maxLength": 100, "minLength": 1 }, { "type": "null" } ], "title": "Label" }, "options": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Options" }, "required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Required" }, "position": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Position" }, "config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Config" } }, "type": "object", "title": "CustomFieldUpdate" }, "CustomerRefIn": { "properties": { "type": { "type": "string", "title": "Type" }, "id": { "type": "string", "minLength": 1, "title": "Id" }, "ref": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ref" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" } }, "type": "object", "required": [ "type", "id" ], "title": "CustomerRefIn" }, "DealCreate": { "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 1, "title": "Name" }, "pipeline_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pipeline Id" }, "stage_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stage Id" }, "value": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "title": "Value" }, "currency": { "type": "string", "title": "Currency", "default": "EUR" }, "expected_close_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expected Close Date" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "tag_ids": { "items": { "type": "string" }, "type": "array", "title": "Tag Ids" } }, "type": "object", "required": [ "name" ], "title": "DealCreate" }, "DealUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 300, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "stage_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stage Id" }, "value": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "title": "Value" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "expected_close_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expected Close Date" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "tag_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tag Ids" }, "position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Position" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Custom Fields" } }, "type": "object", "title": "DealUpdate" }, "DefaultCalendarBody": { "properties": { "calendar_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Calendar Id" } }, "type": "object", "title": "DefaultCalendarBody" }, "DomainAdd": { "properties": { "value": { "type": "string", "maxLength": 320, "minLength": 1, "title": "Value" } }, "type": "object", "required": [ "value" ], "title": "DomainAdd" }, "DraftIn": { "properties": { "to": { "items": { "type": "string" }, "type": "array", "title": "To" }, "cc": { "items": { "type": "string" }, "type": "array", "title": "Cc" }, "bcc": { "items": { "type": "string" }, "type": "array", "title": "Bcc" }, "subject": { "type": "string", "title": "Subject", "default": "" }, "body_markdown": { "type": "string", "title": "Body Markdown", "default": "" }, "attachments": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Attachments" }, "in_reply_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "In Reply To" }, "references": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "References" }, "reply_to_email_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reply To Email Id" }, "mode": { "type": "string", "title": "Mode", "default": "new" }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, "type": "object", "title": "DraftIn" }, "EntityRef": { "properties": { "type": { "type": "string", "enum": [ "task", "project", "contact", "person", "event", "company", "deal", "activity", "bank_transaction" ], "title": "Type" }, "id": { "type": "string", "minLength": 1, "title": "Id" }, "ref": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ref" } }, "type": "object", "required": [ "type", "id" ], "title": "EntityRef" }, "EntityRefIn": { "properties": { "type": { "type": "string", "enum": [ "task", "project", "contact", "person", "event", "company", "deal" ], "title": "Type" }, "id": { "type": "string", "minLength": 1, "title": "Id" }, "ref": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ref" } }, "type": "object", "required": [ "type", "id" ], "title": "EntityRefIn" }, "EntryUpdate": { "properties": { "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "ended_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Ended At" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" } }, "type": "object", "title": "EntryUpdate" }, "ExpenseCreate": { "properties": { "supplier_ref": { "anyOf": [ { "$ref": "#/components/schemas/SupplierRefIn" }, { "type": "null" } ] }, "issue_date": { "type": "string", "format": "date", "title": "Issue Date" }, "due_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Due Date" }, "supplier_invoice_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Supplier Invoice Number" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "lines": { "items": { "$ref": "#/components/schemas/ExpenseLineIn" }, "type": "array", "title": "Lines" } }, "type": "object", "required": [ "issue_date" ], "title": "ExpenseCreate" }, "ExpenseLineIn": { "properties": { "description": { "type": "string", "title": "Description", "default": "" }, "amount_cents": { "type": "integer", "title": "Amount Cents", "default": 0 }, "incl_btw": { "type": "boolean", "title": "Incl Btw", "default": false }, "btw_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Btw Code" }, "expense_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expense Account Id" } }, "type": "object", "title": "ExpenseLineIn" }, "ExpenseUpdate": { "properties": { "supplier_ref": { "anyOf": [ { "$ref": "#/components/schemas/SupplierRefIn" }, { "type": "null" } ] }, "issue_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Issue Date" }, "due_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Due Date" }, "supplier_invoice_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Supplier Invoice Number" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "lines": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExpenseLineIn" }, "type": "array" }, { "type": "null" } ], "title": "Lines" } }, "type": "object", "title": "ExpenseUpdate" }, "ExportPayload": { "properties": { "calendar_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Calendar Id" } }, "type": "object", "title": "ExportPayload" }, "FilterBucket": { "properties": { "name": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Name" }, "max_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max Score" } }, "type": "object", "required": [ "name" ], "title": "FilterBucket" }, "FilterConfig": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": false }, "dest_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dest Path" }, "buckets": { "items": { "$ref": "#/components/schemas/FilterBucket" }, "type": "array", "title": "Buckets" }, "keep_contacts": { "type": "boolean", "title": "Keep Contacts", "default": true }, "spam_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Spam Path" } }, "type": "object", "title": "FilterConfig" }, "FolderSelection": { "properties": { "folder_ids": { "items": { "type": "string" }, "type": "array", "title": "Folder Ids" } }, "type": "object", "title": "FolderSelection" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ImapAccountIn": { "properties": { "host": { "type": "string", "minLength": 1, "title": "Host" }, "port": { "type": "integer", "maximum": 65535, "minimum": 1, "title": "Port", "default": 993 }, "use_ssl": { "type": "boolean", "title": "Use Ssl", "default": true }, "verify_ssl": { "type": "boolean", "title": "Verify Ssl", "default": true }, "username": { "type": "string", "minLength": 1, "title": "Username" }, "password": { "type": "string", "minLength": 1, "title": "Password" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" } }, "type": "object", "required": [ "host", "username", "password" ], "title": "ImapAccountIn" }, "ImapCredentials": { "properties": { "host": { "type": "string", "minLength": 1, "title": "Host" }, "port": { "type": "integer", "maximum": 65535, "minimum": 1, "title": "Port", "default": 993 }, "use_ssl": { "type": "boolean", "title": "Use Ssl", "default": true }, "verify_ssl": { "type": "boolean", "title": "Verify Ssl", "default": true }, "username": { "type": "string", "minLength": 1, "title": "Username" }, "password": { "type": "string", "minLength": 1, "title": "Password" } }, "type": "object", "required": [ "host", "username", "password" ], "title": "ImapCredentials" }, "ImportSubmit": { "properties": { "dataset": { "type": "string", "title": "Dataset", "description": "One of the keys in DATASETS" }, "skip_if_unchanged": { "type": "boolean", "title": "Skip If Unchanged", "description": "Compare upstream Last-Modified; skip if unchanged.", "default": false } }, "type": "object", "required": [ "dataset" ], "title": "ImportSubmit" }, "InstantiatePayload": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "target_project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Project Id" } }, "type": "object", "title": "InstantiatePayload" }, "InvoiceCreate": { "properties": { "customer_ref": { "$ref": "#/components/schemas/CustomerRefIn" }, "issue_date": { "type": "string", "format": "date", "title": "Issue Date" }, "due_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Due Date" }, "reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "deal_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deal Id" }, "lines": { "items": { "$ref": "#/components/schemas/InvoiceLineIn" }, "type": "array", "title": "Lines" } }, "type": "object", "required": [ "customer_ref", "issue_date" ], "title": "InvoiceCreate" }, "InvoiceEmailRequest": { "properties": { "to": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "To" }, "cc": { "items": { "type": "string" }, "type": "array", "title": "Cc" }, "subject": { "type": "string", "maxLength": 400, "minLength": 1, "title": "Subject" }, "body": { "type": "string", "title": "Body", "default": "" }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, "type": "object", "required": [ "to", "subject" ], "title": "InvoiceEmailRequest" }, "InvoiceLineIn": { "properties": { "description": { "type": "string", "title": "Description", "default": "" }, "quantity": { "type": "number", "title": "Quantity", "default": 1 }, "unit_price_cents": { "type": "integer", "title": "Unit Price Cents", "default": 0 }, "btw_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Btw Code" }, "revenue_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Revenue Account Id" } }, "type": "object", "title": "InvoiceLineIn" }, "InvoiceUpdate": { "properties": { "customer_ref": { "anyOf": [ { "$ref": "#/components/schemas/CustomerRefIn" }, { "type": "null" } ] }, "issue_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Issue Date" }, "due_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Due Date" }, "reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "lines": { "anyOf": [ { "items": { "$ref": "#/components/schemas/InvoiceLineIn" }, "type": "array" }, { "type": "null" } ], "title": "Lines" } }, "type": "object", "title": "InvoiceUpdate" }, "JournalEntryIn": { "properties": { "date": { "type": "string", "format": "date-time", "title": "Date" }, "description": { "type": "string", "title": "Description", "default": "" }, "dagboek": { "type": "string", "title": "Dagboek", "default": "memoriaal" }, "lines": { "items": { "$ref": "#/components/schemas/JournalLineIn" }, "type": "array", "minItems": 1, "title": "Lines" } }, "type": "object", "required": [ "date", "lines" ], "title": "JournalEntryIn" }, "JournalLineIn": { "properties": { "account_id": { "type": "string", "minLength": 1, "title": "Account Id" }, "debit_cents": { "type": "integer", "minimum": 0, "title": "Debit Cents", "default": 0 }, "credit_cents": { "type": "integer", "minimum": 0, "title": "Credit Cents", "default": 0 }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "btw_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Btw Code" } }, "type": "object", "required": [ "account_id" ], "title": "JournalLineIn" }, "KeywordAdd": { "properties": { "keyword": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Keyword" }, "block_domain": { "type": "boolean", "title": "Block Domain", "default": false } }, "type": "object", "required": [ "keyword" ], "title": "KeywordAdd" }, "KeywordPatch": { "properties": { "block_domain": { "type": "boolean", "title": "Block Domain" } }, "type": "object", "required": [ "block_domain" ], "title": "KeywordPatch" }, "LinkBody": { "properties": { "type": { "type": "string", "enum": [ "task", "project", "contact", "event", "company", "deal" ], "title": "Type" }, "id": { "type": "string", "minLength": 1, "title": "Id" }, "ref": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ref" } }, "type": "object", "required": [ "type", "id" ], "title": "LinkBody" }, "LinkCreate": { "properties": { "from": { "$ref": "#/components/schemas/EntityRef" }, "to": { "$ref": "#/components/schemas/EntityRef" }, "kind": { "type": "string", "title": "Kind", "default": "related" } }, "type": "object", "required": [ "from", "to" ], "title": "LinkCreate" }, "Login2faPayload": { "properties": { "code": { "type": "string", "minLength": 1, "title": "Code" }, "mfa_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mfa Token" } }, "type": "object", "required": [ "code" ], "title": "Login2faPayload" }, "LoginPayload": { "properties": { "username": { "type": "string", "minLength": 1, "title": "Username" }, "password": { "type": "string", "minLength": 1, "title": "Password" } }, "type": "object", "required": [ "username", "password" ], "title": "LoginPayload" }, "ManualEntry": { "properties": { "task_id": { "type": "string", "minLength": 1, "title": "Task Id" }, "started_at": { "type": "string", "format": "date-time", "title": "Started At" }, "ended_at": { "type": "string", "format": "date-time", "title": "Ended At" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" } }, "type": "object", "required": [ "task_id", "started_at", "ended_at" ], "title": "ManualEntry" }, "MatchIn": { "properties": { "kind": { "type": "string", "title": "Kind" }, "target_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Id" }, "ledger_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ledger Account Id" }, "amount_cents": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Amount Cents" }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date" } }, "type": "object", "required": [ "kind" ], "title": "MatchIn" }, "MemberAdd": { "properties": { "username": { "type": "string", "minLength": 1, "title": "Username" }, "role": { "type": "string", "enum": [ "viewer", "editor", "admin" ], "title": "Role", "default": "editor" } }, "type": "object", "required": [ "username" ], "title": "MemberAdd" }, "MemberRoleChange": { "properties": { "role": { "type": "string", "enum": [ "viewer", "editor", "admin" ], "title": "Role" } }, "type": "object", "required": [ "role" ], "title": "MemberRoleChange" }, "MessageCreate": { "properties": { "body_md": { "type": "string", "maxLength": 10000, "title": "Body Md", "default": "" }, "attachments": { "items": { "type": "string" }, "type": "array", "title": "Attachments" } }, "type": "object", "title": "MessageCreate" }, "MessageEdit": { "properties": { "body_md": { "type": "string", "maxLength": 10000, "minLength": 1, "title": "Body Md" } }, "type": "object", "required": [ "body_md" ], "title": "MessageEdit" }, "MetaPatch": { "properties": { "title": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Description" }, "doc_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Doc Type" }, "doc_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Doc Date" }, "tag_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tag Ids" }, "party_ref": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Party Ref" }, "keep_until": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Keep Until" } }, "type": "object", "title": "MetaPatch", "description": "Document metadata. Every field optional — this is a partial patch, and\n``exclude_unset`` in the handler keeps untouched fields untouched." }, "NameIn": { "properties": { "first": { "type": "string", "title": "First", "default": "" }, "last": { "type": "string", "title": "Last", "default": "" }, "additional": { "type": "string", "title": "Additional", "default": "" }, "prefix": { "type": "string", "title": "Prefix", "default": "" }, "suffix": { "type": "string", "title": "Suffix", "default": "" }, "display": { "type": "string", "title": "Display", "default": "" } }, "type": "object", "title": "NameIn" }, "NoteCreate": { "properties": { "notebook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notebook Id" }, "title": { "type": "string", "maxLength": 300, "title": "Title", "default": "" }, "body_md": { "type": "string", "title": "Body Md", "default": "" }, "tag_ids": { "items": { "type": "string" }, "type": "array", "title": "Tag Ids" }, "link_to": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Link To" } }, "type": "object", "title": "NoteCreate" }, "NoteUpdate": { "properties": { "title": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ], "title": "Title" }, "body_md": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body Md" }, "tag_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tag Ids" }, "pinned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Pinned" }, "notebook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notebook Id" } }, "type": "object", "title": "NoteUpdate" }, "NotebookCreate": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" } }, "type": "object", "required": [ "name" ], "title": "NotebookCreate" }, "NotebookUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 120, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" } }, "type": "object", "title": "NotebookUpdate" }, "NrdRun": { "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" } }, "type": "object", "title": "NrdRun" }, "PaidIn": { "properties": { "paid": { "type": "boolean", "title": "Paid" } }, "type": "object", "required": [ "paid" ], "title": "PaidIn" }, "PartyRefIn": { "properties": { "type": { "type": "string", "title": "Type" }, "id": { "type": "string", "minLength": 1, "title": "Id" }, "ref": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ref" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" } }, "type": "object", "required": [ "type", "id" ], "title": "PartyRefIn" }, "PasswordChangePayload": { "properties": { "current_password": { "type": "string", "minLength": 1, "title": "Current Password" }, "new_password": { "type": "string", "minLength": 8, "title": "New Password" } }, "type": "object", "required": [ "current_password", "new_password" ], "title": "PasswordChangePayload" }, "PaymentIn": { "properties": { "amount_cents": { "type": "integer", "exclusiveMinimum": 0, "title": "Amount Cents" }, "date": { "type": "string", "format": "date", "title": "Date" }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, "type": "object", "required": [ "amount_cents", "date" ], "title": "PaymentIn" }, "PersonalExpenseCreate": { "properties": { "date": { "type": "string", "format": "date", "title": "Date" }, "merchant": { "type": "string", "title": "Merchant", "default": "" }, "amount_cents": { "type": "integer", "minimum": 0, "title": "Amount Cents", "default": 0 }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "currency": { "type": "string", "title": "Currency", "default": "EUR" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "paid": { "type": "boolean", "title": "Paid", "default": false }, "party_ref": { "anyOf": [ { "$ref": "#/components/schemas/PartyRefIn" }, { "type": "null" } ] } }, "type": "object", "required": [ "date" ], "title": "PersonalExpenseCreate" }, "PersonalExpenseUpdate": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date" }, "merchant": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Merchant" }, "amount_cents": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Amount Cents" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "paid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Paid" }, "party_ref": { "anyOf": [ { "$ref": "#/components/schemas/PartyRefIn" }, { "type": "null" } ] } }, "type": "object", "title": "PersonalExpenseUpdate" }, "PipelineUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 120, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "stages": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StageEntry" }, "type": "array" }, { "type": "null" } ], "title": "Stages" } }, "type": "object", "title": "PipelineUpdate" }, "PreferencesPatch": { "properties": { "preferences": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Preferences" } }, "type": "object", "title": "PreferencesPatch" }, "ProfileUpdate": { "properties": { "legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Name" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address" }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "kvk_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kvk Number" }, "btw_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Btw Id" }, "iban": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Iban" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website" }, "invoice_number_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoice Number Format" }, "invoice_footer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoice Footer" }, "invoice_email_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoice Email Subject" }, "invoice_email_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoice Email Body" }, "default_revenue_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Revenue Account Id" }, "default_expense_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Expense Account Id" }, "default_btw_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Btw Code" }, "logo_attachment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logo Attachment Id" }, "fiscal_year_start_month": { "anyOf": [ { "type": "integer", "maximum": 12, "minimum": 1 }, { "type": "null" } ], "title": "Fiscal Year Start Month" } }, "type": "object", "title": "ProfileUpdate" }, "ProjectCreate": { "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "status": { "type": "string", "enum": [ "active", "on_hold", "done", "archived" ], "title": "Status", "default": "active" }, "start_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Date" }, "due_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Due Date" }, "tag_ids": { "items": { "type": "string" }, "type": "array", "title": "Tag Ids" }, "parent_project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Project Id" } }, "type": "object", "required": [ "name" ], "title": "ProjectCreate" }, "ProjectUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "status": { "anyOf": [ { "type": "string", "enum": [ "active", "on_hold", "done", "archived" ] }, { "type": "null" } ], "title": "Status" }, "start_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Date" }, "due_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Due Date" }, "tag_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tag Ids" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "statuses": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StatusEntry" }, "type": "array" }, { "type": "null" } ], "title": "Statuses" }, "parent_project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Project Id" } }, "type": "object", "title": "ProjectUpdate" }, "RegisterPayload": { "properties": { "username": { "type": "string", "maxLength": 32, "minLength": 3, "title": "Username" }, "password": { "type": "string", "minLength": 8, "title": "Password" } }, "type": "object", "required": [ "username", "password" ], "title": "RegisterPayload", "description": "Self-registration payload — always lands as a ``viewer``." }, "RelocateIn": { "properties": { "target_addressbook_id": { "type": "string", "minLength": 1, "title": "Target Addressbook Id" }, "mode": { "type": "string", "enum": [ "move", "copy" ], "title": "Mode", "default": "move" } }, "type": "object", "required": [ "target_addressbook_id" ], "title": "RelocateIn" }, "ReorderBody": { "properties": { "ordered_ids": { "items": { "type": "string" }, "type": "array", "title": "Ordered Ids" } }, "type": "object", "title": "ReorderBody" }, "ReorderIn": { "properties": { "ordered_ids": { "items": { "type": "string" }, "type": "array", "title": "Ordered Ids" } }, "type": "object", "required": [ "ordered_ids" ], "title": "ReorderIn" }, "ReverseIn": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "title": "ReverseIn" }, "RuleFromTxnIn": { "properties": { "txn_id": { "type": "string", "title": "Txn Id" }, "category_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Id" }, "set_excluded": { "type": "boolean", "title": "Set Excluded", "default": false }, "field": { "type": "string", "title": "Field", "default": "counterparty" } }, "type": "object", "required": [ "txn_id" ], "title": "RuleFromTxnIn" }, "RulePatch": { "properties": { "counterparty_contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Counterparty Contains" }, "counterparty_iban": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Counterparty Iban" }, "description_contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description Contains" }, "category_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Id" }, "set_excluded": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Set Excluded" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" } }, "type": "object", "title": "RulePatch" }, "RulePreviewIn": { "properties": { "counterparty_contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Counterparty Contains" }, "counterparty_iban": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Counterparty Iban" }, "description_contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description Contains" } }, "type": "object", "title": "RulePreviewIn" }, "RuleReorder": { "properties": { "ids": { "items": { "type": "string" }, "type": "array", "title": "Ids" } }, "type": "object", "title": "RuleReorder" }, "SelfContactPayload": { "properties": { "addressbook_id": { "type": "string", "minLength": 1, "title": "Addressbook Id" }, "uid": { "type": "string", "minLength": 1, "title": "Uid" } }, "type": "object", "required": [ "addressbook_id", "uid" ], "title": "SelfContactPayload" }, "SendRequest": { "properties": { "to": { "items": { "type": "string" }, "type": "array", "title": "To" }, "cc": { "items": { "type": "string" }, "type": "array", "title": "Cc" }, "bcc": { "items": { "type": "string" }, "type": "array", "title": "Bcc" }, "subject": { "type": "string", "title": "Subject", "default": "" }, "body_markdown": { "type": "string", "title": "Body Markdown", "default": "" }, "body_html": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body Html" }, "attachment_ids": { "items": { "type": "string" }, "type": "array", "title": "Attachment Ids" }, "in_reply_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "In Reply To" }, "references": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "References" }, "reply_to_email_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reply To Email Id" }, "draft_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Draft Id" }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, "type": "object", "title": "SendRequest" }, "SmartConditionIn": { "properties": { "field": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Field" }, "op": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Op" }, "value": { "title": "Value" } }, "type": "object", "required": [ "field", "op" ], "title": "SmartConditionIn" }, "SmartFolderIn": { "properties": { "name": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Name" }, "match": { "type": "string", "title": "Match", "default": "all" }, "groups": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SmartGroupIn" }, "type": "array" }, { "type": "null" } ], "title": "Groups" }, "conditions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SmartConditionIn" }, "type": "array" }, { "type": "null" } ], "title": "Conditions" }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, "type": "object", "required": [ "name" ], "title": "SmartFolderIn" }, "SmartFolderPatch": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 80 }, { "type": "null" } ], "title": "Name" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Match" }, "groups": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SmartGroupIn" }, "type": "array" }, { "type": "null" } ], "title": "Groups" }, "conditions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SmartConditionIn" }, "type": "array" }, { "type": "null" } ], "title": "Conditions" }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" } }, "type": "object", "title": "SmartFolderPatch" }, "SmartGroupIn": { "properties": { "match": { "type": "string", "title": "Match", "default": "all" }, "conditions": { "items": { "$ref": "#/components/schemas/SmartConditionIn" }, "type": "array", "title": "Conditions" } }, "type": "object", "title": "SmartGroupIn" }, "SmtpConfigIn": { "properties": { "smtp_host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Smtp Host" }, "smtp_port": { "type": "integer", "maximum": 65535, "minimum": 1, "title": "Smtp Port", "default": 465 }, "smtp_security": { "type": "string", "title": "Smtp Security", "default": "ssl" }, "from_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Address" }, "from_name": { "type": "string", "title": "From Name", "default": "" }, "signature": { "type": "string", "title": "Signature", "default": "" } }, "type": "object", "title": "SmtpConfigIn" }, "StageEntry": { "properties": { "id": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Id" }, "name": { "type": "string", "maxLength": 60, "minLength": 1, "title": "Name" }, "kind": { "type": "string", "enum": [ "open", "won", "lost" ], "title": "Kind" }, "probability": { "type": "integer", "maximum": 100, "minimum": 0, "title": "Probability", "default": 0 }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "position": { "type": "integer", "minimum": 0, "title": "Position" } }, "type": "object", "required": [ "id", "name", "kind", "position" ], "title": "StageEntry" }, "StartTimerBody": { "properties": { "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" } }, "type": "object", "title": "StartTimerBody" }, "StatusEntry": { "properties": { "id": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Id" }, "name": { "type": "string", "maxLength": 60, "minLength": 1, "title": "Name" }, "kind": { "type": "string", "enum": [ "open", "done", "cancelled" ], "title": "Kind" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "position": { "type": "integer", "minimum": 0, "title": "Position" } }, "type": "object", "required": [ "id", "name", "kind", "position" ], "title": "StatusEntry" }, "SupplierRefIn": { "properties": { "type": { "type": "string", "title": "Type" }, "id": { "type": "string", "minLength": 1, "title": "Id" }, "ref": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ref" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" } }, "type": "object", "required": [ "type", "id" ], "title": "SupplierRefIn" }, "TagAction": { "properties": { "tag": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Tag" }, "add": { "type": "boolean", "title": "Add", "default": true } }, "type": "object", "required": [ "tag" ], "title": "TagAction" }, "TagCreate": { "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Name" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kind" } }, "type": "object", "required": [ "name" ], "title": "TagCreate" }, "TagUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 64, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kind" } }, "type": "object", "title": "TagUpdate" }, "TargetIn": { "properties": { "category_id": { "type": "string", "minLength": 1, "title": "Category Id" }, "amount_cents": { "type": "integer", "minimum": 0, "title": "Amount Cents" } }, "type": "object", "required": [ "category_id", "amount_cents" ], "title": "TargetIn" }, "TargetPatch": { "properties": { "amount_cents": { "type": "integer", "minimum": 0, "title": "Amount Cents" } }, "type": "object", "required": [ "amount_cents" ], "title": "TargetPatch" }, "TaskCreate": { "properties": { "title": { "type": "string", "maxLength": 400, "minLength": 1, "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "parent_task_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Task Id" }, "status": { "type": "string", "title": "Status", "default": "backlog" }, "priority": { "type": "string", "enum": [ "low", "normal", "high", "urgent" ], "title": "Priority", "default": "normal" }, "due_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Due Date" }, "due_has_time": { "type": "boolean", "title": "Due Has Time", "default": false }, "scheduled_for": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Scheduled For" }, "scheduled_has_time": { "type": "boolean", "title": "Scheduled Has Time", "default": false }, "assignee_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee Id" }, "tag_ids": { "items": { "type": "string" }, "type": "array", "title": "Tag Ids" }, "recurrence_rule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recurrence Rule" } }, "type": "object", "required": [ "title" ], "title": "TaskCreate" }, "TaskUpdate": { "properties": { "title": { "anyOf": [ { "type": "string", "maxLength": 400, "minLength": 1 }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "parent_task_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Task Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "priority": { "anyOf": [ { "type": "string", "enum": [ "low", "normal", "high", "urgent" ] }, { "type": "null" } ], "title": "Priority" }, "due_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Due Date" }, "due_has_time": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Due Has Time" }, "scheduled_for": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Scheduled For" }, "scheduled_has_time": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Scheduled Has Time" }, "assignee_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee Id" }, "tag_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tag Ids" }, "position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Position" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "recurrence_rule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recurrence Rule" } }, "type": "object", "title": "TaskUpdate" }, "TemplateCapture": { "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "required": [ "name" ], "title": "TemplateCapture" }, "TotpEnablePayload": { "properties": { "code": { "type": "string", "minLength": 1, "title": "Code" } }, "type": "object", "required": [ "code" ], "title": "TotpEnablePayload" }, "TotpPasswordPayload": { "properties": { "password": { "type": "string", "minLength": 1, "title": "Password" } }, "type": "object", "required": [ "password" ], "title": "TotpPasswordPayload" }, "TxnPatch": { "properties": { "category_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Id" }, "excluded": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Excluded" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" } }, "type": "object", "title": "TxnPatch" }, "TypeCreate": { "properties": { "label": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Label" }, "icon": { "anyOf": [ { "type": "string", "maxLength": 8 }, { "type": "null" } ], "title": "Icon" } }, "type": "object", "required": [ "label" ], "title": "TypeCreate" }, "TypeUpdate": { "properties": { "label": { "anyOf": [ { "type": "string", "maxLength": 40, "minLength": 1 }, { "type": "null" } ], "title": "Label" }, "icon": { "anyOf": [ { "type": "string", "maxLength": 8 }, { "type": "null" } ], "title": "Icon" } }, "type": "object", "title": "TypeUpdate" }, "TypedValueIn": { "properties": { "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "value": { "type": "string", "title": "Value", "default": "" } }, "type": "object", "title": "TypedValueIn" }, "UpdateUserPayload": { "properties": { "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" } }, "type": "object", "title": "UpdateUserPayload" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "WhitelistAdd": { "properties": { "value": { "type": "string", "maxLength": 320, "minLength": 1, "title": "Value" } }, "type": "object", "required": [ "value" ], "title": "WhitelistAdd" }, "WindowUpdate": { "properties": { "window_days_past": { "type": "integer", "maximum": 3650, "minimum": 0, "title": "Window Days Past" }, "window_days_future": { "type": "integer", "maximum": 3650, "minimum": 0, "title": "Window Days Future" } }, "type": "object", "required": [ "window_days_past", "window_days_future" ], "title": "WindowUpdate" }, "api__routers__bank__RuleIn": { "properties": { "counterparty_contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Counterparty Contains" }, "counterparty_iban": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Counterparty Iban" }, "description_contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description Contains" }, "category_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Id" }, "set_excluded": { "type": "boolean", "title": "Set Excluded", "default": false } }, "type": "object", "title": "RuleIn" }, "api__routers__caldav__SyncRequest": { "properties": { "calendar_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Calendar Id" } }, "type": "object", "title": "SyncRequest" }, "api__routers__carddav__SyncRequest": { "properties": { "addressbook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressbook Id" } }, "type": "object", "title": "SyncRequest" }, "api__routers__deals__ReorderItem": { "properties": { "deal_id": { "type": "string", "minLength": 1, "title": "Deal Id" }, "stage_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stage Id" }, "position": { "type": "integer", "minimum": 0, "title": "Position" } }, "type": "object", "required": [ "deal_id", "position" ], "title": "ReorderItem" }, "api__routers__deals__ReorderRequest": { "properties": { "items": { "items": { "$ref": "#/components/schemas/api__routers__deals__ReorderItem" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ReorderRequest" }, "api__routers__mail__MoveRequest": { "properties": { "dest_folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dest Folder Id" }, "special": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Special" } }, "type": "object", "title": "MoveRequest" }, "api__routers__mail__RuleIn": { "properties": { "from_value": { "anyOf": [ { "type": "string", "maxLength": 320 }, { "type": "null" } ], "title": "From Value" }, "subject_contains": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Subject Contains" }, "list_id_contains": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "List Id Contains" }, "dest_path": { "type": "string", "maxLength": 400, "minLength": 1, "title": "Dest Path" } }, "type": "object", "required": [ "dest_path" ], "title": "RuleIn" }, "api__routers__mail__SyncRequest": { "properties": { "folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Folder Id" }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, "type": "object", "title": "SyncRequest" }, "api__routers__tasks__MoveRequest": { "properties": { "project_id": { "type": "string", "title": "Project Id" } }, "type": "object", "required": [ "project_id" ], "title": "MoveRequest" }, "api__routers__tasks__ReorderItem": { "properties": { "task_id": { "type": "string", "minLength": 1, "title": "Task Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "position": { "type": "integer", "minimum": 0, "title": "Position" } }, "type": "object", "required": [ "task_id", "position" ], "title": "ReorderItem" }, "api__routers__tasks__ReorderRequest": { "properties": { "items": { "items": { "$ref": "#/components/schemas/api__routers__tasks__ReorderItem" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ReorderRequest" } } } }