diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index 21ac1fc..aba0322 100644 --- a/SwagCommercial-adminapi.json +++ b/SwagCommercial-adminapi.json @@ -111040,222 +111040,144 @@ }, "type": "object" }, - "OAuthScopes": { - "description": "OAuth scopes that should be requested.", + "MediaId": { "type": "string", - "enum": [ - "write", - "user-verified", - "admin", - "write user-verified", - "write admin", - "user-verified admin", - "write user-verified admin" - ] + "pattern": "^[0-9a-f]{32}$", + "description": "Media entity ID" }, - "OAuthGrant": { + "ExternalThumbnail": { "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" - } - }, + "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", "required": [ - "grant_type" + "url", + "width", + "height" ], - "discriminator": { - "propertyName": "grant_type", - "mapping": { - "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", - "password": "#/components/schemas/OAuthPasswordGrant", - "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + "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 } } }, - "OAuthClientCredentialsGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "type": "object", + "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": { - "client_id": { - "description": "OAuth client id.", - "type": "string" + "gross": { + "description": "Discount percentage relative to the gross list price.", + "type": "number" }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" + "net": { + "description": "Discount percentage relative to the net list price.", + "type": "number" } }, "required": [ - "client_id", - "client_secret" + "gross", + "net" ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" }, - { + "listPrice": { + "description": "Reference list price for displaying discounts.", "type": "object", "properties": { - "client_id": { - "description": "OAuth client id.", + "currencyId": { + "description": "Unique identity of the associated currency.", "type": "string", - "enum": [ - "administration" - ] + "pattern": "^[0-9a-f]{32}$" }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" + "gross": { + "description": "Gross list price for the associated currency.", + "type": "number" }, - "username": { - "description": "Username of the user that should be authenticated.", - "type": "string" + "net": { + "description": "Net list price for the associated currency.", + "type": "number" }, - "password": { - "description": "Password of the user that should be authenticated.", - "type": "string" + "linked": { + "description": "Whether gross and net list prices are linked through the tax configuration.", + "type": "boolean" } }, "required": [ - "client_id", - "scope", - "username", - "password" + "gross", + "net", + "linked" ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" }, - { + "regulationPrice": { + "description": "Reference price used for legal price disclosures.", "type": "object", "properties": { - "client_id": { - "description": "OAuth client id.", + "currencyId": { + "description": "Unique identity of the associated currency.", "type": "string", - "enum": [ - "administration" - ] + "pattern": "^[0-9a-f]{32}$" }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" + "gross": { + "description": "Gross regulation price for the associated currency.", + "type": "number" }, - "refresh_token": { - "description": "The refresh token that should be used to refresh the access token.", - "type": "string" + "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": [ - "client_id", - "scope", - "refresh_token" + "gross", + "net", + "linked" ] } - ] - }, - "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" - } - } - } - }, - "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" - } - } - } - } - }, - "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 - } - } + "currencyId", + "gross", + "net", + "linked" + ] }, "infoConfigResponse": { "type": "object", @@ -111489,50 +111411,6 @@ ], "additionalProperties": false }, - "MeasurementUnits": { - "type": "object", - "description": "Configuration of the measurement system", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." - }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." - }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." - } - } - } - } - }, "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)", @@ -112212,208 +112090,258 @@ "ranges" ] }, - "AggregationMetrics": { + "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": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "avg", - "count", - "max", - "min", - "stats", - "sum" - ] - }, - "field": { + "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": [ - "name", - "type", - "field" - ] + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } }, - "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" + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" }, - "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" - ], + { + "type": "object", "properties": { - "gross": { - "description": "Discount percentage relative to the gross list price.", - "type": "number" + "client_id": { + "description": "OAuth client id.", + "type": "string" }, - "net": { - "description": "Discount percentage relative to the net list price.", - "type": "number" + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" } }, "required": [ - "gross", - "net" + "client_id", + "client_secret" ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" }, - "listPrice": { - "description": "Reference list price for displaying discounts.", + { "type": "object", "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", + "client_id": { + "description": "OAuth client id.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "administration" + ] }, - "gross": { - "description": "Gross list price for the associated currency.", - "type": "number" + "scope": { + "$ref": "#/components/schemas/OAuthScopes" }, - "net": { - "description": "Net list price for the associated currency.", - "type": "number" + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" }, - "linked": { - "description": "Whether gross and net list prices are linked through the tax configuration.", - "type": "boolean" + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" } }, "required": [ - "gross", - "net", - "linked" + "client_id", + "scope", + "username", + "password" ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" }, - "regulationPrice": { - "description": "Reference price used for legal price disclosures.", + { "type": "object", "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", + "client_id": { + "description": "OAuth client id.", "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "Gross regulation price for the associated currency.", - "type": "number" + "enum": [ + "administration" + ] }, - "net": { - "description": "Net regulation price for the associated currency.", - "type": "number" + "scope": { + "$ref": "#/components/schemas/OAuthScopes" }, - "linked": { - "description": "Whether gross and net regulation prices are linked through the tax configuration.", - "type": "boolean" + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" } }, "required": [ - "gross", - "net", - "linked" + "client_id", + "scope", + "refresh_token" ] } - }, - "required": [ - "currencyId", - "gross", - "net", - "linked" ] }, - "ConsentState": { + "MeasurementUnits": { "type": "object", - "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt", - "acceptedUntil" - ], + "description": "Configuration of the measurement system", "properties": { - "name": { - "type": "string", - "description": "The name of the consent" - }, - "scopeName": { - "type": "string", - "description": "The scope of the consent that defines how the identifier is resolved" - }, - "identifier": { - "type": "string", - "description": "The resolved identifier of the consent" - }, - "status": { + "system": { "type": "string", "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" - }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" - }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" - }, - "acceptedUntil": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp until when the consent is accepted. null if never accepted" - }, - "acceptedRevision": { - "type": [ - "string", - "null" + "metric", + "imperial" ], - "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." }, - "latestRevision": { - "type": [ - "string", - "null" - ], - "description": "The current latest revision defined for the consent. null when the consent does not use revisions." + "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." + } + } } } }, @@ -112652,6 +112580,78 @@ } } }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + }, + "acceptedUntil": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp until when the consent is accepted. null if never accepted" + }, + "acceptedRevision": { + "type": [ + "string", + "null" + ], + "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." + }, + "latestRevision": { + "type": [ + "string", + "null" + ], + "description": "The current latest revision defined for the consent. null when the consent does not use revisions." + } + } + }, "CustomPricingResponse": { "type": "object", "required": [ @@ -112705,6 +112705,87 @@ } } }, + "CustomPricingPrice": { + "type": "object", + "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", + "required": [ + "quantityStart", + "price" + ], + "properties": { + "quantityStart": { + "type": "integer", + "format": "int64" + }, + "quantityEnd": { + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "price": { + "type": "array", + "items": { + "type": "object", + "description": "This field should house all the normal facets of the `product_price`.`price` column", + "required": [ + "currencyId", + "gross", + "net", + "linked" + ], + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + }, + "listPrice": { + "type": "object", + "properties": { + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + } + } + }, + "regulationPrice": { + "type": "object", + "properties": { + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + } + } + } + } + } + } + } + }, "CustomPricingDeleteOperation": { "type": "object", "required": [ @@ -112814,87 +112895,6 @@ } } }, - "CustomPricingPrice": { - "type": "object", - "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", - "required": [ - "quantityStart", - "price" - ], - "properties": { - "quantityStart": { - "type": "integer", - "format": "int64" - }, - "quantityEnd": { - "type": "integer", - "format": "int64", - "minimum": 1 - }, - "price": { - "type": "array", - "items": { - "type": "object", - "description": "This field should house all the normal facets of the `product_price`.`price` column", - "required": [ - "currencyId", - "gross", - "net", - "linked" - ], - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - }, - "listPrice": { - "type": "object", - "properties": { - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - } - } - }, - "regulationPrice": { - "type": "object", - "properties": { - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - } - } - } - } - } - } - } - }, "Options": { "type": "object", "properties": {