{ "openapi": "3.1.0", "info": { "title": "WeTransform API", "version": "1.0.0", "description": "WeTransform data transformation platform API." }, "servers": [ { "url": "https://api.staging.wetransform.com" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Get started" }, { "name": "Sender" }, { "name": "Receiver", "description": "Endpoints used to manage templates and customers" }, { "name": "Integrations" } ], "paths": { "/en/hello": { "get": { "operationId": "Dot-ApiBundle-Controller-HelloController--demoGet", "tags": [ "Get started" ], "summary": "[Demo Receiver] Using parameters in the query string.", "description": "All endpoints hit using `GET` verb take parameters in the query string.\nThis test endpoint enables you to test that a simple call using parameters\nin the query string functions normally. It has no impact on the application.", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "description": "What is your name?", "type": "string", "default": "Bob" }, "description": "What is your name?" } ], "responses": { "200": { "description": "A classic \"Hello, world!\" response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_DemoHelloResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "Dot-ApiBundle-Controller-HelloController--demoOthers", "tags": [ "Get started" ], "summary": "[Demo Receiver] Using a JSON body.", "description": "All endpoints hit using `POST`, `PUT` and `DELETE` take parameters in the request payload.\nThis test endpoint enables you to test that a simple call using a JSON body\nfunctions normally. It has no impact on the application.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemoHelloRequest" } } } }, "responses": { "200": { "description": "A classic \"Hello, world!\" response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_DemoHelloResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "operationId": "Dot-ApiBundle-Controller-HelloController--demoOthers", "tags": [ "Get started" ], "summary": "[Demo Receiver] Using a JSON body.", "description": "All endpoints hit using `POST`, `PUT` and `DELETE` take parameters in the request payload.\nThis test endpoint enables you to test that a simple call using a JSON body\nfunctions normally. It has no impact on the application.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemoHelloRequest" } } } }, "responses": { "200": { "description": "A classic \"Hello, world!\" response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_DemoHelloResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "operationId": "Dot-ApiBundle-Controller-HelloController--demoOthers", "tags": [ "Get started" ], "summary": "[Demo Receiver] Using a JSON body.", "description": "All endpoints hit using `POST`, `PUT` and `DELETE` take parameters in the request payload.\nThis test endpoint enables you to test that a simple call using a JSON body\nfunctions normally. It has no impact on the application.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemoHelloRequest" } } } }, "responses": { "200": { "description": "A classic \"Hello, world!\" response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_DemoHelloResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/en/hello/{name}": { "get": { "operationId": "Dot-ApiBundle-Controller-HelloController--demoAttribute", "tags": [ "Get started" ], "summary": "[Demo Receiver] Using URL {attributes}.", "description": "Sometimes, URLs can take attributes, that should be replaced by\na resource identifier.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "What is your name?" } ], "responses": { "200": { "description": "A classic \"Hello, world!\" response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_DemoHelloResponse" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/en/hello/file-upload": { "post": { "operationId": "Dot-ApiBundle-Controller-HelloController--fileUpload", "tags": [ "Get started" ], "summary": "[Demo Receiver] Uploading files.", "description": "This test endpoint enables you to test that uploading a file to WeTransform\nfunctions normally. It has no impact on the application.", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_DemoFileResponse" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/en/send/{subdomain}/hello": { "get": { "operationId": "Dot-SenderBundle-Controller-HelloSenderController--demoGet", "tags": [ "Get started" ], "summary": "[Demo Sender] Using parameters in the query string.", "description": "All endpoints hit using `GET` verb take parameters in the query string.", "parameters": [ { "name": "subdomain", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[a-z0-9]([a-z0-9\\-]+)?[a-z0-9]" }, "description": "The organisation subdomain." }, { "name": "name", "in": "query", "required": true, "schema": { "description": "What is your name?", "type": "string", "default": "Bob" }, "description": "What is your name?" } ], "responses": { "200": { "description": "A classic \"Hello, world!\" response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_DemoHelloResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "Dot-SenderBundle-Controller-HelloSenderController--demoOthers", "tags": [ "Get started" ], "summary": "[Demo Sender] Using a JSON body.", "description": "All endpoints hit using `POST`, `PUT` and `DELETE` take parameters in the request payload.", "parameters": [ { "name": "subdomain", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[a-z0-9]([a-z0-9\\-]+)?[a-z0-9]" }, "description": "The organisation subdomain." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemoHelloRequest" } } } }, "responses": { "200": { "description": "A classic \"Hello, world!\" response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_DemoHelloResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "operationId": "Dot-SenderBundle-Controller-HelloSenderController--demoOthers", "tags": [ "Get started" ], "summary": "[Demo Sender] Using a JSON body.", "description": "All endpoints hit using `POST`, `PUT` and `DELETE` take parameters in the request payload.", "parameters": [ { "name": "subdomain", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[a-z0-9]([a-z0-9\\-]+)?[a-z0-9]" }, "description": "The organisation subdomain." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemoHelloRequest" } } } }, "responses": { "200": { "description": "A classic \"Hello, world!\" response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_DemoHelloResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "operationId": "Dot-SenderBundle-Controller-HelloSenderController--demoOthers", "tags": [ "Get started" ], "summary": "[Demo Sender] Using a JSON body.", "description": "All endpoints hit using `POST`, `PUT` and `DELETE` take parameters in the request payload.", "parameters": [ { "name": "subdomain", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[a-z0-9]([a-z0-9\\-]+)?[a-z0-9]" }, "description": "The organisation subdomain." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemoHelloRequest" } } } }, "responses": { "200": { "description": "A classic \"Hello, world!\" response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_DemoHelloResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/en/send/{subdomain}/hello/{name}": { "get": { "operationId": "Dot-SenderBundle-Controller-HelloSenderController--demoAttribute", "tags": [ "Get started" ], "summary": "[Demo Sender] Using URL {attributes}.", "description": "Sometimes, URLs can take attributes, that should be replaced by\na resource identifier.", "parameters": [ { "name": "subdomain", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[a-z0-9]([a-z0-9\\-]+)?[a-z0-9]" }, "description": "The organisation subdomain." }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "What is your name?" } ], "responses": { "200": { "description": "A classic \"Hello, world!\" response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_DemoHelloResponse" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/en/send/{subdomain}/hello/file-upload": { "post": { "operationId": "Dot-SenderBundle-Controller-HelloSenderController--fileUpload", "tags": [ "Get started" ], "summary": "[Demo Sender] Uploading files.", "parameters": [ { "name": "subdomain", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[a-z0-9]([a-z0-9\\-]+)?[a-z0-9]" }, "description": "The organisation subdomain." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_DemoFileResponse" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/sender/sources": { "get": { "operationId": "Dot-PublicBundle-Controller-SourceController--collection", "tags": [ "Sender" ], "summary": "[Source feeds] List source configurations.", "description": "Use this endpoint to list all source configurations.", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "description": "Page number to request.", "type": "integer", "default": 1, "minimum": 1 }, "description": "Page number to request." }, { "name": "per_page", "in": "query", "required": false, "schema": { "description": "Number of entries per page.", "type": "integer", "default": 25, "minimum": 1, "maximum": 200 }, "description": "Number of entries per page." }, { "name": "criteria", "in": "query", "required": false, "schema": { "description": "Search criteria.", "type": [ "string", "null" ] }, "description": "Search criteria." } ], "responses": { "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/sender/source": { "post": { "operationId": "Dot-PublicBundle-Controller-SourceController--create", "tags": [ "Sender" ], "summary": "[Source feeds] Create a source configuration.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceCreateRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_SourceResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/sender/source/{sourceId}": { "get": { "operationId": "Dot-PublicBundle-Controller-SourceController--read", "tags": [ "Sender" ], "summary": "[Source feeds] Read a source configuration.", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The source UUID to read" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_SourceResponse" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "operationId": "Dot-PublicBundle-Controller-SourceController--update", "tags": [ "Sender" ], "summary": "[Source feeds] Update a source configuration.", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The source UUID to update" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceUpdateRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_SourceResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "operationId": "Dot-PublicBundle-Controller-SourceController--delete", "tags": [ "Sender" ], "summary": "[Source feeds] Delete a source configuration and its schedules.", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The source UUID to delete" } ], "responses": { "204": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_HttpNoContent" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/sender/source/{sourceId}/schedules": { "delete": { "operationId": "Dot-PublicBundle-Controller-SourceController--deactivateSchedules", "tags": [ "Sender" ], "summary": "[Source feeds] Deactivate schedules linked to a source.", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The source UUID of the schedules to deactivate" } ], "responses": { "204": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_HttpNoContent" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "Dot-PublicBundle-Controller-SourceController--activateSchedules", "tags": [ "Sender" ], "summary": "[Source feeds] Activate schedules linked to a source.", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The source UUID of the schedules to deactivate" } ], "responses": { "204": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_HttpNoContent" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/transformations": { "get": { "operationId": "Dot-SenderBundle-Controller-Public-TransformationController--collection", "tags": [ "Sender" ], "summary": "[Public Transformations] List transformations.", "description": "This endpoint will list all transformations, paginated. A transformation has\na source file, a template name, and has been initiated, but has not necessarily finished.", "parameters": [ { "name": "template_handles", "in": "query", "required": true, "schema": { "description": "An array of template Handles to filter from.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] }, "description": "An array of template Handles to filter from." }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Page number to request.", "type": "integer", "default": 1, "minimum": 1 }, "description": "Page number to request." }, { "name": "per_page", "in": "query", "required": false, "schema": { "description": "Number of entries per page.", "type": "integer", "default": 25, "minimum": 1, "maximum": 200 }, "description": "Number of entries per page." } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PaginationQueryBuilder_TransformationPublic" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/transformations/trash": { "get": { "operationId": "Dot-SenderBundle-Controller-Public-TransformationController--trash", "tags": [ "Sender" ], "summary": "[Public Transformations] List deleted transformations.", "description": "This endpoint will list all deleted (trashed) transformations, paginated.", "parameters": [ { "name": "template_handles", "in": "query", "required": true, "schema": { "description": "An array of template Handles to filter from.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] }, "description": "An array of template Handles to filter from." }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Page number to request.", "type": "integer", "default": 1, "minimum": 1 }, "description": "Page number to request." }, { "name": "per_page", "in": "query", "required": false, "schema": { "description": "Number of entries per page.", "type": "integer", "default": 25, "minimum": 1, "maximum": 200 }, "description": "Number of entries per page." } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PaginationQueryBuilder_TransformationPublic" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/transformation/{transformationId}": { "get": { "operationId": "Dot-SenderBundle-Controller-Public-TransformationController--read", "tags": [ "Sender" ], "summary": "[Public Transformations] Read a transformation.", "description": "This endpoint will give details about a particular transformation, such as its import date,\nsource file name, download_url and more.", "parameters": [ { "name": "transformationId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The transformation UUID to read" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_TransformationPublic" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "operationId": "Dot-SenderBundle-Controller-Public-TransformationController--delete", "tags": [ "Sender" ], "summary": "[Public Transformations] Delete a transformation.", "description": "This endpoint will delete a transformation.", "parameters": [ { "name": "transformationId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The transformation UUID to delete" } ], "responses": { "204": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_HttpNoContent" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "operationId": "Dot-SenderBundle-Controller-Public-TransformationController--undelete", "tags": [ "Sender" ], "summary": "[Public Transformations] Undelete a transformation.", "description": "This endpoint will restore a previously deleted transformation.", "parameters": [ { "name": "transformationId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The transformation UUID to undelete" } ], "responses": { "204": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_HttpNoContent" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/transformation/delete-by-source/{sourceId}": { "delete": { "operationId": "Dot-SenderBundle-Controller-Public-TransformationController--deleteBySource", "tags": [ "Sender" ], "summary": "[Public Transformations] Delete all transformations tied to a source.", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The source UUID for which to delete transformations" } ], "responses": { "204": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_HttpNoContent" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/transformation/undelete-by-source/{sourceId}": { "put": { "operationId": "Dot-SenderBundle-Controller-Public-TransformationController--undeleteBySource", "tags": [ "Sender" ], "summary": "[Public Transformations] Undelete all transformations tied to a source.", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The source UUID for which to delete transformations" } ], "responses": { "204": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_HttpNoContent" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/transformation/automation/{transformationId}": { "post": { "operationId": "Dot-SenderBundle-Controller-Public-AutomationController--run", "tags": [ "Sender" ], "summary": "[Public Transformations] Run a transformation.", "description": "This endpoint can be used to run an existing transformation. It requires that\n1) a source file was already uploaded, 2) the source file is dynamic\n3) a template has been chosen. This will refresh the source file, and run the\ntransformation with the new source file.", "parameters": [ { "name": "transformationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The transformation UUID to read" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_ScheduleAutomation" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/transformation/automation/{automationId}": { "get": { "operationId": "Dot-SenderBundle-Controller-Public-AutomationController--status", "tags": [ "Sender" ], "summary": "[Public Transformations] Get the status of a transformation.", "description": "This endpoint will return the status of the transformation\nprovided the source file is dynamic.", "parameters": [ { "name": "automationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The automation UUID to read" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_ScheduleAutomation" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/transformation/{transformationId}/data": { "get": { "operationId": "Dot-SenderBundle-Controller-Public-TransformationDataController--read", "tags": [ "Sender" ], "summary": "[Public Transformations] Get data from a transformation.", "description": "This endoint allows to get portions of transformed file before it is actually submitted.\nA use case, if used with the `update data from a transformation` endpoint,\nis to allow to make changes to the file while a transformation is still pending\nand the file has not been submitted yet.", "parameters": [ { "name": "transformationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The transformation UUID to read" }, { "name": "attributes", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "conditions", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Page number to request.", "type": "integer", "default": 1, "minimum": 1 }, "description": "Page number to request." }, { "name": "per_page", "in": "query", "required": false, "schema": { "description": "Number of entries per page.", "type": "integer", "default": 25, "minimum": 1, "maximum": 200 }, "description": "Number of entries per page." } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_TransformationDataTargetData" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "operationId": "Dot-SenderBundle-Controller-Public-TransformationDataController--write", "tags": [ "Sender" ], "summary": "[Public Transformations] Update data from a transformation.", "description": "This endpoint allows to post changes to a transformation, such as updating content\non specific attributes, before the file is actually fully transformed and submitted.", "parameters": [ { "name": "transformationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The transformation UUID to read" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransformationDataTargetData" } } } }, "responses": { "204": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_HttpNoContent" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/sender/submissions": { "get": { "operationId": "Dot-SenderBundle-Controller-Public-SubmissionController--collection", "tags": [ "Sender" ], "summary": "[Public Submission] List submissions.", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "description": "Page number to request.", "type": "integer", "default": 1, "minimum": 1 }, "description": "Page number to request." }, { "name": "per_page", "in": "query", "required": false, "schema": { "description": "Number of entries per page.", "type": "integer", "default": 25, "minimum": 1, "maximum": 200 }, "description": "Number of entries per page." }, { "name": "criteria", "in": "query", "required": false, "schema": { "description": "Search criteria.", "type": [ "string", "null" ] }, "description": "Search criteria." } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PaginationQueryBuilder_Submission" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/sender/submissions/transformation/{transformationId}": { "get": { "operationId": "Dot-SenderBundle-Controller-Public-SubmissionController--transformationCollection", "tags": [ "Sender" ], "summary": "[Public Submission] List submissions for a transformation.", "parameters": [ { "name": "transformationId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The transformation UUID" }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Page number to request.", "type": "integer", "default": 1, "minimum": 1 }, "description": "Page number to request." }, { "name": "per_page", "in": "query", "required": false, "schema": { "description": "Number of entries per page.", "type": "integer", "default": 25, "minimum": 1, "maximum": 200 }, "description": "Number of entries per page." } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PaginationQueryBuilder_Submission" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/sender/submission": { "get": { "operationId": "Dot-SenderBundle-Controller-Public-SubmissionController--readWithDownloadUrl", "tags": [ "Sender" ], "summary": "[Public Submission] Read a submission by its download URL.", "parameters": [ { "name": "download_url", "in": "query", "required": true, "schema": { "description": "The absolute download URL.", "type": "string", "default": "https://example.com/download", "format": "uri" }, "description": "The absolute download URL." } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_Submission" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/sender/submission/{submissionId}": { "get": { "operationId": "Dot-SenderBundle-Controller-Public-SubmissionController--read", "tags": [ "Sender" ], "summary": "[Public Submission] Read a submission.", "parameters": [ { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The submission UUID to read" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_Submission" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/templates": { "get": { "operationId": "Dot-ReceiverBundle-Controller-Public-TemplateController--collection", "tags": [ "Receiver" ], "summary": "[Public Template] List templates.", "description": "Get a list of all templates and filter them using metadata in the query string.\nYou can define metadata in the template's General setting menu. For example,\nthis can be useful to categorize your templates.", "parameters": [ { "name": "is_enabled", "in": "query", "required": false, "schema": { "description": "The enabled status of the templates. If null, all templates are returned.", "type": [ "boolean", "null" ], "default": true }, "description": "The enabled status of the templates. If null, all templates are returned." }, { "name": "user_metadata", "in": "query", "required": false, "schema": { "description": "The metadata to filter the search.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] }, "description": "The metadata to filter the search." }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Page number to request.", "type": "integer", "default": 1, "minimum": 1 }, "description": "Page number to request." }, { "name": "per_page", "in": "query", "required": false, "schema": { "description": "Number of entries per page.", "type": "integer", "default": 25, "minimum": 1, "maximum": 200 }, "description": "Number of entries per page." }, { "name": "criteria", "in": "query", "required": false, "schema": { "description": "Search criteria.", "type": [ "string", "null" ] }, "description": "Search criteria." } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PaginationQueryBuilder_TemplatePublicTemplateResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/template/{templateHandle}": { "get": { "operationId": "Dot-ReceiverBundle-Controller-Public-TemplateController--read", "tags": [ "Receiver" ], "summary": "[Public Template] Read a template.", "parameters": [ { "name": "templateHandle", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The template handle" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_TemplatePublicTemplateResponse" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/template/{templateHandle}/customers": { "get": { "operationId": "Dot-ReceiverBundle-Controller-Public-TemplateController--customerCollection", "tags": [ "Receiver" ], "summary": "[Public Template] List template's customers.", "description": "Get a list of all customers having access to a particular template, using the template UUID.", "parameters": [ { "name": "templateHandle", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The template handle" }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Page number to request.", "type": "integer", "default": 1, "minimum": 1 }, "description": "Page number to request." }, { "name": "per_page", "in": "query", "required": false, "schema": { "description": "Number of entries per page.", "type": "integer", "default": 25, "minimum": 1, "maximum": 200 }, "description": "Number of entries per page." } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PaginationQueryBuilder_CustomerPublicCustomerWidget" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/customers": { "get": { "operationId": "Dot-ReceiverBundle-Controller-Public-CustomerController--collection", "tags": [ "Receiver" ], "summary": "[Public Customer] List customers.", "description": "Get the list of all your customers, including details such as WeTransform UUID,\nexternal_id, name, email, templates they have access to and more.", "parameters": [ { "name": "user_metadata", "in": "query", "required": false, "schema": { "description": "The metadata to filter the search.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] }, "description": "The metadata to filter the search." }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Page number to request.", "type": "integer", "default": 1, "minimum": 1 }, "description": "Page number to request." }, { "name": "per_page", "in": "query", "required": false, "schema": { "description": "Number of entries per page.", "type": "integer", "default": 25, "minimum": 1, "maximum": 200 }, "description": "Number of entries per page." }, { "name": "criteria", "in": "query", "required": false, "schema": { "description": "Search criteria.", "type": [ "string", "null" ] }, "description": "Search criteria." } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PaginationQueryBuilder_CustomerPublicCustomerResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/customer/{customerId}": { "get": { "operationId": "Dot-ReceiverBundle-Controller-Public-CustomerController--read", "tags": [ "Receiver" ], "summary": "[Public Customer] Read a customer.", "description": "Get details for a customer, such as its email, and list of available templates,\nfrom the WeTransform customer UUID.", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The customer UUID to read" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_CustomerPublicCustomerResponse" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "operationId": "Dot-ReceiverBundle-Controller-Public-CustomerController--update", "tags": [ "Receiver" ], "summary": "[Public Customer] Update a customer.", "description": "Give specific templates access to a customer, using its WeTransform UUID,\nor update other details.", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The customer UUID to update" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPublicCustomerRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_CustomerPublicCustomerResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "operationId": "Dot-ReceiverBundle-Controller-Public-CustomerController--delete", "tags": [ "Receiver" ], "summary": "[Public Customer] Delete a customer.", "description": "Delete a customer using its WeTransform UUID. Deleting a customer\nwill delete the corresponding transformations done by this customer.", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The customer UUID to delete" } ], "responses": { "204": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_HttpNoContent" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/customer": { "post": { "operationId": "Dot-ReceiverBundle-Controller-Public-CustomerController--create", "tags": [ "Receiver" ], "summary": "[Public Customer] Create a customer.", "description": "Create a customer specifying its external_id, and allowing specific templates.\nCreating an already existing customer will return a 409 error.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPublicCustomerRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_CustomerPublicCustomerResponse" } } } }, "402": { "description": "A product CTA if user reached out his/her number of customers limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpPaymentRequired" } } } }, "418": { "description": "A customer already exists with the same external ID or email", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_ExceptionCustomerAlreadyExists" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/power-functions/{callId}/{callNumber}/fetch": { "get": { "operationId": "Dot-TransformBundle-Controller-Public-PowerFunctionController--fetch", "tags": [ "Integrations" ], "summary": "[Power functions] Fetch data from the transformation dataset.", "parameters": [ { "name": "callNumber", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" }, "description": "The call number" }, { "name": "callId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The Power function call UUID" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PowerFunctionFetchFetch" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/power-functions/{callId}/{callNumber}/populate": { "post": { "operationId": "Dot-TransformBundle-Controller-Public-PowerFunctionController--populate", "tags": [ "Integrations" ], "summary": "[Power functions] Populate the function's result to the transformation dataset.", "parameters": [ { "name": "callNumber", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" }, "description": "The call number" }, { "name": "callId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The Power function call UUID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerFunctionPopulatePopulate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PowerFunctionPopulateResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "operationId": "Dot-TransformBundle-Controller-Public-PowerFunctionController--populate", "tags": [ "Integrations" ], "summary": "[Power functions] Populate the function's result to the transformation dataset.", "parameters": [ { "name": "callNumber", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" }, "description": "The call number" }, { "name": "callId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The Power function call UUID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerFunctionPopulatePopulate" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PowerFunctionPopulateResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpBadRequest" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } }, "409": { "description": "Payload contains invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_Violations_Violation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/power-functions/{callId}/{callNumber}/abort": { "get": { "operationId": "Dot-TransformBundle-Controller-Public-PowerFunctionController--abort", "tags": [ "Integrations" ], "summary": "[Power functions] Abort an ongoing Power function call.", "parameters": [ { "name": "callNumber", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" }, "description": "The call number" }, { "name": "callId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The Power function call UUID" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PowerFunctionPopulateResponse" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "Dot-TransformBundle-Controller-Public-PowerFunctionController--abort", "tags": [ "Integrations" ], "summary": "[Power functions] Abort an ongoing Power function call.", "parameters": [ { "name": "callNumber", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" }, "description": "The call number" }, { "name": "callId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The Power function call UUID" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PowerFunctionPopulateResponse" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "operationId": "Dot-TransformBundle-Controller-Public-PowerFunctionController--abort", "tags": [ "Integrations" ], "summary": "[Power functions] Abort an ongoing Power function call.", "parameters": [ { "name": "callNumber", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" }, "description": "The call number" }, { "name": "callId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The Power function call UUID" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PowerFunctionPopulateResponse" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "operationId": "Dot-TransformBundle-Controller-Public-PowerFunctionController--abort", "tags": [ "Integrations" ], "summary": "[Power functions] Abort an ongoing Power function call.", "parameters": [ { "name": "callNumber", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" }, "description": "The call number" }, { "name": "callId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The Power function call UUID" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PowerFunctionPopulateResponse" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "operationId": "Dot-TransformBundle-Controller-Public-PowerFunctionController--abort", "tags": [ "Integrations" ], "summary": "[Power functions] Abort an ongoing Power function call.", "parameters": [ { "name": "callNumber", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" }, "description": "The call number" }, { "name": "callId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}" }, "description": "The Power function call UUID" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSuccess_PowerFunctionPopulateResponse" } } } }, "401": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpUnauthorized" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError_HttpForbidden" } } } } }, "security": [ { "bearerAuth": [] } ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "Collection": { "type": "array", "items": { "type": "object" } }, "CustomerPublicCustomerRequest": { "type": "object", "properties": { "template_handles": { "description": "An array of template Handles that the customer can use.", "type": "array", "items": { "type": "string" } }, "external_id": { "description": "Customer ID on receiver's side.", "type": [ "string", "null" ], "default": "1234", "maxLength": 70 }, "name": { "description": "Customer's name", "type": [ "string", "null" ], "default": "Michael Jackson", "maxLength": 70 }, "email": { "description": "Customer's email.", "type": [ "string", "null" ], "default": "mickael@jackson.com", "format": "email", "maxLength": 70 }, "language": { "description": "The customer's preferred language.", "type": [ "string", "null" ], "default": "fr" }, "user_metadata": { "description": "Customer-specific metadata.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } }, "required": [ "template_handles" ] }, "CustomerPublicCustomerResponse": { "type": "object", "properties": { "customer_id": { "description": "Customer ID (on WeTransform side)", "type": [ "string", "null" ] }, "templates": { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } }, "external_id": { "description": "Customer ID on receiver's side.", "type": [ "string", "null" ], "default": "1234", "maxLength": 70 }, "name": { "description": "Customer's name", "type": [ "string", "null" ], "default": "Michael Jackson", "maxLength": 70 }, "email": { "description": "Customer's email.", "type": [ "string", "null" ], "default": "mickael@jackson.com", "format": "email", "maxLength": 70 }, "language": { "description": "The customer's preferred language.", "type": [ "string", "null" ], "default": "fr" }, "user_metadata": { "description": "Customer-specific metadata.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "DataExtractorCustomDataExtractor": { "type": "object", "properties": { "custom_data_extractor_id": { "description": "The custom data extractor's ID.", "type": [ "string", "null" ], "default": "c3e2a4d2-0176-4560-bf6e-d7bc77c57036" }, "handle": { "description": "The custom data extractor's handle.", "type": [ "string", "null" ], "default": "my-export" }, "metadata": { "description": "Metadata attached to the custom data extractor.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "DataExtractorFtpDataExtractor": { "type": "object", "properties": { "host": { "description": "The FTP host.", "type": "string", "default": "ftp.example.com", "maxLength": 70 }, "port": { "description": "The FTP port.", "type": [ "integer", "null" ], "default": 21, "minimum": 1, "maximum": 65535 }, "username": { "description": "The FTP username.", "type": "string", "default": "username", "maxLength": 70 }, "password": { "description": "The FTP password.", "type": "string", "default": "password", "maxLength": 70 }, "path": { "description": "The FTP path.", "type": "string", "default": "*.csv", "maxLength": 4096 }, "is_ssl": { "description": "Whether to use SSL or not.", "type": [ "boolean", "null" ], "default": false } }, "required": [ "host", "username", "password", "path" ] }, "DataExtractorSftpDataExtractor": { "type": "object", "properties": { "host": { "description": "The SFTP host to connect to.", "type": "string", "default": "example.com", "maxLength": 70 }, "port": { "description": "The SFTP port to connect to.", "type": "integer", "default": 22, "minimum": 1, "maximum": 65535 }, "username": { "description": "The username to use for the SFTP connection.", "type": "string", "default": "username", "maxLength": 70 }, "password": { "description": "The password to use for the SFTP connection.", "type": [ "string", "null" ], "default": "password", "maxLength": 70 }, "path": { "description": "The path to the file or directory to send.", "type": "string", "default": "/path/to/files/file.csv", "maxLength": 4096 }, "private_key": { "description": "The key to use for the SFTP connection.", "type": [ "string", "null" ] } }, "required": [ "host", "port", "username", "private_key" ] }, "DataExtractorUrlDataExtractor": { "type": "object", "properties": { "url": { "description": "The URL to which the request is sent.", "type": "string", "default": "https://example.com", "maxLength": 1024, "format": "uri" }, "method": { "description": "The HTTP method to use for the request.", "type": "string", "default": "GET" }, "headers": { "description": "Headers to send along with the request.", "type": "array", "items": { "type": "string" }, "maxItems": 5 }, "cookies": { "description": "Cookies to send along with the request.", "type": "array", "items": { "type": "string" }, "maxItems": 1 }, "content_type": { "description": "The content type of the body.", "type": [ "string", "null" ], "default": "application/json" }, "body": { "description": "The body of the request, encoded in the right format.", "type": [ "string", "null" ], "default": "{\"foo\":\"bar\"}", "maxLength": 4096 } }, "required": [ "url", "method" ] }, "DemoFileResponse": { "type": "object", "properties": { "filename": { "description": "Uploaded file name.", "type": "string", "default": "turtle.png" }, "size": { "description": "Uploaded file size in bytes.", "type": "integer", "default": 4230 } } }, "DemoHelloRequest": { "type": "object", "properties": { "name": { "description": "What is your name?", "type": "string", "default": "Bob" } }, "required": [ "name" ] }, "DemoHelloResponse": { "type": "object", "properties": { "hello": { "description": "The provided name.", "type": "string", "default": "Bob" } } }, "HttpBadRequest": { "type": "object" }, "HttpForbidden": { "type": "object" }, "HttpNoContent": { "type": "object" }, "HttpPaymentRequired": { "type": "object" }, "HttpUnauthorized": { "type": "object" }, "PaginationQueryBuilder": { "type": "object", "properties": { "total_pages": { "description": "Total number of available pages.", "type": "integer", "default": 5 }, "current_page": { "description": "Current page requested.", "type": "integer", "default": 5 }, "total_items": { "description": "Total number of items.", "type": "integer", "default": 103 }, "items_per_page": { "description": "Number of items per page.", "type": "integer", "default": 25 }, "entries": { "description": "An array of the requested resources.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "PermissionResponse": { "type": "object", "properties": { "description": { "description": "A human-understandable name for the permission.", "type": [ "string", "null" ] }, "name": { "description": "A technical permission name (ex: ORGANISATION_UPDATE_SETTINGS).", "type": "string", "default": "X_SOURCE_FORMAT_XML" } }, "required": [ "name" ] }, "PowerFunctionFetchFetch": { "type": "object", "properties": { "rows": { "description": "Rows of required data for the Power function.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "PowerFunctionPopulatePopulate": { "type": "object", "properties": { "outcomes": { "description": "The outcomes to populate.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "PowerFunctionPopulateResponse": { "type": "object", "properties": { "impacted_rows": { "type": [ "integer", "null" ], "default": 7750 } } }, "Product": { "type": "object", "properties": { "requirement": { "type": [ "string", "null" ], "default": "permission" }, "permission": { "description": "The required permission.", "oneOf": [ { "$ref": "#/components/schemas/PermissionResponse" }, { "type": "null" } ] }, "limitation_type": { "description": "The limitation that needs to be increased (ex: number of columns).", "type": [ "string", "null" ] }, "limitation_needed_value": { "type": [ "integer", "null" ] }, "limitation_current_value": { "type": [ "integer", "null" ] }, "limitation_object": { "type": [ "string", "null" ] }, "is_cta": { "description": "Whether a Call To Action should be displayed.", "type": [ "boolean", "null" ] } } }, "ResponseError_ExceptionCustomerAlreadyExists": { "type": "object", "properties": { "success": { "description": "Always `false` on error responses.", "type": "boolean", "default": false }, "payload": { "description": "Context about the error, if any.", "allOf": [ { "$ref": "#/components/schemas/Translatable" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseError_HttpBadRequest": { "type": "object", "properties": { "success": { "description": "Always `false` on error responses.", "type": "boolean", "default": false }, "payload": { "description": "Context about the error, if any.", "allOf": [ { "$ref": "#/components/schemas/HttpBadRequest" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseError_HttpForbidden": { "type": "object", "properties": { "success": { "description": "Always `false` on error responses.", "type": "boolean", "default": false }, "payload": { "description": "Context about the error, if any.", "allOf": [ { "$ref": "#/components/schemas/HttpForbidden" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseError_HttpPaymentRequired": { "type": "object", "properties": { "success": { "description": "Always `false` on error responses.", "type": "boolean", "default": false }, "payload": { "description": "Context about the error, if any.", "allOf": [ { "$ref": "#/components/schemas/HttpPaymentRequired" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseError_HttpUnauthorized": { "type": "object", "properties": { "success": { "description": "Always `false` on error responses.", "type": "boolean", "default": false }, "payload": { "description": "Context about the error, if any.", "allOf": [ { "$ref": "#/components/schemas/HttpUnauthorized" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseError_Violations_Violation": { "type": "object", "properties": { "success": { "description": "Always `false` on error responses.", "type": "boolean", "default": false }, "payload": { "description": "Context about the error, if any.", "allOf": [ { "$ref": "#/components/schemas/Violations" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_CustomerPublicCustomerResponse": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/CustomerPublicCustomerResponse" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_DemoFileResponse": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/DemoFileResponse" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_DemoHelloResponse": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/DemoHelloResponse" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_HttpNoContent": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/HttpNoContent" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_PaginationQueryBuilder_CustomerPublicCustomerResponse": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/PaginationQueryBuilder" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_PaginationQueryBuilder_CustomerPublicCustomerWidget": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/PaginationQueryBuilder" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_PaginationQueryBuilder_Submission": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/PaginationQueryBuilder" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_PaginationQueryBuilder_TemplatePublicTemplateResponse": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/PaginationQueryBuilder" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_PaginationQueryBuilder_TransformationPublic": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/PaginationQueryBuilder" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_PowerFunctionFetchFetch": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/PowerFunctionFetchFetch" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_PowerFunctionPopulateResponse": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/PowerFunctionPopulateResponse" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_ScheduleAutomation": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/ScheduleAutomation" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_SourceResponse": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/SourceResponse" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_Submission": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/Submission" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_TemplatePublicTemplateResponse": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/TemplatePublicTemplateResponse" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_TransformationDataTargetData": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/TransformationDataTargetData" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ResponseSuccess_TransformationPublic": { "type": "object", "properties": { "success": { "description": "Always `true` on successful responses.", "type": "boolean", "default": true }, "payload": { "description": "Payload of the requested resource.", "allOf": [ { "$ref": "#/components/schemas/TransformationPublic" } ] }, "product": { "description": "A product needed.", "oneOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] }, "debug": { "description": "Debug information.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "ScheduleAutomation": { "type": "object", "properties": { "automation_id": { "description": "The transformation tracking UUID.", "type": [ "string", "null" ], "default": "9b58bbd3-c78d-403a-85a7-83702f90f955" }, "type": { "description": "The type of automation that is being tracked.", "type": [ "string", "null" ], "default": "schedule" }, "step": { "description": "The step at which the transformation is at.", "type": [ "string", "null" ], "default": "pending" }, "step_for_humans": { "description": "The human-readable step at which the transformation is at.", "oneOf": [ { "$ref": "#/components/schemas/Translatable" }, { "type": "null" } ] }, "details": { "description": "The transformation step details.", "type": [ "string", "null" ], "default": "The transformation is pending." }, "original_file": { "description": "The URL at which can be found the original file fetched when the transformation was started.", "type": [ "string", "null" ], "default": "https://example.com/original-file.csv" }, "transformed_file": { "description": "The URL at which can be found the transformed file.", "type": [ "string", "null" ], "default": "https://example.com/transformed-file.csv" }, "error_report_file": { "description": "The URL at which can be found the error report file, if any.", "type": [ "string", "null" ], "default": "https://example.com/error-report-file.csv" }, "created_at": { "description": "The date at which the transformation was initiated.", "type": "string" } } }, "SourceCreateRequest": { "type": "object", "properties": { "name": { "description": "The name of the source.", "type": [ "string", "null" ], "maxLength": 70 }, "data_extractor": { "description": "The selected data extractor.", "type": [ "string", "null" ], "default": "url" }, "url": { "description": "Describes the URL data extractor.", "oneOf": [ { "$ref": "#/components/schemas/DataExtractorUrlDataExtractor" }, { "type": "null" } ] }, "ftp": { "description": "Describes the FTP data extractor.", "oneOf": [ { "$ref": "#/components/schemas/DataExtractorFtpDataExtractor" }, { "type": "null" } ] }, "sftp": { "description": "Describes the SFTP data extractor.", "oneOf": [ { "$ref": "#/components/schemas/DataExtractorSftpDataExtractor" }, { "type": "null" } ] }, "custom": { "description": "Describes the custom data extractor.", "oneOf": [ { "$ref": "#/components/schemas/DataExtractorCustomDataExtractor" }, { "type": "null" } ] } } }, "SourceResponse": { "type": "object", "properties": { "source_id": { "description": "The source ID.", "type": [ "string", "null" ] }, "name": { "description": "The name of the source.", "type": [ "string", "null" ], "maxLength": 70 }, "data_extractor": { "description": "The selected data extractor.", "type": [ "string", "null" ], "default": "url" }, "url": { "description": "Describes the URL data extractor.", "oneOf": [ { "$ref": "#/components/schemas/DataExtractorUrlDataExtractor" }, { "type": "null" } ] }, "ftp": { "description": "Describes the FTP data extractor.", "oneOf": [ { "$ref": "#/components/schemas/DataExtractorFtpDataExtractor" }, { "type": "null" } ] }, "sftp": { "description": "Describes the SFTP data extractor.", "oneOf": [ { "$ref": "#/components/schemas/DataExtractorSftpDataExtractor" }, { "type": "null" } ] }, "custom": { "description": "Describes the custom data extractor.", "oneOf": [ { "$ref": "#/components/schemas/DataExtractorCustomDataExtractor" }, { "type": "null" } ] } } }, "SourceUpdateRequest": { "type": "object", "properties": { "name": { "description": "The name of the source.", "type": [ "string", "null" ], "maxLength": 70 }, "data_extractor": { "description": "The selected data extractor.", "type": [ "string", "null" ], "default": "url" }, "url": { "description": "Describes the URL data extractor.", "oneOf": [ { "$ref": "#/components/schemas/DataExtractorUrlDataExtractor" }, { "type": "null" } ] }, "ftp": { "description": "Describes the FTP data extractor.", "oneOf": [ { "$ref": "#/components/schemas/DataExtractorFtpDataExtractor" }, { "type": "null" } ] }, "sftp": { "description": "Describes the SFTP data extractor.", "oneOf": [ { "$ref": "#/components/schemas/DataExtractorSftpDataExtractor" }, { "type": "null" } ] }, "custom": { "description": "Describes the custom data extractor.", "oneOf": [ { "$ref": "#/components/schemas/DataExtractorCustomDataExtractor" }, { "type": "null" } ] } } }, "Submission": { "type": "object", "properties": { "submission_id": { "description": "The submission UUID", "type": [ "string", "null" ], "default": "cbe6d17e-9c19-4ac3-baf5-8e7e4bb53e3d" }, "customer_id": { "description": "The customer external ID", "type": [ "string", "null" ], "default": "jojo" }, "customer_name": { "description": "The customer name", "type": [ "string", "null" ], "default": "Jo\u00ebl" }, "customer_email": { "description": "The customer email", "type": [ "string", "null" ], "default": "joel@fuz.org" }, "source_id": { "description": "The source UUID", "type": [ "string", "null" ], "default": "8d049772-c9f8-4fe2-a988-ecf926022c51" }, "source_name": { "description": "The source name", "type": [ "string", "null" ], "default": "New Hires" }, "source_file_url": { "description": "The source file URL, if it still exists", "type": [ "string", "null" ], "default": "https://example.com/source.csv" }, "target_file_url": { "description": "The target file URL", "type": [ "string", "null" ], "default": "https://example.com/target.csv" }, "error_report_url": { "description": "The error report url.", "type": [ "string", "null" ], "default": "https://example.com/error-report.csv" }, "push_report_url": { "description": "The push report url.", "type": [ "string", "null" ], "default": "https://example.com/push-report.csv" }, "target_name": { "description": "The target file naem.", "type": [ "string", "null" ] }, "template_name": { "description": "The template name", "type": [ "string", "null" ], "default": "New Hires" }, "template_item": { "description": "The template item name", "type": [ "string", "null" ], "default": "Employee" }, "template_picture_url": { "description": "The template picture URL, if any", "type": [ "string", "null" ], "default": "https://example.com/picture.png" }, "rows_in_source": { "description": "Number of rows that were imported from the source file.", "type": [ "integer", "null" ], "default": 100 }, "rows_ignored_from_source": { "description": "Number of rows that were ignored in the source file.", "type": [ "integer", "null" ], "default": 0 }, "columns_ignored_from_source": { "description": "Number of columns that were ignored in the source file.", "type": [ "integer", "null" ], "default": 0 }, "maximum_number_of_columns": { "description": "Maximum number of columns allowed.", "type": "integer", "default": 180 }, "rows_in_target": { "description": "Number of rows in the target file.", "type": [ "integer", "null" ], "default": 100 }, "rows_in_error": { "description": "Number of rows in error.", "type": [ "integer", "null" ], "default": 12 }, "created_at": { "description": "The date at which the submission has been created.", "type": [ "string", "null" ] }, "pushed_at": { "description": "The date at which the file has been successfully submitted automatically.", "type": [ "string", "null" ] }, "failed": { "description": "Whether the submission has failed.", "type": "boolean", "default": false }, "error_message": { "description": "If the submission has failed, the error message.", "type": [ "string", "null" ] } } }, "TemplatePublicTemplateResponse": { "type": "object", "properties": { "template_handle": { "description": "The template handle.", "type": [ "string", "null" ], "default": "my-template" }, "is_enabled": { "description": "Whether the template is enabled.", "type": "boolean", "default": true }, "name": { "description": "The template name.", "type": [ "string", "null" ], "default": "Employee Leaves (RE)" }, "description": { "description": "The template description.", "type": [ "string", "null" ], "default": "Upload your employee leaves and absences, automate calendar updates and email notifications" }, "picture_url": { "description": "Profile picture's URL.", "type": [ "string", "null" ], "default": "https://api.staging.wetransform.com/icon.png" }, "user_metadata": { "description": "The template metadata.", "allOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } ] } } }, "TransformationDataTargetData": { "type": "object", "properties": { "total_pages": { "description": "Total number of available pages.", "type": "integer", "default": 7 }, "current_page": { "description": "Current page requested.", "type": "integer", "default": 2 }, "total_items": { "description": "Total number of items.", "type": "integer", "default": 63 }, "items_per_page": { "description": "Number of items per page.", "type": "integer", "default": 10 }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } } }, "TransformationPublic": { "type": "object", "properties": { "source_id": { "description": "The source identifier.", "type": "string", "default": "306e6d71-3d87-4c15-935e-d1cb9743b220" }, "source_name": { "description": "The source name.", "type": [ "string", "null" ], "default": "my-employees.csv" }, "source_file_url": { "description": "The source file URL, if it still exists", "type": [ "string", "null" ] }, "imported_at": { "description": "The date and time the source was imported.", "type": "string" }, "template_name": { "description": "The template name.", "type": "string", "default": "Employee Leaves (RE)" }, "template_picture_url": { "description": "The template picture URL.", "type": [ "string", "null" ], "default": "https://api.staging.wetransform.com/icon.png" }, "transformation_id": { "description": "The transformation identifier.", "type": "string", "default": "393e68a1-2e73-4f3a-a4a1-b3de32814124" }, "has_schedule": { "description": "Whether the transformation has an enabled schedule.", "type": "boolean", "default": true }, "column_names": { "description": "The columns' names.", "type": "array", "items": { "type": "string" } }, "custom_field_names": { "description": "The custom fields' names.", "type": "array", "items": { "type": "string" } }, "deleted_at": { "description": "The date and time the transformation was deleted, if applicable.", "type": [ "string", "null" ] }, "download_url": { "description": "The download URL of the transformed file.", "type": [ "string", "null" ], "default": "https://api.staging.wetransform.com/file/prqfit7vq7q152jvi58ps16b7vg1p01k.csv" }, "template_handle": { "description": "The template handle.", "type": "string", "default": "furniture" } } }, "Translatable": { "type": "object", "properties": { "code": { "description": "A translation key for the given message.", "type": "string", "default": "exception.violation" }, "message": { "description": "The translated version of the message.", "type": "string" } } }, "Violations": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Translatable" }, "violations": { "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } } } } } }