{ "openapi": "3.0.0", "paths": { "/health": { "get": { "operationId": "HealthController_check", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" }, "timestamp": { "type": "string", "format": "date-time" }, "rls": { "type": "object", "properties": { "enforced": { "type": "boolean" } } } } } } } } }, "tags": ["Health"], "security": [] } }, "/health/live": { "get": { "operationId": "HealthController_live", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["Health"] } }, "/health/ready": { "get": { "operationId": "HealthController_ready", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["Health"] } }, "/v1/metrics/prometheus": { "get": { "operationId": "MetricsController_scrape", "parameters": [], "responses": { "200": { "description": "Success", "content": { "text/plain; version=0.0.4; charset=utf-8": { "schema": { "type": "string" } } } } }, "tags": ["Metrics"], "security": [ { "prometheusScrapeToken": [] } ], "summary": "Prometheus metrics scrape", "description": "Prometheus text exposition format (Content-Type set by the metrics registry). Fails closed: 401 when PROMETHEUS_SCRAPE_TOKEN is unset or the bearer does not match." } }, "/internal/shift-change-approval": { "post": { "operationId": "ShiftChangeApprovalController_create", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Internal"], "security": [ { "proxySecret": [] } ], "summary": "Create a shift-change approval request (internal)", "description": "Server-to-server from apps/app's attendance check-in flow. Requires an allowlisted Origin plus a matching x-proxy-secret (401 otherwise, checked before the body is validated). 400 \"Validation failed\" if a field is missing or malformed (workspaceId must be a uuid, 1-50 approverIds); 400 if requester/approvers are not members of workspaceId.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftChangeApprovalBody" } } } } } }, "/v1/feature-flags/{key}/check": { "get": { "operationId": "FeatureFlagsController_check", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Platform Feature Flags"] } }, "/api/v1/content/{collection}": { "get": { "operationId": "ContentController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 1, "default": 1 } }, { "name": "collection", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ai-insights", "api-keys", "attendance", "attendance-bot-commands", "automation-flows", "automation-sequences", "contact-segments", "contractors", "courses", "crm-contract-types", "crm-deal-types", "crm-industries", "crm-lead-sources", "crm-lost-reasons", "crm-priorities", "crm-tags", "departments", "designations", "email-providers", "employee-skills", "employment-types", "invoice-templates", "invoices", "job-modes", "job-openings", "job-types", "kpi-templates", "lms-modules", "locations", "marketing-forms", "media", "milestone-priorities", "milestone-statuses", "milestone-tags", "milestone-types", "notification-delivery-logs", "notification-queue", "offers", "okr-templates", "performance-reviews", "project-categories", "project-priorities", "project-statuses", "project-tags", "project-types", "recruitment-approval-chains", "recruitment-email-templates", "recruitment-job-templates", "recruitment-notification-settings", "recruitment-pipeline-stages", "retainers", "review-cycles", "skills", "slack-integrations", "task-priorities", "task-statuses", "task-tags", "task-types", "taxes", "ticket-categories", "timers", "webhook-subscriptions" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "description": "Payload REST-shaped paginated list (legacy compat).", "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } } }, "tags": ["Content"] }, "post": { "operationId": "ContentController_create", "parameters": [ { "name": "collection", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ai-insights", "api-keys", "attendance", "attendance-bot-commands", "automation-flows", "automation-sequences", "contact-segments", "contractors", "courses", "crm-contract-types", "crm-deal-types", "crm-industries", "crm-lead-sources", "crm-lost-reasons", "crm-priorities", "crm-tags", "departments", "designations", "email-providers", "employee-skills", "employment-types", "invoice-templates", "invoices", "job-modes", "job-openings", "job-types", "kpi-templates", "lms-modules", "locations", "marketing-forms", "media", "milestone-priorities", "milestone-statuses", "milestone-tags", "milestone-types", "notification-delivery-logs", "notification-queue", "offers", "okr-templates", "performance-reviews", "project-categories", "project-priorities", "project-statuses", "project-tags", "project-types", "recruitment-approval-chains", "recruitment-email-templates", "recruitment-job-templates", "recruitment-notification-settings", "recruitment-pipeline-stages", "retainers", "review-cycles", "skills", "slack-integrations", "task-priorities", "task-statuses", "task-tags", "task-types", "taxes", "ticket-categories", "timers", "webhook-subscriptions" ] } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "tags": ["Content"] } }, "/api/v1/content/{collection}/{id}": { "get": { "operationId": "ContentController_get", "parameters": [ { "name": "collection", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ai-insights", "api-keys", "attendance", "attendance-bot-commands", "automation-flows", "automation-sequences", "contact-segments", "contractors", "courses", "crm-contract-types", "crm-deal-types", "crm-industries", "crm-lead-sources", "crm-lost-reasons", "crm-priorities", "crm-tags", "departments", "designations", "email-providers", "employee-skills", "employment-types", "invoice-templates", "invoices", "job-modes", "job-openings", "job-types", "kpi-templates", "lms-modules", "locations", "marketing-forms", "media", "milestone-priorities", "milestone-statuses", "milestone-tags", "milestone-types", "notification-delivery-logs", "notification-queue", "offers", "okr-templates", "performance-reviews", "project-categories", "project-priorities", "project-statuses", "project-tags", "project-types", "recruitment-approval-chains", "recruitment-email-templates", "recruitment-job-templates", "recruitment-notification-settings", "recruitment-pipeline-stages", "retainers", "review-cycles", "skills", "slack-integrations", "task-priorities", "task-statuses", "task-tags", "task-types", "taxes", "ticket-categories", "timers", "webhook-subscriptions" ] } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Content"] }, "patch": { "operationId": "ContentController_update", "parameters": [ { "name": "collection", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ai-insights", "api-keys", "attendance", "attendance-bot-commands", "automation-flows", "automation-sequences", "contact-segments", "contractors", "courses", "crm-contract-types", "crm-deal-types", "crm-industries", "crm-lead-sources", "crm-lost-reasons", "crm-priorities", "crm-tags", "departments", "designations", "email-providers", "employee-skills", "employment-types", "invoice-templates", "invoices", "job-modes", "job-openings", "job-types", "kpi-templates", "lms-modules", "locations", "marketing-forms", "media", "milestone-priorities", "milestone-statuses", "milestone-tags", "milestone-types", "notification-delivery-logs", "notification-queue", "offers", "okr-templates", "performance-reviews", "project-categories", "project-priorities", "project-statuses", "project-tags", "project-types", "recruitment-approval-chains", "recruitment-email-templates", "recruitment-job-templates", "recruitment-notification-settings", "recruitment-pipeline-stages", "retainers", "review-cycles", "skills", "slack-integrations", "task-priorities", "task-statuses", "task-tags", "task-types", "taxes", "ticket-categories", "timers", "webhook-subscriptions" ] } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "tags": ["Content"] }, "delete": { "operationId": "ContentController_remove", "parameters": [ { "name": "collection", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ai-insights", "api-keys", "attendance", "attendance-bot-commands", "automation-flows", "automation-sequences", "contact-segments", "contractors", "courses", "crm-contract-types", "crm-deal-types", "crm-industries", "crm-lead-sources", "crm-lost-reasons", "crm-priorities", "crm-tags", "departments", "designations", "email-providers", "employee-skills", "employment-types", "invoice-templates", "invoices", "job-modes", "job-openings", "job-types", "kpi-templates", "lms-modules", "locations", "marketing-forms", "media", "milestone-priorities", "milestone-statuses", "milestone-tags", "milestone-types", "notification-delivery-logs", "notification-queue", "offers", "okr-templates", "performance-reviews", "project-categories", "project-priorities", "project-statuses", "project-tags", "project-types", "recruitment-approval-chains", "recruitment-email-templates", "recruitment-job-templates", "recruitment-notification-settings", "recruitment-pipeline-stages", "retainers", "review-cycles", "skills", "slack-integrations", "task-priorities", "task-statuses", "task-tags", "task-types", "taxes", "ticket-categories", "timers", "webhook-subscriptions" ] } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "tags": ["Content"] } }, "/api/v1/media": { "post": { "operationId": "MediaController_upload", "parameters": [ { "name": "alt", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "purpose", "in": "query", "required": false, "schema": { "type": "string", "enum": ["avatar", "workspace-logo", "general"] } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Media"] }, "get": { "operationId": "MediaController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Media"] } }, "/api/v1/media/{id}": { "get": { "operationId": "MediaController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Media"] }, "patch": { "operationId": "MediaController_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Media"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMediaMeta" } } } } }, "delete": { "operationId": "MediaController_remove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Media"] } }, "/v1/auth-next/login": { "post": { "operationId": "AuthNextController_login", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextTokenResponse" } } } } }, "tags": ["AuthNext"], "security": [], "summary": "Log in with email and password", "description": "Public. Any body-validation or credential failure returns 401 \"Invalid credentials\". Issues a 15-minute access JWT plus a rotating refresh token (refreshExpiresIn in seconds; rememberMe extends it).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextLoginBody" } } } } } }, "/v1/auth-next/verify-password": { "post": { "operationId": "AuthNextController_verifyPasswordOnly", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextVerifyPasswordResponse" } } } } }, "tags": ["AuthNext"], "security": [], "summary": "Verify a password without creating a session", "description": "Public. Same body as login but issues no tokens and writes no session. Always 200 — read `valid`, not the status code.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextLoginBody" } } } } } }, "/v1/auth-next/refresh": { "post": { "operationId": "AuthNextController_refresh", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextTokenResponse" } } } } }, "tags": ["AuthNext"], "security": [], "summary": "Rotate a refresh token", "description": "Public — the refresh token in the body is the credential. The used token is revoked and a new pair issued. Invalid/expired token returns 401 \"Invalid refresh token\".", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextRefreshBody" } } } } } }, "/v1/auth-next/impersonate": { "post": { "operationId": "AuthNextController_impersonate", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextImpersonateResponse" } } } } }, "tags": ["AuthNext"], "summary": "View as a workspace member (owner only)", "description": "Mints a 30-minute access token for an active, non-owner, same-workspace member other than the caller. No refresh token is issued. 403 \"Owner role required\" for non-owners; every target-side rejection collapses into one 403.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextImpersonateBody" } } } } } }, "/v1/auth-next/impersonate-grant": { "post": { "operationId": "AuthNextController_impersonateGrant", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextImpersonateGrantResponse" } } } } }, "tags": ["AuthNext"], "summary": "Create a platform-impersonation handoff grant (hop 1 of 2)", "description": "Bearer must be a plain auth-next access token (issuer amdital-auth-next, no OAuth `scope` claim, not `mfaSatisfied: false`) whose owner holds platform impersonation rights; it is verified in the handler, not by the default workspace guard. targetWorkspaceId comes from the body by design (platform-level authorization). Returns a single-use grant, never a session token. 401 without a valid console token; 403 if not authorized or no eligible target.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextImpersonateGrantBody" } } } } } }, "/v1/auth-next/impersonate-redeem": { "post": { "operationId": "AuthNextController_impersonateRedeem", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextImpersonateRedeemResponse" } } } } }, "tags": ["AuthNext"], "security": [], "summary": "Redeem a platform-impersonation grant (hop 2 of 2)", "description": "Public — grantId + binderSecret are the credential. Consumes the grant and returns a 30-minute impersonation access token. Every rejection (unknown, consumed, expired, wrong binder) returns the same 401 \"Invalid or expired grant\".", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextImpersonateRedeemBody" } } } } } }, "/v1/auth-next/me": { "get": { "operationId": "AuthNextController_me", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextMeResponse" } } } } }, "tags": ["AuthNext"], "summary": "Get the caller's profile and workspace", "description": "`role` falls back to `employee` when no membership role resolves." } }, "/v1/auth-next/sessions": { "get": { "operationId": "AuthNextController_sessions", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextSessionList" } } } } }, "tags": ["AuthNext"], "summary": "List the caller's active sessions" }, "delete": { "operationId": "AuthNextController_revokeAll", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextRevokeAllResponse" } } } } }, "tags": ["AuthNext"], "summary": "Revoke all of the caller's sessions", "description": "`revoked` is the number of sessions revoked." } }, "/v1/auth-next/sessions/{id}": { "delete": { "operationId": "AuthNextController_revoke", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextBooleanSuccess" } } } } }, "tags": ["AuthNext"], "summary": "Revoke one of the caller's sessions", "description": "`success` is false when the id is not an active session owned by the caller." } }, "/v1/auth-next/admin/set-password": { "post": { "operationId": "AuthNextController_adminSetPassword", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextBooleanSuccess" } } } } }, "tags": ["AuthNext"], "security": [ { "internalApiKey": [] } ], "summary": "Set a user's password (server-to-server)", "description": "x-internal-key gated (timing-safe compare against INTERNAL_API_KEY); the calling app route owns user-facing authorization. 401 on bad key, 400 on invalid body; `success` is false when no user matches authUserId.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextAdminSetPasswordBody" } } } } } }, "/v1/auth-next/admin/set-email": { "post": { "operationId": "AuthNextController_adminSetEmail", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextBooleanSuccess" } } } } }, "tags": ["AuthNext"], "security": [ { "internalApiKey": [] } ], "summary": "Set a user's email (server-to-server)", "description": "x-internal-key gated (timing-safe compare against INTERNAL_API_KEY); the calling app route owns OTP verification and rate limiting. 401 on bad key, 400 on invalid body; `success` is false when no user matches authUserId.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextAdminSetEmailBody" } } } } } }, "/v1/auth-next/mfa/enroll": { "post": { "operationId": "AuthNextController_enroll", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextMfaEnrollResponse" } } } } }, "tags": ["AuthNext"], "summary": "Start TOTP MFA enrollment", "description": "Generates and stores a new TOTP secret for the caller (replacing any existing one) and returns its otpauth:// URI. `email` is only used as the URI label.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextMfaEnrollBody" } } } } } }, "/v1/auth-next/mfa/verify": { "post": { "operationId": "AuthNextController_verifyTotp", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextMfaVerifyResponse" } } } } }, "tags": ["AuthNext"], "summary": "Verify a TOTP code", "description": "Always 200; an invalid body or wrong/replayed code returns `verified: false`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextTotpVerifyBody" } } } } } }, "/v1/auth-next/mfa/complete-login": { "post": { "operationId": "AuthNextController_completeMfaLogin", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextCompleteMfaLoginResponse" } } } } }, "tags": ["AuthNext"], "summary": "Complete the console login MFA gate", "description": "Callable with an `mfaSatisfied: false` access token. Verifies the TOTP code, marks the session (identified by refreshToken) MFA-verified, then rotates it. Returns only `verified: false` on a bad body/code; 401 \"Invalid session\" if the refresh token does not match the caller's session.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthNextCompleteMfaLoginBody" } } } } } }, "/v1/auth-next/oidc/authorize": { "get": { "operationId": "OidcController_authorize", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["AuthNextOidc"] } }, "/v1/auth-next/oidc/callback": { "get": { "operationId": "OidcController_callback", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["AuthNextOidc"] } }, "/api/v1/companies": { "get": { "operationId": "CrmController_listCompanies", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "nullable": true } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Crm"] }, "post": { "operationId": "CrmController_createCompany", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CompanyResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCompany" } } } } } }, "/api/v1/companies/{id}": { "get": { "operationId": "CrmController_getCompany", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CompanyResponse" } } } } } } }, "tags": ["Crm"] }, "patch": { "operationId": "CrmController_updateCompany", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CompanyResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCompany" } } } } }, "delete": { "operationId": "CrmController_deleteCompany", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Crm"] } }, "/api/v1/companies/{id}/merge": { "post": { "operationId": "CrmController_mergeCompany", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "tags": ["Crm"] } }, "/api/v1/deals": { "get": { "operationId": "DealsController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/DealResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Crm"] }, "post": { "operationId": "DealsController_create", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DealResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeal" } } } } } }, "/api/v1/deals/{id}": { "get": { "operationId": "DealsController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DealResponse" } } } } } } }, "tags": ["Crm"] }, "patch": { "operationId": "DealsController_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DealResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeal" } } } } }, "delete": { "operationId": "DealsController_remove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Crm"] } }, "/api/v1/leads": { "get": { "operationId": "LeadsController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/LeadResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Crm"] }, "post": { "operationId": "LeadsController_create", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/LeadResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLead" } } } } } }, "/api/v1/leads/{id}": { "get": { "operationId": "LeadsController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/LeadResponse" } } } } } } }, "tags": ["Crm"] }, "patch": { "operationId": "LeadsController_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/LeadResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLead" } } } } }, "delete": { "operationId": "LeadsController_remove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Crm"] } }, "/api/v1/pipelines": { "get": { "operationId": "PipelinesController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Crm"] }, "post": { "operationId": "PipelinesController_create", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PipelineResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePipeline" } } } } } }, "/api/v1/pipelines/{id}": { "get": { "operationId": "PipelinesController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PipelineResponse" } } } } } } }, "tags": ["Crm"] }, "patch": { "operationId": "PipelinesController_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PipelineResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePipeline" } } } } }, "delete": { "operationId": "PipelinesController_remove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Crm"] } }, "/api/v1/crm-products": { "get": { "operationId": "CrmProductsController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/CrmProductResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Crm"] }, "post": { "operationId": "CrmProductsController_create", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmProductResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCrmProduct" } } } } } }, "/api/v1/crm-products/{id}": { "get": { "operationId": "CrmProductsController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmProductResponse" } } } } } } }, "tags": ["Crm"] }, "patch": { "operationId": "CrmProductsController_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmProductResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCrmProduct" } } } } }, "delete": { "operationId": "CrmProductsController_remove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Crm"] } }, "/api/v1/crm-custom-field-defs": { "get": { "operationId": "CrmCustomFieldDefsController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "objectType", "in": "query", "required": false, "schema": { "type": "string", "enum": ["lead", "deal", "contact", "company"] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/CrmCustomFieldDefResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Crm"] }, "post": { "operationId": "CrmCustomFieldDefsController_create", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmCustomFieldDefResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCrmCustomFieldDef" } } } } } }, "/api/v1/crm-custom-field-defs/{id}": { "get": { "operationId": "CrmCustomFieldDefsController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmCustomFieldDefResponse" } } } } } } }, "tags": ["Crm"] }, "patch": { "operationId": "CrmCustomFieldDefsController_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmCustomFieldDefResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCrmCustomFieldDef" } } } } }, "delete": { "operationId": "CrmCustomFieldDefsController_remove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Crm"] } }, "/api/v1/crm-lead-routes": { "get": { "operationId": "CrmLeadRoutesController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/CrmLeadRouteResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Crm"] }, "post": { "operationId": "CrmLeadRoutesController_create", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmLeadRouteResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCrmLeadRoute" } } } } } }, "/api/v1/crm-lead-routes/{id}": { "get": { "operationId": "CrmLeadRoutesController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmLeadRouteResponse" } } } } } } }, "tags": ["Crm"] }, "patch": { "operationId": "CrmLeadRoutesController_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmLeadRouteResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCrmLeadRoute" } } } } }, "delete": { "operationId": "CrmLeadRoutesController_remove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Crm"] } }, "/api/v1/crm-sequences": { "get": { "operationId": "CrmSequencesController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/CrmSequenceResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Crm"] }, "post": { "operationId": "CrmSequencesController_create", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmSequenceResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCrmSequence" } } } } } }, "/api/v1/crm-sequences/{id}": { "get": { "operationId": "CrmSequencesController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmSequenceResponse" } } } } } } }, "tags": ["Crm"] }, "patch": { "operationId": "CrmSequencesController_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmSequenceResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCrmSequence" } } } } }, "delete": { "operationId": "CrmSequencesController_remove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Crm"] } }, "/api/v1/crm-sequence-enrollments": { "get": { "operationId": "CrmSequenceEnrollmentsController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "sequenceId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/CrmSequenceEnrollmentResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Crm"] }, "post": { "operationId": "CrmSequenceEnrollmentsController_create", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmSequenceEnrollmentResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCrmSequenceEnrollment" } } } } } }, "/api/v1/crm-sequence-enrollments/{id}": { "get": { "operationId": "CrmSequenceEnrollmentsController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmSequenceEnrollmentResponse" } } } } } } }, "tags": ["Crm"] }, "patch": { "operationId": "CrmSequenceEnrollmentsController_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CrmSequenceEnrollmentResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCrmSequenceEnrollment" } } } } }, "delete": { "operationId": "CrmSequenceEnrollmentsController_remove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Crm"] } }, "/api/v1/client-portal-tokens": { "get": { "operationId": "ClientPortalTokensController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/ClientPortalTokenResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Crm"] }, "post": { "operationId": "ClientPortalTokensController_create", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ClientPortalTokenResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateClientPortalToken" } } } } } }, "/api/v1/client-portal-tokens/{id}": { "get": { "operationId": "ClientPortalTokensController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ClientPortalTokenResponse" } } } } } } }, "tags": ["Crm"] }, "patch": { "operationId": "ClientPortalTokensController_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ClientPortalTokenResponse" } } } } } } }, "tags": ["Crm"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClientPortalToken" } } } } }, "delete": { "operationId": "ClientPortalTokensController_remove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Crm"] } }, "/api/v1/mcp/info": { "get": { "operationId": "McpController_descriptor[0]", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpDescriptorResponse" } } } } }, "tags": ["Mcp"], "security": [], "summary": "MCP server descriptor", "description": "Public, human-readable server info, at `/info` (SP-20260929-MCPAUD — moved off the bare MCP endpoint, which now returns 405 on GET per the Streamable HTTP transport spec). Not part of the JSON-RPC protocol." } }, "/mcp/info": { "get": { "operationId": "McpController_descriptor[1]", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpDescriptorResponse" } } } } }, "tags": ["Mcp"], "security": [], "summary": "MCP server descriptor", "description": "Public, human-readable server info, at `/info` (SP-20260929-MCPAUD — moved off the bare MCP endpoint, which now returns 405 on GET per the Streamable HTTP transport spec). Not part of the JSON-RPC protocol." } }, "/api/v1/mcp": { "get": { "operationId": "McpController_getNotAllowed[0]", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpMethodNotAllowedResponse" } } } } }, "tags": ["Mcp"], "security": [], "summary": "GET is not supported on the MCP endpoint", "description": "This server is stateless (no SSE stream, no sessions) — the Streamable HTTP transport spec requires 405 for GET at the MCP endpoint when no SSE stream is offered. `Allow: POST` is set. See `/info` for the human-readable descriptor." }, "delete": { "operationId": "McpController_deleteNotAllowed[0]", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpMethodNotAllowedResponse" } } } } }, "tags": ["Mcp"], "security": [], "summary": "DELETE is not supported on the MCP endpoint", "description": "This server never assigns an `Mcp-Session-Id` — there is no session to terminate. `Allow: POST` is set." }, "post": { "operationId": "McpController_dispatch[0]", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpJsonRpcResponse" } } } } }, "tags": ["Mcp"], "security": [ { "mcpApiKeyOrJwt": [] } ], "summary": "MCP JSON-RPC 2.0 endpoint (streamable HTTP)", "description": "Methods: initialize, notifications/initialized, ping, tools/list, tools/call, resources/list, resources/read, prompts/list, prompts/get. Status is 200 on success, 202 with an empty body for notifications/initialized, 400 for an invalid JSON-RPC request, 404 for an unknown method/tool/resource (JSON-RPC error body). 401 if the API key/JWT is missing or invalid.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpJsonRpcRequest" } } } } } }, "/mcp": { "get": { "operationId": "McpController_getNotAllowed[1]", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpMethodNotAllowedResponse" } } } } }, "tags": ["Mcp"], "security": [], "summary": "GET is not supported on the MCP endpoint", "description": "This server is stateless (no SSE stream, no sessions) — the Streamable HTTP transport spec requires 405 for GET at the MCP endpoint when no SSE stream is offered. `Allow: POST` is set. See `/info` for the human-readable descriptor." }, "delete": { "operationId": "McpController_deleteNotAllowed[1]", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpMethodNotAllowedResponse" } } } } }, "tags": ["Mcp"], "security": [], "summary": "DELETE is not supported on the MCP endpoint", "description": "This server never assigns an `Mcp-Session-Id` — there is no session to terminate. `Allow: POST` is set." }, "post": { "operationId": "McpController_dispatch[1]", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpJsonRpcResponse" } } } } }, "tags": ["Mcp"], "security": [ { "mcpApiKeyOrJwt": [] } ], "summary": "MCP JSON-RPC 2.0 endpoint (streamable HTTP)", "description": "Methods: initialize, notifications/initialized, ping, tools/list, tools/call, resources/list, resources/read, prompts/list, prompts/get. Status is 200 on success, 202 with an empty body for notifications/initialized, 400 for an invalid JSON-RPC request, 404 for an unknown method/tool/resource (JSON-RPC error body). 401 if the API key/JWT is missing or invalid.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpJsonRpcRequest" } } } } } }, "/api/v1/mcp/oauth/consent/{pendingId}": { "get": { "operationId": "McpOAuthConsentController_getPending", "parameters": [ { "name": "pendingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpOAuthPendingConsent" } } } } }, "tags": ["Mcp OAuth"], "summary": "Get a pending MCP OAuth consent request", "description": "workspaceId/workspaceName are the caller's own session workspace. 404 `{ error: 'not_found' }` if unknown or no longer pending; 410 `{ error: 'expired' }` if past expiry." }, "post": { "operationId": "McpOAuthConsentController_decide", "parameters": [ { "name": "pendingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpOAuthConsentResult" } } } } }, "tags": ["Mcp OAuth"], "summary": "Approve or deny a pending MCP OAuth consent request", "description": "Returns the absolute redirect URL the browser must navigate to (code+state on approve, error=access_denied+state on deny), built server-side. Approve requires a console-MFA-cleared session when the caller needs that gate (403 otherwise). 404 on an invalid body; 410 if no longer pending or expired.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpOAuthConsentDecisionBody" } } } } } }, "/api/v1/mcp/oauth/grants": { "get": { "operationId": "McpOAuthGrantsController_list", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McpOAuthGrantSummary" } } } } } }, "tags": ["Mcp OAuth"], "summary": "List the workspace's active connected AI tools" } }, "/api/v1/mcp/oauth/grants/{grantId}": { "delete": { "operationId": "McpOAuthGrantsController_revoke", "parameters": [ { "name": "grantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpOAuthRevokeResponse" } } } } }, "tags": ["Mcp OAuth"], "summary": "Revoke a connected AI tool grant", "description": "Owner/admin, or the member who created the grant. 404 if the grant is not in this workspace; 403 otherwise unauthorized." } }, "/api/v1/agents/{id}/budget": { "get": { "operationId": "AgentBudgetsController_getAgentBudget", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Agent Budgets"] }, "patch": { "operationId": "AgentBudgetsController_updateAgentBudget", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Agent Budgets"] } }, "/api/v1/projects/{id}/costs": { "get": { "operationId": "AgentBudgetsController_getProjectCosts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Agent Budgets"] } }, "/api/v1/goals/{id}/costs": { "get": { "operationId": "AgentBudgetsController_getGoalCosts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Agent Budgets"] } }, "/api/v1/agents/{id}/pause": { "post": { "operationId": "AgentBudgetsController_pauseAgent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "tags": ["Agent Budgets"] } }, "/api/v1/agents/{id}/resume": { "post": { "operationId": "AgentBudgetsController_resumeAgent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "tags": ["Agent Budgets"] } }, "/api/v1/agents/{id}/terminate": { "post": { "operationId": "AgentBudgetsController_terminateAgent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "tags": ["Agent Budgets"] } }, "/api/v1/agents/{id}/governance-history": { "get": { "operationId": "AgentBudgetsController_getGovernanceHistory", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Agent Budgets"] } }, "/api/v1/hrms/employees": { "get": { "operationId": "HrmsController_listEmployees", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"] }, "post": { "operationId": "HrmsController_createEmployee", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/EmployeeResponse" } } } } } } }, "tags": ["Hrms"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEmployee" } } } } } }, "/api/v1/hrms/employees/{id}": { "get": { "operationId": "HrmsController_getEmployee", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/EmployeeResponse" } } } } } } }, "tags": ["Hrms"] }, "patch": { "operationId": "HrmsController_updateEmployee", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/EmployeeResponse" } } } } } } }, "tags": ["Hrms"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmployee" } } } } }, "delete": { "operationId": "HrmsController_deleteEmployee", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Hrms"] } }, "/api/v1/hrms/departments": { "get": { "operationId": "HrmsController_listDepartments", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"] }, "post": { "operationId": "HrmsController_createDepartment", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DepartmentResponse" } } } } } } }, "tags": ["Hrms"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDepartment" } } } } } }, "/api/v1/hrms/departments/{id}": { "get": { "operationId": "HrmsController_getDepartment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DepartmentResponse" } } } } } } }, "tags": ["Hrms"] }, "patch": { "operationId": "HrmsController_updateDepartment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DepartmentResponse" } } } } } } }, "tags": ["Hrms"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDepartment" } } } } }, "delete": { "operationId": "HrmsController_deleteDepartment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Hrms"] } }, "/api/v1/hrms/roles": { "get": { "operationId": "HrmsController_listRoles", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"] }, "post": { "operationId": "HrmsController_createRole", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/RoleResponse" } } } } } } }, "tags": ["Hrms"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRole" } } } } } }, "/api/v1/hrms/roles/{id}": { "get": { "operationId": "HrmsController_getRole", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/RoleResponse" } } } } } } }, "tags": ["Hrms"] }, "patch": { "operationId": "HrmsController_updateRole", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/RoleResponse" } } } } } } }, "tags": ["Hrms"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRole" } } } } }, "delete": { "operationId": "HrmsController_deleteRole", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Hrms"] } }, "/api/v1/hrms/shifts": { "get": { "operationId": "HrmsController_listShifts", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"] }, "post": { "operationId": "HrmsController_createShift", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ShiftResponse" } } } } } } }, "tags": ["Hrms"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShift" } } } } } }, "/api/v1/hrms/shifts/{id}": { "get": { "operationId": "HrmsController_getShift", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ShiftResponse" } } } } } } }, "tags": ["Hrms"] }, "patch": { "operationId": "HrmsController_updateShift", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ShiftResponse" } } } } } } }, "tags": ["Hrms"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShift" } } } } }, "delete": { "operationId": "HrmsController_deleteShift", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Hrms"] } }, "/api/v1/hrms/leave-requests": { "get": { "operationId": "HrmsController_listLeaveRequests", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"], "summary": "List leave requests" }, "post": { "operationId": "HrmsController_createLeaveRequest", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Submit a leave request for the caller", "description": "Self-service: employeeId is always the caller's own employee profile, status is forced to `pending`, and approvedById/approvedAt are cleared — body values for those fields are ignored. 400 if the caller has no employee profile.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLeaveRequest" } } } } } }, "/api/v1/hrms/leave-requests/{id}": { "get": { "operationId": "HrmsController_getLeaveRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Get a leave request" }, "patch": { "operationId": "HrmsController_updateLeaveRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Update a leave request", "description": "Owner/admin/manager, or the request's own author (LeaveRequestOwnRecordOrWriteRolesGuard). A non-elevated author may only leave status unchanged or set it to `cancelled`; approving/rejecting requires owner/admin/manager (403 otherwise).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLeaveRequest" } } } } }, "delete": { "operationId": "HrmsController_deleteLeaveRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Hrms"], "summary": "Delete a leave request", "description": "Owner/admin/manager, or the request's own author while it is still `pending` (403 once approved/rejected)." } }, "/api/v1/hrms/performance-reviews": { "get": { "operationId": "HrmsController_listPerformanceReviews", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"], "summary": "List performance reviews" }, "post": { "operationId": "HrmsController_createPerformanceReview", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Create a performance review", "description": "Requires `hrms.performance_reviews.create.workspace`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePerformanceReview" } } } } } }, "/api/v1/hrms/performance-reviews/{id}": { "get": { "operationId": "HrmsController_getPerformanceReview", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Get a performance review" }, "patch": { "operationId": "HrmsController_updatePerformanceReview", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Update a performance review", "description": "Requires `hrms.performance_reviews.update.workspace`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePerformanceReview" } } } } }, "delete": { "operationId": "HrmsController_deletePerformanceReview", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Hrms"], "summary": "Delete a performance review", "description": "Requires `hrms.performance_reviews.delete.workspace`." } }, "/api/v1/hrms/payroll-runs": { "get": { "operationId": "HrmsController_listPayrollRuns", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"], "summary": "List payroll runs", "description": "Requires `hrms.payroll_runs.view.department`." }, "post": { "operationId": "HrmsController_createPayrollRun", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Create a payroll run", "description": "Requires `hrms.payroll_runs.create.workspace`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePayrollRun" } } } } } }, "/api/v1/hrms/payroll-runs/{id}": { "get": { "operationId": "HrmsController_getPayrollRun", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Get a payroll run", "description": "Requires `hrms.payroll_runs.view.department`." }, "patch": { "operationId": "HrmsController_updatePayrollRun", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Update a payroll run", "description": "Requires `hrms.payroll_runs.update.workspace`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePayrollRun" } } } } }, "delete": { "operationId": "HrmsController_deletePayrollRun", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Hrms"], "summary": "Delete a payroll run", "description": "Requires `hrms.payroll_runs.delete.workspace`." } }, "/api/v1/hrms/compliance-records": { "get": { "operationId": "HrmsController_listComplianceRecords", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"], "summary": "List compliance records", "description": "Requires `hrms.compliance_records.view.department`; a department-scoped caller only sees records for employees in their own scope." }, "post": { "operationId": "HrmsController_createComplianceRecord", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Create a compliance record", "description": "Requires `hrms.compliance_records.create.workspace`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateComplianceRecord" } } } } } }, "/api/v1/hrms/compliance-records/{id}": { "get": { "operationId": "HrmsController_getComplianceRecord", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Get a compliance record", "description": "Requires `hrms.compliance_records.view.department`; same per-caller employee scoping as the list." }, "patch": { "operationId": "HrmsController_updateComplianceRecord", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Update a compliance record", "description": "Requires `hrms.compliance_records.update.workspace`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateComplianceRecord" } } } } }, "delete": { "operationId": "HrmsController_deleteComplianceRecord", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Hrms"], "summary": "Delete a compliance record", "description": "Requires `hrms.compliance_records.delete.workspace`." } }, "/api/v1/hrms/salary-structures": { "get": { "operationId": "HrmsController_listSalaryStructures", "parameters": [ { "name": "employeeId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"], "summary": "List an employee's salary structures", "description": "Gated by SalaryStructureAccessGuard." }, "post": { "operationId": "HrmsController_createSalaryStructure", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Create a salary structure", "description": "Requires `hrms.salary_structures.create.workspace`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSalaryStructure" } } } } } }, "/api/v1/hrms/salary-structures/current": { "get": { "operationId": "HrmsController_getCurrentSalaryStructure", "parameters": [ { "name": "employeeId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "asOf", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true, "nullable": true } } } } } } }, "tags": ["Hrms"], "summary": "Get an employee's salary structure effective on a date", "description": "Returns the structure whose effectiveFrom <= asOf (default: today) and whose effectiveTo is null or >= asOf, latest effectiveFrom first. `data` is null when none applies. Gated by SalaryStructureAccessGuard." } }, "/api/v1/hrms/salary-structures/{id}": { "get": { "operationId": "HrmsController_getSalaryStructure", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Get a salary structure", "description": "Gated by SalaryStructureAccessGuard." } }, "/api/v1/hrms/salary-revisions": { "get": { "operationId": "HrmsController_listSalaryRevisions", "parameters": [ { "name": "employeeId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"], "summary": "List an employee's salary revisions", "description": "Gated by SalaryStructureAccessGuard." } }, "/api/v1/hrms/salary-revisions/{id}": { "get": { "operationId": "HrmsController_getSalaryRevision", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Get a salary revision", "description": "Gated by SalaryStructureAccessGuard." } }, "/api/v1/hrms/employee-bonuses": { "get": { "operationId": "HrmsController_listEmployeeBonuses", "parameters": [ { "name": "employeeId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"], "summary": "List an employee's bonuses", "description": "Gated by SalaryStructureAccessGuard." }, "post": { "operationId": "HrmsController_createEmployeeBonus", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Create an employee bonus", "description": "Requires `hrms.employee_bonuses.create.workspace`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEmployeeBonus" } } } } } }, "/api/v1/hrms/employee-bonuses/{id}": { "get": { "operationId": "HrmsController_getEmployeeBonus", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Get an employee bonus", "description": "Gated by SalaryStructureAccessGuard." }, "patch": { "operationId": "HrmsController_updateEmployeeBonus", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Update an employee bonus", "description": "Requires `hrms.employee_bonuses.update.workspace`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmployeeBonus" } } } } }, "delete": { "operationId": "HrmsController_deleteEmployeeBonus", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Hrms"], "summary": "Delete an employee bonus", "description": "Requires `hrms.employee_bonuses.delete.workspace`. 400 \"Bonus not found\" if absent." } }, "/api/v1/hrms/arrears": { "get": { "operationId": "HrmsController_listArrears", "parameters": [ { "name": "employeeId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"], "summary": "List an employee's arrears records", "description": "Gated by SalaryStructureAccessGuard." }, "post": { "operationId": "HrmsController_createArrears", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Create an arrears record", "description": "Requires `hrms.arrears.create.workspace`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateArrears" } } } } } }, "/api/v1/hrms/arrears/{id}": { "get": { "operationId": "HrmsController_getArrears", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Hrms"], "summary": "Get an arrears record", "description": "Gated by SalaryStructureAccessGuard." } }, "/api/v1/hrms/payroll-activity": { "get": { "operationId": "HrmsController_listEmployeePayrollActivity", "parameters": [ { "name": "employeeId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityLogResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Hrms"], "summary": "List an employee's payroll activity feed", "description": "Activity-log entries for entityType `employee_profile` / entityId = employeeId. Validates its query with the same schema as the bonuses list (employeeId + limit/page). Gated by SalaryStructureAccessGuard." } }, "/api/v1/activity-logs": { "get": { "operationId": "ActivityController_listActivityLogs", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "object", "properties": { "equals": { "nullable": true } } } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Activity"] }, "post": { "operationId": "ActivityController_createActivityLog", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ActivityLogResponse" } } } } } } }, "tags": ["Activity"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateActivityLog" } } } } } }, "/api/v1/activity-logs/{id}": { "get": { "operationId": "ActivityController_getActivityLog", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ActivityLogResponse" } } } } } } }, "tags": ["Activity"] } }, "/api/v1/activity/screenshots": { "get": { "operationId": "ActivityController_listScreenshots", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Activity"] }, "post": { "operationId": "ActivityController_createScreenshot", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ScreenshotResponse" } } } } } } }, "tags": ["Activity"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScreenshot" } } } } } }, "/api/v1/activity/screenshots/{id}": { "get": { "operationId": "ActivityController_getScreenshot", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ScreenshotResponse" } } } } } } }, "tags": ["Activity"] }, "patch": { "operationId": "ActivityController_updateScreenshot", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ScreenshotResponse" } } } } } } }, "tags": ["Activity"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateScreenshot" } } } } }, "delete": { "operationId": "ActivityController_deleteScreenshot", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Activity"] } }, "/api/v1/activity/screenshots/{id}/blur": { "patch": { "operationId": "ActivityController_setBlurLevel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ScreenshotResponse" } } } } } } }, "tags": ["Activity"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetBlurLevelBody" } } } } } }, "/api/v1/activity/screenshots/{id}/score": { "patch": { "operationId": "ActivityController_setActivityScore", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ScreenshotResponse" } } } } } } }, "tags": ["Activity"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetActivityScoreBody" } } } } } }, "/api/v1/projects": { "post": { "operationId": "WorkServiceController_createProject", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProject" } } } } }, "get": { "operationId": "WorkServiceController_listProjects", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Work"] } }, "/api/v1/projects/{id}": { "get": { "operationId": "WorkServiceController_getProject", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"] }, "put": { "operationId": "WorkServiceController_updateProject", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProject" } } } } }, "delete": { "operationId": "WorkServiceController_deleteProject", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Work"] } }, "/api/v1/projects/{id}/merge": { "post": { "operationId": "WorkServiceController_mergeProject", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "tags": ["Work"] } }, "/api/v1/tasks": { "post": { "operationId": "WorkServiceController_createTask", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTask" } } } } }, "get": { "operationId": "WorkServiceController_listTasks", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Work"] } }, "/api/v1/tasks/{id}": { "get": { "operationId": "WorkServiceController_getTask", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"] }, "put": { "operationId": "WorkServiceController_updateTask", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTask" } } } } }, "delete": { "operationId": "WorkServiceController_deleteTask", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Work"] } }, "/api/v1/sprints": { "post": { "operationId": "WorkServiceController_createSprint", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSprint" } } } } }, "get": { "operationId": "WorkServiceController_listSprints", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Work"] } }, "/api/v1/sprints/{id}": { "get": { "operationId": "WorkServiceController_getSprint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"] }, "put": { "operationId": "WorkServiceController_updateSprint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSprint" } } } } }, "delete": { "operationId": "WorkServiceController_deleteSprint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Work"] } }, "/api/v1/milestones": { "post": { "operationId": "WorkServiceController_createMilestone", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["Work"] }, "get": { "operationId": "WorkServiceController_listMilestones", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["Work"] } }, "/api/v1/milestones/{id}": { "get": { "operationId": "WorkServiceController_getMilestone", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Work"] } }, "/api/v1/project-members": { "post": { "operationId": "WorkServiceController_assignProjectMember", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["Work"] } }, "/api/v1/chat-channels": { "post": { "operationId": "WorkServiceController_createChannel", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChatChannel" } } } } }, "get": { "operationId": "WorkServiceController_listChannels", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Work"] } }, "/api/v1/chat-channels/{id}": { "get": { "operationId": "WorkServiceController_getChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"] }, "put": { "operationId": "WorkServiceController_updateChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateChatChannel" } } } } }, "delete": { "operationId": "WorkServiceController_deleteChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Work"] } }, "/api/v1/chat-messages": { "post": { "operationId": "WorkServiceController_createMessage", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessage" } } } } }, "get": { "operationId": "WorkServiceController_listMessages", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Work"] } }, "/api/v1/chat-messages/{id}": { "get": { "operationId": "WorkServiceController_getMessage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"] }, "patch": { "operationId": "WorkServiceController_updateMessage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Work"] }, "delete": { "operationId": "WorkServiceController_deleteMessage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Work"] } }, "/api/v1/work-files": { "post": { "operationId": "WorkServiceController_createFile", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFile" } } } } }, "get": { "operationId": "WorkServiceController_listFiles", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Work"] } }, "/api/v1/work-files/{id}": { "get": { "operationId": "WorkServiceController_getFile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"] }, "put": { "operationId": "WorkServiceController_updateFile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Work"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFile" } } } } }, "delete": { "operationId": "WorkServiceController_deleteFile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Work"] } }, "/api/v1/approval-requests": { "get": { "operationId": "ApprovalsController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Approvals"] } }, "/api/v1/approval-requests/{id}": { "get": { "operationId": "ApprovalsController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Approvals"] } }, "/api/v1/approval-requests/{id}/decide": { "post": { "operationId": "ApprovalsController_decide", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Approvals"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideApproval" } } } } } }, "/api/v1/campaigns": { "post": { "operationId": "MarketingServiceController_createCampaign", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Marketing"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCampaign" } } } } }, "get": { "operationId": "MarketingServiceController_listCampaigns", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Marketing"] } }, "/api/v1/campaigns/{id}": { "get": { "operationId": "MarketingServiceController_getCampaign", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Marketing"] }, "put": { "operationId": "MarketingServiceController_updateCampaign", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Marketing"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCampaign" } } } } }, "delete": { "operationId": "MarketingServiceController_deleteCampaign", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Marketing"] } }, "/api/v1/email-templates": { "post": { "operationId": "MarketingServiceController_createEmailTemplate", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Marketing"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEmailTemplate" } } } } }, "get": { "operationId": "MarketingServiceController_listEmailTemplates", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Marketing"] } }, "/api/v1/email-templates/{id}": { "get": { "operationId": "MarketingServiceController_getEmailTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Marketing"] }, "put": { "operationId": "MarketingServiceController_updateEmailTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Marketing"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmailTemplate" } } } } }, "delete": { "operationId": "MarketingServiceController_deleteEmailTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Marketing"] } }, "/api/v1/marketing-forms": { "get": { "operationId": "MarketingServiceController_listForms", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Marketing"] }, "post": { "operationId": "MarketingServiceController_createForm", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Marketing"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMarketingForm" } } } } } }, "/api/v1/marketing-forms/{id}": { "get": { "operationId": "MarketingServiceController_getForm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Marketing"] }, "put": { "operationId": "MarketingServiceController_updateForm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Marketing"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMarketingForm" } } } } }, "delete": { "operationId": "MarketingServiceController_deleteForm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Marketing"] } }, "/api/v1/marketing-assets": { "post": { "operationId": "MarketingServiceController_createAsset", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Marketing"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAsset" } } } } }, "get": { "operationId": "MarketingServiceController_listAssets", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Marketing"] } }, "/api/v1/marketing-assets/{id}": { "get": { "operationId": "MarketingServiceController_getAsset", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Marketing"] }, "put": { "operationId": "MarketingServiceController_updateAsset", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Marketing"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAsset" } } } } }, "delete": { "operationId": "MarketingServiceController_deleteAsset", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Marketing"] } }, "/api/v1/invoices": { "get": { "operationId": "FinanceController_listInvoices", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "nullable": true } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createInvoice", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/InvoiceResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoice" } } } } } }, "/api/v1/invoices/{id}": { "get": { "operationId": "FinanceController_getInvoice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/InvoiceResponse" } } } } } } }, "tags": ["Finance"] }, "patch": { "operationId": "FinanceController_updateInvoice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/InvoiceResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoice" } } } } }, "delete": { "operationId": "FinanceController_deleteInvoice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/payments": { "get": { "operationId": "FinanceController_listPayments", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "nullable": true } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createPayment", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PaymentResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePayment" } } } } } }, "/api/v1/payments/{id}": { "get": { "operationId": "FinanceController_getPayment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PaymentResponse" } } } } } } }, "tags": ["Finance"] }, "patch": { "operationId": "FinanceController_updatePayment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PaymentResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePayment" } } } } }, "delete": { "operationId": "FinanceController_deletePayment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/budgets": { "get": { "operationId": "FinanceController_listBudgets", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "nullable": true } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createBudget", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/BudgetResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBudget" } } } } } }, "/api/v1/budgets/{id}": { "get": { "operationId": "FinanceController_getBudget", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/BudgetResponse" } } } } } } }, "tags": ["Finance"] }, "patch": { "operationId": "FinanceController_updateBudget", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/BudgetResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBudget" } } } } }, "delete": { "operationId": "FinanceController_deleteBudget", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/estimates": { "get": { "operationId": "FinanceController_listEstimates", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "nullable": true } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/EstimateResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] } }, "/api/v1/expenses": { "get": { "operationId": "FinanceController_listExpenses", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "nullable": true } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createExpense", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ExpenseResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExpense" } } } } } }, "/api/v1/expenses/{id}": { "get": { "operationId": "FinanceController_getExpense", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ExpenseResponse" } } } } } } }, "tags": ["Finance"] }, "patch": { "operationId": "FinanceController_updateExpense", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ExpenseResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateExpense" } } } } }, "delete": { "operationId": "FinanceController_deleteExpense", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/purchase-orders": { "get": { "operationId": "FinanceController_listPurchaseOrders", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "nullable": true } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createPurchaseOrder", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PurchaseOrderResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrder" } } } } } }, "/api/v1/purchase-orders/{id}": { "get": { "operationId": "FinanceController_getPurchaseOrder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PurchaseOrderResponse" } } } } } } }, "tags": ["Finance"] }, "patch": { "operationId": "FinanceController_updatePurchaseOrder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PurchaseOrderResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePurchaseOrder" } } } } }, "delete": { "operationId": "FinanceController_deletePurchaseOrder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/accounts": { "get": { "operationId": "FinanceController_listAccounts", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/AccountResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createAccount", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AccountResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccount" } } } } } }, "/api/v1/accounts/{id}": { "get": { "operationId": "FinanceController_getAccount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AccountResponse" } } } } } } }, "tags": ["Finance"] }, "patch": { "operationId": "FinanceController_updateAccount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AccountResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccount" } } } } }, "delete": { "operationId": "FinanceController_deleteAccount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/vendors": { "get": { "operationId": "FinanceController_listVendors", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/VendorResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createVendor", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/VendorResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVendor" } } } } } }, "/api/v1/vendors/{id}": { "get": { "operationId": "FinanceController_getVendor", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/VendorResponse" } } } } } } }, "tags": ["Finance"] }, "patch": { "operationId": "FinanceController_updateVendor", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/VendorResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVendor" } } } } }, "delete": { "operationId": "FinanceController_deleteVendor", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/payroll": { "get": { "operationId": "FinanceController_listPayroll", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createPayrollEntry", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PayrollResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePayroll" } } } } } }, "/api/v1/payroll/{id}": { "get": { "operationId": "FinanceController_getPayrollEntry", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PayrollResponse" } } } } } } }, "tags": ["Finance"] }, "patch": { "operationId": "FinanceController_updatePayrollEntry", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PayrollResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePayroll" } } } } }, "delete": { "operationId": "FinanceController_deletePayrollEntry", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/finance/ledger/summary": { "get": { "operationId": "FinanceController_getLedgerSummary", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/LedgerSummaryResponse" } } } } } } }, "tags": ["Finance"] } }, "/api/v1/finance/revenue/summary": { "get": { "operationId": "FinanceController_getRevenueSummary", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/RevenueSummaryResponse" } } } } } } }, "tags": ["Finance"] } }, "/api/v1/finance-tickets": { "get": { "operationId": "FinanceController_listTickets", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/FinanceTicketResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createTicket", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/FinanceTicketResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFinanceTicket" } } } } } }, "/api/v1/finance-tickets/{id}": { "get": { "operationId": "FinanceController_getTicket", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/FinanceTicketResponse" } } } } } } }, "tags": ["Finance"] }, "patch": { "operationId": "FinanceController_updateTicket", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/FinanceTicketResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFinanceTicket" } } } } }, "delete": { "operationId": "FinanceController_deleteTicket", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/recurring-expenses": { "get": { "operationId": "FinanceController_listRecurringExpenses", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringExpenseResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createRecurringExpense", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/RecurringExpenseResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRecurringExpense" } } } } } }, "/api/v1/recurring-expenses/{id}": { "get": { "operationId": "FinanceController_getRecurringExpense", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/RecurringExpenseResponse" } } } } } } }, "tags": ["Finance"] }, "patch": { "operationId": "FinanceController_updateRecurringExpense", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/RecurringExpenseResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRecurringExpense" } } } } }, "delete": { "operationId": "FinanceController_deleteRecurringExpense", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/expense-categories": { "get": { "operationId": "FinanceController_listExpenseCategories", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseCategoryResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createExpenseCategory", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ExpenseCategoryResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExpenseCategory" } } } } } }, "/api/v1/expense-categories/{id}": { "patch": { "operationId": "FinanceController_updateExpenseCategory", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ExpenseCategoryResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateExpenseCategory" } } } } }, "delete": { "operationId": "FinanceController_deleteExpenseCategory", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/tax-rates": { "get": { "operationId": "FinanceController_listTaxRates", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRateResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createTaxRate", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/TaxRateResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTaxRate" } } } } } }, "/api/v1/tax-rates/{id}": { "patch": { "operationId": "FinanceController_updateTaxRate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/TaxRateResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaxRate" } } } } }, "delete": { "operationId": "FinanceController_deleteTaxRate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/products": { "get": { "operationId": "FinanceController_listProducts", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/ProductResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Finance"] }, "post": { "operationId": "FinanceController_createProduct", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ProductResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProduct" } } } } } }, "/api/v1/products/{id}": { "get": { "operationId": "FinanceController_getProduct", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ProductResponse" } } } } } } }, "tags": ["Finance"] }, "patch": { "operationId": "FinanceController_updateProduct", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ProductResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProduct" } } } } }, "delete": { "operationId": "FinanceController_deleteProduct", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Finance"] } }, "/api/v1/invoices/from-time-log": { "post": { "operationId": "FinanceController_createInvoiceFromTimeLog", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/InvoiceFromTimeLogResponse" } } } } } } }, "tags": ["Finance"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceFromTimeLog" } } } } } }, "/v1/mail-log": { "get": { "operationId": "MailLogController_list", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["MailLog"] } }, "/v1/mail-log/test-send": { "post": { "operationId": "MailLogController_testSend", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["MailLog"] } }, "/api/v1/reports": { "get": { "operationId": "ReportsController_listReports", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "nullable": true } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Reports"] }, "post": { "operationId": "ReportsController_createReport", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ReportResponse" } } } } } } }, "tags": ["Reports"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReport" } } } } } }, "/api/v1/reports/{id}": { "get": { "operationId": "ReportsController_getReport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ReportResponse" } } } } } } }, "tags": ["Reports"] }, "patch": { "operationId": "ReportsController_updateReport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ReportResponse" } } } } } } }, "tags": ["Reports"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReport" } } } } }, "delete": { "operationId": "ReportsController_deleteReport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Reports"] } }, "/api/v1/report-definitions": { "get": { "operationId": "ReportDefinitionsController_listDefinitions", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "reportType", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "isShared", "in": "query", "required": false, "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDefinitionResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Report Definitions"] }, "post": { "operationId": "ReportDefinitionsController_createDefinition", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ReportDefinitionResponse" } } } } } } }, "tags": ["Report Definitions"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportDefinition" } } } } } }, "/api/v1/report-definitions/{id}": { "get": { "operationId": "ReportDefinitionsController_getDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ReportDefinitionResponse" } } } } } } }, "tags": ["Report Definitions"] }, "patch": { "operationId": "ReportDefinitionsController_updateDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ReportDefinitionResponse" } } } } } } }, "tags": ["Report Definitions"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReportDefinition" } } } } }, "delete": { "operationId": "ReportDefinitionsController_deleteDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Report Definitions"] } }, "/api/v1/report-definitions/{id}/run": { "post": { "operationId": "ReportDefinitionsController_runDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Report Definitions"] } }, "/api/v1/doc-categories": { "get": { "operationId": "DocsController_listCategories[0]", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "nullable": true } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Docs"], "summary": "List doc/wiki categories" }, "post": { "operationId": "DocsController_createCategory[0]", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CategoryResponse" } } } } } } }, "tags": ["Docs"], "summary": "Create a doc/wiki category", "description": "Owner/admin/manager only (WriteRolesGuard).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCategory" } } } } } }, "/api/v1/wiki-categories": { "get": { "operationId": "DocsController_listCategories[1]", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "nullable": true } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Docs"], "summary": "List doc/wiki categories" }, "post": { "operationId": "DocsController_createCategory[1]", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CategoryResponse" } } } } } } }, "tags": ["Docs"], "summary": "Create a doc/wiki category", "description": "Owner/admin/manager only (WriteRolesGuard).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCategory" } } } } } }, "/api/v1/doc-categories/{id}": { "get": { "operationId": "DocsController_getCategory[0]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CategoryResponse" } } } } } } }, "tags": ["Docs"], "summary": "Get a doc/wiki category", "description": "Returns 400 \"Category not found\" when the id does not exist in this workspace." }, "patch": { "operationId": "DocsController_updateCategory[0]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CategoryResponse" } } } } } } }, "tags": ["Docs"], "summary": "Update a doc/wiki category", "description": "Owner/admin/manager only (WriteRolesGuard).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCategory" } } } } }, "delete": { "operationId": "DocsController_deleteCategory[0]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Docs"], "summary": "Delete a doc/wiki category", "description": "Owner/admin/manager only (WriteRolesGuard)." } }, "/api/v1/wiki-categories/{id}": { "get": { "operationId": "DocsController_getCategory[1]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CategoryResponse" } } } } } } }, "tags": ["Docs"], "summary": "Get a doc/wiki category", "description": "Returns 400 \"Category not found\" when the id does not exist in this workspace." }, "patch": { "operationId": "DocsController_updateCategory[1]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CategoryResponse" } } } } } } }, "tags": ["Docs"], "summary": "Update a doc/wiki category", "description": "Owner/admin/manager only (WriteRolesGuard).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCategory" } } } } }, "delete": { "operationId": "DocsController_deleteCategory[1]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Docs"], "summary": "Delete a doc/wiki category", "description": "Owner/admin/manager only (WriteRolesGuard)." } }, "/api/v1/doc-pages": { "get": { "operationId": "DocsController_listPages[0]", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "properties": { "docType": { "type": "object", "properties": { "equals": { "type": "string", "enum": ["wiki", "sop", "doc"] } }, "required": ["equals"] }, "status": { "type": "object", "properties": { "equals": { "type": "string", "enum": ["draft", "published", "archived"] } }, "required": ["equals"] }, "isDeleted": { "type": "object", "properties": { "equals": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] } }, "required": ["equals"] }, "departmentId": { "type": "object", "properties": { "equals": { "type": "string", "format": "uuid" } }, "required": ["equals"] }, "authorId": { "type": "object", "properties": { "equals": { "type": "string", "format": "uuid" } }, "required": ["equals"] }, "lastEditedById": { "type": "object", "properties": { "equals": { "type": "string", "format": "uuid" } }, "required": ["equals"] }, "categoryId": { "type": "object", "properties": { "equals": { "type": "string", "format": "uuid" } }, "required": ["equals"] }, "tag": { "type": "object", "properties": { "equals": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": ["equals"] } } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Docs"], "summary": "List doc/wiki pages visible to the caller", "description": "Filters use the legacy `where[field][equals]=value` form (docType, status, isDeleted, departmentId, authorId, lastEditedById, categoryId, tag). Results are ACL-filtered to pages the caller can view." }, "post": { "operationId": "DocsController_createPage[0]", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PageResponse" } } } } } } }, "tags": ["Docs"], "summary": "Create a doc/wiki page", "description": "Owner/admin/manager only (WriteRolesGuard). authorId is taken from the caller's token, never the body.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePage" } } } } } }, "/api/v1/wiki-pages": { "get": { "operationId": "DocsController_listPages[1]", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "properties": { "docType": { "type": "object", "properties": { "equals": { "type": "string", "enum": ["wiki", "sop", "doc"] } }, "required": ["equals"] }, "status": { "type": "object", "properties": { "equals": { "type": "string", "enum": ["draft", "published", "archived"] } }, "required": ["equals"] }, "isDeleted": { "type": "object", "properties": { "equals": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] } }, "required": ["equals"] }, "departmentId": { "type": "object", "properties": { "equals": { "type": "string", "format": "uuid" } }, "required": ["equals"] }, "authorId": { "type": "object", "properties": { "equals": { "type": "string", "format": "uuid" } }, "required": ["equals"] }, "lastEditedById": { "type": "object", "properties": { "equals": { "type": "string", "format": "uuid" } }, "required": ["equals"] }, "categoryId": { "type": "object", "properties": { "equals": { "type": "string", "format": "uuid" } }, "required": ["equals"] }, "tag": { "type": "object", "properties": { "equals": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": ["equals"] } } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Docs"], "summary": "List doc/wiki pages visible to the caller", "description": "Filters use the legacy `where[field][equals]=value` form (docType, status, isDeleted, departmentId, authorId, lastEditedById, categoryId, tag). Results are ACL-filtered to pages the caller can view." }, "post": { "operationId": "DocsController_createPage[1]", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PageResponse" } } } } } } }, "tags": ["Docs"], "summary": "Create a doc/wiki page", "description": "Owner/admin/manager only (WriteRolesGuard). authorId is taken from the caller's token, never the body.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePage" } } } } } }, "/api/v1/doc-pages/tree": { "get": { "operationId": "DocsController_getTree[0]", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WikiTreeNode" } } } } } } } }, "tags": ["Docs"], "summary": "Get the doc/wiki page tree", "description": "All non-deleted pages the caller can view, nested by parentId. A page whose parent is missing or not visible to the caller is returned as a root." } }, "/api/v1/wiki-pages/tree": { "get": { "operationId": "DocsController_getTree[1]", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WikiTreeNode" } } } } } } } }, "tags": ["Docs"], "summary": "Get the doc/wiki page tree", "description": "All non-deleted pages the caller can view, nested by parentId. A page whose parent is missing or not visible to the caller is returned as a root." } }, "/api/v1/doc-pages/tags": { "get": { "operationId": "DocsController_listTags[0]", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "required": ["tag", "count"], "properties": { "tag": { "type": "string" }, "count": { "type": "integer", "minimum": 1 } } } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Docs"], "summary": "List wiki page tags", "description": "Distinct tags with page counts, counting only non-deleted pages the caller can view. A tag used only on pages hidden from the caller is not listed." } }, "/api/v1/wiki-pages/tags": { "get": { "operationId": "DocsController_listTags[1]", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "required": ["tag", "count"], "properties": { "tag": { "type": "string" }, "count": { "type": "integer", "minimum": 1 } } } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Docs"], "summary": "List wiki page tags", "description": "Distinct tags with page counts, counting only non-deleted pages the caller can view. A tag used only on pages hidden from the caller is not listed." } }, "/api/v1/doc-pages/{id}": { "get": { "operationId": "DocsController_getPage[0]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data", "access"], "properties": { "data": { "$ref": "#/components/schemas/PageResponse" }, "access": { "type": "string", "enum": ["editor", "viewer"] } } } } } } }, "tags": ["Docs"], "summary": "Get a doc/wiki page", "description": "Returns the page plus the caller's resolved access level. 400 \"Page not found\" if it does not exist; 403 if it exists but the caller cannot view it." }, "patch": { "operationId": "DocsController_updatePage[0]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PageResponse" } } } } } } }, "tags": ["Docs"], "summary": "Update a doc/wiki page", "description": "Owner/admin/manager, the page author, or an explicit editor grantee (WikiPageWriteAccessGuard).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePage" } } } } }, "delete": { "operationId": "DocsController_deletePage[0]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Docs"], "summary": "Delete a doc/wiki page", "description": "Owner/admin/manager, the page author, or an explicit editor grantee (WikiPageWriteAccessGuard)." } }, "/api/v1/wiki-pages/{id}": { "get": { "operationId": "DocsController_getPage[1]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data", "access"], "properties": { "data": { "$ref": "#/components/schemas/PageResponse" }, "access": { "type": "string", "enum": ["editor", "viewer"] } } } } } } }, "tags": ["Docs"], "summary": "Get a doc/wiki page", "description": "Returns the page plus the caller's resolved access level. 400 \"Page not found\" if it does not exist; 403 if it exists but the caller cannot view it." }, "patch": { "operationId": "DocsController_updatePage[1]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PageResponse" } } } } } } }, "tags": ["Docs"], "summary": "Update a doc/wiki page", "description": "Owner/admin/manager, the page author, or an explicit editor grantee (WikiPageWriteAccessGuard).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePage" } } } } }, "delete": { "operationId": "DocsController_deletePage[1]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Docs"], "summary": "Delete a doc/wiki page", "description": "Owner/admin/manager, the page author, or an explicit editor grantee (WikiPageWriteAccessGuard)." } }, "/api/v1/doc-pages/{id}/access": { "get": { "operationId": "DocsController_listPageAccess[0]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/WikiPageAccessGrant" } } } } } } } }, "tags": ["Docs"], "summary": "List explicit share grants on a page", "description": "Owner/admin/manager or the page author only (WikiPageShareAccessGuard)." }, "post": { "operationId": "DocsController_grantPageAccess[0]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Docs"], "summary": "Share a page with a user (upsert)", "description": "Owner/admin/manager or the page author only (WikiPageShareAccessGuard). Re-granting an existing user updates their role. Returns the raw wiki_page_access row.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantPageAccess" } } } } } }, "/api/v1/wiki-pages/{id}/access": { "get": { "operationId": "DocsController_listPageAccess[1]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/WikiPageAccessGrant" } } } } } } } }, "tags": ["Docs"], "summary": "List explicit share grants on a page", "description": "Owner/admin/manager or the page author only (WikiPageShareAccessGuard)." }, "post": { "operationId": "DocsController_grantPageAccess[1]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Docs"], "summary": "Share a page with a user (upsert)", "description": "Owner/admin/manager or the page author only (WikiPageShareAccessGuard). Re-granting an existing user updates their role. Returns the raw wiki_page_access row.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantPageAccess" } } } } } }, "/api/v1/doc-pages/{id}/access/{userId}": { "delete": { "operationId": "DocsController_revokePageAccess[0]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Docs"], "summary": "Remove a user's share grant on a page", "description": "Owner/admin/manager or the page author only (WikiPageShareAccessGuard)." } }, "/api/v1/wiki-pages/{id}/access/{userId}": { "delete": { "operationId": "DocsController_revokePageAccess[1]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Docs"], "summary": "Remove a user's share grant on a page", "description": "Owner/admin/manager or the page author only (WikiPageShareAccessGuard)." } }, "/api/v1/goals": { "get": { "operationId": "GoalsController_listGoals", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "nullable": true } }, "style": "deepObject", "explode": true } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Goals"] }, "post": { "operationId": "GoalsController_createGoal", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/GoalResponse" } } } } } } }, "tags": ["Goals"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGoal" } } } } } }, "/api/v1/goals/{id}": { "get": { "operationId": "GoalsController_getGoal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/GoalResponse" } } } } } } }, "tags": ["Goals"] }, "patch": { "operationId": "GoalsController_updateGoal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/GoalResponse" } } } } } } }, "tags": ["Goals"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGoal" } } } } }, "delete": { "operationId": "GoalsController_deleteGoal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Goals"] } }, "/api/v1/okrs": { "get": { "operationId": "OkrsController_list", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/OkrResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Goals"] }, "post": { "operationId": "OkrsController_create", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OkrResponse" } } } } } } }, "tags": ["Goals"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOkr" } } } } } }, "/api/v1/okrs/{id}": { "get": { "operationId": "OkrsController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OkrResponse" } } } } } } }, "tags": ["Goals"] }, "patch": { "operationId": "OkrsController_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OkrResponse" } } } } } } }, "tags": ["Goals"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOkr" } } } } }, "delete": { "operationId": "OkrsController_remove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Goals"] } }, "/api/v1/one-on-one-meetings": { "get": { "operationId": "GoalsExtrasController_listMeetings", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/OneOnOneMeetingResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Goals"] }, "post": { "operationId": "GoalsExtrasController_createMeeting", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OneOnOneMeetingResponse" } } } } } } }, "tags": ["Goals"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMeeting" } } } } } }, "/api/v1/one-on-one-meetings/{id}": { "get": { "operationId": "GoalsExtrasController_getMeeting", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OneOnOneMeetingResponse" } } } } } } }, "tags": ["Goals"] }, "patch": { "operationId": "GoalsExtrasController_updateMeeting", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OneOnOneMeetingResponse" } } } } } } }, "tags": ["Goals"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMeeting" } } } } }, "delete": { "operationId": "GoalsExtrasController_deleteMeeting", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Goals"] } }, "/api/v1/appreciations": { "get": { "operationId": "GoalsExtrasController_listAppreciations", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/AppreciationResponse" } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Goals"] }, "post": { "operationId": "GoalsExtrasController_createAppreciation", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AppreciationResponse" } } } } } } }, "tags": ["Goals"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppreciation" } } } } } }, "/api/v1/appreciations/{id}": { "get": { "operationId": "GoalsExtrasController_getAppreciation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AppreciationResponse" } } } } } } }, "tags": ["Goals"] }, "patch": { "operationId": "GoalsExtrasController_updateAppreciation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AppreciationResponse" } } } } } } }, "tags": ["Goals"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppreciation" } } } } }, "delete": { "operationId": "GoalsExtrasController_deleteAppreciation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Goals"] } }, "/api/v1/channels": { "get": { "operationId": "SupportController_listChannels", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Support"] }, "post": { "operationId": "SupportController_createChannel", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ChannelResponse" } } } } } } }, "tags": ["Support"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChannel" } } } } } }, "/api/v1/channels/{id}": { "get": { "operationId": "SupportController_getChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ChannelResponse" } } } } } } }, "tags": ["Support"] }, "patch": { "operationId": "SupportController_updateChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ChannelResponse" } } } } } } }, "tags": ["Support"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateChannel" } } } } }, "delete": { "operationId": "SupportController_deleteChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Support"] } }, "/api/v1/tickets": { "get": { "operationId": "SupportController_listTickets", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "assigneeId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Support"] }, "post": { "operationId": "SupportController_createTicket", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/TicketResponse" } } } } } } }, "tags": ["Support"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTicket" } } } } } }, "/api/v1/tickets/{id}": { "get": { "operationId": "SupportController_getTicket", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/TicketResponse" } } } } } } }, "tags": ["Support"] }, "patch": { "operationId": "SupportController_updateTicket", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/TicketResponse" } } } } } } }, "tags": ["Support"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTicket" } } } } }, "delete": { "operationId": "SupportController_deleteTicket", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Support"] } }, "/api/v1/tickets/{id}/assign": { "patch": { "operationId": "SupportController_assignTicket", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/TicketResponse" } } } } } } }, "tags": ["Support"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignTicketBody" } } } } } }, "/api/v1/tickets/{id}/link-task": { "post": { "operationId": "SupportController_linkTask", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "tags": ["Support"] } }, "/api/v1/tickets/{id}/link-task/{taskId}": { "delete": { "operationId": "SupportController_unlinkTask", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Support"] } }, "/api/v1/helpdesk-mailboxes": { "get": { "operationId": "HelpdeskMailboxesController_list", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["Support"] }, "post": { "operationId": "HelpdeskMailboxesController_create", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["Support"] } }, "/api/v1/helpdesk-mailboxes/{id}": { "get": { "operationId": "HelpdeskMailboxesController_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Support"] }, "patch": { "operationId": "HelpdeskMailboxesController_update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Support"] }, "delete": { "operationId": "HelpdeskMailboxesController_remove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Support"] } }, "/api/v1/ai/agents": { "get": { "operationId": "AiController_listAgents", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Ai"] }, "post": { "operationId": "AiController_createAgent", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AgentResponse" } } } } } } }, "tags": ["Ai"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgent" } } } } } }, "/api/v1/ai/agents/{id}": { "get": { "operationId": "AiController_getAgent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AgentResponse" } } } } } } }, "tags": ["Ai"] }, "patch": { "operationId": "AiController_updateAgent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AgentResponse" } } } } } } }, "tags": ["Ai"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgent" } } } } }, "delete": { "operationId": "AiController_deleteAgent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Ai"] } }, "/api/v1/ai/agents/{id}/deploy": { "post": { "operationId": "AiController_deployAgent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AgentResponse" } } } } } } }, "tags": ["Ai"] } }, "/api/v1/ai/prompts": { "get": { "operationId": "AiController_listPrompts", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Ai"] }, "post": { "operationId": "AiController_createPrompt", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PromptResponse" } } } } } } }, "tags": ["Ai"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePrompt" } } } } } }, "/api/v1/ai/prompts/{id}": { "get": { "operationId": "AiController_getPrompt", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PromptResponse" } } } } } } }, "tags": ["Ai"] }, "patch": { "operationId": "AiController_updatePrompt", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/PromptResponse" } } } } } } }, "tags": ["Ai"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePrompt" } } } } }, "delete": { "operationId": "AiController_deletePrompt", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Ai"] } }, "/api/v1/ai/workflows": { "get": { "operationId": "AiController_listWorkflows", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Ai"] }, "post": { "operationId": "AiController_createWorkflow", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WorkflowResponse" } } } } } } }, "tags": ["Ai"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkflow" } } } } } }, "/api/v1/ai/workflows/{id}": { "get": { "operationId": "AiController_getWorkflow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WorkflowResponse" } } } } } } }, "tags": ["Ai"] }, "patch": { "operationId": "AiController_updateWorkflow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WorkflowResponse" } } } } } } }, "tags": ["Ai"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkflow" } } } } }, "delete": { "operationId": "AiController_deleteWorkflow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Ai"] } }, "/api/v1/ai/workflows/{id}/activate": { "post": { "operationId": "AiController_activateWorkflow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WorkflowResponse" } } } } } } }, "tags": ["Ai"] } }, "/api/v1/agents/{agentId}/api-keys": { "post": { "operationId": "AgentApiKeysController_mintKey", "parameters": [ { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "tags": ["Agent API Keys"] }, "get": { "operationId": "AgentApiKeysController_listKeys", "parameters": [ { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Agent API Keys"] } }, "/api/v1/agents/{agentId}/api-keys/{keyId}": { "delete": { "operationId": "AgentApiKeysController_revokeKey", "parameters": [ { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Agent API Keys"] } }, "/api/v1/agents": { "get": { "operationId": "AgentMembersController_listAgents", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["Agent Members"] }, "post": { "operationId": "AgentMembersController_createAgent", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["Agent Members"] } }, "/api/v1/agents/{id}": { "get": { "operationId": "AgentMembersController_getAgent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Agent Members"] }, "patch": { "operationId": "AgentMembersController_updateAgent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Agent Members"] }, "delete": { "operationId": "AgentMembersController_deleteAgent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Agent Members"] } }, "/api/v1/client-orgs": { "get": { "operationId": "ClientsController_listClientOrgs", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Clients"] }, "post": { "operationId": "ClientsController_createClientOrg", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ClientOrgResponse" } } } } } } }, "tags": ["Clients"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateClientOrg" } } } } } }, "/api/v1/client-orgs/{id}": { "get": { "operationId": "ClientsController_getClientOrg", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ClientOrgResponse" } } } } } } }, "tags": ["Clients"] }, "patch": { "operationId": "ClientsController_updateClientOrg", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ClientOrgResponse" } } } } } } }, "tags": ["Clients"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClientOrg" } } } } }, "delete": { "operationId": "ClientsController_deleteClientOrg", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Clients"] } }, "/api/v1/client-contacts": { "get": { "operationId": "ClientsController_listClientContacts", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "clientOrgId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Clients"] }, "post": { "operationId": "ClientsController_createClientContact", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ClientContactResponse" } } } } } } }, "tags": ["Clients"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateClientContact" } } } } } }, "/api/v1/client-contacts/{id}": { "get": { "operationId": "ClientsController_getClientContact", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ClientContactResponse" } } } } } } }, "tags": ["Clients"] }, "patch": { "operationId": "ClientsController_updateClientContact", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ClientContactResponse" } } } } } } }, "tags": ["Clients"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClientContact" } } } } }, "delete": { "operationId": "ClientsController_deleteClientContact", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Clients"] } }, "/api/v1/calendars": { "get": { "operationId": "CalendarController_listCalendars", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Calendar"] }, "post": { "operationId": "CalendarController_createCalendar", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Calendar"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCalendar" } } } } } }, "/api/v1/calendars/{id}": { "get": { "operationId": "CalendarController_getCalendar", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Calendar"] }, "patch": { "operationId": "CalendarController_updateCalendar", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Calendar"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCalendar" } } } } }, "delete": { "operationId": "CalendarController_deleteCalendar", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Calendar"] } }, "/api/v1/calendar-events": { "get": { "operationId": "CalendarController_listCalendarEvents", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "calendarId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Calendar"] }, "post": { "operationId": "CalendarController_createCalendarEvent", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Calendar"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCalendarEvent" } } } } } }, "/api/v1/calendar-events/{id}": { "get": { "operationId": "CalendarController_getCalendarEvent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Calendar"] }, "patch": { "operationId": "CalendarController_updateCalendarEvent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Calendar"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCalendarEvent" } } } } }, "delete": { "operationId": "CalendarController_deleteCalendarEvent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Calendar"] } }, "/api/v1/webhooks": { "get": { "operationId": "IntegrationsController_listWebhooks", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Integrations"] }, "post": { "operationId": "IntegrationsController_createWebhook", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Integrations"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhook" } } } } } }, "/api/v1/webhooks/{id}": { "get": { "operationId": "IntegrationsController_getWebhook", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Integrations"] }, "patch": { "operationId": "IntegrationsController_updateWebhook", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Integrations"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhook" } } } } }, "delete": { "operationId": "IntegrationsController_deleteWebhook", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Integrations"] } }, "/api/v1/integration-tokens": { "get": { "operationId": "IntegrationsController_listIntegrationTokens", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "provider", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Integrations"] }, "post": { "operationId": "IntegrationsController_createIntegrationToken", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Integrations"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIntegrationToken" } } } } } }, "/api/v1/integration-tokens/{id}": { "get": { "operationId": "IntegrationsController_getIntegrationToken", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Integrations"] }, "patch": { "operationId": "IntegrationsController_updateIntegrationToken", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Integrations"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIntegrationToken" } } } } }, "delete": { "operationId": "IntegrationsController_deleteIntegrationToken", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Integrations"] } }, "/api/v1/job-postings": { "get": { "operationId": "RecruitmentController_listJobPostings", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Recruitment"] }, "post": { "operationId": "RecruitmentController_createJobPosting", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Recruitment"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJobPosting" } } } } } }, "/api/v1/job-postings/{id}": { "get": { "operationId": "RecruitmentController_getJobPosting", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Recruitment"] }, "patch": { "operationId": "RecruitmentController_updateJobPosting", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Recruitment"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateJobPosting" } } } } }, "delete": { "operationId": "RecruitmentController_deleteJobPosting", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Recruitment"] } }, "/api/v1/applicants": { "get": { "operationId": "RecruitmentController_listApplicants", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "jobPostingId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Recruitment"] }, "post": { "operationId": "RecruitmentController_createApplicant", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Recruitment"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApplicant" } } } } } }, "/api/v1/applicants/{id}": { "get": { "operationId": "RecruitmentController_getApplicant", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Recruitment"] }, "patch": { "operationId": "RecruitmentController_updateApplicant", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Recruitment"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApplicant" } } } } }, "delete": { "operationId": "RecruitmentController_deleteApplicant", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Recruitment"] } }, "/api/v1/interviews": { "get": { "operationId": "RecruitmentController_listInterviews", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "applicantId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Recruitment"] }, "post": { "operationId": "RecruitmentController_createInterview", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Recruitment"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInterview" } } } } } }, "/api/v1/interviews/{id}": { "get": { "operationId": "RecruitmentController_getInterview", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Recruitment"] }, "patch": { "operationId": "RecruitmentController_updateInterview", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } } }, "tags": ["Recruitment"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInterview" } } } } }, "delete": { "operationId": "RecruitmentController_deleteInterview", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Recruitment"] } }, "/api/v1/recruitment-scorecards": { "get": { "operationId": "RecruitmentController_listScorecards", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["Recruitment"] }, "post": { "operationId": "RecruitmentController_createScorecard", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["Recruitment"] } }, "/api/v1/recruitment-scorecards/{id}": { "get": { "operationId": "RecruitmentController_getScorecard", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Recruitment"] }, "patch": { "operationId": "RecruitmentController_updateScorecard", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Recruitment"] }, "delete": { "operationId": "RecruitmentController_deleteScorecard", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Recruitment"] } }, "/api/v1/lms": { "get": { "operationId": "LmsServiceController_list", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "description": "Hardcoded stub response — this module is not implemented.", "properties": { "docs": { "type": "array", "items": {}, "example": [] }, "totalDocs": { "type": "integer", "example": 0 }, "page": { "type": "integer", "example": 1 }, "totalPages": { "type": "integer", "example": 0 } } } } } } }, "tags": ["Lms"] } }, "/api/v1/lms/enrollments": { "get": { "operationId": "LmsServiceController_listEnrollments", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "courseId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Lms"] }, "post": { "operationId": "LmsServiceController_createEnrollment", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["Lms"] } }, "/api/v1/lms/enrollments/{id}": { "get": { "operationId": "LmsServiceController_getEnrollment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Lms"] }, "patch": { "operationId": "LmsServiceController_updateEnrollment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Lms"] }, "delete": { "operationId": "LmsServiceController_deleteEnrollment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Lms"] } }, "/api/v1/lms/modules": { "get": { "operationId": "LmsServiceController_listModules", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "courseId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Lms"] }, "post": { "operationId": "LmsServiceController_createModule", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["Lms"] } }, "/api/v1/lms/modules/{id}": { "get": { "operationId": "LmsServiceController_getModule", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Lms"] }, "patch": { "operationId": "LmsServiceController_updateModule", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Lms"] }, "delete": { "operationId": "LmsServiceController_deleteModule", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Lms"] } }, "/api/v1/lms/lessons": { "get": { "operationId": "LmsServiceController_listLessons", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "moduleId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs", "page", "totalPages"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "tags": ["Lms"] }, "post": { "operationId": "LmsServiceController_createLesson", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["Lms"] } }, "/api/v1/lms/lessons/{id}": { "get": { "operationId": "LmsServiceController_getLesson", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Lms"] }, "patch": { "operationId": "LmsServiceController_updateLesson", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Lms"] }, "delete": { "operationId": "LmsServiceController_deleteLesson", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Lms"] } }, "/api/v1/lms/courses/{courseId}/lessons": { "get": { "operationId": "LmsServiceController_getCourseLessonsFlattened", "parameters": [ { "name": "courseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Lms"] } }, "/api/v1/lms/lessons/{id}/complete": { "post": { "operationId": "LmsServiceController_completeLesson", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "tags": ["Lms"] } }, "/api/v1/lms/courses/favorites": { "get": { "operationId": "LmsServiceController_listFavoriteCourses", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["Lms"] } }, "/api/v1/lms/courses/{courseId}/favorite": { "post": { "operationId": "LmsServiceController_favoriteCourse", "parameters": [ { "name": "courseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "tags": ["Lms"] }, "delete": { "operationId": "LmsServiceController_unfavoriteCourse", "parameters": [ { "name": "courseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Lms"] } }, "/api/doc-categories": { "get": { "operationId": "PublicContentController_listDocCategories", "parameters": [ { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "properties": { "slug": { "type": "object", "properties": { "equals": { "type": "string" } } }, "section": { "type": "object", "properties": { "equals": { "type": "string" } } } } }, "style": "deepObject", "explode": true }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "description": "Payload REST-shaped paginated list (legacy compat).", "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } } }, "tags": ["Public Content"], "security": [] } }, "/api/doc-articles": { "get": { "operationId": "PublicContentController_listDocArticles", "parameters": [ { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "properties": { "slug": { "type": "object", "properties": { "equals": { "type": "string" } } }, "category": { "type": "object", "properties": { "equals": { "type": "string" } } }, "status": { "type": "object", "properties": { "equals": { "type": "string" } } } } }, "style": "deepObject", "explode": true }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 2, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "description": "Payload REST-shaped paginated list (legacy compat).", "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } } }, "tags": ["Public Content"], "security": [] } }, "/api/changelog": { "get": { "operationId": "PublicContentController_listChangelog", "parameters": [ { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "properties": { "isPublished": { "type": "object", "properties": { "equals": { "type": "string" } } }, "module": { "type": "object", "properties": { "equals": { "type": "string" } } }, "version": { "type": "object", "properties": { "equals": { "type": "string" } } }, "releaseDate": { "type": "object", "properties": { "equals": { "type": "string" }, "greater_than_equal": { "type": "string" }, "less_than_equal": { "type": "string" } } } } }, "style": "deepObject", "explode": true }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 200 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "description": "Payload REST-shaped paginated list (legacy compat).", "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } } }, "tags": ["Public Content"], "security": [] } }, "/api/faqs": { "get": { "operationId": "PublicContentController_listFaqs", "parameters": [ { "name": "where", "in": "query", "required": false, "schema": { "type": "object", "properties": { "category": { "type": "object", "properties": { "equals": { "type": "string" } } } } }, "style": "deepObject", "explode": true }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "description": "Payload REST-shaped paginated list (legacy compat).", "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } } }, "tags": ["Public Content"], "security": [] } }, "/api/careers-openings": { "get": { "operationId": "PublicContentController_listCareersOpenings", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "description": "Payload REST-shaped paginated list (legacy compat).", "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "totalPages": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } } }, "tags": ["Public Content"] } }, "/api/roadmap-items": { "get": { "operationId": "ContentAdminController_listRoadmap", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" } } } } } } }, "tags": ["Content Admin"], "security": [], "description": "`limit` defaults to 200; larger values are clamped to 500. 400 if it is not a positive integer." } }, "/api/testimonials": { "get": { "operationId": "ContentAdminController_listTestimonials", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" } } } } } } }, "tags": ["Content Admin"], "security": [], "description": "`limit` defaults to 200; larger values are clamped to 500. 400 if it is not a positive integer." } }, "/api/feature-ideas": { "get": { "operationId": "ContentAdminController_listFeatureIdeas", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" } } } } } } }, "tags": ["Content Admin"], "security": [], "description": "`limit` defaults to 200; larger values are clamped to 500. 400 if it is not a positive integer." } }, "/api/blog-posts": { "get": { "operationId": "ContentAdminController_listBlogPosts", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" } } } } } } }, "tags": ["Content Admin"], "security": [], "description": "`limit` defaults to 50; larger values are clamped to 100. 400 if it is not a positive integer." } }, "/api/blog-posts/{slug}": { "get": { "operationId": "ContentAdminController_getBlogPostBySlug", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "tags": ["Content Admin"], "security": [] } }, "/api/blog-categories": { "get": { "operationId": "ContentAdminController_listBlogCategories", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" } } } } } } }, "tags": ["Content Admin"], "security": [], "description": "`limit` defaults to 100; larger values are clamped to 200. 400 if it is not a positive integer." } }, "/api/blog-tags": { "get": { "operationId": "ContentAdminController_listBlogTags", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" } } } } } } }, "tags": ["Content Admin"], "security": [], "description": "`limit` defaults to 100; larger values are clamped to 200. 400 if it is not a positive integer." } }, "/api/surveys": { "get": { "operationId": "ContentAdminController_listSurveys", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" } } } } } } }, "tags": ["Content Admin"], "security": [], "description": "`limit` defaults to 50; larger values are clamped to 100. 400 if it is not a positive integer." } }, "/api/surveys/{id}": { "get": { "operationId": "ContentAdminController_getSurvey", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "tags": ["Content Admin"], "security": [] } }, "/api/platform-tickets": { "get": { "operationId": "ContentAdminController_listPlatformTickets", "parameters": [ { "name": "reporterUserId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 } }, { "name": "reporterEmail", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 320 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" } } } } } } }, "tags": ["Content Admin"], "security": [ { "internalApiKey": [] } ], "summary": "List platform support tickets", "description": "Optional `reporterUserId`/`reporterEmail` query filters (OR-ed when both are given); `limit` defaults to 200, capped at 500." } }, "/api/platform-tickets/{id}": { "get": { "operationId": "ContentAdminController_getPlatformTicket", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "required": ["messages"], "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/PlatformTicketMessage" } } } } } } } }, "tags": ["Content Admin"], "security": [ { "internalApiKey": [] } ], "summary": "Get a platform ticket with its message thread", "description": "404 \"ticket not found\" if absent." } }, "/api/platform-leads": { "get": { "operationId": "ContentAdminController_listPlatformLeads", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 50 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["docs", "totalDocs"], "properties": { "docs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "totalDocs": { "type": "integer" } } } } } } }, "tags": ["Content Admin"], "security": [ { "internalApiKey": [] } ], "summary": "List platform CRM leads", "description": "Optional `status` query filter; `limit` defaults to 200, capped at 500." } }, "/api/feature-ideas/{id}/upvote": { "post": { "operationId": "ContentAdminController_upvoteFeatureIdea", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "tags": ["Content Admin"], "security": [ { "internalApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpvoteFeatureIdeaBody" } } } } } }, "/api/surveys/{id}/responses": { "post": { "operationId": "ContentAdminController_submitSurveyResponse", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "tags": ["Content Admin"], "security": [ { "internalApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitSurveyResponseBody" } } } } } }, "/api/platform-tickets/{id}/messages": { "post": { "operationId": "ContentAdminController_addPlatformTicketMessage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformTicketMessage" } } } } }, "tags": ["Content Admin"], "security": [ { "internalApiKey": [] } ], "summary": "Append a message to a platform ticket", "description": "400 if `content` is empty after trimming (or over 20,000 characters). A non-internal message with an authorId notifies the ticket reporter.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddPlatformTicketMessageBody" } } } } } }, "/api/{collection}": { "post": { "operationId": "ContentAdminController_create", "parameters": [ { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "tags": ["Content Admin"], "security": [ { "internalApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAdminWriteBody" } } } } } }, "/api/{collection}/{id}": { "patch": { "operationId": "ContentAdminController_update", "parameters": [ { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "tags": ["Content Admin"], "security": [ { "internalApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAdminWriteBody" } } } } }, "delete": { "operationId": "ContentAdminController_remove", "parameters": [ { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["success"], "properties": { "success": { "type": "boolean", "example": true } } } } } } }, "tags": ["Content Admin"], "security": [ { "internalApiKey": [] } ] } }, "/api/trial-extension-requests": { "get": { "operationId": "TrialExtensionRequestsController_list", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["Billing — Trial Extensions"] } }, "/api/trial-extension-requests/{id}": { "get": { "operationId": "TrialExtensionRequestsController_getById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Billing — Trial Extensions"] } }, "/api/trial-extension-requests/{id}/decision": { "post": { "operationId": "TrialExtensionRequestsController_decide", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "tags": ["Billing — Trial Extensions"] } }, "/v1/internal/migration-status": { "get": { "operationId": "MigrationStatusController_check", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "track", "in": "query", "required": false, "schema": { "type": "string", "enum": ["payload", "drizzle"], "default": "payload" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["name", "track", "found"], "properties": { "name": { "type": "string" }, "track": { "type": "string", "enum": ["payload", "drizzle"] }, "found": { "type": "boolean" } } } } } } }, "tags": ["Internal"], "summary": "Check whether a migration has been applied (CI only)", "description": "Bearer CI_MIGRATION_VERIFY_TOKEN (401 otherwise, checked before the query is validated). 400 if `name` is missing or `track` is not payload|drizzle." } }, "/api/v1/migration-health": { "get": { "operationId": "MigrationHealthController_get", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["MigrationHealth"] } }, "/v1/internal/everhour-migration/run": { "post": { "operationId": "EverhourMigrationController_run", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["Internal"] } }, "/v1/internal/everhour-migration/status/{jobId}": { "get": { "operationId": "EverhourMigrationController_status", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Internal"] } }, "/v1/privacy/export": { "get": { "operationId": "PrivacyController_export", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyExportResponse" } } } } }, "tags": ["Privacy"], "summary": "Export the caller's personal data (GDPR Art. 15/20)", "description": "Scoped to the JWT `sub`; impersonation tokens get 403. Rate-limited to 5 per hour per user (429). Writes a `privacy.data_export` audit row per member workspace." } }, "/v1/privacy/erasure": { "post": { "operationId": "PrivacyController_erasure", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyErasureResponse" } } } } }, "tags": ["Privacy"], "summary": "Erase the caller's account (GDPR Art. 17)", "description": "Irreversible. Requires the current password (403 when wrong) and the exact confirmation phrase (400). 409 when the caller owns a workspace that still has other members. Anonymizes PII, deactivates memberships, revokes every session; business records and audit_logs are kept. 5 attempts per hour per user (429).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyErasureBody" } } } } } } }, "info": { "title": "AmDital API", "description": "AmDital enterprise business operating system API — generated directly from the live NestJS controllers and their Zod request/response schemas (see apps/api/src/openapi/generate.ts).", "version": "2.0.0", "contact": {} }, "tags": [ { "name": "Health", "description": "Liveness/readiness probe. Unauthenticated." }, { "name": "AuthNext", "description": "Live authentication surface — login, password verification, token refresh, session management, MFA, and admin credential resets. login/verify-password/refresh are public (the credential exchange itself); session/MFA routes require the bearer JWT they issue; admin/* routes are internal-key gated, server-to-server only." }, { "name": "Content", "description": "Generic tenant-scoped CRUD over the 49 allowlisted content/config collections (see the `collection` path parameter enum) — the NestJS replacement for Payload REST on these collections; response shapes match Payload REST so existing consumers work unchanged." }, { "name": "Activity", "description": "Activity logs and screenshot capture/scoring for the time-tracking desktop agent." }, { "name": "Ai", "description": "AMI agents, prompts, and workflows — create, deploy/activate, and manage." }, { "name": "Calendar", "description": "Workspace calendars and calendar events." }, { "name": "Clients", "description": "Client organizations and client contacts." }, { "name": "Content Admin", "description": "Public reads for roadmap items, testimonials, feature ideas, and blog/survey content; write endpoints (create/update/remove, upvote, survey responses) require the `x-internal-key`/`x-api-key` server-to-server header — these writes are not for third-party API consumers." }, { "name": "Crm", "description": "Companies, leads, deals, pipelines, products, sequences, sequence enrollments, custom field definitions, lead routing rules, and client portal tokens. Contacts are documented separately under the Clients tag." }, { "name": "Docs", "description": "Tenant-internal wiki: doc categories and doc pages (distinct from the public docs-site content under Public Content)." }, { "name": "Finance", "description": "Invoices, payments, budgets, expenses, and purchase orders." }, { "name": "Goals", "description": "Workspace goals/OKRs." }, { "name": "Hrms", "description": "Employees, departments, roles, shifts, leave requests, performance reviews, payroll runs, compliance records, salary structures/revisions, bonuses, arrears, and the per-employee payroll activity feed." }, { "name": "Integrations", "description": "Outbound webhooks and third-party integration tokens." }, { "name": "Lms", "description": "LMS API is a placeholder — course/enrollment endpoints are not yet implemented. The one route below returns a hardcoded empty list." }, { "name": "Marketing", "description": "Marketing campaigns, email templates, and marketing assets." }, { "name": "Public Content", "description": "Fully public, unauthenticated docs/marketing content reads (doc categories, doc articles, changelog, FAQs) — paths intentionally match Payload REST exactly (no `/v1`, no auth) because apps/docs hardcodes these URLs." }, { "name": "Recruitment", "description": "Job postings, applicants, and interviews." }, { "name": "Reports", "description": "Saved report configurations/definitions." }, { "name": "Report Definitions", "description": "Reusable saved report definitions (name/type/filter-definition/schedule) distinct from the one-off generated reports above — includes \"run\" to execute a definition and produce a new report_snapshots row." }, { "name": "Support", "description": "Support channels and tickets, including ticket assignment." }, { "name": "Time", "description": "Time entries/timers and timesheets, including submit/approve/reject." }, { "name": "Approvals", "description": "Approval requests — read and decide only, by design (no create/update/delete)." }, { "name": "Work", "description": "Projects, tasks, sprints, chat channels/messages, and work files." }, { "name": "Mcp", "description": "Model Context Protocol server (stateless Streamable HTTP) — the JSON-RPC 2.0 endpoint (POST, authenticated by a workspace API key or auth-next JWT), a public human-readable descriptor at `/info` (GET), and spec-mandated 405s for GET/DELETE at the bare endpoint (no SSE stream, no sessions)." }, { "name": "Mcp OAuth", "description": "Consent screen backing (read/decide a pending MCP OAuth authorization) and the workspace's connected-AI-tool grants (list/revoke). Bearer JWT required." }, { "name": "Metrics", "description": "Prometheus text-format scrape endpoint, authenticated by its own static scrape token (not a user JWT)." }, { "name": "Privacy", "description": "GDPR self-service for the signed-in user: export of their personal data and irreversible account erasure. Bearer JWT required; impersonation tokens are refused." }, { "name": "Internal", "description": "Server-to-server endpoints for AmDital's own apps (trusted Origin + proxy secret). Not for third-party API consumers." } ], "servers": [ { "url": "https://api.amdital.com", "description": "Production" }, { "url": "http://localhost:8000", "description": "Local development" } ], "components": { "securitySchemes": { "bearerAuth": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http" }, "internalApiKey": { "type": "apiKey", "in": "header", "name": "x-internal-key" }, "mcpApiKeyOrJwt": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http", "description": "Either a long-lived workspace API key (`sk_` + 64 hex chars) or an auth-next access JWT." }, "prometheusScrapeToken": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http", "description": "Static machine-to-machine scrape token (PROMETHEUS_SCRAPE_TOKEN)." }, "proxySecret": { "type": "apiKey", "in": "header", "name": "x-proxy-secret", "description": "Shared proxy secret (CMS_PROXY_SECRET); the request must also carry an allowlisted Origin header." } }, "schemas": { "ActivityLogResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "nullable": true, "format": "uuid" }, "kind": { "type": "string" }, "source": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "nullable": true } }, "occurredAt": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "workspaceId", "userId", "kind", "source", "data", "occurredAt", "createdAt" ] }, "CreateActivityLog": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "minLength": 1 }, "source": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} }, "occurredAt": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" } }, "required": ["kind"] }, "CreateScreenshot": { "type": "object", "properties": { "storageKey": { "type": "string", "minLength": 1 }, "capturedAt": { "type": "string" }, "blurLevel": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 100, "default": 0 }, "activityScore": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 100 } }, "required": ["storageKey"] }, "ListActivityLogs": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "userId": { "type": "string", "format": "uuid" }, "kind": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "where": { "type": "object", "additionalProperties": { "type": "object", "properties": { "equals": { "nullable": true } } } } } }, "ListScreenshots": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "userId": { "type": "string", "format": "uuid" }, "startDate": { "type": "string" }, "endDate": { "type": "string" } } }, "ScreenshotResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "storageKey": { "type": "string" }, "capturedAt": { "type": "string" }, "blurLevel": { "type": "number", "nullable": true }, "activityScore": { "type": "number", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "userId", "storageKey", "capturedAt", "blurLevel", "activityScore", "createdAt", "updatedAt", "deletedAt" ] }, "SetActivityScoreBody": { "type": "object", "properties": { "activityScore": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": ["activityScore"] }, "SetBlurLevelBody": { "type": "object", "properties": { "blurLevel": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": ["blurLevel"] }, "UpdateScreenshot": { "type": "object", "properties": { "storageKey": { "type": "string", "minLength": 1 }, "capturedAt": { "type": "string" }, "blurLevel": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 100, "default": 0 }, "activityScore": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 100 } } }, "AgentResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "agentType": { "type": "string" }, "name": { "type": "string" }, "systemPrompt": { "type": "string", "nullable": true }, "tools": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": { "nullable": true } } }, "memoryScope": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "temperature": { "type": "number", "nullable": true }, "toolPermissions": { "type": "object", "nullable": true, "additionalProperties": { "type": "boolean" } } }, "required": [ "id", "workspaceId", "agentType", "name", "systemPrompt", "tools", "memoryScope", "isActive", "createdAt", "description", "model", "temperature", "toolPermissions" ] }, "CreateAgent": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "agentType": { "type": "string", "minLength": 1, "maxLength": 50, "default": "custom" }, "systemPrompt": { "type": "string" }, "tools": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } }, "default": [] }, "memoryScope": { "type": "string", "maxLength": 50 }, "isActive": { "type": "boolean", "default": true }, "description": { "type": "string", "maxLength": 2000 }, "model": { "type": "string", "maxLength": 100 }, "temperature": { "type": "number", "minimum": 0, "maximum": 2 }, "toolPermissions": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "required": ["name"] }, "CreatePrompt": { "type": "object", "properties": { "module": { "type": "string", "minLength": 1, "default": "custom" }, "content": { "type": "string", "minLength": 1 }, "active": { "type": "boolean", "default": true } }, "required": ["content"] }, "CreateWorkflow": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "trigger": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} }, "steps": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } }, "default": [] }, "status": { "type": "string", "enum": ["draft", "active", "archived"], "default": "draft" } }, "required": ["name"] }, "ListAgents": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "ListPrompts": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "ListWorkflows": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "PromptResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "nullable": true, "format": "uuid" }, "module": { "type": "string" }, "version": { "type": "number", "nullable": true }, "content": { "type": "string" }, "active": { "type": "boolean" }, "createdAt": { "type": "string" } }, "required": ["id", "workspaceId", "module", "version", "content", "active", "createdAt"] }, "UpdateAgent": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "agentType": { "type": "string", "minLength": 1, "maxLength": 50, "default": "custom" }, "systemPrompt": { "type": "string" }, "tools": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } }, "default": [] }, "memoryScope": { "type": "string", "maxLength": 50 }, "isActive": { "type": "boolean", "default": true }, "description": { "type": "string", "maxLength": 2000 }, "model": { "type": "string", "maxLength": 100 }, "temperature": { "type": "number", "minimum": 0, "maximum": 2 }, "toolPermissions": { "type": "object", "additionalProperties": { "type": "boolean" } } } }, "UpdatePrompt": { "type": "object", "properties": { "module": { "type": "string", "minLength": 1, "default": "custom" }, "content": { "type": "string", "minLength": 1 }, "active": { "type": "boolean", "default": true } } }, "UpdateWorkflow": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "trigger": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} }, "steps": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } }, "default": [] }, "status": { "type": "string", "enum": ["draft", "active", "archived"], "default": "draft" } } }, "WorkflowResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "trigger": { "type": "object", "additionalProperties": { "nullable": true } }, "steps": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } } }, "status": { "type": "string" }, "lastRunAt": { "type": "string", "nullable": true }, "runCount": { "type": "number", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "name", "trigger", "steps", "status", "lastRunAt", "runCount", "createdAt", "updatedAt", "deletedAt" ] }, "CreateCalendarEvent": { "type": "object", "properties": { "calendarId": { "type": "string", "format": "uuid" }, "title": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "startsAt": { "type": "string" }, "endsAt": { "type": "string" }, "allDay": { "type": "boolean", "default": false }, "location": { "type": "string" }, "rrule": { "type": "string" }, "attendees": { "type": "array", "items": { "nullable": true }, "default": [] }, "reminders": { "type": "array", "items": { "nullable": true }, "default": [] }, "createdBy": { "type": "string", "format": "uuid" } }, "required": ["calendarId", "title", "startsAt", "endsAt"] }, "CreateCalendar": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "color": { "type": "string" }, "ownerId": { "type": "string", "format": "uuid" }, "isDefault": { "type": "boolean", "default": false }, "visibility": { "type": "string", "enum": ["workspace", "private"], "default": "workspace" } }, "required": ["name"] }, "ListCalendarEvents": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "calendarId": { "type": "string", "format": "uuid" } } }, "ListCalendars": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateCalendarEvent": { "type": "object", "properties": { "calendarId": { "type": "string", "format": "uuid" }, "title": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "startsAt": { "type": "string" }, "endsAt": { "type": "string" }, "allDay": { "type": "boolean", "default": false }, "location": { "type": "string" }, "rrule": { "type": "string" }, "attendees": { "type": "array", "items": { "nullable": true }, "default": [] }, "reminders": { "type": "array", "items": { "nullable": true }, "default": [] }, "createdBy": { "type": "string", "format": "uuid" } } }, "UpdateCalendar": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "color": { "type": "string" }, "ownerId": { "type": "string", "format": "uuid" }, "isDefault": { "type": "boolean", "default": false }, "visibility": { "type": "string", "enum": ["workspace", "private"], "default": "workspace" } } }, "ClientContactResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "clientOrgId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "nullable": true, "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "portalAccess": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "clientOrgId", "userId", "firstName", "lastName", "email", "phone", "role", "portalAccess", "createdAt", "updatedAt", "deletedAt" ] }, "ClientOrgResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "companyId": { "type": "string", "nullable": true, "format": "uuid" }, "status": { "type": "string" }, "billingEmail": { "type": "string", "nullable": true }, "portalEnabled": { "type": "boolean" }, "custom": { "type": "object", "additionalProperties": { "nullable": true } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "name", "companyId", "status", "billingEmail", "portalEnabled", "custom", "createdAt", "updatedAt", "deletedAt" ] }, "CreateClientContact": { "type": "object", "properties": { "clientOrgId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "role": { "type": "string" }, "portalAccess": { "type": "boolean", "default": false } }, "required": ["clientOrgId", "firstName"] }, "CreateClientOrg": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "companyId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": ["active", "inactive"], "default": "active" }, "billingEmail": { "type": "string", "format": "email" }, "portalEnabled": { "type": "boolean", "default": false }, "custom": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} } }, "required": ["name"] }, "ListClientContacts": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "clientOrgId": { "type": "string", "format": "uuid" } } }, "ListClientOrgs": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateClientContact": { "type": "object", "properties": { "clientOrgId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "role": { "type": "string" }, "portalAccess": { "type": "boolean", "default": false } } }, "UpdateClientOrg": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "companyId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": ["active", "inactive"], "default": "active" }, "billingEmail": { "type": "string", "format": "email" }, "portalEnabled": { "type": "boolean", "default": false }, "custom": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} } } }, "CreateClientPortalToken": { "type": "object", "properties": { "client": { "type": "string", "minLength": 1 }, "token": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string" }, "lastAccessedAt": { "type": "string" }, "clientName": { "type": "string" } }, "required": ["client", "token", "expiresAt"] }, "ListClientPortalTokens": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateClientPortalToken": { "type": "object", "properties": { "client": { "type": "string", "minLength": 1 }, "token": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string" }, "lastAccessedAt": { "type": "string" }, "clientName": { "type": "string" } } }, "CompanyResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "industry": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "status": { "type": "string" }, "ownerId": { "type": "string", "nullable": true, "format": "uuid" }, "custom": { "type": "object", "additionalProperties": { "nullable": true } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "name", "industry", "website", "phone", "status", "ownerId", "custom", "createdAt", "updatedAt", "deletedAt" ] }, "CreateCompany": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "industry": { "type": "string" }, "website": { "type": "string", "format": "uri" }, "phone": { "type": "string" }, "status": { "type": "string", "enum": ["active", "inactive", "prospect"], "default": "active" }, "ownerId": { "type": "string", "format": "uuid" }, "custom": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} } }, "required": ["name"] }, "ListCompanies": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "MergeCompany": { "type": "object", "properties": { "duplicateId": { "type": "string", "format": "uuid" }, "dryRun": { "type": "boolean" } }, "required": ["duplicateId", "dryRun"] }, "UpdateCompany": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "industry": { "type": "string" }, "website": { "type": "string", "format": "uri" }, "phone": { "type": "string" }, "status": { "type": "string", "enum": ["active", "inactive", "prospect"], "default": "active" }, "ownerId": { "type": "string", "format": "uuid" }, "custom": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} } } }, "CreateCrmCustomFieldDef": { "type": "object", "properties": { "objectType": { "type": "string", "enum": ["lead", "deal", "contact", "company"] }, "fieldKey": { "type": "string", "minLength": 1 }, "fieldLabel": { "type": "string", "minLength": 1 }, "fieldType": { "type": "string", "enum": ["text", "number", "select", "multiselect", "date", "checkbox"] }, "fieldOptions": { "nullable": true }, "isRequired": { "type": "boolean", "default": false }, "displayOrder": { "type": "number", "nullable": true, "default": 0 } }, "required": ["objectType", "fieldKey", "fieldLabel", "fieldType"] }, "ListCrmCustomFieldDefs": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "objectType": { "type": "string", "enum": ["lead", "deal", "contact", "company"] } } }, "UpdateCrmCustomFieldDef": { "type": "object", "properties": { "objectType": { "type": "string", "enum": ["lead", "deal", "contact", "company"] }, "fieldKey": { "type": "string", "minLength": 1 }, "fieldLabel": { "type": "string", "minLength": 1 }, "fieldType": { "type": "string", "enum": ["text", "number", "select", "multiselect", "date", "checkbox"] }, "fieldOptions": { "nullable": true }, "isRequired": { "type": "boolean", "default": false }, "displayOrder": { "type": "number", "nullable": true, "default": 0 } } }, "CreateCrmLeadRoute": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "conditionField": { "type": "string", "enum": ["source", "company", "teamSize", "status"] }, "conditionOperator": { "type": "string", "enum": ["equals", "contains", "not_equals"] }, "conditionValue": { "type": "string", "minLength": 1 }, "assigneeId": { "type": "string", "minLength": 1 }, "assigneeName": { "type": "string" }, "priority": { "type": "number", "nullable": true, "default": 0 }, "active": { "type": "boolean", "default": true } }, "required": ["name", "conditionField", "conditionOperator", "conditionValue", "assigneeId"] }, "ListCrmLeadRoutes": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateCrmLeadRoute": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "conditionField": { "type": "string", "enum": ["source", "company", "teamSize", "status"] }, "conditionOperator": { "type": "string", "enum": ["equals", "contains", "not_equals"] }, "conditionValue": { "type": "string", "minLength": 1 }, "assigneeId": { "type": "string", "minLength": 1 }, "assigneeName": { "type": "string" }, "priority": { "type": "number", "nullable": true, "default": 0 }, "active": { "type": "boolean", "default": true } } }, "CreateCrmProduct": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "sku": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": ["product", "service", "subscription"], "default": "product" }, "price": { "type": "number", "nullable": true, "minimum": 0 }, "currency": { "type": "string", "default": "USD" }, "unit": { "type": "string", "default": "per unit" }, "active": { "type": "boolean", "default": true }, "imageUrl": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string" } }, "required": ["tag"] }, "default": [] } }, "required": ["name", "price"] }, "ListCrmProducts": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateCrmProduct": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "sku": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": ["product", "service", "subscription"], "default": "product" }, "price": { "type": "number", "nullable": true, "minimum": 0 }, "currency": { "type": "string", "default": "USD" }, "unit": { "type": "string", "default": "per unit" }, "active": { "type": "boolean", "default": true }, "imageUrl": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string" } }, "required": ["tag"] }, "default": [] } } }, "CreateCrmSequence": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "status": { "type": "string", "enum": ["draft", "active", "paused", "archived"], "default": "draft" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["email", "wait", "task"] }, "delayDays": { "type": "number", "nullable": true, "minimum": 0, "default": 1 }, "subject": { "type": "string" }, "body": { "type": "string" }, "taskTitle": { "type": "string" } }, "required": ["type"] }, "default": [] } }, "required": ["name"] }, "CrmSequenceStep": { "type": "object", "properties": { "type": { "type": "string", "enum": ["email", "wait", "task"] }, "delayDays": { "type": "number", "nullable": true, "minimum": 0, "default": 1 }, "subject": { "type": "string" }, "body": { "type": "string" }, "taskTitle": { "type": "string" } }, "required": ["type"] }, "ListCrmSequences": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateCrmSequence": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "status": { "type": "string", "enum": ["draft", "active", "paused", "archived"], "default": "draft" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["email", "wait", "task"] }, "delayDays": { "type": "number", "nullable": true, "minimum": 0, "default": 1 }, "subject": { "type": "string" }, "body": { "type": "string" }, "taskTitle": { "type": "string" } }, "required": ["type"] }, "default": [] } } }, "CreateCrmSequenceEnrollment": { "type": "object", "properties": { "sequenceId": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "minLength": 1 }, "contactEmail": { "type": "string", "format": "email" }, "currentStep": { "type": "number", "nullable": true, "default": 0 }, "status": { "type": "string", "enum": ["active", "paused", "completed", "unsubscribed"], "default": "active" }, "lastSentAt": { "type": "string" }, "completedAt": { "type": "string" } }, "required": ["sequenceId", "contactId"] }, "ListCrmSequenceEnrollments": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "sequenceId": { "type": "string", "format": "uuid" } } }, "UpdateCrmSequenceEnrollment": { "type": "object", "properties": { "sequenceId": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "minLength": 1 }, "contactEmail": { "type": "string", "format": "email" }, "currentStep": { "type": "number", "nullable": true, "default": 0 }, "status": { "type": "string", "enum": ["active", "paused", "completed", "unsubscribed"], "default": "active" }, "lastSentAt": { "type": "string" }, "completedAt": { "type": "string" } } }, "CreateDeal": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "company": { "type": "string" }, "contactId": { "type": "string", "format": "uuid" }, "value": { "type": "number", "nullable": true, "default": 0 }, "currency": { "type": "string", "default": "USD" }, "stage": { "type": "string", "enum": [ "prospecting", "qualification", "proposal", "negotiation", "closed_won", "closed_lost" ], "default": "prospecting" }, "pipelineId": { "type": "string", "format": "uuid" }, "probability": { "type": "number", "nullable": true, "default": 0 }, "status": { "type": "string", "enum": ["open", "won", "lost"], "default": "open" }, "priority": { "type": "string", "enum": ["low", "medium", "high"], "default": "medium" }, "assigneeId": { "type": "string", "format": "uuid" }, "expectedCloseDate": { "type": "string" }, "notes": { "type": "string" }, "lostReason": { "type": "string" } }, "required": ["title"] }, "ListDeals": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateDeal": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "company": { "type": "string" }, "contactId": { "type": "string", "format": "uuid" }, "value": { "type": "number", "nullable": true, "default": 0 }, "currency": { "type": "string", "default": "USD" }, "stage": { "type": "string", "enum": [ "prospecting", "qualification", "proposal", "negotiation", "closed_won", "closed_lost" ], "default": "prospecting" }, "pipelineId": { "type": "string", "format": "uuid" }, "probability": { "type": "number", "nullable": true, "default": 0 }, "status": { "type": "string", "enum": ["open", "won", "lost"], "default": "open" }, "priority": { "type": "string", "enum": ["low", "medium", "high"], "default": "medium" }, "assigneeId": { "type": "string", "format": "uuid" }, "expectedCloseDate": { "type": "string" }, "notes": { "type": "string" }, "lostReason": { "type": "string" }, "expectedVersion": { "type": "integer", "nullable": true } } }, "CreateLead": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "company": { "type": "string" }, "title": { "type": "string" }, "website": { "type": "string" }, "source": { "type": "string" }, "stage": { "type": "string" }, "status": { "type": "string", "default": "active" }, "value": { "type": "number", "nullable": true }, "notes": { "type": "string" }, "assigneeId": { "type": "string", "format": "uuid" } }, "required": ["firstName"] }, "ListLeads": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateLead": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "company": { "type": "string" }, "title": { "type": "string" }, "website": { "type": "string" }, "source": { "type": "string" }, "stage": { "type": "string" }, "status": { "type": "string", "default": "active" }, "value": { "type": "number", "nullable": true }, "notes": { "type": "string" }, "assigneeId": { "type": "string", "format": "uuid" } } }, "CreatePipeline": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "color": { "type": "string" }, "description": { "type": "string" }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "color": { "type": "string" }, "description": { "type": "string" }, "probability": { "type": "number", "nullable": true, "minimum": 0, "maximum": 100 }, "order": { "type": "number", "nullable": true } }, "required": ["name"] }, "default": [] }, "isDefault": { "type": "boolean", "default": false }, "active": { "type": "boolean", "default": true } }, "required": ["name"] }, "ListPipelines": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "PipelineStage": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "color": { "type": "string" }, "description": { "type": "string" }, "probability": { "type": "number", "nullable": true, "minimum": 0, "maximum": 100 }, "order": { "type": "number", "nullable": true } }, "required": ["name"] }, "UpdatePipeline": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "color": { "type": "string" }, "description": { "type": "string" }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "color": { "type": "string" }, "description": { "type": "string" }, "probability": { "type": "number", "nullable": true, "minimum": 0, "maximum": 100 }, "order": { "type": "number", "nullable": true } }, "required": ["name"] }, "default": [] }, "isDefault": { "type": "boolean", "default": false }, "active": { "type": "boolean", "default": true } } }, "CategoryResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "icon": { "type": "string", "nullable": true }, "order": { "type": "number", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "name", "slug", "description", "color", "icon", "order", "createdAt", "updatedAt" ] }, "CreateCategory": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "color": { "type": "string" }, "icon": { "type": "string" }, "order": { "type": "number", "nullable": true }, "departmentId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" } }, "required": ["name"] }, "CreatePage": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "content": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} }, "searchText": { "type": "string" }, "categoryId": { "type": "string", "format": "uuid" }, "parentId": { "type": "string", "nullable": true, "format": "uuid" }, "docType": { "type": "string", "enum": ["wiki", "sop", "doc"], "default": "wiki" }, "status": { "type": "string", "enum": ["draft", "published", "archived"], "default": "draft" }, "isPinned": { "type": "boolean" }, "isShared": { "type": "boolean" }, "authorId": { "type": "string", "format": "uuid" }, "departmentId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "visibility": { "type": "string", "enum": ["workspace", "department", "private", "restricted"], "default": "workspace" }, "isPublished": { "type": "boolean" } }, "required": ["title"], "additionalProperties": false }, "GrantPageAccess": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "role": { "type": "string", "enum": ["viewer", "editor"], "default": "viewer" } }, "required": ["userId"] }, "ListCategories": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ListPages": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "sort": { "type": "string" }, "where": { "type": "object", "properties": { "docType": { "type": "object", "properties": { "equals": { "type": "string", "enum": ["wiki", "sop", "doc"] } }, "required": ["equals"] }, "status": { "type": "object", "properties": { "equals": { "type": "string", "enum": ["draft", "published", "archived"] } }, "required": ["equals"] }, "isDeleted": { "type": "object", "properties": { "equals": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] } }, "required": ["equals"] }, "departmentId": { "type": "object", "properties": { "equals": { "type": "string", "format": "uuid" } }, "required": ["equals"] }, "authorId": { "type": "object", "properties": { "equals": { "type": "string", "format": "uuid" } }, "required": ["equals"] }, "lastEditedById": { "type": "object", "properties": { "equals": { "type": "string", "format": "uuid" } }, "required": ["equals"] }, "categoryId": { "type": "object", "properties": { "equals": { "type": "string", "format": "uuid" } }, "required": ["equals"] }, "tag": { "type": "object", "properties": { "equals": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": ["equals"] } } } } }, "PageResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "slug": { "type": "string" }, "content": { "type": "object", "nullable": true, "additionalProperties": { "nullable": true } }, "searchText": { "type": "string", "nullable": true }, "categoryId": { "type": "string", "nullable": true, "format": "uuid" }, "parentId": { "type": "string", "nullable": true, "format": "uuid" }, "docType": { "type": "string", "nullable": true }, "status": { "type": "string" }, "isPinned": { "type": "boolean", "nullable": true }, "isShared": { "type": "boolean", "nullable": true }, "authorId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "title", "slug", "content", "searchText", "categoryId", "parentId", "docType", "status", "isPinned", "isShared", "authorId", "createdAt", "updatedAt", "deletedAt" ] }, "UpdateCategory": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "color": { "type": "string" }, "icon": { "type": "string" }, "order": { "type": "number", "nullable": true }, "departmentId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" } } }, "UpdatePage": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "content": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} }, "searchText": { "type": "string" }, "categoryId": { "type": "string", "format": "uuid" }, "parentId": { "type": "string", "nullable": true, "format": "uuid" }, "docType": { "type": "string", "enum": ["wiki", "sop", "doc"], "default": "wiki" }, "status": { "type": "string", "enum": ["draft", "published", "archived"], "default": "draft" }, "isPinned": { "type": "boolean" }, "isShared": { "type": "boolean" }, "authorId": { "type": "string", "format": "uuid" }, "departmentId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "visibility": { "type": "string", "enum": ["workspace", "department", "private", "restricted"], "default": "workspace" }, "isPublished": { "type": "boolean" }, "isDeleted": { "type": "boolean", "enum": [false] } }, "additionalProperties": false }, "BudgetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "department": { "type": "string", "nullable": true }, "departmentId": { "type": "string", "nullable": true, "format": "uuid" }, "totalBudget": { "type": "number", "nullable": true }, "spent": { "type": "number", "nullable": true }, "currency": { "type": "string", "nullable": true }, "period": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "name", "department", "departmentId", "totalBudget", "spent", "currency", "period", "startDate", "endDate", "notes", "createdAt", "updatedAt", "deletedAt" ] }, "CreateAccount": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": ["cash", "bank", "credit_card", "investment", "receivable", "payable"] }, "balance": { "type": "number", "nullable": true, "default": 0 }, "currency": { "type": "string", "default": "USD" }, "description": { "type": "string" }, "isActive": { "type": "boolean", "default": true } }, "required": ["name", "type"] }, "CreateBudget": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "department": { "type": "string" }, "departmentId": { "type": "string", "format": "uuid" }, "totalBudget": { "type": "number", "nullable": true, "minimum": 0, "default": 0 }, "spent": { "type": "number", "nullable": true, "minimum": 0, "default": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "period": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "notes": { "type": "string" } }, "required": ["name"] }, "CreateExpenseCategory": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9_-]+$" }, "label": { "type": "string", "minLength": 1 }, "className": { "type": "string" }, "allowedRoles": { "type": "array", "items": { "type": "string" }, "default": [] } }, "required": ["name", "label"] }, "CreateExpense": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1 }, "amount": { "type": "number", "nullable": true, "minimum": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "category": { "type": "string" }, "date": { "type": "string" }, "vendor": { "type": "string" }, "createdById": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": ["pending", "approved", "rejected", "reimbursed"], "default": "pending" }, "approvedById": { "type": "string", "format": "uuid" }, "receiptUrl": { "type": "string" }, "notes": { "type": "string" } }, "required": ["description", "amount", "date"] }, "CreateFinanceTicket": { "type": "object", "properties": { "invoiceId": { "type": "string", "format": "uuid" }, "subject": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "assignedToId": { "type": "string", "format": "uuid" }, "priority": { "type": "string", "enum": ["low", "medium", "high", "urgent"], "default": "medium" } }, "required": ["invoiceId", "subject"] }, "CreateInvoiceFromTimeLog": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "invoiceNumber": { "type": "string" }, "notes": { "type": "string" } }, "required": ["startDate", "endDate"] }, "CreateInvoice": { "type": "object", "properties": { "invoiceNumber": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": ["draft", "sent", "paid", "overdue", "void"], "default": "draft" }, "issueDate": { "type": "string" }, "dueDate": { "type": "string" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "amount": { "type": "number", "nullable": true, "default": 0 }, "taxAmount": { "type": "number", "nullable": true, "default": 0 }, "totalAmount": { "type": "number", "nullable": true, "default": 0 }, "notes": { "type": "string" } }, "required": ["invoiceNumber"] }, "CreatePayment": { "type": "object", "properties": { "invoiceId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "nullable": true, "minimum": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "method": { "type": "string", "enum": ["bank_transfer", "card", "cash", "upi", "other"], "default": "bank_transfer" }, "status": { "type": "string", "enum": ["pending", "completed", "failed", "refunded"], "default": "completed" }, "paidAt": { "type": "string" }, "transactionId": { "type": "string" }, "notes": { "type": "string" } }, "required": ["amount"] }, "CreatePayroll": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "year": { "type": "integer", "nullable": true }, "grossPay": { "type": "number", "nullable": true, "default": 0 }, "deductions": { "type": "number", "nullable": true, "default": 0 }, "netPay": { "type": "number", "nullable": true, "default": 0 }, "currency": { "type": "string", "default": "USD" }, "status": { "type": "string", "enum": ["pending", "processed", "paid", "cancelled"], "default": "pending" }, "paidAt": { "type": "string" }, "notes": { "type": "string" } }, "required": ["employeeId", "month", "year"] }, "CreateProduct": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "sku": { "type": "string" }, "description": { "type": "string" }, "unitPrice": { "type": "number", "nullable": true, "minimum": 0, "default": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "defaultTaxRateId": { "type": "string", "format": "uuid" } }, "required": ["name"] }, "CreatePurchaseOrder": { "type": "object", "properties": { "vendor": { "type": "string" }, "orderNumber": { "type": "string", "minLength": 1 }, "subtotal": { "type": "number", "nullable": true, "default": 0 }, "tax": { "type": "number", "nullable": true, "default": 0 }, "total": { "type": "number", "nullable": true, "default": 0 }, "status": { "type": "string", "enum": ["draft", "sent", "approved", "received", "cancelled"], "default": "draft" }, "dueDate": { "type": "string" }, "notes": { "type": "string" } }, "required": ["orderNumber"] }, "CreateRecurringExpense": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1 }, "category": { "type": "string", "default": "other" }, "amount": { "type": "number", "nullable": true, "minimum": 0, "default": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "vendor": { "type": "string" }, "notes": { "type": "string" }, "billingFrequency": { "type": "string", "enum": ["weekly", "monthly", "quarterly", "yearly"], "default": "monthly" }, "intervalCount": { "type": "integer", "minimum": 1, "default": 1 }, "nextRunDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string" } }, "required": ["description", "nextRunDate"] }, "CreateTaxRate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "rate": { "type": "number", "nullable": true, "minimum": 0, "maximum": 100, "default": 0 }, "isCompound": { "type": "boolean", "default": false } }, "required": ["name"] }, "CreateVendor": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "category": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "website": { "type": "string" }, "address": { "type": "string" }, "paymentTerms": { "type": "string" }, "notes": { "type": "string" }, "isActive": { "type": "boolean", "default": true } }, "required": ["name"] }, "ExpenseCategoryResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "label": { "type": "string" }, "className": { "type": "string", "nullable": true }, "allowedRoles": { "type": "array", "items": { "type": "string" } }, "isActive": { "type": "boolean" }, "sortOrder": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "name", "label", "className", "allowedRoles", "isActive", "sortOrder", "createdAt", "updatedAt" ] }, "ExpenseResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "amount": { "type": "number", "nullable": true }, "currency": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "date": { "type": "string" }, "vendor": { "type": "string", "nullable": true }, "createdById": { "type": "string", "nullable": true, "format": "uuid" }, "status": { "type": "string", "nullable": true }, "approvedById": { "type": "string", "nullable": true, "format": "uuid" }, "receiptUrl": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "description", "amount", "currency", "category", "date", "vendor", "createdById", "status", "approvedById", "receiptUrl", "notes", "createdAt", "updatedAt", "deletedAt" ] }, "FinanceTicketResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "string", "nullable": true, "format": "uuid" }, "subject": { "type": "string" }, "description": { "type": "string", "nullable": true }, "assignedToId": { "type": "string", "nullable": true, "format": "uuid" }, "priority": { "type": "string" }, "status": { "type": "string" }, "resolutionNotes": { "type": "string", "nullable": true }, "resolvedAt": { "type": "string", "nullable": true }, "createdById": { "type": "string", "nullable": true, "format": "uuid" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "invoiceId", "subject", "description", "assignedToId", "priority", "status", "resolutionNotes", "resolvedAt", "createdById", "createdAt", "updatedAt" ] }, "InvoiceResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": "string" }, "clientId": { "type": "string", "nullable": true, "format": "uuid" }, "contactId": { "type": "string", "nullable": true, "format": "uuid" }, "status": { "type": "string", "nullable": true }, "issueDate": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "amount": { "type": "number", "nullable": true }, "taxAmount": { "type": "number", "nullable": true }, "totalAmount": { "type": "number", "nullable": true }, "notes": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "invoiceNumber", "clientId", "contactId", "status", "issueDate", "dueDate", "currency", "amount", "taxAmount", "totalAmount", "notes", "createdAt", "updatedAt", "deletedAt" ] }, "ListAccounts": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "type": { "type": "string" } } }, "ListBudgets": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ListEstimates": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ListExpenseCategories": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ListExpenses": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ListFinanceEntity": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "ListFinanceTickets": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ListInvoices": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ListPayments": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ListProducts": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ListPurchaseOrders": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ListRecurringExpenses": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ListTaxRates": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "PaymentResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "string", "nullable": true, "format": "uuid" }, "amount": { "type": "number", "nullable": true }, "currency": { "type": "string", "nullable": true }, "method": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "paidAt": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "invoiceId", "amount", "currency", "method", "status", "paidAt", "transactionId", "notes", "createdAt", "updatedAt" ] }, "ProductResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "sku": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "unitPrice": { "type": "number", "nullable": true }, "currency": { "type": "string", "nullable": true }, "defaultTaxRateId": { "type": "string", "nullable": true, "format": "uuid" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "name", "sku", "description", "unitPrice", "currency", "defaultTaxRateId", "isActive", "createdAt", "updatedAt" ] }, "PurchaseOrderResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "vendor": { "type": "string", "nullable": true }, "orderNumber": { "type": "string" }, "subtotal": { "type": "number", "nullable": true }, "tax": { "type": "number", "nullable": true }, "total": { "type": "number", "nullable": true }, "status": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "vendor", "orderNumber", "subtotal", "tax", "total", "status", "dueDate", "notes", "createdAt", "updatedAt", "deletedAt" ] }, "RecurringExpenseResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "category": { "type": "string" }, "amount": { "type": "number", "nullable": true }, "currency": { "type": "string", "nullable": true }, "vendor": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "billingFrequency": { "type": "string" }, "intervalCount": { "type": "number" }, "nextRunDate": { "type": "string" }, "endDate": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "lastMaterializedAt": { "type": "string", "nullable": true }, "createdById": { "type": "string", "nullable": true, "format": "uuid" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "description", "category", "amount", "currency", "vendor", "notes", "billingFrequency", "intervalCount", "nextRunDate", "endDate", "isActive", "lastMaterializedAt", "createdById", "createdAt", "updatedAt" ] }, "TaxRateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "rate": { "type": "number", "nullable": true }, "isCompound": { "type": "boolean" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "name", "rate", "isCompound", "isActive", "createdAt", "updatedAt" ] }, "UpdateAccount": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": ["cash", "bank", "credit_card", "investment", "receivable", "payable"] }, "balance": { "type": "number", "nullable": true, "default": 0 }, "currency": { "type": "string", "default": "USD" }, "description": { "type": "string" }, "isActive": { "type": "boolean", "default": true } } }, "UpdateBudget": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "department": { "type": "string" }, "departmentId": { "type": "string", "format": "uuid" }, "totalBudget": { "type": "number", "nullable": true, "minimum": 0, "default": 0 }, "spent": { "type": "number", "nullable": true, "minimum": 0, "default": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "period": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "notes": { "type": "string" } } }, "UpdateExpenseCategory": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9_-]+$" }, "label": { "type": "string", "minLength": 1 }, "className": { "type": "string" }, "allowedRoles": { "type": "array", "items": { "type": "string" }, "default": [] }, "isActive": { "type": "boolean" }, "sortOrder": { "type": "integer", "nullable": true } } }, "UpdateExpense": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1 }, "amount": { "type": "number", "nullable": true, "minimum": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "category": { "type": "string" }, "date": { "type": "string" }, "vendor": { "type": "string" }, "createdById": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": ["pending", "approved", "rejected", "reimbursed"], "default": "pending" }, "approvedById": { "type": "string", "format": "uuid" }, "receiptUrl": { "type": "string" }, "notes": { "type": "string" } } }, "UpdateFinanceTicket": { "type": "object", "properties": { "invoiceId": { "type": "string", "format": "uuid" }, "subject": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "assignedToId": { "type": "string", "format": "uuid" }, "priority": { "type": "string", "enum": ["low", "medium", "high", "urgent"], "default": "medium" }, "status": { "type": "string", "enum": ["open", "in_progress", "resolved", "closed"] }, "resolutionNotes": { "type": "string" } } }, "UpdateInvoice": { "type": "object", "properties": { "invoiceNumber": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": ["draft", "sent", "paid", "overdue", "void"], "default": "draft" }, "issueDate": { "type": "string" }, "dueDate": { "type": "string" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "amount": { "type": "number", "nullable": true, "default": 0 }, "taxAmount": { "type": "number", "nullable": true, "default": 0 }, "totalAmount": { "type": "number", "nullable": true, "default": 0 }, "notes": { "type": "string" }, "expectedVersion": { "type": "integer", "nullable": true } } }, "UpdatePayment": { "type": "object", "properties": { "invoiceId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "nullable": true, "minimum": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "method": { "type": "string", "enum": ["bank_transfer", "card", "cash", "upi", "other"], "default": "bank_transfer" }, "status": { "type": "string", "enum": ["pending", "completed", "failed", "refunded"], "default": "completed" }, "paidAt": { "type": "string" }, "transactionId": { "type": "string" }, "notes": { "type": "string" } } }, "UpdatePayroll": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "year": { "type": "integer", "nullable": true }, "grossPay": { "type": "number", "nullable": true, "default": 0 }, "deductions": { "type": "number", "nullable": true, "default": 0 }, "netPay": { "type": "number", "nullable": true, "default": 0 }, "currency": { "type": "string", "default": "USD" }, "status": { "type": "string", "enum": ["pending", "processed", "paid", "cancelled"], "default": "pending" }, "paidAt": { "type": "string" }, "notes": { "type": "string" } } }, "UpdateProduct": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "sku": { "type": "string" }, "description": { "type": "string" }, "unitPrice": { "type": "number", "nullable": true, "minimum": 0, "default": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "defaultTaxRateId": { "type": "string", "format": "uuid" }, "isActive": { "type": "boolean" } } }, "UpdatePurchaseOrder": { "type": "object", "properties": { "vendor": { "type": "string" }, "orderNumber": { "type": "string", "minLength": 1 }, "subtotal": { "type": "number", "nullable": true, "default": 0 }, "tax": { "type": "number", "nullable": true, "default": 0 }, "total": { "type": "number", "nullable": true, "default": 0 }, "status": { "type": "string", "enum": ["draft", "sent", "approved", "received", "cancelled"], "default": "draft" }, "dueDate": { "type": "string" }, "notes": { "type": "string" }, "expectedVersion": { "type": "integer", "nullable": true } } }, "UpdateRecurringExpense": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1 }, "category": { "type": "string", "default": "other" }, "amount": { "type": "number", "nullable": true, "minimum": 0, "default": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "vendor": { "type": "string" }, "notes": { "type": "string" }, "billingFrequency": { "type": "string", "enum": ["weekly", "monthly", "quarterly", "yearly"], "default": "monthly" }, "intervalCount": { "type": "integer", "minimum": 1, "default": 1 }, "nextRunDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string" }, "isActive": { "type": "boolean" } } }, "UpdateTaxRate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "rate": { "type": "number", "nullable": true, "minimum": 0, "maximum": 100, "default": 0 }, "isCompound": { "type": "boolean", "default": false }, "isActive": { "type": "boolean" } } }, "UpdateVendor": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "category": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "website": { "type": "string" }, "address": { "type": "string" }, "paymentTerms": { "type": "string" }, "notes": { "type": "string" }, "isActive": { "type": "boolean", "default": true } } }, "CreateGoal": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": ["goal", "okr", "milestone"], "default": "goal" }, "parentId": { "type": "string", "format": "uuid" }, "ownerId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": ["not_started", "on_track", "at_risk", "behind", "achieved", "closed"], "default": "not_started" }, "progress": { "type": "number", "nullable": true, "minimum": 0, "maximum": 100, "default": 0 }, "targetValue": { "type": "number", "nullable": true }, "currentValue": { "type": "number", "nullable": true }, "dueDate": { "type": "string" }, "period": { "type": "string" } }, "required": ["title"] }, "GoalResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "kind": { "type": "string" }, "parentId": { "type": "string", "nullable": true, "format": "uuid" }, "ownerId": { "type": "string", "nullable": true, "format": "uuid" }, "status": { "type": "string" }, "progress": { "type": "number", "nullable": true }, "targetValue": { "type": "number", "nullable": true }, "currentValue": { "type": "number", "nullable": true }, "dueDate": { "type": "string", "nullable": true }, "period": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "title", "kind", "parentId", "ownerId", "status", "progress", "targetValue", "currentValue", "dueDate", "period", "createdAt", "updatedAt", "deletedAt" ] }, "ListGoals": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "UpdateGoal": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": ["goal", "okr", "milestone"], "default": "goal" }, "parentId": { "type": "string", "format": "uuid" }, "ownerId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": ["not_started", "on_track", "at_risk", "behind", "achieved", "closed"], "default": "not_started" }, "progress": { "type": "number", "nullable": true, "minimum": 0, "maximum": 100, "default": 0 }, "targetValue": { "type": "number", "nullable": true }, "currentValue": { "type": "number", "nullable": true }, "dueDate": { "type": "string" }, "period": { "type": "string" } } }, "CreateAppreciation": { "type": "object", "properties": { "toUserId": { "type": "string", "format": "uuid" }, "message": { "type": "string", "minLength": 1, "maxLength": 500 }, "badge": { "type": "string", "enum": ["star", "heart", "fire", "trophy", "rocket", "clap"] }, "isPublic": { "type": "boolean", "default": true } }, "required": ["toUserId", "message", "badge"] }, "CreateMeeting": { "type": "object", "properties": { "participantId": { "type": "string", "format": "uuid" }, "title": { "type": "string", "minLength": 1 }, "scheduledAt": { "type": "string" }, "duration": { "type": "number", "nullable": true, "default": 30 }, "recurring": { "type": "string", "enum": ["none", "weekly", "biweekly", "monthly"], "default": "none" }, "status": { "type": "string", "enum": ["scheduled", "completed", "cancelled"], "default": "scheduled" }, "agenda": { "type": "string" }, "notes": { "type": "string" }, "nextMeetingAt": { "type": "string" } }, "required": ["participantId", "title"] }, "ListAppreciations": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "ListMeetings": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateAppreciation": { "type": "object", "properties": { "message": { "type": "string", "minLength": 1, "maxLength": 500 }, "badge": { "type": "string", "enum": ["star", "heart", "fire", "trophy", "rocket", "clap"] }, "isPublic": { "type": "boolean" } } }, "UpdateMeeting": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "scheduledAt": { "type": "string" }, "duration": { "type": "number", "nullable": true, "default": 30 }, "recurring": { "type": "string", "enum": ["none", "weekly", "biweekly", "monthly"], "default": "none" }, "status": { "type": "string", "enum": ["scheduled", "completed", "cancelled"], "default": "scheduled" }, "agenda": { "type": "string" }, "notes": { "type": "string" }, "nextMeetingAt": { "type": "string" } } }, "CreateOkr": { "type": "object", "properties": { "objective": { "type": "string", "minLength": 1 }, "ownerId": { "type": "string", "format": "uuid" }, "parentId": { "type": "string", "format": "uuid" }, "cadence": { "type": "string", "enum": ["weekly", "monthly", "quarterly", "annual"] }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "progress": { "type": "number", "nullable": true, "minimum": 0, "maximum": 100, "default": 0 }, "status": { "type": "string", "enum": ["on-track", "at-risk", "off-track", "completed"], "default": "on-track" }, "keyResults": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "target": { "type": "number", "nullable": true }, "current": { "type": "number", "nullable": true }, "unit": { "type": "string" } }, "required": ["title"] }, "default": [] } }, "required": ["objective"] }, "ListOkrs": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateOkr": { "type": "object", "properties": { "objective": { "type": "string", "minLength": 1 }, "ownerId": { "type": "string", "format": "uuid" }, "parentId": { "type": "string", "format": "uuid" }, "cadence": { "type": "string", "enum": ["weekly", "monthly", "quarterly", "annual"] }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "progress": { "type": "number", "nullable": true, "minimum": 0, "maximum": 100, "default": 0 }, "status": { "type": "string", "enum": ["on-track", "at-risk", "off-track", "completed"], "default": "on-track" }, "keyResults": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "target": { "type": "number", "nullable": true }, "current": { "type": "number", "nullable": true }, "unit": { "type": "string" } }, "required": ["title"] }, "default": [] } } }, "CreateDepartment": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "parentDepartmentId": { "type": "string", "format": "uuid" }, "headId": { "type": "string", "format": "uuid" } }, "required": ["name"] }, "DepartmentResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "parentDepartmentId": { "type": "string", "nullable": true, "format": "uuid" }, "headId": { "type": "string", "nullable": true, "format": "uuid" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "name", "parentDepartmentId", "headId", "createdAt", "updatedAt" ] }, "ListDepartments": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateDepartment": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "parentDepartmentId": { "type": "string", "format": "uuid" }, "headId": { "type": "string", "format": "uuid" } } }, "CreateEmployee": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "employeeId": { "type": "string" }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string" }, "workEmail": { "type": "string", "format": "email" }, "personalEmail": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "department": { "type": "string" }, "designation": { "type": "string", "minLength": 1 }, "employmentType": { "type": "string", "enum": ["full-time", "part-time", "contract", "intern"] }, "status": { "type": "string", "enum": ["active", "on-leave", "terminated"], "default": "active" }, "joiningDate": { "type": "string", "format": "date" }, "reportingManagerId": { "type": "string", "format": "uuid" }, "weeklyCapacityHours": { "type": "number", "minimum": 0, "exclusiveMinimum": true } }, "required": ["firstName", "workEmail", "designation"] }, "EmployeeResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "nullable": true, "format": "uuid" }, "employeeId": { "type": "string", "nullable": true }, "displayName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string", "nullable": true }, "workEmail": { "type": "string" }, "personalEmail": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "designation": { "type": "string" }, "employmentType": { "type": "string", "nullable": true }, "status": { "type": "string" }, "joiningDate": { "type": "string", "nullable": true }, "reportingManagerId": { "type": "string", "nullable": true, "format": "uuid" }, "weeklyCapacityHours": { "type": "number", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "userId", "employeeId", "displayName", "firstName", "lastName", "workEmail", "personalEmail", "phone", "department", "designation", "employmentType", "status", "joiningDate", "reportingManagerId", "weeklyCapacityHours", "createdAt", "updatedAt" ] }, "ListEmployees": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateEmployee": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "employeeId": { "type": "string" }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string" }, "workEmail": { "type": "string", "format": "email" }, "personalEmail": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "department": { "type": "string" }, "designation": { "type": "string", "minLength": 1 }, "employmentType": { "type": "string", "enum": ["full-time", "part-time", "contract", "intern"] }, "status": { "type": "string", "enum": ["active", "on-leave", "terminated"], "default": "active" }, "joiningDate": { "type": "string", "format": "date" }, "reportingManagerId": { "type": "string", "format": "uuid" }, "weeklyCapacityHours": { "type": "number", "minimum": 0, "exclusiveMinimum": true } } }, "CreateRole": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" }, "default": [] } }, "required": ["name"] }, "ListRoles": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "RoleResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string", "nullable": true }, "permissions": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "name", "slug", "description", "permissions", "createdAt", "updatedAt" ] }, "UpdateRole": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" }, "default": [] } } }, "CreateShift": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "shiftCode": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "activeDays": { "type": "array", "items": { "type": "string" }, "default": [] }, "timezone": { "type": "string", "default": "UTC" }, "color": { "type": "string" }, "status": { "type": "string", "enum": ["active", "inactive"] }, "priority": { "type": "integer", "nullable": true }, "defaultShift": { "type": "boolean" }, "coreStartTime": { "type": "string" }, "coreEndTime": { "type": "string" }, "autoCheckoutTime": { "type": "string" }, "workMode": { "type": "string", "enum": ["office_only", "remote_only", "hybrid", "client_location", "flexible"] }, "weeklyOffPattern": { "type": "string", "enum": [ "sat_sun_off", "sunday_off", "alternate_saturday", "second_fourth_saturday", "rotational" ] }, "totalShiftDuration": { "type": "number", "nullable": true, "minimum": 0 }, "netWorkingHours": { "type": "number", "nullable": true, "minimum": 0 }, "minimumRequiredHours": { "type": "number", "nullable": true, "minimum": 0 }, "maximumAllowedHours": { "type": "number", "nullable": true, "minimum": 0 }, "breakDurationMinutes": { "type": "number", "nullable": true, "minimum": 0 }, "gracePeriodMinutes": { "type": "number", "nullable": true, "minimum": 0 }, "lateMarkAfterMinutes": { "type": "number", "nullable": true, "minimum": 0 }, "halfDayAfterHours": { "type": "number", "nullable": true, "minimum": 0 }, "absentAfterHours": { "type": "number", "nullable": true, "minimum": 0 }, "overtimeAfterHours": { "type": "number", "nullable": true, "minimum": 0 }, "overtimeEnabled": { "type": "boolean" }, "checkinRequired": { "type": "boolean" }, "checkoutRequired": { "type": "boolean" }, "multipleCheckinsAllowed": { "type": "boolean" }, "breakPunchRequired": { "type": "boolean" }, "autoCheckoutEnabled": { "type": "boolean" }, "geofenceEnabled": { "type": "boolean" }, "selfieVerificationEnabled": { "type": "boolean" }, "ipRestrictionEnabled": { "type": "boolean" }, "locationTrackingEnabled": { "type": "boolean" }, "vpnRequired": { "type": "boolean" }, "mondayEnabled": { "type": "boolean" }, "tuesdayEnabled": { "type": "boolean" }, "wednesdayEnabled": { "type": "boolean" }, "thursdayEnabled": { "type": "boolean" }, "fridayEnabled": { "type": "boolean" }, "saturdayEnabled": { "type": "boolean" }, "sundayEnabled": { "type": "boolean" }, "timesheetRequired": { "type": "boolean" }, "taskTrackingRequired": { "type": "boolean" }, "jiraRequired": { "type": "boolean" }, "dailyStatusReportRequired": { "type": "boolean" }, "notifyEmployeeLate": { "type": "boolean" }, "notifyManagerAbsent": { "type": "boolean" }, "notifyHrRepeatedLate": { "type": "boolean" }, "notifyMissedCheckout": { "type": "boolean" }, "notifyOvertime": { "type": "boolean" } }, "required": ["name", "startTime", "endTime"] }, "ListShifts": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "ShiftResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "activeDays": { "type": "array", "nullable": true, "items": { "type": "string" } }, "timezone": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "name", "startTime", "endTime", "activeDays", "timezone", "createdAt", "updatedAt" ] }, "UpdateShift": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "shiftCode": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "activeDays": { "type": "array", "items": { "type": "string" }, "default": [] }, "timezone": { "type": "string", "default": "UTC" }, "color": { "type": "string" }, "status": { "type": "string", "enum": ["active", "inactive"] }, "priority": { "type": "integer", "nullable": true }, "defaultShift": { "type": "boolean" }, "coreStartTime": { "type": "string" }, "coreEndTime": { "type": "string" }, "autoCheckoutTime": { "type": "string" }, "workMode": { "type": "string", "enum": ["office_only", "remote_only", "hybrid", "client_location", "flexible"] }, "weeklyOffPattern": { "type": "string", "enum": [ "sat_sun_off", "sunday_off", "alternate_saturday", "second_fourth_saturday", "rotational" ] }, "totalShiftDuration": { "type": "number", "nullable": true, "minimum": 0 }, "netWorkingHours": { "type": "number", "nullable": true, "minimum": 0 }, "minimumRequiredHours": { "type": "number", "nullable": true, "minimum": 0 }, "maximumAllowedHours": { "type": "number", "nullable": true, "minimum": 0 }, "breakDurationMinutes": { "type": "number", "nullable": true, "minimum": 0 }, "gracePeriodMinutes": { "type": "number", "nullable": true, "minimum": 0 }, "lateMarkAfterMinutes": { "type": "number", "nullable": true, "minimum": 0 }, "halfDayAfterHours": { "type": "number", "nullable": true, "minimum": 0 }, "absentAfterHours": { "type": "number", "nullable": true, "minimum": 0 }, "overtimeAfterHours": { "type": "number", "nullable": true, "minimum": 0 }, "overtimeEnabled": { "type": "boolean" }, "checkinRequired": { "type": "boolean" }, "checkoutRequired": { "type": "boolean" }, "multipleCheckinsAllowed": { "type": "boolean" }, "breakPunchRequired": { "type": "boolean" }, "autoCheckoutEnabled": { "type": "boolean" }, "geofenceEnabled": { "type": "boolean" }, "selfieVerificationEnabled": { "type": "boolean" }, "ipRestrictionEnabled": { "type": "boolean" }, "locationTrackingEnabled": { "type": "boolean" }, "vpnRequired": { "type": "boolean" }, "mondayEnabled": { "type": "boolean" }, "tuesdayEnabled": { "type": "boolean" }, "wednesdayEnabled": { "type": "boolean" }, "thursdayEnabled": { "type": "boolean" }, "fridayEnabled": { "type": "boolean" }, "saturdayEnabled": { "type": "boolean" }, "sundayEnabled": { "type": "boolean" }, "timesheetRequired": { "type": "boolean" }, "taskTrackingRequired": { "type": "boolean" }, "jiraRequired": { "type": "boolean" }, "dailyStatusReportRequired": { "type": "boolean" }, "notifyEmployeeLate": { "type": "boolean" }, "notifyManagerAbsent": { "type": "boolean" }, "notifyHrRepeatedLate": { "type": "boolean" }, "notifyMissedCheckout": { "type": "boolean" }, "notifyOvertime": { "type": "boolean" } } }, "CreateLeaveRequest": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "sick", "vacation", "personal", "maternity", "paternity", "bereavement", "other" ] }, "fromDate": { "type": "string" }, "toDate": { "type": "string" }, "totalDays": { "type": "number", "nullable": true }, "reason": { "type": "string", "maxLength": 2000 }, "status": { "type": "string", "enum": ["pending", "approved", "rejected", "cancelled"], "default": "pending" }, "approvedById": { "type": "string", "format": "uuid" }, "approvedAt": { "type": "string" } }, "required": ["employeeId", "type", "fromDate", "toDate", "totalDays"] }, "ListLeaveRequests": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateLeaveRequest": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "sick", "vacation", "personal", "maternity", "paternity", "bereavement", "other" ] }, "fromDate": { "type": "string" }, "toDate": { "type": "string" }, "totalDays": { "type": "number", "nullable": true }, "reason": { "type": "string", "maxLength": 2000 }, "status": { "type": "string", "enum": ["pending", "approved", "rejected", "cancelled"], "default": "pending" }, "approvedById": { "type": "string", "format": "uuid" }, "approvedAt": { "type": "string" } } }, "CreatePerformanceReview": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "reviewerId": { "type": "string", "format": "uuid" }, "period": { "type": "string", "minLength": 1 }, "dueDate": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "in-progress", "completed"], "default": "pending" }, "score": { "type": "number", "nullable": true }, "notes": { "type": "string" }, "createdById": { "type": "string", "format": "uuid" } }, "required": ["employeeId", "reviewerId", "period"] }, "ListPerformanceReviews": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdatePerformanceReview": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "reviewerId": { "type": "string", "format": "uuid" }, "period": { "type": "string", "minLength": 1 }, "dueDate": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "in-progress", "completed"], "default": "pending" }, "score": { "type": "number", "nullable": true }, "notes": { "type": "string" }, "createdById": { "type": "string", "format": "uuid" } } }, "CreatePayrollRun": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "period": { "type": "string", "minLength": 1 }, "paymentDate": { "type": "string" }, "status": { "type": "string", "enum": ["draft", "processing", "approved", "paid"], "default": "draft" }, "headcount": { "type": "number", "nullable": true }, "totalGross": { "type": "number", "nullable": true }, "totalDeductions": { "type": "number", "nullable": true }, "totalNet": { "type": "number", "nullable": true }, "totalWorkdays": { "type": "number", "nullable": true }, "lopDays": { "type": "number", "nullable": true }, "notes": { "type": "string" } }, "required": ["title", "period"] }, "ListPayrollRuns": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdatePayrollRun": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "period": { "type": "string", "minLength": 1 }, "paymentDate": { "type": "string" }, "status": { "type": "string", "enum": ["draft", "processing", "approved", "paid"], "default": "draft" }, "headcount": { "type": "number", "nullable": true }, "totalGross": { "type": "number", "nullable": true }, "totalDeductions": { "type": "number", "nullable": true }, "totalNet": { "type": "number", "nullable": true }, "totalWorkdays": { "type": "number", "nullable": true }, "lopDays": { "type": "number", "nullable": true }, "notes": { "type": "string" } } }, "CreateComplianceRecord": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "complianceType": { "type": "string", "enum": [ "pf", "esi", "pt", "tds", "gratuity", "maternity", "policy-ack", "certification" ] }, "documentName": { "type": "string", "minLength": 1 }, "issuedAt": { "type": "string" }, "expiresAt": { "type": "string" }, "status": { "type": "string", "enum": ["active", "expiring-soon", "expired", "pending"], "default": "active" }, "notes": { "type": "string" } }, "required": ["complianceType", "documentName"] }, "ListComplianceRecords": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateComplianceRecord": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "complianceType": { "type": "string", "enum": [ "pf", "esi", "pt", "tds", "gratuity", "maternity", "policy-ack", "certification" ] }, "documentName": { "type": "string", "minLength": 1 }, "issuedAt": { "type": "string" }, "expiresAt": { "type": "string" }, "status": { "type": "string", "enum": ["active", "expiring-soon", "expired", "pending"], "default": "active" }, "notes": { "type": "string" } } }, "CreateSalaryStructure": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "components": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "amount": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "type": { "type": "string", "enum": ["earning", "deduction"], "default": "earning" } }, "required": ["name", "amount"] }, "minItems": 1 }, "effectiveFrom": { "type": "string", "format": "date" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "notes": { "type": "string", "maxLength": 2000 }, "changeReason": { "type": "string", "maxLength": 2000 } }, "required": ["employeeId", "components", "effectiveFrom"] }, "CurrentSalaryStructure": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "asOf": { "type": "string", "format": "date" } }, "required": ["employeeId"] }, "ListSalaryRevisions": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } }, "required": ["employeeId"] }, "ListSalaryStructures": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } }, "required": ["employeeId"] }, "CreateEmployeeBonus": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "bonusDate": { "type": "string", "format": "date" }, "reason": { "type": "string", "maxLength": 2000 } }, "required": ["employeeId", "amount", "bonusDate"] }, "ListEmployeeBonuses": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } }, "required": ["employeeId"] }, "UpdateEmployeeBonus": { "type": "object", "properties": { "amount": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "default": "USD" }, "bonusDate": { "type": "string", "format": "date" }, "reason": { "type": "string", "maxLength": 2000 } } }, "CreateArrears": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "salaryRevisionId": { "type": "string", "format": "uuid" }, "effectiveDate": { "type": "string", "format": "date" }, "amount": { "type": "number", "nullable": true }, "remarks": { "type": "string", "maxLength": 2000 }, "confirm": { "type": "boolean", "enum": [true] } }, "required": ["employeeId", "salaryRevisionId", "effectiveDate", "amount", "confirm"] }, "ListArrears": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } }, "required": ["employeeId"] }, "CreateIntegrationToken": { "type": "object", "properties": { "provider": { "type": "string" }, "accessTokenEnc": { "type": "string" }, "refreshTokenEnc": { "type": "string" }, "expiresAt": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" }, "default": [] }, "externalAccountId": { "type": "string" }, "connectedBy": { "type": "string", "format": "uuid" } }, "required": ["provider", "accessTokenEnc"] }, "CreateWebhook": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string" }, "default": [] }, "secretHash": { "type": "string" }, "active": { "type": "boolean", "default": true } }, "required": ["url", "secretHash"] }, "ListIntegrationTokens": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "provider": { "type": "string" } } }, "ListWebhooks": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateIntegrationToken": { "type": "object", "properties": { "provider": { "type": "string" }, "accessTokenEnc": { "type": "string" }, "refreshTokenEnc": { "type": "string" }, "expiresAt": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" }, "default": [] }, "externalAccountId": { "type": "string" }, "connectedBy": { "type": "string", "format": "uuid" } } }, "UpdateWebhook": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string" }, "default": [] }, "secretHash": { "type": "string" }, "active": { "type": "boolean", "default": true } } }, "CreateAsset": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "storageKey": { "type": "string" }, "url": { "type": "string" }, "campaignId": { "type": "string", "format": "uuid" }, "custom": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": ["name", "kind"] }, "CreateCampaign": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1, "default": "email" }, "status": { "type": "string", "default": "draft" }, "subject": { "type": "string" }, "previewText": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "senderId": { "type": "string", "format": "uuid" }, "providerId": { "type": "string", "format": "uuid" }, "segmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "scheduledAt": { "type": "string" }, "utmSource": { "type": "string" }, "utmMedium": { "type": "string" }, "utmCampaign": { "type": "string" } }, "required": ["name"] }, "CreateEmailTemplate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "subject": { "type": "string", "maxLength": 500 }, "previewText": { "type": "string", "maxLength": 200 }, "bodyHtml": { "type": "string" }, "bodyText": { "type": "string" }, "category": { "type": "string", "maxLength": 50 }, "tags": { "type": "array", "items": { "type": "string" } }, "isGlobal": { "type": "boolean" }, "thumbnailUrl": { "type": "string" } }, "required": ["name"] }, "CreateMarketingForm": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "type": { "type": "string", "enum": ["inline", "popup", "slide-in", "sticky-bar", "standalone"], "default": "inline" }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } }, "default": [] }, "submitAction": { "type": "object", "additionalProperties": { "nullable": true } }, "segmentId": { "type": "string", "format": "uuid" }, "sequenceId": { "type": "string", "format": "uuid" }, "fieldMapping": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": ["name"] }, "ListMarketingForms": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 1, "default": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } }, "UpdateAsset": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "storageKey": { "type": "string" }, "url": { "type": "string" }, "campaignId": { "type": "string", "format": "uuid" }, "custom": { "type": "object", "additionalProperties": { "nullable": true } } } }, "UpdateCampaign": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1, "default": "email" }, "status": { "type": "string", "default": "draft" }, "subject": { "type": "string" }, "previewText": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "senderId": { "type": "string", "format": "uuid" }, "providerId": { "type": "string", "format": "uuid" }, "segmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "scheduledAt": { "type": "string" }, "utmSource": { "type": "string" }, "utmMedium": { "type": "string" }, "utmCampaign": { "type": "string" } } }, "UpdateEmailTemplate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "subject": { "type": "string", "maxLength": 500 }, "previewText": { "type": "string", "maxLength": 200 }, "bodyHtml": { "type": "string" }, "bodyText": { "type": "string" }, "category": { "type": "string", "maxLength": 50 }, "tags": { "type": "array", "items": { "type": "string" } }, "isGlobal": { "type": "boolean" }, "thumbnailUrl": { "type": "string" } } }, "UpdateMarketingForm": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "type": { "type": "string", "enum": ["inline", "popup", "slide-in", "sticky-bar", "standalone"], "default": "inline" }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } }, "default": [] }, "submitAction": { "type": "object", "additionalProperties": { "nullable": true } }, "segmentId": { "type": "string", "format": "uuid" }, "sequenceId": { "type": "string", "format": "uuid" }, "fieldMapping": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ListMedia": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "UpdateMediaMeta": { "type": "object", "properties": { "alt": { "type": "string" }, "purpose": { "type": "string", "enum": ["avatar", "workspace-logo", "general"] } } }, "UploadMediaMeta": { "type": "object", "properties": { "alt": { "type": "string" }, "purpose": { "type": "string", "enum": ["avatar", "workspace-logo", "general"] } } }, "ListCareersOpeningsQuery": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "ListChangelogQuery": { "type": "object", "properties": { "where": { "type": "object", "properties": { "isPublished": { "type": "object", "properties": { "equals": { "type": "string" } } }, "module": { "type": "object", "properties": { "equals": { "type": "string" } } }, "version": { "type": "object", "properties": { "equals": { "type": "string" } } }, "releaseDate": { "type": "object", "properties": { "equals": { "type": "string" }, "greater_than_equal": { "type": "string" }, "less_than_equal": { "type": "string" } } } } }, "sort": { "type": "string" }, "limit": { "type": "integer", "minimum": 1, "maximum": 500, "default": 200 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "ListDocArticlesQuery": { "type": "object", "properties": { "where": { "type": "object", "properties": { "slug": { "type": "object", "properties": { "equals": { "type": "string" } } }, "category": { "type": "object", "properties": { "equals": { "type": "string" } } }, "status": { "type": "object", "properties": { "equals": { "type": "string" } } } } }, "sort": { "type": "string" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "depth": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 2, "default": 1 } } }, "ListDocCategoriesQuery": { "type": "object", "properties": { "where": { "type": "object", "properties": { "slug": { "type": "object", "properties": { "equals": { "type": "string" } } }, "section": { "type": "object", "properties": { "equals": { "type": "string" } } } } }, "sort": { "type": "string" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "ListFaqsQuery": { "type": "object", "properties": { "where": { "type": "object", "properties": { "category": { "type": "object", "properties": { "equals": { "type": "string" } } } } }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "CreateApplicant": { "type": "object", "properties": { "jobPostingId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "resumeFileId": { "type": "string", "format": "uuid" }, "stage": { "type": "string", "default": "applied" }, "score": { "type": "integer", "nullable": true }, "source": { "type": "string" }, "notes": { "type": "string" }, "custom": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} } }, "required": ["jobPostingId", "firstName", "email"] }, "CreateInterview": { "type": "object", "properties": { "applicantId": { "type": "string", "format": "uuid" }, "scheduledAt": { "type": "string" }, "durationMinutes": { "type": "integer", "nullable": true, "default": 60 }, "interviewerIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "default": [] }, "kind": { "type": "string", "enum": ["video", "phone", "in_person"], "default": "video" }, "status": { "type": "string", "enum": ["scheduled", "completed", "cancelled"], "default": "scheduled" }, "feedback": { "type": "array", "items": { "nullable": true }, "default": [] }, "rating": { "type": "integer", "nullable": true } }, "required": ["applicantId", "scheduledAt"] }, "CreateJobPosting": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "departmentId": { "type": "string", "format": "uuid" }, "description": { "type": "string", "default": "" }, "status": { "type": "string", "enum": ["draft", "open", "closed"], "default": "draft" }, "location": { "type": "string" }, "employmentType": { "type": "string" }, "salaryMin": { "type": "number", "nullable": true }, "salaryMax": { "type": "number", "nullable": true }, "openings": { "type": "integer", "nullable": true, "default": 1 }, "hiringManagerId": { "type": "string", "format": "uuid" } }, "required": ["title"] }, "CreateScorecard": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "criterion": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["criterion"] }, "default": [] } }, "required": ["name"] }, "ListApplicants": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "jobPostingId": { "type": "string", "format": "uuid" } } }, "ListInterviews": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "applicantId": { "type": "string", "format": "uuid" } } }, "ListJobPostings": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "ListScorecards": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "ScorecardCriterion": { "type": "object", "properties": { "criterion": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["criterion"] }, "UpdateApplicant": { "type": "object", "properties": { "jobPostingId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "resumeFileId": { "type": "string", "format": "uuid" }, "stage": { "type": "string", "default": "applied" }, "score": { "type": "integer", "nullable": true }, "source": { "type": "string" }, "notes": { "type": "string" }, "custom": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} } } }, "UpdateInterview": { "type": "object", "properties": { "applicantId": { "type": "string", "format": "uuid" }, "scheduledAt": { "type": "string" }, "durationMinutes": { "type": "integer", "nullable": true, "default": 60 }, "interviewerIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "default": [] }, "kind": { "type": "string", "enum": ["video", "phone", "in_person"], "default": "video" }, "status": { "type": "string", "enum": ["scheduled", "completed", "cancelled"], "default": "scheduled" }, "feedback": { "type": "array", "items": { "nullable": true }, "default": [] }, "rating": { "type": "integer", "nullable": true } } }, "UpdateJobPosting": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "departmentId": { "type": "string", "format": "uuid" }, "description": { "type": "string", "default": "" }, "status": { "type": "string", "enum": ["draft", "open", "closed"], "default": "draft" }, "location": { "type": "string" }, "employmentType": { "type": "string" }, "salaryMin": { "type": "number", "nullable": true }, "salaryMax": { "type": "number", "nullable": true }, "openings": { "type": "integer", "nullable": true, "default": 1 }, "hiringManagerId": { "type": "string", "format": "uuid" } } }, "UpdateScorecard": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "criterion": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["criterion"] } } } }, "CreateReport": { "type": "object", "properties": { "reportType": { "type": "string", "minLength": 1 }, "generatedBy": { "type": "string", "format": "uuid" }, "dateFrom": { "type": "string" }, "dateTo": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "nullable": true } }, "data": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} }, "expiresAt": { "type": "string" } }, "required": ["reportType", "generatedBy"] }, "ListReports": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "where": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ReportIdParam": { "type": "string", "format": "uuid" }, "ReportResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "reportType": { "type": "string" }, "generatedBy": { "type": "string", "format": "uuid" }, "dateFrom": { "type": "string", "nullable": true }, "dateTo": { "type": "string", "nullable": true }, "filters": { "type": "object", "nullable": true, "additionalProperties": { "nullable": true } }, "data": { "type": "object", "additionalProperties": { "nullable": true } }, "expiresAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" } }, "required": [ "id", "workspaceId", "reportType", "generatedBy", "dateFrom", "dateTo", "filters", "data", "expiresAt", "createdAt" ] }, "UpdateReport": { "type": "object", "properties": { "reportType": { "type": "string", "minLength": 1 }, "generatedBy": { "type": "string", "format": "uuid" }, "dateFrom": { "type": "string" }, "dateTo": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "nullable": true } }, "data": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} }, "expiresAt": { "type": "string" } } }, "CreateReportDefinition": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "reportType": { "type": "string", "minLength": 1, "maxLength": 100 }, "definition": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} }, "isShared": { "type": "boolean", "default": false }, "schedule": { "type": "object", "nullable": true, "properties": { "frequency": { "type": "string", "enum": ["Daily", "Weekly", "Monthly"] }, "recipients": { "type": "array", "items": { "type": "string", "format": "email" } } }, "required": ["frequency"], "additionalProperties": false } }, "required": ["name", "reportType"] }, "ListReportDefinitions": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "reportType": { "type": "string" }, "isShared": { "type": "boolean", "nullable": true } } }, "ReportDefinitionIdParam": { "type": "string", "format": "uuid" }, "Schedule": { "type": "object", "properties": { "frequency": { "type": "string", "enum": ["Daily", "Weekly", "Monthly"] }, "recipients": { "type": "array", "items": { "type": "string", "format": "email" } } }, "required": ["frequency"], "additionalProperties": false }, "UpdateReportDefinition": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "reportType": { "type": "string", "minLength": 1, "maxLength": 100 }, "definition": { "type": "object", "additionalProperties": { "nullable": true }, "default": {} }, "isShared": { "type": "boolean", "default": false }, "schedule": { "type": "object", "nullable": true, "properties": { "frequency": { "type": "string", "enum": ["Daily", "Weekly", "Monthly"] }, "recipients": { "type": "array", "items": { "type": "string", "format": "email" } } }, "required": ["frequency"], "additionalProperties": false } } }, "AssignTicketBody": { "type": "object", "properties": { "assigneeId": { "type": "string", "format": "uuid" } }, "required": ["assigneeId"] }, "ChannelResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "address": { "type": "string" }, "inboundProvider": { "type": "string" }, "outboundFromName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "name", "address", "inboundProvider", "outboundFromName", "isActive", "createdAt", "updatedAt" ] }, "CreateChannel": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "address": { "type": "string", "format": "email" }, "inboundProvider": { "type": "string", "enum": ["maileroo", "manual"], "default": "maileroo" }, "outboundFromName": { "type": "string" }, "isActive": { "type": "boolean", "default": true } }, "required": ["name", "address"] }, "CreateTicket": { "type": "object", "properties": { "subject": { "type": "string", "minLength": 1 }, "body": { "type": "string" }, "status": { "type": "string", "enum": ["open", "pending", "resolved", "closed"], "default": "open" }, "priority": { "type": "string", "enum": ["low", "medium", "high", "urgent"], "default": "medium" }, "channel": { "type": "string", "enum": ["manual", "portal", "email"], "default": "manual" }, "mailboxId": { "type": "string", "format": "uuid" }, "requesterEmail": { "type": "string", "format": "email" }, "requesterName": { "type": "string" }, "requesterContactId": { "type": "string", "format": "uuid" }, "sourceSystem": { "type": "string", "enum": ["freescout"] }, "sourceId": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "nullable": true } }, "assigneeId": { "type": "string", "format": "uuid" } }, "required": ["subject"] }, "LinkTask": { "type": "object", "properties": { "taskId": { "type": "string", "format": "uuid" }, "autoResolveOnComplete": { "type": "boolean", "default": true } }, "required": ["taskId"] }, "ListChannels": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "ListTickets": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "status": { "type": "string" }, "assigneeId": { "type": "string", "format": "uuid" } } }, "TicketResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "ticketNumber": { "type": "integer", "nullable": true }, "subject": { "type": "string" }, "body": { "type": "string", "nullable": true }, "status": { "type": "string" }, "priority": { "type": "string" }, "channel": { "type": "string" }, "mailboxId": { "type": "string", "nullable": true, "format": "uuid" }, "requesterEmail": { "type": "string", "nullable": true }, "requesterName": { "type": "string", "nullable": true }, "requesterContactId": { "type": "string", "nullable": true, "format": "uuid" }, "sourceSystem": { "type": "string", "nullable": true }, "sourceId": { "type": "string", "nullable": true }, "metadata": { "type": "object", "nullable": true, "additionalProperties": { "nullable": true } }, "assigneeId": { "type": "string", "nullable": true, "format": "uuid" }, "linkedTaskIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "firstResponseAt": { "type": "string", "nullable": true }, "resolvedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "ticketNumber", "subject", "body", "status", "priority", "channel", "mailboxId", "requesterEmail", "requesterName", "requesterContactId", "sourceSystem", "sourceId", "metadata", "assigneeId", "firstResponseAt", "resolvedAt", "createdAt", "updatedAt" ] }, "UpdateChannel": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "address": { "type": "string", "format": "email" }, "inboundProvider": { "type": "string", "enum": ["maileroo", "manual"], "default": "maileroo" }, "outboundFromName": { "type": "string" }, "isActive": { "type": "boolean", "default": true } } }, "UpdateTicket": { "type": "object", "properties": { "subject": { "type": "string", "minLength": 1 }, "body": { "type": "string" }, "status": { "type": "string", "enum": ["open", "pending", "resolved", "closed"], "default": "open" }, "priority": { "type": "string", "enum": ["low", "medium", "high", "urgent"], "default": "medium" }, "channel": { "type": "string", "enum": ["manual", "portal", "email"], "default": "manual" }, "mailboxId": { "type": "string", "format": "uuid" }, "requesterEmail": { "type": "string", "format": "email" }, "requesterName": { "type": "string" }, "requesterContactId": { "type": "string", "format": "uuid" }, "sourceSystem": { "type": "string", "enum": ["freescout"] }, "sourceId": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "nullable": true } }, "assigneeId": { "type": "string", "format": "uuid" } } }, "DecideApproval": { "type": "object", "properties": { "decision": { "type": "string", "enum": ["approved", "rejected"] }, "notes": { "type": "string", "maxLength": 2000 } }, "required": ["decision"] }, "ListApprovalRequests": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "AssignProjectMember": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "role": { "type": "string", "default": "member" }, "customRate": { "type": "number", "nullable": true }, "costRate": { "type": "number", "nullable": true } }, "required": ["projectId", "userId"] }, "CreateChatChannel": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "topic": { "type": "string" }, "projectId": { "type": "string", "format": "uuid" }, "isPrivate": { "type": "boolean", "default": false }, "custom": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": ["name"] }, "CreateFile": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "mimeType": { "type": "string", "minLength": 1 }, "storageKey": { "type": "string", "minLength": 1 }, "size": { "type": "number", "nullable": true }, "projectId": { "type": "string", "format": "uuid" }, "taskId": { "type": "string", "format": "uuid" }, "uploadedById": { "type": "string", "format": "uuid" }, "custom": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": ["name", "mimeType", "storageKey", "size", "uploadedById"] }, "CreateMessage": { "type": "object", "properties": { "channelId": { "type": "string", "format": "uuid" }, "authorId": { "type": "string", "format": "uuid" }, "content": { "type": "string", "minLength": 1 }, "attachments": { "type": "array", "items": { "nullable": true } } }, "required": ["channelId", "content"] }, "CreateMilestone": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "projectId": { "type": "string", "format": "uuid" }, "dueDate": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "startDate": { "type": "string" }, "status": { "type": "string" }, "priority": { "type": "string", "maxLength": 20 }, "statusId": { "type": "string", "format": "uuid" }, "priorityId": { "type": "string", "format": "uuid" }, "typeId": { "type": "string", "format": "uuid" }, "budgetedTime": { "type": "string", "maxLength": 20 }, "tags": { "type": "array", "items": { "type": "string" } }, "assigneeId": { "type": "string", "format": "uuid" } }, "required": ["name", "projectId", "dueDate"] }, "CreateProject": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "status": { "type": "string", "default": "planned" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "ownerId": { "type": "string", "format": "uuid" }, "clientOrgId": { "type": "string", "format": "uuid" }, "budget": { "type": "number", "nullable": true }, "custom": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": ["name"] }, "CreateSprint": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "projectId": { "type": "string", "format": "uuid" }, "goal": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "status": { "type": "string", "default": "planned" } }, "required": ["name", "projectId"] }, "CreateTask": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "projectId": { "type": "string", "format": "uuid" }, "sprintId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "default": "todo" }, "priority": { "type": "string", "default": "medium" }, "assigneeId": { "type": "string", "format": "uuid" }, "dueDate": { "type": "string" }, "parentId": { "type": "string", "format": "uuid" }, "position": { "type": "number", "nullable": true }, "estimateHours": { "type": "number", "nullable": true }, "storyPoints": { "type": "number", "nullable": true, "minimum": 0 }, "custom": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": ["title"] }, "ListQuery": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 } } }, "MergeProject": { "type": "object", "properties": { "targetProjectId": { "type": "string", "format": "uuid" }, "dryRun": { "type": "boolean" } }, "required": ["targetProjectId"] }, "UpdateChatChannel": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "topic": { "type": "string" }, "projectId": { "type": "string", "format": "uuid" }, "isPrivate": { "type": "boolean", "default": false }, "custom": { "type": "object", "additionalProperties": { "nullable": true } } } }, "UpdateFile": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "mimeType": { "type": "string", "minLength": 1 }, "storageKey": { "type": "string", "minLength": 1 }, "size": { "type": "number", "nullable": true }, "projectId": { "type": "string", "format": "uuid" }, "taskId": { "type": "string", "format": "uuid" }, "uploadedById": { "type": "string", "format": "uuid" }, "custom": { "type": "object", "additionalProperties": { "nullable": true } } } }, "UpdateMessage": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1 } } }, "UpdateProject": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "status": { "type": "string", "default": "planned" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "ownerId": { "type": "string", "format": "uuid" }, "clientOrgId": { "type": "string", "format": "uuid" }, "budget": { "type": "number", "nullable": true }, "custom": { "type": "object", "additionalProperties": { "nullable": true } } } }, "UpdateSprint": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "projectId": { "type": "string", "format": "uuid" }, "goal": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "status": { "type": "string", "default": "planned" } } }, "UpdateTask": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "projectId": { "type": "string", "format": "uuid" }, "sprintId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "default": "todo" }, "priority": { "type": "string", "default": "medium" }, "assigneeId": { "type": "string", "format": "uuid" }, "dueDate": { "type": "string" }, "parentId": { "type": "string", "format": "uuid" }, "position": { "type": "number", "nullable": true }, "estimateHours": { "type": "number", "nullable": true }, "storyPoints": { "type": "number", "nullable": true, "minimum": 0 }, "custom": { "type": "object", "additionalProperties": { "nullable": true } } } }, "ContentListQuery": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "page": { "type": "integer", "minimum": 1, "default": 1 }, "depth": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 1, "default": 1 } } }, "UpvoteFeatureIdeaBody": { "type": "object", "properties": { "voterId": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": ["voterId"] }, "SubmitSurveyResponseBody": { "type": "object", "properties": { "responderId": { "type": "string", "minLength": 1, "maxLength": 200 }, "responderEmail": { "type": "string", "maxLength": 320 }, "workspaceId": { "type": "string", "format": "uuid" }, "answers": { "type": "array", "items": { "nullable": true }, "maxItems": 500 } }, "required": ["responderId", "answers"] }, "ContentAdminListQuery": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1 } } }, "PlatformTicketsListQuery": { "type": "object", "properties": { "reporterUserId": { "type": "string", "minLength": 1, "maxLength": 200 }, "reporterEmail": { "type": "string", "minLength": 1, "maxLength": 320 }, "limit": { "type": "integer", "minimum": 1 } } }, "PlatformLeadsListQuery": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1, "maxLength": 50 }, "limit": { "type": "integer", "minimum": 1 } } }, "PaginationQuery": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 1, "default": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } }, "LmsCourseScopedListQuery": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 1, "default": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "courseId": { "type": "string", "format": "uuid" } } }, "LmsLessonsListQuery": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 1, "default": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "moduleId": { "type": "string", "format": "uuid" } } }, "MigrationStatusQuery": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "track": { "type": "string", "enum": ["payload", "drizzle"], "default": "payload" } }, "required": ["name"] }, "ReportDefinitionResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "reportType": { "type": "string" }, "definition": { "type": "object", "additionalProperties": { "nullable": true } }, "ownerId": { "type": "string", "nullable": true, "format": "uuid" }, "isShared": { "type": "boolean" }, "schedule": { "type": "object", "nullable": true, "properties": { "frequency": { "type": "string", "enum": ["Daily", "Weekly", "Monthly"] }, "recipients": { "type": "array", "items": { "type": "string", "format": "email" } } }, "required": ["frequency"], "additionalProperties": false }, "lastRunAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "name", "reportType", "definition", "ownerId", "isShared", "schedule", "lastRunAt", "updatedAt", "createdAt" ] }, "EstimateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "nullable": true, "format": "uuid" }, "title": { "type": "string" }, "subtotal": { "type": "number" }, "tax": { "type": "number" }, "discount": { "type": "number" }, "total": { "type": "number" }, "status": { "type": "string" }, "validUntil": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true }, "quoteNumber": { "type": "string", "nullable": true }, "dealId": { "type": "string", "nullable": true, "format": "uuid" }, "contactId": { "type": "string", "nullable": true, "format": "uuid" }, "lineItems": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": { "nullable": true } } } }, "required": [ "id", "workspaceId", "clientId", "title", "subtotal", "tax", "discount", "total", "status", "validUntil", "notes", "createdAt", "updatedAt", "deletedAt", "quoteNumber", "dealId", "contactId", "lineItems" ] }, "AccountResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "type": "string" }, "balance": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" }, "snowflakeId": { "type": "number", "nullable": true }, "oldUuidId": { "type": "string", "nullable": true, "format": "uuid" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "name", "type", "balance", "currency", "description", "isActive", "updatedAt", "createdAt", "snowflakeId", "oldUuidId", "deletedAt" ] }, "VendorResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "category": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "paymentTerms": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" }, "snowflakeId": { "type": "number", "nullable": true }, "oldUuidId": { "type": "string", "nullable": true, "format": "uuid" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "name", "category", "email", "phone", "website", "address", "paymentTerms", "notes", "isActive", "updatedAt", "createdAt", "snowflakeId", "oldUuidId", "deletedAt" ] }, "PayrollResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "employeeId": { "type": "string", "format": "uuid" }, "month": { "type": "string" }, "year": { "type": "string" }, "grossPay": { "type": "string", "nullable": true }, "deductions": { "type": "string", "nullable": true }, "netPay": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "paidAt": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" }, "snowflakeId": { "type": "number", "nullable": true }, "oldUuidId": { "type": "string", "nullable": true, "format": "uuid" }, "createdById": { "type": "string", "nullable": true, "format": "uuid" }, "updatedById": { "type": "string", "nullable": true, "format": "uuid" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "employeeId", "month", "year", "grossPay", "deductions", "netPay", "currency", "status", "paidAt", "notes", "updatedAt", "createdAt", "snowflakeId", "oldUuidId", "createdById", "updatedById", "deletedAt" ] }, "LedgerSummaryResponse": { "type": "object", "properties": { "totalCredits": { "type": "number" }, "totalDebits": { "type": "number" }, "net": { "type": "number" }, "entriesThisMonth": { "type": "number" } }, "required": ["totalCredits", "totalDebits", "net", "entriesThisMonth"] }, "RevenueSummaryResponse": { "type": "object", "properties": { "totalRevenue": { "type": "number" }, "thisMonthRevenue": { "type": "number" }, "outstanding": { "type": "number" }, "avgInvoice": { "type": "number" } }, "required": ["totalRevenue", "thisMonthRevenue", "outstanding", "avgInvoice"] }, "InvoiceFromTimeLogResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": "string" }, "clientId": { "type": "string", "nullable": true, "format": "uuid" }, "contactId": { "type": "string", "nullable": true, "format": "uuid" }, "status": { "type": "string", "nullable": true }, "issueDate": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "amount": { "type": "number", "nullable": true }, "taxAmount": { "type": "number", "nullable": true }, "totalAmount": { "type": "number", "nullable": true }, "notes": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "quantity": { "type": "string" }, "unitPrice": { "type": "string" }, "amount": { "type": "string" } }, "required": ["description", "quantity", "unitPrice", "amount"] } }, "timeEntriesInvoiced": { "type": "number" } }, "required": [ "id", "workspaceId", "invoiceNumber", "clientId", "contactId", "status", "issueDate", "dueDate", "currency", "amount", "taxAmount", "totalAmount", "notes", "createdAt", "updatedAt", "deletedAt", "items", "timeEntriesInvoiced" ] }, "LeadResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "stage": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "assigneeId": { "type": "string", "nullable": true, "format": "uuid" }, "convertedToDealId": { "type": "string", "nullable": true, "format": "uuid" }, "lastContactedAt": { "type": "string", "nullable": true }, "convertedAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" }, "snowflakeId": { "type": "number", "nullable": true }, "oldUuidId": { "type": "string", "nullable": true, "format": "uuid" }, "teamSize": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "pipelineStage": { "type": "string", "nullable": true }, "sourcePage": { "type": "string", "nullable": true }, "websiteLeadId": { "type": "string", "nullable": true }, "owner": { "type": "string", "nullable": true }, "customFields": { "type": "object", "additionalProperties": { "nullable": true } }, "hubspotMeta": { "type": "object", "nullable": true, "additionalProperties": { "nullable": true } }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "firstName", "lastName", "email", "phone", "company", "title", "website", "source", "stage", "status", "value", "notes", "assigneeId", "convertedToDealId", "lastContactedAt", "convertedAt", "updatedAt", "createdAt", "snowflakeId", "oldUuidId", "teamSize", "message", "pipelineStage", "sourcePage", "websiteLeadId", "owner", "customFields", "hubspotMeta", "deletedAt" ] }, "DealResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "company": { "type": "string", "nullable": true }, "contactId": { "type": "string", "nullable": true, "format": "uuid" }, "value": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "stage": { "type": "string", "nullable": true }, "pipelineId": { "type": "string", "nullable": true, "format": "uuid" }, "probability": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "priority": { "type": "string", "nullable": true }, "assigneeId": { "type": "string", "nullable": true, "format": "uuid" }, "expectedCloseDate": { "type": "string", "nullable": true }, "closedAt": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" }, "snowflakeId": { "type": "number", "nullable": true }, "oldUuidId": { "type": "string", "nullable": true, "format": "uuid" }, "lostReason": { "type": "string", "nullable": true }, "customFields": { "type": "object", "additionalProperties": { "nullable": true } }, "hubspotMeta": { "type": "object", "nullable": true, "additionalProperties": { "nullable": true } }, "version": { "type": "number" }, "deletedAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "title", "company", "contactId", "value", "currency", "stage", "pipelineId", "probability", "status", "priority", "assigneeId", "expectedCloseDate", "closedAt", "notes", "updatedAt", "createdAt", "snowflakeId", "oldUuidId", "lostReason", "customFields", "hubspotMeta", "version", "deletedAt" ] }, "PipelineResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "isDefault": { "type": "boolean", "nullable": true }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" }, "snowflakeId": { "type": "number", "nullable": true }, "oldUuidId": { "type": "string", "nullable": true, "format": "uuid" }, "color": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "active": { "type": "boolean", "nullable": true }, "stages": { "type": "array", "items": { "type": "object", "properties": { "arrayOrder": { "type": "number" }, "parentId": { "type": "string", "format": "uuid" }, "id": { "type": "string" }, "name": { "type": "string" }, "probability": { "type": "string", "nullable": true }, "order": { "type": "string", "nullable": true } }, "required": ["arrayOrder", "parentId", "id", "name", "probability", "order"] } } }, "required": [ "id", "workspaceId", "name", "isDefault", "updatedAt", "createdAt", "snowflakeId", "oldUuidId", "color", "description", "active", "stages" ] }, "CrmLeadRouteResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "conditionField": { "type": "string" }, "conditionOperator": { "type": "string" }, "conditionValue": { "type": "string" }, "assigneeId": { "type": "string" }, "assigneeName": { "type": "string", "nullable": true }, "priority": { "type": "string", "nullable": true }, "active": { "type": "boolean", "nullable": true }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "workspaceId", "name", "conditionField", "conditionOperator", "conditionValue", "assigneeId", "assigneeName", "priority", "active", "updatedAt", "createdAt" ] }, "CrmProductResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "sku": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "price": { "type": "string" }, "currency": { "type": "string", "nullable": true }, "unit": { "type": "string", "nullable": true }, "active": { "type": "boolean", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "order": { "type": "number" }, "parentId": { "type": "string", "format": "uuid" }, "id": { "type": "string" }, "tag": { "type": "string", "nullable": true } }, "required": ["order", "parentId", "id", "tag"] } } }, "required": [ "id", "workspaceId", "name", "sku", "description", "type", "price", "currency", "unit", "active", "imageUrl", "updatedAt", "createdAt", "tags" ] }, "CrmSequenceResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "order": { "type": "number" }, "parentId": { "type": "string", "format": "uuid" }, "id": { "type": "string" }, "type": { "type": "string" }, "delayDays": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "taskTitle": { "type": "string", "nullable": true } }, "required": [ "order", "parentId", "id", "type", "delayDays", "subject", "body", "taskTitle" ] } } }, "required": [ "id", "workspaceId", "name", "description", "status", "updatedAt", "createdAt", "steps" ] }, "CrmSequenceEnrollmentResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "sequenceId": { "type": "string", "format": "uuid" }, "contactId": { "type": "string" }, "contactEmail": { "type": "string", "nullable": true }, "currentStep": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "lastSentAt": { "type": "string", "nullable": true }, "completedAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "workspaceId", "sequenceId", "contactId", "contactEmail", "currentStep", "status", "lastSentAt", "completedAt", "updatedAt", "createdAt" ] }, "CrmCustomFieldDefResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "objectType": { "type": "string" }, "fieldKey": { "type": "string" }, "fieldLabel": { "type": "string" }, "fieldType": { "type": "string" }, "fieldOptions": { "nullable": true }, "isRequired": { "type": "boolean", "nullable": true }, "displayOrder": { "type": "string", "nullable": true }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "workspaceId", "objectType", "fieldKey", "fieldLabel", "fieldType", "isRequired", "displayOrder", "updatedAt", "createdAt" ] }, "ClientPortalTokenResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "client": { "type": "string" }, "token": { "type": "string" }, "expiresAt": { "type": "string" }, "lastAccessedAt": { "type": "string", "nullable": true }, "clientName": { "type": "string", "nullable": true }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "workspaceId", "client", "token", "expiresAt", "lastAccessedAt", "clientName", "updatedAt", "createdAt" ] }, "OkrResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "objective": { "type": "string" }, "ownerId": { "type": "string", "nullable": true, "format": "uuid" }, "parentId": { "type": "string", "nullable": true, "format": "uuid" }, "cadence": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "progress": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "keyResults": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": { "nullable": true } } }, "isActive": { "type": "boolean", "nullable": true }, "createdBy": { "type": "string", "nullable": true, "format": "uuid" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "createdById": { "type": "string", "nullable": true, "format": "uuid" } }, "required": [ "id", "workspaceId", "objective", "ownerId", "parentId", "cadence", "startDate", "endDate", "progress", "status", "keyResults", "isActive", "createdBy", "createdAt", "updatedAt", "createdById" ] }, "OneOnOneMeetingResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "hostId": { "type": "string", "format": "uuid" }, "participantId": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "scheduledAt": { "type": "string", "nullable": true }, "duration": { "type": "string", "nullable": true }, "recurring": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "agenda": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "nextMeetingAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "hostId", "participantId", "title", "scheduledAt", "duration", "recurring", "status", "agenda", "notes", "nextMeetingAt", "updatedAt", "createdAt" ] }, "AppreciationResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "fromUserId": { "type": "string", "format": "uuid" }, "toUserId": { "type": "string", "format": "uuid" }, "message": { "type": "string" }, "badge": { "type": "string" }, "isPublic": { "type": "boolean", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true } }, "required": [ "id", "workspaceId", "fromUserId", "toUserId", "message", "badge", "isPublic", "updatedAt", "createdAt" ] }, "AuthNextLoginBody": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 8 }, "rememberMe": { "type": "boolean", "default": false } }, "required": ["email", "password"] }, "AuthNextRefreshBody": { "type": "object", "properties": { "refreshToken": { "type": "string", "minLength": 20 } }, "required": ["refreshToken"] }, "AuthNextTotpVerifyBody": { "type": "object", "properties": { "code": { "type": "string", "minLength": 6, "maxLength": 6 } }, "required": ["code"] }, "AuthNextCompleteMfaLoginBody": { "type": "object", "properties": { "code": { "type": "string", "minLength": 6, "maxLength": 6 }, "refreshToken": { "type": "string", "minLength": 20 } }, "required": ["code", "refreshToken"] }, "AuthNextAdminSetPasswordBody": { "type": "object", "properties": { "authUserId": { "type": "string", "format": "uuid" }, "password": { "type": "string", "minLength": 8 } }, "required": ["authUserId", "password"] }, "AuthNextAdminSetEmailBody": { "type": "object", "properties": { "authUserId": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" } }, "required": ["authUserId", "email"] }, "AuthNextImpersonateBody": { "type": "object", "properties": { "targetUserId": { "type": "string", "format": "uuid" }, "reason": { "type": "string", "maxLength": 500 } }, "required": ["targetUserId"] }, "AuthNextImpersonateGrantBody": { "type": "object", "properties": { "targetWorkspaceId": { "type": "string", "format": "uuid" }, "reason": { "type": "string", "minLength": 10, "maxLength": 500 } }, "required": ["targetWorkspaceId", "reason"] }, "AuthNextImpersonateRedeemBody": { "type": "object", "properties": { "grantId": { "type": "string", "format": "uuid" }, "binderSecret": { "type": "string", "minLength": 32, "maxLength": 128 } }, "required": ["grantId", "binderSecret"] }, "AuthNextMfaEnrollBody": { "type": "object", "properties": { "email": { "type": "string", "maxLength": 320 } }, "default": {} }, "AuthNextTokenResponse": { "type": "object", "properties": { "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "refreshExpiresIn": { "type": "integer" }, "expiresIn": { "type": "integer" } }, "required": ["accessToken", "refreshToken", "refreshExpiresIn", "expiresIn"] }, "AuthNextVerifyPasswordResponse": { "type": "object", "properties": { "valid": { "type": "boolean" } }, "required": ["valid"] }, "AuthNextImpersonateResponse": { "type": "object", "properties": { "accessToken": { "type": "string" }, "expiresIn": { "type": "integer" }, "target": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": ["id", "name", "email"] } }, "required": ["accessToken", "expiresIn", "target"] }, "AuthNextImpersonateGrantResponse": { "type": "object", "properties": { "grantId": { "type": "string", "format": "uuid" }, "grantSecret": { "type": "string" }, "expiresIn": { "type": "integer" }, "target": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "role": { "type": "string" } }, "required": ["id", "name", "email", "role"] } }, "required": ["grantId", "grantSecret", "expiresIn", "target"] }, "AuthNextImpersonateRedeemResponse": { "type": "object", "properties": { "accessToken": { "type": "string" }, "expiresIn": { "type": "integer" }, "workspaceSlug": { "type": "string" }, "workspaceId": { "type": "string", "format": "uuid" }, "targetUserId": { "type": "string", "format": "uuid" }, "impersonatorAuthUserId": { "type": "string", "format": "uuid" } }, "required": [ "accessToken", "expiresIn", "workspaceSlug", "workspaceId", "targetUserId", "impersonatorAuthUserId" ] }, "AuthNextMeResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "full_name": { "type": "string" }, "workspace_id": { "type": "string", "format": "uuid" }, "workspace_slug": { "type": "string" }, "workspace_name": { "type": "string" }, "role": { "type": "string" } }, "required": [ "id", "email", "full_name", "workspace_id", "workspace_slug", "workspace_name", "role" ] }, "AuthNextSession": { "type": "object", "properties": { "id": { "type": "string" }, "user_agent": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "last_used_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" } }, "required": ["id", "user_agent", "ip", "created_at", "last_used_at", "expires_at"] }, "AuthNextSessionList": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "user_agent": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "last_used_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" } }, "required": ["id", "user_agent", "ip", "created_at", "last_used_at", "expires_at"] } } }, "required": ["docs"], "description": "Active (unrevoked, unexpired) sessions, most recently used first." }, "AuthNextRevokeAllResponse": { "type": "object", "properties": { "revoked": { "type": "integer" } }, "required": ["revoked"] }, "AuthNextBooleanSuccess": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": ["success"] }, "PrivacyErasureBody": { "type": "object", "properties": { "password": { "type": "string", "minLength": 1, "maxLength": 1024 }, "confirmation": { "type": "string", "enum": ["DELETE MY ACCOUNT"] } }, "required": ["password", "confirmation"] }, "PrivacyErasureResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": ["completed"] }, "workspacesAffected": { "type": "integer" }, "sessionsRevoked": { "type": "integer" } }, "required": ["status", "workspacesAffected", "sessionsRevoked"] }, "PrivacyExportResponse": { "type": "object", "properties": { "format": { "type": "string", "enum": ["amdital.gdpr-export.v1"] }, "exportedAt": { "type": "string", "format": "date-time" }, "subject": { "type": "object", "nullable": true, "additionalProperties": { "nullable": true } }, "memberships": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } } }, "sessions": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } } }, "globalAuditLogs": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } } }, "workspaces": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } } }, "truncated": { "type": "array", "items": { "type": "string" } } }, "required": [ "format", "exportedAt", "subject", "memberships", "sessions", "globalAuditLogs", "workspaces", "truncated" ], "description": "The caller's personal data across every workspace they belong to. `truncated` lists any collection that hit the per-collection row cap." }, "AuthNextMfaEnrollResponse": { "type": "object", "properties": { "otpauthUrl": { "type": "string" } }, "required": ["otpauthUrl"] }, "AuthNextMfaVerifyResponse": { "type": "object", "properties": { "verified": { "type": "boolean" } }, "required": ["verified"] }, "AuthNextCompleteMfaLoginResponse": { "type": "object", "properties": { "verified": { "type": "boolean" }, "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "refreshExpiresIn": { "type": "integer" } }, "required": ["verified"] }, "McpDescriptorResponse": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "protocol": { "type": "string" }, "transport": { "type": "string" }, "docs": { "type": "string" } }, "required": ["name", "version", "protocol", "transport", "docs"] }, "McpMethodNotAllowedResponse": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } }, "required": ["error", "message"] }, "McpJsonRpcRequest": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": ["2.0"] }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "nullable": true }, { "nullable": true } ] }, "method": { "type": "string" }, "params": { "nullable": true } }, "required": ["jsonrpc", "method"] }, "McpJsonRpcResponse": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": ["2.0"] }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "nullable": true }, { "nullable": true } ] }, "result": { "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": ["code", "message"] } }, "required": ["jsonrpc", "id"] }, "McpOAuthPendingConsent": { "type": "object", "properties": { "pendingId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string" }, "clientName": { "type": "string" }, "workspaceId": { "type": "string", "format": "uuid" }, "workspaceName": { "type": "string" }, "permissionLines": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": ["pending", "approved", "denied", "consumed", "expired"] }, "expiresAt": { "type": "string" } }, "required": [ "pendingId", "clientId", "clientName", "workspaceId", "workspaceName", "permissionLines", "status", "expiresAt" ] }, "McpOAuthConsentDecisionBody": { "type": "object", "properties": { "decision": { "type": "string", "enum": ["approve", "deny"] } }, "required": ["decision"] }, "McpOAuthConsentResult": { "type": "object", "properties": { "redirectTo": { "type": "string", "format": "uri" } }, "required": ["redirectTo"] }, "McpOAuthGrantSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "clientId": { "type": "string" }, "clientName": { "type": "string" }, "workspaceId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "userLabel": { "type": "string" }, "status": { "type": "string", "enum": ["active", "revoked"] }, "createdAt": { "type": "string" }, "lastUsedAt": { "type": "string", "nullable": true } }, "required": [ "id", "clientId", "clientName", "workspaceId", "userId", "userLabel", "status", "createdAt", "lastUsedAt" ] }, "McpOAuthRevokeResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": ["revoked"] } }, "required": ["id", "status"] } }, "required": ["data"] }, "ShiftChangeApprovalBody": { "type": "object", "properties": { "workspaceId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "minLength": 1, "maxLength": 200 }, "requesterId": { "type": "string", "minLength": 1, "maxLength": 200 }, "approverIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "minItems": 1, "maxItems": 50 } }, "required": ["workspaceId", "entityId", "requesterId", "approverIds"] }, "PlatformTicketMessage": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "author": { "type": "string", "nullable": true }, "isInternal": { "type": "boolean" } }, "required": ["id", "content", "author", "isInternal"] }, "ContentAdminWriteBody": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Column values for the target collection's row. Keys that are not writable columns of that collection are dropped; on create, a body with no writable fields returns 400 'no writable fields provided'." }, "AddPlatformTicketMessageBody": { "type": "object", "properties": { "content": { "type": "string", "minLength": 1, "maxLength": 20000 }, "authorId": { "type": "string", "nullable": true, "maxLength": 200 }, "isInternal": { "type": "boolean" } }, "required": ["content"] }, "WikiPageAccessGrant": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "role": { "type": "string", "enum": ["viewer", "editor"] }, "grantedById": { "type": "string", "nullable": true, "format": "uuid" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "userName": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true } }, "required": [ "id", "userId", "role", "grantedById", "createdAt", "updatedAt", "userName", "userEmail" ] }, "WikiTreeNode": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "slug": { "type": "string" }, "parentId": { "type": "string", "nullable": true, "format": "uuid" }, "isPinned": { "type": "boolean", "nullable": true }, "status": { "type": "string", "enum": ["draft", "published", "archived"] }, "authorId": { "type": "string", "format": "uuid" }, "visibility": { "type": "string", "enum": ["workspace", "department", "private", "restricted"] }, "departmentId": { "type": "string", "nullable": true, "format": "uuid" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/WikiTreeNode" } } }, "required": [ "id", "title", "slug", "parentId", "isPinned", "status", "authorId", "visibility", "departmentId", "children" ] } } }, "security": [ { "bearerAuth": [] } ] }