diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index 69122a5..1018c60 100644 --- a/SwagDigitalSalesRooms-adminapi.json +++ b/SwagDigitalSalesRooms-adminapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.7.9999999-dev" + "version": "6.7.12.1" }, "servers": [ { @@ -21,7 +21,7 @@ "App Mcp Prompt" ], "summary": "List with basic information of App Mcp Prompt resources.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "getAppMcpPromptList", "parameters": [ { @@ -132,7 +132,7 @@ "App Mcp Prompt" ], "summary": "Create a new App Mcp Prompt resources.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "createAppMcpPrompt", "parameters": [ { @@ -208,7 +208,7 @@ "App Mcp Prompt" ], "summary": "Search for the App Mcp Prompt resources.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "searchAppMcpPrompt", "parameters": [ { @@ -292,7 +292,7 @@ "App Mcp Prompt" ], "summary": "Detailed information about a App Mcp Prompt resource.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "getAppMcpPrompt", "parameters": [ { @@ -355,7 +355,7 @@ "App Mcp Prompt" ], "summary": "Delete a App Mcp Prompt resource.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "deleteAppMcpPrompt", "parameters": [ { @@ -395,7 +395,7 @@ "App Mcp Prompt" ], "summary": "Partially update information about a App Mcp Prompt resource.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "updateAppMcpPrompt", "parameters": [ { @@ -482,7 +482,7 @@ "App Mcp Prompt" ], "summary": "Aggregate for the App Mcp Prompt resources.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "aggregateAppMcpPrompt", "requestBody": { "required": true, @@ -562,7 +562,7 @@ "App Mcp Resource" ], "summary": "List with basic information of App Mcp Resource resources.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "getAppMcpResourceList", "parameters": [ { @@ -673,7 +673,7 @@ "App Mcp Resource" ], "summary": "Create a new App Mcp Resource resources.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "createAppMcpResource", "parameters": [ { @@ -749,7 +749,7 @@ "App Mcp Resource" ], "summary": "Search for the App Mcp Resource resources.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "searchAppMcpResource", "parameters": [ { @@ -833,7 +833,7 @@ "App Mcp Resource" ], "summary": "Detailed information about a App Mcp Resource resource.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "getAppMcpResource", "parameters": [ { @@ -896,7 +896,7 @@ "App Mcp Resource" ], "summary": "Delete a App Mcp Resource resource.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "deleteAppMcpResource", "parameters": [ { @@ -936,7 +936,7 @@ "App Mcp Resource" ], "summary": "Partially update information about a App Mcp Resource resource.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "updateAppMcpResource", "parameters": [ { @@ -1023,7 +1023,7 @@ "App Mcp Resource" ], "summary": "Aggregate for the App Mcp Resource resources.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "aggregateAppMcpResource", "requestBody": { "required": true, @@ -1103,7 +1103,7 @@ "App Mcp Tool" ], "summary": "List with basic information of App Mcp Tool resources.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "getAppMcpToolList", "parameters": [ { @@ -1214,7 +1214,7 @@ "App Mcp Tool" ], "summary": "Create a new App Mcp Tool resources.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "createAppMcpTool", "parameters": [ { @@ -1290,7 +1290,7 @@ "App Mcp Tool" ], "summary": "Search for the App Mcp Tool resources.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "searchAppMcpTool", "parameters": [ { @@ -1374,7 +1374,7 @@ "App Mcp Tool" ], "summary": "Detailed information about a App Mcp Tool resource.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "getAppMcpTool", "parameters": [ { @@ -1437,7 +1437,7 @@ "App Mcp Tool" ], "summary": "Delete a App Mcp Tool resource.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "deleteAppMcpTool", "parameters": [ { @@ -1477,7 +1477,7 @@ "App Mcp Tool" ], "summary": "Partially update information about a App Mcp Tool resource.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "updateAppMcpTool", "parameters": [ { @@ -1564,7 +1564,7 @@ "App Mcp Tool" ], "summary": "Aggregate for the App Mcp Tool resources.", - "description": "Available since: 6.7.0.0", + "description": "Available since: 6.7.11.0", "operationId": "aggregateAppMcpTool", "requestBody": { "required": true, @@ -1638,14 +1638,14 @@ } } }, - "/dsr-appointment": { + "/document-file": { "get": { "tags": [ - "Dsr Appointment" + "Document File" ], - "summary": "List with basic information of Dsr Appointment resources.", - "description": "", - "operationId": "getDsrAppointmentList", + "summary": "List with basic information of Document File resources.", + "description": "Available since: 6.7.10.0", + "operationId": "getDocumentFileList", "parameters": [ { "name": "limit", @@ -1674,7 +1674,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment resources.", + "description": "List of Document File resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1693,7 +1693,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } ] @@ -1707,16 +1707,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment?limit=25" + "example": "/document-file?limit=25" }, "last": { - "example": "/dsr-appointment?limit=25&page=11" + "example": "/document-file?limit=25&page=11" }, "next": { - "example": "/dsr-appointment?limit=25&page=4" + "example": "/document-file?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment?limit=25&page=2" + "example": "/document-file?limit=25&page=2" } } } @@ -1737,7 +1737,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1752,11 +1752,11 @@ }, "post": { "tags": [ - "Dsr Appointment" + "Document File" ], - "summary": "Create a new Dsr Appointment resources.", - "description": "", - "operationId": "createDsrAppointment", + "summary": "Create a new Document File resources.", + "description": "Available since: 6.7.10.0", + "operationId": "createDocumentFile", "parameters": [ { "name": "_response", @@ -1775,14 +1775,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "Detail of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -1794,7 +1794,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1809,7 +1809,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1825,14 +1825,14 @@ } } }, - "/search/dsr-appointment": { + "/search/document-file": { "post": { "tags": [ - "Dsr Appointment" + "Document File" ], - "summary": "Search for the Dsr Appointment resources.", - "description": "", - "operationId": "searchDsrAppointment", + "summary": "Search for the Document File resources.", + "description": "Available since: 6.7.10.0", + "operationId": "searchDocumentFile", "parameters": [ { "name": "sw-include-search-info", @@ -1860,7 +1860,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointment", + "description": "List of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -1874,7 +1874,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1892,7 +1892,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1909,19 +1909,19 @@ } } }, - "/dsr-appointment/{id}": { + "/document-file/{id}": { "get": { "tags": [ - "Dsr Appointment" + "Document File" ], - "summary": "Detailed information about a Dsr Appointment resource.", - "description": "", - "operationId": "getDsrAppointment", + "summary": "Detailed information about a Document File resource.", + "description": "Available since: 6.7.10.0", + "operationId": "getDocumentFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment", + "description": "Identifier for the document_file", "required": true, "schema": { "type": "string", @@ -1931,7 +1931,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "Detail of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -1943,7 +1943,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1958,7 +1958,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1975,16 +1975,16 @@ }, "delete": { "tags": [ - "Dsr Appointment" + "Document File" ], - "summary": "Delete a Dsr Appointment resource.", - "description": "", - "operationId": "deleteDsrAppointment", + "summary": "Delete a Document File resource.", + "description": "Available since: 6.7.10.0", + "operationId": "deleteDocumentFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment", + "description": "Identifier for the document_file", "required": true, "schema": { "type": "string", @@ -2015,16 +2015,16 @@ }, "patch": { "tags": [ - "Dsr Appointment" + "Document File" ], - "summary": "Partially update information about a Dsr Appointment resource.", - "description": "", - "operationId": "updateDsrAppointment", + "summary": "Partially update information about a Document File resource.", + "description": "Available since: 6.7.10.0", + "operationId": "updateDocumentFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment", + "description": "Identifier for the document_file", "required": true, "schema": { "type": "string", @@ -2042,18 +2042,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Appointment resource.", + "description": "Partially update information about a Document File resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "Detail of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -2065,7 +2065,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -2080,7 +2080,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -2099,14 +2099,14 @@ } } }, - "/aggregate/dsr-appointment": { + "/aggregate/document-file": { "post": { "tags": [ - "Dsr Appointment" + "Document File" ], - "summary": "Aggregate for the Dsr Appointment resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointment", + "summary": "Aggregate for the Document File resources.", + "description": "Available since: 6.7.10.0", + "operationId": "aggregateDocumentFile", "requestBody": { "required": true, "content": { @@ -2130,7 +2130,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointment", + "description": "List of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -2144,7 +2144,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -2162,7 +2162,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -2179,14 +2179,14 @@ } } }, - "/dsr-appointment-attendee": { + "/dsr-appointment": { "get": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Appointment" ], - "summary": "List with basic information of Dsr Appointment Attendee resources.", + "summary": "List with basic information of Dsr Appointment resources.", "description": "", - "operationId": "getDsrAppointmentAttendeeList", + "operationId": "getDsrAppointmentList", "parameters": [ { "name": "limit", @@ -2215,7 +2215,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment Attendee resources.", + "description": "List of Dsr Appointment resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2234,7 +2234,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } ] @@ -2248,16 +2248,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment-attendee?limit=25" + "example": "/dsr-appointment?limit=25" }, "last": { - "example": "/dsr-appointment-attendee?limit=25&page=11" + "example": "/dsr-appointment?limit=25&page=11" }, "next": { - "example": "/dsr-appointment-attendee?limit=25&page=4" + "example": "/dsr-appointment?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment-attendee?limit=25&page=2" + "example": "/dsr-appointment?limit=25&page=2" } } } @@ -2278,7 +2278,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -2293,11 +2293,11 @@ }, "post": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Appointment" ], - "summary": "Create a new Dsr Appointment Attendee resources.", + "summary": "Create a new Dsr Appointment resources.", "description": "", - "operationId": "createDsrAppointmentAttendee", + "operationId": "createDsrAppointment", "parameters": [ { "name": "_response", @@ -2316,14 +2316,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -2335,7 +2335,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -2350,7 +2350,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -2366,14 +2366,14 @@ } } }, - "/search/dsr-appointment-attendee": { + "/search/dsr-appointment": { "post": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Appointment" ], - "summary": "Search for the Dsr Appointment Attendee resources.", + "summary": "Search for the Dsr Appointment resources.", "description": "", - "operationId": "searchDsrAppointmentAttendee", + "operationId": "searchDsrAppointment", "parameters": [ { "name": "sw-include-search-info", @@ -2401,7 +2401,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentAttendee", + "description": "List of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -2415,7 +2415,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -2433,7 +2433,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -2450,19 +2450,19 @@ } } }, - "/dsr-appointment-attendee/{id}": { + "/dsr-appointment/{id}": { "get": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Appointment" ], - "summary": "Detailed information about a Dsr Appointment Attendee resource.", + "summary": "Detailed information about a Dsr Appointment resource.", "description": "", - "operationId": "getDsrAppointmentAttendee", + "operationId": "getDsrAppointment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_attendee", + "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", @@ -2472,7 +2472,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -2484,7 +2484,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -2499,7 +2499,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -2516,16 +2516,16 @@ }, "delete": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Appointment" ], - "summary": "Delete a Dsr Appointment Attendee resource.", + "summary": "Delete a Dsr Appointment resource.", "description": "", - "operationId": "deleteDsrAppointmentAttendee", + "operationId": "deleteDsrAppointment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_attendee", + "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", @@ -2556,16 +2556,16 @@ }, "patch": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Appointment" ], - "summary": "Partially update information about a Dsr Appointment Attendee resource.", + "summary": "Partially update information about a Dsr Appointment resource.", "description": "", - "operationId": "updateDsrAppointmentAttendee", + "operationId": "updateDsrAppointment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_attendee", + "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", @@ -2583,18 +2583,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Appointment Attendee resource.", + "description": "Partially update information about a Dsr Appointment resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -2606,7 +2606,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -2621,7 +2621,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -2640,14 +2640,14 @@ } } }, - "/aggregate/dsr-appointment-attendee": { + "/aggregate/dsr-appointment": { "post": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Appointment" ], - "summary": "Aggregate for the Dsr Appointment Attendee resources.", + "summary": "Aggregate for the Dsr Appointment resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointmentAttendee", + "operationId": "aggregateDsrAppointment", "requestBody": { "required": true, "content": { @@ -2671,7 +2671,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentAttendee", + "description": "List of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -2685,7 +2685,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -2703,7 +2703,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -2720,14 +2720,14 @@ } } }, - "/dsr-appointment-request": { + "/dsr-appointment-attendee": { "get": { "tags": [ - "Dsr Appointment Request" + "Dsr Appointment Attendee" ], - "summary": "List with basic information of Dsr Appointment Request resources.", + "summary": "List with basic information of Dsr Appointment Attendee resources.", "description": "", - "operationId": "getDsrAppointmentRequestList", + "operationId": "getDsrAppointmentAttendeeList", "parameters": [ { "name": "limit", @@ -2756,7 +2756,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment Request resources.", + "description": "List of Dsr Appointment Attendee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2775,7 +2775,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } ] @@ -2789,16 +2789,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment-request?limit=25" + "example": "/dsr-appointment-attendee?limit=25" }, "last": { - "example": "/dsr-appointment-request?limit=25&page=11" + "example": "/dsr-appointment-attendee?limit=25&page=11" }, "next": { - "example": "/dsr-appointment-request?limit=25&page=4" + "example": "/dsr-appointment-attendee?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment-request?limit=25&page=2" + "example": "/dsr-appointment-attendee?limit=25&page=2" } } } @@ -2819,7 +2819,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -2834,11 +2834,11 @@ }, "post": { "tags": [ - "Dsr Appointment Request" + "Dsr Appointment Attendee" ], - "summary": "Create a new Dsr Appointment Request resources.", + "summary": "Create a new Dsr Appointment Attendee resources.", "description": "", - "operationId": "createDsrAppointmentRequest", + "operationId": "createDsrAppointmentAttendee", "parameters": [ { "name": "_response", @@ -2857,14 +2857,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -2876,7 +2876,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -2891,7 +2891,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -2907,14 +2907,14 @@ } } }, - "/search/dsr-appointment-request": { + "/search/dsr-appointment-attendee": { "post": { "tags": [ - "Dsr Appointment Request" + "Dsr Appointment Attendee" ], - "summary": "Search for the Dsr Appointment Request resources.", + "summary": "Search for the Dsr Appointment Attendee resources.", "description": "", - "operationId": "searchDsrAppointmentRequest", + "operationId": "searchDsrAppointmentAttendee", "parameters": [ { "name": "sw-include-search-info", @@ -2942,7 +2942,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentRequest", + "description": "List of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -2956,7 +2956,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -2974,7 +2974,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -2991,19 +2991,19 @@ } } }, - "/dsr-appointment-request/{id}": { + "/dsr-appointment-attendee/{id}": { "get": { "tags": [ - "Dsr Appointment Request" + "Dsr Appointment Attendee" ], - "summary": "Detailed information about a Dsr Appointment Request resource.", + "summary": "Detailed information about a Dsr Appointment Attendee resource.", "description": "", - "operationId": "getDsrAppointmentRequest", + "operationId": "getDsrAppointmentAttendee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_request", + "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", @@ -3013,7 +3013,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -3025,7 +3025,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -3040,7 +3040,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -3057,16 +3057,16 @@ }, "delete": { "tags": [ - "Dsr Appointment Request" + "Dsr Appointment Attendee" ], - "summary": "Delete a Dsr Appointment Request resource.", + "summary": "Delete a Dsr Appointment Attendee resource.", "description": "", - "operationId": "deleteDsrAppointmentRequest", + "operationId": "deleteDsrAppointmentAttendee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_request", + "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", @@ -3097,16 +3097,16 @@ }, "patch": { "tags": [ - "Dsr Appointment Request" + "Dsr Appointment Attendee" ], - "summary": "Partially update information about a Dsr Appointment Request resource.", + "summary": "Partially update information about a Dsr Appointment Attendee resource.", "description": "", - "operationId": "updateDsrAppointmentRequest", + "operationId": "updateDsrAppointmentAttendee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_request", + "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", @@ -3124,18 +3124,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Appointment Request resource.", + "description": "Partially update information about a Dsr Appointment Attendee resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -3147,7 +3147,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -3162,7 +3162,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -3181,14 +3181,14 @@ } } }, - "/aggregate/dsr-appointment-request": { + "/aggregate/dsr-appointment-attendee": { "post": { "tags": [ - "Dsr Appointment Request" + "Dsr Appointment Attendee" ], - "summary": "Aggregate for the Dsr Appointment Request resources.", + "summary": "Aggregate for the Dsr Appointment Attendee resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointmentRequest", + "operationId": "aggregateDsrAppointmentAttendee", "requestBody": { "required": true, "content": { @@ -3212,7 +3212,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentRequest", + "description": "List of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -3226,7 +3226,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -3244,7 +3244,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -3261,14 +3261,14 @@ } } }, - "/dsr-appointment-video-chat": { + "/dsr-appointment-request": { "get": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Appointment Request" ], - "summary": "List with basic information of Dsr Appointment Video Chat resources.", + "summary": "List with basic information of Dsr Appointment Request resources.", "description": "", - "operationId": "getDsrAppointmentVideoChatList", + "operationId": "getDsrAppointmentRequestList", "parameters": [ { "name": "limit", @@ -3297,7 +3297,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment Video Chat resources.", + "description": "List of Dsr Appointment Request resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3316,7 +3316,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } ] @@ -3330,16 +3330,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment-video-chat?limit=25" + "example": "/dsr-appointment-request?limit=25" }, "last": { - "example": "/dsr-appointment-video-chat?limit=25&page=11" + "example": "/dsr-appointment-request?limit=25&page=11" }, "next": { - "example": "/dsr-appointment-video-chat?limit=25&page=4" + "example": "/dsr-appointment-request?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment-video-chat?limit=25&page=2" + "example": "/dsr-appointment-request?limit=25&page=2" } } } @@ -3360,7 +3360,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -3375,11 +3375,11 @@ }, "post": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Appointment Request" ], - "summary": "Create a new Dsr Appointment Video Chat resources.", + "summary": "Create a new Dsr Appointment Request resources.", "description": "", - "operationId": "createDsrAppointmentVideoChat", + "operationId": "createDsrAppointmentRequest", "parameters": [ { "name": "_response", @@ -3398,14 +3398,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -3417,7 +3417,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -3432,7 +3432,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -3448,14 +3448,14 @@ } } }, - "/search/dsr-appointment-video-chat": { + "/search/dsr-appointment-request": { "post": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Appointment Request" ], - "summary": "Search for the Dsr Appointment Video Chat resources.", + "summary": "Search for the Dsr Appointment Request resources.", "description": "", - "operationId": "searchDsrAppointmentVideoChat", + "operationId": "searchDsrAppointmentRequest", "parameters": [ { "name": "sw-include-search-info", @@ -3483,7 +3483,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentVideoChat", + "description": "List of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -3497,7 +3497,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -3515,7 +3515,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -3532,19 +3532,19 @@ } } }, - "/dsr-appointment-video-chat/{id}": { + "/dsr-appointment-request/{id}": { "get": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Appointment Request" ], - "summary": "Detailed information about a Dsr Appointment Video Chat resource.", + "summary": "Detailed information about a Dsr Appointment Request resource.", "description": "", - "operationId": "getDsrAppointmentVideoChat", + "operationId": "getDsrAppointmentRequest", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", + "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", @@ -3554,7 +3554,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -3566,7 +3566,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -3581,7 +3581,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -3598,16 +3598,16 @@ }, "delete": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Appointment Request" ], - "summary": "Delete a Dsr Appointment Video Chat resource.", + "summary": "Delete a Dsr Appointment Request resource.", "description": "", - "operationId": "deleteDsrAppointmentVideoChat", + "operationId": "deleteDsrAppointmentRequest", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", + "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", @@ -3638,16 +3638,16 @@ }, "patch": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Appointment Request" ], - "summary": "Partially update information about a Dsr Appointment Video Chat resource.", + "summary": "Partially update information about a Dsr Appointment Request resource.", "description": "", - "operationId": "updateDsrAppointmentVideoChat", + "operationId": "updateDsrAppointmentRequest", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", + "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", @@ -3665,18 +3665,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Appointment Video Chat resource.", + "description": "Partially update information about a Dsr Appointment Request resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -3688,7 +3688,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -3703,7 +3703,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -3722,14 +3722,14 @@ } } }, - "/aggregate/dsr-appointment-video-chat": { + "/aggregate/dsr-appointment-request": { "post": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Appointment Request" ], - "summary": "Aggregate for the Dsr Appointment Video Chat resources.", + "summary": "Aggregate for the Dsr Appointment Request resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointmentVideoChat", + "operationId": "aggregateDsrAppointmentRequest", "requestBody": { "required": true, "content": { @@ -3753,7 +3753,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentVideoChat", + "description": "List of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -3767,7 +3767,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -3785,7 +3785,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -3802,14 +3802,14 @@ } } }, - "/dsr-attendee-product-collection": { + "/dsr-appointment-video-chat": { "get": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Appointment Video Chat" ], - "summary": "List with basic information of Dsr Attendee Product Collection resources.", + "summary": "List with basic information of Dsr Appointment Video Chat resources.", "description": "", - "operationId": "getDsrAttendeeProductCollectionList", + "operationId": "getDsrAppointmentVideoChatList", "parameters": [ { "name": "limit", @@ -3838,7 +3838,7 @@ ], "responses": { "200": { - "description": "List of Dsr Attendee Product Collection resources.", + "description": "List of Dsr Appointment Video Chat resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3857,7 +3857,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } ] @@ -3871,16 +3871,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-attendee-product-collection?limit=25" + "example": "/dsr-appointment-video-chat?limit=25" }, "last": { - "example": "/dsr-attendee-product-collection?limit=25&page=11" + "example": "/dsr-appointment-video-chat?limit=25&page=11" }, "next": { - "example": "/dsr-attendee-product-collection?limit=25&page=4" + "example": "/dsr-appointment-video-chat?limit=25&page=4" }, "prev": { - "example": "/dsr-attendee-product-collection?limit=25&page=2" + "example": "/dsr-appointment-video-chat?limit=25&page=2" } } } @@ -3901,7 +3901,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -3916,11 +3916,11 @@ }, "post": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Appointment Video Chat" ], - "summary": "Create a new Dsr Attendee Product Collection resources.", + "summary": "Create a new Dsr Appointment Video Chat resources.", "description": "", - "operationId": "createDsrAttendeeProductCollection", + "operationId": "createDsrAppointmentVideoChat", "parameters": [ { "name": "_response", @@ -3939,14 +3939,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } }, "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -3958,7 +3958,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -3973,7 +3973,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -3989,14 +3989,14 @@ } } }, - "/search/dsr-attendee-product-collection": { + "/search/dsr-appointment-video-chat": { "post": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Appointment Video Chat" ], - "summary": "Search for the Dsr Attendee Product Collection resources.", + "summary": "Search for the Dsr Appointment Video Chat resources.", "description": "", - "operationId": "searchDsrAttendeeProductCollection", + "operationId": "searchDsrAppointmentVideoChat", "parameters": [ { "name": "sw-include-search-info", @@ -4024,7 +4024,7 @@ }, "responses": { "200": { - "description": "List of DsrAttendeeProductCollection", + "description": "List of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -4038,7 +4038,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -4056,7 +4056,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -4073,19 +4073,19 @@ } } }, - "/dsr-attendee-product-collection/{id}": { + "/dsr-appointment-video-chat/{id}": { "get": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Appointment Video Chat" ], - "summary": "Detailed information about a Dsr Attendee Product Collection resource.", + "summary": "Detailed information about a Dsr Appointment Video Chat resource.", "description": "", - "operationId": "getDsrAttendeeProductCollection", + "operationId": "getDsrAppointmentVideoChat", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", + "description": "Identifier for the dsr_appointment_video_chat", "required": true, "schema": { "type": "string", @@ -4095,7 +4095,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -4107,7 +4107,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -4122,7 +4122,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -4139,16 +4139,16 @@ }, "delete": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Appointment Video Chat" ], - "summary": "Delete a Dsr Attendee Product Collection resource.", + "summary": "Delete a Dsr Appointment Video Chat resource.", "description": "", - "operationId": "deleteDsrAttendeeProductCollection", + "operationId": "deleteDsrAppointmentVideoChat", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", + "description": "Identifier for the dsr_appointment_video_chat", "required": true, "schema": { "type": "string", @@ -4179,16 +4179,16 @@ }, "patch": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Appointment Video Chat" ], - "summary": "Partially update information about a Dsr Attendee Product Collection resource.", + "summary": "Partially update information about a Dsr Appointment Video Chat resource.", "description": "", - "operationId": "updateDsrAttendeeProductCollection", + "operationId": "updateDsrAppointmentVideoChat", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", + "description": "Identifier for the dsr_appointment_video_chat", "required": true, "schema": { "type": "string", @@ -4206,18 +4206,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Attendee Product Collection resource.", + "description": "Partially update information about a Dsr Appointment Video Chat resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } }, "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -4229,7 +4229,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -4244,7 +4244,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -4263,14 +4263,14 @@ } } }, - "/aggregate/dsr-attendee-product-collection": { + "/aggregate/dsr-appointment-video-chat": { "post": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Appointment Video Chat" ], - "summary": "Aggregate for the Dsr Attendee Product Collection resources.", + "summary": "Aggregate for the Dsr Appointment Video Chat resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAttendeeProductCollection", + "operationId": "aggregateDsrAppointmentVideoChat", "requestBody": { "required": true, "content": { @@ -4294,7 +4294,7 @@ }, "responses": { "200": { - "description": "List of DsrAttendeeProductCollection", + "description": "List of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -4308,7 +4308,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -4326,7 +4326,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -4343,14 +4343,14 @@ } } }, - "/dsr-cms-slide": { + "/dsr-attendee-product-collection": { "get": { "tags": [ - "Dsr Cms Slide" + "Dsr Attendee Product Collection" ], - "summary": "List with basic information of Dsr Cms Slide resources.", + "summary": "List with basic information of Dsr Attendee Product Collection resources.", "description": "", - "operationId": "getDsrCmsSlideList", + "operationId": "getDsrAttendeeProductCollectionList", "parameters": [ { "name": "limit", @@ -4379,7 +4379,7 @@ ], "responses": { "200": { - "description": "List of Dsr Cms Slide resources.", + "description": "List of Dsr Attendee Product Collection resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4398,7 +4398,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } ] @@ -4412,16 +4412,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-cms-slide?limit=25" + "example": "/dsr-attendee-product-collection?limit=25" }, "last": { - "example": "/dsr-cms-slide?limit=25&page=11" + "example": "/dsr-attendee-product-collection?limit=25&page=11" }, "next": { - "example": "/dsr-cms-slide?limit=25&page=4" + "example": "/dsr-attendee-product-collection?limit=25&page=4" }, "prev": { - "example": "/dsr-cms-slide?limit=25&page=2" + "example": "/dsr-attendee-product-collection?limit=25&page=2" } } } @@ -4442,7 +4442,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -4457,11 +4457,11 @@ }, "post": { "tags": [ - "Dsr Cms Slide" + "Dsr Attendee Product Collection" ], - "summary": "Create a new Dsr Cms Slide resources.", + "summary": "Create a new Dsr Attendee Product Collection resources.", "description": "", - "operationId": "createDsrCmsSlide", + "operationId": "createDsrAttendeeProductCollection", "parameters": [ { "name": "_response", @@ -4480,14 +4480,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } }, "responses": { "200": { - "description": "Detail of DsrCmsSlide", + "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -4499,7 +4499,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -4514,7 +4514,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -4530,14 +4530,14 @@ } } }, - "/search/dsr-cms-slide": { + "/search/dsr-attendee-product-collection": { "post": { "tags": [ - "Dsr Cms Slide" + "Dsr Attendee Product Collection" ], - "summary": "Search for the Dsr Cms Slide resources.", + "summary": "Search for the Dsr Attendee Product Collection resources.", "description": "", - "operationId": "searchDsrCmsSlide", + "operationId": "searchDsrAttendeeProductCollection", "parameters": [ { "name": "sw-include-search-info", @@ -4565,7 +4565,7 @@ }, "responses": { "200": { - "description": "List of DsrCmsSlide", + "description": "List of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -4579,7 +4579,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -4597,7 +4597,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -4614,19 +4614,19 @@ } } }, - "/dsr-cms-slide/{id}": { + "/dsr-attendee-product-collection/{id}": { "get": { "tags": [ - "Dsr Cms Slide" + "Dsr Attendee Product Collection" ], - "summary": "Detailed information about a Dsr Cms Slide resource.", + "summary": "Detailed information about a Dsr Attendee Product Collection resource.", "description": "", - "operationId": "getDsrCmsSlide", + "operationId": "getDsrAttendeeProductCollection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_cms_slide", + "description": "Identifier for the dsr_attendee_product_collection", "required": true, "schema": { "type": "string", @@ -4636,7 +4636,7 @@ ], "responses": { "200": { - "description": "Detail of DsrCmsSlide", + "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -4648,7 +4648,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -4663,7 +4663,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -4680,16 +4680,16 @@ }, "delete": { "tags": [ - "Dsr Cms Slide" + "Dsr Attendee Product Collection" ], - "summary": "Delete a Dsr Cms Slide resource.", + "summary": "Delete a Dsr Attendee Product Collection resource.", "description": "", - "operationId": "deleteDsrCmsSlide", + "operationId": "deleteDsrAttendeeProductCollection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_cms_slide", + "description": "Identifier for the dsr_attendee_product_collection", "required": true, "schema": { "type": "string", @@ -4720,16 +4720,16 @@ }, "patch": { "tags": [ - "Dsr Cms Slide" + "Dsr Attendee Product Collection" ], - "summary": "Partially update information about a Dsr Cms Slide resource.", + "summary": "Partially update information about a Dsr Attendee Product Collection resource.", "description": "", - "operationId": "updateDsrCmsSlide", + "operationId": "updateDsrAttendeeProductCollection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_cms_slide", + "description": "Identifier for the dsr_attendee_product_collection", "required": true, "schema": { "type": "string", @@ -4747,18 +4747,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Cms Slide resource.", + "description": "Partially update information about a Dsr Attendee Product Collection resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } }, "responses": { "200": { - "description": "Detail of DsrCmsSlide", + "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -4770,7 +4770,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -4785,7 +4785,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -4804,14 +4804,14 @@ } } }, - "/aggregate/dsr-cms-slide": { + "/aggregate/dsr-attendee-product-collection": { "post": { "tags": [ - "Dsr Cms Slide" + "Dsr Attendee Product Collection" ], - "summary": "Aggregate for the Dsr Cms Slide resources.", + "summary": "Aggregate for the Dsr Attendee Product Collection resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrCmsSlide", + "operationId": "aggregateDsrAttendeeProductCollection", "requestBody": { "required": true, "content": { @@ -4835,7 +4835,7 @@ }, "responses": { "200": { - "description": "List of DsrCmsSlide", + "description": "List of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -4849,7 +4849,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -4867,7 +4867,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -4884,14 +4884,14 @@ } } }, - "/dsr-interaction": { + "/dsr-cms-slide": { "get": { "tags": [ - "Dsr Interaction" + "Dsr Cms Slide" ], - "summary": "List with basic information of Dsr Interaction resources.", + "summary": "List with basic information of Dsr Cms Slide resources.", "description": "", - "operationId": "getDsrInteractionList", + "operationId": "getDsrCmsSlideList", "parameters": [ { "name": "limit", @@ -4920,7 +4920,7 @@ ], "responses": { "200": { - "description": "List of Dsr Interaction resources.", + "description": "List of Dsr Cms Slide resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4939,7 +4939,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } ] @@ -4953,16 +4953,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-interaction?limit=25" + "example": "/dsr-cms-slide?limit=25" }, "last": { - "example": "/dsr-interaction?limit=25&page=11" + "example": "/dsr-cms-slide?limit=25&page=11" }, "next": { - "example": "/dsr-interaction?limit=25&page=4" + "example": "/dsr-cms-slide?limit=25&page=4" }, "prev": { - "example": "/dsr-interaction?limit=25&page=2" + "example": "/dsr-cms-slide?limit=25&page=2" } } } @@ -4983,7 +4983,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -4998,11 +4998,11 @@ }, "post": { "tags": [ - "Dsr Interaction" + "Dsr Cms Slide" ], - "summary": "Create a new Dsr Interaction resources.", + "summary": "Create a new Dsr Cms Slide resources.", "description": "", - "operationId": "createDsrInteraction", + "operationId": "createDsrCmsSlide", "parameters": [ { "name": "_response", @@ -5021,14 +5021,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } }, "responses": { "200": { - "description": "Detail of DsrInteraction", + "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -5040,7 +5040,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -5055,7 +5055,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -5071,14 +5071,14 @@ } } }, - "/search/dsr-interaction": { + "/search/dsr-cms-slide": { "post": { "tags": [ - "Dsr Interaction" + "Dsr Cms Slide" ], - "summary": "Search for the Dsr Interaction resources.", + "summary": "Search for the Dsr Cms Slide resources.", "description": "", - "operationId": "searchDsrInteraction", + "operationId": "searchDsrCmsSlide", "parameters": [ { "name": "sw-include-search-info", @@ -5106,7 +5106,7 @@ }, "responses": { "200": { - "description": "List of DsrInteraction", + "description": "List of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -5120,7 +5120,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -5138,7 +5138,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -5155,19 +5155,19 @@ } } }, - "/dsr-interaction/{id}": { + "/dsr-cms-slide/{id}": { "get": { "tags": [ - "Dsr Interaction" + "Dsr Cms Slide" ], - "summary": "Detailed information about a Dsr Interaction resource.", + "summary": "Detailed information about a Dsr Cms Slide resource.", "description": "", - "operationId": "getDsrInteraction", + "operationId": "getDsrCmsSlide", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_interaction", + "description": "Identifier for the dsr_cms_slide", "required": true, "schema": { "type": "string", @@ -5177,7 +5177,7 @@ ], "responses": { "200": { - "description": "Detail of DsrInteraction", + "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -5189,7 +5189,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -5204,7 +5204,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -5221,16 +5221,16 @@ }, "delete": { "tags": [ - "Dsr Interaction" + "Dsr Cms Slide" ], - "summary": "Delete a Dsr Interaction resource.", + "summary": "Delete a Dsr Cms Slide resource.", "description": "", - "operationId": "deleteDsrInteraction", + "operationId": "deleteDsrCmsSlide", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_interaction", + "description": "Identifier for the dsr_cms_slide", "required": true, "schema": { "type": "string", @@ -5261,16 +5261,16 @@ }, "patch": { "tags": [ - "Dsr Interaction" + "Dsr Cms Slide" ], - "summary": "Partially update information about a Dsr Interaction resource.", + "summary": "Partially update information about a Dsr Cms Slide resource.", "description": "", - "operationId": "updateDsrInteraction", + "operationId": "updateDsrCmsSlide", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_interaction", + "description": "Identifier for the dsr_cms_slide", "required": true, "schema": { "type": "string", @@ -5288,18 +5288,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Interaction resource.", + "description": "Partially update information about a Dsr Cms Slide resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } }, "responses": { "200": { - "description": "Detail of DsrInteraction", + "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -5311,7 +5311,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -5326,7 +5326,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -5345,14 +5345,14 @@ } } }, - "/aggregate/dsr-interaction": { + "/aggregate/dsr-cms-slide": { "post": { "tags": [ - "Dsr Interaction" + "Dsr Cms Slide" ], - "summary": "Aggregate for the Dsr Interaction resources.", + "summary": "Aggregate for the Dsr Cms Slide resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrInteraction", + "operationId": "aggregateDsrCmsSlide", "requestBody": { "required": true, "content": { @@ -5376,7 +5376,7 @@ }, "responses": { "200": { - "description": "List of DsrInteraction", + "description": "List of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -5390,7 +5390,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -5408,7 +5408,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -5425,14 +5425,14 @@ } } }, - "/dsr-presentation": { + "/dsr-interaction": { "get": { "tags": [ - "Dsr Presentation" + "Dsr Interaction" ], - "summary": "List with basic information of Dsr Presentation resources.", + "summary": "List with basic information of Dsr Interaction resources.", "description": "", - "operationId": "getDsrPresentationList", + "operationId": "getDsrInteractionList", "parameters": [ { "name": "limit", @@ -5461,7 +5461,7 @@ ], "responses": { "200": { - "description": "List of Dsr Presentation resources.", + "description": "List of Dsr Interaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5480,7 +5480,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } ] @@ -5494,16 +5494,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-presentation?limit=25" + "example": "/dsr-interaction?limit=25" }, "last": { - "example": "/dsr-presentation?limit=25&page=11" + "example": "/dsr-interaction?limit=25&page=11" }, "next": { - "example": "/dsr-presentation?limit=25&page=4" + "example": "/dsr-interaction?limit=25&page=4" }, "prev": { - "example": "/dsr-presentation?limit=25&page=2" + "example": "/dsr-interaction?limit=25&page=2" } } } @@ -5524,7 +5524,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -5539,11 +5539,11 @@ }, "post": { "tags": [ - "Dsr Presentation" + "Dsr Interaction" ], - "summary": "Create a new Dsr Presentation resources.", + "summary": "Create a new Dsr Interaction resources.", "description": "", - "operationId": "createDsrPresentation", + "operationId": "createDsrInteraction", "parameters": [ { "name": "_response", @@ -5562,14 +5562,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } }, "responses": { "200": { - "description": "Detail of DsrPresentation", + "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -5581,7 +5581,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -5596,7 +5596,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -5612,14 +5612,14 @@ } } }, - "/search/dsr-presentation": { + "/search/dsr-interaction": { "post": { "tags": [ - "Dsr Presentation" + "Dsr Interaction" ], - "summary": "Search for the Dsr Presentation resources.", + "summary": "Search for the Dsr Interaction resources.", "description": "", - "operationId": "searchDsrPresentation", + "operationId": "searchDsrInteraction", "parameters": [ { "name": "sw-include-search-info", @@ -5647,7 +5647,7 @@ }, "responses": { "200": { - "description": "List of DsrPresentation", + "description": "List of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -5661,7 +5661,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -5679,7 +5679,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -5696,19 +5696,19 @@ } } }, - "/dsr-presentation/{id}": { + "/dsr-interaction/{id}": { "get": { "tags": [ - "Dsr Presentation" + "Dsr Interaction" ], - "summary": "Detailed information about a Dsr Presentation resource.", + "summary": "Detailed information about a Dsr Interaction resource.", "description": "", - "operationId": "getDsrPresentation", + "operationId": "getDsrInteraction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_presentation", + "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", @@ -5718,7 +5718,7 @@ ], "responses": { "200": { - "description": "Detail of DsrPresentation", + "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -5730,7 +5730,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -5745,7 +5745,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -5762,16 +5762,16 @@ }, "delete": { "tags": [ - "Dsr Presentation" + "Dsr Interaction" ], - "summary": "Delete a Dsr Presentation resource.", + "summary": "Delete a Dsr Interaction resource.", "description": "", - "operationId": "deleteDsrPresentation", + "operationId": "deleteDsrInteraction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_presentation", + "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", @@ -5802,16 +5802,16 @@ }, "patch": { "tags": [ - "Dsr Presentation" + "Dsr Interaction" ], - "summary": "Partially update information about a Dsr Presentation resource.", + "summary": "Partially update information about a Dsr Interaction resource.", "description": "", - "operationId": "updateDsrPresentation", + "operationId": "updateDsrInteraction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_presentation", + "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", @@ -5829,18 +5829,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Presentation resource.", + "description": "Partially update information about a Dsr Interaction resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } }, "responses": { "200": { - "description": "Detail of DsrPresentation", + "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -5852,7 +5852,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -5867,7 +5867,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -5886,14 +5886,14 @@ } } }, - "/aggregate/dsr-presentation": { + "/aggregate/dsr-interaction": { "post": { "tags": [ - "Dsr Presentation" + "Dsr Interaction" ], - "summary": "Aggregate for the Dsr Presentation resources.", + "summary": "Aggregate for the Dsr Interaction resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrPresentation", + "operationId": "aggregateDsrInteraction", "requestBody": { "required": true, "content": { @@ -5917,7 +5917,7 @@ }, "responses": { "200": { - "description": "List of DsrPresentation", + "description": "List of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -5931,7 +5931,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -5949,7 +5949,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -5966,14 +5966,14 @@ } } }, - "/dsr-presentation-cms-page": { + "/dsr-presentation": { "get": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Presentation" ], - "summary": "List with basic information of Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getDsrPresentationCmsPageList", + "summary": "List with basic information of Dsr Presentation resources.", + "description": "", + "operationId": "getDsrPresentationList", "parameters": [ { "name": "limit", @@ -6002,7 +6002,7 @@ ], "responses": { "200": { - "description": "List of Dsr Presentation Cms Page resources.", + "description": "List of Dsr Presentation resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6021,7 +6021,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } ] @@ -6035,16 +6035,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-presentation-cms-page?limit=25" + "example": "/dsr-presentation?limit=25" }, "last": { - "example": "/dsr-presentation-cms-page?limit=25&page=11" + "example": "/dsr-presentation?limit=25&page=11" }, "next": { - "example": "/dsr-presentation-cms-page?limit=25&page=4" + "example": "/dsr-presentation?limit=25&page=4" }, "prev": { - "example": "/dsr-presentation-cms-page?limit=25&page=2" + "example": "/dsr-presentation?limit=25&page=2" } } } @@ -6065,7 +6065,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -6080,11 +6080,11 @@ }, "post": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Presentation" ], - "summary": "Create a new Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createDsrPresentationCmsPage", + "summary": "Create a new Dsr Presentation resources.", + "description": "", + "operationId": "createDsrPresentation", "parameters": [ { "name": "_response", @@ -6103,14 +6103,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } }, "responses": { "200": { - "description": "Detail of DsrPresentationCmsPage", + "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -6122,7 +6122,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -6137,7 +6137,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -6153,14 +6153,14 @@ } } }, - "/search/dsr-presentation-cms-page": { + "/search/dsr-presentation": { "post": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Presentation" ], - "summary": "Search for the Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchDsrPresentationCmsPage", + "summary": "Search for the Dsr Presentation resources.", + "description": "", + "operationId": "searchDsrPresentation", "parameters": [ { "name": "sw-include-search-info", @@ -6188,7 +6188,7 @@ }, "responses": { "200": { - "description": "List of DsrPresentationCmsPage", + "description": "List of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -6202,7 +6202,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -6220,7 +6220,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -6237,19 +6237,19 @@ } } }, - "/dsr-presentation-cms-page/{id}": { + "/dsr-presentation/{id}": { "get": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Presentation" ], - "summary": "Detailed information about a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDsrPresentationCmsPage", + "summary": "Detailed information about a Dsr Presentation resource.", + "description": "", + "operationId": "getDsrPresentation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", + "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", @@ -6259,7 +6259,7 @@ ], "responses": { "200": { - "description": "Detail of DsrPresentationCmsPage", + "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -6271,7 +6271,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -6286,7 +6286,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -6303,16 +6303,16 @@ }, "delete": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Presentation" ], - "summary": "Delete a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteDsrPresentationCmsPage", + "summary": "Delete a Dsr Presentation resource.", + "description": "", + "operationId": "deleteDsrPresentation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", + "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", @@ -6343,16 +6343,16 @@ }, "patch": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Presentation" ], - "summary": "Partially update information about a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateDsrPresentationCmsPage", + "summary": "Partially update information about a Dsr Presentation resource.", + "description": "", + "operationId": "updateDsrPresentation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", + "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", @@ -6370,18 +6370,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Presentation Cms Page resource.", + "description": "Partially update information about a Dsr Presentation resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } }, "responses": { "200": { - "description": "Detail of DsrPresentationCmsPage", + "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -6393,7 +6393,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -6408,7 +6408,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -6427,14 +6427,14 @@ } } }, - "/aggregate/dsr-presentation-cms-page": { + "/aggregate/dsr-presentation": { "post": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Presentation" ], - "summary": "Aggregate for the Dsr Presentation Cms Page resources.", + "summary": "Aggregate for the Dsr Presentation resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrPresentationCmsPage", + "operationId": "aggregateDsrPresentation", "requestBody": { "required": true, "content": { @@ -6458,7 +6458,7 @@ }, "responses": { "200": { - "description": "List of DsrPresentationCmsPage", + "description": "List of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -6472,7 +6472,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -6490,7 +6490,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -6507,300 +6507,2395 @@ } } }, - "/_action/number-range/{numberRangeId}/preview-pattern": { + "/dsr-presentation-cms-page": { "get": { "tags": [ - "Number Range Management" + "Dsr Presentation Cms Page" ], - "summary": "Preview a persisted number range", - "description": "Previews the next value for a concrete persisted number range without incrementing its state. Optional `pattern` and `start` query parameters can be used to preview unsaved changes while editing the number range. Use `/_action/number-range/reserve/{type}` for actual allocation by business type and sales channel.", - "operationId": "numberRangePreviewPatternById", + "summary": "List with basic information of Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDsrPresentationCmsPageList", "parameters": [ { - "name": "numberRangeId", - "in": "path", - "description": "Identifier of the number range to preview.", - "required": true, + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "integer" } }, { - "name": "pattern", + "name": "page", "in": "query", - "description": "Optional pattern override for the preview.", - "required": false, + "description": "The page to be returned", "schema": { - "type": "string" + "type": "integer" } }, { - "name": "start", + "name": "query", "in": "query", - "description": "Optional start value override for the preview.", - "required": false, + "description": "Encoded SwagQL in JSON", "schema": { - "type": "integer" + "type": "string" } } ], "responses": { "200": { - "description": "The previewed number", + "description": "List of Dsr Presentation Cms Page resources.", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-presentation-cms-page?limit=25" + }, + "last": { + "example": "/dsr-presentation-cms-page?limit=25&page=11" + }, + "next": { + "example": "/dsr-presentation-cms-page?limit=25&page=4" + }, + "prev": { + "example": "/dsr-presentation-cms-page?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, "application/json": { "schema": { + "type": "object", "properties": { - "number": { - "description": "The previewed number.", - "type": "string" + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } } - }, - "type": "object" + } } } } }, - "404": { - "description": "Number range not found" + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/integration/{integrationId}/mcp-allowlist": { + }, "post": { "tags": [ - "MCP", - "Experimental" + "Dsr Presentation Cms Page" ], - "summary": "Save MCP allowlist for an integration", - "description": "Saves the per-integration MCP allowlist covering tools, resources, and prompts. Pass `null` as the top-level value to allow all capabilities unrestricted. Pass an object with `tools`, `resources`, and `prompts` keys where each key is either `null` (unrestricted for that type) or a list of allowed names/URIs (empty array = deny all of that type). Requires `integration_mcp.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "saveMcpAllowlist", + "summary": "Create a new Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDsrPresentationCmsPage", "parameters": [ { - "name": "integrationId", - "in": "path", - "required": true, - "description": "The integration UUID.", + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "basic", + "detail" + ] } } ], - "security": [ - { - "oAuth": [ - "write" - ] - } - ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "allowlist" - ], - "properties": { - "allowlist": { - "oneOf": [ - { - "type": "object", - "description": "Per-type allowlist. Each key is null (unrestricted) or a list of allowed names/URIs.", - "properties": { - "tools": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of allowed tool names. Empty array = no tools allowed." - }, - { - "type": "null", - "description": "Null = all tools allowed." - } - ] - }, - "resources": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of allowed resource URIs. Empty array = no resources allowed." - }, - { - "type": "null", - "description": "Null = all resources allowed." - } - ] - }, - "prompts": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of allowed prompt names. Empty array = no prompts allowed." - }, - { - "type": "null", - "description": "Null = all prompts allowed." - } - ] - } + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" } - }, - { - "type": "null", - "description": "Null = all capabilities unrestricted." } - ] + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } } } } } - } - }, - "responses": { - "204": { - "description": "Allowlist saved successfully." }, "400": { - "description": "Bad request — missing or invalid `allowlist` field." + "$ref": "#/components/responses/400" }, "401": { - "description": "Unauthorized — missing or invalid credentials." - }, - "403": { - "description": "Forbidden — caller lacks `integration_mcp.editor` privilege." - }, - "404": { - "description": "Integration not found." + "$ref": "#/components/responses/401" } } } }, - "/_action/user/{userId}/mcp-allowlist": { + "/search/dsr-presentation-cms-page": { "post": { "tags": [ - "MCP", - "Experimental" + "Dsr Presentation Cms Page" ], - "summary": "Save MCP allowlist for a user", - "description": "Saves the per-user MCP allowlist covering tools, resources, and prompts. Pass `null` as the top-level value to allow all capabilities unrestricted. Pass an object with `tools`, `resources`, and `prompts` keys where each key is either `null` (unrestricted for that type) or a list of allowed names/URIs (empty array = deny all of that type). Requires `users_and_permissions.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "saveMcpAllowlistUser", + "summary": "Search for the Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDsrPresentationCmsPage", "parameters": [ { - "name": "userId", - "in": "path", - "required": true, - "description": "The user UUID.", + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "0", + "1" + ], + "default": "1" } } ], - "security": [ - { - "oAuth": [ - "write" - ] - } - ], "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "allowlist" - ], - "properties": { - "allowlist": { - "oneOf": [ - { - "type": "object", - "description": "Per-type allowlist. Each key is null (unrestricted) or a list of allowed names/URIs.", - "properties": { - "tools": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of allowed tool names. Empty array = no tools allowed." - }, - { - "type": "null", - "description": "Null = all tools allowed." - } - ] - }, - "resources": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of allowed resource URIs. Empty array = no resources allowed." - }, - { - "type": "null", - "description": "Null = all resources allowed." - } - ] - }, - "prompts": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of allowed prompt names. Empty array = no prompts allowed." - }, - { - "type": "null", - "description": "Null = all prompts allowed." - } - ] + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } - }, - { - "type": "null", - "description": "Null = all capabilities unrestricted." } - ] + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } } } } } - } - }, - "responses": { - "204": { - "description": "Allowlist saved successfully." }, "400": { - "description": "Bad request — missing or invalid `allowlist` field." + "$ref": "#/components/responses/400" }, "401": { - "description": "Unauthorized — missing or invalid credentials." - }, + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-presentation-cms-page/{id}": { + "get": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Detailed information about a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDsrPresentationCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation_cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Delete a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteDsrPresentationCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation_cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Partially update information about a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateDsrPresentationCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation_cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Presentation Cms Page resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/dsr-presentation-cms-page": { + "post": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Aggregate for the Dsr Presentation Cms Page resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrPresentationCmsPage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel-file": { + "get": { + "tags": [ + "Sales Channel File" + ], + "summary": "List with basic information of Sales Channel File resources.", + "description": "Available since: 6.7.12.0", + "operationId": "getSalesChannelFileList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Sales Channel File resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/sales-channel-file?limit=25" + }, + "last": { + "example": "/sales-channel-file?limit=25&page=11" + }, + "next": { + "example": "/sales-channel-file?limit=25&page=4" + }, + "prev": { + "example": "/sales-channel-file?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Sales Channel File" + ], + "summary": "Create a new Sales Channel File resources.", + "description": "Available since: 6.7.12.0", + "operationId": "createSalesChannelFile", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SalesChannelFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/sales-channel-file": { + "post": { + "tags": [ + "Sales Channel File" + ], + "summary": "Search for the Sales Channel File resources.", + "description": "Available since: 6.7.12.0", + "operationId": "searchSalesChannelFile", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel-file/{id}": { + "get": { + "tags": [ + "Sales Channel File" + ], + "summary": "Detailed information about a Sales Channel File resource.", + "description": "Available since: 6.7.12.0", + "operationId": "getSalesChannelFile", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sales_channel_file", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SalesChannelFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Sales Channel File" + ], + "summary": "Delete a Sales Channel File resource.", + "description": "Available since: 6.7.12.0", + "operationId": "deleteSalesChannelFile", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sales_channel_file", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Sales Channel File" + ], + "summary": "Partially update information about a Sales Channel File resource.", + "description": "Available since: 6.7.12.0", + "operationId": "updateSalesChannelFile", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sales_channel_file", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Sales Channel File resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SalesChannelFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/sales-channel-file": { + "post": { + "tags": [ + "Sales Channel File" + ], + "summary": "Aggregate for the Sales Channel File resources.", + "description": "Available since: 6.7.12.0", + "operationId": "aggregateSalesChannelFile", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFile" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/_action/mail-template/simulate": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Simulate a mail template", + "description": "Generates simulated data for a given event name and renders the provided mail template content against it.", + "operationId": "simulateMailTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "templateParts", + "eventName" + ], + "properties": { + "templateParts": { + "description": "A map of mail template fields and their template content to render.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "example": { + "subject": "Order {{ order.orderNumber }} confirmation", + "senderName": "{{ salesChannel.name }}", + "contentHtml": "
Hello {{ order.orderCustomer.firstName }}
", + "contentPlain": "Hello {{ order.orderCustomer.firstName }}" + } + }, + "eventName": { + "description": "The business event name used to generate simulated mail template data.", + "type": "string", + "example": "checkout.order.placed" + }, + "salesChannelId": { + "description": "Identifier of the sales channel that should be used for the simulate request.", + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a" + }, + "strictRendering": { + "description": "Enables strict variable rendering and surfaces errors for unknown variables. Defaults to `true`.", + "type": "boolean", + "default": true + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The rendered preview of the mail template.", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A map of render results keyed by the same field names that were provided in the request's `templateParts` object.", + "additionalProperties": { + "type": "object", + "required": [ + "type", + "content" + ], + "properties": { + "type": { + "description": "The type of the render result (either `success` or `error`)", + "type": "string", + "enum": [ + "success", + "error" + ], + "example": "success" + }, + "content": { + "description": "The rendered content of the mail template field. Also contains the error when rendering this field wasn't possible.", + "type": "string", + "example": "Example mail" + } + } + } + } + } + } + }, + "400": { + "description": "Invalid request data or invalid eventName", + "$ref": "#/components/responses/400" + } + } + } + }, + "/_action/mail-template/preview": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Preview a mail template", + "description": "Fetches the required data needed for the mail template and generates a preview.", + "operationId": "mailTemplatePreview", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "mailTemplateId" + ], + "properties": { + "mailTemplateId": { + "description": "Identifier of the mail template which should be rendered.", + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b3c4d5e6f7a8b90a1b2c3d4e5f678906" + }, + "salesChannelId": { + "description": "Identifier of the sales channel that should be used for the preview request.", + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a" + }, + "includeHeaderFooter": { + "description": "Includes the sales channel mail header and footer in `contentHtml` and `contentPlain`. Defaults to `false`.", + "type": "boolean", + "default": false + }, + "strictRendering": { + "description": "Enables strict variable rendering and enables errors on e.g. unknown variables. Defaults to `false`.", + "type": "boolean", + "default": false + }, + "entities": { + "description": "A map of entity names and corresponding identifiers that define entities which should be used additionally during rendering.", + "type": "object", + "additionalProperties": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "example": { + "order": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a", + "customer": "a1b2c3d4e5f67890b3c4d5e6f7a8b90a" + } + }, + "templateData": { + "description": "A map of template data that should be used additionally during rendering. Values in this map override generated or entity-derived template data with the same top-level keys.", + "type": "object", + "additionalProperties": true, + "example": { + "salesChannel": { + "name": "Storefront" + }, + "order": { + "orderNumber": "SW10042" + } + } + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The rendered preview of the mail template.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "subject", + "senderName", + "contentHtml", + "contentPlain" + ], + "properties": { + "subject": { + "type": "object", + "required": [ + "type", + "content" + ], + "properties": { + "type": { + "description": "The type of the render result (either `success` or `error`)", + "type": "string", + "enum": [ + "success", + "error" + ], + "example": "success" + }, + "content": { + "description": "The rendered content of the mail template's subject. Also contains the error when rendering this field wasn't possible.", + "type": "string", + "example": "Example mail" + } + } + }, + "senderName": { + "type": "object", + "required": [ + "type", + "content" + ], + "properties": { + "type": { + "description": "The type of the render result (either `success` or `error`)", + "type": "string", + "enum": [ + "success", + "error" + ], + "example": "success" + }, + "content": { + "description": "The rendered content of the mail template's sender name. Also contains the error when rendering this field wasn't possible.", + "type": "string", + "example": "Storefront" + } + } + }, + "contentHtml": { + "type": "object", + "required": [ + "type", + "content" + ], + "properties": { + "type": { + "description": "The type of the render result (either `success` or `error`)", + "type": "string", + "enum": [ + "success", + "error" + ], + "example": "success" + }, + "content": { + "description": "The rendered content of the mail template in html format. Also contains the error when rendering this field wasn't possible.", + "type": "string", + "example": "
Hello Mr. Mustermann,
this is example mail content, the current date is 16.03.2026.
" + } + } + }, + "contentPlain": { + "type": "object", + "required": [ + "type", + "content" + ], + "properties": { + "type": { + "description": "The type of the render result (either `success` or `error`)", + "type": "string", + "enum": [ + "success", + "error" + ], + "example": "success" + }, + "content": { + "description": "The rendered content of the mail template in plain text format. Also contains the error when rendering this field wasn't possible.", + "type": "string", + "example": "Hello Mr. Mustermann, this is example mail content, the current date is 16.03.2026." + } + } + } + } + } + } + } + }, + "400": { + "description": "Invalid request data or invalid mailTemplateId", + "$ref": "#/components/responses/400" + } + } + } + }, + "/_action/mail-template/get-data-and-send": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Fetch the template data and send a mail", + "description": "Generates the required data needed for the mail template, renders the mail content and sends it to the customer.", + "operationId": "generateAndSendMail", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "mailTemplateId", + "recipients", + "salesChannelId" + ], + "properties": { + "mailTemplateId": { + "description": "Identifier of the mail template which should be rendered.", + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a" + }, + "recipients": { + "description": "A map of recipients with name and mail address.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient. Can be null to omit the display name.", + "type": [ + "string", + "null" + ] + } + }, + "salesChannelId": { + "description": "Identifier of the sales channel from which the mail should be send.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "contentHtml": { + "description": "The content of the mail in HTML format. If passed, this content will be used instead of the content from the mail template.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text. If passed, this content will be used instead of the content from the mail template.", + "type": "string" + }, + "subject": { + "description": "Subject of the mail. If passed, this subject will be used instead of the subject from the mail template.", + "type": "string" + }, + "senderName": { + "description": "Name of the sender. If passed, this sender name will be used instead of the sender name from the mail template.", + "type": "string" + }, + "senderEmail": { + "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "type": "string", + "format": "email" + }, + "mediaIds": { + "description": "List of media identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "documentIds": { + "description": "List of document identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "binAttachments": { + "description": "A list of binary attachments which should be added to the mail.", + "type": "array", + "items": { + "required": [ + "content", + "fileName", + "mimeType" + ], + "properties": { + "content": { + "description": "Binary content of the attachment.", + "type": "string" + }, + "fileName": { + "description": "File name of the attachment.", + "type": "string" + }, + "mimeType": { + "description": "Mime type of the attachment.", + "type": "string" + } + }, + "type": "object" + } + }, + "recipientsBcc": { + "description": "A mail address or a map of recipients with name and mail address to be set in BCC.", + "oneOf": [ + { + "type": "string", + "format": "email" + }, + { + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient. Can be null to omit the display name.", + "type": [ + "string", + "null" + ] + } + } + ] + }, + "recipientsCc": { + "description": "A mail address or a map of recipients with name and mail address to be set in CC.", + "oneOf": [ + { + "type": "string", + "format": "email" + }, + { + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient. Can be null to omit the display name.", + "type": [ + "string", + "null" + ] + } + } + ] + }, + "replyTo": { + "description": "A mail address or a map of mail addresses with name to be set in reply-to.", + "oneOf": [ + { + "type": "string", + "format": "email" + }, + { + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient. Can be null to omit the display name.", + "type": [ + "string", + "null" + ] + } + } + ] + }, + "returnPath": { + "description": "A mail address or a map of mail addresses with name to be set in return-path.", + "oneOf": [ + { + "type": "string", + "format": "email" + }, + { + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient. Can be null to omit the display name.", + "type": [ + "string", + "null" + ] + } + } + ] + }, + "entities": { + "description": "A map of entity names and corresponding identifiers that define entities which should be used additionally during rendering.", + "type": "object", + "additionalProperties": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "example": { + "order": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a", + "customer": "a1b2c3d4e5f67890b3c4d5e6f7a8b90a" + } + }, + "templateData": { + "description": "A map of template data that should be used additionally during rendering. Values in this map override generated or entity-derived template data with the same top-level keys.", + "type": "object", + "additionalProperties": true, + "example": { + "salesChannel": { + "name": "Storefront" + }, + "order": { + "orderNumber": "SW10042" + } + } + }, + "testMode": { + "description": "Enables mail test mode. The mail is still sent, but template rendering runs with the renderer's test mode enabled, a fallback `order.deepLinkCode` of `home` is injected when missing, and debug headers such as `X-Shopware-Language-Id` plus available event or sales-channel headers are added to the message.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The mail was sent successful", + "content": { + "application/json": { + "schema": { + "required": [ + "size" + ], + "properties": { + "size": { + "description": "Length of the email message", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "400": { + "description": "Invalid request data or invalid mailTemplateId", + "$ref": "#/components/responses/400" + } + } + } + }, + "/_action/mail-template/available-variables": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Fetch the available variables for a business event and an optional parent variable path.", + "description": "Fetches the available variables that a business event provides for a certain parent variable path to determine which variables can be used in a mail template.", + "operationId": "mailTemplateAvailableVariables", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "eventName" + ], + "properties": { + "eventName": { + "description": "The business event name that provides the available variables.", + "type": "string", + "example": "checkout.order.placed" + }, + "parentVariablePath": { + "description": "The path to the parent field of which the available variables should be returned. If omitted or empty, the top-level variables of the business event are returned.", + "type": "string", + "example": "order.transactions" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The available variables got fetched successfully.", + "content": { + "application/json": { + "schema": { + "items": { + "type": "object", + "required": [ + "fieldName", + "hasChildren" + ], + "properties": { + "fieldName": { + "description": "The name of the variable.", + "type": "string", + "example": "salesChannel" + }, + "hasChildren": { + "description": "Shows if behind the variable are more nested variables which can be accessed by another request to this endpoint with the updated parent variable path: `.`", + "type": "boolean", + "example": true + } + } + }, + "type": "array", + "description": "A collection of the available variables which also show if behind the variables are more nested variables." + } + } + } + }, + "400": { + "description": "Invalid request data or invalid eventName", + "$ref": "#/components/responses/400" + } + } + } + }, + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}": { + "get": { + "tags": [ + "Sales Channel Files" + ], + "summary": "List discovered sales channel files", + "description": "Lists all discovered public files for a file family and sales channel, including content type and the stored sales-channel configuration when one exists.", + "operationId": "listSalesChannelFiles", + "parameters": [ + { + "name": "fileFamily", + "in": "path", + "description": "File family below `Resources/views/files`, for example `agentic`.", + "required": true, + "schema": { + "type": "string", + "maxLength": 64, + "pattern": "^[A-Za-z0-9_-]+$" + } + }, + { + "name": "salesChannelId", + "in": "path", + "description": "Identifier of the sales channel for which stored configuration should be loaded.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Discovered sales channel files for the given file family.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelFileListResponse" + } + } + } + }, + "400": { + "description": "Invalid file family.", + "$ref": "#/components/responses/400" + } + } + } + }, + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}/detail": { + "get": { + "tags": [ + "Sales Channel Files" + ], + "summary": "Load sales channel file detail", + "description": "Loads detail data for a discovered public file, including contributing Twig templates, their source content, and the stored sales-channel configuration when one exists.", + "operationId": "getSalesChannelFileDetail", + "parameters": [ + { + "name": "fileFamily", + "in": "path", + "description": "File family below `Resources/views/files`, for example `agentic`.", + "required": true, + "schema": { + "type": "string", + "maxLength": 64, + "pattern": "^[A-Za-z0-9_-]+$" + } + }, + { + "name": "salesChannelId", + "in": "path", + "description": "Identifier of the sales channel for which stored configuration should be loaded.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "fileName", + "in": "query", + "description": "Public file path without a leading slash. Subfolders are supported, for example `.well-known/ucp.json`.", + "required": true, + "schema": { + "type": "string", + "examples": [ + "llms.txt", + ".well-known/ucp.json" + ] + } + } + ], + "responses": { + "200": { + "description": "Detail data for the discovered sales channel file.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelFileDetailResponse" + } + } + } + }, + "400": { + "description": "Invalid file family or file name.", + "$ref": "#/components/responses/400" + }, + "404": { + "description": "The requested sales channel file was not discovered.", + "$ref": "#/components/responses/404" + } + } + } + }, + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}/preview": { + "post": { + "tags": [ + "Sales Channel Files" + ], + "summary": "Preview a sales channel file", + "description": "Renders a discovered public file for a sales channel with the supplied Twig template overrides. This allows Administration previews without persisting the overrides first.", + "operationId": "previewSalesChannelFile", + "parameters": [ + { + "name": "fileFamily", + "in": "path", + "description": "File family below `Resources/views/files`, for example `agentic`.", + "required": true, + "schema": { + "type": "string", + "maxLength": 64, + "pattern": "^[A-Za-z0-9_-]+$" + } + }, + { + "name": "salesChannelId", + "in": "path", + "description": "Identifier of the sales channel used to build the rendering context.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "description": "Preview input containing the public file name and optional Twig overrides keyed by Twig namespace.", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelFilePreviewRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Rendered preview content.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelFilePreviewResponse" + } + } + } + }, + "400": { + "description": "Invalid request payload, file family, or file name.", + "$ref": "#/components/responses/400" + }, + "404": { + "description": "The requested sales channel file was not discovered.", + "$ref": "#/components/responses/404" + } + } + } + }, + "/_action/media/presign-upload": { + "post": { + "tags": [ + "Asset Management" + ], + "summary": "Prepare a presigned upload", + "description": "Creates or reuses a media entity and returns a presigned S3 URL for direct browser-to-storage upload. The client uploads the file directly to the returned URL, then calls the finalize endpoint.", + "operationId": "presignUpload", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "fileName", + "extension", + "mimeType" + ], + "properties": { + "fileName": { + "type": "string", + "description": "Name of the file without extension" + }, + "extension": { + "type": "string", + "description": "File extension, e.g. `jpg`, `png`, `pdf`" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file, e.g. `image/jpeg`" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder to place the new media in" + }, + "private": { + "type": "boolean", + "default": false, + "description": "Whether the media should be private" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of an existing media entity to replace. If omitted, a new entity is created." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Presigned upload prepared successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "mediaId", + "url", + "path", + "expiresAt", + "isDuplicate" + ], + "properties": { + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media entity" + }, + "url": { + "type": "string", + "description": "Presigned URL to upload the file to via HTTP PUT" + }, + "path": { + "type": "string", + "description": "Storage path of the media file, required for the finalize call" + }, + "expiresAt": { + "type": "string", + "format": "date-time", + "description": "Expiration time of the presigned URL" + }, + "isDuplicate": { + "type": "boolean", + "description": "Whether a file with the same name already exists" + } + } + } + } + } + }, + "400": { + "description": "Bad request. The file extension is not supported or the file name is invalid.", + "$ref": "#/components/responses/400" + }, + "404": { + "description": "The media entity with the given `mediaId` was not found.", + "$ref": "#/components/responses/404" + }, + "422": { + "description": "Validation error. Required fields (`fileName`, `extension`, `mimeType`) must not be blank.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + } + } + } + } + } + } + }, + "/_action/media/{mediaId}/finalize-upload": { + "post": { + "tags": [ + "Asset Management" + ], + "summary": "Finalize a presigned upload", + "description": "Confirms that the file has been uploaded to storage via the presigned URL and updates the media entity with file metadata.", + "operationId": "finalizeUpload", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "required": true, + "description": "ID of the media entity to finalize", + "schema": { + "$ref": "#/components/schemas/MediaId" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "fileName", + "extension", + "mimeType", + "path" + ], + "properties": { + "fileName": { + "type": "string", + "description": "Name of the file without extension" + }, + "extension": { + "type": "string", + "description": "File extension, e.g. `jpg`, `png`, `pdf`" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "path": { + "type": "string", + "description": "Storage path returned by the presign-upload endpoint" + }, + "width": { + "type": "integer", + "description": "Image width in pixels (optional, for images only)" + }, + "height": { + "type": "integer", + "description": "Image height in pixels (optional, for images only)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Upload finalized successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "mediaId" + ], + "properties": { + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the finalized media entity" + } + } + } + } + } + }, + "400": { + "description": "Bad request. The file extension is not supported, the storage path does not match, the file name is already taken, or the file could not be found on the remote storage.", + "$ref": "#/components/responses/400" + }, + "404": { + "description": "The media entity with the given `mediaId` was not found.", + "$ref": "#/components/responses/404" + }, + "422": { + "description": "Validation error. Required fields (`fileName`, `extension`, `mimeType`, `path`) must not be blank.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + } + } + } + } + } + } + }, + "/_action/number-range/{numberRangeId}/preview-pattern": { + "get": { + "tags": [ + "Number Range Management" + ], + "summary": "Preview a persisted number range", + "description": "Previews the next value for a concrete persisted number range without incrementing its state. Optional `pattern` and `start` query parameters can be used to preview unsaved changes while editing the number range. Use `/_action/number-range/reserve/{type}` for actual allocation by business type and sales channel.", + "operationId": "numberRangePreviewPatternById", + "parameters": [ + { + "name": "numberRangeId", + "in": "path", + "description": "Identifier of the number range to preview.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "pattern", + "in": "query", + "description": "Optional pattern override for the preview.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "start", + "in": "query", + "description": "Optional start value override for the preview.", + "required": false, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "The previewed number", + "content": { + "application/json": { + "schema": { + "properties": { + "number": { + "description": "The previewed number.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "404": { + "description": "Number range not found" + } + } + } + }, + "/_action/integration/{integrationId}/mcp-allowlist": { + "post": { + "tags": [ + "MCP", + "Experimental" + ], + "summary": "Save MCP allowlist for an integration", + "description": "Saves the per-integration MCP allowlist covering tools, resources, and prompts. Pass `null` as the top-level value to allow all capabilities unrestricted. Pass an object with `tools`, `resources`, and `prompts` keys where each key is either `null` (unrestricted for that type) or a list of allowed names/URIs (empty array = deny all of that type). Requires `integration_mcp.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "saveMcpAllowlist", + "parameters": [ + { + "name": "integrationId", + "in": "path", + "required": true, + "description": "The integration UUID.", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "security": [ + { + "oAuth": [ + "write" + ] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "allowlist" + ], + "properties": { + "allowlist": { + "oneOf": [ + { + "type": "object", + "description": "Per-type allowlist. Each key is null (unrestricted) or a list of allowed names/URIs.", + "properties": { + "tools": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allowed tool names. Empty array = no tools allowed." + }, + { + "type": "null", + "description": "Null = all tools allowed." + } + ] + }, + "resources": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allowed resource URIs. Empty array = no resources allowed." + }, + { + "type": "null", + "description": "Null = all resources allowed." + } + ] + }, + "prompts": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allowed prompt names. Empty array = no prompts allowed." + }, + { + "type": "null", + "description": "Null = all prompts allowed." + } + ] + } + } + }, + { + "type": "null", + "description": "Null = all capabilities unrestricted." + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Allowlist saved successfully." + }, + "400": { + "description": "Bad request — missing or invalid `allowlist` field." + }, + "401": { + "description": "Unauthorized — missing or invalid credentials." + }, + "403": { + "description": "Forbidden — caller lacks `integration_mcp.editor` privilege." + }, + "404": { + "description": "Integration not found." + } + } + } + }, + "/_action/user/{userId}/mcp-allowlist": { + "post": { + "tags": [ + "MCP", + "Experimental" + ], + "summary": "Save MCP allowlist for a user", + "description": "Saves the per-user MCP allowlist covering tools, resources, and prompts. Pass `null` as the top-level value to allow all capabilities unrestricted. Pass an object with `tools`, `resources`, and `prompts` keys where each key is either `null` (unrestricted for that type) or a list of allowed names/URIs (empty array = deny all of that type). Requires `users_and_permissions.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "saveMcpAllowlistUser", + "parameters": [ + { + "name": "userId", + "in": "path", + "required": true, + "description": "The user UUID.", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "security": [ + { + "oAuth": [ + "write" + ] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "allowlist" + ], + "properties": { + "allowlist": { + "oneOf": [ + { + "type": "object", + "description": "Per-type allowlist. Each key is null (unrestricted) or a list of allowed names/URIs.", + "properties": { + "tools": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allowed tool names. Empty array = no tools allowed." + }, + { + "type": "null", + "description": "Null = all tools allowed." + } + ] + }, + "resources": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allowed resource URIs. Empty array = no resources allowed." + }, + { + "type": "null", + "description": "Null = all resources allowed." + } + ] + }, + "prompts": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allowed prompt names. Empty array = no prompts allowed." + }, + { + "type": "null", + "description": "Null = all prompts allowed." + } + ] + } + } + }, + { + "type": "null", + "description": "Null = all capabilities unrestricted." + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Allowlist saved successfully." + }, + "400": { + "description": "Bad request — missing or invalid `allowlist` field." + }, + "401": { + "description": "Unauthorized — missing or invalid credentials." + }, "403": { "description": "Forbidden — caller lacks `users_and_permissions.editor` privilege." }, @@ -10608,7 +12703,7 @@ "type": "object" }, "AppMcpPromptJsonApi": { - "description": "Added since version: 6.7.0.0", + "description": "Added since version: 6.7.11.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -10695,7 +12790,7 @@ ] }, "AppMcpPrompt": { - "description": "Added since version: 6.7.0.0", + "description": "Added since version: 6.7.11.0", "required": [ "id", "name", @@ -10744,7 +12839,7 @@ "type": "object" }, "AppMcpResourceJsonApi": { - "description": "Added since version: 6.7.0.0", + "description": "Added since version: 6.7.11.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -10838,7 +12933,7 @@ ] }, "AppMcpResource": { - "description": "Added since version: 6.7.0.0", + "description": "Added since version: 6.7.11.0", "required": [ "id", "name", @@ -10894,7 +12989,7 @@ "type": "object" }, "AppMcpToolJsonApi": { - "description": "Added since version: 6.7.0.0", + "description": "Added since version: 6.7.11.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -10987,7 +13082,7 @@ ] }, "AppMcpTool": { - "description": "Added since version: 6.7.0.0", + "description": "Added since version: 6.7.11.0", "required": [ "id", "name", @@ -25372,7 +27467,8 @@ "type": "object" }, "templateData": { - "type": "object" + "type": "object", + "deprecated": true }, "createdAt": { "type": "string", @@ -25454,7 +27550,8 @@ "type": "object" }, "templateData": { - "type": "object" + "type": "object", + "deprecated": true }, "createdAt": { "type": "string", @@ -35653,6 +37750,11 @@ "description": { "type": "string" }, + "descriptionTeaser": { + "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", + "type": "string", + "readOnly": true + }, "metaTitle": { "type": "string" }, @@ -37056,6 +39158,11 @@ "description": { "type": "string" }, + "descriptionTeaser": { + "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", + "type": "string", + "readOnly": true + }, "metaTitle": { "type": "string" }, @@ -40103,6 +42210,10 @@ "description": "To configure whether the field can be used for searching.", "type": "boolean" }, + "useExactSubfield": { + "description": "To configure whether exact match queries should target the exact subfield, which uses the whitespace analyzer (lowercased, whitespace-tokenised) and bypasses the language analyzer (no stemming, no stop-word removal, no compound decomposition).", + "type": "boolean" + }, "ranking": { "description": "Search ranking.", "type": "integer", @@ -40220,6 +42331,10 @@ "description": "To configure whether the field can be used for searching.", "type": "boolean" }, + "useExactSubfield": { + "description": "To configure whether exact match queries should target the exact subfield, which uses the whitespace analyzer (lowercased, whitespace-tokenised) and bypasses the language analyzer (no stemming, no stop-word removal, no compound decomposition).", + "type": "boolean" + }, "ranking": { "description": "Search ranking.", "type": "integer", @@ -45640,6 +47755,37 @@ }, "type": "object" }, + "salesChannelFiles": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelFiles" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_file" + }, + "id": { + "type": "string", + "example": "98cb8f9be6620dcdb0ab1b3b87f2662e" + } + } + } + } + }, + "type": "object" + }, "analytics": { "properties": { "links": { @@ -46255,6 +48401,12 @@ "$ref": "#/components/schemas/ProductExport" } }, + "salesChannelFiles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFile" + } + }, "analytics": { "$ref": "#/components/schemas/SalesChannelAnalytics" }, @@ -46892,6 +49044,144 @@ }, "type": "object" }, + "SalesChannelFileJsonApi": { + "description": "Added since version: 6.7.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "salesChannelId", + "fileFamily", + "fileName", + "enabled" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the configured sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileFamily": { + "description": "File family below Resources/views/files.", + "type": "string" + }, + "fileName": { + "description": "Normalized public file path without a leading slash.", + "type": "string" + }, + "enabled": { + "description": "Controls whether the file is served for this sales channel.", + "type": "boolean" + }, + "templateOverrides": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-file/581416c2ea128b091dcb038453fdefb6/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelFile": { + "description": "Added since version: 6.7.12.0", + "required": [ + "id", + "salesChannelId", + "fileFamily", + "fileName", + "enabled" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the configured sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileFamily": { + "description": "File family below Resources/views/files.", + "type": "string" + }, + "fileName": { + "description": "Normalized public file path without a leading slash.", + "type": "string" + }, + "enabled": { + "description": "Controls whether the file is served for this sales channel.", + "type": "boolean" + }, + "templateOverrides": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, "SalesChannelLanguage": { "description": "Added since version: 6.0.0.0", "required": [ @@ -54246,77 +56536,144 @@ }, "type": "object" }, - "ConsentState": { + "MediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Media entity ID" + }, + "ExternalThumbnail": { "type": "object", + "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt", - "acceptedUntil" + "url", + "width", + "height" ], "properties": { - "name": { + "url": { "type": "string", - "description": "The name of the consent" + "description": "Absolute HTTP/HTTPS URL of the thumbnail", + "example": "https://cdn.example.com/image-200x200.jpg" }, - "scopeName": { - "type": "string", - "description": "The scope of the consent that defines how the identifier is resolved" + "width": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Width of the thumbnail in pixels", + "example": 200 }, - "identifier": { + "height": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Height of the thumbnail in pixels", + "example": 200 + } + } + }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", "type": "string", - "description": "The resolved identifier of the consent" + "pattern": "^[0-9a-f]{32}$" }, - "status": { - "type": "string", - "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" + "gross": { + "description": "Gross price for the associated currency.", + "type": "number" }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" + "net": { + "description": "Net price for the associated currency.", + "type": "number" }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" + "linked": { + "description": "Whether gross and net prices are linked through the tax configuration.", + "type": "boolean" }, - "acceptedUntil": { + "percentage": { + "description": "Discount percentage relative to the list price for the gross and net amounts. `null` when no list price is set.", "type": [ - "string", + "object", "null" ], - "format": "date-time", - "description": "The timestamp until when the consent is accepted. null if never accepted" + "properties": { + "gross": { + "description": "Discount percentage relative to the gross list price.", + "type": "number" + }, + "net": { + "description": "Discount percentage relative to the net list price.", + "type": "number" + } + }, + "required": [ + "gross", + "net" + ] }, - "acceptedRevision": { - "type": [ - "string", - "null" - ], - "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." + "listPrice": { + "description": "Reference list price for displaying discounts.", + "type": "object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "Gross list price for the associated currency.", + "type": "number" + }, + "net": { + "description": "Net list price for the associated currency.", + "type": "number" + }, + "linked": { + "description": "Whether gross and net list prices are linked through the tax configuration.", + "type": "boolean" + } + }, + "required": [ + "gross", + "net", + "linked" + ] }, - "latestRevision": { - "type": [ - "string", - "null" - ], - "description": "The current latest revision defined for the consent. null when the consent does not use revisions." + "regulationPrice": { + "description": "Reference price used for legal price disclosures.", + "type": "object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "Gross regulation price for the associated currency.", + "type": "number" + }, + "net": { + "description": "Net regulation price for the associated currency.", + "type": "number" + }, + "linked": { + "description": "Whether gross and net regulation prices are linked through the tax configuration.", + "type": "boolean" + } + }, + "required": [ + "gross", + "net", + "linked" + ] } - } + }, + "required": [ + "currencyId", + "gross", + "net", + "linked" + ] }, "infoConfigResponse": { "type": "object", @@ -54540,39 +56897,6 @@ ], "additionalProperties": false }, - "MediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Media entity ID" - }, - "ExternalThumbnail": { - "type": "object", - "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", - "required": [ - "url", - "width", - "height" - ], - "properties": { - "url": { - "type": "string", - "description": "Absolute HTTP/HTTPS URL of the thumbnail", - "example": "https://cdn.example.com/image-200x200.jpg" - }, - "width": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Width of the thumbnail in pixels", - "example": 200 - }, - "height": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Height of the thumbnail in pixels", - "example": 200 - } - } - }, "Criteria": { "type": "object", "description": "Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)", @@ -54697,7 +57021,7 @@ } }, "Includes": { - "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. To return a DAL extension, list the extension by its name (for example `myExtension`); the `extensions` wrapper is then kept automatically. Listing the keyword `extensions` returns all extensions.", "type": "object", "additionalProperties": { "type": "array", @@ -54707,7 +57031,7 @@ } }, "Excludes": { - "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. Use an extension name to remove a single extension, or the keyword `extensions` to remove all of them.", "type": "object", "additionalProperties": { "type": "array", @@ -55255,134 +57579,28 @@ "AggregationMetrics": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "avg", - "count", - "max", - "min", - "stats", - "sum" - ] - }, - "field": { - "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] - }, - "Price": { - "type": "object", - "description": "Price object", - "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "Gross price for the associated currency.", - "type": "number" - }, - "net": { - "description": "Net price for the associated currency.", - "type": "number" - }, - "linked": { - "description": "Whether gross and net prices are linked through the tax configuration.", - "type": "boolean" - }, - "percentage": { - "description": "Discount percentage relative to the list price for the gross and net amounts. `null` when no list price is set.", - "type": [ - "object", - "null" - ], - "properties": { - "gross": { - "description": "Discount percentage relative to the gross list price.", - "type": "number" - }, - "net": { - "description": "Discount percentage relative to the net list price.", - "type": "number" - } - }, - "required": [ - "gross", - "net" - ] - }, - "listPrice": { - "description": "Reference list price for displaying discounts.", - "type": "object", - "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "Gross list price for the associated currency.", - "type": "number" - }, - "net": { - "description": "Net list price for the associated currency.", - "type": "number" - }, - "linked": { - "description": "Whether gross and net list prices are linked through the tax configuration.", - "type": "boolean" - } - }, - "required": [ - "gross", - "net", - "linked" - ] - }, - "regulationPrice": { - "description": "Reference price used for legal price disclosures.", - "type": "object", - "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "Gross regulation price for the associated currency.", - "type": "number" - }, - "net": { - "description": "Net regulation price for the associated currency.", - "type": "number" - }, - "linked": { - "description": "Whether gross and net regulation prices are linked through the tax configuration.", - "type": "boolean" - } - }, - "required": [ - "gross", - "net", - "linked" + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "avg", + "count", + "max", + "min", + "stats", + "sum" ] + }, + "field": { + "type": "string" } }, "required": [ - "currencyId", - "gross", - "net", - "linked" + "name", + "type", + "field" ] }, "businessEventsResponse": { @@ -55419,46 +57637,28 @@ } } }, - "MeasurementUnits": { - "type": "object", - "description": "Configuration of the measurement system", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." - }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." - }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" } } } @@ -55587,101 +57787,673 @@ } ] }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" + "MeasurementUnits": { + "type": "object", + "description": "Configuration of the measurement system", + "properties": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." + } + } + } + } + }, + "SalesChannelFileConfiguration": { + "type": "object", + "required": [ + "id", + "enabled", + "templateOverrides" + ], + "properties": { + "id": { + "description": "Identifier of the sales_channel_file row.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "enabled": { + "description": "Whether this file is served publicly for the sales channel.", + "type": "boolean" + }, + "templateOverrides": { + "description": "Merchant-provided Twig overrides keyed by Twig namespace. The reserved `user_provided_content` key stores plain text for the dedicated append block when supported by the template chain.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SalesChannelFileDescriptor": { + "type": "object", + "required": [ + "fileFamily", + "fileName", + "contentType", + "configuration" + ], + "properties": { + "fileFamily": { + "description": "File family below `Resources/views/files`.", + "type": "string", + "maxLength": 64 + }, + "fileName": { + "description": "Public file path without a leading slash.", + "type": "string", + "examples": [ + "llms.txt", + ".well-known/ucp.json" + ] + }, + "contentType": { + "description": "Detected response content type for the public file.", + "type": "string", + "examples": [ + "text/plain; charset=utf-8" + ] + }, + "configuration": { + "description": "Stored sales-channel configuration for this file, or null when it has not been configured yet.", + "oneOf": [ + { + "$ref": "#/components/schemas/SalesChannelFileConfiguration" + }, + { + "type": "null" + } + ] + } + } + }, + "SalesChannelFileDetail": { + "type": "object", + "required": [ + "fileFamily", + "fileName", + "templatePath", + "contentType", + "templates", + "supportsUserProvidedContent", + "configuration" + ], + "properties": { + "fileFamily": { + "description": "File family below `Resources/views/files`.", + "type": "string", + "maxLength": 64 + }, + "fileName": { + "description": "Public file path without a leading slash.", + "type": "string", + "examples": [ + "llms.txt", + ".well-known/ucp.json" + ] + }, + "templatePath": { + "description": "Relative Twig template path used for rendering.", + "type": "string", + "examples": [ + "files/agentic/llms.txt.twig" + ] + }, + "contentType": { + "description": "Detected response content type for the public file.", + "type": "string", + "examples": [ + "text/plain; charset=utf-8" + ] + }, + "templates": { + "description": "Contributing Twig templates in resolved inheritance order.", + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFileTemplate" + } + }, + "supportsUserProvidedContent": { + "description": "Whether the template chain exposes the `user_provided_content` block for simple appended merchant notes.", + "type": "boolean" + }, + "configuration": { + "description": "Stored sales-channel configuration for this file, or null when it has not been configured yet.", + "oneOf": [ + { + "$ref": "#/components/schemas/SalesChannelFileConfiguration" + }, + { + "type": "null" + } + ] + } + } + }, + "SalesChannelFileDetailResponse": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelFileDetail" + } + } + }, + "SalesChannelFileListResponse": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFileDescriptor" + } + } + } + }, + "SalesChannelFilePreviewRequest": { + "type": "object", + "required": [ + "fileName" + ], + "properties": { + "fileName": { + "description": "Public file path without a leading slash.", + "type": "string", + "examples": [ + "llms.txt", + ".well-known/ucp.json" + ] + }, + "templateOverrides": { + "description": "Unsaved Twig overrides keyed by Twig namespace. The reserved `user_provided_content` key stores plain text for the dedicated append block when supported by the template chain.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SalesChannelFilePreviewResponse": { + "type": "object", + "required": [ + "fileName", + "contentType", + "content" + ], + "properties": { + "fileName": { + "description": "Public file path without a leading slash.", + "type": "string" + }, + "contentType": { + "description": "Detected content type of the rendered file.", + "type": "string" + }, + "content": { + "description": "Rendered file content.", + "type": "string" + } + } + }, + "SalesChannelFileTemplate": { + "type": "object", + "required": [ + "twigNamespace", + "templateName", + "templateContent", + "role" + ], + "properties": { + "twigNamespace": { + "description": "Twig namespace that contributed the template, for example `Framework` or a plugin name.", + "type": "string" + }, + "templateName": { + "description": "Resolved Twig template name.", + "type": "string", + "examples": [ + "@Framework/files/agentic/llms.txt.twig" + ] + }, + "templateContent": { + "description": "Original source template content. Administration clients can use this as the default text when editing a template override.", + "type": "string" + }, + "role": { + "description": "Whether this source provides the base template or extends another source in the resolved template chain.", + "type": "string", + "enum": [ + "base", + "extension" + ] + } + } + }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + }, + "acceptedUntil": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp until when the consent is accepted. null if never accepted" + }, + "acceptedRevision": { + "type": [ + "string", + "null" + ], + "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." + }, + "latestRevision": { + "type": [ + "string", + "null" + ], + "description": "The current latest revision defined for the consent. null when the consent does not use revisions." + } + } + }, + "AttendeeInsights": { + "type": "object", + "description": "Attendee Insights", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Id of the attendee" + }, + "cartSum": { + "type": "number", + "description": "Sum of the cart net in base currency" + }, + "productCount": { + "type": "number", + "description": "Sum of all quantities in the cart which were added during the appointment" + } + }, + "example": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } + } + }, + "LineItemType": { + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "discount", + "container", + "quantity", + "dsr-line-item-discount", + "dsr-cart-discount" + ] + }, + "DiscountLineItemPayload": { + "type": "object", + "properties": { + "discountType": { + "type": "string", + "enum": [ + "percentage", + "absolute" + ] + }, + "discountValue": { + "type": "number", + "format": "float", + "maximum": 0 + }, + "discountPrice": { + "type": "number", + "format": "float", + "maximum": 0 + } + } + }, + "LineItem": { + "type": "object", + "properties": { + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + }, + "cover": { + "$ref": "#/components/schemas/ProductMedia" + }, + "dataContextHash": { + "type": "string" + }, + "dataTimestamp": { + "type": "string" + }, + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" + }, + "description": { + "type": "string" + }, + "good": { + "type": "boolean" + }, + "id": { + "type": "string" + }, + "label": { + "type": "string" + }, + "modified": { + "type": "boolean" + }, + "modifiedByApp": { + "type": "boolean" + }, + "payload": { + "allOf": [ + { + "$ref": "#/components/schemas/ProductJsonApi" + }, + { + "type": "object", + "properties": { + "discountType": { + "type": "string", + "enum": [ + "percentage", + "absolute" + ] + }, + "discountValue": { + "type": "number", + "format": "float", + "maximum": 0 + }, + "discountPrice": { + "type": "number", + "format": "float", + "maximum": 0 + } + } + } + ] + }, + "extensions": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "attendees": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + } + } + } + } + } } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" } - } - } - }, - "PresentationCmsPage": { - "allOf": [ - { - "$ref": "#/components/schemas/DsrPresentationCmsPage" }, - { + "price": { "type": "object", "properties": { - "pickedProductIds": { - "anyOf": [ - { - "type": "array", - "items": { + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] + }, + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Product id" + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" } }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, { "type": "null" } - ], - "description": "The product id is assigned to presentation if it's product listing or instant listing" + ] + }, + "quantity": { + "type": "number" + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true + }, + "totalPrice": { + "type": "number" + }, + "unitPrice": { + "type": "number" + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } - } - } - ] - }, - "CartError": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "items": { + }, + "required": [ + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" + ] + }, + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" + }, + "quantity": { + "type": "number" + }, + "quantityInformation": { "type": "object", "properties": { - "key": { - "type": "string" - }, - "level": { - "type": "number", - "enum": [ - 0, - 10, - 20 - ], - "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" + "maxPurchase": { + "type": "number" }, - "message": { - "type": "string" + "minPurchase": { + "type": "number" }, - "messageKey": { - "type": "string" + "purchaseSteps": { + "type": "number" } } - } - } - }, - "GetListBodyRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "Max amount of resources to be returned in a page" }, - "page": { - "type": "integer", - "description": "The page to be returned" + "referencedId": { + "type": "string" + }, + "removable": { + "type": "boolean" + }, + "stackable": { + "type": "boolean" + }, + "states": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] + } + }, + "type": { + "$ref": "#/components/schemas/LineItemType" + }, + "uniqueIdentifier": { + "type": "string" } - } + }, + "required": [ + "id", + "type" + ] }, "WidgetProductListing": { "type": "object", @@ -55733,173 +58505,292 @@ } } }, - "CartPriceQuantity": { + "GetListBodyRequest": { "type": "object", "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_quantity" - ] - }, - "isCalculated": { - "type": "boolean" + "limit": { + "type": "integer", + "description": "Max amount of resources to be returned in a page" }, - "listPrice": { - "$ref": "#/components/schemas/CartListPrice" + "page": { + "type": "integer", + "description": "The page to be returned" + } + } + }, + "StateForGuides": { + "type": "object", + "properties": { + "clients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "price": { - "type": "number" + "inactiveClients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "quantity": { - "type": "number" + "guides": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" + "videoGuideToken": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" } - }, - "type": "object" + ] }, - "taxRules": { + "quickViewState": { "type": "array", "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } + "type": "string" + }, + "default": [] + }, + "extensions": { + "type": "array", + "default": [] + } + } + }, + "GetAttendeeInsightsResponse": { + "type": "object", + "description": "Returns aggregations for the current attendees within the appointment.", + "properties": { + "attendees": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/AttendeeInsights" } }, - "type": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencySymbol": { "type": "string" } }, - "required": [ - "apiAlias" - ] + "example": { + "extensions": [], + "attendees": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } + }, + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$" + } }, - "CartDelivery": { + "CartItems": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + } + } + }, + "CartPriceReference": { + "type": "object", + "properties": { + "purchaseUnit": { + "type": "number" + }, + "referenceUnit": { + "type": "number" + }, + "unitName": { + "type": "string" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" }, - "latest": { - "type": "string", - "format": "date-time" + { + "type": "null" } - } + ] }, - "location": { + "regulationPrice": { "type": "object", "properties": { + "price": { + "type": "number" + }, "apiAlias": { "type": "string", "enum": [ - "cart_delivery_shipping_location" + "cart_regulation_price" ] - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "state": { - "$ref": "#/components/schemas/CountryState" } + }, + "nullable": true + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] + }, + "Cart": { + "type": "object", + "properties": { + "name": { + "description": "Name of the cart - for example `guest-cart`", + "type": "string" + }, + "token": { + "description": "Context token identifying the cart and the user session", + "type": "string" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "lineItems": { + "description": "All items within the cart", + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" } }, - "positions": { + "errors": { "type": "array", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" + "$ref": "#/components/schemas/CartError" } }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" + "deliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDelivery" + } }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - }, - "DynamicProductListingPageOpenedPayload": { - "required": [ - "page" - ], - "properties": { - "page": { - "type": "integer", - "description": "Current page position in the pagination" + "transactions": { + "description": "A list of all payment transactions associated with the current cart.", + "type": "array", + "items": { + "type": "object", + "properties": { + "paymentMethodId": { + "type": "string" + }, + "amount": { + "$ref": "#/components/schemas/CalculatedPrice" + } + } + } + }, + "modified": { + "type": "boolean" + }, + "customerComment": { + "type": "string", + "description": "A comment that can be added to the cart.", + "nullable": true + }, + "affiliateCode": { + "type": "string", + "description": "An affiliate tracking code", + "nullable": true + }, + "campaignCode": { + "type": "string", + "description": "A campaign tracking code", + "nullable": true } } }, - "CartDeliveryInformation": { + "CartPriceQuantity": { "type": "object", "properties": { "apiAlias": { "type": "string", "enum": [ - "cart_delivery_information" + "cart_price_quantity" ] }, - "freeDelivery": { + "isCalculated": { "type": "boolean" }, - "deliveryTime": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "min": { - "type": "integer" - }, - "max": { - "type": "integer" - }, - "unit": { - "type": "string" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_time" - ] - } - } - }, - "height": { - "type": "integer" + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" }, - "length": { - "type": "integer" + "price": { + "type": "number" }, - "restockTime": { - "type": "integer" + "quantity": { + "type": "number" }, - "stock": { - "type": "integer" + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" }, - "weight": { - "type": "integer" + "taxRules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } }, - "width": { - "type": "integer" + "type": { + "type": "string" } }, "required": [ @@ -56061,6 +58952,57 @@ "apiAlias": "swag_digital_sales_rooms_content_appointment_struct_appointment_join_struct" } }, + "CartDelivery": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } + }, + "location": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_shipping_location" + ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "state": { + "$ref": "#/components/schemas/CountryState" + } + } + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDeliveryPosition" + } + }, + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + }, "StateForAll": { "type": "object", "properties": { @@ -56272,151 +59214,6 @@ } } }, - "Cart": { - "type": "object", - "properties": { - "name": { - "description": "Name of the cart - for example `guest-cart`", - "type": "string" - }, - "token": { - "description": "Context token identifying the cart and the user session", - "type": "string" - }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" - }, - "lineItems": { - "description": "All items within the cart", - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "errors": { - "type": "array", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "items": { - "$ref": "#/components/schemas/CartError" - } - }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDelivery" - } - }, - "transactions": { - "description": "A list of all payment transactions associated with the current cart.", - "type": "array", - "items": { - "type": "object", - "properties": { - "paymentMethodId": { - "type": "string" - }, - "amount": { - "$ref": "#/components/schemas/CalculatedPrice" - } - } - } - }, - "modified": { - "type": "boolean" - }, - "customerComment": { - "type": "string", - "description": "A comment that can be added to the cart.", - "nullable": true - }, - "affiliateCode": { - "type": "string", - "description": "An affiliate tracking code", - "nullable": true - }, - "campaignCode": { - "type": "string", - "description": "A campaign tracking code", - "nullable": true - } - } - }, - "VideoChatCreateStruct": { - "type": "object", - "description": "Includes all data you will need to attend to a appointment.", - "properties": { - "roomUrl": { - "type": "string", - "description": "Url of the video room in daily" - }, - "roomName": { - "type": "string", - "description": "Name of the video room in daily" - }, - "userToken": { - "type": "string", - "description": "Token for the end users to connect to the daily room" - }, - "ownerToken": { - "type": "string", - "description": "Token for the room owner (guide) to connect to the daily room" - } - }, - "example": { - "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", - "userToken": "dummy user token", - "ownerToken": "dummy owner token", - "roomName": "rSq20mrgwsj4eIXo1u95", - "extensions": [] - } - }, - "StateForGuides": { - "type": "object", - "properties": { - "clients": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "inactiveClients": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "guides": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "videoGuideToken": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "quickViewState": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "extensions": { - "type": "array", - "default": [] - } - } - }, "DiscountType": { "type": "string", "description": "Type of the discount", @@ -56468,276 +59265,14 @@ } } }, - "GuidePresentationStateResponse": { - "type": "object", - "properties": { - "stateForAll": { - "$ref": "#/components/schemas/StateForAll" - }, - "stateForClients": { - "$ref": "#/components/schemas/StateForGuides" - } - }, - "example": { - "extensions": [], - "stateForAll": { - "currentGuideProductId": null, - "lastActiveGuideSection": null, - "currentPageId": null, - "currentSectionId": null, - "currentSlideAlias": 0, - "currentDynamicPage": null, - "started": false, - "running": false, - "ended": false, - "startedAt": null, - "endedAt": null, - "accessibleFrom": { - "date": "2023-08-04 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "accessibleTo": { - "date": "2023-08-05 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "appointmentMode": "guided", - "videoAudioSettings": "both", - "videoRoomUrl": "", - "attendeeRestrictionType": "open", - "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", - "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", - "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", - "broadcastMode": false, - "extensions": [] - }, - "stateForGuides": { - "clients": [], - "inactiveClients": { - "2b4066cd37a341088e32a81e04a56817": { - "attendeeId": "2b4066cd37a341088e32a81e04a56817", - "attendeeName": "Attendee 1", - "videoUserId": null, - "hasJoined": false - }, - "302108ad602b4ac687f5247aae5d0297": { - "attendeeId": "302108ad602b4ac687f5247aae5d0297", - "attendeeName": null, - "videoUserId": null, - "hasJoined": true - }, - "5a3b4e84acab47119b8a6bceb79e732e": { - "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", - "attendeeName": "Test attende name", - "videoUserId": null, - "hasJoined": true - }, - "b6358241e4ad4a4e99d0f729d21d63be": { - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "attendeeName": null, - "videoUserId": null, - "hasJoined": true - }, - "f1bb9374308d4e088c29d10a2fc8cc07": { - "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", - "attendeeName": null, - "videoUserId": null, - "hasJoined": false - } - }, - "guides": { - "1850bbdc12dc44aba95bc78b16c3643c": { - "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", - "attendeeName": " admin", - "videoUserId": null, - "hasJoined": true - } - }, - "videoGuideToken": null, - "quickViewState": [], - "extensions": [] - } - } - }, - "GetCartInsightsResponse": { - "type": "object", - "description": "Returns aggregations for the current carts within the appointment.", - "properties": { - "cartSum": { - "type": "number", - "description": "Sum of all products from all attenddees which were added to the cart during the appointment" - }, - "productCount": { - "type": "number", - "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the shown currency" - }, - "currencySymbol": { - "type": "string", - "description": "The currency symbol from the shown currency" - }, - "topProducts": { - "type": "object", - "required": [ - "byQuantity", - "byRevenue" - ], - "properties": { - "byQuantity": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" - }, - "value": { - "type": "number", - "description": "The quantity in carts of this product" - } - }, - "required": [ - "productId", - "value" - ] - } - }, - "byRevenue": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" - }, - "value": { - "type": "number", - "description": "The net revenue in the shown currency in carts of this product" - } - }, - "required": [ - "productId", - "value" - ] - } - } - } - } - }, - "example": { - "extensions": [], - "cartSum": 6770.53, - "productCount": 3, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$", - "topProducts": { - "byQuantity": [ - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1 - }, - { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 1 - }, - { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 1 - } - ], - "byRevenue": [ - { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 5333.03 - }, - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1152.62 - }, - { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 284.88 - } - ] - } - } - }, - "CartListPrice": { - "type": "object", - "description": "", - "properties": { - "discount": { - "type": "number" - }, - "percentage": { - "type": "number" - }, - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_list_price" - ] - } - }, + "DynamicProductListingPageOpenedPayload": { "required": [ - "apiAlias" - ] - }, - "GetAttendeeInsightsResponse": { - "type": "object", - "description": "Returns aggregations for the current attendees within the appointment.", - "properties": { - "attendees": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/AttendeeInsights" - } - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencySymbol": { - "type": "string" - } - }, - "example": { - "extensions": [], - "attendees": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } - }, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$" - } - }, - "CartItems": { - "type": "object", + "page" + ], "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } + "page": { + "type": "integer", + "description": "Current page position in the pagination" } } }, @@ -57241,13 +59776,6 @@ "apiAlias": "pwa_page_result" } }, - "DynamicPageOpenedPayload": { - "allOf": [ - { - "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" - } - ] - }, "CartDeliveryPosition": { "type": "object", "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", @@ -57276,25 +59804,174 @@ } } }, - "CartPriceReference": { + "GuidePresentationStateResponse": { "type": "object", "properties": { - "purchaseUnit": { + "stateForAll": { + "$ref": "#/components/schemas/StateForAll" + }, + "stateForClients": { + "$ref": "#/components/schemas/StateForGuides" + } + }, + "example": { + "extensions": [], + "stateForAll": { + "currentGuideProductId": null, + "lastActiveGuideSection": null, + "currentPageId": null, + "currentSectionId": null, + "currentSlideAlias": 0, + "currentDynamicPage": null, + "started": false, + "running": false, + "ended": false, + "startedAt": null, + "endedAt": null, + "accessibleFrom": { + "date": "2023-08-04 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" + }, + "accessibleTo": { + "date": "2023-08-05 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" + }, + "appointmentMode": "guided", + "videoAudioSettings": "both", + "videoRoomUrl": "", + "attendeeRestrictionType": "open", + "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", + "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", + "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", + "broadcastMode": false, + "extensions": [] + }, + "stateForGuides": { + "clients": [], + "inactiveClients": { + "2b4066cd37a341088e32a81e04a56817": { + "attendeeId": "2b4066cd37a341088e32a81e04a56817", + "attendeeName": "Attendee 1", + "videoUserId": null, + "hasJoined": false + }, + "302108ad602b4ac687f5247aae5d0297": { + "attendeeId": "302108ad602b4ac687f5247aae5d0297", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true + }, + "5a3b4e84acab47119b8a6bceb79e732e": { + "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", + "attendeeName": "Test attende name", + "videoUserId": null, + "hasJoined": true + }, + "b6358241e4ad4a4e99d0f729d21d63be": { + "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true + }, + "f1bb9374308d4e088c29d10a2fc8cc07": { + "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", + "attendeeName": null, + "videoUserId": null, + "hasJoined": false + } + }, + "guides": { + "1850bbdc12dc44aba95bc78b16c3643c": { + "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", + "attendeeName": " admin", + "videoUserId": null, + "hasJoined": true + } + }, + "videoGuideToken": null, + "quickViewState": [], + "extensions": [] + } + } + }, + "AbstractDynamicPageOpenedPayload": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of the current dynamic page" + }, + "opened": { + "type": "boolean", + "default": true + } + } + }, + "DynamicPageOpenedPayload": { + "allOf": [ + { + "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" + } + ] + }, + "CalculatedPrice": { + "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", + "properties": { + "unitPrice": { "type": "number" }, - "referenceUnit": { + "quantity": { "type": "number" }, - "unitName": { - "type": "string" + "rawTotal": { + "type": "number" }, - "price": { + "totalPrice": { "type": "number" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_reference" + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } ] }, "listPrice": { @@ -57307,6 +59984,12 @@ } ] }, + "positionPrice": { + "type": "number" + }, + "netPrice": { + "type": "number" + }, "regulationPrice": { "type": "object", "properties": { @@ -57329,6 +60012,28 @@ "type": "string", "format": "^[0-9a-f]{32}$", "nullable": true + }, + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } }, "required": [ @@ -57336,476 +60041,296 @@ "hasRange", "regulationPrice", "listPrice", + "referencePrice", "calculatedTaxes", "totalPrice", "quantity", - "unitName" + "unitPrice", + "positionPrice", + "netPrice", + "taxRules" ] }, - "CalculatedPrice": { + "GetCartInsightsResponse": { "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", + "description": "Returns aggregations for the current carts within the appointment.", "properties": { - "unitPrice": { - "type": "number" + "cartSum": { + "type": "number", + "description": "Sum of all products from all attenddees which were added to the cart during the appointment" }, - "quantity": { - "type": "number" + "productCount": { + "type": "number", + "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" }, - "rawTotal": { - "type": "number" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the shown currency" }, - "totalPrice": { - "type": "number" + "currencySymbol": { + "type": "string", + "description": "The currency symbol from the shown currency" }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" + "topProducts": { + "type": "object", + "required": [ + "byQuantity", + "byRevenue" + ], + "properties": { + "byQuantity": { + "type": "array", + "uniqueItems": true, + "items": { + "type": "object", + "properties": { + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the product" + }, + "value": { + "type": "number", + "description": "The quantity in carts of this product" + } + }, + "required": [ + "productId", + "value" ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" } }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] + "byRevenue": { + "type": "array", + "uniqueItems": true, + "items": { + "type": "object", + "properties": { + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the product" + }, + "value": { + "type": "number", + "description": "The net revenue in the shown currency in carts of this product" + } + }, + "required": [ + "productId", + "value" + ] + } + } } - }, - "referencePrice": { - "oneOf": [ + } + }, + "example": { + "extensions": [], + "cartSum": 6770.53, + "productCount": 3, + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$", + "topProducts": { + "byQuantity": [ { - "$ref": "#/components/schemas/CartPriceReference" + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1 }, { - "type": "null" + "productId": "fee3ca762be94bb49b692e359d529563", + "value": 1 + }, + { + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 1 } - ] - }, - "listPrice": { - "oneOf": [ + ], + "byRevenue": [ { - "$ref": "#/components/schemas/CartListPrice" + "productId": "fee3ca762be94bb49b692e359d529563", + "value": 5333.03 }, { - "type": "null" + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1152.62 + }, + { + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 284.88 } ] - }, - "positionPrice": { + } + } + }, + "CartListPrice": { + "type": "object", + "description": "", + "properties": { + "discount": { "type": "number" }, - "netPrice": { + "percentage": { "type": "number" }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true - }, - "hasRange": { - "type": "boolean" - }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "price": { + "type": "number" }, "apiAlias": { "type": "string", "enum": [ - "calculated_price" + "cart_list_price" ] - }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } } }, "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "referencePrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitPrice", - "positionPrice", - "netPrice", - "taxRules" + "apiAlias" ] }, - "AttendeeInsights": { + "VideoChatCreateStruct": { "type": "object", - "description": "Attendee Insights", + "description": "Includes all data you will need to attend to a appointment.", "properties": { - "id": { + "roomUrl": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Id of the attendee" + "description": "Url of the video room in daily" }, - "cartSum": { - "type": "number", - "description": "Sum of the cart net in base currency" + "roomName": { + "type": "string", + "description": "Name of the video room in daily" }, - "productCount": { - "type": "number", - "description": "Sum of all quantities in the cart which were added during the appointment" + "userToken": { + "type": "string", + "description": "Token for the end users to connect to the daily room" + }, + "ownerToken": { + "type": "string", + "description": "Token for the room owner (guide) to connect to the daily room" } }, "example": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } + "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", + "userToken": "dummy user token", + "ownerToken": "dummy owner token", + "roomName": "rSq20mrgwsj4eIXo1u95", + "extensions": [] } }, - "LineItemType": { - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity", - "dsr-line-item-discount", - "dsr-cart-discount" - ] - }, - "DiscountLineItemPayload": { + "CartDeliveryInformation": { "type": "object", "properties": { - "discountType": { + "apiAlias": { "type": "string", "enum": [ - "percentage", - "absolute" + "cart_delivery_information" ] }, - "discountValue": { - "type": "number", - "format": "float", - "maximum": 0 - }, - "discountPrice": { - "type": "number", - "format": "float", - "maximum": 0 - } - } - }, - "LineItem": { - "type": "object", - "properties": { - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "cover": { - "$ref": "#/components/schemas/ProductMedia" - }, - "dataContextHash": { - "type": "string" - }, - "dataTimestamp": { - "type": "string" - }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" - }, - "description": { - "type": "string" - }, - "good": { - "type": "boolean" - }, - "id": { - "type": "string" - }, - "label": { - "type": "string" - }, - "modified": { - "type": "boolean" - }, - "modifiedByApp": { + "freeDelivery": { "type": "boolean" }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/ProductJsonApi" - }, - { - "type": "object", - "properties": { - "discountType": { - "type": "string", - "enum": [ - "percentage", - "absolute" - ] - }, - "discountValue": { - "type": "number", - "format": "float", - "maximum": 0 - }, - "discountPrice": { - "type": "number", - "format": "float", - "maximum": 0 - } - } - } - ] - }, - "extensions": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "attendees": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - } - } - } - } - } - } - } - }, - "price": { + "deliveryTime": { "type": "object", "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] + "name": { + "type": "string" }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" - } - }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } + "min": { + "type": "integer" }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] + "max": { + "type": "integer" }, - "quantity": { - "type": "number" + "unit": { + "type": "string" }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_time" ] - }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true - }, - "totalPrice": { - "type": "number" - }, - "unitPrice": { - "type": "number" - }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } - } - }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" - ] - }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" - }, - "quantity": { - "type": "number" - }, - "quantityInformation": { - "type": "object", - "properties": { - "maxPurchase": { - "type": "number" - }, - "minPurchase": { - "type": "number" - }, - "purchaseSteps": { - "type": "number" } } }, - "referencedId": { - "type": "string" + "height": { + "type": "integer" }, - "removable": { - "type": "boolean" + "length": { + "type": "integer" }, - "stackable": { - "type": "boolean" + "restockTime": { + "type": "integer" }, - "states": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] - } + "stock": { + "type": "integer" }, - "type": { - "$ref": "#/components/schemas/LineItemType" + "weight": { + "type": "integer" }, - "uniqueIdentifier": { - "type": "string" + "width": { + "type": "integer" } }, "required": [ - "id", - "type" + "apiAlias" ] }, - "AbstractDynamicPageOpenedPayload": { + "CartError": { "type": "object", - "required": [ - "type" - ], + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "type": { - "type": "string", - "description": "The type of the current dynamic page" - }, - "opened": { - "type": "boolean", - "default": true + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "level": { + "type": "number", + "enum": [ + 0, + 10, + 20 + ], + "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" + }, + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" + } + } } } + }, + "PresentationCmsPage": { + "allOf": [ + { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + }, + { + "type": "object", + "properties": { + "pickedProductIds": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Product id" + } + }, + { + "type": "null" + } + ], + "description": "The product id is assigned to presentation if it's product listing or instant listing" + } + } + } + ] } }, "responses": { @@ -57941,6 +60466,39 @@ } } }, + "429": { + "description": "Too Many Requests", + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/failure" + }, + "example": { + "errors": [ + { + "status": "429", + "title": "Too Many Requests", + "description": "Rate limit exceeded. Please wait before retrying." + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + }, + "example": { + "errors": [ + { + "status": "429", + "title": "Too Many Requests", + "description": "Rate limit exceeded. Please wait before retrying." + } + ] + } + } + } + }, "204": { "description": "No Content" }, @@ -58656,6 +61214,10 @@ "name": "Sales Channel Domain", "description": "The endpoint for operations on Sales Channel Domain" }, + { + "name": "Sales Channel File", + "description": "The endpoint for operations on Sales Channel File" + }, { "name": "Sales Channel Tracking Customer", "description": "The endpoint for operations on Sales Channel Tracking Customer" diff --git a/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index b01eb3f..7012b45 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -21,14 +21,24 @@ "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics", "/_action/integration/{integrationId}/mcp-allowlist", + "/_action/mail-template/available-variables", + "/_action/mail-template/get-data-and-send", + "/_action/mail-template/preview", + "/_action/mail-template/simulate", "/_action/mcp/capabilities", "/_action/mcp/tools", + "/_action/media/presign-upload", + "/_action/media/{mediaId}/finalize-upload", "/_action/number-range/{numberRangeId}/preview-pattern", + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}", + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}/detail", + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}/preview", "/_action/user/{userId}/mcp-allowlist", "/_mcp", "/aggregate/app-mcp-prompt", "/aggregate/app-mcp-resource", "/aggregate/app-mcp-tool", + "/aggregate/document-file", "/aggregate/dsr-appointment", "/aggregate/dsr-appointment-attendee", "/aggregate/dsr-appointment-request", @@ -38,12 +48,15 @@ "/aggregate/dsr-interaction", "/aggregate/dsr-presentation", "/aggregate/dsr-presentation-cms-page", + "/aggregate/sales-channel-file", "/app-mcp-prompt", "/app-mcp-prompt/{id}", "/app-mcp-resource", "/app-mcp-resource/{id}", "/app-mcp-tool", "/app-mcp-tool/{id}", + "/document-file", + "/document-file/{id}", "/dsr-appointment", "/dsr-appointment-attendee", "/dsr-appointment-attendee/{id}", @@ -62,9 +75,12 @@ "/dsr-presentation-cms-page", "/dsr-presentation-cms-page/{id}", "/dsr-presentation/{id}", + "/sales-channel-file", + "/sales-channel-file/{id}", "/search/app-mcp-prompt", "/search/app-mcp-resource", "/search/app-mcp-tool", + "/search/document-file", "/search/dsr-appointment", "/search/dsr-appointment-attendee", "/search/dsr-appointment-request", @@ -73,7 +89,8 @@ "/search/dsr-cms-slide", "/search/dsr-interaction", "/search/dsr-presentation", - "/search/dsr-presentation-cms-page" + "/search/dsr-presentation-cms-page", + "/search/sales-channel-file" ], "schemas": [ "AbstractDynamicPageOpenedPayload", @@ -400,6 +417,16 @@ "SalesChannelCurrency", "SalesChannelDomain", "SalesChannelDomainJsonApi", + "SalesChannelFile", + "SalesChannelFileConfiguration", + "SalesChannelFileDescriptor", + "SalesChannelFileDetail", + "SalesChannelFileDetailResponse", + "SalesChannelFileJsonApi", + "SalesChannelFileListResponse", + "SalesChannelFilePreviewRequest", + "SalesChannelFilePreviewResponse", + "SalesChannelFileTemplate", "SalesChannelJsonApi", "SalesChannelLanguage", "SalesChannelPaymentMethod",