{ "openapi": "3.1.0", "info": { "title": "Yay! Forms", "version": "0.0.1", "description": "API Endpoints" }, "servers": [ { "url": "https://api.yayforms.com", "description": "API" } ], "security": [ { "http": [] } ], "paths": { "/forms/{form}/ai-chat/init": { "get": { "operationId": "forms.ai-chat.init", "tags": [ "AiChat" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/forms/{form}/ai-chat": { "post": { "operationId": "forms.ai-chat", "tags": [ "AiChat" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiChatRequest" } } } }, "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } }, "required": [ "data" ] }, { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": {} }, { "type": "object" } ] } }, "required": [ "data" ] } ] } }, "text/event-stream": { "schema": { "type": "string" } } }, "headers": { "Transfer-Encoding": { "required": true, "schema": { "type": "string", "enum": [ "chunked" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/forms/{form}/ai-chat/feedback": { "post": { "operationId": "forms.ai-chat.feedback", "tags": [ "AiChat" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiChatFeedbackRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/responses/{response}/answers": { "get": { "operationId": "response.answers.index", "tags": [ "Answer" ], "parameters": [ { "name": "response", "in": "path", "required": true, "description": "The response ID", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "order", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "asc", "desc" ] } }, { "name": "orderBy", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "title", "created_at", "updated_at" ] } }, { "name": "startsAt", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "endsAt", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "draft", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "others", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "related", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "device", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "desktop", "mobile", "tablet", "unknown" ] } }, { "name": "keywords", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "classifications", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "keyphrases", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "sentiments", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "emotions", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "options", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "`AnswerCollection`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AnswerCollection" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/responses/{response}/card": { "get": { "operationId": "response.card.show", "tags": [ "Card" ], "parameters": [ { "name": "response", "in": "path", "required": true, "description": "The response ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`CardResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CardResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "put": { "operationId": "response.card.upsert", "tags": [ "Card" ], "parameters": [ { "name": "response", "in": "path", "required": true, "description": "The response ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardUpsertRequest" } } } }, "responses": { "200": { "description": "`CardResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CardResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/workspaces/{workspace}/credentials": { "get": { "operationId": "workspaces.credentials.index", "tags": [ "Credential" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "order", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Paginated set of `CredentialListResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CredentialCollection" }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/forms/{form}/fields": { "get": { "operationId": "forms.fields.index", "tags": [ "Field" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string" } }, { "name": "draft", "in": "query", "schema": { "type": [ "boolean", "null" ] } } ], "responses": { "200": { "description": "`FieldCollection`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FieldCollection" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "post": { "operationId": "forms.fields.store", "tags": [ "Field" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldStoreRequest" } } } }, "responses": { "200": { "description": "`FieldResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FieldResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/fields/{field}": { "get": { "operationId": "fields.show", "tags": [ "Field" ], "parameters": [ { "name": "field", "in": "path", "required": true, "description": "The field ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`FieldResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FieldResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "put": { "operationId": "fields.update", "tags": [ "Field" ], "parameters": [ { "name": "field", "in": "path", "required": true, "description": "The field ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldUpdateRequest" } } } }, "responses": { "200": { "description": "`FieldResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FieldResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "delete": { "operationId": "fields.destroy", "tags": [ "Field" ], "parameters": [ { "name": "field", "in": "path", "required": true, "description": "The field ID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/workspaces/{workspace}/forms": { "get": { "operationId": "workspaces.forms.index", "tags": [ "Form" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "order", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "asc", "desc" ] } }, { "name": "orderBy", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "title", "created_at", "updated_at" ] } }, { "name": "folderId", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "search", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 100 } } ], "responses": { "200": { "description": "Paginated set of `FormListResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FormCollection" }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "post": { "operationId": "workspaces.forms.store", "tags": [ "Form" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormStoreRequest" } } } }, "responses": { "200": { "description": "`FormResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FormResource" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/forms/{form}": { "get": { "operationId": "forms.show", "tags": [ "Form" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`FormResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FormResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "put": { "operationId": "forms.update", "tags": [ "Form" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormUpdateRequest" } } } }, "responses": { "200": { "description": "`FormResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FormResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "delete": { "operationId": "forms.destroy", "tags": [ "Form" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/forms/{form}/integrations": { "get": { "operationId": "forms.integrations.index", "tags": [ "Integration" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string" } }, { "name": "order", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "`IntegrationCollection`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/IntegrationCollection" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/integrations/{integration}/logs": { "get": { "operationId": "integration.logs", "tags": [ "IntegrationLog" ], "parameters": [ { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "order", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Paginated set of `IntegrationLogSummaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/IntegrationLogCollection" }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/integration-logs/{integrationLog}": { "get": { "operationId": "integration.logs.show", "tags": [ "IntegrationLog" ], "parameters": [ { "name": "integrationLog", "in": "path", "required": true, "description": "The integration log ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`IntegrationLogResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/IntegrationLogResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/workspaces/{workspace}/medias": { "get": { "operationId": "workspaces.medias.index", "tags": [ "Media" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "order", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Paginated set of `MediaListResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaCollection" }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "post": { "operationId": "workspaces.medias.store", "tags": [ "Media" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MediaStoreRequest" } } } }, "responses": { "200": { "description": "`MediaResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/medias/{media}": { "get": { "operationId": "medias.show", "tags": [ "Media" ], "parameters": [ { "name": "media", "in": "path", "required": true, "description": "The media ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`MediaResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "delete": { "operationId": "medias.destroy", "tags": [ "Media" ], "parameters": [ { "name": "media", "in": "path", "required": true, "description": "The media ID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/forms/{form}/responses": { "get": { "operationId": "forms.responses.index", "tags": [ "Response" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Page size. Defaults to 1000 when omitted (100 when options=test; ignored when options=answer).", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 20000 } }, { "name": "page", "in": "query", "description": "1-based page number.", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "paginationToken", "in": "query", "description": "Opaque cursor from a previous response (nextPaginationToken); takes precedence over page. Only valid without options.", "schema": { "type": [ "string", "null" ] } }, { "name": "order", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "asc", "desc" ] } }, { "name": "options", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "answer", "test" ] } } ], "responses": { "200": { "description": "`ResponseAnswerCollection`\n\n`ResponseCollection`\n\n`ResponseGridCollection`", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "description": "Proxied grid page (default mode, no options).", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextPaginationToken": { "type": [ "string", "null" ], "description": "Cursor for the next page; null when there are no more results. Send it back as paginationToken." }, "page": { "type": "integer" }, "pageSize": { "type": "integer" } }, "required": [ "data" ] }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ResponseAnswerCollection" } }, "required": [ "data" ] }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ResponseCollection" } }, "required": [ "data" ] }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ResponseGridCollection" } }, "required": [ "data" ] } ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/responses/{response}": { "get": { "operationId": "responses.show", "tags": [ "Response" ], "parameters": [ { "name": "response", "in": "path", "required": true, "description": "The response ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`ResponseResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ResponseResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "delete": { "operationId": "responses.destroy", "tags": [ "Response" ], "parameters": [ { "name": "response", "in": "path", "required": true, "description": "The response ID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/forms/{form}/stats": { "get": { "operationId": "forms.stats", "tags": [ "Stat" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string" } }, { "name": "startsAt", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } }, { "name": "endsAt", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } }, { "name": "device", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "desktop", "mobile", "tablet", "unknown" ] } } ], "responses": { "200": { "description": "`StatResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StatResource" } }, "required": [ "data" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/statements": { "get": { "operationId": "statements.index", "tags": [ "Statement" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "order", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Paginated set of `StatementResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StatementCollection" }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/workspaces/{workspace}/themes": { "get": { "operationId": "workspaces.themes.index", "tags": [ "Theme" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "order", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Paginated set of `ThemeResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ThemeCollection" }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "post": { "operationId": "workspaces.themes.store", "tags": [ "Theme" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeStoreRequest" } } } }, "responses": { "200": { "description": "`ThemeResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ThemeResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/themes/{theme}": { "get": { "operationId": "themes.show", "tags": [ "Theme" ], "parameters": [ { "name": "theme", "in": "path", "required": true, "description": "The theme ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`ThemeResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ThemeResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "put": { "operationId": "themes.update", "tags": [ "Theme" ], "parameters": [ { "name": "theme", "in": "path", "required": true, "description": "The theme ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeUpdateRequest" } } } }, "responses": { "200": { "description": "`ThemeResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ThemeResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "delete": { "operationId": "themes.destroy", "tags": [ "Theme" ], "parameters": [ { "name": "theme", "in": "path", "required": true, "description": "The theme ID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/misc/timezones": { "get": { "operationId": "timezones.index", "tags": [ "Timezone" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "anyOf": [ { "type": "null" }, { "type": "array", "items": {} }, { "type": "string" } ] } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/lookup/{entityId}/user": { "get": { "operationId": "internal.lookup.user", "tags": [ "User" ], "parameters": [ { "name": "entityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "anyOf": [ { "type": "null" }, { "type": "array", "items": {} }, { "type": "string" } ] } }, "required": [ "message" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "anyOf": [ { "type": "array", "items": {} }, { "type": "array", "prefixItems": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Entity not found." } }, "required": [ "message" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } ] } }, "required": [ "errors" ] } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "anyOf": [ { "type": "array", "items": {} }, { "type": "array", "prefixItems": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Invalid ObjectId format." } }, "required": [ "message" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } ] } }, "required": [ "errors" ] } } } } } } }, "/users/{user}": { "put": { "operationId": "users.update", "tags": [ "User" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateRequest" } } } }, "responses": { "200": { "description": "`UserResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserResource" } }, "required": [ "data" ] } } } }, "424": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "anyOf": [ { "type": "array", "items": {} }, { "type": "array", "prefixItems": [ { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } ] } }, "required": [ "errors" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "delete": { "operationId": "users.destroy", "tags": [ "User" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/workspaces/{workspace}/users": { "get": { "operationId": "workspaces.users.index", "tags": [ "UserWorkspace" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "order", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "asc", "desc" ] } }, { "name": "related", "in": "query", "schema": { "type": [ "boolean", "null" ] } } ], "responses": { "200": { "description": "Paginated set of `UserListResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserCollection" }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/workspaces": { "get": { "operationId": "workspaces.index", "tags": [ "Workspace" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "order", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "asc", "desc" ] } }, { "name": "orderBy", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "options", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "Paginated set of `WorkspaceResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WorkspaceCollection" }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "post": { "operationId": "workspaces.store", "tags": [ "Workspace" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceStoreRequest" } } } }, "responses": { "200": { "description": "`WorkspaceResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WorkspaceResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/workspaces/{workspace}": { "get": { "operationId": "workspaces.show", "tags": [ "Workspace" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`WorkspaceResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WorkspaceResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "put": { "operationId": "workspaces.update", "tags": [ "Workspace" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUpdateRequest" } } } }, "responses": { "200": { "description": "`WorkspaceResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WorkspaceResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "delete": { "operationId": "workspaces.destroy", "tags": [ "Workspace" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/workspaces/{workspace}/folders": { "post": { "operationId": "workspaces.folders.store", "tags": [ "WorkspaceFolder" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "parentId": { "type": [ "string", "null" ] } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "anyOf": [ { "type": "null" }, { "type": "array", "items": {} }, { "type": "string" } ] } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/workspaces/{workspace}/folders/{folderId}": { "put": { "operationId": "workspaces.folders.update", "tags": [ "WorkspaceFolder" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } }, { "name": "folderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "parentId": { "type": [ "string", "null" ] } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "anyOf": [ { "type": "null" }, { "type": "array", "items": {} }, { "type": "string" } ] } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "delete": { "operationId": "workspaces.folders.destroy", "tags": [ "WorkspaceFolder" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace ID", "schema": { "type": "string" } }, { "name": "folderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "422": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "anyOf": [ { "type": "array", "items": {} }, { "type": "array", "prefixItems": [ { "type": "object", "properties": { "message": { "anyOf": [ { "type": "null" }, { "type": "array", "items": {} }, { "type": "string" } ] } }, "required": [ "message" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } ] } }, "required": [ "errors" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } } }, "components": { "securitySchemes": { "http": { "type": "http", "scheme": "bearer" } }, "schemas": { "AiChatFeedbackRequest": { "type": "object", "properties": { "message_id": { "type": "string" }, "type": { "type": "string", "enum": [ "positive", "negative" ] }, "category": { "type": [ "string", "null" ] }, "comment": { "type": [ "string", "null" ], "maxLength": 2000 } }, "required": [ "message_id", "type" ], "title": "AiChatFeedbackRequest" }, "AiChatRequest": { "type": "object", "properties": { "instruction": { "type": [ "string", "null" ], "maxLength": 10000 }, "mode": { "type": "string", "enum": [ "auto", "action", "plan", "chat" ] }, "conversation_id": { "type": [ "string", "null" ] }, "execute_plan": { "type": "boolean" }, "step_index": { "type": "integer", "minimum": 0 }, "agent": { "type": "string", "enum": [ "form-edit", "integration-config", "response-analysis" ] }, "agent_meta": { "type": "array", "items": { "type": "string" } }, "blocked_operations": { "type": "array", "items": { "type": "string" } }, "plan": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" } } } } }, "title": "AiChatRequest" }, "AnswerCollection": { "type": "array", "items": { "$ref": "#/components/schemas/AnswerResource" }, "title": "AnswerCollection" }, "AnswerResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "responseId": { "type": [ "string", "null" ] }, "fieldId": { "type": [ "string", "null" ] }, "field": { "type": [ "string", "null" ] }, "fieldTitle": { "type": "string" }, "fieldPlainTitle": { "type": "string" }, "fieldDescription": { "type": "string" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } ] }, "keywords": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "keyphrases": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "sentimentAnalysis": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "emotionAnalysis": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "classifications": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "answeredAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] } }, "required": [ "id", "userId", "responseId", "fieldId", "field", "fieldTitle", "fieldPlainTitle", "fieldDescription", "content", "keywords", "keyphrases", "sentimentAnalysis", "emotionAnalysis", "classifications", "answeredAt", "createdAt", "updatedAt", "deletedAt" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": [ "string", "null" ] }, "fieldId": { "type": [ "string", "null" ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } ] }, "answeredAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] } }, "required": [ "id", "userId", "fieldId", "content", "answeredAt" ] } ], "title": "AnswerResource" }, "CardResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "stageId": { "type": "string" }, "stages": { "type": "array", "items": {} }, "assigneeId": { "type": "string" }, "assignees": { "type": "array", "items": {} }, "labels": { "type": "string" }, "comments": { "type": "array", "items": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "stageId", "stages", "assigneeId", "assignees", "labels", "comments", "createdAt", "updatedAt" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ], "title": "CardResource" }, "CardUpsertRequest": { "type": "object", "properties": { "stageId": { "type": [ "string", "null" ], "enum": [ "" ] }, "assigneeId": { "type": [ "string", "null" ], "enum": [ "" ] }, "labels": { "type": [ "array", "null" ], "description": "Labels ops for the card: add/remove/reorder, ids must exist on form kanban labels", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "add", "remove", "reorder" ] }, "id": { "type": "string", "enum": [ "" ] }, "orderedIds": { "type": "array", "items": { "type": "string", "enum": [ "" ] } } }, "required": [ "action" ] } }, "comments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "add", "update", "delete" ] }, "id": { "type": [ "string", "null" ] }, "content": { "type": [ "string", "null" ], "minLength": 1 } }, "required": [ "action" ] } } }, "title": "CardUpsertRequest" }, "CredentialCollection": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialListResource" }, "title": "CredentialCollection" }, "CredentialListResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "providerId": { "type": "string" }, "provider": { "type": "string" }, "avatar": { "type": "string" }, "isActive": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] } }, "required": [ "id", "userId", "workspaceId", "name", "providerId", "provider", "avatar", "isActive", "expiresAt", "createdAt", "updatedAt", "deletedAt" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ], "title": "CredentialListResource" }, "CurrencyAlpha3": { "type": "string", "enum": [ "XUA", "AFN", "DZD", "XAD", "ARS", "AMD", "AWG", "AUD", "AZN", "BSD", "BHD", "THB", "PAB", "BBD", "BYN", "BZD", "BMD", "VED", "VES", "BOB", "XBA", "XBB", "XBD", "XBC", "BRL", "BND", "BIF", "XOF", "XAF", "XPF", "CVE", "CAD", "XCG", "KYD", "CLP", "XTS", "COP", "KMF", "CDF", "BAM", "NIO", "CRC", "CUP", "CZK", "GMD", "DKK", "MKD", "DJF", "STN", "DOP", "VND", "XCD", "EGP", "SVC", "ETB", "EUR", "FKP", "FJD", "HUF", "GHS", "GIP", "XAU", "HTG", "PYG", "GNF", "GYD", "HKD", "UAH", "ISK", "INR", "IRR", "IQD", "JMD", "JOD", "KES", "PGK", "KWD", "AOA", "MMK", "LAK", "GEL", "LBP", "ALL", "HNL", "SLE", "LRD", "LYD", "SZL", "LSL", "MGA", "MWK", "MYR", "MUR", "MXN", "MXV", "MDL", "MAD", "MZN", "BOV", "NGN", "ERN", "NAD", "NPR", "ILS", "TWD", "NZD", "BTN", "KPW", "NOK", "MRU", "TOP", "PKR", "XPD", "MOP", "UYU", "PHP", "XPT", "GBP", "BWP", "QAR", "GTQ", "ZAR", "OMR", "KHR", "RON", "MVR", "IDR", "RUB", "RWF", "XDR", "SHP", "SAR", "RSD", "SCR", "XAG", "SGD", "PEN", "SBD", "KGS", "SOS", "TJS", "SSP", "LKR", "XSU", "SDG", "SRD", "SEK", "CHF", "SYP", "BDT", "WST", "TZS", "KZT", "XXX", "TTD", "MNT", "TND", "TRY", "TMT", "AED", "USD", "USN", "UGX", "UYW", "CLF", "COU", "UYI", "UZS", "VUV", "CHE", "CHW", "KRW", "YER", "JPY", "CNY", "ZMW", "ZWG", "PLN", "BGN", "HRK", "SLL", "ANG", "CUC", "ZWL" ], "title": "CurrencyAlpha3" }, "FieldCollection": { "type": "array", "items": { "$ref": "#/components/schemas/FieldResource" }, "title": "FieldCollection" }, "FieldResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": [ "string", "null" ] }, "formId": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "position": { "type": [ "integer", "null" ] }, "title": { "type": [ "string", "null" ] }, "plainTitle": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "isKeywordExtractionEnabled": { "type": "boolean" }, "isTextAnalysisEnabled": { "type": "boolean" }, "isTextClassificationEnabled": { "type": "boolean" }, "metadata": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "settings": { "type": "string" }, "options": { "type": "string" }, "required": { "type": [ "string", "null" ] }, "logic": { "type": [ "string", "null" ] }, "stats": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "views": { "type": [ "integer", "null" ] }, "answers": { "type": [ "integer", "null" ] }, "dropOff": { "type": [ "integer", "null" ] }, "layout": { "type": [ "string", "null" ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] } }, "required": [ "id", "userId", "formId", "type", "position", "title", "plainTitle", "description", "isKeywordExtractionEnabled", "isTextAnalysisEnabled", "isTextClassificationEnabled", "metadata", "settings", "options", "required", "logic", "stats", "summary", "views", "answers", "dropOff", "layout", "createdAt", "updatedAt", "deletedAt" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": [ "string", "null" ] }, "formId": { "type": [ "string", "null" ] }, "type": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "position": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "integer" } ] }, "title": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "plainTitle": { "type": [ "string", "null" ] }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "isKeywordExtractionEnabled": { "type": "boolean" }, "isTextAnalysisEnabled": { "type": "boolean" }, "isTextClassificationEnabled": { "type": "boolean" }, "metadata": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "settings": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "options": { "type": [ "string", "null" ] }, "required": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "logic": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "stats": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "views": { "type": [ "integer", "null" ] }, "answers": { "type": [ "integer", "null" ] }, "dropOff": { "type": [ "integer", "null" ] }, "layout": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string" } }, "required": [ "id", "userId", "formId", "type", "position", "title", "plainTitle", "description", "isKeywordExtractionEnabled", "isTextAnalysisEnabled", "isTextClassificationEnabled", "metadata", "settings", "options", "required", "logic", "stats", "summary", "views", "answers", "dropOff", "layout", "createdAt", "updatedAt", "deletedAt" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "formId": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "position": { "type": [ "integer", "null" ] }, "title": { "type": [ "string", "null" ] }, "plainTitle": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "settings": { "type": "string" }, "options": { "type": "string" }, "required": { "type": [ "string", "null" ] }, "logic": { "type": [ "string", "null" ] }, "layout": { "type": [ "string", "null" ] } }, "required": [ "id", "formId", "type", "position", "title", "plainTitle", "description", "settings", "options", "required", "logic", "layout" ] } ], "title": "FieldResource" }, "FieldStoreRequest": { "type": "object", "properties": { "cloneFieldId": { "type": [ "string", "null" ] }, "type": { "type": "string" }, "position": { "type": [ "integer", "null" ] }, "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "metadata": { "type": [ "array", "null" ], "items": { "type": "string" } }, "options": { "type": [ "string", "null" ] }, "settings": { "type": [ "array", "null" ], "items": { "type": "string" } }, "required": { "type": [ "boolean", "null" ] }, "logic": { "type": [ "array", "null" ], "items": { "type": "string" } }, "layout": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "title": "FieldStoreRequest" }, "FieldUpdateRequest": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "position": { "type": [ "integer", "null" ] }, "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "metadata": { "type": [ "array", "null" ], "items": { "type": "string" } }, "options": { "type": [ "string", "null" ] }, "settings": { "type": [ "array", "null" ], "items": { "type": "string" } }, "required": { "type": [ "boolean", "null" ] }, "logic": { "type": [ "array", "null" ], "items": { "type": "string" } }, "layout": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "title": "FieldUpdateRequest" }, "FormCollection": { "type": "array", "items": { "$ref": "#/components/schemas/FormListResource" }, "title": "FormCollection" }, "FormListResource": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "title": { "type": "string" }, "theme": { "$ref": "#/components/schemas/ThemeResource" }, "folderId": { "type": "string" }, "sentResponses": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "key", "title", "theme", "folderId", "sentResponses", "status" ], "title": "FormListResource" }, "FormResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": [ "string", "null" ] }, "workspaceId": { "type": [ "string", "null" ] }, "folderId": { "type": "string" }, "workspaceSubdomain": { "type": "string" }, "language": { "type": [ "string", "null" ] }, "theme": { "$ref": "#/components/schemas/ThemeResource" }, "key": { "type": [ "string", "null" ] }, "importFormKey": { "type": "string" }, "customKey": { "type": "string" }, "hiddenFields": { "type": "string" }, "variables": { "type": [ "string", "null" ] }, "elementNames": { "type": "object", "description": "The rule the editor judges a new variable or hidden field name with: trimmed and lower-cased, then matching the pattern of its kind, within its maxLength, and none of the reserved names.", "properties": { "variable": { "type": "object", "properties": { "pattern": { "type": "string" }, "maxLength": { "type": "null" } }, "required": [ "pattern", "maxLength" ] }, "hiddenField": { "type": "object", "properties": { "pattern": { "type": "string" }, "maxLength": { "type": "integer" } }, "required": [ "pattern", "maxLength" ] }, "reserved": { "type": "array", "items": { "type": "string" } }, "normalize": { "type": "array", "items": { "type": "string" } } }, "required": [ "variable", "hiddenField", "reserved", "normalize" ] }, "tracking": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "fullTitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "metadata": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "metaTags": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "settings": { "type": "string" }, "webhookUrl": { "type": "string" }, "status": { "type": [ "integer", "null" ] }, "kanban": { "type": [ "string", "null" ] }, "isDirty": { "type": "boolean" }, "allResponses": { "type": "string" }, "sentResponses": { "type": "string" }, "draftResponses": { "type": "string" }, "responsesLimit": { "type": [ "integer", "null" ] }, "closedMessage": { "type": [ "string", "null" ] }, "publishedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "closedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "labels": { "type": "object", "properties": { "enterKey": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "shiftKey": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ok": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "continue": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "skip": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "pressEnter": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "multipleChoiceHelpText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "multipleChoiceHelpTextSingle": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "otherPrompt": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "submitText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "longTextHelpText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "prev": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "percentCompleted": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "invalidPrompt": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "thankYouText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "successText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaOk": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaRequired": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaPrev": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaNext": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaSubmitText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaMultipleChoice": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaTypeAnswer": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "errorAllowedFileTypes": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "errorMaxFileSize": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "errorMinFiles": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "errorMaxFiles": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "invalidEmail": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "invalidDate": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "invalidPhone": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "month": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "day": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "year": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "yes": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "no": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "poweredBy": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "dropdownPlaceholder": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "fileUploadPlaceholder": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "fileUploadSizeLimit": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] } }, "required": [ "enterKey", "shiftKey", "ok", "continue", "skip", "pressEnter", "multipleChoiceHelpText", "multipleChoiceHelpTextSingle", "otherPrompt", "placeholder", "submitText", "longTextHelpText", "prev", "next", "percentCompleted", "invalidPrompt", "thankYouText", "successText", "ariaOk", "ariaRequired", "ariaPrev", "ariaNext", "ariaSubmitText", "ariaMultipleChoice", "ariaTypeAnswer", "errorAllowedFileTypes", "errorMaxFileSize", "errorMinFiles", "errorMaxFiles", "invalidEmail", "invalidDate", "invalidPhone", "month", "day", "year", "yes", "no", "start", "poweredBy", "dropdownPlaceholder", "fileUploadPlaceholder", "fileUploadSizeLimit" ] } }, "required": [ "id", "userId", "workspaceId", "folderId", "workspaceSubdomain", "language", "theme", "key", "importFormKey", "customKey", "hiddenFields", "variables", "elementNames", "tracking", "title", "fullTitle", "description", "metadata", "metaTags", "settings", "webhookUrl", "status", "kanban", "isDirty", "allResponses", "sentResponses", "draftResponses", "responsesLimit", "closedMessage", "publishedAt", "closedAt", "createdAt", "updatedAt", "deletedAt", "labels" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": [ "string", "null" ] }, "workspaceId": { "type": [ "string", "null" ] }, "folderId": { "type": "string" }, "workspaceSubdomain": { "type": "string" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "theme": { "$ref": "#/components/schemas/ThemeResource" }, "key": { "type": [ "string", "null" ] }, "importFormKey": { "type": "string" }, "customKey": { "type": "string" }, "hiddenFields": { "type": "string" }, "variables": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "elementNames": { "type": "object", "description": "The rule the editor judges a new variable or hidden field name with: trimmed and lower-cased, then matching the pattern of its kind, within its maxLength, and none of the reserved names.", "properties": { "variable": { "type": "object", "properties": { "pattern": { "type": "string" }, "maxLength": { "type": "null" } }, "required": [ "pattern", "maxLength" ] }, "hiddenField": { "type": "object", "properties": { "pattern": { "type": "string" }, "maxLength": { "type": "integer" } }, "required": [ "pattern", "maxLength" ] }, "reserved": { "type": "array", "items": { "type": "string" } }, "normalize": { "type": "array", "items": { "type": "string" } } }, "required": [ "variable", "hiddenField", "reserved", "normalize" ] }, "tracking": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "fullTitle": { "type": [ "string", "null" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metadata": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "metaTags": { "type": "string" }, "settings": { "type": "string" }, "webhookUrl": { "type": "string" }, "kanban": { "type": [ "string", "null" ] }, "isDirty": { "type": "boolean" }, "allResponses": { "type": [ "integer", "null" ] }, "sentResponses": { "type": [ "integer", "null" ] }, "draftResponses": { "type": [ "integer", "null" ] }, "responsesLimit": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "closedMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publishedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "closedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "labels": { "type": "object", "properties": { "enterKey": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "shiftKey": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ok": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "continue": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "skip": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "pressEnter": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "multipleChoiceHelpText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "multipleChoiceHelpTextSingle": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "otherPrompt": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "submitText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "longTextHelpText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "prev": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "percentCompleted": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "invalidPrompt": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "thankYouText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "successText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaOk": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaRequired": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaPrev": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaNext": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaSubmitText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaMultipleChoice": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaTypeAnswer": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "errorAllowedFileTypes": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "errorMaxFileSize": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "errorMinFiles": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "errorMaxFiles": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "invalidEmail": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "invalidDate": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "invalidPhone": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "month": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "day": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "year": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "yes": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "no": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "poweredBy": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "dropdownPlaceholder": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "fileUploadPlaceholder": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "fileUploadSizeLimit": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] } }, "required": [ "enterKey", "shiftKey", "ok", "continue", "skip", "pressEnter", "multipleChoiceHelpText", "multipleChoiceHelpTextSingle", "otherPrompt", "placeholder", "submitText", "longTextHelpText", "prev", "next", "percentCompleted", "invalidPrompt", "thankYouText", "successText", "ariaOk", "ariaRequired", "ariaPrev", "ariaNext", "ariaSubmitText", "ariaMultipleChoice", "ariaTypeAnswer", "errorAllowedFileTypes", "errorMaxFileSize", "errorMinFiles", "errorMaxFiles", "invalidEmail", "invalidDate", "invalidPhone", "month", "day", "year", "yes", "no", "start", "poweredBy", "dropdownPlaceholder", "fileUploadPlaceholder", "fileUploadSizeLimit" ] } }, "required": [ "id", "userId", "workspaceId", "folderId", "workspaceSubdomain", "language", "theme", "key", "importFormKey", "customKey", "hiddenFields", "variables", "elementNames", "tracking", "title", "fullTitle", "description", "metadata", "metaTags", "settings", "webhookUrl", "kanban", "isDirty", "allResponses", "sentResponses", "draftResponses", "responsesLimit", "closedMessage", "publishedAt", "closedAt", "createdAt", "updatedAt", "deletedAt", "labels" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "language": { "type": [ "string", "null" ] }, "theme": { "$ref": "#/components/schemas/ThemeResource" }, "key": { "type": [ "string", "null" ] }, "customKey": { "type": "string" }, "hiddenFields": { "type": "string" }, "settings": { "type": "string" }, "variables": { "type": [ "string", "null" ] }, "tracking": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "status": { "type": [ "integer", "null" ] }, "kanban": { "type": [ "string", "null" ] }, "integrations": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "labels": { "type": "object", "properties": { "enterKey": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "shiftKey": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ok": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "continue": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "skip": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "pressEnter": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "multipleChoiceHelpText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "multipleChoiceHelpTextSingle": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "otherPrompt": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "submitText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "longTextHelpText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "prev": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "percentCompleted": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "invalidPrompt": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "thankYouText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "successText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaOk": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaRequired": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaPrev": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaNext": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaSubmitText": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaMultipleChoice": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "ariaTypeAnswer": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "errorAllowedFileTypes": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "errorMaxFileSize": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "errorMinFiles": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "errorMaxFiles": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "invalidEmail": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "invalidDate": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "invalidPhone": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "month": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "day": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "year": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "yes": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "no": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "poweredBy": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "dropdownPlaceholder": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "fileUploadPlaceholder": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] }, "fileUploadSizeLimit": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "array", "items": {} } ] } }, "required": [ "enterKey", "shiftKey", "ok", "continue", "skip", "pressEnter", "multipleChoiceHelpText", "multipleChoiceHelpTextSingle", "otherPrompt", "placeholder", "submitText", "longTextHelpText", "prev", "next", "percentCompleted", "invalidPrompt", "thankYouText", "successText", "ariaOk", "ariaRequired", "ariaPrev", "ariaNext", "ariaSubmitText", "ariaMultipleChoice", "ariaTypeAnswer", "errorAllowedFileTypes", "errorMaxFileSize", "errorMinFiles", "errorMaxFiles", "invalidEmail", "invalidDate", "invalidPhone", "month", "day", "year", "yes", "no", "start", "poweredBy", "dropdownPlaceholder", "fileUploadPlaceholder", "fileUploadSizeLimit" ] } }, "required": [ "id", "language", "theme", "key", "customKey", "hiddenFields", "settings", "variables", "tracking", "title", "description", "status", "kanban", "integrations", "labels" ] } ], "title": "FormResource" }, "FormStoreRequest": { "type": "object", "properties": { "cloneFormId": { "type": [ "string", "null" ] }, "formSubject": { "type": [ "string", "null" ] }, "importFormKey": { "type": [ "string", "null" ] }, "createWelcomeScreen": { "type": [ "boolean", "null" ] }, "createEndingScreen": { "type": [ "boolean", "null" ] }, "themeId": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "metadata": { "type": [ "array", "null" ], "items": { "type": "string" } }, "metaTags": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": "string" } }, "language": { "type": [ "string", "null" ], "enum": [ "en", "pt", "es" ], "minLength": 2, "maxLength": 5 }, "labels": { "type": [ "array", "null" ], "items": { "type": "string" } }, "hiddenFields": { "type": [ "array", "null" ], "items": { "type": "string" } }, "variables": { "type": [ "array", "null" ], "items": { "type": "string" } }, "tracking": { "type": [ "array", "null" ], "items": { "type": "string" } }, "responseLimit": { "type": [ "integer", "null" ] }, "closedMessage": { "type": [ "string", "null" ] }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "closedAt": { "type": [ "string", "null" ], "format": "date-time" }, "folderId": { "type": [ "string", "null" ] } }, "title": "FormStoreRequest" }, "FormUpdateRequest": { "type": "object", "properties": { "workspaceId": { "type": [ "string", "null" ] }, "folderId": { "type": [ "string", "null" ] }, "themeId": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "metadata": { "type": [ "array", "null" ], "items": { "type": "string" } }, "metaTags": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": "string" } }, "language": { "type": [ "string", "null" ], "enum": [ "en", "pt", "es" ], "minLength": 2, "maxLength": 5 }, "labels": { "type": [ "array", "null" ], "items": { "type": "string" } }, "hiddenFields": { "type": [ "array", "null" ], "items": { "type": "string" } }, "variables": { "type": [ "array", "null" ], "items": { "type": "string" } }, "tracking": { "type": [ "array", "null" ], "items": { "type": "string" } }, "customKey": { "type": [ "string", "null" ] }, "responseLimit": { "type": [ "integer", "null" ] }, "closedMessage": { "type": [ "string", "null" ] }, "action": { "type": [ "string", "null" ], "enum": [ "publish", "discard", "export" ] }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "closedAt": { "type": [ "string", "null" ], "format": "date-time" }, "force": { "type": [ "boolean", "null" ] }, "kanban": { "type": "object", "description": "Kanban operations pattern (similar to comments.*.action)", "properties": { "stages": { "type": [ "array", "null" ], "description": "Kanban Stages ops", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "add", "update", "delete", "reorder" ] }, "id": { "type": "string", "enum": [ "" ] }, "title": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 100 }, "orderedIds": { "type": "array", "description": "For reorder action, accept only camelCase orderedIds", "items": { "type": "string" } } }, "required": [ "action", "id" ] } }, "fields": { "type": [ "array", "null" ], "description": "Kanban Fields ops", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "add", "remove", "reorder" ] }, "id": { "type": [ "string", "null" ] }, "orderedIds": { "type": "array", "description": "For fields reorder, accept only camelCase orderedIds", "items": { "type": "string" } } }, "required": [ "action" ] } }, "assignees": { "type": [ "array", "null" ], "description": "Kanban Assignees ops", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "add", "remove" ] }, "id": { "type": "string", "enum": [ "" ] } }, "required": [ "action", "id" ] } }, "links": { "type": [ "array", "null" ], "description": "Kanban Links ops", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "add", "update", "delete", "reorder" ] }, "id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 100 }, "url": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 500 }, "orderedIds": { "type": "array", "description": "For links reorder, accept only camelCase orderedIds", "items": { "type": "string" } } }, "required": [ "action" ] } }, "notifications": { "type": [ "array", "null" ], "description": "Kanban Notifications ops", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "add", "update", "remove" ] }, "user_id": { "type": "string", "enum": [ "" ] }, "emailNotifications": { "type": [ "boolean", "null" ] }, "whatsappNotifications": { "type": [ "boolean", "null" ] } }, "required": [ "action" ] } }, "labels": { "type": [ "array", "null" ], "description": "Kanban Labels ops", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "add", "update", "delete", "reorder" ] }, "id": { "type": "string", "enum": [ "" ] }, "name": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 100 }, "color": { "type": [ "string", "null" ], "pattern": "^[0-9A-Fa-f]{6}$" }, "orderedIds": { "type": "array", "description": "For labels reorder", "items": { "type": "string" } } }, "required": [ "action", "id" ] } } } } }, "required": [ "kanban" ], "title": "FormUpdateRequest" }, "IntegrationCollection": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationResource" }, "title": "IntegrationCollection" }, "IntegrationLogCollection": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationLogSummaryResource" }, "title": "IntegrationLogCollection" }, "IntegrationLogResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": [ "string", "null" ] }, "integrationId": { "type": [ "string", "null" ] }, "responseId": { "type": "string" }, "trigger": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "log": { "type": [ "string", "null" ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] } }, "required": [ "id", "userId", "integrationId", "responseId", "trigger", "status", "log", "createdAt", "deletedAt" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ], "title": "IntegrationLogResource" }, "IntegrationLogSummaryResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "integrationId": { "type": "string" }, "responseId": { "type": "string" }, "trigger": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] } }, "required": [ "id", "userId", "integrationId", "responseId", "trigger", "status", "createdAt", "deletedAt" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ], "title": "IntegrationLogSummaryResource" }, "IntegrationResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": [ "string", "null" ] }, "formId": { "type": [ "string", "null" ] }, "credentialId": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "settings": { "type": "array", "items": {} }, "isActive": { "type": [ "boolean", "null" ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] } }, "required": [ "id", "userId", "formId", "credentialId", "name", "type", "settings", "isActive", "createdAt", "updatedAt", "deletedAt" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ], "title": "IntegrationResource" }, "MediaCollection": { "type": "array", "items": { "$ref": "#/components/schemas/MediaListResource" }, "title": "MediaCollection" }, "MediaListResource": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "thumbnail": { "type": "string" }, "name": { "type": "string" }, "altText": { "type": "string" } }, "required": [ "id", "url", "thumbnail", "name", "altText" ], "title": "MediaListResource" }, "MediaResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "workspaceId": { "type": "string" }, "url": { "type": "string" }, "thumbnail": { "type": "string" }, "sizes": { "type": "object", "properties": { "s480": { "type": "string" }, "s720": { "type": "string" }, "s1080": { "type": "string" }, "s1440": { "type": "string" }, "s2160": { "type": "string" } }, "required": [ "s480", "s720", "s1080", "s1440", "s2160" ] }, "name": { "type": "string" }, "altText": { "type": "string" }, "metadata": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] } }, "required": [ "id", "userId", "workspaceId", "url", "thumbnail", "sizes", "name", "altText", "metadata", "createdAt", "updatedAt", "deletedAt" ] }, { "type": "object", "properties": { "name": { "type": "string" }, "altText": { "type": "string" }, "url": { "type": "string" }, "sizes": { "type": "object", "properties": { "s480": { "type": "string" }, "s720": { "type": "string" }, "s1080": { "type": "string" }, "s1440": { "type": "string" }, "s2160": { "type": "string" } }, "required": [ "s480", "s720", "s1080", "s1440", "s2160" ] } }, "required": [ "name", "altText", "url", "sizes" ] } ], "title": "MediaResource" }, "MediaStoreRequest": { "type": "object", "properties": { "media": { "type": "string", "format": "binary", "contentMediaType": "application/octet-stream", "maxLength": 2048 }, "name": { "type": [ "string", "null" ] }, "altText": { "type": [ "string", "null" ] }, "metadata": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "title": "MediaStoreRequest" }, "ResponseAnswerCollection": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseAnswerResource" }, "title": "ResponseAnswerCollection" }, "ResponseAnswerResource": { "type": "object", "properties": { "ID": { "type": "string" }, "Form ID": { "type": "string" }, "IP Address": { "type": "string" }, "Metadata": { "type": "string" }, "User Agent": { "type": "string" }, "Referrer Url": { "type": "string" }, "Device Type": { "type": "string" }, "Continent": { "type": [ "string", "null" ] }, "Iso Code": { "type": [ "string", "null" ] }, "Country": { "type": [ "string", "null" ] }, "State": { "type": [ "string", "null" ] }, "City": { "type": [ "string", "null" ] }, "Postal Code": { "type": [ "string", "null" ] }, "Lat": { "type": [ "string", "null" ] }, "Lon": { "type": [ "string", "null" ] }, "Timezone": { "type": [ "string", "null" ] }, "AI Feedback": { "type": "string" }, "Time To Complete": { "type": "string" }, "Started At": { "type": "string" }, "Submitted At": { "type": "string" }, "Created At": { "type": "string" }, "Updated At": { "type": "string" } }, "required": [ "ID", "Form ID", "IP Address", "User Agent", "Referrer Url", "Device Type", "Continent", "Iso Code", "Country", "State", "City", "Postal Code", "Lat", "Lon", "Timezone", "AI Feedback", "Time To Complete", "Started At", "Submitted At", "Created At", "Updated At" ], "title": "ResponseAnswerResource" }, "ResponseCollection": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseResource" }, "title": "ResponseCollection" }, "ResponseGridCollection": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseGridResource" }, "title": "ResponseGridCollection" }, "ResponseGridResource": { "type": "object", "properties": { "id": { "type": "string" }, "ipAddress": { "type": "string" }, "metadata": { "type": "string" }, "userAgent": { "type": "string" }, "operatingSystem": { "type": "string" }, "operatingSystemVersion": { "type": "string" }, "browser": { "type": "string" }, "browserVersion": { "type": "string" }, "referrerUrl": { "type": "string" }, "deviceType": { "type": "string" }, "isoCode": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "stateName": { "type": "string" }, "postalCode": { "type": "string" }, "lat": { "type": "string" }, "lon": { "type": "string" }, "timezone": { "type": "string" }, "continent": { "type": "string" }, "currency": { "type": "string" }, "aiFeedback": { "type": "string" }, "timeToComplete": { "type": "string" }, "startedAt": { "type": "string" }, "submittedAt": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string" } }, "required": [ "id", "ipAddress", "userAgent", "operatingSystem", "operatingSystemVersion", "browser", "browserVersion", "referrerUrl", "deviceType", "isoCode", "country", "city", "state", "stateName", "postalCode", "lat", "lon", "timezone", "continent", "currency", "aiFeedback", "timeToComplete", "startedAt", "submittedAt", "createdAt", "updatedAt", "deletedAt" ], "title": "ResponseGridResource" }, "ResponseResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "formId": { "type": [ "string", "null" ] }, "assigneeId": { "type": "string" }, "ipAddress": { "type": [ "string", "null" ] }, "metadata": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "operatingSystem": { "type": [ "string", "null" ] }, "operatingSystemVersion": { "type": [ "string", "null" ] }, "userAgent": { "type": [ "string", "null" ] }, "browser": { "type": [ "string", "null" ] }, "browserVersion": { "type": [ "string", "null" ] }, "referrerUrl": { "type": [ "string", "null" ] }, "deviceType": { "type": [ "string", "null" ] }, "geolocation": { "type": [ "string", "null" ] }, "aiFeedback": { "type": "string" }, "hiddenFields": { "type": [ "string", "null" ] }, "variables": { "type": [ "string", "null" ] }, "tracking": { "type": "array", "items": {} }, "card": { "type": "string" }, "timeToComplete": { "type": [ "string", "null" ] }, "startedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "submittedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "answers": { "type": "string" } }, "required": [ "id", "userId", "formId", "assigneeId", "ipAddress", "metadata", "operatingSystem", "operatingSystemVersion", "userAgent", "browser", "browserVersion", "referrerUrl", "deviceType", "geolocation", "aiFeedback", "hiddenFields", "variables", "tracking", "card", "timeToComplete", "startedAt", "submittedAt", "createdAt", "updatedAt", "deletedAt", "answers" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "formId": { "type": [ "string", "null" ] }, "submittedAt": { "type": "string" }, "hiddenFields": { "type": [ "string", "null" ] }, "variables": { "type": [ "string", "null" ] }, "tracking": { "type": "array", "items": {} }, "answers": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/AnswerResource" } }, { "type": "object" } ] } }, "required": [ "id", "formId", "submittedAt", "hiddenFields", "variables", "tracking", "answers" ] } ], "title": "ResponseResource" }, "StatResource": { "type": "object", "properties": { "views": { "type": "string" }, "starts": { "type": "string" }, "responses": { "type": "string" }, "completionRate": { "type": "string" }, "timeToComplete": { "type": "string" } }, "required": [ "views", "starts", "responses", "completionRate", "timeToComplete" ], "title": "StatResource" }, "StatementCollection": { "type": "array", "items": { "$ref": "#/components/schemas/StatementResource" }, "title": "StatementCollection" }, "StatementResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": [ "string", "null" ] }, "users": { "type": [ "integer", "null" ] }, "workspaces": { "type": [ "integer", "null" ] }, "forms": { "type": [ "integer", "null" ] }, "fields": { "type": [ "integer", "null" ] }, "responses": { "type": [ "integer", "null" ] }, "answers": { "type": [ "integer", "null" ] }, "keywordsExtraction": { "type": [ "integer", "null" ] }, "textAnalysis": { "type": [ "integer", "null" ] }, "usersLimit": { "type": [ "integer", "null" ] }, "workspacesLimit": { "type": [ "integer", "null" ] }, "formsLimit": { "type": [ "integer", "null" ] }, "fieldsLimit": { "type": [ "integer", "null" ] }, "responsesLimit": { "type": [ "integer", "null" ] }, "answersLimit": { "type": [ "integer", "null" ] }, "keywordsExtractionLimit": { "type": [ "integer", "null" ] }, "textAnalysisLimit": { "type": [ "integer", "null" ] }, "startsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] }, "endsAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] } }, "required": [ "id", "userId", "users", "workspaces", "forms", "fields", "responses", "answers", "keywordsExtraction", "textAnalysis", "usersLimit", "workspacesLimit", "formsLimit", "fieldsLimit", "responsesLimit", "answersLimit", "keywordsExtractionLimit", "textAnalysisLimit", "startsAt", "endsAt", "createdAt", "updatedAt", "deletedAt" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ], "title": "StatementResource" }, "ThemeCollection": { "type": "array", "items": { "$ref": "#/components/schemas/ThemeResource" }, "title": "ThemeCollection" }, "ThemeResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": [ "string", "null" ] }, "workspaceId": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "fontName": { "type": [ "string", "null" ] }, "fieldTextColor": { "type": [ "string", "null" ] }, "answerTextColor": { "type": [ "string", "null" ] }, "buttonBackgroundColor": { "type": [ "string", "null" ] }, "buttonTextColor": { "type": [ "string", "null" ] }, "pageBackgroundColor": { "type": [ "string", "null" ] }, "fontSizeScale": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "md" ] } ] }, "buttonBorderRadius": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "regular" ] } ] }, "layout": { "type": "string" }, "metadata": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] } }, "required": [ "id", "userId", "workspaceId", "name", "fontName", "fieldTextColor", "answerTextColor", "buttonBackgroundColor", "buttonTextColor", "pageBackgroundColor", "fontSizeScale", "buttonBorderRadius", "layout", "metadata", "createdAt", "updatedAt", "deletedAt" ] }, { "type": "object", "properties": { "fontName": { "type": [ "string", "null" ] }, "fieldTextColor": { "type": [ "string", "null" ] }, "answerTextColor": { "type": [ "string", "null" ] }, "buttonBackgroundColor": { "type": [ "string", "null" ] }, "buttonTextColor": { "type": [ "string", "null" ] }, "pageBackgroundColor": { "type": [ "string", "null" ] }, "fontSizeScale": { "type": [ "string", "null" ] }, "layout": { "type": "string" } }, "required": [ "fontName", "fieldTextColor", "answerTextColor", "buttonBackgroundColor", "buttonTextColor", "pageBackgroundColor", "fontSizeScale", "layout" ] } ], "title": "ThemeResource" }, "ThemeStoreRequest": { "type": "object", "properties": { "cloneThemeId": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "fontName": { "type": [ "string", "null" ] }, "fieldTextColor": { "type": [ "string", "null" ] }, "answerTextColor": { "type": [ "string", "null" ] }, "buttonBackgroundColor": { "type": [ "string", "null" ] }, "buttonTextColor": { "type": [ "string", "null" ] }, "pageBackgroundColor": { "type": [ "string", "null" ] }, "fontSizeScale": { "type": [ "string", "null" ], "enum": [ "sm", "md", "lg" ] }, "buttonBorderRadius": { "type": [ "string", "null" ], "enum": [ "flat", "regular", "full" ] }, "layout": { "type": [ "array", "null" ], "items": { "type": "string" } }, "metadata": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "title": "ThemeStoreRequest" }, "ThemeUpdateRequest": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "fontName": { "type": [ "string", "null" ] }, "fieldTextColor": { "type": "string" }, "answerTextColor": { "type": "string" }, "buttonBackgroundColor": { "type": "string" }, "buttonTextColor": { "type": "string" }, "pageBackgroundColor": { "type": "string" }, "fontSizeScale": { "type": [ "string", "null" ], "enum": [ "sm", "md", "lg" ] }, "buttonBorderRadius": { "type": [ "string", "null" ], "enum": [ "flat", "regular", "full" ] }, "layout": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "fieldTextColor", "answerTextColor", "buttonBackgroundColor", "buttonTextColor", "pageBackgroundColor" ], "title": "ThemeUpdateRequest" }, "UserCollection": { "type": "array", "items": { "$ref": "#/components/schemas/UserListResource" }, "title": "UserCollection" }, "UserListResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "profilePhotoUrl": { "type": "string" } }, "required": [ "id", "name", "email", "profilePhotoUrl" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ], "title": "UserListResource" }, "UserResource": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "tracking": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "tours": { "type": "object", "description": "What the person decided about the guided tours; `{}` when they decided nothing.", "additionalProperties": { "type": "boolean" } }, "geolocation": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "ipAddress": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "userAgent": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "affiliateCode": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "currentWorkspaceId": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "currentWorkspaceName": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "onboardingStep": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "supportAccess": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] }, "loginLink": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "termsAcceptedAt": { "type": "string" }, "initiateCheckout": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "pricingTable": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "notificationChannels": { "type": "string" }, "notificationsSummary": { "type": "object", "properties": { "unreadGeneralNotifications": { "type": "integer", "minimum": 0 }, "unreadOnboardingNotifications": { "type": "integer", "minimum": 0 } }, "required": [ "unreadGeneralNotifications", "unreadOnboardingNotifications" ] }, "addOns": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "billing": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "apiToken": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "chatKey": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] } }, "required": [ "id", "name", "company", "phone", "email", "timezone", "language", "currency", "tracking", "tours", "geolocation", "ipAddress", "userAgent", "affiliateCode", "currentWorkspaceId", "currentWorkspaceName", "profilePhotoUrl", "onboardingStep", "supportAccess", "loginLink", "termsAcceptedAt", "initiateCheckout", "pricingTable", "notificationChannels", "notificationsSummary", "addOns", "billing", "apiToken", "chatKey", "createdAt", "updatedAt", "deletedAt" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ], "title": "UserResource" }, "UserUpdateRequest": { "type": "object", "properties": { "currentWorkspaceId": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "email": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "password": { "type": "string", "maxLength": 50 }, "phone": { "type": [ "string", "null" ] }, "tracking": { "type": [ "array", "null" ], "items": { "type": "string" } }, "tours": { "type": [ "object", "null" ], "description": "What the person decided about the guided tours: `main` turns every tour off, a key per tour turns that one off. Absent means on.", "maxProperties": 40, "propertyNames": { "pattern": "^[a-z][a-z0-9_]{0,39}$" }, "additionalProperties": { "type": "boolean" } }, "notificationChannels": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "mail", "whatsapp" ] } }, "timezone": { "type": [ "string", "null" ], "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fort_Nelson", "America/Fortaleza", "America/Glace_Bay", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Chita", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kathmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Riyadh", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Ulyanovsk", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zurich", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis", "UTC" ] }, "company": { "type": [ "string", "null" ], "maxLength": 255 }, "industry": { "type": [ "string", "null" ], "maxLength": 255 }, "social_name": { "type": [ "string", "null" ], "maxLength": 255 }, "document_company": { "type": [ "string", "null" ], "maxLength": 255 }, "street": { "type": [ "string", "null" ], "maxLength": 255 }, "number": { "type": [ "string", "null" ], "maxLength": 255 }, "complement": { "type": [ "string", "null" ], "maxLength": 255 }, "neighborhood": { "type": [ "string", "null" ], "maxLength": 255 }, "state": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "zipcode": { "type": [ "string", "null" ], "maxLength": 255 }, "country_code": { "type": [ "string", "null" ], "maxLength": 255 }, "currency": { "$ref": "#/components/schemas/CurrencyAlpha3" }, "language": { "type": [ "string", "null" ], "enum": [ "en", "pt", "es" ], "minLength": 2, "maxLength": 5 }, "addOns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "onboardingStep": { "type": [ "string", "null" ], "maxLength": 255 }, "termsAccepted": { "type": [ "boolean", "null" ] }, "supportAccess": { "type": [ "boolean", "null" ] }, "hasApiToken": { "type": [ "boolean", "null" ] }, "useCurrentWorkspace": { "type": [ "boolean", "null" ] } }, "title": "UserUpdateRequest" }, "WorkspaceCollection": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceResource" }, "title": "WorkspaceCollection" }, "WorkspaceResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": [ "string", "null" ] }, "owner": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "company": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "subdomain": { "type": [ "string", "null" ] }, "timezone": { "type": "string" }, "metadata": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "folders": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "users": { "type": "integer", "minimum": 0 }, "workspacePlan": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "free" ] } ] }, "billing": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] }, "deletedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" }, { "type": "object" } ] } }, "required": [ "id", "userId", "owner", "company", "name", "subdomain", "timezone", "metadata", "folders", "users", "workspacePlan", "billing", "createdAt", "updatedAt", "deletedAt" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ], "title": "WorkspaceResource" }, "WorkspaceStoreRequest": { "type": "object", "properties": { "name": { "type": "string" }, "subdomain": { "type": [ "string", "null" ] }, "metadata": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "name" ], "title": "WorkspaceStoreRequest" }, "WorkspaceUpdateRequest": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "subdomain": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 255 }, "metadata": { "type": [ "array", "null" ], "items": { "type": "string" } }, "timezone": { "type": [ "string", "null" ], "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fort_Nelson", "America/Fortaleza", "America/Glace_Bay", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Chita", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kathmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Riyadh", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Ulyanovsk", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zurich", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis", "UTC" ] } }, "title": "WorkspaceUpdateRequest" } }, "responses": { "AuthorizationException": { "description": "Authorization error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ModelNotFoundException": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "AuthenticationException": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ValidationException": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } } } } }