From b2f6155b7ba07aac0a304f13031b96a8306e249e Mon Sep 17 00:00:00 2001 From: shopwareBot Date: Thu, 11 Jun 2026 11:33:56 +0000 Subject: [PATCH] [create-pull-request] automated change --- SwagDigitalSalesRooms-adminapi.json | 8311 +++++++------------ SwagDigitalSalesRooms-adminapi.summary.json | 18 - 2 files changed, 2969 insertions(+), 5360 deletions(-) diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index 69122a5..a326055 100644 --- a/SwagDigitalSalesRooms-adminapi.json +++ b/SwagDigitalSalesRooms-adminapi.json @@ -15,14 +15,14 @@ } ], "paths": { - "/app-mcp-prompt": { + "/dsr-appointment": { "get": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "List with basic information of App Mcp Prompt resources.", - "description": "Available since: 6.7.0.0", - "operationId": "getAppMcpPromptList", + "summary": "List with basic information of Dsr Appointment resources.", + "description": "", + "operationId": "getDsrAppointmentList", "parameters": [ { "name": "limit", @@ -51,7 +51,7 @@ ], "responses": { "200": { - "description": "List of App Mcp Prompt resources.", + "description": "List of Dsr Appointment resources.", "content": { "application/vnd.api+json": { "schema": { @@ -70,7 +70,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } ] @@ -84,16 +84,16 @@ "type": "object", "properties": { "first": { - "example": "/app-mcp-prompt?limit=25" + "example": "/dsr-appointment?limit=25" }, "last": { - "example": "/app-mcp-prompt?limit=25&page=11" + "example": "/dsr-appointment?limit=25&page=11" }, "next": { - "example": "/app-mcp-prompt?limit=25&page=4" + "example": "/dsr-appointment?limit=25&page=4" }, "prev": { - "example": "/app-mcp-prompt?limit=25&page=2" + "example": "/dsr-appointment?limit=25&page=2" } } } @@ -114,7 +114,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -129,11 +129,11 @@ }, "post": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "Create a new App Mcp Prompt resources.", - "description": "Available since: 6.7.0.0", - "operationId": "createAppMcpPrompt", + "summary": "Create a new Dsr Appointment resources.", + "description": "", + "operationId": "createDsrAppointment", "parameters": [ { "name": "_response", @@ -152,14 +152,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } }, "responses": { "200": { - "description": "Detail of AppMcpPrompt", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -171,7 +171,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -186,7 +186,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -202,14 +202,14 @@ } } }, - "/search/app-mcp-prompt": { + "/search/dsr-appointment": { "post": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "Search for the App Mcp Prompt resources.", - "description": "Available since: 6.7.0.0", - "operationId": "searchAppMcpPrompt", + "summary": "Search for the Dsr Appointment resources.", + "description": "", + "operationId": "searchDsrAppointment", "parameters": [ { "name": "sw-include-search-info", @@ -237,7 +237,7 @@ }, "responses": { "200": { - "description": "List of AppMcpPrompt", + "description": "List of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -251,7 +251,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -269,7 +269,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -286,19 +286,19 @@ } } }, - "/app-mcp-prompt/{id}": { + "/dsr-appointment/{id}": { "get": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "Detailed information about a App Mcp Prompt resource.", - "description": "Available since: 6.7.0.0", - "operationId": "getAppMcpPrompt", + "summary": "Detailed information about a Dsr Appointment resource.", + "description": "", + "operationId": "getDsrAppointment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_prompt", + "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", @@ -308,7 +308,7 @@ ], "responses": { "200": { - "description": "Detail of AppMcpPrompt", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -320,7 +320,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -335,7 +335,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -352,16 +352,16 @@ }, "delete": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "Delete a App Mcp Prompt resource.", - "description": "Available since: 6.7.0.0", - "operationId": "deleteAppMcpPrompt", + "summary": "Delete a Dsr Appointment resource.", + "description": "", + "operationId": "deleteDsrAppointment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_prompt", + "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", @@ -392,16 +392,16 @@ }, "patch": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "Partially update information about a App Mcp Prompt resource.", - "description": "Available since: 6.7.0.0", - "operationId": "updateAppMcpPrompt", + "summary": "Partially update information about a Dsr Appointment resource.", + "description": "", + "operationId": "updateDsrAppointment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_prompt", + "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", @@ -419,18 +419,18 @@ } ], "requestBody": { - "description": "Partially update information about a App Mcp Prompt resource.", + "description": "Partially update information about a Dsr Appointment resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } }, "responses": { "200": { - "description": "Detail of AppMcpPrompt", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -442,7 +442,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -457,7 +457,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -476,14 +476,14 @@ } } }, - "/aggregate/app-mcp-prompt": { + "/aggregate/dsr-appointment": { "post": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "Aggregate for the App Mcp Prompt resources.", - "description": "Available since: 6.7.0.0", - "operationId": "aggregateAppMcpPrompt", + "summary": "Aggregate for the Dsr Appointment resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrAppointment", "requestBody": { "required": true, "content": { @@ -507,7 +507,7 @@ }, "responses": { "200": { - "description": "List of AppMcpPrompt", + "description": "List of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -521,7 +521,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -539,7 +539,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -556,14 +556,14 @@ } } }, - "/app-mcp-resource": { + "/dsr-appointment-attendee": { "get": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "List with basic information of App Mcp Resource resources.", - "description": "Available since: 6.7.0.0", - "operationId": "getAppMcpResourceList", + "summary": "List with basic information of Dsr Appointment Attendee resources.", + "description": "", + "operationId": "getDsrAppointmentAttendeeList", "parameters": [ { "name": "limit", @@ -592,7 +592,7 @@ ], "responses": { "200": { - "description": "List of App Mcp Resource resources.", + "description": "List of Dsr Appointment Attendee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -611,7 +611,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } ] @@ -625,16 +625,16 @@ "type": "object", "properties": { "first": { - "example": "/app-mcp-resource?limit=25" + "example": "/dsr-appointment-attendee?limit=25" }, "last": { - "example": "/app-mcp-resource?limit=25&page=11" + "example": "/dsr-appointment-attendee?limit=25&page=11" }, "next": { - "example": "/app-mcp-resource?limit=25&page=4" + "example": "/dsr-appointment-attendee?limit=25&page=4" }, "prev": { - "example": "/app-mcp-resource?limit=25&page=2" + "example": "/dsr-appointment-attendee?limit=25&page=2" } } } @@ -655,7 +655,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -670,11 +670,11 @@ }, "post": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "Create a new App Mcp Resource resources.", - "description": "Available since: 6.7.0.0", - "operationId": "createAppMcpResource", + "summary": "Create a new Dsr Appointment Attendee resources.", + "description": "", + "operationId": "createDsrAppointmentAttendee", "parameters": [ { "name": "_response", @@ -693,14 +693,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } }, "responses": { "200": { - "description": "Detail of AppMcpResource", + "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -712,7 +712,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -727,7 +727,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -743,14 +743,14 @@ } } }, - "/search/app-mcp-resource": { + "/search/dsr-appointment-attendee": { "post": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "Search for the App Mcp Resource resources.", - "description": "Available since: 6.7.0.0", - "operationId": "searchAppMcpResource", + "summary": "Search for the Dsr Appointment Attendee resources.", + "description": "", + "operationId": "searchDsrAppointmentAttendee", "parameters": [ { "name": "sw-include-search-info", @@ -778,7 +778,7 @@ }, "responses": { "200": { - "description": "List of AppMcpResource", + "description": "List of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -792,7 +792,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -810,7 +810,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -827,19 +827,19 @@ } } }, - "/app-mcp-resource/{id}": { + "/dsr-appointment-attendee/{id}": { "get": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "Detailed information about a App Mcp Resource resource.", - "description": "Available since: 6.7.0.0", - "operationId": "getAppMcpResource", + "summary": "Detailed information about a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "getDsrAppointmentAttendee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_resource", + "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", @@ -849,7 +849,7 @@ ], "responses": { "200": { - "description": "Detail of AppMcpResource", + "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -861,7 +861,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -876,7 +876,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -893,16 +893,16 @@ }, "delete": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "Delete a App Mcp Resource resource.", - "description": "Available since: 6.7.0.0", - "operationId": "deleteAppMcpResource", + "summary": "Delete a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "deleteDsrAppointmentAttendee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_resource", + "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", @@ -933,16 +933,16 @@ }, "patch": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "Partially update information about a App Mcp Resource resource.", - "description": "Available since: 6.7.0.0", - "operationId": "updateAppMcpResource", + "summary": "Partially update information about a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "updateDsrAppointmentAttendee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_resource", + "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", @@ -960,18 +960,18 @@ } ], "requestBody": { - "description": "Partially update information about a App Mcp Resource resource.", + "description": "Partially update information about a Dsr Appointment Attendee resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } }, "responses": { "200": { - "description": "Detail of AppMcpResource", + "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -983,7 +983,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -998,7 +998,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -1017,14 +1017,14 @@ } } }, - "/aggregate/app-mcp-resource": { + "/aggregate/dsr-appointment-attendee": { "post": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "Aggregate for the App Mcp Resource resources.", - "description": "Available since: 6.7.0.0", - "operationId": "aggregateAppMcpResource", + "summary": "Aggregate for the Dsr Appointment Attendee resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrAppointmentAttendee", "requestBody": { "required": true, "content": { @@ -1048,7 +1048,7 @@ }, "responses": { "200": { - "description": "List of AppMcpResource", + "description": "List of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -1062,7 +1062,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -1080,7 +1080,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -1097,14 +1097,14 @@ } } }, - "/app-mcp-tool": { + "/dsr-appointment-request": { "get": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "List with basic information of App Mcp Tool resources.", - "description": "Available since: 6.7.0.0", - "operationId": "getAppMcpToolList", + "summary": "List with basic information of Dsr Appointment Request resources.", + "description": "", + "operationId": "getDsrAppointmentRequestList", "parameters": [ { "name": "limit", @@ -1133,7 +1133,7 @@ ], "responses": { "200": { - "description": "List of App Mcp Tool resources.", + "description": "List of Dsr Appointment Request resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1152,7 +1152,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } ] @@ -1166,16 +1166,16 @@ "type": "object", "properties": { "first": { - "example": "/app-mcp-tool?limit=25" + "example": "/dsr-appointment-request?limit=25" }, "last": { - "example": "/app-mcp-tool?limit=25&page=11" + "example": "/dsr-appointment-request?limit=25&page=11" }, "next": { - "example": "/app-mcp-tool?limit=25&page=4" + "example": "/dsr-appointment-request?limit=25&page=4" }, "prev": { - "example": "/app-mcp-tool?limit=25&page=2" + "example": "/dsr-appointment-request?limit=25&page=2" } } } @@ -1196,7 +1196,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1211,11 +1211,11 @@ }, "post": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "Create a new App Mcp Tool resources.", - "description": "Available since: 6.7.0.0", - "operationId": "createAppMcpTool", + "summary": "Create a new Dsr Appointment Request resources.", + "description": "", + "operationId": "createDsrAppointmentRequest", "parameters": [ { "name": "_response", @@ -1234,14 +1234,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } }, "responses": { "200": { - "description": "Detail of AppMcpTool", + "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1253,7 +1253,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1268,7 +1268,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1284,14 +1284,14 @@ } } }, - "/search/app-mcp-tool": { + "/search/dsr-appointment-request": { "post": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "Search for the App Mcp Tool resources.", - "description": "Available since: 6.7.0.0", - "operationId": "searchAppMcpTool", + "summary": "Search for the Dsr Appointment Request resources.", + "description": "", + "operationId": "searchDsrAppointmentRequest", "parameters": [ { "name": "sw-include-search-info", @@ -1319,7 +1319,7 @@ }, "responses": { "200": { - "description": "List of AppMcpTool", + "description": "List of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1333,7 +1333,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1351,7 +1351,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1368,19 +1368,19 @@ } } }, - "/app-mcp-tool/{id}": { + "/dsr-appointment-request/{id}": { "get": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "Detailed information about a App Mcp Tool resource.", - "description": "Available since: 6.7.0.0", - "operationId": "getAppMcpTool", + "summary": "Detailed information about a Dsr Appointment Request resource.", + "description": "", + "operationId": "getDsrAppointmentRequest", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_tool", + "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", @@ -1390,7 +1390,7 @@ ], "responses": { "200": { - "description": "Detail of AppMcpTool", + "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1402,7 +1402,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1417,7 +1417,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1434,16 +1434,16 @@ }, "delete": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "Delete a App Mcp Tool resource.", - "description": "Available since: 6.7.0.0", - "operationId": "deleteAppMcpTool", + "summary": "Delete a Dsr Appointment Request resource.", + "description": "", + "operationId": "deleteDsrAppointmentRequest", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_tool", + "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", @@ -1474,16 +1474,16 @@ }, "patch": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "Partially update information about a App Mcp Tool resource.", - "description": "Available since: 6.7.0.0", - "operationId": "updateAppMcpTool", + "summary": "Partially update information about a Dsr Appointment Request resource.", + "description": "", + "operationId": "updateDsrAppointmentRequest", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_tool", + "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", @@ -1501,18 +1501,18 @@ } ], "requestBody": { - "description": "Partially update information about a App Mcp Tool resource.", + "description": "Partially update information about a Dsr Appointment Request resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } }, "responses": { "200": { - "description": "Detail of AppMcpTool", + "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1524,7 +1524,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1539,7 +1539,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1558,14 +1558,14 @@ } } }, - "/aggregate/app-mcp-tool": { + "/aggregate/dsr-appointment-request": { "post": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "Aggregate for the App Mcp Tool resources.", - "description": "Available since: 6.7.0.0", - "operationId": "aggregateAppMcpTool", + "summary": "Aggregate for the Dsr Appointment Request resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrAppointmentRequest", "requestBody": { "required": true, "content": { @@ -1589,7 +1589,7 @@ }, "responses": { "200": { - "description": "List of AppMcpTool", + "description": "List of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1603,7 +1603,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1621,7 +1621,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1638,14 +1638,14 @@ } } }, - "/dsr-appointment": { + "/dsr-appointment-video-chat": { "get": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "List with basic information of Dsr Appointment resources.", + "summary": "List with basic information of Dsr Appointment Video Chat resources.", "description": "", - "operationId": "getDsrAppointmentList", + "operationId": "getDsrAppointmentVideoChatList", "parameters": [ { "name": "limit", @@ -1674,7 +1674,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment resources.", + "description": "List of Dsr Appointment Video Chat resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1693,7 +1693,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } ] @@ -1707,16 +1707,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment?limit=25" + "example": "/dsr-appointment-video-chat?limit=25" }, "last": { - "example": "/dsr-appointment?limit=25&page=11" + "example": "/dsr-appointment-video-chat?limit=25&page=11" }, "next": { - "example": "/dsr-appointment?limit=25&page=4" + "example": "/dsr-appointment-video-chat?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment?limit=25&page=2" + "example": "/dsr-appointment-video-chat?limit=25&page=2" } } } @@ -1737,7 +1737,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1752,11 +1752,11 @@ }, "post": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "Create a new Dsr Appointment resources.", + "summary": "Create a new Dsr Appointment Video Chat resources.", "description": "", - "operationId": "createDsrAppointment", + "operationId": "createDsrAppointmentVideoChat", "parameters": [ { "name": "_response", @@ -1775,14 +1775,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -1794,7 +1794,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1809,7 +1809,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1825,14 +1825,14 @@ } } }, - "/search/dsr-appointment": { + "/search/dsr-appointment-video-chat": { "post": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "Search for the Dsr Appointment resources.", + "summary": "Search for the Dsr Appointment Video Chat resources.", "description": "", - "operationId": "searchDsrAppointment", + "operationId": "searchDsrAppointmentVideoChat", "parameters": [ { "name": "sw-include-search-info", @@ -1860,7 +1860,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointment", + "description": "List of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -1874,7 +1874,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1892,7 +1892,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1909,19 +1909,19 @@ } } }, - "/dsr-appointment/{id}": { + "/dsr-appointment-video-chat/{id}": { "get": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "Detailed information about a Dsr Appointment resource.", + "summary": "Detailed information about a Dsr Appointment Video Chat resource.", "description": "", - "operationId": "getDsrAppointment", + "operationId": "getDsrAppointmentVideoChat", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment", + "description": "Identifier for the dsr_appointment_video_chat", "required": true, "schema": { "type": "string", @@ -1931,7 +1931,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -1943,7 +1943,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1958,7 +1958,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1975,16 +1975,16 @@ }, "delete": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "Delete a Dsr Appointment resource.", + "summary": "Delete a Dsr Appointment Video Chat resource.", "description": "", - "operationId": "deleteDsrAppointment", + "operationId": "deleteDsrAppointmentVideoChat", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment", + "description": "Identifier for the dsr_appointment_video_chat", "required": true, "schema": { "type": "string", @@ -2015,16 +2015,16 @@ }, "patch": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "Partially update information about a Dsr Appointment resource.", + "summary": "Partially update information about a Dsr Appointment Video Chat resource.", "description": "", - "operationId": "updateDsrAppointment", + "operationId": "updateDsrAppointmentVideoChat", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment", + "description": "Identifier for the dsr_appointment_video_chat", "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 Dsr Appointment Video Chat resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -2065,7 +2065,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -2080,7 +2080,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -2099,14 +2099,14 @@ } } }, - "/aggregate/dsr-appointment": { + "/aggregate/dsr-appointment-video-chat": { "post": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "Aggregate for the Dsr Appointment resources.", + "summary": "Aggregate for the Dsr Appointment Video Chat resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointment", + "operationId": "aggregateDsrAppointmentVideoChat", "requestBody": { "required": true, "content": { @@ -2130,7 +2130,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointment", + "description": "List of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -2144,7 +2144,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -2162,7 +2162,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -2179,14 +2179,14 @@ } } }, - "/dsr-appointment-attendee": { + "/dsr-attendee-product-collection": { "get": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "List with basic information of Dsr Appointment Attendee resources.", + "summary": "List with basic information of Dsr Attendee Product Collection resources.", "description": "", - "operationId": "getDsrAppointmentAttendeeList", + "operationId": "getDsrAttendeeProductCollectionList", "parameters": [ { "name": "limit", @@ -2215,7 +2215,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment Attendee resources.", + "description": "List of Dsr Attendee Product Collection resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2234,7 +2234,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } ] @@ -2248,16 +2248,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment-attendee?limit=25" + "example": "/dsr-attendee-product-collection?limit=25" }, "last": { - "example": "/dsr-appointment-attendee?limit=25&page=11" + "example": "/dsr-attendee-product-collection?limit=25&page=11" }, "next": { - "example": "/dsr-appointment-attendee?limit=25&page=4" + "example": "/dsr-attendee-product-collection?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment-attendee?limit=25&page=2" + "example": "/dsr-attendee-product-collection?limit=25&page=2" } } } @@ -2278,7 +2278,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2293,11 +2293,11 @@ }, "post": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "Create a new Dsr Appointment Attendee resources.", + "summary": "Create a new Dsr Attendee Product Collection resources.", "description": "", - "operationId": "createDsrAppointmentAttendee", + "operationId": "createDsrAttendeeProductCollection", "parameters": [ { "name": "_response", @@ -2316,14 +2316,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2335,7 +2335,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2350,7 +2350,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2366,14 +2366,14 @@ } } }, - "/search/dsr-appointment-attendee": { + "/search/dsr-attendee-product-collection": { "post": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "Search for the Dsr Appointment Attendee resources.", + "summary": "Search for the Dsr Attendee Product Collection resources.", "description": "", - "operationId": "searchDsrAppointmentAttendee", + "operationId": "searchDsrAttendeeProductCollection", "parameters": [ { "name": "sw-include-search-info", @@ -2401,7 +2401,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentAttendee", + "description": "List of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2415,7 +2415,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2433,7 +2433,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2450,19 +2450,19 @@ } } }, - "/dsr-appointment-attendee/{id}": { + "/dsr-attendee-product-collection/{id}": { "get": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "Detailed information about a Dsr Appointment Attendee resource.", + "summary": "Detailed information about a Dsr Attendee Product Collection resource.", "description": "", - "operationId": "getDsrAppointmentAttendee", + "operationId": "getDsrAttendeeProductCollection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_attendee", + "description": "Identifier for the dsr_attendee_product_collection", "required": true, "schema": { "type": "string", @@ -2472,7 +2472,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2484,7 +2484,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2499,7 +2499,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2516,16 +2516,16 @@ }, "delete": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "Delete a Dsr Appointment Attendee resource.", + "summary": "Delete a Dsr Attendee Product Collection resource.", "description": "", - "operationId": "deleteDsrAppointmentAttendee", + "operationId": "deleteDsrAttendeeProductCollection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_attendee", + "description": "Identifier for the dsr_attendee_product_collection", "required": true, "schema": { "type": "string", @@ -2556,16 +2556,16 @@ }, "patch": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "Partially update information about a Dsr Appointment Attendee resource.", + "summary": "Partially update information about a Dsr Attendee Product Collection resource.", "description": "", - "operationId": "updateDsrAppointmentAttendee", + "operationId": "updateDsrAttendeeProductCollection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_attendee", + "description": "Identifier for the dsr_attendee_product_collection", "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 Attendee Product Collection resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2606,7 +2606,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2621,7 +2621,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2640,14 +2640,14 @@ } } }, - "/aggregate/dsr-appointment-attendee": { + "/aggregate/dsr-attendee-product-collection": { "post": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "Aggregate for the Dsr Appointment Attendee resources.", + "summary": "Aggregate for the Dsr Attendee Product Collection resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointmentAttendee", + "operationId": "aggregateDsrAttendeeProductCollection", "requestBody": { "required": true, "content": { @@ -2671,7 +2671,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentAttendee", + "description": "List of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2685,7 +2685,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2703,7 +2703,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2720,14 +2720,14 @@ } } }, - "/dsr-appointment-request": { + "/dsr-cms-slide": { "get": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "List with basic information of Dsr Appointment Request resources.", + "summary": "List with basic information of Dsr Cms Slide resources.", "description": "", - "operationId": "getDsrAppointmentRequestList", + "operationId": "getDsrCmsSlideList", "parameters": [ { "name": "limit", @@ -2756,7 +2756,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment Request resources.", + "description": "List of Dsr Cms Slide resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2775,7 +2775,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } ] @@ -2789,16 +2789,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment-request?limit=25" + "example": "/dsr-cms-slide?limit=25" }, "last": { - "example": "/dsr-appointment-request?limit=25&page=11" + "example": "/dsr-cms-slide?limit=25&page=11" }, "next": { - "example": "/dsr-appointment-request?limit=25&page=4" + "example": "/dsr-cms-slide?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment-request?limit=25&page=2" + "example": "/dsr-cms-slide?limit=25&page=2" } } } @@ -2819,7 +2819,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2834,11 +2834,11 @@ }, "post": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "Create a new Dsr Appointment Request resources.", + "summary": "Create a new Dsr Cms Slide resources.", "description": "", - "operationId": "createDsrAppointmentRequest", + "operationId": "createDsrCmsSlide", "parameters": [ { "name": "_response", @@ -2857,14 +2857,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -2876,7 +2876,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2891,7 +2891,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2907,14 +2907,14 @@ } } }, - "/search/dsr-appointment-request": { + "/search/dsr-cms-slide": { "post": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "Search for the Dsr Appointment Request resources.", + "summary": "Search for the Dsr Cms Slide resources.", "description": "", - "operationId": "searchDsrAppointmentRequest", + "operationId": "searchDsrCmsSlide", "parameters": [ { "name": "sw-include-search-info", @@ -2942,7 +2942,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentRequest", + "description": "List of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -2956,7 +2956,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2974,7 +2974,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2991,19 +2991,19 @@ } } }, - "/dsr-appointment-request/{id}": { + "/dsr-cms-slide/{id}": { "get": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "Detailed information about a Dsr Appointment Request resource.", + "summary": "Detailed information about a Dsr Cms Slide resource.", "description": "", - "operationId": "getDsrAppointmentRequest", + "operationId": "getDsrCmsSlide", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_request", + "description": "Identifier for the dsr_cms_slide", "required": true, "schema": { "type": "string", @@ -3013,7 +3013,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -3025,7 +3025,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -3040,7 +3040,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -3057,16 +3057,16 @@ }, "delete": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "Delete a Dsr Appointment Request resource.", + "summary": "Delete a Dsr Cms Slide resource.", "description": "", - "operationId": "deleteDsrAppointmentRequest", + "operationId": "deleteDsrCmsSlide", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_request", + "description": "Identifier for the dsr_cms_slide", "required": true, "schema": { "type": "string", @@ -3097,16 +3097,16 @@ }, "patch": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "Partially update information about a Dsr Appointment Request resource.", + "summary": "Partially update information about a Dsr Cms Slide resource.", "description": "", - "operationId": "updateDsrAppointmentRequest", + "operationId": "updateDsrCmsSlide", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_request", + "description": "Identifier for the dsr_cms_slide", "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 Cms Slide resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -3147,7 +3147,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -3162,7 +3162,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -3181,14 +3181,14 @@ } } }, - "/aggregate/dsr-appointment-request": { + "/aggregate/dsr-cms-slide": { "post": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "Aggregate for the Dsr Appointment Request resources.", + "summary": "Aggregate for the Dsr Cms Slide resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointmentRequest", + "operationId": "aggregateDsrCmsSlide", "requestBody": { "required": true, "content": { @@ -3212,7 +3212,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentRequest", + "description": "List of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -3226,7 +3226,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -3244,7 +3244,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -3261,14 +3261,14 @@ } } }, - "/dsr-appointment-video-chat": { + "/dsr-interaction": { "get": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "List with basic information of Dsr Appointment Video Chat resources.", + "summary": "List with basic information of Dsr Interaction resources.", "description": "", - "operationId": "getDsrAppointmentVideoChatList", + "operationId": "getDsrInteractionList", "parameters": [ { "name": "limit", @@ -3297,7 +3297,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment Video Chat resources.", + "description": "List of Dsr Interaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3316,7 +3316,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } ] @@ -3330,16 +3330,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment-video-chat?limit=25" + "example": "/dsr-interaction?limit=25" }, "last": { - "example": "/dsr-appointment-video-chat?limit=25&page=11" + "example": "/dsr-interaction?limit=25&page=11" }, "next": { - "example": "/dsr-appointment-video-chat?limit=25&page=4" + "example": "/dsr-interaction?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment-video-chat?limit=25&page=2" + "example": "/dsr-interaction?limit=25&page=2" } } } @@ -3360,7 +3360,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3375,11 +3375,11 @@ }, "post": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "Create a new Dsr Appointment Video Chat resources.", + "summary": "Create a new Dsr Interaction resources.", "description": "", - "operationId": "createDsrAppointmentVideoChat", + "operationId": "createDsrInteraction", "parameters": [ { "name": "_response", @@ -3398,14 +3398,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3417,7 +3417,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3432,7 +3432,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3448,14 +3448,14 @@ } } }, - "/search/dsr-appointment-video-chat": { + "/search/dsr-interaction": { "post": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "Search for the Dsr Appointment Video Chat resources.", + "summary": "Search for the Dsr Interaction resources.", "description": "", - "operationId": "searchDsrAppointmentVideoChat", + "operationId": "searchDsrInteraction", "parameters": [ { "name": "sw-include-search-info", @@ -3483,7 +3483,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentVideoChat", + "description": "List of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3497,7 +3497,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3515,7 +3515,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3532,19 +3532,19 @@ } } }, - "/dsr-appointment-video-chat/{id}": { + "/dsr-interaction/{id}": { "get": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "Detailed information about a Dsr Appointment Video Chat resource.", + "summary": "Detailed information about a Dsr Interaction resource.", "description": "", - "operationId": "getDsrAppointmentVideoChat", + "operationId": "getDsrInteraction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", + "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", @@ -3554,7 +3554,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3566,7 +3566,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3581,7 +3581,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3598,16 +3598,16 @@ }, "delete": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "Delete a Dsr Appointment Video Chat resource.", + "summary": "Delete a Dsr Interaction resource.", "description": "", - "operationId": "deleteDsrAppointmentVideoChat", + "operationId": "deleteDsrInteraction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", + "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", @@ -3638,16 +3638,16 @@ }, "patch": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "Partially update information about a Dsr Appointment Video Chat resource.", + "summary": "Partially update information about a Dsr Interaction resource.", "description": "", - "operationId": "updateDsrAppointmentVideoChat", + "operationId": "updateDsrInteraction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", + "description": "Identifier for the dsr_interaction", "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 Interaction resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3688,7 +3688,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3703,7 +3703,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3722,14 +3722,14 @@ } } }, - "/aggregate/dsr-appointment-video-chat": { + "/aggregate/dsr-interaction": { "post": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "Aggregate for the Dsr Appointment Video Chat resources.", + "summary": "Aggregate for the Dsr Interaction resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointmentVideoChat", + "operationId": "aggregateDsrInteraction", "requestBody": { "required": true, "content": { @@ -3753,7 +3753,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentVideoChat", + "description": "List of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3767,7 +3767,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3785,7 +3785,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3802,14 +3802,14 @@ } } }, - "/dsr-attendee-product-collection": { + "/dsr-presentation": { "get": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "List with basic information of Dsr Attendee Product Collection resources.", + "summary": "List with basic information of Dsr Presentation resources.", "description": "", - "operationId": "getDsrAttendeeProductCollectionList", + "operationId": "getDsrPresentationList", "parameters": [ { "name": "limit", @@ -3838,7 +3838,7 @@ ], "responses": { "200": { - "description": "List of Dsr Attendee Product Collection resources.", + "description": "List of Dsr Presentation resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3857,7 +3857,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } ] @@ -3871,16 +3871,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-attendee-product-collection?limit=25" + "example": "/dsr-presentation?limit=25" }, "last": { - "example": "/dsr-attendee-product-collection?limit=25&page=11" + "example": "/dsr-presentation?limit=25&page=11" }, "next": { - "example": "/dsr-attendee-product-collection?limit=25&page=4" + "example": "/dsr-presentation?limit=25&page=4" }, "prev": { - "example": "/dsr-attendee-product-collection?limit=25&page=2" + "example": "/dsr-presentation?limit=25&page=2" } } } @@ -3901,7 +3901,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3916,11 +3916,11 @@ }, "post": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "Create a new Dsr Attendee Product Collection resources.", + "summary": "Create a new Dsr Presentation resources.", "description": "", - "operationId": "createDsrAttendeeProductCollection", + "operationId": "createDsrPresentation", "parameters": [ { "name": "_response", @@ -3939,14 +3939,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } }, "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -3958,7 +3958,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3973,7 +3973,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3989,14 +3989,14 @@ } } }, - "/search/dsr-attendee-product-collection": { + "/search/dsr-presentation": { "post": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "Search for the Dsr Attendee Product Collection resources.", + "summary": "Search for the Dsr Presentation resources.", "description": "", - "operationId": "searchDsrAttendeeProductCollection", + "operationId": "searchDsrPresentation", "parameters": [ { "name": "sw-include-search-info", @@ -4024,7 +4024,7 @@ }, "responses": { "200": { - "description": "List of DsrAttendeeProductCollection", + "description": "List of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -4038,7 +4038,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4056,7 +4056,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4073,19 +4073,19 @@ } } }, - "/dsr-attendee-product-collection/{id}": { + "/dsr-presentation/{id}": { "get": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "Detailed information about a Dsr Attendee Product Collection resource.", + "summary": "Detailed information about a Dsr Presentation resource.", "description": "", - "operationId": "getDsrAttendeeProductCollection", + "operationId": "getDsrPresentation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", + "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", @@ -4095,7 +4095,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -4107,7 +4107,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4122,7 +4122,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4139,16 +4139,16 @@ }, "delete": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "Delete a Dsr Attendee Product Collection resource.", + "summary": "Delete a Dsr Presentation resource.", "description": "", - "operationId": "deleteDsrAttendeeProductCollection", + "operationId": "deleteDsrPresentation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", + "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", @@ -4179,16 +4179,16 @@ }, "patch": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "Partially update information about a Dsr Attendee Product Collection resource.", + "summary": "Partially update information about a Dsr Presentation resource.", "description": "", - "operationId": "updateDsrAttendeeProductCollection", + "operationId": "updateDsrPresentation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", + "description": "Identifier for the dsr_presentation", "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 Presentation resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } }, "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -4229,7 +4229,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4244,7 +4244,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4263,14 +4263,14 @@ } } }, - "/aggregate/dsr-attendee-product-collection": { + "/aggregate/dsr-presentation": { "post": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "Aggregate for the Dsr Attendee Product Collection resources.", + "summary": "Aggregate for the Dsr Presentation resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAttendeeProductCollection", + "operationId": "aggregateDsrPresentation", "requestBody": { "required": true, "content": { @@ -4294,7 +4294,7 @@ }, "responses": { "200": { - "description": "List of DsrAttendeeProductCollection", + "description": "List of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -4308,7 +4308,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4326,7 +4326,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4343,14 +4343,14 @@ } } }, - "/dsr-cms-slide": { + "/dsr-presentation-cms-page": { "get": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "List with basic information of Dsr Cms Slide resources.", - "description": "", - "operationId": "getDsrCmsSlideList", + "summary": "List with basic information of Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDsrPresentationCmsPageList", "parameters": [ { "name": "limit", @@ -4379,7 +4379,7 @@ ], "responses": { "200": { - "description": "List of Dsr Cms Slide resources.", + "description": "List of Dsr Presentation Cms Page resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4398,7 +4398,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } ] @@ -4412,16 +4412,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-cms-slide?limit=25" + "example": "/dsr-presentation-cms-page?limit=25" }, "last": { - "example": "/dsr-cms-slide?limit=25&page=11" + "example": "/dsr-presentation-cms-page?limit=25&page=11" }, "next": { - "example": "/dsr-cms-slide?limit=25&page=4" + "example": "/dsr-presentation-cms-page?limit=25&page=4" }, "prev": { - "example": "/dsr-cms-slide?limit=25&page=2" + "example": "/dsr-presentation-cms-page?limit=25&page=2" } } } @@ -4442,7 +4442,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4457,11 +4457,11 @@ }, "post": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "Create a new Dsr Cms Slide resources.", - "description": "", - "operationId": "createDsrCmsSlide", + "summary": "Create a new Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDsrPresentationCmsPage", "parameters": [ { "name": "_response", @@ -4480,14 +4480,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } }, "responses": { "200": { - "description": "Detail of DsrCmsSlide", + "description": "Detail of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4499,7 +4499,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4514,7 +4514,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4530,14 +4530,14 @@ } } }, - "/search/dsr-cms-slide": { + "/search/dsr-presentation-cms-page": { "post": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "Search for the Dsr Cms Slide resources.", - "description": "", - "operationId": "searchDsrCmsSlide", + "summary": "Search for the Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDsrPresentationCmsPage", "parameters": [ { "name": "sw-include-search-info", @@ -4565,7 +4565,7 @@ }, "responses": { "200": { - "description": "List of DsrCmsSlide", + "description": "List of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4579,7 +4579,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4597,7 +4597,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4614,19 +4614,19 @@ } } }, - "/dsr-cms-slide/{id}": { + "/dsr-presentation-cms-page/{id}": { "get": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "Detailed information about a Dsr Cms Slide resource.", - "description": "", - "operationId": "getDsrCmsSlide", + "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_cms_slide", + "description": "Identifier for the dsr_presentation_cms_page", "required": true, "schema": { "type": "string", @@ -4636,7 +4636,7 @@ ], "responses": { "200": { - "description": "Detail of DsrCmsSlide", + "description": "Detail of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4648,7 +4648,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4663,7 +4663,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4680,16 +4680,16 @@ }, "delete": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "Delete a Dsr Cms Slide resource.", - "description": "", - "operationId": "deleteDsrCmsSlide", + "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_cms_slide", + "description": "Identifier for the dsr_presentation_cms_page", "required": true, "schema": { "type": "string", @@ -4720,16 +4720,16 @@ }, "patch": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "Partially update information about a Dsr Cms Slide resource.", - "description": "", - "operationId": "updateDsrCmsSlide", + "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_cms_slide", + "description": "Identifier for the dsr_presentation_cms_page", "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 Presentation Cms Page resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } }, "responses": { "200": { - "description": "Detail of DsrCmsSlide", + "description": "Detail of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4770,7 +4770,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4785,7 +4785,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4804,14 +4804,14 @@ } } }, - "/aggregate/dsr-cms-slide": { + "/aggregate/dsr-presentation-cms-page": { "post": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "Aggregate for the Dsr Cms Slide resources.", + "summary": "Aggregate for the Dsr Presentation Cms Page resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrCmsSlide", + "operationId": "aggregateDsrPresentationCmsPage", "requestBody": { "required": true, "content": { @@ -4835,7 +4835,7 @@ }, "responses": { "200": { - "description": "List of DsrCmsSlide", + "description": "List of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4849,7 +4849,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4867,7 +4867,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4884,213 +4884,233 @@ } } }, - "/dsr-interaction": { - "get": { + "/_action/dsr/appointment/{appointmentId}/join-as-guide": { + "post": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "List with basic information of Dsr Interaction resources.", - "description": "", - "operationId": "getDsrInteractionList", + "summary": "Join a meeting as a guide", + "description": "This route is used to join appointment as guide.", + "operationId": "joinAppointmentAsGuide", "parameters": [ { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { - "type": "integer" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } - }, + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JoinAppointmentResponse" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/start": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Start a presentation for a appointment", + "description": "Complete all needed data start the presentation", + "operationId": "startAppointment", + "parameters": [ { - "name": "page", - "in": "query", - "description": "The page to be returned", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { - "type": "integer" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } - }, + } + ], + "responses": { + "204": { + "description": "" + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/end": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "End a presentation for a appointment", + "description": "Complete all needed data and remove unneeded to close the presentation", + "operationId": "endAppointment", + "parameters": [ { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { - "description": "List of Dsr Interaction resources.", + "description": "" + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get the sw-context-token for a attendee", + "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", + "operationId": "getAttendeeToken", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "The sw-context-token from the attendee", "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/DsrInteraction" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-interaction?limit=25" - }, - "last": { - "example": "/dsr-interaction?limit=25&page=11" - }, - "next": { - "example": "/dsr-interaction?limit=25&page=4" - }, - "prev": { - "example": "/dsr-interaction?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } + "attendee-sw-context-token": { + "type": "string" } + }, + "example": { + "attendee-sw-context-token": "context token of attendee" } } } } - }, - "401": { - "$ref": "#/components/responses/401" } } - }, + } + }, + "/_action/dsr/appointment/{appointmentId}/instant-listing": { "post": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "Create a new Dsr Interaction resources.", - "description": "", - "operationId": "createDsrInteraction", + "summary": "Add a instant listing to the presentation", + "description": "Add a page as the instant listing to the presentation", + "operationId": "addInstantListing", "parameters": [ { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { "type": "string", - "enum": [ - "basic", - "detail" - ] + "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrInteraction" + "required": [ + "productIds" + ], + "properties": { + "productIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be added to the instant listing" + }, + "currentPageGroupId": { + "type": "string", + "description": "Id of the current cms page", + "pattern": "^[0-9a-f]{32}$" + }, + "pageName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the instant listing page" + } + }, + "type": "object" } } } }, "responses": { - "200": { - "description": "Detail of DsrInteraction", + "201": { + "description": "Created a new instant listing", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" + "index": { + "type": "integer", + "description": "The current index of the instant listing which is created by this request" } + }, + "example": { + "index": 1 } } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } - } - }, - "/search/dsr-interaction": { - "post": { + }, + "patch": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "Search for the Dsr Interaction resources.", - "description": "", - "operationId": "searchDsrInteraction", + "summary": "Update a instant listing from the presentation", + "description": "Updates the products for the given listing", + "operationId": "updateInstantListing", "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.", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" + "pattern": "^[0-9a-f]{32}$" } } ], @@ -5099,75 +5119,104 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "required": [ + "addProductIds", + "removeProductIds", + "currentPageGroupId" + ], + "properties": { + "addProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be added to the instant listing" + }, + "removeProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be removed to the instant listing" + }, + "currentPageGroupId": { + "type": "string", + "description": "Id of the current cms page", + "pattern": "^[0-9a-f]{32}$" + }, + "pageName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the instant listing page" + } + }, + "type": "object" } } } }, "responses": { "200": { - "description": "List of DsrInteraction", + "description": "Updated the instant listing", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", "properties": { - "total": { - "type": "integer" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the instant listing page" }, - "data": { + "pickedProductIds": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrInteraction" - } + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which are picked for the instant listing" + }, + "title": { + "type": "string", + "description": "The title of the instant listing" } + }, + "example": { + "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", + "pickedProductIds": [ + "018c19b80403709cb2cef54f70860042", + "018c19b804027291955d8f076c272d0d" + ], + "title": "Default Digital Sales Rooms product listing page" } } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-interaction/{id}": { + "/_action/dsr/appointment/{appointmentId}/presentation/state": { "get": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "Detailed information about a Dsr Interaction resource.", - "description": "", - "operationId": "getDsrInteraction", + "summary": "Get the current presentation state", + "description": "Returns the presentation state for all and the guide", + "operationId": "getGuidePresentationState", "parameters": [ { - "name": "id", + "name": "appointmentId", "in": "path", - "description": "Identifier for the dsr_interaction", + "description": "Appointment id", "required": true, "schema": { "type": "string", @@ -5177,283 +5226,179 @@ ], "responses": { "200": { - "description": "Detail of DsrInteraction", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } + "$ref": "#/components/schemas/GuidePresentationStateResponse" } } } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/_action/dsr/appointment/{appointmentId}/video-room": { + "post": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "Delete a Dsr Interaction resource.", - "description": "", - "operationId": "deleteDsrInteraction", + "summary": "Create a video room", + "description": "Creates a video room on the remote video tool", + "operationId": "createVideoRoom", "parameters": [ { - "name": "id", + "name": "appointmentId", "in": "path", - "description": "Identifier for the dsr_interaction", + "description": "Appointment id", "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" + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VideoChatCreateStruct" + } + } + } } } }, - "patch": { + "delete": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "Partially update information about a Dsr Interaction resource.", - "description": "", - "operationId": "updateDsrInteraction", + "summary": "Delete a video room", + "description": "Delete a video room and tokens on the remote video tool", + "operationId": "deleteVideoRoom", "parameters": [ { - "name": "id", + "name": "appointmentId", "in": "path", - "description": "Identifier for the dsr_interaction", + "description": "Appointment id", "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": { + "200": { + "description": "", + "content": { + "application/json": [] } } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { + "get": { + "tags": [ + "Appointment" ], - "requestBody": { - "description": "Partially update information about a Dsr Interaction resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrInteraction" - } + "summary": "Get attendee insights", + "description": "Get attendee insights for the given appointment", + "operationId": "getAttendeeInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "Detail of DsrInteraction", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } + "$ref": "#/components/schemas/GetAttendeeInsightsResponse" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/aggregate/dsr-interaction": { - "post": { + "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { + "get": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "Aggregate for the Dsr Interaction resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrInteraction", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "Get cart insights", + "description": "Get cart insights for the given appointment", + "operationId": "getCartInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of DsrInteraction", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } + "$ref": "#/components/schemas/GetCartInsightsResponse" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-presentation": { + "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { "get": { "tags": [ - "Dsr Presentation" + "Appointment" ], - "summary": "List with basic information of Dsr Presentation resources.", - "description": "", - "operationId": "getDsrPresentationList", + "summary": "Get cart statistics", + "description": "Get cart statistics (cart line items) of all the attendees for the given appointment", + "operationId": "getCartStatistics", "parameters": [ { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { - "type": "integer" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, { - "name": "page", + "name": "order", "in": "query", - "description": "The page to be returned", + "description": "The order of the cart line items", "schema": { - "type": "integer" + "type": "string" } }, { - "name": "query", + "name": "sort", "in": "query", - "description": "Encoded SwagQL in JSON", + "description": "The sort of the cart line items", "schema": { "type": "string" } @@ -5461,254 +5406,185 @@ ], "responses": { "200": { - "description": "List of Dsr Presentation resources.", + "description": "", "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/DsrPresentation" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-presentation?limit=25" - }, - "last": { - "example": "/dsr-presentation?limit=25&page=11" - }, - "next": { - "example": "/dsr-presentation?limit=25&page=4" - }, - "prev": { - "example": "/dsr-presentation?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "post": { + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics": { + "get": { "tags": [ - "Dsr Presentation" + "Appointment" ], - "summary": "Create a new Dsr Presentation resources.", - "description": "", - "operationId": "createDsrPresentation", + "summary": "Get last seen products insights", + "description": "Get last seen products of all attendees for the given appointment", + "operationId": "getLastSeenProductsInsights", "parameters": [ { - "name": "_response", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "limit", "in": "query", - "description": "Data format for response. Empty if none is provided.", + "description": "The limit of the products which should be returned", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "page", + "in": "query", + "description": "The page of the products which should be returned", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "term", + "in": "query", + "description": "The search term for the products", + "schema": { + "type": "string" + } + }, + { + "name": "attendeeId", + "in": "query", + "description": "The attendee id for which the last seen products should be returned", "schema": { "type": "string", - "enum": [ - "basic", - "detail" - ] + "pattern": "^[0-9a-f]{32}$" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - }, "responses": { "200": { - "description": "Detail of DsrPresentation", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } + "$ref": "#/components/schemas/WidgetProductListing" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/search/dsr-presentation": { - "post": { + "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics": { + "get": { "tags": [ - "Dsr Presentation" + "Appointment" ], - "summary": "Search for the Dsr Presentation resources.", - "description": "", - "operationId": "searchDsrPresentation", + "summary": "Get wishlist insights", + "description": "Get wishlist of all the attendees for the given appointment", + "operationId": "getWishlistInsights", "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.", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" + "pattern": "^[0-9a-f]{32}$" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + }, + { + "name": "limit", + "in": "query", + "description": "The limit of the products which should be returned", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "page", + "in": "query", + "description": "The page of the products which should be returned", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "term", + "in": "query", + "description": "The search term for the wishlist products", + "schema": { + "type": "string" + } + }, + { + "name": "order", + "in": "query", + "description": "The order of the wishlist products", + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "in": "query", + "description": "The sort of the wishlist products", + "schema": { + "type": "string" + } + }, + { + "name": "attendeeId", + "in": "query", + "description": "The attendee id for which the wishlist products should be returned", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of DsrPresentation", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } + "$ref": "#/components/schemas/WidgetProductListing" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-presentation/{id}": { - "get": { + "/_action/dsr/appointment/attendee/{attendeeId}/remove": { + "post": { "tags": [ - "Dsr Presentation" + "Appointment" ], - "summary": "Detailed information about a Dsr Presentation resource.", - "description": "", - "operationId": "getDsrPresentation", + "summary": "Remove an attendee from the appointment", + "description": "Remove an attendee from the appointment", + "operationId": "removeAttendee", "parameters": [ { - "name": "id", + "name": "attendeeId", "in": "path", - "description": "Identifier for the dsr_presentation", + "description": "Attendee id", "required": true, "schema": { "type": "string", @@ -5718,100 +5594,101 @@ ], "responses": { "200": { - "description": "Detail of DsrPresentation", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - ] - } - }, - "application/json": { + "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" + "message": { + "type": "string" + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the removed attendee" } + }, + "example": { + "message": "Attendee removed successfully", + "attendeeId": "018c19b80403709cb2cef54f70860042" } } } } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { + "get": { "tags": [ - "Dsr Presentation" + "Appointment" ], - "summary": "Delete a Dsr Presentation resource.", - "description": "", - "operationId": "deleteDsrPresentation", + "summary": "Get ids of last seen products", + "description": "Get all product ids of that attendee has seen", + "operationId": "getLastSeenProductIds", "parameters": [ { - "name": "id", + "name": "attendeeId", "in": "path", - "description": "Identifier for the dsr_presentation", + "description": "Attendee id", "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" + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "collection": { + "type": "object", + "properties": { + "lastSeen": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + } + } + }, + "example": { + "collection": { + "lastSeen": [ + "018c19b80403709cb2cef54f70860042", + "018c19b804027291955d8f076c272d0d" + ] + } + } + } + } + } } } - }, - "patch": { + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { + "get": { "tags": [ - "Dsr Presentation" + "Appointment" ], - "summary": "Partially update information about a Dsr Presentation resource.", - "description": "", - "operationId": "updateDsrPresentation", + "summary": "Load a temporary cart for the attendee", + "description": "Load a temporary cart for the attendee", + "operationId": "loadTempCart", "parameters": [ { - "name": "id", + "name": "attendeeId", "in": "path", - "description": "Identifier for the dsr_presentation", + "description": "Attendee id", "required": true, "schema": { "type": "string", @@ -5819,360 +5696,157 @@ } }, { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, + "name": "sw-context-token", + "in": "header", + "description": "Contains sw-context-token value", "schema": { "type": "string" } } ], - "requestBody": { - "description": "Partially update information about a Dsr Presentation resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - }, "responses": { "200": { - "description": "Detail of DsrPresentation", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/aggregate/dsr-presentation": { + "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount": { "post": { "tags": [ - "Dsr Presentation" + "Appointment" + ], + "summary": "Add discount to the temp cart", + "description": "Add discount to the temp cart", + "operationId": "addTempDiscount", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } ], - "summary": "Aggregate for the Dsr Presentation resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrPresentation", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/AddTempDiscountRequestBody" } } } }, "responses": { "200": { - "description": "List of DsrPresentation", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-presentation-cms-page": { - "get": { + "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { + "post": { "tags": [ - "Dsr Presentation Cms Page" + "Appointment" ], - "summary": "List with basic information of Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getDsrPresentationCmsPageList", + "summary": "Remove all discount from the temp cart", + "description": "Remove all discount from the temp cart", + "operationId": "removeTempDiscount", "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", + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { - "description": "List of Dsr Presentation Cms Page resources.", + "description": "", "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": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "401": { - "$ref": "#/components/responses/401" } } - }, + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount": { "post": { "tags": [ - "Dsr Presentation Cms Page" + "Appointment" ], - "summary": "Create a new Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createDsrPresentationCmsPage", + "summary": "Apply the discount from the temp cart to the attendee cart", + "description": "Apply the discount from the temp cart to the attendee cart", + "operationId": "applyTempDiscount", "parameters": [ { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, "schema": { "type": "string", - "enum": [ - "basic", - "detail" - ] + "pattern": "^[0-9a-f]{32}$" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - }, "responses": { "200": { - "description": "Detail of DsrPresentationCmsPage", + "description": "", "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" - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/search/dsr-presentation-cms-page": { + "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount": { "post": { "tags": [ - "Dsr Presentation Cms Page" + "Appointment" ], - "summary": "Search for the Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchDsrPresentationCmsPage", + "summary": "Add discount to the attendee cart", + "description": "Add discount to the attendee cart", + "operationId": "addCartDiscount", "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.", + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, "schema": { "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" + "pattern": "^[0-9a-f]{32}$" } } ], @@ -6181,2409 +5855,342 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/AddCartDiscountRequestBody" } } } }, "responses": { "200": { - "description": "List of DsrPresentationCmsPage", + "description": "", "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" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-presentation-cms-page/{id}": { - "get": { + "/_action/dsr/appointment/{appointmentId}/shopping-lists/{shoppingListId}": { + "post": { "tags": [ - "Dsr Presentation Cms Page" + "Appointment" ], - "summary": "Detailed information about a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDsrPresentationCmsPage", + "summary": "Load line item ids of a shopping lists from the appointment", + "description": "Load line item ids of a shopping lists from the appointment", + "operationId": "setSharingShoppingList", "parameters": [ { - "name": "id", + "name": "appointmentId", "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", + "description": "The appointment id you are joining", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - } + }, + { + "name": "shoppingListId", + "in": "path", + "description": "The shopping list id you want to load", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } ], "responses": { "200": { - "description": "Detail of DsrPresentationCmsPage", + "description": "", "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" + "type": "object", + "example": { + "data": { + "01938f89c632709ba4d65eb53604bf5b": { + "quantity": "1" + }, + "01938f89c8647036a617b7d88e1e24f5": { + "quantity": "1" + }, + "01938f8a23d47305b1e289163cea5074": { + "quantity": "1" + } + } + } } } } } } + } + }, + "security": [ + { + "ApiKey": [] + } + ] + } + } + }, + "components": { + "schemas": { + "success": { + "required": [ + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" }, - "404": { - "$ref": "#/components/responses/404" + "links": { + "description": "Link members related to the primary data.", + "allOf": [ + { + "$ref": "#/components/schemas/links" + }, + { + "$ref": "#/components/schemas/pagination" + } + ] }, - "401": { - "$ref": "#/components/responses/401" + "data": { + "$ref": "#/components/schemas/data" + }, + "included": { + "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true } - } + }, + "type": "object", + "additionalProperties": false }, - "delete": { - "tags": [ - "Dsr Presentation Cms Page" + "failure": { + "required": [ + "errors" ], - "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}$" - } + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } + "links": { + "$ref": "#/components/schemas/links" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/error" + }, + "uniqueItems": true } + }, + "type": "object", + "additionalProperties": false + }, + "info": { + "required": [ + "meta" ], - "responses": { - "204": { - "$ref": "#/components/responses/204" + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" }, - "404": { - "$ref": "#/components/responses/404" + "links": { + "$ref": "#/components/schemas/links" }, - "401": { - "$ref": "#/components/responses/401" + "jsonapi": { + "$ref": "#/components/schemas/jsonapi" } - } + }, + "type": "object" }, - "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": [ + "meta": { + "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", + "type": "object", + "additionalProperties": true + }, + "data": { + "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", + "oneOf": [ { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "$ref": "#/components/schemas/resource" }, { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } + "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true } + ] + }, + "resource": { + "description": "\"Resource objects\" appear in a JSON API document to represent resources.", + "required": [ + "type", + "id" ], - "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" - } - } - } - } - } + "properties": { + "type": { + "type": "string" }, - "400": { - "$ref": "#/components/responses/400" + "id": { + "type": "string" }, - "404": { - "$ref": "#/components/responses/404" + "attributes": { + "$ref": "#/components/schemas/attributes" }, - "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" - ] - } - } + "relationships": { + "$ref": "#/components/schemas/relationships" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/meta" } }, - "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": "object" + }, + "relationshipLinks": { + "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", + "properties": { + "self": { + "allOf": [ + { + "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", + "type": "array", + "items": { + "type": "object" } }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - } + { + "$ref": "#/components/schemas/link" } - } - }, - "400": { - "$ref": "#/components/responses/400" + ] }, - "401": { - "$ref": "#/components/responses/401" + "related": { + "$ref": "#/components/schemas/link" } + }, + "type": "object", + "additionalProperties": true + }, + "links": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/link" } - } - }, - "/_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": [ + }, + "link": { + "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", + "oneOf": [ { - "name": "numberRangeId", - "in": "path", - "description": "Identifier of the number range to preview.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" }, { - "name": "pattern", - "in": "query", - "description": "Optional pattern override for the preview.", - "required": false, - "schema": { - "type": "string" + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } } + } + ] + }, + "attributes": { + "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", + "type": "object", + "additionalProperties": true + }, + "relationships": { + "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", + "type": "object", + "anyOf": [ + { + "required": [ + "data" + ] }, { - "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" - } + "required": [ + "meta" + ] + }, + { + "required": [ + "links" + ] + }, + { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/relationshipLinks" + }, + "data": { + "description": "Member, whose value represents \"resource linkage\".", + "oneOf": [ + { + "$ref": "#/components/schemas/relationshipToOne" }, - "type": "object" - } + { + "$ref": "#/components/schemas/relationshipToMany" + } + ] } } - }, - "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": [ + "additionalProperties": false + }, + "relationshipToOne": { + "allOf": [ { - "name": "integrationId", - "in": "path", - "required": true, - "description": "The integration UUID.", - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "security": [ + "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." + }, { - "oAuth": [ - "write" - ] + "$ref": "#/components/schemas/linkage" } - ], - "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." - }, - "404": { - "description": "User not found." - } - } - } - }, - "/_action/mcp/tools": { - "get": { - "tags": [ - "MCP", - "Experimental" - ], - "summary": "List registered MCP tools", - "description": "Returns all MCP tools currently registered on this Shopware installation. For all capability types (tools, resources, prompts) use `GET /_action/mcp/capabilities` instead. Requires `integration.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "mcpToolsList", - "security": [ - { - "oAuth": [ - "write" - ] - } - ], - "responses": { - "200": { - "description": "Array of registered MCP tools.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string", - "description": "Unique tool identifier used in `tools/call` requests.", - "example": "shopware-entity-search" - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Human-readable description of what the tool does.", - "example": "Search Shopware entities and return matching records." - }, - "dependencies": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Tool names that are automatically included when this tool is selected." - }, - "requiredPrivileges": { - "oneOf": [ - { - "type": "object", - "properties": { - "static": { - "type": "array", - "items": { - "type": "string" - } - }, - "entityParam": { - "type": [ - "string", - "null" - ] - }, - "operations": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - { - "type": "null" - } - ], - "description": "ACL privileges required by this tool." - } - } - } - } - } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials." - }, - "403": { - "description": "Forbidden — caller lacks `integration.editor` privilege." - } - } - } - }, - "/_action/mcp/capabilities": { - "get": { - "tags": [ - "MCP", - "Experimental" - ], - "summary": "List all registered MCP capabilities", - "description": "Returns all registered MCP tools, resources, and prompts. Used by the Admin UI to populate the per-integration allowlist selector. Requires `integration.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "mcpCapabilitiesList", - "security": [ - { - "oAuth": [ - "write" - ] - } - ], - "responses": { - "200": { - "description": "Object containing all registered MCP capabilities.", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tools", - "resources", - "prompts" - ], - "properties": { - "tools": { - "type": "array", - "items": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string", - "example": "shopware-entity-search" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "dependencies": { - "type": "array", - "items": { - "type": "string" - } - }, - "requiredPrivileges": { - "oneOf": [ - { - "type": "object", - "properties": { - "static": { - "type": "array", - "items": { - "type": "string" - } - }, - "entityParam": { - "type": [ - "string", - "null" - ] - }, - "operations": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - { - "type": "null" - } - ] - } - } - } - }, - "resources": { - "type": "array", - "items": { - "type": "object", - "required": [ - "uri", - "name" - ], - "properties": { - "uri": { - "type": "string", - "example": "shopware://entity-list" - }, - "name": { - "type": "string", - "example": "shopware-entity-list" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "mimeType": { - "type": [ - "string", - "null" - ] - } - } - } - }, - "prompts": { - "type": "array", - "items": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string", - "example": "shopware-context" - }, - "description": { - "type": [ - "string", - "null" - ] - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials." - }, - "403": { - "description": "Forbidden — caller lacks `integration.editor` privilege." - } - } - } - }, - "/_mcp": { - "post": { - "tags": [ - "MCP", - "Experimental" - ], - "summary": "MCP JSON-RPC endpoint", - "description": "Handles Model Context Protocol (MCP) requests using the Streamable HTTP transport. Accepts JSON-RPC 2.0 messages for methods such as `initialize`, `tools/list`, `tools/call`, `prompts/list`, `prompts/get`, `resources/list`, and `resources/read`. Requires either an integration access key pair (`sw-access-key` + `sw-secret-access-key` headers) or a standard OAuth2 bearer token. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "mcpPost", - "parameters": [ - { - "name": "mcp-session-id", - "in": "header", - "required": false, - "description": "Session ID returned by the server after `initialize`. Required for all requests except `initialize`.", - "schema": { - "type": "string" - } - }, - { - "name": "sw-access-key", - "in": "header", - "required": false, - "description": "Integration access key for direct credential authentication (alternative to bearer token).", - "schema": { - "type": "string" - } - }, - { - "name": "sw-secret-access-key", - "in": "header", - "required": false, - "description": "Integration secret access key. Required when `sw-access-key` is provided.", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "description": "A JSON-RPC 2.0 request or batch.", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "jsonrpc", - "method" - ], - "properties": { - "jsonrpc": { - "type": "string", - "enum": [ - "2.0" - ] - }, - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "null" - } - ] - }, - "method": { - "type": "string", - "example": "tools/call" - }, - "params": { - "type": "object", - "additionalProperties": true - } - } - } - } - } - }, - "responses": { - "200": { - "description": "JSON-RPC response or Server-Sent Events stream for long-running operations.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jsonrpc": { - "type": "string", - "enum": [ - "2.0" - ] - }, - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "null" - } - ] - }, - "result": { - "type": "object", - "additionalProperties": true - }, - "error": { - "type": "object", - "properties": { - "code": { - "type": "integer" - }, - "message": { - "type": "string" - } - } - } - } - } - }, - "text/event-stream": { - "schema": { - "type": "string", - "description": "Server-Sent Events stream for streaming responses." - } - } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials." - }, - "429": { - "description": "Too many requests — rate limit exceeded." - } - } - }, - "get": { - "tags": [ - "MCP", - "Experimental" - ], - "summary": "MCP SSE stream", - "description": "Opens a Server-Sent Events stream for receiving server-initiated messages. Used by MCP clients that support the SSE transport variant. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "mcpGet", - "parameters": [ - { - "name": "mcp-session-id", - "in": "header", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Server-Sent Events stream.", - "content": { - "text/event-stream": { - "schema": { - "type": "string" - } - } - } - }, - "401": { - "description": "Unauthorized." - } - } - }, - "delete": { - "tags": [ - "MCP", - "Experimental" - ], - "summary": "Close MCP session", - "description": "Terminates an active MCP session identified by the `mcp-session-id` header. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "mcpDelete", - "parameters": [ - { - "name": "mcp-session-id", - "in": "header", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Session closed successfully." - }, - "401": { - "description": "Unauthorized." - } - } - }, - "options": { - "tags": [ - "MCP", - "Experimental" - ], - "summary": "MCP CORS preflight", - "description": "Handles CORS preflight requests for the MCP endpoint. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "mcpOptions", - "responses": { - "204": { - "description": "CORS preflight accepted." - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/join-as-guide": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Join a meeting as a guide", - "description": "This route is used to join appointment as guide.", - "operationId": "joinAppointmentAsGuide", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JoinAppointmentResponse" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/start": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Start a presentation for a appointment", - "description": "Complete all needed data start the presentation", - "operationId": "startAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "204": { - "description": "" - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/end": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "End a presentation for a appointment", - "description": "Complete all needed data and remove unneeded to close the presentation", - "operationId": "endAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get the sw-context-token for a attendee", - "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", - "operationId": "getAttendeeToken", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "The sw-context-token from the attendee", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "attendee-sw-context-token": { - "type": "string" - } - }, - "example": { - "attendee-sw-context-token": "context token of attendee" - } - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/instant-listing": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Add a instant listing to the presentation", - "description": "Add a page as the instant listing to the presentation", - "operationId": "addInstantListing", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "productIds" - ], - "properties": { - "productIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be added to the instant listing" - }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" - }, - "pageName": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The name of the instant listing page" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "description": "Created a new instant listing", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "index": { - "type": "integer", - "description": "The current index of the instant listing which is created by this request" - } - }, - "example": { - "index": 1 - } - } - } - } - } - } - }, - "patch": { - "tags": [ - "Appointment" - ], - "summary": "Update a instant listing from the presentation", - "description": "Updates the products for the given listing", - "operationId": "updateInstantListing", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "addProductIds", - "removeProductIds", - "currentPageGroupId" - ], - "properties": { - "addProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be added to the instant listing" - }, - "removeProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be removed to the instant listing" - }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" - }, - "pageName": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The name of the instant listing page" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Updated the instant listing", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the instant listing page" - }, - "pickedProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which are picked for the instant listing" - }, - "title": { - "type": "string", - "description": "The title of the instant listing" - } - }, - "example": { - "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", - "pickedProductIds": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ], - "title": "Default Digital Sales Rooms product listing page" - } - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/presentation/state": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get the current presentation state", - "description": "Returns the presentation state for all and the guide", - "operationId": "getGuidePresentationState", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidePresentationStateResponse" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/video-room": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Create a video room", - "description": "Creates a video room on the remote video tool", - "operationId": "createVideoRoom", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VideoChatCreateStruct" - } - } - } - } - } - }, - "delete": { - "tags": [ - "Appointment" - ], - "summary": "Delete a video room", - "description": "Delete a video room and tokens on the remote video tool", - "operationId": "deleteVideoRoom", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": [] - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get attendee insights", - "description": "Get attendee insights for the given appointment", - "operationId": "getAttendeeInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAttendeeInsightsResponse" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get cart insights", - "description": "Get cart insights for the given appointment", - "operationId": "getCartInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetCartInsightsResponse" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get cart statistics", - "description": "Get cart statistics (cart line items) of all the attendees for the given appointment", - "operationId": "getCartStatistics", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "order", - "in": "query", - "description": "The order of the cart line items", - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "in": "query", - "description": "The sort of the cart line items", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get last seen products insights", - "description": "Get last seen products of all attendees for the given appointment", - "operationId": "getLastSeenProductsInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "limit", - "in": "query", - "description": "The limit of the products which should be returned", - "schema": { - "type": "integer", - "default": 10 - } - }, - { - "name": "page", - "in": "query", - "description": "The page of the products which should be returned", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "term", - "in": "query", - "description": "The search term for the products", - "schema": { - "type": "string" - } - }, - { - "name": "attendeeId", - "in": "query", - "description": "The attendee id for which the last seen products should be returned", - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WidgetProductListing" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get wishlist insights", - "description": "Get wishlist of all the attendees for the given appointment", - "operationId": "getWishlistInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "limit", - "in": "query", - "description": "The limit of the products which should be returned", - "schema": { - "type": "integer", - "default": 10 - } - }, - { - "name": "page", - "in": "query", - "description": "The page of the products which should be returned", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "term", - "in": "query", - "description": "The search term for the wishlist products", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The order of the wishlist products", - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "in": "query", - "description": "The sort of the wishlist products", - "schema": { - "type": "string" - } - }, - { - "name": "attendeeId", - "in": "query", - "description": "The attendee id for which the wishlist products should be returned", - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WidgetProductListing" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/remove": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Remove an attendee from the appointment", - "description": "Remove an attendee from the appointment", - "operationId": "removeAttendee", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the removed attendee" - } - }, - "example": { - "message": "Attendee removed successfully", - "attendeeId": "018c19b80403709cb2cef54f70860042" - } - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get ids of last seen products", - "description": "Get all product ids of that attendee has seen", - "operationId": "getLastSeenProductIds", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collection": { - "type": "object", - "properties": { - "lastSeen": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - } - } - }, - "example": { - "collection": { - "lastSeen": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ] - } - } - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Load a temporary cart for the attendee", - "description": "Load a temporary cart for the attendee", - "operationId": "loadTempCart", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "sw-context-token", - "in": "header", - "description": "Contains sw-context-token value", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Add discount to the temp cart", - "description": "Add discount to the temp cart", - "operationId": "addTempDiscount", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddTempDiscountRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Remove all discount from the temp cart", - "description": "Remove all discount from the temp cart", - "operationId": "removeTempDiscount", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Apply the discount from the temp cart to the attendee cart", - "description": "Apply the discount from the temp cart to the attendee cart", - "operationId": "applyTempDiscount", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Add discount to the attendee cart", - "description": "Add discount to the attendee cart", - "operationId": "addCartDiscount", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddCartDiscountRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/shopping-lists/{shoppingListId}": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Load line item ids of a shopping lists from the appointment", - "description": "Load line item ids of a shopping lists from the appointment", - "operationId": "setSharingShoppingList", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "The appointment id you are joining", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "shoppingListId", - "in": "path", - "description": "The shopping list id you want to load", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "example": { - "data": { - "01938f89c632709ba4d65eb53604bf5b": { - "quantity": "1" - }, - "01938f89c8647036a617b7d88e1e24f5": { - "quantity": "1" - }, - "01938f8a23d47305b1e289163cea5074": { - "quantity": "1" - } - } - } - } - } - } - } - } - } - }, - "security": [ - { - "ApiKey": [] - } - ] - } - } - }, - "components": { - "schemas": { - "success": { - "required": [ - "data" - ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "description": "Link members related to the primary data.", - "allOf": [ - { - "$ref": "#/components/schemas/links" - }, - { - "$ref": "#/components/schemas/pagination" - } - ] - }, - "data": { - "$ref": "#/components/schemas/data" - }, - "included": { - "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - }, - "type": "object", - "additionalProperties": false - }, - "failure": { - "required": [ - "errors" - ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/error" - }, - "uniqueItems": true - } - }, - "type": "object", - "additionalProperties": false - }, - "info": { - "required": [ - "meta" - ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "jsonapi": { - "$ref": "#/components/schemas/jsonapi" - } - }, - "type": "object" - }, - "meta": { - "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", - "type": "object", - "additionalProperties": true - }, - "data": { - "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", - "oneOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - ] - }, - "resource": { - "description": "\"Resource objects\" appear in a JSON API document to represent resources.", - "required": [ - "type", - "id" - ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string" - }, - "attributes": { - "$ref": "#/components/schemas/attributes" - }, - "relationships": { - "$ref": "#/components/schemas/relationships" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "meta": { - "$ref": "#/components/schemas/meta" - } - }, - "type": "object" - }, - "relationshipLinks": { - "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", - "properties": { - "self": { - "allOf": [ - { - "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", - "type": "array", - "items": { - "type": "object" - } - }, - { - "$ref": "#/components/schemas/link" - } - ] - }, - "related": { - "$ref": "#/components/schemas/link" - } - }, - "type": "object", - "additionalProperties": true - }, - "links": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/link" - } - }, - "link": { - "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", - "oneOf": [ - { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - { - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - "meta": { - "$ref": "#/components/schemas/meta" - } - } - } - ] - }, - "attributes": { - "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", - "type": "object", - "additionalProperties": true - }, - "relationships": { - "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", - "type": "object", - "anyOf": [ - { - "required": [ - "data" - ] - }, - { - "required": [ - "meta" - ] - }, - { - "required": [ - "links" - ] - }, - { - "type": "object", - "properties": { - "links": { - "$ref": "#/components/schemas/relationshipLinks" - }, - "data": { - "description": "Member, whose value represents \"resource linkage\".", - "oneOf": [ - { - "$ref": "#/components/schemas/relationshipToOne" - }, - { - "$ref": "#/components/schemas/relationshipToMany" - } - ] - } - } - } - ], - "additionalProperties": false - }, - "relationshipToOne": { - "allOf": [ - { - "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." - }, - { - "$ref": "#/components/schemas/linkage" - } - ] - }, - "relationshipToMany": { - "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", - "type": "array", - "items": { - "$ref": "#/components/schemas/linkage" - }, - "uniqueItems": true - }, - "linkage": { - "description": "The \"type\" and \"id\" to non-empty members.", - "required": [ - "type", - "id" + ] + }, + "relationshipToMany": { + "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", + "type": "array", + "items": { + "$ref": "#/components/schemas/linkage" + }, + "uniqueItems": true + }, + "linkage": { + "description": "The \"type\" and \"id\" to non-empty members.", + "required": [ + "type", + "id" ], "properties": { "type": { @@ -10608,7 +8215,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 +8302,7 @@ ] }, "AppMcpPrompt": { - "description": "Added since version: 6.7.0.0", + "description": "Added since version: 6.7.11.0", "required": [ "id", "name", @@ -10744,7 +8351,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 +8445,7 @@ ] }, "AppMcpResource": { - "description": "Added since version: 6.7.0.0", + "description": "Added since version: 6.7.11.0", "required": [ "id", "name", @@ -10894,7 +8501,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 +8594,7 @@ ] }, "AppMcpTool": { - "description": "Added since version: 6.7.0.0", + "description": "Added since version: 6.7.11.0", "required": [ "id", "name", @@ -25372,7 +22979,8 @@ "type": "object" }, "templateData": { - "type": "object" + "type": "object", + "deprecated": true }, "createdAt": { "type": "string", @@ -25454,7 +23062,8 @@ "type": "object" }, "templateData": { - "type": "object" + "type": "object", + "deprecated": true }, "createdAt": { "type": "string", @@ -35653,6 +33262,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 +34670,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 +37722,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 +37843,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", @@ -54246,77 +51873,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 +52234,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 +52358,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 +52368,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", @@ -55013,723 +52674,1175 @@ "SubAggregations": { "type": "object", "properties": { - "aggregation": { - "anyOf": [ - { - "$ref": "#/components/schemas/AggregationMetrics" - }, - { - "$ref": "#/components/schemas/AggregationEntity" - }, - { - "$ref": "#/components/schemas/AggregationFilter" - }, - { - "$ref": "#/components/schemas/AggregationTerms" - }, - { - "$ref": "#/components/schemas/AggregationHistogram" + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "$ref": "#/components/schemas/AggregationEntity" + }, + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/AggregationRange" + } + ] + } + } + }, + "AggregationEntity": { + "title": "AggregationEntity", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" + }, + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "entity" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "definition": { + "description": "The entity definition e.g \"product_manufacturer\".", + "type": "string" + } + }, + "required": [ + "name", + "type", + "field", + "definition" + ] + }, + "AggregationFilter": { + "title": "AggregationFilter", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" + }, + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "filter" + ] + }, + "filter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Filters" + } + } + }, + "required": [ + "name", + "type", + "filter" + ] + }, + "AggregationTerms": { + "title": "AggregationTerms", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" + }, + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "terms" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "limit": { + "description": "The number of terms to return", + "type": "number" + }, + "sort": { + "type": "array", + "description": "Sorting the aggregation result.", + "items": { + "$ref": "#/components/schemas/Sort" + } + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "AggregationHistogram": { + "title": "AggregationHistogram", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" + }, + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "histogram" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "interval": { + "description": "The interval of the histogram", + "type": "number" + }, + "format": { + "description": "The format of the histogram", + "type": "string" + }, + "timeZone": { + "description": "The timezone of the histogram", + "type": "string" + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "AggregationRange": { + "title": "AggregationRange", + "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" + }, + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "range" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "ranges": { + "description": "The ranges of the aggregation", + "type": "array", + "items": { + "type": "object", + "anyOf": [ + { + "type": "object", + "title": "From and to", + "properties": { + "from": { + "type": "number", + "description": "The lower bound of the range" + }, + "to": { + "type": "number", + "description": "The upper bound of the range" + } + }, + "required": [ + "from", + "to" + ] + }, + { + "type": "object", + "title": "From only", + "properties": { + "from": { + "type": "string", + "description": "The lower bound of the range" + } + }, + "required": [ + "from" + ] + }, + { + "type": "object", + "title": "To only", + "properties": { + "to": { + "type": "string", + "description": "The upper bound of the range" + } + }, + "required": [ + "to" + ] + } + ] + } + } + }, + "required": [ + "name", + "type", + "field", + "ranges" + ] + }, + "AggregationMetrics": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "avg", + "count", + "max", + "min", + "stats", + "sum" + ] + }, + "field": { + "type": "string" + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "businessEventsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the event" + }, + "class": { + "type": "string", + "description": "Class name of the event" + }, + "data": { + "type": "object", + "description": "Available data of event" + }, + "aware": { + "type": "array", + "description": "Flow builder will base on awareness to show actions", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "description": "Extensions data of event", + "items": { + "type": "string" + } + } + } + } + }, + "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" + } + } + } + }, + "OAuthScopes": { + "description": "OAuth scopes that should be requested.", + "type": "string", + "enum": [ + "write", + "user-verified", + "admin", + "write user-verified", + "write admin", + "user-verified admin", + "write user-verified admin" + ] + }, + "OAuthGrant": { + "type": "object", + "properties": { + "grant_type": { + "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", + "type": "string" + } + }, + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } + }, + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" + }, + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" + }, + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "refresh_token" + ] + } + ] + }, + "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." }, - { - "$ref": "#/components/schemas/AggregationRange" + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." } - ] + } } } }, - "AggregationEntity": { - "title": "AggregationEntity", + "ConsentState": { "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], "properties": { "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" + "type": "string", + "description": "The name of the consent" }, - "type": { - "description": "The type of aggregation", + "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": [ - "entity" - ] + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" }, - "definition": { - "description": "The entity definition e.g \"product_manufacturer\".", - "type": "string" + "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." } - }, - "required": [ - "name", - "type", - "field", - "definition" - ] + } }, - "AggregationFilter": { - "title": "AggregationFilter", + "AttendeeInsights": { "type": "object", + "description": "Attendee Insights", "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" - }, - "type": { - "description": "The type of aggregation", + "id": { "type": "string", - "enum": [ - "filter" - ] + "pattern": "^[0-9a-f]{32}$", + "description": "Id of the attendee" }, - "filter": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Filters" - } + "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" } }, - "required": [ - "name", - "type", - "filter" + "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" ] }, - "AggregationTerms": { - "title": "AggregationTerms", + "DiscountLineItemPayload": { "type": "object", "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" - }, - "type": { - "description": "The type of aggregation", + "discountType": { "type": "string", "enum": [ - "terms" + "percentage", + "absolute" ] }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" - }, - "limit": { - "description": "The number of terms to return", - "type": "number" + "discountValue": { + "type": "number", + "format": "float", + "maximum": 0 }, - "sort": { - "type": "array", - "description": "Sorting the aggregation result.", - "items": { - "$ref": "#/components/schemas/Sort" - } + "discountPrice": { + "type": "number", + "format": "float", + "maximum": 0 } - }, - "required": [ - "name", - "type", - "field" - ] + } }, - "AggregationHistogram": { - "title": "AggregationHistogram", + "LineItem": { "type": "object", "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "type": { - "description": "The type of aggregation", - "type": "string", - "enum": [ - "histogram" - ] + "cover": { + "$ref": "#/components/schemas/ProductMedia" }, - "field": { - "description": "The field you want to aggregate over.", + "dataContextHash": { "type": "string" }, - "interval": { - "description": "The interval of the histogram", - "type": "number" + "dataTimestamp": { + "type": "string" }, - "format": { - "description": "The format of the histogram", + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" + }, + "description": { "type": "string" }, - "timeZone": { - "description": "The timezone of the histogram", + "good": { + "type": "boolean" + }, + "id": { "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] - }, - "AggregationRange": { - "title": "AggregationRange", - "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", + }, + "label": { "type": "string" }, - "type": { - "description": "The type of aggregation", - "type": "string", - "enum": [ - "range" - ] + "modified": { + "type": "boolean" }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "modifiedByApp": { + "type": "boolean" }, - "ranges": { - "description": "The ranges of the aggregation", - "type": "array", - "items": { - "type": "object", - "anyOf": [ - { - "type": "object", - "title": "From and to", - "properties": { - "from": { - "type": "number", - "description": "The lower bound of the range" - }, - "to": { - "type": "number", - "description": "The upper bound of the range" - } + "payload": { + "allOf": [ + { + "$ref": "#/components/schemas/ProductJsonApi" + }, + { + "type": "object", + "properties": { + "discountType": { + "type": "string", + "enum": [ + "percentage", + "absolute" + ] }, - "required": [ - "from", - "to" - ] - }, - { - "type": "object", - "title": "From only", - "properties": { - "from": { - "type": "string", - "description": "The lower bound of the range" - } + "discountValue": { + "type": "number", + "format": "float", + "maximum": 0 }, - "required": [ - "from" - ] - }, - { + "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": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] + }, + "calculatedTaxes": { + "type": "array", + "items": { "type": "object", - "title": "To only", "properties": { - "to": { + "apiAlias": { "type": "string", - "description": "The upper bound of the range" + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" } }, "required": [ - "to" + "apiAlias", + "tax", + "taxRate", + "price" ] } - ] - } - } - }, - "required": [ - "name", - "type", - "field", - "ranges" - ] - }, - "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.", + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "quantity": { "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}$" + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true }, - "gross": { - "description": "Gross list price for the associated currency.", + "totalPrice": { "type": "number" }, - "net": { - "description": "Net list price for the associated currency.", + "unitPrice": { "type": "number" }, - "linked": { - "description": "Whether gross and net list prices are linked through the tax configuration.", - "type": "boolean" + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } }, "required": [ - "gross", - "net", - "linked" + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" ] }, - "regulationPrice": { - "description": "Reference price used for legal price disclosures.", + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" + }, + "quantity": { + "type": "number" + }, + "quantityInformation": { "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.", + "maxPurchase": { "type": "number" }, - "net": { - "description": "Net regulation price for the associated currency.", + "minPurchase": { "type": "number" }, - "linked": { - "description": "Whether gross and net regulation prices are linked through the tax configuration.", - "type": "boolean" + "purchaseSteps": { + "type": "number" } - }, - "required": [ - "gross", - "net", - "linked" - ] + } + }, + "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": [ - "currencyId", - "gross", - "net", - "linked" + "id", + "type" ] }, - "businessEventsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the event" - }, - "class": { - "type": "string", - "description": "Class name of the event" - }, - "data": { - "type": "object", - "description": "Available data of event" - }, - "aware": { - "type": "array", - "description": "Flow builder will base on awareness to show actions", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "description": "Extensions data of event", - "items": { - "type": "string" - } - } - } - } - }, - "MeasurementUnits": { + "WidgetProductListing": { "type": "object", - "description": "Configuration of the measurement system", + "description": "Includes all data you will need to attend to a appointment.", "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." + "extensions": { + "type": "array", + "description": "List of extensions", + "default": [] }, - "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." - } + "products": { + "type": "array", + "description": "List of last seen products", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/Product" + }, + { + "type": "object", + "properties": { + "customFields": { + "type": "object", + "properties": { + "wishlistAttendeeIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + ] } + }, + "total": { + "type": "integer", + "description": "The total number of products" + }, + "page": { + "type": "integer", + "description": "The current page" + }, + "limit": { + "type": "integer", + "description": "The number of products per page" } } }, - "OAuthScopes": { - "description": "OAuth scopes that should be requested.", - "type": "string", - "enum": [ - "write", - "user-verified", - "admin", - "write user-verified", - "write admin", - "user-verified admin", - "write user-verified admin" - ] - }, - "OAuthGrant": { + "GetListBodyRequest": { "type": "object", "properties": { - "grant_type": { - "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", - "type": "string" - } - }, - "required": [ - "grant_type" - ], - "discriminator": { - "propertyName": "grant_type", - "mapping": { - "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", - "password": "#/components/schemas/OAuthPasswordGrant", - "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + "limit": { + "type": "integer", + "description": "Max amount of resources to be returned in a page" + }, + "page": { + "type": "integer", + "description": "The page to be returned" } } }, - "OAuthClientCredentialsGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" + "StateForGuides": { + "type": "object", + "properties": { + "clients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string" - }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" - } + "inactiveClients": { + "type": "array", + "items": { + "type": "string" }, - "required": [ - "client_id", - "client_secret" - ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" + "default": [] }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "username": { - "description": "Username of the user that should be authenticated.", + "guides": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "videoGuideToken": { + "anyOf": [ + { "type": "string" }, - "password": { - "description": "Password of the user that should be authenticated.", - "type": "string" + { + "type": "null" } - }, - "required": [ - "client_id", - "scope", - "username", - "password" ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "refresh_token": { - "description": "The refresh token that should be used to refresh the access token.", - "type": "string" - } + "quickViewState": { + "type": "array", + "items": { + "type": "string" }, - "required": [ - "client_id", - "scope", - "refresh_token" - ] + "default": [] + }, + "extensions": { + "type": "array", + "default": [] } - ] + } }, - "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" + "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": "$" } }, - "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" - } + "CartItems": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" } } - ] + } }, - "CartError": { + "CartPriceReference": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "items": { + "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" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { "type": "object", "properties": { - "key": { - "type": "string" + "price": { + "type": "number" }, - "level": { - "type": "number", + "apiAlias": { + "type": "string", "enum": [ - 0, - 10, - 20 - ], - "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" - }, - "message": { - "type": "string" - }, - "messageKey": { - "type": "string" + "cart_regulation_price" + ] } - } - } - } - }, - "GetListBodyRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "Max amount of resources to be returned in a page" + }, + "nullable": true }, - "page": { - "type": "integer", - "description": "The page to be returned" + "hasRange": { + "type": "boolean" + }, + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true } - } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] }, - "WidgetProductListing": { + "Cart": { "type": "object", - "description": "Includes all data you will need to attend to a appointment.", "properties": { - "extensions": { + "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", - "description": "List of extensions", - "default": [] + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "products": { + "errors": { "type": "array", - "description": "List of last seen products", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "items": { - "allOf": [ - { - "$ref": "#/components/schemas/Product" + "$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" }, - { - "type": "object", - "properties": { - "customFields": { - "type": "object", - "properties": { - "wishlistAttendeeIds": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } + "amount": { + "$ref": "#/components/schemas/CalculatedPrice" } - ] + } } }, - "total": { - "type": "integer", - "description": "The total number of products" + "modified": { + "type": "boolean" }, - "page": { - "type": "integer", - "description": "The current page" + "customerComment": { + "type": "string", + "description": "A comment that can be added to the cart.", + "nullable": true }, - "limit": { - "type": "integer", - "description": "The number of products per page" + "affiliateCode": { + "type": "string", + "description": "An affiliate tracking code", + "nullable": true + }, + "campaignCode": { + "type": "string", + "description": "A campaign tracking code", + "nullable": true } } }, @@ -55786,126 +53899,6 @@ "apiAlias" ] }, - "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" - } - } - }, - "DynamicProductListingPageOpenedPayload": { - "required": [ - "page" - ], - "properties": { - "page": { - "type": "integer", - "description": "Current page position in the pagination" - } - } - }, - "CartDeliveryInformation": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_information" - ] - }, - "freeDelivery": { - "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" - }, - "length": { - "type": "integer" - }, - "restockTime": { - "type": "integer" - }, - "stock": { - "type": "integer" - }, - "weight": { - "type": "integer" - }, - "width": { - "type": "integer" - } - }, - "required": [ - "apiAlias" - ] - }, "JoinAppointmentResponse": { "type": "object", "description": "Includes all data you will need to attend to a appointment.", @@ -56061,6 +54054,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": { @@ -56184,232 +54228,87 @@ "appointmentMode": { "type": "string", "enum": [ - "guided", - "self" - ] - }, - "videoAudioSettings": { - "type": "string", - "enum": [ - "both", - "none", - "audio-only" - ], - "default": "none" - }, - "videoRoomUrl": { - "type": "string", - "default": "" - }, - "attendeeRestrictionType": { - "anyOf": [ - { - "type": "string", - "enum": [ - "open", - "customer", - "rules" - ] - }, - { - "type": "null" - } - ] - }, - "productDetailDefaultPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "quickviewPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "productListingDefaultPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "broadcastMode": { - "type": "boolean", - "default": false - }, - "viewMode": { - "type": "string", - "enum": [ - "onlyYou", - "presentation", - "videoGrid" - ], - "default": "presentation" - }, - "allowScreenSharing": { - "type": "boolean", - "default": false - }, - "extensions": { - "type": "array", - "default": [] - } - } - }, - "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": [] + "guided", + "self" + ] }, - "inactiveClients": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "videoAudioSettings": { + "type": "string", + "enum": [ + "both", + "none", + "audio-only" + ], + "default": "none" }, - "guides": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "videoRoomUrl": { + "type": "string", + "default": "" }, - "videoGuideToken": { + "attendeeRestrictionType": { "anyOf": [ { - "type": "string" + "type": "string", + "enum": [ + "open", + "customer", + "rules" + ] }, { "type": "null" } ] }, - "quickViewState": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "productDetailDefaultPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "quickviewPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "productListingDefaultPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "broadcastMode": { + "type": "boolean", + "default": false + }, + "viewMode": { + "type": "string", + "enum": [ + "onlyYou", + "presentation", + "videoGrid" + ], + "default": "presentation" + }, + "allowScreenSharing": { + "type": "boolean", + "default": false }, "extensions": { "type": "array", @@ -56468,276 +54367,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 +54878,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,70 +54906,119 @@ } } }, - "CartPriceReference": { + "GuidePresentationStateResponse": { "type": "object", "properties": { - "purchaseUnit": { - "type": "number" - }, - "referenceUnit": { - "type": "number" - }, - "unitName": { - "type": "string" - }, - "price": { - "type": "number" + "stateForAll": { + "$ref": "#/components/schemas/StateForAll" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_reference" - ] + "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": [] }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" + "stateForGuides": { + "clients": [], + "inactiveClients": { + "2b4066cd37a341088e32a81e04a56817": { + "attendeeId": "2b4066cd37a341088e32a81e04a56817", + "attendeeName": "Attendee 1", + "videoUserId": null, + "hasJoined": false }, - { - "type": "null" - } - ] - }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" + "302108ad602b4ac687f5247aae5d0297": { + "attendeeId": "302108ad602b4ac687f5247aae5d0297", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] + "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 } }, - "nullable": true - }, - "hasRange": { - "type": "boolean" - }, - "variantId": { + "guides": { + "1850bbdc12dc44aba95bc78b16c3643c": { + "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", + "attendeeName": " admin", + "videoUserId": null, + "hasJoined": true + } + }, + "videoGuideToken": null, + "quickViewState": [], + "extensions": [] + } + } + }, + "AbstractDynamicPageOpenedPayload": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "description": "The type of the current dynamic page" + }, + "opened": { + "type": "boolean", + "default": true + } + } + }, + "DynamicPageOpenedPayload": { + "allOf": [ + { + "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" } - }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" ] }, "CalculatedPrice": { @@ -57474,338 +55153,286 @@ "taxRules" ] }, - "AttendeeInsights": { + "GetCartInsightsResponse": { "type": "object", - "description": "Attendee Insights", + "description": "Returns aggregations for the current carts within the appointment.", "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" + "description": "Sum of all products from all attenddees which were added to the cart during the appointment" }, "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" + "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" }, - "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 - } - } - } - ] + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the shown currency" }, - "extensions": { - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "attendees": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - } - } - } - } - } - } - } + "currencySymbol": { + "type": "string", + "description": "The currency symbol from the shown currency" }, - "price": { + "topProducts": { "type": "object", + "required": [ + "byQuantity", + "byRevenue" + ], "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] - }, - "calculatedTaxes": { + "byQuantity": { "type": "array", + "uniqueItems": true, "items": { "type": "object", "properties": { - "apiAlias": { + "productId": { "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the product" }, - "price": { - "type": "number" + "value": { + "type": "number", + "description": "The quantity in carts of this product" } }, "required": [ - "apiAlias", - "tax", - "taxRate", - "price" + "productId", + "value" ] } }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] - }, - "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": { + "byRevenue": { "type": "array", - "description": "Currently active tax rules and/or rates", + "uniqueItems": true, "items": { "type": "object", "properties": { - "taxRate": { - "type": "number", - "format": "float" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the product" }, - "name": { - "type": "string" + "value": { + "type": "number", + "description": "The net revenue in the shown currency in carts of this product" } - } + }, + "required": [ + "productId", + "value" + ] } } - }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" + } + } + }, + "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" }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" + "percentage": { + "type": "number" }, - "quantity": { + "price": { "type": "number" }, - "quantityInformation": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_list_price" + ] + } + }, + "required": [ + "apiAlias" + ] + }, + "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": [] + } + }, + "CartDeliveryInformation": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_information" + ] + }, + "freeDelivery": { + "type": "boolean" + }, + "deliveryTime": { "type": "object", "properties": { - "maxPurchase": { - "type": "number" + "name": { + "type": "string" }, - "minPurchase": { - "type": "number" + "min": { + "type": "integer" }, - "purchaseSteps": { - "type": "number" + "max": { + "type": "integer" + }, + "unit": { + "type": "string" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_time" + ] } } }, - "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": { diff --git a/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index b01eb3f..d506deb 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -20,15 +20,6 @@ "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics", - "/_action/integration/{integrationId}/mcp-allowlist", - "/_action/mcp/capabilities", - "/_action/mcp/tools", - "/_action/number-range/{numberRangeId}/preview-pattern", - "/_action/user/{userId}/mcp-allowlist", - "/_mcp", - "/aggregate/app-mcp-prompt", - "/aggregate/app-mcp-resource", - "/aggregate/app-mcp-tool", "/aggregate/dsr-appointment", "/aggregate/dsr-appointment-attendee", "/aggregate/dsr-appointment-request", @@ -38,12 +29,6 @@ "/aggregate/dsr-interaction", "/aggregate/dsr-presentation", "/aggregate/dsr-presentation-cms-page", - "/app-mcp-prompt", - "/app-mcp-prompt/{id}", - "/app-mcp-resource", - "/app-mcp-resource/{id}", - "/app-mcp-tool", - "/app-mcp-tool/{id}", "/dsr-appointment", "/dsr-appointment-attendee", "/dsr-appointment-attendee/{id}", @@ -62,9 +47,6 @@ "/dsr-presentation-cms-page", "/dsr-presentation-cms-page/{id}", "/dsr-presentation/{id}", - "/search/app-mcp-prompt", - "/search/app-mcp-resource", - "/search/app-mcp-tool", "/search/dsr-appointment", "/search/dsr-appointment-attendee", "/search/dsr-appointment-request",