{ "openapi": "3.0.0", "info": { "title": "ovasabi API", "version": "1.1.0", "description": "API documentation for ovasabi" }, "paths": { "/v1/auth/guest": { "post": { "operationId": "postAuthGuest", "tags": [ "auth" ], "summary": "Create a guest account and open a session for it.", "description": "Create a guest account and open a session for it.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [] } }, "/v1/auth/login": { "post": { "operationId": "postAuthLogin", "tags": [ "auth" ], "summary": "Exchange an email and password for a session.", "description": "Exchange an email and password for a session.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceLogin" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceTokens" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } }, "security": [] } }, "/v1/auth/me": { "get": { "operationId": "getAuthMe", "tags": [ "auth" ], "summary": "Describe the session behind the presented token.", "description": "Describe the session behind the presented token.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceSession" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/auth/refresh": { "post": { "operationId": "postAuthRefresh", "tags": [ "auth" ], "summary": "Exchange a refresh token for a new access token.", "description": "Exchange a refresh token for a new access token.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceRefresh" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceTokens" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } }, "security": [] } }, "/v1/auth/register": { "post": { "operationId": "postAuthRegister", "tags": [ "auth" ], "summary": "Create a studio account and open a session.", "description": "Create a studio account and open a session.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceRegister" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceTokens" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } }, "security": [] } }, "/v1/business/add": { "post": { "operationId": "postBusinessAdd", "tags": [ "business" ], "summary": "Business add.", "description": "Business add.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/convert": { "post": { "operationId": "postBusinessConvert", "tags": [ "business" ], "summary": "Business convert.", "description": "Business convert.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/create": { "post": { "operationId": "postBusinessCreate", "tags": [ "business" ], "summary": "Business create.", "description": "Business create.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/intake": { "post": { "operationId": "postBusinessIntake", "tags": [ "business" ], "summary": "Submit a visitor class dialogue as an enquiry.", "description": "Submit a visitor class dialogue as an enquiry.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/IntakeSubmission" } } } }, "responses": { "200": { "description": "Existing record returned for an idempotent request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/IntakeReceipt" } } } }, "201": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/IntakeReceipt" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } }, "security": [] } }, "/v1/business/list": { "get": { "operationId": "getBusinessList", "tags": [ "business" ], "summary": "Business list.", "description": "Business list.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/pipeline": { "get": { "operationId": "getBusinessPipeline", "tags": [ "business" ], "summary": "Read the lead pipeline board on the live projection read mode.", "description": "Read the lead pipeline board on the live projection read mode.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/publish": { "post": { "operationId": "postBusinessPublish", "tags": [ "business" ], "summary": "Business publish.", "description": "Business publish.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/qualify": { "post": { "operationId": "postBusinessQualify", "tags": [ "business" ], "summary": "Business qualify.", "description": "Business qualify.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/query": { "post": { "operationId": "postBusinessQuery", "tags": [ "business" ], "summary": "Business query.", "description": "Business query.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/read": { "post": { "operationId": "postBusinessRead", "tags": [ "business" ], "summary": "Business read.", "description": "Business read.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/record": { "post": { "operationId": "postBusinessRecord", "tags": [ "business" ], "summary": "Business record.", "description": "Business record.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/search": { "post": { "operationId": "postBusinessSearch", "tags": [ "business" ], "summary": "Business search.", "description": "Business search.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/submit": { "post": { "operationId": "postBusinessSubmit", "tags": [ "business" ], "summary": "Business submit.", "description": "Business submit.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/update": { "patch": { "operationId": "patchBusinessUpdate", "tags": [ "business" ], "summary": "Business update.", "description": "Business update.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business/upsert": { "patch": { "operationId": "patchBusinessUpsert", "tags": [ "business" ], "summary": "Business upsert.", "description": "Business upsert.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/add": { "post": { "operationId": "postCommunicationAdd", "tags": [ "communication" ], "summary": "Communication add.", "description": "Communication add.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/create": { "post": { "operationId": "postCommunicationCreate", "tags": [ "communication" ], "summary": "Communication create.", "description": "Communication create.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/dispatch": { "post": { "operationId": "postCommunicationDispatch", "tags": [ "communication" ], "summary": "Communication dispatch.", "description": "Communication dispatch.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/end-session": { "post": { "operationId": "postCommunicationEndSession", "tags": [ "communication" ], "summary": "Communication end-session.", "description": "Communication end-session.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/heartbeat": { "post": { "operationId": "postCommunicationHeartbeat", "tags": [ "communication" ], "summary": "Communication heartbeat.", "description": "Communication heartbeat.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/ingest": { "post": { "operationId": "postCommunicationIngest", "tags": [ "communication" ], "summary": "Communication ingest.", "description": "Communication ingest.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/join": { "post": { "operationId": "postCommunicationJoin", "tags": [ "communication" ], "summary": "Communication join.", "description": "Communication join.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/leave": { "post": { "operationId": "postCommunicationLeave", "tags": [ "communication" ], "summary": "Communication leave.", "description": "Communication leave.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/list": { "get": { "operationId": "getCommunicationList", "tags": [ "communication" ], "summary": "Communication list.", "description": "Communication list.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/list-presence": { "get": { "operationId": "getCommunicationListPresence", "tags": [ "communication" ], "summary": "Communication list-presence.", "description": "Communication list-presence.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/open": { "post": { "operationId": "postCommunicationOpen", "tags": [ "communication" ], "summary": "Communication open.", "description": "Communication open.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/read": { "post": { "operationId": "postCommunicationRead", "tags": [ "communication" ], "summary": "Communication read.", "description": "Communication read.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/communication/start-session": { "post": { "operationId": "postCommunicationStartSession", "tags": [ "communication" ], "summary": "Communication start-session.", "description": "Communication start-session.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/community/attach": { "post": { "operationId": "postCommunityAttach", "tags": [ "community" ], "summary": "Community attach.", "description": "Community attach.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/community/enroll": { "post": { "operationId": "postCommunityEnroll", "tags": [ "community" ], "summary": "Community enroll.", "description": "Community enroll.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/community/list": { "get": { "operationId": "getCommunityList", "tags": [ "community" ], "summary": "Community list.", "description": "Community list.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/community/pledge": { "post": { "operationId": "postCommunityPledge", "tags": [ "community" ], "summary": "Community pledge.", "description": "Community pledge.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/community/refer": { "post": { "operationId": "postCommunityRefer", "tags": [ "community" ], "summary": "Community refer.", "description": "Community refer.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/community/serve": { "post": { "operationId": "postCommunityServe", "tags": [ "community" ], "summary": "Community serve.", "description": "Community serve.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/contact/message": { "post": { "operationId": "postContactMessage", "tags": [ "contact" ], "summary": "Send a message to Ovasabi Studios.", "description": "Send a message to Ovasabi Studios.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/ContactSubmission" } } } }, "responses": { "200": { "description": "Existing record returned for an idempotent request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/ContactReceipt" } } } }, "201": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/ContactReceipt" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } }, "security": [] } }, "/v1/contact/send-message": { "post": { "operationId": "postContactSendMessage", "tags": [ "contact" ], "summary": "Contact send-message.", "description": "Contact send-message.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/content/create": { "post": { "operationId": "postContentCreate", "tags": [ "content" ], "summary": "Content create.", "description": "Content create.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/content/entry": { "get": { "operationId": "getContentEntry", "tags": [ "content" ], "summary": "Read one published entry by space and slug.", "description": "Read one published entry by space and slug.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceEntryResult" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } }, "security": [] } }, "/v1/content/get": { "get": { "operationId": "getContentGet", "tags": [ "content" ], "summary": "Content get.", "description": "Content get.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/content/list": { "get": { "operationId": "getContentList", "tags": [ "content" ], "summary": "Content list.", "description": "Content list.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/content/publish": { "post": { "operationId": "postContentPublish", "tags": [ "content" ], "summary": "Content publish.", "description": "Content publish.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/content/published": { "get": { "operationId": "getContentPublished", "tags": [ "content" ], "summary": "List published entries in the public content spaces.", "description": "List published entries in the public content spaces.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceEntryList" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } }, "security": [] } }, "/v1/content/studio/entries": { "get": { "operationId": "getContentStudioEntries", "tags": [ "content" ], "summary": "List entries in a space, drafts included.", "description": "List entries in a space, drafts included.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceEntryList" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/content/studio/entry": { "get": { "operationId": "getContentStudioEntry", "tags": [ "content" ], "summary": "Read one entry for editing, whatever its status.", "description": "Read one entry for editing, whatever its status.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceEntryResult" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } }, "patch": { "operationId": "patchContentStudioEntry", "tags": [ "content" ], "summary": "Edit an entry and record the revision.", "description": "Edit an entry and record the revision.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceEntryBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceWriteResult" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } }, "post": { "operationId": "postContentStudioEntry", "tags": [ "content" ], "summary": "Create a draft entry.", "description": "Create a draft entry.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceEntryBody" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceWriteResult" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/content/studio/publish": { "post": { "operationId": "postContentStudioPublish", "tags": [ "content" ], "summary": "Publish a draft entry to the public surface.", "description": "Publish a draft entry to the public surface.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfacePublishBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceWriteResult" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/content/studio/spaces": { "get": { "operationId": "getContentStudioSpaces", "tags": [ "content" ], "summary": "List the publishing spaces this organization owns.", "description": "List the publishing spaces this organization owns.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceSpaces" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/content/studio/unpublish": { "post": { "operationId": "postContentStudioUnpublish", "tags": [ "content" ], "summary": "Return a published entry to draft.", "description": "Return a published entry to draft.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfacePublishBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/SurfaceWriteResult" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/content/update": { "patch": { "operationId": "patchContentUpdate", "tags": [ "content" ], "summary": "Content update.", "description": "Content update.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/aliases": { "post": { "operationId": "postEmailAliases", "tags": [ "email" ], "summary": "Register an alias with internal, masked, or relay forwarding intent.", "description": "Register an alias with internal, masked, or relay forwarding intent.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/approve": { "post": { "operationId": "postEmailApprove", "tags": [ "email" ], "summary": "Email approve.", "description": "Email approve.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/capabilities": { "get": { "operationId": "getEmailCapabilities", "tags": [ "email" ], "summary": "Return the current Ovasabi email service capabilities and infrastructure requirements.", "description": "Return the current Ovasabi email service capabilities and infrastructure requirements.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [] } }, "/v1/email/create": { "post": { "operationId": "postEmailCreate", "tags": [ "email" ], "summary": "Email create.", "description": "Email create.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/dkim": { "post": { "operationId": "postEmailDkim", "tags": [ "email" ], "summary": "Generate a DKIM signing pair and register it; returns the DNS TXT record.", "description": "Generate a DKIM signing pair and register it; returns the DNS TXT record.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/dkim/domains": { "get": { "operationId": "getEmailDkimDomains", "tags": [ "email" ], "summary": "Report every sending domain's signing slot, rotation date, and DNS.", "description": "Report every sending domain's signing slot, rotation date, and DNS.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "post": { "operationId": "postEmailDkimDomains", "tags": [ "email" ], "summary": "Provision a sending domain with two stable selectors and return the DNS to publish.", "description": "Provision a sending domain with two stable selectors and return the DNS to publish.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/dkim/rotate": { "post": { "operationId": "postEmailDkimRotate", "tags": [ "email" ], "summary": "Move signing to the standby key and issue a fresh one behind the vacated selector.", "description": "Move signing to the standby key and issue a fresh one behind the vacated selector.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/inbox/accounts": { "get": { "operationId": "getEmailInboxAccounts", "tags": [ "email" ], "summary": "List accessible company mailboxes.", "description": "List accessible company mailboxes.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/inbox/command": { "post": { "operationId": "postEmailInboxCommand", "tags": [ "email" ], "summary": "Save drafts, submit mail, and manage messages.", "description": "Save drafts, submit mail, and manage messages.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/inbox/read": { "post": { "operationId": "postEmailInboxRead", "tags": [ "email" ], "summary": "Read mailbox folders and bounded messages.", "description": "Read mailbox folders and bounded messages.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/invites": { "post": { "operationId": "postEmailInvites", "tags": [ "email" ], "summary": "Send an iMIP calendar invitation through Stalwart.", "description": "Send an iMIP calendar invitation through Stalwart.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/list": { "get": { "operationId": "getEmailList", "tags": [ "email" ], "summary": "Email list.", "description": "Email list.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/lists": { "post": { "operationId": "postEmailLists", "tags": [ "email" ], "summary": "Provision a community mailing list on the mail backend.", "description": "Provision a community mailing list on the mail backend.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/mailboxes": { "post": { "operationId": "postEmailMailboxes", "tags": [ "email" ], "summary": "Provision a user, service, or shared mailbox on the mail backend.", "description": "Provision a user, service, or shared mailbox on the mail backend.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/send": { "post": { "operationId": "postEmailSend", "tags": [ "email" ], "summary": "Email send.", "description": "Email send.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/submit": { "post": { "operationId": "postEmailSubmit", "tags": [ "email" ], "summary": "Email submit.", "description": "Email submit.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/upsert": { "patch": { "operationId": "patchEmailUpsert", "tags": [ "email" ], "summary": "Email upsert.", "description": "Email upsert.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/email/webhooks/stalwart": { "post": { "operationId": "postEmailWebhooksStalwart", "tags": [ "email" ], "summary": "Receive Stalwart delivery lifecycle events signed with the shared HMAC secret.", "description": "Receive Stalwart delivery lifecycle events signed with the shared HMAC secret.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [] } }, "/v1/game/actions": { "post": { "operationId": "postGameActions", "tags": [ "game" ], "summary": "Resolve one player action inside a fenced session.", "description": "Resolve one player action inside a fenced session.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/game.v1.ApplyActionRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/game.v1.ApplyActionResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/game/actors/claim": { "post": { "operationId": "postGameActorsClaim", "tags": [ "game" ], "summary": "Record that the caller's account now has an address.", "description": "Record that the caller's account now has an address.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/game.v1.ClaimActorRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/game.v1.ClaimActorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/game/cells/accepted": { "get": { "operationId": "getGameCellsAccepted", "tags": [ "game" ], "summary": "Read one committed accepted cell record.", "description": "Read one committed accepted cell record.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/game.v1.GetAcceptedCellResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/game/cells/occupancy": { "get": { "operationId": "getGameCellsOccupancy", "tags": [ "game" ], "summary": "Read the bounded roster of one cell.", "description": "Read the bounded roster of one cell.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/game.v1.GetCellOccupancyResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/game/enter": { "post": { "operationId": "postGameEnter", "tags": [ "game" ], "summary": "Open the caller's session and mint its actor.", "description": "Open the caller's session and mint its actor.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/game.v1.EnterWorldRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/game.v1.EnterWorldResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/game/runtime": { "get": { "operationId": "getGameRuntime", "tags": [ "game" ], "summary": "Report the action lane capability and its bounds.", "description": "Report the action lane capability and its bounds.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/game.v1.DescribeRuntimeResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/game/state": { "post": { "operationId": "postGameState", "tags": [ "game" ], "summary": "Read one bounded cell frame and acknowledge its baseline.", "description": "Read one bounded cell frame and acknowledge its baseline.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/game.v1.ReadStateRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/game.v1.ReadStateResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/game/world": { "get": { "operationId": "getGameWorld", "tags": [ "game" ], "summary": "Read the committed world summary for a fenced session.", "description": "Read the committed world summary for a fenced session.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/game.v1.GetWorldResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hub/command": { "post": { "operationId": "postHubCommand", "tags": [ "hub" ], "summary": "", "description": "", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/WorkflowCommand" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/WorkflowRecord" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/hub/passkeys/begin": { "post": { "operationId": "postHubPasskeysBegin", "tags": [ "hub" ], "summary": "", "description": "", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/PasskeyBegin" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/PasskeyChallenge" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/hub/passkeys/finish": { "post": { "operationId": "postHubPasskeysFinish", "tags": [ "hub" ], "summary": "", "description": "", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/PasskeyFinish" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/PasskeyVerified" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/hub/people": { "get": { "operationId": "getHubPeople", "tags": [ "hub" ], "summary": "", "description": "", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/WorkflowPeople" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/hub/records": { "get": { "operationId": "getHubRecords", "tags": [ "hub" ], "summary": "", "description": "", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/WorkflowList" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/identity/add": { "post": { "operationId": "postIdentityAdd", "tags": [ "identity" ], "summary": "Identity add.", "description": "Identity add.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/identity/assign": { "post": { "operationId": "postIdentityAssign", "tags": [ "identity" ], "summary": "Identity assign.", "description": "Identity assign.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/identity/create": { "post": { "operationId": "postIdentityCreate", "tags": [ "identity" ], "summary": "Identity create.", "description": "Identity create.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/identity/get": { "get": { "operationId": "getIdentityGet", "tags": [ "identity" ], "summary": "Identity get.", "description": "Identity get.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/identity/list": { "get": { "operationId": "getIdentityList", "tags": [ "identity" ], "summary": "Identity list.", "description": "Identity list.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/identity/update": { "patch": { "operationId": "patchIdentityUpdate", "tags": [ "identity" ], "summary": "Identity update.", "description": "Identity update.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/admit": { "post": { "operationId": "postLegalfinanceAdmit", "tags": [ "legalfinance" ], "summary": "Legalfinance admit.", "description": "Legalfinance admit.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/allocate": { "post": { "operationId": "postLegalfinanceAllocate", "tags": [ "legalfinance" ], "summary": "Legalfinance allocate.", "description": "Legalfinance allocate.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/apply": { "post": { "operationId": "postLegalfinanceApply", "tags": [ "legalfinance" ], "summary": "Legalfinance apply.", "description": "Legalfinance apply.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/approve": { "post": { "operationId": "postLegalfinanceApprove", "tags": [ "legalfinance" ], "summary": "Legalfinance approve.", "description": "Legalfinance approve.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/create": { "post": { "operationId": "postLegalfinanceCreate", "tags": [ "legalfinance" ], "summary": "Legalfinance create.", "description": "Legalfinance create.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/issue": { "post": { "operationId": "postLegalfinanceIssue", "tags": [ "legalfinance" ], "summary": "Legalfinance issue.", "description": "Legalfinance issue.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/license": { "post": { "operationId": "postLegalfinanceLicense", "tags": [ "legalfinance" ], "summary": "Legalfinance license.", "description": "Legalfinance license.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/list": { "get": { "operationId": "getLegalfinanceList", "tags": [ "legalfinance" ], "summary": "Legalfinance list.", "description": "Legalfinance list.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/list-partners": { "get": { "operationId": "getLegalfinanceListPartners", "tags": [ "legalfinance" ], "summary": "Legalfinance list-partners.", "description": "Legalfinance list-partners.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/open-account": { "post": { "operationId": "postLegalfinanceOpenAccount", "tags": [ "legalfinance" ], "summary": "Legalfinance open-account.", "description": "Legalfinance open-account.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/register": { "post": { "operationId": "postLegalfinanceRegister", "tags": [ "legalfinance" ], "summary": "Legalfinance register.", "description": "Legalfinance register.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/run": { "post": { "operationId": "postLegalfinanceRun", "tags": [ "legalfinance" ], "summary": "Legalfinance run.", "description": "Legalfinance run.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/set": { "post": { "operationId": "postLegalfinanceSet", "tags": [ "legalfinance" ], "summary": "Legalfinance set.", "description": "Legalfinance set.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/legalfinance/submit": { "post": { "operationId": "postLegalfinanceSubmit", "tags": [ "legalfinance" ], "summary": "Legalfinance submit.", "description": "Legalfinance submit.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/network/calls/stream": { "get": { "operationId": "getNetworkCallsStream", "tags": [ "network" ], "summary": "", "description": "", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [] } }, "/v1/network/calls/ticket": { "post": { "operationId": "postNetworkCallsTicket", "tags": [ "network" ], "summary": "", "description": "", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/CallTicketBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/CallTicketResult" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/network/members": { "get": { "operationId": "getNetworkMembers", "tags": [ "network" ], "summary": "List the community roster.", "description": "List the community roster.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/MembershipRoster" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/network/membership": { "get": { "operationId": "getNetworkMembership", "tags": [ "network" ], "summary": "Report the signed-in account's standing in the community.", "description": "Report the signed-in account's standing in the community.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/MembershipStanding" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } }, "post": { "operationId": "postNetworkMembership", "tags": [ "network" ], "summary": "Join the community as the signed-in account. Idempotent.", "description": "Join the community as the signed-in account. Idempotent.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/MembershipEnrollment" } } } }, "responses": { "200": { "description": "Existing record returned for an idempotent request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/MembershipStanding" } } } }, "201": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/MembershipStanding" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/network/rooms": { "get": { "operationId": "getNetworkRooms", "tags": [ "network" ], "summary": "List the rooms this account can enter, with live occupancy.", "description": "List the rooms this account can enter, with live occupancy.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkRooms" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } }, "post": { "operationId": "postNetworkRooms", "tags": [ "network" ], "summary": "Open a room on a channel.", "description": "Open a room on a channel.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkRoomInput" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkRoom" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/network/rooms/heartbeat": { "post": { "operationId": "postNetworkRoomsHeartbeat", "tags": [ "network" ], "summary": "Hold a seat. A seat with no heartbeat is released.", "description": "Hold a seat. A seat with no heartbeat is released.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkSeatInput" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkJoin" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/network/rooms/join": { "post": { "operationId": "postNetworkRoomsJoin", "tags": [ "network" ], "summary": "Take a seat in a room as the signed-in account.", "description": "Take a seat in a room as the signed-in account.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkSeatInput" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkJoin" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/network/rooms/leave": { "post": { "operationId": "postNetworkRoomsLeave", "tags": [ "network" ], "summary": "Release the seat this account holds.", "description": "Release the seat this account holds.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkSeatInput" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkLeft" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/network/rooms/roster": { "get": { "operationId": "getNetworkRoomsRoster", "tags": [ "network" ], "summary": "Who is in a room right now.", "description": "Who is in a room right now.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkRoster" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/network/spaces": { "get": { "operationId": "getNetworkSpaces", "tags": [ "network" ], "summary": "List the spaces in this network, with their open room counts.", "description": "List the spaces in this network, with their open room counts.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkSpaces" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } }, "post": { "operationId": "postNetworkSpaces", "tags": [ "network" ], "summary": "Open a space. Rooms live inside one.", "description": "Open a space. Rooms live inside one.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkSpaceInput" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/NetworkSpace" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/network/thread": { "get": { "operationId": "getNetworkThread", "tags": [ "network" ], "summary": "Read one conversation and everything attached to it, in order.", "description": "Read one conversation and everything attached to it, in order.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/ThreadView" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/network/thread/attach": { "post": { "operationId": "postNetworkThreadAttach", "tags": [ "network" ], "summary": "Attach a room, recording, post, message or mail to a conversation.", "description": "Attach a room, recording, post, message or mail to a conversation.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/ThreadAttachBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/ThreadItemView" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/network/threads": { "get": { "operationId": "getNetworkThreads", "tags": [ "network" ], "summary": "List the conversations in this network.", "description": "List the conversations in this network.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/ThreadList" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } }, "post": { "operationId": "postNetworkThreads", "tags": [ "network" ], "summary": "Open a conversation that rooms, recordings and posts attach to.", "description": "Open a conversation that rooms, recordings and posts attach to.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/ThreadOpenBody" } } } }, "responses": { "200": { "description": "Existing record returned for an idempotent request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/ThreadView" } } } }, "201": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/ThreadView" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } }, "/v1/project/add": { "post": { "operationId": "postProjectAdd", "tags": [ "project" ], "summary": "Project add.", "description": "Project add.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/project/create": { "post": { "operationId": "postProjectCreate", "tags": [ "project" ], "summary": "Project create.", "description": "Project create.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/project/get": { "get": { "operationId": "getProjectGet", "tags": [ "project" ], "summary": "Project get.", "description": "Project get.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/project/list": { "get": { "operationId": "getProjectList", "tags": [ "project" ], "summary": "Project list.", "description": "Project list.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/project/patch": { "post": { "operationId": "postProjectPatch", "tags": [ "project" ], "summary": "Project patch.", "description": "Project patch.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/project/submit": { "post": { "operationId": "postProjectSubmit", "tags": [ "project" ], "summary": "Project submit.", "description": "Project submit.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/project/update": { "patch": { "operationId": "patchProjectUpdate", "tags": [ "project" ], "summary": "Project update.", "description": "Project update.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/schedule/create": { "post": { "operationId": "postScheduleCreate", "tags": [ "schedule" ], "summary": "Schedule create.", "description": "Schedule create.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/schedule/list": { "get": { "operationId": "getScheduleList", "tags": [ "schedule" ], "summary": "Schedule list.", "description": "Schedule list.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/schedule/set": { "post": { "operationId": "postScheduleSet", "tags": [ "schedule" ], "summary": "Schedule set.", "description": "Schedule set.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/schedule/update": { "patch": { "operationId": "patchScheduleUpdate", "tags": [ "schedule" ], "summary": "Schedule update.", "description": "Schedule update.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/talent/progress": { "get": { "operationId": "getTalentProgress", "tags": [ "talent" ], "summary": "Get cumulative XP and level for a user.", "description": "Get cumulative XP and level for a user.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "post": { "operationId": "postTalentProgress", "tags": [ "talent" ], "summary": "Award XP for a verified action.", "description": "Award XP for a verified action.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/voice/audio": { "get": { "operationId": "getVoiceAudio", "tags": [ "voice" ], "summary": "Stream the audio of one take.", "description": "Stream the audio of one take.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [] } }, "/v1/voice/delete-take": { "delete": { "operationId": "deleteVoiceDeleteTake", "tags": [ "voice" ], "summary": "Voice delete-take.", "description": "Voice delete-take.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/voice/list-takes": { "get": { "operationId": "getVoiceListTakes", "tags": [ "voice" ], "summary": "Voice list-takes.", "description": "Voice list-takes.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/voice/publish-take": { "post": { "operationId": "postVoicePublishTake", "tags": [ "voice" ], "summary": "Voice publish-take.", "description": "Voice publish-take.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardSuccessResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/voice/take": { "post": { "operationId": "postVoiceTake", "tags": [ "voice" ], "summary": "Leave a recorded take in the studio booth.", "description": "Leave a recorded take in the studio booth.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/BoothPublish" } } } }, "responses": { "200": { "description": "Existing record returned for an idempotent request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/BoothPublished" } } } }, "201": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/BoothPublished" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } }, "security": [] } }, "/v1/voice/take/delete": { "post": { "operationId": "postVoiceTakeDelete", "tags": [ "voice" ], "summary": "Remove a take, given the control token issued when it was left.", "description": "Remove a take, given the control token issued when it was left.", "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/BoothDelete" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/BoothDeleted" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } }, "security": [] } }, "/v1/voice/takes": { "get": { "operationId": "getVoiceTakes", "tags": [ "voice" ], "summary": "List the takes in the booth, newest first, without audio.", "description": "List the takes in the booth, newest first, without audio.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/BoothList" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } }, "security": [] } }, "/v1/workspace/capabilities": { "get": { "operationId": "getWorkspaceCapabilities", "tags": [ "workspace" ], "summary": "Return the current Ovasabi workspace schema and service capabilities.", "description": "Return the current Ovasabi workspace schema and service capabilities.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [] } }, "/v1/workspace/records": { "get": { "operationId": "getWorkspaceRecords", "tags": [ "workspace" ], "summary": "Read authorized workspace summaries.", "description": "Read authorized workspace summaries.", "responses": { "200": { "description": "Successful response", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/DeskRecords" } } } }, "400": { "description": "Bad request", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "401": { "description": "Unauthorized", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } }, "500": { "description": "Internal server error", "content": { "application/x-protobuf": { "schema": { "$ref": "#/components/schemas/StandardError" } } } } } } } }, "components": { "schemas": { "AgreementDocument": { "type": "object", "properties": { "canonicalPayload": { "type": "string" }, "markdown": { "type": "string" }, "schema": { "type": "string" }, "sha256": { "type": "string" }, "signatures": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AgreementSignature" } }, "signers": { "type": "array", "items": { "type": "string" } } } }, "AgreementDraft": { "type": "object", "properties": { "markdown": { "type": "string" }, "signers": { "type": "array", "items": { "type": "string" } } } }, "AgreementSignature": { "type": "object", "properties": { "assertion": { "type": "string", "format": "byte" }, "challenge": { "type": "string" }, "correlationId": { "type": "string" }, "credentialId": { "type": "string", "format": "byte" }, "documentHash": { "type": "string" }, "publicKey": { "type": "string", "format": "byte" }, "signedAt": { "type": "string", "format": "date-time" } } }, "BoothDelete": { "type": "object", "properties": { "controlToken": { "type": "string" }, "takeRef": { "type": "string" } } }, "BoothDeleted": { "type": "object", "properties": { "correlationId": { "type": "string" }, "deleted": { "type": "boolean" }, "takeRef": { "type": "string" } } }, "BoothList": { "type": "object", "properties": { "correlationId": { "type": "string" }, "hasMore": { "type": "boolean" }, "takes": { "type": "array", "items": { "$ref": "#/components/schemas/BoothTake" } }, "total": { "type": "integer", "format": "int32" } } }, "BoothPublish": { "type": "object", "properties": { "audio": { "type": "string", "format": "byte" }, "durationMs": { "type": "integer", "format": "int32" }, "mimeType": { "type": "string" }, "peaks": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "sourceRef": { "type": "string" }, "speaker": { "type": "string" }, "title": { "type": "string" } } }, "BoothPublished": { "type": "object", "properties": { "audioUrl": { "type": "string", "format": "uri" }, "byteSize": { "type": "integer", "format": "int32" }, "controlToken": { "type": "string" }, "correlationId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "duplicate": { "type": "boolean" }, "durationMs": { "type": "integer", "format": "int32" }, "mimeType": { "type": "string" }, "peaks": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "speaker": { "type": "string" }, "status": { "type": "string" }, "takeRef": { "type": "string" }, "title": { "type": "string" } } }, "BoothTake": { "type": "object", "properties": { "audioUrl": { "type": "string", "format": "uri" }, "byteSize": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "durationMs": { "type": "integer", "format": "int32" }, "mimeType": { "type": "string" }, "peaks": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "speaker": { "type": "string" }, "status": { "type": "string" }, "takeRef": { "type": "string" }, "title": { "type": "string" } } }, "CalendarEvent": { "type": "object", "properties": { "endsAt": { "type": "string", "format": "date-time" }, "invitees": { "type": "array", "items": { "type": "string" } }, "markdown": { "type": "string" }, "responses": { "type": "object", "additionalProperties": { "type": "string" } }, "startsAt": { "type": "string", "format": "date-time" }, "timezone": { "type": "string" } } }, "CalendarReply": { "type": "object", "properties": { "response": { "type": "string" } } }, "CallCapabilities": { "type": "object", "properties": { "opus": { "type": "boolean" }, "vp8": { "type": "boolean" }, "webp": { "type": "boolean" } } }, "CallTicketBody": { "type": "object", "properties": { "capabilities": { "$ref": "#/components/schemas/CallCapabilities" }, "roomId": { "type": "string" } } }, "CallTicketResult": { "type": "object", "properties": { "renewAfterSeconds": { "type": "integer", "format": "int32" }, "ticket": { "type": "string" } } }, "Campaign": { "type": "object", "properties": { "approvedBy": { "type": "string" }, "markdown": { "type": "string" }, "publishedAt": { "type": "string", "format": "date-time" }, "receipts": { "type": "object", "additionalProperties": { "type": "string", "format": "date-time" } }, "segment": { "type": "string" } } }, "CommunicationPreferences": { "type": "object", "properties": { "consent": { "type": "boolean" }, "segments": { "type": "array", "items": { "type": "string" } } } }, "ContactReceipt": { "type": "object", "properties": { "correlationId": { "type": "string" }, "duplicate": { "type": "boolean" }, "messageRef": { "type": "string" }, "status": { "type": "string" } } }, "ContactSubmission": { "type": "object", "properties": { "body": { "type": "string" }, "email": { "type": "string", "format": "email" }, "fullName": { "type": "string" }, "sourceRef": { "type": "string" }, "subject": { "type": "string" } } }, "DeskRecord": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "string" } } }, "DeskRecords": { "type": "object", "properties": { "hasMore": { "type": "boolean" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/DeskRecord" } } } }, "Distribution": { "type": "object", "properties": { "approvedBy": { "type": "string" }, "bookRevision": { "type": "integer", "format": "int32" }, "input": { "$ref": "#/components/schemas/DistributionInput" }, "result": { "$ref": "#/components/schemas/DistributionResult" } } }, "DistributionAllocation": { "type": "object", "properties": { "bucket": { "type": "string" }, "grossMinor": { "type": "integer", "format": "int64" }, "id": { "type": "string" }, "netMinor": { "type": "integer", "format": "int64" }, "userId": { "type": "string" }, "withheldMinor": { "type": "integer", "format": "int64" } } }, "DistributionInput": { "type": "object", "properties": { "agreementId": { "type": "string" }, "chargebacksMinor": { "type": "integer", "format": "int64" }, "currency": { "type": "string" }, "feesMinor": { "type": "integer", "format": "int64" }, "grossMinor": { "type": "integer", "format": "int64" }, "period": { "type": "string" }, "policy": { "$ref": "#/components/schemas/DistributionPolicy" }, "projectId": { "type": "string" }, "recipients": { "type": "array", "items": { "$ref": "#/components/schemas/DistributionRecipient" } }, "refundsMinor": { "type": "integer", "format": "int64" }, "taxesMinor": { "type": "integer", "format": "int64" } } }, "DistributionPolicy": { "type": "object", "properties": { "buckets": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } }, "reserveBps": { "type": "integer", "format": "int64" }, "teamOverflowBps": { "type": "integer", "format": "int64" } } }, "DistributionRecipient": { "type": "object", "properties": { "bucket": { "type": "string" }, "capMinor": { "type": "integer", "format": "int64" }, "endsOn": { "type": "string" }, "id": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "startsOn": { "type": "string" }, "userId": { "type": "string" }, "weight": { "type": "integer", "format": "int64" }, "withholdingBps": { "type": "integer", "format": "int64" } } }, "DistributionResult": { "type": "object", "properties": { "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/DistributionAllocation" } }, "buckets": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } }, "distributableMinor": { "type": "integer", "format": "int64" }, "netRevenueMinor": { "type": "integer", "format": "int64" }, "reserveMinor": { "type": "integer", "format": "int64" } } }, "DistributionStatement": { "type": "object", "properties": { "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/DistributionAllocation" } }, "currency": { "type": "string" }, "period": { "type": "string" } } }, "ErrorResponse": { "type": "object", "properties": { "code": { "type": "string", "example": "BAD_REQUEST" }, "details": { "type": "object", "additionalProperties": {} }, "error": { "type": "string", "example": "validation failed" } }, "required": [ "error" ] }, "IntakeAnswer": { "type": "object", "properties": { "answer": { "type": "string" }, "question": { "type": "string" }, "questionId": { "type": "string" } } }, "IntakeContact": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "fullName": { "type": "string" }, "organization": { "type": "string" }, "timezone": { "type": "string" } } }, "IntakeReceipt": { "type": "object", "properties": { "accountType": { "type": "string" }, "correlationId": { "type": "string" }, "duplicate": { "type": "boolean" }, "enquiryRef": { "type": "string" }, "status": { "type": "string" } } }, "IntakeSubmission": { "type": "object", "properties": { "answers": { "type": "array", "items": { "$ref": "#/components/schemas/IntakeAnswer" } }, "class": { "type": "string" }, "contact": { "$ref": "#/components/schemas/IntakeContact" }, "sourceRef": { "type": "string" } } }, "MembershipEnrollment": { "type": "object", "properties": { "archetypes": { "type": "array", "items": { "type": "string" } }, "displayName": { "type": "string" }, "referredByParticipantId": { "type": "string" } } }, "MembershipMember": { "type": "object", "properties": { "archetypes": { "type": "array", "items": { "type": "string" } }, "displayName": { "type": "string" }, "participantId": { "type": "string" }, "status": { "type": "string" } } }, "MembershipRoster": { "type": "object", "properties": { "correlationId": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/MembershipMember" } }, "total": { "type": "integer", "format": "int32" } } }, "MembershipStanding": { "type": "object", "properties": { "archetypes": { "type": "array", "items": { "type": "string" } }, "correlationId": { "type": "string" }, "displayName": { "type": "string" }, "enrolled": { "type": "boolean" }, "memberCount": { "type": "integer", "format": "int32" }, "participantId": { "type": "string" }, "referredByParticipantId": { "type": "string" }, "status": { "type": "string" } } }, "NetworkJoin": { "type": "object", "properties": { "correlationId": { "type": "string" }, "heartbeatSeconds": { "type": "integer", "format": "int32" }, "roomId": { "type": "string" }, "subscribe": { "type": "array", "items": { "type": "string" } }, "you": { "$ref": "#/components/schemas/NetworkPresence" } } }, "NetworkLeft": { "type": "object", "properties": { "correlationId": { "type": "string" }, "roomId": { "type": "string" } } }, "NetworkPresence": { "type": "object", "properties": { "heartbeatAt": { "type": "string", "format": "date-time" }, "joinedAt": { "type": "string", "format": "date-time" }, "media": { "type": "string" }, "stale": { "type": "boolean" }, "state": { "type": "string" }, "userAccountId": { "type": "string" } } }, "NetworkRoom": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "occupied": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "youArePresent": { "type": "boolean" } } }, "NetworkRoomInput": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32" }, "channelId": { "type": "string" }, "code": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" } } }, "NetworkRooms": { "type": "object", "properties": { "correlationId": { "type": "string" }, "rooms": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkRoom" } } } }, "NetworkRoster": { "type": "object", "properties": { "correlationId": { "type": "string" }, "occupied": { "type": "integer", "format": "int32" }, "present": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkPresence" } }, "roomId": { "type": "string" } } }, "NetworkSeatInput": { "type": "object", "properties": { "media": { "type": "string" }, "roomId": { "type": "string" }, "state": { "type": "string" } } }, "NetworkSpace": { "type": "object", "properties": { "code": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "rooms": { "type": "integer", "format": "int32" }, "visibility": { "type": "string" } } }, "NetworkSpaceInput": { "type": "object", "properties": { "code": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "visibility": { "type": "string" } } }, "NetworkSpaces": { "type": "object", "properties": { "correlationId": { "type": "string" }, "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkSpace" } } } }, "PaginatedResult": { "type": "object", "properties": { "items": { "type": "array", "items": {} }, "pagination": { "$ref": "#/components/schemas/Pagination" } } }, "Pagination": { "type": "object", "properties": { "next_page_token": { "type": "string", "example": "cursor:def456" }, "page_size": { "type": "integer", "format": "int32", "example": 50 }, "page_token": { "type": "string", "example": "cursor:abc123" }, "total_count": { "type": "integer", "format": "int64", "example": 120 } } }, "PasskeyBegin": { "type": "object", "properties": { "action": { "type": "string" }, "documentId": { "type": "string" } } }, "PasskeyChallenge": { "type": "object", "properties": { "ceremonyId": { "type": "string" }, "documentHash": { "type": "string" }, "options": { "type": "object", "additionalProperties": {} } } }, "PasskeyFinish": { "type": "object", "properties": { "ceremonyId": { "type": "string" }, "consent": { "type": "boolean" }, "credential": { "type": "object", "additionalProperties": {} } } }, "PasskeyVerified": { "type": "object", "properties": { "verified": { "type": "boolean" } } }, "StandardError": { "type": "object", "properties": { "code": { "type": "string" }, "correlationId": { "type": "string" }, "message": { "type": "string" }, "retryHint": { "type": "string" } } }, "StandardSuccessResponse": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": {} }, "message": { "type": "string", "example": "Successful response" }, "status": { "type": "string", "example": "ok" } } }, "SurfaceEntry": { "type": "object", "properties": { "canonicalUrl": { "type": "string", "format": "uri" }, "excerpt": { "type": "string" }, "fields": { "type": "object", "additionalProperties": {} }, "format": { "type": "string" }, "id": { "type": "string" }, "lane": { "type": "string" }, "markdown": { "type": "string" }, "publishedAt": { "type": "string", "format": "date-time" }, "slug": { "type": "string" }, "space": { "type": "string" }, "status": { "type": "string" }, "subtitle": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "updatedAt": { "type": "string", "format": "date" } } }, "SurfaceEntryBody": { "type": "object", "properties": { "canonicalUrl": { "type": "string", "format": "uri" }, "changeSummary": { "type": "string" }, "excerpt": { "type": "string" }, "fields": { "type": "object", "additionalProperties": {} }, "format": { "type": "string" }, "markdown": { "type": "string" }, "slug": { "type": "string" }, "space": { "type": "string" }, "subtitle": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" } } }, "SurfaceEntryList": { "type": "object", "properties": { "correlationId": { "type": "string" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/SurfaceEntry" } }, "hasMore": { "type": "boolean" }, "space": { "type": "string" } } }, "SurfaceEntryResult": { "type": "object", "properties": { "correlationId": { "type": "string" }, "entry": { "$ref": "#/components/schemas/SurfaceEntry" } } }, "SurfaceLogin": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 8 } } }, "SurfacePublishBody": { "type": "object", "properties": { "slug": { "type": "string" }, "space": { "type": "string" } } }, "SurfaceRefresh": { "type": "object", "properties": { "refreshToken": { "type": "string" } } }, "SurfaceRegister": { "type": "object", "properties": { "displayName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "handle": { "type": "string" }, "locale": { "type": "string" }, "password": { "type": "string", "minLength": 8 }, "timezone": { "type": "string" } } }, "SurfaceSession": { "type": "object", "properties": { "capabilities": { "type": "array", "items": { "type": "string" } }, "displayName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "handle": { "type": "string" }, "publicId": { "type": "string" }, "role": { "type": "string" } } }, "SurfaceSpace": { "type": "object", "properties": { "code": { "type": "string" }, "defaultFormat": { "type": "string" }, "id": { "type": "string" }, "lane": { "type": "string" }, "title": { "type": "string" }, "visibility": { "type": "string" } } }, "SurfaceSpaces": { "type": "object", "properties": { "correlationId": { "type": "string" }, "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/SurfaceSpace" } } } }, "SurfaceTokens": { "type": "object", "properties": { "accessToken": { "type": "string" }, "correlationId": { "type": "string" }, "expiresIn": { "type": "integer", "format": "int64" }, "organizationId": { "type": "string" }, "refreshToken": { "type": "string" }, "session": { "$ref": "#/components/schemas/SurfaceSession" }, "tokenType": { "type": "string" } } }, "SurfaceWriteResult": { "type": "object", "properties": { "correlationId": { "type": "string" }, "entryId": { "type": "string" }, "slug": { "type": "string" }, "space": { "type": "string" }, "status": { "type": "string" } } }, "ThreadAttachBody": { "type": "object", "properties": { "code": { "type": "string" }, "kind": { "type": "string" }, "note": { "type": "string" }, "ref": { "type": "string" } } }, "ThreadItemView": { "type": "object", "properties": { "attachedAt": { "type": "string", "format": "date-time" }, "attachedBy": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "note": { "type": "string" }, "ref": { "type": "string" } } }, "ThreadList": { "type": "object", "properties": { "correlationId": { "type": "string" }, "threads": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadView" } } } }, "ThreadOpenBody": { "type": "object", "properties": { "code": { "type": "string" }, "subject": { "type": "string" } } }, "ThreadView": { "type": "object", "properties": { "code": { "type": "string" }, "contents": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadItemView" } }, "correlationId": { "type": "string" }, "id": { "type": "string" }, "items": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "subject": { "type": "string" } } }, "WorkflowCommand": { "type": "object", "properties": { "action": { "type": "string" }, "data": { "$ref": "#/components/schemas/WorkflowCommandData" }, "id": { "type": "string" }, "kind": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "title": { "type": "string" } } }, "WorkflowCommandData": { "type": "object", "properties": { "agreement": { "$ref": "#/components/schemas/AgreementDraft" }, "campaign": { "$ref": "#/components/schemas/Campaign" }, "distribution": { "$ref": "#/components/schemas/DistributionInput" }, "event": { "$ref": "#/components/schemas/CalendarEvent" }, "preferences": { "$ref": "#/components/schemas/CommunicationPreferences" }, "reply": { "$ref": "#/components/schemas/CalendarReply" } } }, "WorkflowFact": { "type": "object", "properties": { "action": { "type": "string" }, "actor": { "type": "string" }, "at": { "type": "string", "format": "date-time" }, "correlationId": { "type": "string" }, "requestHash": { "type": "string" } } }, "WorkflowList": { "type": "object", "properties": { "hasMore": { "type": "boolean" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRecord" } } } }, "WorkflowPeople": { "type": "object", "properties": { "people": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowPerson" } } } }, "WorkflowPerson": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "WorkflowRecord": { "type": "object", "properties": { "audience": { "type": "array", "items": { "type": "string" } }, "data": { "$ref": "#/components/schemas/WorkflowRecordData" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowFact" } }, "id": { "type": "string" }, "kind": { "type": "string" }, "owner": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "state": { "type": "string" }, "title": { "type": "string" } } }, "WorkflowRecordData": { "type": "object", "properties": { "campaign": { "$ref": "#/components/schemas/Campaign" }, "distribution": { "$ref": "#/components/schemas/Distribution" }, "document": { "$ref": "#/components/schemas/AgreementDocument" }, "event": { "$ref": "#/components/schemas/CalendarEvent" }, "preferences": { "$ref": "#/components/schemas/CommunicationPreferences" }, "statement": { "$ref": "#/components/schemas/DistributionStatement" } } }, "game.v1.ApplyActionRequest": { "type": "object", "description": "Request body for game:apply_action:v1:requested", "additionalProperties": {} }, "game.v1.ApplyActionResponse": { "type": "object", "description": "Successful response for game:apply_action:v1:requested", "additionalProperties": {} }, "game.v1.ClaimActorRequest": { "type": "object", "description": "Request body for game:claim_actor:v1:requested", "additionalProperties": {} }, "game.v1.ClaimActorResponse": { "type": "object", "description": "Successful response for game:claim_actor:v1:requested", "additionalProperties": {} }, "game.v1.DescribeRuntimeResponse": { "type": "object", "description": "Successful response for game:describe_runtime:v1:requested", "additionalProperties": {} }, "game.v1.EnterWorldRequest": { "type": "object", "description": "Request body for game:enter_world:v1:requested", "additionalProperties": {} }, "game.v1.EnterWorldResponse": { "type": "object", "description": "Successful response for game:enter_world:v1:requested", "additionalProperties": {} }, "game.v1.GetAcceptedCellResponse": { "type": "object", "description": "Successful response for game:get_accepted_cell:v1:requested", "additionalProperties": {} }, "game.v1.GetCellOccupancyResponse": { "type": "object", "description": "Successful response for game:get_cell_occupancy:v1:requested", "additionalProperties": {} }, "game.v1.GetWorldResponse": { "type": "object", "description": "Successful response for game:get_world:v1:requested", "additionalProperties": {} }, "game.v1.ReadStateRequest": { "type": "object", "description": "Request body for game:read_state:v1:requested", "additionalProperties": {} }, "game.v1.ReadStateResponse": { "type": "object", "description": "Successful response for game:read_state:v1:requested", "additionalProperties": {} } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "JWT bearer token. Example: Authorization: Bearer \u003ctoken\u003e" } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "auth" }, { "name": "business" }, { "name": "communication" }, { "name": "community" }, { "name": "contact" }, { "name": "content" }, { "name": "email" }, { "name": "game" }, { "name": "hub" }, { "name": "identity" }, { "name": "legalfinance" }, { "name": "network" }, { "name": "project" }, { "name": "schedule" }, { "name": "talent" }, { "name": "voice" }, { "name": "workspace" } ] }