{ "openapi": "3.0.4", "info": { "title": "agentView Owner API", "description": "Authenticated display-owner management surface under /api/v1/owner and /api/v1/orgs: display categories, webhooks, content approval, source-lock and activity audit.", "version": "v1" }, "paths": { "/api/v1/owner/activity-audit": { "get": { "tags": [ "ActivityAudit" ], "summary": "Owner-scoped audit view: events where the caller is the actor, plus\nevents targeting displays the caller owns or API keys the caller\nholds. Filters: action, target type/id, time window. Capped at 1000.", "parameters": [ { "name": "action", "in": "query", "schema": { "type": "string" } }, { "name": "targetType", "in": "query", "schema": { "type": "string" } }, { "name": "targetId", "in": "query", "schema": { "type": "string" } }, { "name": "apiKeyId", "in": "query", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 200 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ActivityAuditListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ActivityAuditListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ActivityAuditListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/display-categories": { "get": { "tags": [ "DisplayCategories" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "DisplayCategories" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.CreateCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.CreateCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.CreateCategoryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/display-categories/{categoryId}": { "patch": { "tags": [ "DisplayCategories" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.UpdateCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.UpdateCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.UpdateCategoryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "DisplayCategories" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/categories": { "put": { "tags": [ "DisplayCategories" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/display-categories/bulk-assign": { "post": { "tags": [ "DisplayCategories" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/orgs/{orgId}/display-categories": { "get": { "tags": [ "DisplayCategories" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "DisplayCategories" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.CreateCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.CreateCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.CreateCategoryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/orgs/{orgId}/display-categories/{categoryId}": { "patch": { "tags": [ "DisplayCategories" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.UpdateCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.UpdateCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.UpdateCategoryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "DisplayCategories" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/orgs/{orgId}/displays/{profileId}/categories": { "put": { "tags": [ "DisplayCategories" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/orgs/{orgId}/display-categories/bulk-assign": { "post": { "tags": [ "DisplayCategories" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/preferences": { "get": { "tags": [ "Owner" ], "summary": "Get user preferences", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetPreferencesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetPreferencesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetPreferencesResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/preferences/language": { "put": { "tags": [ "Owner" ], "summary": "Update user language", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerController.UpdateLanguageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerController.UpdateLanguageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerController.UpdateLanguageRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/stats": { "get": { "tags": [ "Owner" ], "summary": "Get dashboard stats for the authenticated user.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetStatsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetStatsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetStatsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays": { "get": { "tags": [ "Owner" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetDisplaysResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetDisplaysResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetDisplaysResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{displayId}": { "get": { "tags": [ "Owner" ], "summary": "Get a single accessible display by id, returning the same shape as a list element\nfrom M:Screen.Central.Controllers.OwnerController.GetDisplays(System.Int32,System.Int32,System.Threading.CancellationToken). Used by the Display Detail page.", "parameters": [ { "name": "displayId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayListItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayListItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayListItem" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Owner" ], "summary": "Delete a display profile and its affinity.", "parameters": [ { "name": "displayId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DeleteOwnerDisplayResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DeleteOwnerDisplayResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DeleteOwnerDisplayResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/toggle-lock": { "post": { "tags": [ "Owner" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ToggleLockResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ToggleLockResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ToggleLockResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/name": { "put": { "tags": [ "Owner" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RenameDisplayRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RenameDisplayRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RenameDisplayRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RenameDisplayResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RenameDisplayResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RenameDisplayResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/stop": { "post": { "tags": [ "Owner" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/assign-license": { "post": { "tags": [ "Owner" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayLicenseAssignmentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayLicenseAssignmentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayLicenseAssignmentResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/unassign-license": { "post": { "tags": [ "Owner" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayLicenseAssignmentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayLicenseAssignmentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayLicenseAssignmentResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/unlink": { "post": { "tags": [ "Owner" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/move-to-group": { "post": { "tags": [ "Owner" ], "summary": "Move an existing display between groups (or detach to \"personal\" by\npassing null/empty groupId). Closes the reseller use-case where a\ndisplay was paired in personal first and now needs to land in the\ncustomer's group — previously only \"remove from current group\" and\n\"create new in group\" existed, but no migration of existing displays.\n \nPer memory `feedback_personal_displays_not_assignable.md`, personal\ndisplays themselves stay personal — but moving between groups (or\nfrom personal into a group, since the display itself is unchanged\nmetadata-wise) is the missing reseller workflow.", "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerController.MoveDisplayToGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerController.MoveDisplayToGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerController.MoveDisplayToGroupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.MoveDisplayToGroupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.MoveDisplayToGroupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.MoveDisplayToGroupResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/profiles": { "post": { "tags": [ "Owner" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerController.CreateProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerController.CreateProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerController.CreateProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayListItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayListItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayListItem" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/agent-artifacts": { "get": { "tags": [ "OwnerAgentArtifacts" ], "summary": "Metadata-only list of artifacts available for the template currently\ninstalled on this display. Bodies are not included — fetch them via\nM:Screen.Central.Controllers.OwnerAgentArtifactsController.GetArtifact(System.String,System.String,System.Boolean,System.Threading.CancellationToken) when the customer hits Copy / Download.", "parameters": [ { "name": "profileId", "in": "path", "description": "Display profile ID, owned by the caller.", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Locale code ('de' or 'en'); falls back across the available locales.", "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ListDisplayAgentArtifactsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ListDisplayAgentArtifactsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ListDisplayAgentArtifactsResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/agent-artifacts/{artifactKey}": { "get": { "tags": [ "OwnerAgentArtifacts" ], "summary": "Returns the artifact body with placeholders substituted against the\ndisplay's installed slots. The Content-Type matches the artifact's\nstored MIME type (markdown / json / plain text).", "parameters": [ { "name": "profileId", "in": "path", "description": "Display profile ID.", "required": true, "schema": { "type": "string" } }, { "name": "artifactKey", "in": "path", "description": "Artifact key declared in the template's manifest.", "required": true, "schema": { "type": "string" } }, { "name": "download", "in": "query", "description": "When true, sets a `Content-Disposition: attachment`\n header with the artifact's suggested filename so the browser writes\n a file instead of rendering inline.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/markdown": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/markdown": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/markdown": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing": { "get": { "tags": [ "OwnerBilling" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetBillingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetBillingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetBillingResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing/sync": { "post": { "tags": [ "OwnerBilling" ], "summary": "Syncs the user's local subscription with Paddle's current state.\nCalled by the client before displaying the billing page.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSyncResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSyncResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSyncResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing/portal-session": { "post": { "tags": [ "OwnerBilling" ], "summary": "Creates a Paddle customer portal session and returns the portal URL.\nPaddle requires the provider-side customer ID (ctm_...), not our userId.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.CreatePortalSessionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.CreatePortalSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.CreatePortalSessionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingUrlResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingUrlResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingUrlResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing/transactions": { "get": { "tags": [ "OwnerBilling" ], "summary": "Returns the user's transaction history from Paddle.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetBillingTransactionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetBillingTransactionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetBillingTransactionsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing/transactions/{transactionId}/invoice": { "get": { "tags": [ "OwnerBilling" ], "summary": "Returns a signed PDF invoice URL for a specific transaction.", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingUrlResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingUrlResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingUrlResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing/pause": { "post": { "tags": [ "OwnerBilling" ], "summary": "Pauses the user's active subscription at the end of the current billing period.\nValidates no scheduled_change is already pending.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing/resume": { "post": { "tags": [ "OwnerBilling" ], "summary": "Resumes a paused subscription immediately.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing/reactivate": { "post": { "tags": [ "OwnerBilling" ], "summary": "Reactivates a subscription that is scheduled to cancel at period end.\nClears the scheduled cancellation so the subscription continues normally.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ReactivateSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ReactivateSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ReactivateSubscriptionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing/cancel": { "post": { "tags": [ "OwnerBilling" ], "summary": "Cancels the user's active subscription at the end of the current billing period.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing/subscriptions/{subscriptionId}/cancel": { "post": { "tags": [ "OwnerBilling" ], "summary": "Cancels a specific subscription by its internal ID at the end of the current billing period.\nAllows users with multiple subscriptions to cancel individual ones.", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionActionResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing/display-checkout": { "get": { "tags": [ "OwnerBilling" ], "summary": "Returns checkout configuration for purchasing extra display licenses via Paddle.js overlay.", "parameters": [ { "name": "interval", "in": "query", "schema": { "type": "string", "default": "monthly" } }, { "name": "quantity", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayCheckoutResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayCheckoutResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayCheckoutResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing/display-quantity/preview": { "post": { "tags": [ "OwnerBilling" ], "summary": "Previews proration and immediate charge when changing display add-on quantity.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UpdateDisplayQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UpdateDisplayQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UpdateDisplayQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayQuantityPreviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayQuantityPreviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayQuantityPreviewResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/billing/display-quantity": { "post": { "tags": [ "OwnerBilling" ], "summary": "Updates the quantity of an existing display add-on subscription.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UpdateDisplayQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UpdateDisplayQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UpdateDisplayQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.UpdateDisplayQuantityResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.UpdateDisplayQuantityResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.UpdateDisplayQuantityResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/broadcast-by-category": { "post": { "tags": [ "OwnerCategoryBroadcast" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastByCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastByCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastByCategoryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/orgs/{orgId}/displays/broadcast-by-category": { "post": { "tags": [ "OwnerCategoryBroadcast" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastByCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastByCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastByCategoryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/current-html": { "post": { "tags": [ "OwnerContent" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Html": { "type": "string" }, "Description": { "type": "string" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "Html": { "style": "form" }, "Description": { "style": "form" }, "file": { "style": "form" } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Html": { "type": "string" }, "Description": { "type": "string" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "Html": { "style": "form" }, "Description": { "style": "form" }, "file": { "style": "form" } } }, "text/html": { "schema": { "type": "object", "properties": { "Html": { "type": "string" }, "Description": { "type": "string" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "Html": { "style": "form" }, "Description": { "style": "form" }, "file": { "style": "form" } } }, "text/plain": { "schema": { "type": "object", "properties": { "Html": { "type": "string" }, "Description": { "type": "string" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "Html": { "style": "form" }, "Description": { "style": "form" }, "file": { "style": "form" } } }, "application/octet-stream": { "schema": { "type": "object", "properties": { "Html": { "type": "string" }, "Description": { "type": "string" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "Html": { "style": "form" }, "Description": { "style": "form" }, "file": { "style": "form" } } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "Html": { "type": "string" }, "Description": { "type": "string" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "Html": { "style": "form" }, "Description": { "style": "form" }, "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetCurrentContentHtmlResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetCurrentContentHtmlResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetCurrentContentHtmlResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "413": { "description": "Content Too Large", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "get": { "tags": [ "OwnerContent" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetCurrentContentHtmlResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetCurrentContentHtmlResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetCurrentContentHtmlResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/quick-send/preview": { "post": { "tags": [ "OwnerContent" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerContentController.QuickSendPreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerContentController.QuickSendPreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerContentController.QuickSendPreviewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.CreateQuickSendPreviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.CreateQuickSendPreviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.CreateQuickSendPreviewResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/saved-default-html": { "get": { "tags": [ "OwnerContent" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetSavedDefaultContentHtmlResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetSavedDefaultContentHtmlResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetSavedDefaultContentHtmlResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "OwnerContent" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerContentController.SetSavedDefaultHtmlRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerContentController.SetSavedDefaultHtmlRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerContentController.SetSavedDefaultHtmlRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetSavedDefaultContentHtmlResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetSavedDefaultContentHtmlResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetSavedDefaultContentHtmlResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "413": { "description": "Content Too Large", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/saved-default-url": { "post": { "tags": [ "OwnerContent" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerContentController.SetSavedDefaultUrlRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerContentController.SetSavedDefaultUrlRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerContentController.SetSavedDefaultUrlRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetSavedDefaultContentHtmlResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetSavedDefaultContentHtmlResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetSavedDefaultContentHtmlResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "413": { "description": "Content Too Large", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/saved-default": { "delete": { "tags": [ "OwnerContent" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ClearSavedDefaultContentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ClearSavedDefaultContentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ClearSavedDefaultContentResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/preview": { "get": { "tags": [ "OwnerContent" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayPreviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayPreviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayPreviewResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/agent-send-link": { "post": { "tags": [ "OwnerContent" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.CreateAgentSendLinkResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.CreateAgentSendLinkResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.CreateAgentSendLinkResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{id}/approval-mode": { "put": { "tags": [ "OwnerDisplayApproval" ], "summary": "Toggle the per-display approval requirement.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ApprovalModeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ApprovalModeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ApprovalModeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ApprovalModeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ApprovalModeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ApprovalModeResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{id}/pending/accept": { "post": { "tags": [ "OwnerDisplayApproval" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessMessageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessMessageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessMessageResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{id}/pending/reject": { "post": { "tags": [ "OwnerDisplayApproval" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.RejectPendingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.RejectPendingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.RejectPendingRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessMessageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessMessageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessMessageResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{id}/rollback": { "post": { "tags": [ "OwnerDisplayApproval" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessMessageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessMessageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessMessageResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{id}/approval-state": { "get": { "tags": [ "OwnerDisplayApproval" ], "summary": "Read-only snapshot of the current/pending/previous slot the dashboard\nuses to render the side-by-side preview UI.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ApprovalStateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ApprovalStateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.ApprovalStateResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/badge-overlay": { "put": { "tags": [ "OwnerDisplaySettings" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.BadgeOverlayRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.BadgeOverlayRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.BadgeOverlayRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetBadgeOverlayResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetBadgeOverlayResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetBadgeOverlayResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "OwnerDisplaySettings" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.BadgeOverlayRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.BadgeOverlayRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.BadgeOverlayRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetBadgeOverlayResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetBadgeOverlayResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetBadgeOverlayResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/idle-policy": { "put": { "tags": [ "OwnerDisplaySettings" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.IdlePolicyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.IdlePolicyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.IdlePolicyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetIdlePolicyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetIdlePolicyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetIdlePolicyResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "OwnerDisplaySettings" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.IdlePolicyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.IdlePolicyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.IdlePolicyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetIdlePolicyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetIdlePolicyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetIdlePolicyResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/watermark-position": { "put": { "tags": [ "OwnerDisplaySettings" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.WatermarkPositionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.WatermarkPositionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.WatermarkPositionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetWatermarkPositionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetWatermarkPositionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetWatermarkPositionResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "OwnerDisplaySettings" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.WatermarkPositionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.WatermarkPositionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.WatermarkPositionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetWatermarkPositionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetWatermarkPositionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetWatermarkPositionResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/connectivity": { "get": { "tags": [ "OwnerDisplaySettings" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetDisplayConnectivityResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetDisplayConnectivityResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetDisplayConnectivityResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "OwnerDisplaySettings" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.DisplayConnectivityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.DisplayConnectivityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.DisplayConnectivityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetDisplayConnectivityResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetDisplayConnectivityResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetDisplayConnectivityResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/runtime-preferences": { "put": { "tags": [ "OwnerDisplaySettings" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.DisplayRuntimePreferencesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.DisplayRuntimePreferencesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.DisplayRuntimePreferencesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetDisplayRuntimePreferencesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetDisplayRuntimePreferencesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetDisplayRuntimePreferencesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "OwnerDisplaySettings" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.DisplayRuntimePreferencesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.DisplayRuntimePreferencesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerDisplaySettingsController.DisplayRuntimePreferencesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetDisplayRuntimePreferencesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetDisplayRuntimePreferencesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SetDisplayRuntimePreferencesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{id}/source-lock": { "get": { "tags": [ "OwnerDisplaySourceLock" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SourceLockResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SourceLockResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SourceLockResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "put": { "tags": [ "OwnerDisplaySourceLock" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SourceLockRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SourceLockRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SourceLockRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SourceLockResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SourceLockResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SourceLockResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/generate-secret": { "post": { "tags": [ "OwnerPairing" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GenerateSecretResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GenerateSecretResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GenerateSecretResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/generate-pin": { "post": { "tags": [ "OwnerPairing" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "preset", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GeneratePinResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GeneratePinResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GeneratePinResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/generate-managed-link": { "post": { "tags": [ "OwnerPairing" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GenerateManagedLinkResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GenerateManagedLinkResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GenerateManagedLinkResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/pair-by-code": { "post": { "tags": [ "OwnerPairing" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerPairingController.PairByCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerPairingController.PairByCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerPairingController.PairByCodeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.PairByCodeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.PairByCodeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.PairByCodeResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/pairing-choices/complete": { "post": { "tags": [ "OwnerPairing" ], "summary": "Finishes a choice somebody made before they had an account: connects the\nscreen whose code the note carries, and puts the chosen template on it\nwith the fields they typed.\n \n\nThe template is the second half, not a condition of the first. If\ninstalling it fails, the screen still belongs to its new owner and the\nanswer says so, because losing the screen over a template would undo the\none step that mattered.\nA reload or a double submit arrives with the same note. By then the\ncode is consumed, so the same answer is handed back rather than a\n\"code not found\" for a screen that is already connected.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerPairingController.CompletePairingChoiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerPairingController.CompletePairingChoiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerPairingController.CompletePairingChoiceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.PairingChoiceCompletedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.PairingChoiceCompletedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.PairingChoiceCompletedResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/rebind": { "post": { "tags": [ "OwnerPairing" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerPairingController.RebindDisplayRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerPairingController.RebindDisplayRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerPairingController.RebindDisplayRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RebindDisplayResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RebindDisplayResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RebindDisplayResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/pending-displays": { "get": { "tags": [ "OwnerPairing" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.PendingDisplayItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.PendingDisplayItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.PendingDisplayItem" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/approve-display": { "post": { "tags": [ "OwnerPairing" ], "parameters": [ { "name": "displayId", "in": "query", "schema": { "type": "string" } }, { "name": "targetProfileId", "in": "query", "schema": { "type": "string" } }, { "name": "createMode", "in": "query", "schema": { "type": "string" } }, { "name": "createName", "in": "query", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ApproveDisplayResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ApproveDisplayResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ApproveDisplayResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/schedule": { "get": { "tags": [ "OwnerSchedule" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetScheduleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetScheduleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "OwnerSchedule" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SaveScheduleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SaveScheduleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SaveScheduleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SaveScheduleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SaveScheduleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SaveScheduleResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "OwnerSchedule" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DeleteScheduleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DeleteScheduleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DeleteScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/schedule/repair-reference": { "post": { "tags": [ "OwnerSchedule" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RepairScheduleReferenceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RepairScheduleReferenceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RepairScheduleReferenceResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/schedule/toggle": { "post": { "tags": [ "OwnerSchedule" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ToggleScheduleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ToggleScheduleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ToggleScheduleResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/schedule/entries": { "post": { "tags": [ "OwnerSchedule" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SaveEntryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SaveEntryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SaveEntryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ScheduleEntryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ScheduleEntryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ScheduleEntryResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/schedule/entries/{entryId}": { "put": { "tags": [ "OwnerSchedule" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SaveEntryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SaveEntryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SaveEntryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ScheduleEntryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ScheduleEntryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ScheduleEntryResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "OwnerSchedule" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DeleteScheduleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DeleteScheduleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DeleteScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/schedule/preview": { "get": { "tags": [ "OwnerSchedule" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SchedulePreviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SchedulePreviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SchedulePreviewResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/html-templates": { "get": { "tags": [ "OwnerTemplate" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetHtmlTemplatesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetHtmlTemplatesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetHtmlTemplatesResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "OwnerTemplate" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerTemplateController.SaveHtmlTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerTemplateController.SaveHtmlTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerTemplateController.SaveHtmlTemplateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SaveHtmlTemplateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SaveHtmlTemplateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SaveHtmlTemplateResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/html-templates/{templateId}": { "get": { "tags": [ "OwnerTemplate" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetHtmlTemplateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetHtmlTemplateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetHtmlTemplateResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "patch": { "tags": [ "OwnerTemplate" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerTemplateController.UpdateHtmlTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerTemplateController.UpdateHtmlTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerTemplateController.UpdateHtmlTemplateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.UpdateHtmlTemplateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.UpdateHtmlTemplateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.UpdateHtmlTemplateResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "OwnerTemplate" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DeleteHtmlTemplateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DeleteHtmlTemplateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.DeleteHtmlTemplateResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/displays/{profileId}/current-html/save-template": { "post": { "tags": [ "OwnerTemplate" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerTemplateController.SaveCurrentHtmlAsTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerTemplateController.SaveCurrentHtmlAsTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerTemplateController.SaveCurrentHtmlAsTemplateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SaveHtmlTemplateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SaveHtmlTemplateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SaveHtmlTemplateResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/html-templates/{templateId}/shares": { "get": { "tags": [ "OwnerTemplate" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetHtmlTemplateSharesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetHtmlTemplateSharesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.GetHtmlTemplateSharesResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "OwnerTemplate" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerTemplateController.ShareHtmlTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerTemplateController.ShareHtmlTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerTemplateController.ShareHtmlTemplateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ShareHtmlTemplateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ShareHtmlTemplateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ShareHtmlTemplateResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "OwnerTemplate" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupType", "in": "query", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RemoveHtmlTemplateShareResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RemoveHtmlTemplateShareResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.RemoveHtmlTemplateShareResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/orgs/{orgId}/category-grants": { "get": { "tags": [ "UserCategoryGrants" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto" } } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "UserCategoryGrants" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.CreateGrantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.CreateGrantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.CreateGrantRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/orgs/{orgId}/category-grants/{id}": { "delete": { "tags": [ "UserCategoryGrants" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/category-grants": { "get": { "tags": [ "UserCategoryGrants" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "UserCategoryGrants" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.CreateGrantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.CreateGrantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.CreateGrantRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/category-grants/{id}": { "delete": { "tags": [ "UserCategoryGrants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/webhooks": { "get": { "tags": [ "Webhook" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.WebhookListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.WebhookListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.WebhookListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Webhook" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.CreateWebhookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.CreateWebhookRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.CreateWebhookRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.CreateWebhookResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.CreateWebhookResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.CreateWebhookResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/webhooks/{id}": { "delete": { "tags": [ "Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessMessageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessMessageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.SuccessMessageResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/webhooks/{id}/active": { "patch": { "tags": [ "Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SetWebhookActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SetWebhookActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.SetWebhookActiveRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.WebhookSubscriptionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.WebhookSubscriptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.WebhookSubscriptionDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } }, "/api/v1/owner/webhooks/{id}/test": { "post": { "tags": [ "Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.WebhookSubscriptionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.WebhookSubscriptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Controllers.WebhookSubscriptionDto" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Screen.Central.Contracts.ErrorResponse" } } } } }, "security": [ { } ] } } }, "components": { "schemas": { "Screen.Central.Contracts.ApproveDisplayResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "profileId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.AssignedDisplayCategory": { "type": "object", "properties": { "categoryId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "scope": { "type": "string", "nullable": true }, "orgId": { "type": "string", "nullable": true }, "orgName": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "A category assigned to a display, as the owner sees it.\nScreen.Central.Contracts.AssignedDisplayCategory.Scope is \"personal\" for the caller's own categories and \"org\"\nfor ones that come from a group, in which case Screen.Central.Contracts.AssignedDisplayCategory.OrgId and\nScreen.Central.Contracts.AssignedDisplayCategory.OrgName name the group." }, "Screen.Central.Contracts.BillingAccountSummary": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "providerCustomerId": { "type": "string", "nullable": true }, "currencyCode": { "type": "string", "nullable": true }, "activePlan": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Screen.Central.Contracts.BillingStateSummary": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingAccountSummary" }, "nullable": true }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The stored billing records, one entry per environment (live and sandbox).\nThis is the raw local state, separate from the resolved view above it." }, "Screen.Central.Contracts.BillingSubscriptionActionResponse": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Screen.Central.Contracts.BillingSubscriptionActionResponse.Status is one of \"pause_scheduled\", \"resumed\", \"reactivated\"\n or \"cancel_scheduled\". The two \"scheduled\" ones mean the change takes effect\n at the end of the paid period, not now." }, "Screen.Central.Contracts.BillingSubscriptionDetail": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "provider": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "plan": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "providerSubscriptionId": { "type": "string", "nullable": true }, "providerPriceId": { "type": "string", "nullable": true }, "cancelAtPeriodEnd": { "type": "boolean" }, "currentPeriodEndsAt": { "type": "string", "format": "date-time", "nullable": true }, "nextBilledAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "assignedByUserId": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "isTrialing": { "type": "boolean" }, "trialEndsAt": { "type": "string", "format": "date-time", "nullable": true }, "quantity": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Screen.Central.Contracts.BillingSubscriptionSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "provider": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "plan": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "cancelAtPeriodEnd": { "type": "boolean" }, "currentPeriodEndsAt": { "type": "string", "format": "date-time", "nullable": true }, "nextBilledAt": { "type": "string", "format": "date-time", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "assignedByUserId": { "type": "string", "nullable": true }, "isTrialing": { "type": "boolean" }, "trialEndsAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A subscription as the billing page shows it." }, "Screen.Central.Contracts.BillingSyncResponse": { "type": "object", "properties": { "synced": { "type": "boolean" }, "diag": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "Screen.Central.Contracts.BillingSyncResponse.Synced reports whether the pull from the provider changed\n anything locally, so false is the ordinary answer and not a failure." }, "Screen.Central.Contracts.BillingTransactionSummary": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "currencyCode": { "type": "string", "nullable": true }, "grandTotal": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "billedAt": { "type": "string", "format": "date-time", "nullable": true }, "billingPeriodStartsAt": { "type": "string", "nullable": true }, "billingPeriodEndsAt": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.BillingUrlResponse": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "A one-time link at the payment provider. It expires." }, "Screen.Central.Contracts.ClearSavedDefaultContentResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "profileId": { "type": "string", "nullable": true }, "hasSavedDefaultContent": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Contracts.CreateAgentSendLinkResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "profileId": { "type": "string", "nullable": true }, "displayId": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time" }, "sendUrl": { "type": "string", "nullable": true }, "aiConnectUrl": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "A short-lived link that lets an agent send to one display without a session.\n`SendUrl` is the endpoint to post to; `AiConnectUrl` is the page a\nperson opens to hand the link to their assistant." }, "Screen.Central.Contracts.CreateQuickSendPreviewResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "displayId": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "versionId": { "type": "string", "nullable": true }, "size": { "type": "integer", "format": "int64" }, "uploadLimit": { "type": "integer", "format": "int64" }, "previewUrl": { "type": "string", "nullable": true }, "contentUrl": { "type": "string", "nullable": true }, "expiresInSeconds": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Screen.Central.Contracts.DeleteHtmlTemplateResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "templateId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.DeleteOwnerDisplayResponse": { "type": "object", "properties": { "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.DeleteScheduleResponse": { "type": "object", "properties": { "deleted": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Deleting something that was not there is not an error, so\nScreen.Central.Contracts.DeleteScheduleResponse.Deleted can be false on a 200 and Screen.Central.Contracts.DeleteScheduleResponse.Message says\nwhy." }, "Screen.Central.Contracts.DisplayAddonInfo": { "type": "object", "properties": { "configured": { "type": "boolean" }, "monthlyConfigured": { "type": "boolean" }, "yearlyConfigured": { "type": "boolean" }, "monthlyLabel": { "type": "string", "nullable": true }, "monthlyAmount": { "type": "string", "nullable": true }, "monthlyCurrency": { "type": "string", "nullable": true }, "yearlyLabel": { "type": "string", "nullable": true }, "yearlyAmount": { "type": "string", "nullable": true }, "yearlyCurrency": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "The display add-on's configured prices. Screen.Central.Contracts.DisplayAddonInfo.Configured is false\nwhen neither billing period has a product behind it, in which case the\nadd-on cannot be bought and the labels are null." }, "Screen.Central.Contracts.DisplayCheckoutCustomData": { "type": "object", "properties": { "user_Id": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Custom data the provider hands back on the resulting webhook." }, "Screen.Central.Contracts.DisplayCheckoutResponse": { "type": "object", "properties": { "mode": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "priceId": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "clientToken": { "type": "string", "nullable": true }, "successUrl": { "type": "string", "nullable": true }, "customerEmail": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "customData": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayCheckoutCustomData" } }, "additionalProperties": false, "description": "How to start a display purchase. Screen.Central.Contracts.DisplayCheckoutResponse.Mode decides which of the\nmembers below matter: \"checkout_link\" means send the customer to\nScreen.Central.Contracts.DisplayCheckoutResponse.Url, \"paddle_overlay\" means open the provider's overlay with\nScreen.Central.Contracts.DisplayCheckoutResponse.ClientToken, Screen.Central.Contracts.DisplayCheckoutResponse.PriceId and Screen.Central.Contracts.DisplayCheckoutResponse.Quantity." }, "Screen.Central.Contracts.DisplayLicenseAssignmentResponse": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "isPremiumAssigned": { "type": "boolean" } }, "additionalProperties": false, "description": "Screen.Central.Contracts.DisplayLicenseAssignmentResponse.Status is \"assigned\" or \"unassigned\".\n Screen.Central.Contracts.DisplayLicenseAssignmentResponse.IsPremiumAssigned is the flag as it stands after the call, so a\n client does not have to reload the display to learn the outcome." }, "Screen.Central.Contracts.DisplayListItem": { "type": "object", "properties": { "profileId": { "type": "string", "nullable": true }, "displayId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "isOnline": { "type": "boolean" }, "isDegraded": { "type": "boolean" }, "isReachable": { "type": "boolean" }, "statusHint": { "type": "string", "nullable": true }, "statusSource": { "type": "string", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time" }, "lastFallbackPollAt": { "type": "string", "format": "date-time", "nullable": true }, "currentContent": { "type": "string", "nullable": true }, "currentContentDescription": { "type": "string", "nullable": true }, "hardwareId": { "type": "string", "nullable": true }, "hasBeenPaired": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "idlePolicy": { "type": "string", "nullable": true }, "hasCurrentContent": { "type": "boolean" }, "canSaveCurrentAsDefault": { "type": "boolean" }, "hasSavedDefaultContent": { "type": "boolean" }, "savedDefaultUpdatedAt": { "type": "string", "format": "date-time", "nullable": true }, "showBadgeOverlay": { "type": "boolean" }, "ownerUserId": { "type": "string", "nullable": true }, "groupId": { "type": "string", "nullable": true }, "groupType": { "type": "string", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "hasActiveSchedule": { "type": "boolean" }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "categoryAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.AssignedDisplayCategory" }, "nullable": true }, "isLicensed": { "type": "boolean" }, "isPremiumAssigned": { "type": "boolean" }, "isAdEligible": { "type": "boolean" }, "hasExplicitLicense": { "type": "boolean" }, "accessLevel": { "type": "string", "nullable": true }, "canControl": { "type": "boolean" }, "canManage": { "type": "boolean" }, "canAdmin": { "type": "boolean" }, "badgeMode": { "type": "string", "nullable": true }, "relayHost": { "type": "string", "nullable": true }, "watermarkPosition": { "type": "string", "nullable": true }, "privacyMode": { "type": "string", "nullable": true }, "approvalUrl": { "type": "string", "nullable": true }, "setupUrl": { "type": "string", "nullable": true }, "managedUrl": { "type": "string", "nullable": true }, "setupCode": { "type": "string", "nullable": true }, "setupCodeExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "pairingUrl": { "type": "string", "nullable": true }, "pairingExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "logicalQuota": { "type": "integer", "format": "int64" }, "uploadLimit": { "type": "integer", "format": "int64" }, "showMouseCursor": { "type": "boolean" }, "allowCamera": { "type": "boolean" }, "allowMicrophone": { "type": "boolean" }, "allowGeolocation": { "type": "boolean" }, "preferredLanguage": { "type": "string", "nullable": true }, "effectiveLanguage": { "type": "string", "nullable": true }, "connectedAt": { "type": "string", "format": "date-time", "nullable": true }, "connectedSince": { "type": "string", "format": "date-time", "nullable": true }, "connectionMethod": { "type": "string", "nullable": true }, "resolution": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "browser": { "type": "string", "nullable": true }, "engine": { "type": "string", "nullable": true }, "platform": { "type": "string", "nullable": true }, "deviceClass": { "type": "string", "nullable": true }, "deviceFamily": { "type": "string", "nullable": true }, "hasTouch": { "type": "boolean", "nullable": true }, "touchSupport": { "type": "boolean", "nullable": true }, "touchSource": { "type": "string", "nullable": true }, "screen": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "viewport": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "screenResolution": { "type": "string", "nullable": true }, "viewportResolution": { "type": "string", "nullable": true }, "screenSource": { "type": "string", "nullable": true }, "viewportSource": { "type": "string", "nullable": true }, "runtime": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "preview": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayPreviewResponse" } }, "additionalProperties": false, "description": "One display, as returned by both the list and the single-display endpoint.\n \n\nA few members are deliberate aliases kept for clients written against\nthe older names: Screen.Central.Contracts.DisplayListItem.DisplayId repeats Screen.Central.Contracts.DisplayListItem.ProfileId,\nScreen.Central.Contracts.DisplayListItem.IpAddress repeats Screen.Central.Contracts.DisplayListItem.Ip, Screen.Central.Contracts.DisplayListItem.ConnectedSince\nrepeats Screen.Central.Contracts.DisplayListItem.ConnectedAt, Screen.Central.Contracts.DisplayListItem.TouchSupport repeats\nScreen.Central.Contracts.DisplayListItem.HasTouch, and Screen.Central.Contracts.DisplayListItem.PairingUrl /\nScreen.Central.Contracts.DisplayListItem.PairingExpiresAt repeat Screen.Central.Contracts.DisplayListItem.SetupUrl /\nScreen.Central.Contracts.DisplayListItem.SetupCodeExpiresAt. Each pair always carries the same value;\nnew code should use the first name of each pair.\nScreen.Central.Contracts.DisplayListItem.Runtime, Screen.Central.Contracts.DisplayListItem.Screen and Screen.Central.Contracts.DisplayListItem.Viewport\nare open maps of what the device reported about itself. Their keys depend on\nwhat the display's browser could probe, so they are not fixed and a client\nhas to treat every key as optional. The named members around them\n(Screen.Central.Contracts.DisplayListItem.Browser, Screen.Central.Contracts.DisplayListItem.Platform, Screen.Central.Contracts.DisplayListItem.ScreenResolution\nand so on) are the parts stable enough to promise." }, "Screen.Central.Contracts.DisplayPreviewResponse": { "type": "object", "properties": { "displayId": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "previewOrigin": { "type": "string", "nullable": true }, "previewOriginIsIsolated": { "type": "boolean" }, "current": { "$ref": "#/components/schemas/Screen.Central.Contracts.PreviewContentInfo" }, "idle": { "$ref": "#/components/schemas/Screen.Central.Contracts.PreviewContentInfo" } }, "additionalProperties": false }, "Screen.Central.Contracts.DisplayQuantityPreviewResponse": { "type": "object", "properties": { "quantity": { "type": "integer", "format": "int32" }, "currencyCode": { "type": "string", "nullable": true }, "dueNow": { "type": "string", "nullable": true }, "recurring": { "type": "string", "nullable": true }, "proration": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayQuantityProration" } }, "additionalProperties": false, "description": "Screen.Central.Contracts.DisplayQuantityPreviewResponse.DueNow is what the change costs today and\n Screen.Central.Contracts.DisplayQuantityPreviewResponse.Recurring what each period costs afterwards. They differ, and\n showing one where the other belongs is the mistake this record exists to\n make hard: recurring deliberately excludes one-time credits, which apply\n once and not to future cycles." }, "Screen.Central.Contracts.DisplayQuantityProration": { "type": "object", "properties": { "credit": { "type": "string", "nullable": true }, "charge": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "amount": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "What changing the count costs mid-period. Screen.Central.Contracts.DisplayQuantityProration.Action is the\nprovider's word for the direction (\"credit\" or \"charge\"), and\nScreen.Central.Contracts.DisplayQuantityProration.Amount is the net of the two." }, "Screen.Central.Contracts.ErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "hint": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Error response shape — unified error envelope used across all controllers." }, "Screen.Central.Contracts.GenerateManagedLinkResponse": { "type": "object", "properties": { "managedUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.GeneratePinResponse": { "type": "object", "properties": { "pin": { "type": "string", "nullable": true }, "setupUrl": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "pairingUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.GenerateSecretResponse": { "type": "object", "properties": { "approvalUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.GetBillingResponse": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true }, "currentPlan": { "type": "string", "nullable": true }, "sandboxTestingEnabled": { "type": "boolean" }, "checkoutEnvironment": { "type": "string", "nullable": true }, "checkoutReady": { "type": "boolean" }, "checkoutLinkMode": { "type": "boolean" }, "portalReady": { "type": "boolean" }, "isAdminManaged": { "type": "boolean" }, "providerTermsUrl": { "type": "string", "nullable": true }, "providerPrivacyUrl": { "type": "string", "nullable": true }, "billingAvailable": { "type": "boolean" }, "paddleClientToken": { "type": "string", "nullable": true }, "paddleEnvironment": { "type": "string", "nullable": true }, "activeSubscription": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionSummary" }, "displaySubscription": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingSubscriptionSummary" }, "isPremium": { "type": "boolean" }, "premiumLicenses": { "type": "integer", "format": "int32" }, "assignedLicenses": { "type": "integer", "format": "int32" }, "freeLicenses": { "type": "integer", "format": "int32" }, "personalStorageQuotaBytes": { "type": "integer", "format": "int64" }, "displayAddon": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayAddonInfo" }, "billing": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingStateSummary" } }, "additionalProperties": false, "description": "Everything the billing page needs in one call.\n \n\nThe three \"ready\" flags answer different questions and a client should\nnot collapse them: Screen.Central.Contracts.GetBillingResponse.CheckoutReady means a purchase can be\nstarted, Screen.Central.Contracts.GetBillingResponse.PortalReady means the provider's own portal can be\nopened for this customer, and Screen.Central.Contracts.GetBillingResponse.IsAdminManaged means neither\napplies because the licences were granted by hand." }, "Screen.Central.Contracts.GetBillingTransactionsResponse": { "type": "object", "properties": { "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.BillingTransactionSummary" }, "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.GetCurrentContentHtmlResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "profileId": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "versionId": { "type": "string", "nullable": true }, "html": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalQuota": { "type": "integer", "format": "int64" }, "uploadLimit": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Screen.Central.Contracts.GetDisplayConnectivityResponse": { "type": "object", "properties": { "profileId": { "type": "string", "nullable": true }, "connectivityMode": { "type": "string", "nullable": true }, "whitelist": { "type": "array", "items": { "type": "string" }, "nullable": true }, "strictWhitelist": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Contracts.GetDisplaysResponse": { "type": "object", "properties": { "displays": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayListItem" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Screen.Central.Contracts.GetDisplaysResponse.Total counts every display the caller can see;\n Screen.Central.Contracts.GetDisplaysResponse.Limit is how many this page actually holds, which is not the\n requested limit but the size of Screen.Central.Contracts.GetDisplaysResponse.Displays." }, "Screen.Central.Contracts.GetHtmlTemplateResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "templateId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "ownerUserId": { "type": "string", "nullable": true }, "isOwnedByCurrentUser": { "type": "boolean" }, "sourceProfileId": { "type": "string", "nullable": true }, "sourceDisplayName": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true }, "shares": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.TemplateShareSummary" }, "nullable": true }, "preview": { "$ref": "#/components/schemas/Screen.Central.Contracts.TemplatePreviewResponse" }, "html": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.GetHtmlTemplateSharesResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "shares": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.TemplateShareSummary" }, "nullable": true } }, "additionalProperties": false, "description": "The shares on one template. This was the one template endpoint returning an\nanonymous object, so OpenAPI could only say \"200 OK\" for it while every\nother one carried a record. A client integrating against it had to guess the\nfield names, which is exactly what an integrator reported doing." }, "Screen.Central.Contracts.GetHtmlTemplatesResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "templates": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.HtmlTemplateSummary" }, "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.GetPreferencesResponse": { "type": "object", "properties": { "language": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.GetSavedDefaultContentHtmlResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "profileId": { "type": "string", "nullable": true }, "html": { "type": "string", "nullable": true }, "versionId": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "sourceUrl": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "source": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "The content a display falls back to when nothing else is on it. All three\nbranches of that endpoint returned this exact shape as an anonymous object,\nso OpenAPI could only say \"200 OK\" and an integrator had to guess the field\nnames. `Source` is \"database\", \"storage\" or \"none\" and says where the\nHTML came from; on \"none\" every other field is null." }, "Screen.Central.Contracts.GetScheduleResponse": { "type": "object", "properties": { "hasSchedule": { "type": "boolean" }, "scheduleId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.ScheduleEntryResponse" }, "nullable": true } }, "additionalProperties": false, "description": "A display need not have a schedule, so Screen.Central.Contracts.GetScheduleResponse.HasSchedule decides\nwhether anything below it is filled in. When it is false every other member\nis null: there is no schedule to describe, not an empty one." }, "Screen.Central.Contracts.GetStatsResponse": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "displayCount": { "type": "integer", "format": "int32" }, "activeCount": { "type": "integer", "format": "int32" }, "personalLimit": { "type": "integer", "format": "int32" }, "personalUsed": { "type": "integer", "format": "int32" }, "allocatableSlots": { "type": "integer", "format": "int32" }, "allocatedTotal": { "type": "integer", "format": "int32" }, "slotOverview": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.SlotOverviewItem" }, "nullable": true }, "premiumLicenses": { "type": "integer", "format": "int32" }, "assignedPersonal": { "type": "integer", "format": "int32" }, "assignedGroups": { "type": "integer", "format": "int32" }, "freeLicenses": { "type": "integer", "format": "int32" }, "personalStorageQuotaBytes": { "type": "integer", "format": "int64" }, "personalStorageUsedBytes": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Screen.Central.Contracts.HtmlTemplateSummary": { "type": "object", "properties": { "templateId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "ownerUserId": { "type": "string", "nullable": true }, "isOwnedByCurrentUser": { "type": "boolean" }, "sourceProfileId": { "type": "string", "nullable": true }, "sourceDisplayName": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true }, "preview": { "$ref": "#/components/schemas/Screen.Central.Contracts.TemplatePreviewResponse" }, "shares": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Contracts.TemplateShareSummary" }, "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.ListDisplayAgentArtifactsResponse": { "type": "object", "properties": { "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Services.Store.AgentArtifactSummary" }, "nullable": true } }, "additionalProperties": false, "description": "The agent artifacts for one display, with the template's placeholders\nalready substituted against that display's slots. An empty list means no\ntemplate is installed yet; that is a 200, not a 404, because the tab has\nsomething to say either way." }, "Screen.Central.Contracts.MoveDisplayToGroupResponse": { "type": "object", "properties": { "profileId": { "type": "string", "nullable": true }, "groupId": { "type": "string", "nullable": true }, "moved": { "type": "boolean" }, "fromGroupId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Screen.Central.Contracts.MoveDisplayToGroupResponse.Moved is false when the display was already in the requested\n group, which is a success and not an error. Screen.Central.Contracts.MoveDisplayToGroupResponse.FromGroupId names\n the group it left, and is null when it was not in one." }, "Screen.Central.Contracts.PairByCodeResponse": { "type": "object", "properties": { "profileId": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.PairingChoiceCompletedResponse": { "type": "object", "properties": { "profileId": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "templateSlug": { "type": "string", "nullable": true }, "templateInstalled": { "type": "boolean" }, "templateError": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "What became of a choice somebody made before they had an account. The\ntemplate is the second half, not a condition of the first: when installing\nit fails the screen is still connected, and the two template fields say what\nhappened rather than the whole call failing." }, "Screen.Central.Contracts.PendingDisplayItem": { "type": "object", "properties": { "displayId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time", "nullable": true }, "targetProfileId": { "type": "string", "nullable": true }, "targetProfileName": { "type": "string", "nullable": true }, "width": { "type": "integer", "format": "int32", "nullable": true }, "height": { "type": "integer", "format": "int32", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "connectedAgo": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "A display waiting for its owner to approve it, in the bare list this\nendpoint returns.\n \n\nScreen.Central.Contracts.PendingDisplayItem.IpAddress is masked before it leaves the server, so it\nidentifies the network and not the device. Screen.Central.Contracts.PendingDisplayItem.ConnectedAgo is in\nminutes and null when no live session backs the entry." }, "Screen.Central.Contracts.PreviewContentInfo": { "type": "object", "properties": { "available": { "type": "boolean" }, "url": { "type": "string", "nullable": true }, "contentUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.RebindDisplayResponse": { "type": "object", "properties": { "profileId": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.RemoveHtmlTemplateShareResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "templateId": { "type": "string", "nullable": true }, "groupType": { "type": "string", "nullable": true }, "groupId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.RenameDisplayRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.RenameDisplayResponse": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "The name as stored, which is the trimmed form of what was sent." }, "Screen.Central.Contracts.RepairScheduleReferenceResponse": { "type": "object", "properties": { "repaired": { "type": "boolean" }, "reason": { "type": "string", "nullable": true }, "scheduleId": { "type": "string", "nullable": true }, "removedScheduleId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Repairing is a no-op in the ordinary case, which is why this reports what it\nfound rather than only whether it acted: Screen.Central.Contracts.RepairScheduleReferenceResponse.Reason names the\nno-op (\"no_schedule_reference\", \"schedule_reference_valid\") and\nScreen.Central.Contracts.RepairScheduleReferenceResponse.RemovedScheduleId names the dangling id that was cleared." }, "Screen.Central.Contracts.SaveHtmlTemplateResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "templateId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "sourceProfileId": { "type": "string", "nullable": true }, "sourceDisplayName": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Screen.Central.Contracts.SaveScheduleResponse": { "type": "object", "properties": { "scheduleId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Contracts.ScheduleEntryResponse": { "type": "object", "properties": { "entryId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "sortOrder": { "type": "integer", "format": "int32" }, "templateId": { "type": "string", "nullable": true }, "htmlFileName": { "type": "string", "nullable": true }, "contentUrl": { "type": "string", "nullable": true }, "startTime": { "type": "string", "nullable": true }, "endTime": { "type": "string", "nullable": true }, "daysOfWeek": { "type": "integer", "format": "int32" }, "validFrom": { "type": "string", "nullable": true }, "validUntil": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "One schedule entry as the API renders it. Times are \"HH:mm\" and dates\n\"yyyy-MM-dd\" strings rather than the domain's TimeOnly/DateOnly, because the\ndashboard puts them straight into and \"date\", which\ntake exactly those formats. Screen.Central.Contracts.ScheduleEntryResponse.DaysOfWeek is the numeric value of\nthe day flags (Monday = 1, Tuesday = 2, ... Sunday = 64)." }, "Screen.Central.Contracts.SchedulePreviewCurrentEntry": { "type": "object", "properties": { "entryId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Screen.Central.Contracts.SchedulePreviewNextEntry": { "type": "object", "properties": { "entryId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "startsAt": { "type": "string", "nullable": true }, "minutesUntil": { "type": "number", "format": "double", "nullable": true }, "dayOffset": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "The next change, which may be days away: Screen.Central.Contracts.SchedulePreviewNextEntry.DayOffset is 0 for\ntoday, 1 for tomorrow, and so on up to six, so a client can name the day\ninstead of only counting minutes." }, "Screen.Central.Contracts.SchedulePreviewResponse": { "type": "object", "properties": { "active": { "type": "boolean" }, "timezone": { "type": "string", "nullable": true }, "localTime": { "type": "string", "nullable": true }, "currentEntry": { "$ref": "#/components/schemas/Screen.Central.Contracts.SchedulePreviewCurrentEntry" }, "nextEntry": { "$ref": "#/components/schemas/Screen.Central.Contracts.SchedulePreviewNextEntry" } }, "additionalProperties": false, "description": "What the display is showing now and what it switches to next.\nScreen.Central.Contracts.SchedulePreviewResponse.Active is false when the display has no schedule, its schedule\nis missing, or the schedule is switched off; the rest is null in that case." }, "Screen.Central.Contracts.SetBadgeOverlayResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "badgeMode": { "type": "string", "nullable": true }, "showBadgeOverlay": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Contracts.SetCurrentContentHtmlResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "profileId": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "size": { "type": "integer", "format": "int64" }, "logicalQuota": { "type": "integer", "format": "int64" }, "uploadLimit": { "type": "integer", "format": "int64" }, "preview": { "$ref": "#/components/schemas/Screen.Central.Contracts.DisplayPreviewResponse" } }, "additionalProperties": false }, "Screen.Central.Contracts.SetDisplayConnectivityResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "profileId": { "type": "string", "nullable": true }, "connectivityMode": { "type": "string", "nullable": true }, "whitelist": { "type": "array", "items": { "type": "string" }, "nullable": true }, "strictWhitelist": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Contracts.SetDisplayRuntimePreferencesResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "showMouseCursor": { "type": "boolean" }, "allowCamera": { "type": "boolean" }, "allowMicrophone": { "type": "boolean" }, "allowGeolocation": { "type": "boolean" }, "preferredLanguage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.SetIdlePolicyResponse": { "type": "object", "properties": { "policy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.SetSavedDefaultContentHtmlResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "profileId": { "type": "string", "nullable": true }, "idlePolicy": { "type": "string", "nullable": true }, "hasSavedDefaultContent": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Contracts.SetWatermarkPositionResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "watermarkPosition": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.ShareHtmlTemplateResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "shareId": { "type": "string", "nullable": true }, "templateId": { "type": "string", "nullable": true }, "groupId": { "type": "string", "nullable": true }, "groupType": { "type": "string", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "alreadyShared": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Contracts.SlotOverviewItem": { "type": "object", "properties": { "groupId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "slots": { "type": "integer", "format": "int32" }, "used": { "type": "integer", "format": "int32" }, "online": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Screen.Central.Contracts.SuccessMessageResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "hint": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Simple success acknowledgement with a message." }, "Screen.Central.Contracts.SuccessResponse": { "type": "object", "properties": { "success": { "type": "boolean" } }, "additionalProperties": false, "description": "Simple success acknowledgement." }, "Screen.Central.Contracts.TemplatePreviewResponse": { "type": "object", "properties": { "templateId": { "type": "string", "nullable": true }, "previewOrigin": { "type": "string", "nullable": true }, "previewOriginIsIsolated": { "type": "boolean" }, "current": { "$ref": "#/components/schemas/Screen.Central.Contracts.PreviewContentInfo" } }, "additionalProperties": false }, "Screen.Central.Contracts.TemplateShareSummary": { "type": "object", "properties": { "shareId": { "type": "string", "nullable": true }, "groupId": { "type": "string", "nullable": true }, "groupType": { "type": "string", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "canManage": { "type": "boolean" }, "isVisibleToCurrentUser": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Contracts.ToggleLockResponse": { "type": "object", "properties": { "isLocked": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Contracts.ToggleScheduleResponse": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Contracts.UpdateDisplayQuantityResponse": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32" }, "cancelRestored": { "type": "boolean" }, "cancelRestoreFailed": { "type": "boolean" }, "cancelRestoreError": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "The provider refuses item changes while a cancellation is pending, so a\nquantity change on a cancelling subscription clears the cancellation,\nchanges the count, and puts the cancellation back.\nScreen.Central.Contracts.UpdateDisplayQuantityResponse.CancelRestored says that last step ran;\nScreen.Central.Contracts.UpdateDisplayQuantityResponse.CancelRestoreFailed says it did not, which means the\nsubscription is live again and still billing." }, "Screen.Central.Contracts.UpdateHtmlTemplateResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "templateId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "sourceProfileId": { "type": "string", "nullable": true }, "sourceDisplayName": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Screen.Central.Controllers.ActivityAuditListResponse": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.ActivityAuditRowDto" }, "nullable": true }, "count": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.ActivityAuditRowDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "timestamp": { "type": "string", "format": "date-time" }, "actorUserId": { "type": "string", "nullable": true }, "authMethod": { "type": "string", "nullable": true }, "apiKeyId": { "type": "string", "nullable": true }, "agentIdentifier": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "targetType": { "type": "string", "nullable": true }, "targetId": { "type": "string", "nullable": true }, "orgId": { "type": "string", "nullable": true }, "ipAddressPrefix": { "type": "string", "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "metadata": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.ApprovalModeRequest": { "type": "object", "properties": { "requireApproval": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Controllers.ApprovalModeResponse": { "type": "object", "properties": { "displayId": { "type": "string", "nullable": true }, "requireApproval": { "type": "boolean" }, "hasPending": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Controllers.ApprovalStateResponse": { "type": "object", "properties": { "displayId": { "type": "string", "nullable": true }, "requireApproval": { "type": "boolean" }, "current": { "$ref": "#/components/schemas/Screen.Central.Controllers.ContentSlotDto" }, "pending": { "$ref": "#/components/schemas/Screen.Central.Controllers.PendingContentSlotDto" }, "previous": { "$ref": "#/components/schemas/Screen.Central.Controllers.ContentSlotDto" } }, "additionalProperties": false }, "Screen.Central.Controllers.ContentSlotDto": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "versionId": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "previewUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.CreatePortalSessionRequest": { "type": "object", "properties": { "returnUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.CreateWebhookRequest": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "eventPattern": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.CreateWebhookResponse": { "type": "object", "properties": { "webhook": { "$ref": "#/components/schemas/Screen.Central.Controllers.WebhookSubscriptionDto" }, "secret": { "type": "string", "nullable": true }, "warning": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Screen.Central.Controllers.CreateWebhookResponse.Secret is returned once, here, and never again: it is the\n signing key for this subscription and the server keeps only a protected\n copy. Screen.Central.Controllers.CreateWebhookResponse.Warning says so in words a client can show." }, "Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryRequest": { "required": [ "categoryId", "mode", "profileIds" ], "type": "object", "properties": { "categoryId": { "minLength": 1, "type": "string" }, "profileIds": { "type": "array", "items": { "type": "string" } }, "mode": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryResponse": { "type": "object", "properties": { "categoryId": { "type": "string", "nullable": true }, "mode": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.DisplayCategoriesController.BulkAssignResult" }, "nullable": true } }, "additionalProperties": false, "description": "Screen.Central.Controllers.DisplayCategoriesController.BulkAssignCategoryResponse.Mode is \"add\" or \"remove\". Check\n Screen.Central.Controllers.DisplayCategoriesController.BulkAssignResult.Ok per entry rather than the status code:\n a call where every display hit the per-display limit still answers 200." }, "Screen.Central.Controllers.DisplayCategoriesController.BulkAssignResult": { "type": "object", "properties": { "profileId": { "type": "string", "nullable": true }, "ok": { "type": "boolean" }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One display in a bulk assign. Screen.Central.Controllers.DisplayCategoriesController.BulkAssignResult.Ok is per display, not per\ncall: the endpoint answers 200 even when some entries were refused, and\nScreen.Central.Controllers.DisplayCategoriesController.BulkAssignResult.ErrorCode says why that one was." }, "Screen.Central.Controllers.DisplayCategoriesController.CreateCategoryRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 64, "minLength": 0, "type": "string" }, "parentCategoryId": { "maxLength": 64, "minLength": 0, "type": "string", "nullable": true }, "color": { "maxLength": 16, "minLength": 0, "type": "string", "nullable": true }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.DisplayCategoriesController.DisplayCategoryDto": { "type": "object", "properties": { "categoryId": { "type": "string", "nullable": true }, "scope": { "type": "string", "nullable": true }, "orgId": { "type": "string", "nullable": true }, "ownerUserId": { "type": "string", "nullable": true }, "parentCategoryId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesRequest": { "type": "object", "properties": { "categoryIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.DisplayCategoriesController.ReplaceDisplayCategoriesResponse": { "type": "object", "properties": { "profileId": { "type": "string", "nullable": true }, "categoryIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "The categories the display carries after the call, in scope. This is the\nfull replacement set, not a delta." }, "Screen.Central.Controllers.DisplayCategoriesController.UpdateCategoryRequest": { "type": "object", "properties": { "name": { "maxLength": 64, "minLength": 0, "type": "string", "nullable": true }, "parentCategoryId": { "maxLength": 64, "minLength": 0, "type": "string", "nullable": true }, "moveToRoot": { "type": "boolean" }, "color": { "maxLength": 16, "minLength": 0, "type": "string", "nullable": true }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastByCategoryRequest": { "required": [ "categorySelector" ], "type": "object", "properties": { "categorySelector": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.CategorySelector" }, "html": { "type": "string", "nullable": true }, "base64Html": { "type": "string", "nullable": true }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "dryRun": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastResponse": { "type": "object", "properties": { "matched": { "type": "integer", "format": "int32" }, "sent": { "type": "integer", "format": "int32" }, "skipped": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastResult" }, "nullable": true }, "dryRun": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerCategoryBroadcastController.BroadcastResult": { "type": "object", "properties": { "profileId": { "type": "string", "nullable": true }, "ok": { "type": "boolean" }, "skipReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerCategoryBroadcastController.CategorySelector": { "required": [ "include" ], "type": "object", "properties": { "include": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.CategorySelectorItem" } }, "exclude": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.OwnerCategoryBroadcastController.CategorySelectorItem" }, "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerCategoryBroadcastController.CategorySelectorItem": { "required": [ "categoryId" ], "type": "object", "properties": { "categoryId": { "minLength": 1, "type": "string" }, "includeDescendants": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerContentController.QuickSendPreviewRequest": { "type": "object", "properties": { "html": { "type": "string", "nullable": true }, "profileId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerContentController.SetSavedDefaultHtmlRequest": { "type": "object", "properties": { "html": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "activateAsDefault": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerContentController.SetSavedDefaultUrlRequest": { "required": [ "url" ], "type": "object", "properties": { "url": { "maxLength": 2048, "minLength": 0, "type": "string" }, "description": { "type": "string", "nullable": true }, "activateAsDefault": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerController.CreateProfileRequest": { "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "via": { "maxLength": 16, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerController.MoveDisplayToGroupRequest": { "type": "object", "properties": { "groupId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerController.UpdateLanguageRequest": { "required": [ "language" ], "type": "object", "properties": { "language": { "maxLength": 10, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerDisplaySettingsController.BadgeOverlayRequest": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Deprecated: use ShowBadgeOverlay instead.", "nullable": true }, "showBadgeOverlay": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerDisplaySettingsController.DisplayConnectivityRequest": { "type": "object", "properties": { "connectivityMode": { "maxLength": 64, "minLength": 0, "type": "string", "nullable": true }, "whitelist": { "type": "array", "items": { "type": "string" }, "nullable": true }, "strictWhitelist": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerDisplaySettingsController.DisplayRuntimePreferencesRequest": { "type": "object", "properties": { "showMouseCursor": { "type": "boolean", "nullable": true }, "allowCamera": { "type": "boolean", "nullable": true }, "allowMicrophone": { "type": "boolean", "nullable": true }, "allowGeolocation": { "type": "boolean", "nullable": true }, "preferredLanguage": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerDisplaySettingsController.IdlePolicyRequest": { "required": [ "policy" ], "type": "object", "properties": { "policy": { "maxLength": 64, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerDisplaySettingsController.WatermarkPositionRequest": { "type": "object", "properties": { "position": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Deprecated: use WatermarkPosition instead.", "nullable": true }, "watermarkPosition": { "maxLength": 64, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerPairingController.CompletePairingChoiceRequest": { "required": [ "token" ], "type": "object", "properties": { "token": { "maxLength": 4096, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerPairingController.PairByCodeRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 20, "minLength": 0, "type": "string" }, "profileName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "via": { "maxLength": 16, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerPairingController.RebindDisplayRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 20, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerTemplateController.SaveCurrentHtmlAsTemplateRequest": { "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "description": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerTemplateController.SaveHtmlTemplateRequest": { "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "description": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "html": { "type": "string", "nullable": true }, "sourceProfileId": { "maxLength": 64, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerTemplateController.ShareHtmlTemplateRequest": { "type": "object", "properties": { "groupType": { "maxLength": 64, "minLength": 0, "type": "string", "nullable": true }, "groupId": { "maxLength": 64, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.OwnerTemplateController.UpdateHtmlTemplateRequest": { "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "description": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "html": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.PendingContentSlotDto": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "versionId": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "submittedAt": { "type": "string", "format": "date-time", "nullable": true }, "submittedByUserId": { "type": "string", "nullable": true }, "submittedByApiKeyId": { "type": "string", "nullable": true }, "previewUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.ReactivateSubscriptionRequest": { "type": "object", "properties": { "subscriptionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.RejectPendingRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.SaveEntryRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "templateId": { "type": "string", "nullable": true }, "htmlFileName": { "type": "string", "nullable": true }, "contentUrl": { "type": "string", "nullable": true }, "startTime": { "type": "string", "nullable": true }, "endTime": { "type": "string", "nullable": true }, "daysOfWeek": { "$ref": "#/components/schemas/Screen.Shared.Models.DaysOfWeek" }, "validFrom": { "type": "string", "nullable": true }, "validUntil": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.SaveScheduleRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.SetWebhookActiveRequest": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "additionalProperties": false }, "Screen.Central.Controllers.SourceLockRequest": { "type": "object", "properties": { "apiKeyId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.SourceLockResponse": { "type": "object", "properties": { "displayId": { "type": "string", "nullable": true }, "restrictedToApiKeyId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.UpdateDisplayQuantityRequest": { "type": "object", "properties": { "quantity": { "type": "integer", "format": "int32" }, "subscriptionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.UserCategoryGrantsController.CreateGrantRequest": { "required": [ "accessLevel", "categoryId", "granteeUserId" ], "type": "object", "properties": { "categoryId": { "maxLength": 64, "minLength": 0, "type": "string" }, "includeDescendants": { "type": "boolean" }, "granteeUserId": { "maxLength": 200, "minLength": 0, "type": "string" }, "accessLevel": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "Screen.Central.Controllers.UserCategoryGrantsController.UserCategoryGrantDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "granteeUserId": { "type": "string", "nullable": true }, "categoryId": { "type": "string", "nullable": true }, "categoryName": { "type": "string", "nullable": true }, "categoryPath": { "type": "string", "nullable": true }, "scope": { "type": "string", "nullable": true }, "orgId": { "type": "string", "nullable": true }, "ownerUserId": { "type": "string", "nullable": true }, "includeDescendants": { "type": "boolean" }, "accessLevel": { "type": "string", "nullable": true }, "grantedByUserId": { "type": "string", "nullable": true }, "grantedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Screen.Central.Controllers.WebhookListResponse": { "type": "object", "properties": { "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/Screen.Central.Controllers.WebhookSubscriptionDto" }, "nullable": true } }, "additionalProperties": false }, "Screen.Central.Controllers.WebhookSubscriptionDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "eventPattern": { "type": "string", "nullable": true }, "secretPrefix": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "lastTriggeredAt": { "type": "string", "format": "date-time", "nullable": true }, "lastSuccessAt": { "type": "string", "format": "date-time", "nullable": true }, "lastFailureAt": { "type": "string", "format": "date-time", "nullable": true }, "lastFailureMessage": { "type": "string", "nullable": true }, "consecutiveFailures": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Screen.Central.Services.Store.AgentArtifactSummary": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "kind": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "sizeBytes": { "type": "integer", "format": "int32" }, "label": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Screen.Shared.Models.DaysOfWeek": { "enum": [ 0, 1, 2, 4, 8, 16, 31, 32, 64, 96, 127 ], "type": "integer", "format": "int32" } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Bearer token returned by the agent session flow.", "scheme": "Bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "ActivityAudit" }, { "name": "DisplayCategories" }, { "name": "Owner" }, { "name": "OwnerAgentArtifacts" }, { "name": "OwnerBilling" }, { "name": "OwnerCategoryBroadcast" }, { "name": "OwnerContent" }, { "name": "OwnerDisplayApproval" }, { "name": "OwnerDisplaySettings" }, { "name": "OwnerDisplaySourceLock" }, { "name": "OwnerPairing" }, { "name": "OwnerSchedule" }, { "name": "OwnerTemplate" }, { "name": "UserCategoryGrants" }, { "name": "Webhook" } ] }