{ "openapi": "3.0.1", "info": { "title": "OpenAPI.Admin", "version": "v2" }, "paths": { "/api/v2/admin/admin-menu": { "get": { "tags": [ "Admin Menu" ], "summary": "Retrieves a admin menus", "operationId": "AdminMenuController_Get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminMenus.AdminMenusContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Admin Menu" ], "summary": "Updates an existing admin menu", "operationId": "AdminMenuController_Put", "requestBody": { "description": "Updated admin custom menu model", "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminMenus.AdminMenuContract" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminMenus.AdminMenuContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminMenus.AdminMenuContract" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminMenus.AdminMenuContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminMenus.AdminMenuContract" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/admin-roles": { "get": { "tags": [ "Admin Roles" ], "summary": "Retrieves a list of admin roles by using a \"where\" filtering", "operationId": "AdminRolesController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleSimpleContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Admin Roles" ], "summary": "Creates a new admin role", "operationId": "AdminRolesController_Create", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/admin-roles/{id}": { "get": { "tags": [ "Admin Roles" ], "summary": "Retrieves a admin role", "operationId": "AdminRolesController_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Admin Roles" ], "summary": "Updates an existing admin role", "operationId": "AdminRolesController_Update", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Admin Roles" ], "summary": "Deletes an existing admin role", "operationId": "AdminRolesController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Admin role identification", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/admin-roles/admin-roles-default-restrictions": { "get": { "tags": [ "Admin Roles" ], "summary": "Retrieves a admin roles default restrictions", "operationId": "AdminRolesController_GetDefaultPlanRestriction", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRestrictionContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/admin-users": { "get": { "tags": [ "Admin Users" ], "summary": "Retrieves a list of admin users by using a \"where\" filtering", "operationId": "AdminUsersController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Admin Users" ], "summary": "Creates a new admin user", "operationId": "AdminUsersController_InviteAdminUser", "requestBody": { "description": "Admin user model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/admin-users/{id}": { "get": { "tags": [ "Admin Users" ], "summary": "Retrieves a single admin user", "operationId": "AdminUsersController_Get", "parameters": [ { "name": "id", "in": "path", "description": "User id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Admin Users" ], "summary": "Updates an existing admin user", "operationId": "AdminUsersController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent admin user id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated admin user model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserUpdateContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserUpdateContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserUpdateContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserUpdateContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserUpdateContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Admin Users" ], "summary": "Deletes an existing admin user", "operationId": "AdminUsersController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent admin user id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/admin-users/{id}/re-invite": { "post": { "tags": [ "Admin Users" ], "summary": "Creates a new admin user", "operationId": "AdminUsersController_ReInviteAdminUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/categories": { "get": { "tags": [ "Categories" ], "summary": "Retrieves a list of categories by using a \"where\" filtering", "operationId": "CategoriesController_GetList", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.CategoryContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Categories" ], "summary": "Creates a new category", "operationId": "CategoriesController_Post", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateCategoryContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateCategoryContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateCategoryContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateCategoryContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateCategoryContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CategoryContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/categories/{id}": { "get": { "tags": [ "Categories" ], "summary": "Retrieves a single category", "operationId": "CategoriesController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Category id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CategoryContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Categories" ], "summary": "Updates an existing category", "operationId": "CategoriesController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Category id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateCategoryContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateCategoryContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateCategoryContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateCategoryContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateCategoryContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CategoryContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Categories" ], "summary": "Deletes an existing category", "operationId": "CategoriesController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Category id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/content-templates": { "get": { "tags": [ "Content Templates" ], "summary": "Retrieves a list of content templates by using a \"where\" filtering", "operationId": "ContentTemplatesController_GetList", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ContentTemplates.ContentTemplateContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Content Templates" ], "summary": "Creates a new content template", "operationId": "ContentTemplatesController_Create", "requestBody": { "description": "Content template model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestCreateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestCreateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestCreateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestCreateModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestCreateModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContentTemplates.ContentTemplateContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/content-templates/{id}": { "get": { "tags": [ "Content Templates" ], "summary": "Retrieves a single content template", "operationId": "ContentTemplatesController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Content template id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContentTemplates.ContentTemplateContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Content Templates" ], "summary": "Updates an existing content template", "operationId": "ContentTemplatesController_Update", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestUpdateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestUpdateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestUpdateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestUpdateModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestUpdateModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContentTemplates.ContentTemplateContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Content Templates" ], "summary": "Deletes an existing content template", "operationId": "ContentTemplatesController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/advanced-crm-groups": { "get": { "tags": [ "CRM Advanced Crm RestrictionGroupLayout" ], "summary": "Retrieves a list of advanced crm groups by using a \"where\" filtering", "operationId": "CRMAdvancedCrmRestrictionGroupLayoutController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "CRM Advanced Crm RestrictionGroupLayout" ], "summary": "Creates a new advanced crm group", "operationId": "CRMAdvancedCrmRestrictionGroupLayoutController_Post", "requestBody": { "description": "Advanced crm group model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupCreateContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupCreateContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupCreateContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupCreateContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupCreateContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/advanced-crm-groups/{id}": { "get": { "tags": [ "CRM Advanced Crm RestrictionGroupLayout" ], "summary": "Retrieves a single advanced crm group", "operationId": "CRMAdvancedCrmRestrictionGroupLayoutController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Advanced crm group id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "CRM Advanced Crm RestrictionGroupLayout" ], "summary": "Updates an existing advanced crm group", "operationId": "CRMAdvancedCrmRestrictionGroupLayoutController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent advanced crm group id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated advanced crm group model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupUpdateContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupUpdateContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupUpdateContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupUpdateContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupUpdateContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "CRM Advanced Crm RestrictionGroupLayout" ], "summary": "Deletes an existing advanced crm group", "operationId": "CRMAdvancedCrmRestrictionGroupLayoutController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent advanced crm group id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/advanced-crm-groups/field-types": { "get": { "tags": [ "CRM Advanced Crm RestrictionGroupLayout" ], "summary": "Retrieves a list of advanced crm group field types", "operationId": "CRMAdvancedCrmRestrictionGroupLayoutController_GetPropertyTypes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/advanced-crm-groups/types": { "get": { "tags": [ "CRM Advanced Crm RestrictionGroupLayout" ], "summary": "Retrieves a list of advanced crm group types", "operationId": "CRMAdvancedCrmRestrictionGroupLayoutController_GetApplyToTypes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupTypeContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/bookings": { "get": { "tags": [ "CRM Bookings" ], "summary": "Retrieves a list of bookings by using a \"where\" filtering", "operationId": "CRMBookingsController_GetList", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.EventBookingContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "CRM Bookings" ], "summary": "Creates a new booking", "operationId": "CRMBookingsController_ProcessFormSubmissionPublicV2", "parameters": [ { "name": "Payment_ModuleItemId", "description": "Id of event to subscribed to", "required": true, "schema": { "type": "integer" } }, { "name": "Payment_ItemQuantity", "description": "Allocations of event", "required": true, "schema": { "type": "integer" } }, { "name": "FormId", "description": "Id of form to be submitted", "required": true, "schema": { "type": "integer" } }, { "name": "MemberId", "description": "Id of member who submitted form", "required": true, "schema": { "type": "integer" } }, { "name": "", "description": "Field of form to be submitted", "schema": { "type": "string", "example": "" } }, { "name": "_", "description": "Crm Field of form to be submitted", "schema": { "type": "string", "example": "" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EventBookingContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/bookings/{id}": { "get": { "tags": [ "CRM Bookings" ], "summary": "Retrieves a single booking", "operationId": "CRMBookingsController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Contact id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EventBookingContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "CRM Bookings" ], "summary": "Updates an existing booking", "operationId": "CRMBookingsController_UpdateFormCasePublicV2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "Payment_ModuleItemId", "description": "Id of event to subscribed to", "required": true, "schema": { "type": "integer" } }, { "name": "Payment_ItemQuantity", "description": "Allocations of event", "required": true, "schema": { "type": "integer" } }, { "name": "FormId", "description": "Id of form to be submitted", "required": true, "schema": { "type": "integer" } }, { "name": "MemberId", "description": "Id of member who submitted form", "required": true, "schema": { "type": "integer" } }, { "name": "", "description": "Field of form to be submitted", "schema": { "type": "string", "example": "" } }, { "name": "_", "description": "Crm Field of form to be submitted", "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EventBookingContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "CRM Bookings" ], "summary": "Deletes an existing booking", "operationId": "CRMBookingsController_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/cases": { "get": { "tags": [ "CRM Cases" ], "summary": "Retrieves a list of cases by using a \"where\" filtering", "operationId": "CRMCasesController_GetList", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.CaseContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "CRM Cases" ], "summary": "Creates a new case", "operationId": "CRMCasesController_ProcessFormSubmissionPublicV2", "parameters": [ { "name": "FormId", "description": "Id of form to be submitted", "required": true, "schema": { "type": "integer" } }, { "name": "MemberId", "description": "Id of member who submitted form", "required": true, "schema": { "type": "integer" } }, { "name": "", "description": "Field of form to be submitted", "schema": { "type": "string", "example": "" } }, { "name": "_", "description": "Crm Field of form to be submitted", "schema": { "type": "string", "example": "" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CaseContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/cases/{id}": { "get": { "tags": [ "CRM Cases" ], "summary": "Retrieves a single case", "operationId": "CRMCasesController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Case id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CaseContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "CRM Cases" ], "summary": "Updates an existing case", "operationId": "CRMCasesController_UpdateFormCasePublicV2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "FormId", "description": "Id of form to be submitted", "required": true, "schema": { "type": "integer" } }, { "name": "MemberId", "description": "Id of member who submitted form", "required": true, "schema": { "type": "integer" } }, { "name": "", "description": "Field of form to be submitted", "schema": { "type": "string", "example": "" } }, { "name": "_", "description": "Crm Field of form to be submitted", "schema": { "type": "string", "example": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CaseContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "CRM Cases" ], "summary": "Deletes an existing case", "operationId": "CRMCasesController_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/contacts": { "get": { "tags": [ "CRM Contacts" ], "summary": "Retrieves a list of contacts by using a \"where\" filtering", "operationId": "CRMContactsController_GetList", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ContactContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "CRM Contacts" ], "summary": "Creates a new contact", "operationId": "CRMContactsController_Post", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateContactContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateContactContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateContactContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateContactContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateContactContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContactContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/contacts/{contactId}/bookings": { "get": { "tags": [ "CRM Contacts" ], "summary": "Retrieves a list of contact bookings by using a \"where\" filtering", "operationId": "CRMContactsController_GetContactBooking", "parameters": [ { "name": "contactId", "in": "path", "description": "Contact id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.EventBookingContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/contacts/{contactId}/cases": { "get": { "tags": [ "CRM Contacts" ], "summary": "Retrieves a list of contact cases by using a \"where\" filtering", "operationId": "CRMContactsController_GetContactCases", "parameters": [ { "name": "contactId", "in": "path", "description": "Contact id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.CaseContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/contacts/{contactId}/orders": { "get": { "tags": [ "CRM Contacts" ], "summary": "Retrieves a list of contact orders by using a \"where\" filtering", "operationId": "CRMContactsController_GetContactOrders", "parameters": [ { "name": "contactId", "in": "path", "description": "Contact id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.OrderContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/contacts/{contactId}/secure-zones": { "get": { "tags": [ "CRM Contacts" ], "summary": "Retrieves a list of contact secure zones", "operationId": "CRMContactsController_GetContactSecureZones", "parameters": [ { "name": "contactId", "in": "path", "description": "Contact id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContactSecureZonesContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "CRM Contacts" ], "summary": "Updates an existing contact secure zones", "operationId": "CRMContactsController_UpdateContactSecureZones", "parameters": [ { "name": "contactId", "in": "path", "description": "Contact id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContactSecureZonesContract" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContactSecureZonesContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContactSecureZonesContract" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContactSecureZonesContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContactSecureZonesContract" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContactSecureZonesContract" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/contacts/{id}": { "get": { "tags": [ "CRM Contacts" ], "summary": "Retrieves a single contact", "operationId": "CRMContactsController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Contact id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContactContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "CRM Contacts" ], "summary": "Updates an existing contact", "operationId": "CRMContactsController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent contact id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated contact model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditContactContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditContactContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditContactContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditContactContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditContactContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContactContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "CRM Contacts" ], "summary": "Deletes an existing contact", "operationId": "CRMContactsController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent contact id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/contacts/{id}/set-password": { "put": { "tags": [ "CRM Contacts" ], "summary": "Sets a contact password", "operationId": "CRMContactsController_SetPassword", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SetContactPasswordContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SetContactPasswordContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SetContactPasswordContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SetContactPasswordContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SetContactPasswordContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContactContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/{id}/discount-code": { "put": { "tags": [ "CRM Order Assets" ], "summary": "Sets a discount code to an order", "operationId": "CRMOrderAssetsController_ApplyDiscountCode", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Apply discount code to order model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyDiscountCodeToOrderContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyDiscountCodeToOrderContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyDiscountCodeToOrderContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyDiscountCodeToOrderContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyDiscountCodeToOrderContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/{id}/gift-voucher": { "put": { "tags": [ "CRM Order Assets" ], "summary": "Sets a gift voucher to an order", "operationId": "CRMOrderAssetsController_ApplyGiftVoucher", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Apply gift voucher to order model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyGiftVoucherToOrderContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyGiftVoucherToOrderContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyGiftVoucherToOrderContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyGiftVoucherToOrderContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyGiftVoucherToOrderContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/{id}/shipping": { "put": { "tags": [ "CRM Order Assets" ], "summary": "Sets a shipping option to an order", "operationId": "CRMOrderAssetsController_ApplyShippingInfo", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Apply shipping info order model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyShippingInfoToOrderContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyShippingInfoToOrderContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyShippingInfoToOrderContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyShippingInfoToOrderContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyShippingInfoToOrderContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/{id}/tax": { "put": { "tags": [ "CRM Order Assets" ], "summary": "Sets a tax code to an order", "operationId": "CRMOrderAssetsController_ApplyTax", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Apply tax to order model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyTaxToOrderContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyTaxToOrderContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyTaxToOrderContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyTaxToOrderContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ApplyTaxToOrderContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/{id}/order-lines": { "post": { "tags": [ "CRM Order Lines" ], "summary": "Creates a new order line", "operationId": "CRMOrderLinesController_CreateOrderLine", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Order line model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderLineContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderLineContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderLineContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderLineContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderLineContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderLineContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/order-lines/{id}": { "get": { "tags": [ "CRM Order Lines" ], "summary": "Retrieves a single order line", "operationId": "CRMOrderLinesController_GetOrderLine", "parameters": [ { "name": "id", "in": "path", "description": "Order line id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderLineContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "CRM Order Lines" ], "summary": "Updates an existing order line", "operationId": "CRMOrderLinesController_UpdateOrderLine", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Order line model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateOrderLineContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateOrderLineContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateOrderLineContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateOrderLineContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateOrderLineContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "CRM Order Lines" ], "summary": "Deletes an existing order line", "operationId": "CRMOrderLinesController_DeleteOrdeLine", "parameters": [ { "name": "id", "in": "path", "description": "Existent order line id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/{id}/payments": { "get": { "tags": [ "CRM Order Payments" ], "summary": "Retrieves a list of order payments by using a \"where\" filtering", "operationId": "CRMOrderPaymentsController_GetOrderPayments", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "Order id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.PaymentContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "CRM Order Payments" ], "summary": "Creates a new order payment", "operationId": "CRMOrderPaymentsController_CreateOrderPayment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderPaymentContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderPaymentContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderPaymentContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderPaymentContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderPaymentContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/payments/{id}": { "put": { "tags": [ "CRM Order Payments" ], "summary": "Updates an existing order payment", "operationId": "CRMOrderPaymentsController_UpdateOrderPayment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateOrderPaymentContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateOrderPaymentContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateOrderPaymentContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateOrderPaymentContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UpdateOrderPaymentContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "CRM Order Payments" ], "summary": "Deletes an existing order payment", "operationId": "CRMOrderPaymentsController_DeletePayment", "parameters": [ { "name": "id", "in": "path", "description": "Existent order payment id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/order-statuses": { "get": { "tags": [ "CRM Order Statuses" ], "summary": "Retrieves a list of order statuses by using a \"where\" filtering", "operationId": "CRMOrderStatusesController_GetList", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusFullContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "CRM Order Statuses" ], "summary": "Creates a new order status", "operationId": "CRMOrderStatusesController_Post", "requestBody": { "description": "Order status model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusFullContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/order-statuses/{id}": { "get": { "tags": [ "CRM Order Statuses" ], "summary": "Retrieves a single order status", "operationId": "CRMOrderStatusesController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Order status id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusFullContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "CRM Order Statuses" ], "summary": "Updates an existing order status", "operationId": "CRMOrderStatusesController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent order status id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated order status model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusFullContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "CRM Order Statuses" ], "summary": "Deletes an existing order status", "operationId": "CRMOrderStatusesController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent order status id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/trash": { "get": { "tags": [ "CRM Orders Trash" ], "summary": "Retrieves a list of trashed orders by using a \"where\" filtering", "operationId": "CRMOrdersTrashController_GetList", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.TrashedOrderContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/trash/{id}": { "delete": { "tags": [ "CRM Orders Trash" ], "summary": "Permanently deletes an order from trash", "operationId": "CRMOrdersTrashController_DeletePermanently", "parameters": [ { "name": "id", "in": "path", "description": "Order id to permanently delete.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/trash/{id}/restore": { "put": { "tags": [ "CRM Orders Trash" ], "summary": "Restores an order from trash", "operationId": "CRMOrdersTrashController_Restore", "parameters": [ { "name": "id", "in": "path", "description": "Order id to restore.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders": { "get": { "tags": [ "CRM Orders" ], "summary": "Retrieves a list of orders by using a \"where\" filtering", "operationId": "CRMOrdersController_GetList", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.OrderContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "CRM Orders" ], "summary": "Creates a new order", "operationId": "CRMOrdersController_Post", "requestBody": { "description": "Order model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateOrderContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/{id}": { "get": { "tags": [ "CRM Orders" ], "summary": "Retrieves a single order", "operationId": "CRMOrdersController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Order id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "CRM Orders" ], "summary": "Updates an existing order", "operationId": "CRMOrdersController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent order id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated contact model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditOrderContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditOrderContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditOrderContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditOrderContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditOrderContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "CRM Orders" ], "summary": "Deletes an existing order", "operationId": "CRMOrdersController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent order id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/{id}/custom-crm-groups": { "put": { "tags": [ "CRM Orders" ], "summary": "Updates an existing order custom crm group data", "operationId": "CRMOrdersController_SaveCustomGroups", "parameters": [ { "name": "id", "in": "path", "description": "Existent order id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "_" }, { "name": "_" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/{id}/generate-invoice-number": { "put": { "tags": [ "CRM Orders" ], "summary": "Generate invoice number for order", "operationId": "CRMOrdersController_GenerateInvoiceNumber", "parameters": [ { "name": "id", "in": "path", "description": "Existent order id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/{id}/generate-vat-invoice-number": { "put": { "tags": [ "CRM Orders" ], "summary": "Generate VAT invoice number for order", "operationId": "CRMOrdersController_GenerateVATInvoiceNumber", "parameters": [ { "name": "id", "in": "path", "description": "Existent order id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/orders/{id}/snapshot": { "get": { "tags": [ "CRM Orders" ], "summary": "Retrieves customer snapshot data for an order", "operationId": "CRMOrdersController_GetSnapshot", "parameters": [ { "name": "id", "in": "path", "description": "Order id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.MemberSnapshotContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/customer-types": { "get": { "tags": [ "Customer Types" ], "summary": "Retrieves a list of customer types", "operationId": "CustomerTypesController_Get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.CustomerTypeContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/discount-codes": { "get": { "tags": [ "eCommerce Discount Codes" ], "summary": "Retrieves a list of discount codes by using a \"where\" filtering", "operationId": "eCommerceDiscountCodesController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract]" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "eCommerce Discount Codes" ], "summary": "Creates a new discount code", "operationId": "eCommerceDiscountCodesController_Post", "requestBody": { "description": "Discount model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/discount-codes/{id}": { "get": { "tags": [ "eCommerce Discount Codes" ], "summary": "Retrieves a single discount code", "operationId": "eCommerceDiscountCodesController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Discount id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "eCommerce Discount Codes" ], "summary": "Updates an existing discount code", "operationId": "eCommerceDiscountCodesController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent discount id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated discount model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "eCommerce Discount Codes" ], "summary": "Deletes an existing discount code", "operationId": "eCommerceDiscountCodesController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent discount id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/gift-vouchers": { "get": { "tags": [ "eCommerce Gift Vouchers" ], "summary": "Retrieves a list of gift vouchers by using a \"where\" filtering", "operationId": "eCommerceGiftVouchersController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "eCommerce Gift Vouchers" ], "summary": "Creates a new gift voucher", "operationId": "eCommerceGiftVouchersController_Post", "requestBody": { "description": "Gift voucher model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/gift-vouchers/{id}": { "get": { "tags": [ "eCommerce Gift Vouchers" ], "summary": "Retrieves a single gift voucher", "operationId": "eCommerceGiftVouchersController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Gift voucher id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "eCommerce Gift Vouchers" ], "summary": "Updates an existing gift voucher", "operationId": "eCommerceGiftVouchersController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent gift voucher id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated gift voucher model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "eCommerce Gift Vouchers" ], "summary": "Deletes an existing gift voucher", "operationId": "eCommerceGiftVouchersController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent gift voucher id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/ecommerce-settings": { "get": { "tags": [ "eCommerce Settings" ], "summary": "Retrieves a ecommerce settings", "operationId": "eCommerceSettingsController_Get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.EcommerceSettingContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.EcommerceSettingContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.EcommerceSettingContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "eCommerce Settings" ], "summary": "Updates an existing ecommerce settings", "operationId": "eCommerceSettingsController_Put", "requestBody": { "description": "Updated ecommerce settings model", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.EcommerceSettingsRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.EcommerceSettingsRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.EcommerceSettingsRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.EcommerceSettingsRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.EcommerceSettingsRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/ecommerce-settings/countries": { "get": { "tags": [ "eCommerce Settings" ], "summary": "Retrieves a countries", "operationId": "eCommerceSettingsController_GetCountries", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.CountryContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.CountryContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.CountryContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/ecommerce-settings/tax-and-shipping": { "get": { "tags": [ "eCommerce Settings" ], "summary": "Retrieves a ecommerce shipping tax settings", "operationId": "eCommerceSettingsController_GetShippingTaxSettings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsResponseContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsResponseContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsResponseContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "eCommerce Settings" ], "summary": "Retrieves a ecommerce shipping tax settings", "operationId": "eCommerceSettingsController_PutShippingTaxSettings", "requestBody": { "description": "Updated ecommerce settings model", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsResponseContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsResponseContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsResponseContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/shipping-options": { "get": { "tags": [ "eCommerce Shipping Options" ], "summary": "Retrieves a list of shipping options by using a \"where\" filtering", "operationId": "eCommerceShippingOptionsController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } }, "post": { "tags": [ "eCommerce Shipping Options" ], "summary": "Creates a new shipping option", "operationId": "eCommerceShippingOptionsController_Post", "requestBody": { "description": "Shipping option model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/shipping-options/{id}": { "get": { "tags": [ "eCommerce Shipping Options" ], "summary": "Retrieves a single shipping option", "operationId": "eCommerceShippingOptionsController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Shipping option id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "eCommerce Shipping Options" ], "summary": "Updates an existing shipping option", "operationId": "eCommerceShippingOptionsController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent shipping option id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated shipping option model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "eCommerce Shipping Options" ], "summary": "Deletes an existing shipping option", "operationId": "eCommerceShippingOptionsController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent shipping option id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/shipping-options/countries": { "get": { "tags": [ "eCommerce Shipping Options" ], "summary": "Retrieves a list of countries", "operationId": "eCommerceShippingOptionsController_GetCountries", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.SeoCountryContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } } }, "/api/v2/admin/shipping-options/provider-services": { "get": { "tags": [ "eCommerce Shipping Options" ], "summary": "Retrieves a list of external shipping provider services", "operationId": "eCommerceShippingOptionsController_GetProviderServices", "parameters": [ { "name": "Type", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ShippingOptions.ShippingOptionTypePublicApi" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionProviderServiceContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } } }, "/api/v2/admin/shipping-options/provider-settings": { "get": { "tags": [ "eCommerce Shipping Options" ], "summary": "Retrieves a list of shipping provider settings", "operationId": "eCommerceShippingOptionsController_GetProviderSettingsTemplate", "parameters": [ { "name": "Type", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ShippingOptions.ShippingOptionTypePublicApi" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionProviderSettingsContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } } }, "/api/v2/admin/taxes": { "get": { "tags": [ "eCommerce Taxes" ], "summary": "Retrieves a list of taxes by using a \"where\" filtering", "operationId": "eCommerceTaxesController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract]" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "eCommerce Taxes" ], "summary": "Creates a new tax", "operationId": "eCommerceTaxesController_Post", "requestBody": { "description": "Tax model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/taxes/{id}": { "get": { "tags": [ "eCommerce Taxes" ], "summary": "Retrieves a single tax", "operationId": "eCommerceTaxesController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Tax id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "eCommerce Taxes" ], "summary": "Updates an existing tax", "operationId": "eCommerceTaxesController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent tax id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated tax model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "eCommerce Taxes" ], "summary": "Deletes an existing tax", "operationId": "eCommerceTaxesController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent tax id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/autoresponder": { "post": { "tags": [ "Email Sender" ], "summary": "Sends an autoresponder email notification", "operationId": "EmailSenderController_SendAutoresponderEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.CaseNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.CaseNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.CaseNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.CaseNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.CaseNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/case": { "post": { "tags": [ "Email Sender" ], "summary": "Sends a case email notifications", "operationId": "EmailSenderController_SendCaseNotificationEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.CaseNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.CaseNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.CaseNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.CaseNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.CaseNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/confirm-email": { "post": { "tags": [ "Email Sender" ], "summary": "Sends a confirm email notification", "operationId": "EmailSenderController_SendConfirmEmailNotificationEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/deferred-order-payment": { "post": { "tags": [ "Email Sender" ], "summary": "Sends a deferred order payment email notification", "operationId": "EmailSenderController_SendOfflineCreditCardPaymentEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/gift-voucher": { "post": { "tags": [ "Email Sender" ], "summary": "Sends a gift voucher email notification", "operationId": "EmailSenderController_SendGiftVoucherEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.GiftVoucherNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.GiftVoucherNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.GiftVoucherNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.GiftVoucherNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.GiftVoucherNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/invoice": { "post": { "tags": [ "Email Sender" ], "summary": "Sends an invoice email notification", "operationId": "EmailSenderController_SendInvoiceEcomEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/low-stock": { "post": { "tags": [ "Email Sender" ], "summary": "Sends a low stock email notification", "operationId": "EmailSenderController_SendLowStockNotificationEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/module-item": { "post": { "tags": [ "Email Sender" ], "summary": "Sends a module item email notifications", "operationId": "EmailSenderController_SendModuleItemNotificationEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.ModuleItemNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.ModuleItemNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.ModuleItemNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.ModuleItemNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.ModuleItemNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/password-retrieve-email": { "post": { "tags": [ "Email Sender" ], "summary": "Sends a password retrieve email notification", "operationId": "EmailSenderController_SendPasswordRetrieveEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/quote": { "post": { "tags": [ "Email Sender" ], "summary": "Sends a quote email notification", "operationId": "EmailSenderController_SendQuoteEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/restore-admin-user-password": { "post": { "tags": [ "Email Sender" ], "summary": "Sends a restore admin user password email notification", "operationId": "EmailSenderController_SendRestoreAdminUserPasswordEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/secure-zone-login-details": { "post": { "tags": [ "Email Sender" ], "summary": "Sends a secure zone login details email notification", "operationId": "EmailSenderController_SendSecureZoneLoginDetailsEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/supplier": { "post": { "tags": [ "Email Sender" ], "summary": "Sends a supplier email notification", "operationId": "EmailSenderController_SendSupplierNotificationEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-notification-sender/workflows": { "post": { "tags": [ "Email Sender" ], "summary": "Sends a workflow email notification", "operationId": "EmailSenderController_SendWorkflowNotificationEmail", "requestBody": { "description": "Notification request model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.WorkflowNotificationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.WorkflowNotificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.WorkflowNotificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.WorkflowNotificationRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailSender.WorkflowNotificationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-templates": { "get": { "tags": [ "Email Templates" ], "summary": "Retrieves a list of email templates by using a \"where\" filtering", "operationId": "EmailTemplatesController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateContract]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateContract]" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Email Templates" ], "summary": "Creates a new email template", "operationId": "EmailTemplatesController_Post", "requestBody": { "description": "Email template model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/email-templates/{id}": { "get": { "tags": [ "Email Templates" ], "summary": "Retrieves a single email template", "operationId": "EmailTemplatesController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Email template id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Email Templates" ], "summary": "Updates an existing email template", "operationId": "EmailTemplatesController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent email template id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated email template model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Email Templates" ], "summary": "Deletes an existing email template", "operationId": "EmailTemplatesController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent email template id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/emails": { "get": { "tags": [ "Emails" ], "summary": "Retrieves a list of emails by using a \"where\" filtering", "operationId": "EmailsController_GetAll", "parameters": [ { "name": "systemEvent", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailGroupType" } }, { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract]" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Emails" ], "summary": "Creates a new email", "operationId": "EmailsController_Post", "requestBody": { "description": "Email model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/emails/{id}": { "get": { "tags": [ "Emails" ], "summary": "Retrieves a single email", "operationId": "EmailsController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Email id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Emails" ], "summary": "Updates an existing email", "operationId": "EmailsController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent email id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated email model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailUpdateRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailUpdateRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailUpdateRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailUpdateRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailUpdateRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Emails" ], "summary": "Deletes an existing email", "operationId": "EmailsController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent email id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/emails/custom-email-groups": { "get": { "tags": [ "Emails" ], "summary": "Retrieves a list of email groups", "operationId": "EmailsController_GetCustomEmailGroups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailGroupContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailGroupContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailGroupContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/emails/variables": { "get": { "tags": [ "Emails" ], "summary": "Retrieves a list of variables", "operationId": "EmailsController_GetVariables", "parameters": [ { "name": "emailSection", "in": "query", "schema": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.Emails.Enums.EmailSection" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/file-system": { "get": { "tags": [ "File System" ], "summary": "Retrieves a single folder content", "operationId": "FileSystemController_Get", "parameters": [ { "name": "url", "in": "query", "schema": { "title": "DXP.System.String", "type": "string", "default": "/" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerContract" } } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "File System" ], "summary": "Creates a new file or folder", "operationId": "FileSystemController_Post", "requestBody": { "description": "Updated order model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerCreateContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerCreateContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerCreateContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerCreateContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerCreateContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerContract" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "File System" ], "summary": "Updates an existing file or folder", "operationId": "FileSystemController_Put", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerUpdateContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerUpdateContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerUpdateContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerUpdateContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerUpdateContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerContract" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "File System" ], "summary": "Deletes an existing file or folder", "operationId": "FileSystemController_Delete", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerDeleteContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerDeleteContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerDeleteContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerDeleteContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerDeleteContract" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/file-system/content": { "get": { "tags": [ "File System" ], "summary": "Retrieves a single file content", "operationId": "FileSystemController_GetContent", "parameters": [ { "name": "Url", "in": "query", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerContract" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/file-system/files-upload": { "post": { "tags": [ "File System" ], "summary": "Creates a new files upload", "description": "Files to upload, sent via form-data.

", "operationId": "FileSystemController_PostFile", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Interfaces.FileManager.IFileManagerResponseModel" } } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/file-system/secure-zone": { "put": { "tags": [ "File System" ], "summary": "Sets a list of secure zones to a file or folder", "operationId": "FileSystemController_Set", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileSecureZoneUpdateContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileSecureZoneUpdateContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileSecureZoneUpdateContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileSecureZoneUpdateContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileSecureZoneUpdateContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerContract" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/forms": { "get": { "tags": [ "Forms" ], "summary": "Retrieves a list of forms by using a \"where\" filtering", "operationId": "FormsController_GetList", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Forms.FormContract]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Forms" ], "summary": "Creates a new form", "operationId": "FormsController_Create", "requestBody": { "description": "Form model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormCreateContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormCreateContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormCreateContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormCreateContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormCreateContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/forms/{id}": { "get": { "tags": [ "Forms" ], "summary": "Retrieves a single form", "operationId": "FormsController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Form id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Forms" ], "summary": "Updates an existing form fields", "operationId": "FormsController_Update", "parameters": [ { "name": "id", "in": "path", "description": "Form id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Form model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormUpdateContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormUpdateContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormUpdateContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormUpdateContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormUpdateContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Forms" ], "summary": "Deletes an existing form", "operationId": "FormsController_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/forms/{id}/generate-template": { "post": { "tags": [ "Forms" ], "summary": "Generate form template", "operationId": "FormsController_GenerateTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.String", "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/forms/{id}/settings": { "get": { "tags": [ "Forms" ], "summary": "Retrieves a form settings", "operationId": "FormsController_GetFormSettings", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormSettingsContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Forms" ], "summary": "Update a form settings", "operationId": "FormsController_GetFormSettings_put", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormSettingsContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormSettingsContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormSettingsContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormSettingsContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormSettingsContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormSettingsContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/forms/{id}/template": { "get": { "tags": [ "Forms" ], "summary": "Retrieves a single form template", "operationId": "FormsController_GetTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.String", "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Forms" ], "summary": "Updates an existing form template", "operationId": "FormsController_SaveTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.Forms.Request.UpdateTemplateFormRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.Forms.Request.UpdateTemplateFormRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.Forms.Request.UpdateTemplateFormRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.Forms.Request.UpdateTemplateFormRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.Forms.Request.UpdateTemplateFormRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/forms/field-groups": { "get": { "tags": [ "Forms" ], "summary": "Retrieves a single forms field groups", "operationId": "FormsController_GetFieldGroups", "parameters": [ { "name": "formType", "in": "query", "schema": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentFormType" } }, { "name": "includeCustomProperties", "in": "query", "schema": { "title": "DXP.System.Boolean", "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.Forms.GroupFieldModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/forms/field-types": { "get": { "tags": [ "Forms" ], "summary": "Retrieves a single forms field types", "operationId": "FormsController_GetFieldTypes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/forms/recurring-types": { "get": { "tags": [ "Forms" ], "summary": "Retrieves a single forms recurring types", "operationId": "FormsController_GetRecurringTypes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.SecureZones.PaymentIntervalState" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/forms/types": { "get": { "tags": [ "Forms" ], "summary": "Retrieves a single forms types", "operationId": "FormsController_GetFormTypes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.Forms.EnumResponseModel`1[eCommerce.BusinessModel.PaymentFormType]" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/member-areas": { "get": { "tags": [ "Member Areas" ], "summary": "Retrieves a list of member areas by using a \"where\" filtering", "operationId": "MemberAreasController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Member Areas" ], "summary": "Creates a new member area", "operationId": "MemberAreasController_Post", "requestBody": { "description": "Member area model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/member-areas/{id}": { "get": { "tags": [ "Member Areas" ], "summary": "Retrieves a single member area", "operationId": "MemberAreasController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Member area id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Member Areas" ], "summary": "Updates an existing member area", "operationId": "MemberAreasController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent member area id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated member area model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Member Areas" ], "summary": "Deletes an existing member area", "operationId": "MemberAreasController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent member area id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/member-areas/{id}/add-members": { "post": { "tags": [ "Member Areas" ], "summary": "Creates a new member area members", "operationId": "MemberAreasController_AddMemberToSecureZone", "parameters": [ { "name": "id", "in": "path", "description": "Existent member area id.", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "requestBody": { "description": "Add member area members model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberAddContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberAddContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberAddContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberAddContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberAddContract" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/member-areas/{id}/content": { "get": { "tags": [ "Member Areas" ], "summary": "Retrieves a list of member area content", "operationId": "MemberAreasController_GetContent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "moduleId", "in": "query", "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "moduleAlias", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentListContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Member Areas" ], "summary": "Creates a new member area content", "operationId": "MemberAreasController_PostContents", "parameters": [ { "name": "id", "in": "path", "description": "Existent member area id.", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "requestBody": { "description": "Updated member area content model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Member Areas" ], "summary": "Deletes an existing member area content", "operationId": "MemberAreasController_RemoveContentFromSecureZone", "parameters": [ { "name": "id", "in": "path", "description": "Existent member area id.", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "requestBody": { "description": "Updated member area content model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentRequestContract" } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/member-areas/{id}/files": { "get": { "tags": [ "Member Areas" ], "summary": "Retrieves a list of member area files", "operationId": "MemberAreasController_GetSecureZoneSecureContents", "parameters": [ { "name": "id", "in": "path", "description": "Existent member area id.", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneSecureContentContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/member-areas/{id}/members": { "get": { "tags": [ "Member Areas" ], "summary": "Retrieves a list of member area members", "operationId": "MemberAreasController_GetPaginationMembers", "parameters": [ { "name": "id", "in": "path", "description": "Existent member area id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/member-areas/{id}/remove-members": { "delete": { "tags": [ "Member Areas" ], "summary": "Deletes an existing member area members", "operationId": "MemberAreasController_DeleteMembers", "parameters": [ { "name": "id", "in": "path", "description": "Existent member area id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Delete member area members model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberRequestContract" } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/member-areas/{id}/secure": { "put": { "tags": [ "Member Areas" ], "summary": "Updates an existing member area secure content", "operationId": "MemberAreasController_SecureContents", "parameters": [ { "name": "id", "in": "path", "description": "Existent member area id.", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentRequestContract" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentRequestContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentRequestContract" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentRequestContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentRequestContract" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IList`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentContract" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/member-areas/{id}/unsecure": { "put": { "tags": [ "Member Areas" ], "summary": "Updates an existing member area unsecure content", "operationId": "MemberAreasController_UnSecureContents", "parameters": [ { "name": "id", "in": "path", "description": "Existent member area id.", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentRequestContract" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentRequestContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentRequestContract" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentRequestContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentRequestContract" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IList`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentContract" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/member-areas/options": { "get": { "tags": [ "Member Areas" ], "summary": "Retrieves a single member areas options", "operationId": "MemberAreasController_Get_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.OptionsContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/menus": { "get": { "tags": [ "Menus" ], "summary": "Retrieves a list of menus by using a \"where\" filtering", "operationId": "MenusController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Menus.MenuContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Menus" ], "summary": "Creates a new menu", "operationId": "MenusController_Post", "requestBody": { "description": "Menu model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.MenuRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.MenuRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.MenuRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.MenuRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.MenuRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "title": "DXP.OpenAPI.v2.Contracts.Menus.MenuContract", "type": "object", "properties": { "Id": { "type": "integer", "example": 1, "description": "Unique identifier assigned by the platform.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Name": { "type": "string", "example": "string", "description": "Human-readable name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Alias": { "type": "string", "example": "string", "description": "Machine-readable alias.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "LiquidAlias": { "type": "string", "example": "string", "description": "Technical alias — a machine-readable key used in Liquid templates.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "MenuItemsJson": { "type": "array", "items": { "type": "object", "properties": { "ItemId": { "type": "string", "example": "string", "description": "Identifier of the related item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ItemName": { "type": "string", "example": "string", "description": "Text label shown for the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemUrl": { "type": "string", "example": "string", "description": "The URL the menu item links to.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTargetFrame": { "type": "string", "example": "string", "description": "Target frame or window for the link (e.g. _blank opens a new tab).", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemClass": { "type": "string", "example": "string", "description": "CSS class applied to the menu item for styling.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTitle": { "type": "string", "example": "string", "description": "Title (tooltip) text shown when hovering the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemCustomAttribute": { "type": "string", "example": "string", "description": "Custom HTML attribute added to the menu item element.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemEnabled": { "type": "boolean", "example": true, "description": "Whether the menu item is visible in the rendered menu.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ReleaseDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item becomes publicly available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ExpiryDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item expires and is no longer available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "children": { "type": "array", "items": { "type": "object" }, "description": "An array of child elements. Used to create drop-down lists or multi-level menu structures.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } } }, "example": [ { "ItemId": "string", "ItemName": "string", "ItemUrl": "string", "ItemTargetFrame": "string", "ItemClass": "string", "ItemTitle": "string", "ItemCustomAttribute": "string", "ItemEnabled": true, "ReleaseDate": "2025-03-25T09:23:00Z", "ExpiryDate": "2025-03-25T09:23:00Z", "children": [] } ], "description": "Menu items stored as a JSON structure.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/menus/{id}": { "get": { "tags": [ "Menus" ], "summary": "Retrieves a single menu", "operationId": "MenusController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Menu id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.OpenAPI.v2.Contracts.Menus.MenuContract", "type": "object", "properties": { "Id": { "type": "integer", "example": 1, "description": "Unique identifier assigned by the platform.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Name": { "type": "string", "example": "string", "description": "Human-readable name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Alias": { "type": "string", "example": "string", "description": "Machine-readable alias.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "LiquidAlias": { "type": "string", "example": "string", "description": "Technical alias — a machine-readable key used in Liquid templates.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "MenuItemsJson": { "type": "array", "items": { "type": "object", "properties": { "ItemId": { "type": "string", "example": "string", "description": "Identifier of the related item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ItemName": { "type": "string", "example": "string", "description": "Text label shown for the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemUrl": { "type": "string", "example": "string", "description": "The URL the menu item links to.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTargetFrame": { "type": "string", "example": "string", "description": "Target frame or window for the link (e.g. _blank opens a new tab).", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemClass": { "type": "string", "example": "string", "description": "CSS class applied to the menu item for styling.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTitle": { "type": "string", "example": "string", "description": "Title (tooltip) text shown when hovering the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemCustomAttribute": { "type": "string", "example": "string", "description": "Custom HTML attribute added to the menu item element.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemEnabled": { "type": "boolean", "example": true, "description": "Whether the menu item is visible in the rendered menu.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ReleaseDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item becomes publicly available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ExpiryDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item expires and is no longer available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "children": { "type": "array", "items": { "type": "object" }, "description": "An array of child elements. Used to create drop-down lists or multi-level menu structures.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } } }, "example": [ { "ItemId": "string", "ItemName": "string", "ItemUrl": "string", "ItemTargetFrame": "string", "ItemClass": "string", "ItemTitle": "string", "ItemCustomAttribute": "string", "ItemEnabled": true, "ReleaseDate": "2025-03-25T09:23:00Z", "ExpiryDate": "2025-03-25T09:23:00Z", "children": [] } ], "description": "Menu items stored as a JSON structure.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Menus" ], "summary": "Updates an existing menu", "operationId": "MenusController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent menu id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated menu model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.MenuRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.MenuRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.MenuRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.MenuRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.MenuRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.OpenAPI.v2.Contracts.Menus.MenuContract", "type": "object", "properties": { "Id": { "type": "integer", "example": 1, "description": "Unique identifier assigned by the platform.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Name": { "type": "string", "example": "string", "description": "Human-readable name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Alias": { "type": "string", "example": "string", "description": "Machine-readable alias.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "LiquidAlias": { "type": "string", "example": "string", "description": "Technical alias — a machine-readable key used in Liquid templates.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "MenuItemsJson": { "type": "array", "items": { "type": "object", "properties": { "ItemId": { "type": "string", "example": "string", "description": "Identifier of the related item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ItemName": { "type": "string", "example": "string", "description": "Text label shown for the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemUrl": { "type": "string", "example": "string", "description": "The URL the menu item links to.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTargetFrame": { "type": "string", "example": "string", "description": "Target frame or window for the link (e.g. _blank opens a new tab).", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemClass": { "type": "string", "example": "string", "description": "CSS class applied to the menu item for styling.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTitle": { "type": "string", "example": "string", "description": "Title (tooltip) text shown when hovering the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemCustomAttribute": { "type": "string", "example": "string", "description": "Custom HTML attribute added to the menu item element.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemEnabled": { "type": "boolean", "example": true, "description": "Whether the menu item is visible in the rendered menu.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ReleaseDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item becomes publicly available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ExpiryDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item expires and is no longer available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "children": { "type": "array", "items": { "type": "object" }, "description": "An array of child elements. Used to create drop-down lists or multi-level menu structures.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } } }, "example": [ { "ItemId": "string", "ItemName": "string", "ItemUrl": "string", "ItemTargetFrame": "string", "ItemClass": "string", "ItemTitle": "string", "ItemCustomAttribute": "string", "ItemEnabled": true, "ReleaseDate": "2025-03-25T09:23:00Z", "ExpiryDate": "2025-03-25T09:23:00Z", "children": [] } ], "description": "Menu items stored as a JSON structure.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Menus" ], "summary": "Deletes an existing menu", "operationId": "MenusController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent menu id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/menus/{id}/items": { "get": { "tags": [ "Menus" ], "summary": "Retrieves a menu items", "operationId": "MenusController_GetItems", "parameters": [ { "name": "id", "in": "path", "description": "Menu id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.OpenAPI.v2.Contracts.Menus.MenuItemsContract", "type": "object", "properties": { "MenuItemsJson": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "example": 1, "description": "Unique identifier assigned by the platform.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ItemId": { "type": "string", "example": "string", "description": "Identifier of the related item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ItemName": { "type": "string", "example": "string", "description": "Text label shown for the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemUrl": { "type": "string", "example": "string", "description": "The URL the menu item links to.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTargetFrame": { "type": "string", "example": "string", "description": "Target frame or window for the link (e.g. _blank opens a new tab).", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemClass": { "type": "string", "example": "string", "description": "CSS class applied to the menu item for styling.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTitle": { "type": "string", "example": "string", "description": "Title (tooltip) text shown when hovering the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemCustomAttribute": { "type": "string", "example": "string", "description": "Custom HTML attribute added to the menu item element.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemEnabled": { "type": "boolean", "example": true, "description": "Whether the menu item is visible in the rendered menu.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ReleaseDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item becomes publicly available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ExpiryDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item expires and is no longer available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "children": { "type": "array", "items": { "type": "object" }, "description": "An array of child elements. Used to create drop-down lists or multi-level menu structures.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } } }, "example": [ { "Id": 1, "ItemId": "string", "ItemName": "string", "ItemUrl": "string", "ItemTargetFrame": "string", "ItemClass": "string", "ItemTitle": "string", "ItemCustomAttribute": "string", "ItemEnabled": true, "ReleaseDate": "2025-03-25T09:23:00Z", "ExpiryDate": "2025-03-25T09:23:00Z", "children": [] } ], "description": "Menu items stored as a JSON structure.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Menus" ], "summary": "Updates an existing menu", "operationId": "MenusController_PutItems", "parameters": [ { "name": "id", "in": "path", "description": "Existent menu id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated menu items model.", "content": { "application/json-patch+json": { "schema": { "title": "DXP.OpenAPI.v2.Contracts.Menus.MenuItemsRequestContract", "type": "object", "properties": { "MenuItemsJson": { "type": "array", "items": { "type": "object", "properties": { "ItemId": { "type": "string", "example": "string" }, "ItemName": { "type": "string", "example": "string" }, "ItemUrl": { "type": "string", "example": "string" }, "ItemTargetFrame": { "type": "string", "example": "string" }, "ItemClass": { "type": "string", "example": "string" }, "ItemTitle": { "type": "string", "example": "string" }, "ItemCustomAttribute": { "type": "string", "example": "string" }, "ItemEnabled": { "type": "boolean", "example": true }, "ReleaseDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z" }, "ExpiryDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z" }, "children": { "type": "array", "items": { "type": "object" } } } }, "example": [ { "ItemId": "string", "ItemName": "string", "ItemUrl": "string", "ItemTargetFrame": "string", "ItemClass": "string", "ItemTitle": "string", "ItemCustomAttribute": "string", "ItemEnabled": true, "ReleaseDate": "2025-03-25T09:23:00Z", "ExpiryDate": "2025-03-25T09:23:00Z", "children": [] } ] } } } }, "application/json": { "schema": { "title": "DXP.OpenAPI.v2.Contracts.Menus.MenuItemsRequestContract", "type": "object", "properties": { "MenuItemsJson": { "type": "array", "items": { "type": "object", "properties": { "ItemId": { "type": "string", "example": "string", "description": "Identifier of the related item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ItemName": { "type": "string", "example": "string", "description": "Text label shown for the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemUrl": { "type": "string", "example": "string", "description": "The URL the menu item links to.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTargetFrame": { "type": "string", "example": "string", "description": "Target frame or window for the link (e.g. _blank opens a new tab).", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemClass": { "type": "string", "example": "string", "description": "CSS class applied to the menu item for styling.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTitle": { "type": "string", "example": "string", "description": "Title (tooltip) text shown when hovering the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemCustomAttribute": { "type": "string", "example": "string", "description": "Custom HTML attribute added to the menu item element.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemEnabled": { "type": "boolean", "example": true, "description": "Whether the menu item is visible in the rendered menu.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ReleaseDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item becomes publicly available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ExpiryDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item expires and is no longer available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "children": { "type": "array", "items": { "type": "object" }, "description": "An array of child elements. Used to create drop-down lists or multi-level menu structures.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } } }, "example": [ { "ItemId": "string", "ItemName": "string", "ItemUrl": "string", "ItemTargetFrame": "string", "ItemClass": "string", "ItemTitle": "string", "ItemCustomAttribute": "string", "ItemEnabled": true, "ReleaseDate": "2025-03-25T09:23:00Z", "ExpiryDate": "2025-03-25T09:23:00Z", "children": [] } ], "description": "Menu items stored as a JSON structure.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } } } }, "text/json": { "schema": { "title": "DXP.OpenAPI.v2.Contracts.Menus.MenuItemsRequestContract", "type": "object", "properties": { "MenuItemsJson": { "type": "array", "items": { "type": "object", "properties": { "ItemId": { "type": "string", "example": "string" }, "ItemName": { "type": "string", "example": "string" }, "ItemUrl": { "type": "string", "example": "string" }, "ItemTargetFrame": { "type": "string", "example": "string" }, "ItemClass": { "type": "string", "example": "string" }, "ItemTitle": { "type": "string", "example": "string" }, "ItemCustomAttribute": { "type": "string", "example": "string" }, "ItemEnabled": { "type": "boolean", "example": true }, "ReleaseDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z" }, "ExpiryDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z" }, "children": { "type": "array", "items": { "type": "object" } } } }, "example": [ { "ItemId": "string", "ItemName": "string", "ItemUrl": "string", "ItemTargetFrame": "string", "ItemClass": "string", "ItemTitle": "string", "ItemCustomAttribute": "string", "ItemEnabled": true, "ReleaseDate": "2025-03-25T09:23:00Z", "ExpiryDate": "2025-03-25T09:23:00Z", "children": [] } ] } } } }, "application/*+json": { "schema": { "title": "DXP.OpenAPI.v2.Contracts.Menus.MenuItemsRequestContract", "type": "object", "properties": { "MenuItemsJson": { "type": "array", "items": { "type": "object", "properties": { "ItemId": { "type": "string", "example": "string" }, "ItemName": { "type": "string", "example": "string" }, "ItemUrl": { "type": "string", "example": "string" }, "ItemTargetFrame": { "type": "string", "example": "string" }, "ItemClass": { "type": "string", "example": "string" }, "ItemTitle": { "type": "string", "example": "string" }, "ItemCustomAttribute": { "type": "string", "example": "string" }, "ItemEnabled": { "type": "boolean", "example": true }, "ReleaseDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z" }, "ExpiryDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z" }, "children": { "type": "array", "items": { "type": "object" } } } }, "example": [ { "ItemId": "string", "ItemName": "string", "ItemUrl": "string", "ItemTargetFrame": "string", "ItemClass": "string", "ItemTitle": "string", "ItemCustomAttribute": "string", "ItemEnabled": true, "ReleaseDate": "2025-03-25T09:23:00Z", "ExpiryDate": "2025-03-25T09:23:00Z", "children": [] } ] } } } }, "text/plain": { "schema": { "title": "DXP.OpenAPI.v2.Contracts.Menus.MenuItemsRequestContract", "type": "object", "properties": { "MenuItemsJson": { "type": "array", "items": { "type": "object", "properties": { "ItemId": { "type": "string", "example": "string" }, "ItemName": { "type": "string", "example": "string" }, "ItemUrl": { "type": "string", "example": "string" }, "ItemTargetFrame": { "type": "string", "example": "string" }, "ItemClass": { "type": "string", "example": "string" }, "ItemTitle": { "type": "string", "example": "string" }, "ItemCustomAttribute": { "type": "string", "example": "string" }, "ItemEnabled": { "type": "boolean", "example": true }, "ReleaseDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z" }, "ExpiryDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z" }, "children": { "type": "array", "items": { "type": "object" } } } }, "example": [ { "ItemId": "string", "ItemName": "string", "ItemUrl": "string", "ItemTargetFrame": "string", "ItemClass": "string", "ItemTitle": "string", "ItemCustomAttribute": "string", "ItemEnabled": true, "ReleaseDate": "2025-03-25T09:23:00Z", "ExpiryDate": "2025-03-25T09:23:00Z", "children": [] } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.OpenAPI.v2.Contracts.Menus.MenuContract", "type": "object", "properties": { "Id": { "type": "integer", "example": 1, "description": "Unique identifier assigned by the platform.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Name": { "type": "string", "example": "string", "description": "Human-readable name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Alias": { "type": "string", "example": "string", "description": "Machine-readable alias.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "LiquidAlias": { "type": "string", "example": "string", "description": "Technical alias — a machine-readable key used in Liquid templates.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "MenuItemsJson": { "type": "array", "items": { "type": "object", "properties": { "ItemId": { "type": "string", "example": "string", "description": "Identifier of the related item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ItemName": { "type": "string", "example": "string", "description": "Text label shown for the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemUrl": { "type": "string", "example": "string", "description": "The URL the menu item links to.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTargetFrame": { "type": "string", "example": "string", "description": "Target frame or window for the link (e.g. _blank opens a new tab).", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemClass": { "type": "string", "example": "string", "description": "CSS class applied to the menu item for styling.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTitle": { "type": "string", "example": "string", "description": "Title (tooltip) text shown when hovering the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemCustomAttribute": { "type": "string", "example": "string", "description": "Custom HTML attribute added to the menu item element.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemEnabled": { "type": "boolean", "example": true, "description": "Whether the menu item is visible in the rendered menu.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ReleaseDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item becomes publicly available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ExpiryDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item expires and is no longer available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "children": { "type": "array", "items": { "type": "object" }, "description": "An array of child elements. Used to create drop-down lists or multi-level menu structures.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } } }, "example": [ { "ItemId": "string", "ItemName": "string", "ItemUrl": "string", "ItemTargetFrame": "string", "ItemClass": "string", "ItemTitle": "string", "ItemCustomAttribute": "string", "ItemEnabled": true, "ReleaseDate": "2025-03-25T09:23:00Z", "ExpiryDate": "2025-03-25T09:23:00Z", "children": [] } ], "description": "Menu items stored as a JSON structure.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/menus/{id}/layout-groups": { "get": { "tags": [ "Menus" ], "summary": "Retrieves a single menu layout item", "operationId": "MenusController_GetLayoutGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Menus" ], "summary": "Creates a new menu", "operationId": "MenusController_CreateMenuLayoutGroup", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Menu layout model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Menus" ], "summary": "Updates an existing menu", "operationId": "MenusController_RenameMenuLayoutGroup", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.UpdateLayoutGroupContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.UpdateLayoutGroupContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.UpdateLayoutGroupContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.UpdateLayoutGroupContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.UpdateLayoutGroupContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Menus" ], "summary": "Deletes an existing menu", "operationId": "MenusController_DeleteMenuLayoutGroup", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "layoutGroup", "in": "query", "description": "", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/menus/{id}/layout-groups/item": { "get": { "tags": [ "Menus" ], "summary": "Retrieves a single menu", "operationId": "MenusController_GetLayoutItem", "parameters": [ { "name": "id", "in": "path", "description": "Menu id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "ItemName", "in": "query", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "LayoutGroup", "in": "query", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupItemContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Menus" ], "summary": "Updates an existing menu layout item", "operationId": "MenusController_PutLayoutItem", "parameters": [ { "name": "id", "in": "path", "description": "Existent menu id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated menu layout item model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupItemContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupItemContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupItemContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupItemContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupItemContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupItemContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/menus/{id}/layout-groups/items": { "get": { "tags": [ "Menus" ], "summary": "Retrieves a single menu layout item", "operationId": "MenusController_GetLayoutGroupItemsName", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "layoutGroup", "in": "query", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/mobile-auth/ios/is-registered": { "post": { "tags": [ "Mobile Auth" ], "operationId": "MobileAuthController_IsDeviceRegistered", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.MobileAuth.IsDeviceRefisteredRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.MobileAuth.IsDeviceRefisteredRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.MobileAuth.IsDeviceRefisteredRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.MobileAuth.IsDeviceRefisteredRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.MobileAuth.IsDeviceRefisteredRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v2/admin/mobile-auth/ios/register-key": { "post": { "tags": [ "Mobile Auth" ], "summary": "Register iOS device public key", "description": "Registers a public key for iOS device authentication using Apple App Attest", "operationId": "MobileAuthController_RegisterIosKey", "parameters": [ { "name": "X-Apple-AppAttest-Attestation", "in": "header", "description": "Base64-encoded attestation object from Apple App Attest", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "X-Apple-AppAttest-KeyId", "in": "header", "description": "Key identifier from Apple App Attest", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "X-Request-Nonce", "in": "header", "description": "Nonce obtained from /nonce endpoint", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "X-Client-Id", "in": "header", "description": "OAuth2 client identifier for the mobile application", "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v2/admin/mobile-auth/nonce": { "get": { "tags": [ "Mobile Auth" ], "operationId": "MobileAuthController_GetNonce", "parameters": [ { "name": "clientId", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v2/admin/module-items/attributes/{attributeId}/options": { "post": { "tags": [ "Module Item Attribute Options" ], "summary": "Creates a new module item attribute option", "operationId": "ModuleItemAttributeOptionsController_Post", "parameters": [ { "name": "attributeId", "in": "path", "description": "Existent module item attribute id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Module item attribute option model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/attributes/{id}/attributes-options-order": { "put": { "tags": [ "Module Item Attribute Options" ], "summary": " Changes existing module item attribute options sort order", "operationId": "ModuleItemAttributeOptionsController_AttributeOptionWeight", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/attributes/options/{id}": { "put": { "tags": [ "Module Item Attribute Options" ], "summary": "Updates an existing module item attribute option", "operationId": "ModuleItemAttributeOptionsController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent module item attribute option id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated module item attribute option model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Module Item Attribute Options" ], "summary": "Deletes an existing module item attribute option", "operationId": "ModuleItemAttributeOptionsController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent module item attribute option id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/{id}/attributes-order": { "put": { "tags": [ "Module Item Attributes" ], "summary": " Changes existing module item attributes sort order", "operationId": "ModuleItemAttributesController_ProductAttributeWeight", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/{moduleItemId}/attributes": { "get": { "tags": [ "Module Item Attributes" ], "summary": "Retrieves a list of module item attributes by using a \"where\" filtering", "operationId": "ModuleItemAttributesController_GetAll", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Module Item Attributes" ], "summary": "Creates a new module item attribute", "operationId": "ModuleItemAttributesController_Post", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Module item attribute model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/attributes/{id}": { "get": { "tags": [ "Module Item Attributes" ], "summary": "Retrieves a single module item attribute", "operationId": "ModuleItemAttributesController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Module item attribute id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Module Item Attributes" ], "summary": "Updates an existing module item attribute", "operationId": "ModuleItemAttributesController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent module item attribute id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated module item attribute model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Module Item Attributes" ], "summary": "Deletes an existing module item attribute", "operationId": "ModuleItemAttributesController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent module item attribute id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/draft/{id}": { "get": { "tags": [ "Module Item Draft" ], "summary": "Retrieves a module item draft", "operationId": "ModuleItemDraftController_GetDraft", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemDraftContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Module Item Draft" ], "summary": "Updates an existing module item draft", "operationId": "ModuleItemDraftController_UpdateDraft", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemDraftContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Module Item Draft" ], "summary": "Deletes an existing module item draft", "operationId": "ModuleItemDraftController_DeleteDraft", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } } }, "/api/v2/admin/module-items/publish-draft/{id}": { "put": { "tags": [ "Module Item Draft" ], "summary": "Publish a module item draft", "operationId": "ModuleItemDraftController_PublishDraft", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemDraftContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/seo/draft/{id}": { "get": { "tags": [ "Module Item Draft" ], "summary": "Retrieve a module item SEO draft", "operationId": "ModuleItemDraftController_GetSeoDraft", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Module Item Draft" ], "summary": "Update a module item SEO draft", "operationId": "ModuleItemDraftController_UpdateSeoDraft", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Module Item Draft" ], "summary": "Delete a module item SEO draft", "operationId": "ModuleItemDraftController_DeleteSeoDraft", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/seo/publish-draft/{id}": { "put": { "tags": [ "Module Item Draft" ], "summary": "Publish a module item SEO draft", "operationId": "ModuleItemDraftController_PublishSeoDraft", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/{moduleItemId}/discard-variations": { "delete": { "tags": [ "Module Item Inventory" ], "summary": "Discards existing module item inventory variations", "operationId": "ModuleItemInventoryController_Discard", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/{moduleItemId}/generate-variations": { "put": { "tags": [ "Module Item Inventory" ], "summary": "Generates module item inventory variations", "operationId": "ModuleItemInventoryController_Generate", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.ModuleItemInventoryContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/{moduleItemId}/inventory": { "get": { "tags": [ "Module Item Inventory" ], "summary": "Retrieves a module item inventory", "operationId": "ModuleItemInventoryController_Get", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.ModuleItemInventoryContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Module Item Inventory" ], "summary": "Updates an existing module item inventory", "operationId": "ModuleItemInventoryController_Update", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Module item inventory model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.ModuleItemInventoryRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.ModuleItemInventoryRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.ModuleItemInventoryRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.ModuleItemInventoryRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.ModuleItemInventoryRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.ModuleItemInventoryContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/{moduleItemId}/prices": { "get": { "tags": [ "Module Item Prices" ], "summary": "Retrieves a list of module item prices", "operationId": "ModuleItemPricesController_GetPrices", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemPriceContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Module Item Prices" ], "summary": "Creates a new module item price group", "operationId": "ModuleItemPricesController_Post", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.CreateModuleItemPriceContract" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.CreateModuleItemPriceContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.CreateModuleItemPriceContract" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.CreateModuleItemPriceContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.CreateModuleItemPriceContract" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemPriceContract]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Module Item Prices" ], "summary": "Updates an existing module item price group", "operationId": "ModuleItemPricesController_Put", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.UpdateModuleItemPriceContract" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.UpdateModuleItemPriceContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.UpdateModuleItemPriceContract" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.UpdateModuleItemPriceContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.UpdateModuleItemPriceContract" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemPriceContract]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/prices": { "delete": { "tags": [ "Module Item Prices" ], "summary": "Deletes an existing module item price group", "operationId": "ModuleItemPricesController_Delete", "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/prices/{id}": { "get": { "tags": [ "Module Item Prices" ], "summary": "Retrieves a single module item price", "operationId": "ModuleItemPricesController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Module item price id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemPriceContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/{moduleItemId}/grouped-items": { "get": { "tags": [ "Module Item's Grouped Items" ], "summary": "Retrieves a list of module item's grouped items", "operationId": "ModuleItem'sGroupedItemsController_Get", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Module Item's Grouped Items" ], "summary": "Creates a new module item's grouped item", "operationId": "ModuleItem'sGroupedItemsController_Add", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } }, "put": { "tags": [ "Module Item's Grouped Items" ], "summary": "Updates an existing module item's grouped item", "operationId": "ModuleItem'sGroupedItemsController_Update", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } } }, "/api/v2/admin/module-items/{moduleItemId}/grouped-items/{groupProductId}": { "delete": { "tags": [ "Module Item's Grouped Items" ], "summary": "Deletes an existing module item's grouped item", "operationId": "ModuleItem'sGroupedItemsController_Delete", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "groupProductId", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/{id}/parent-items": { "get": { "tags": [ "Module Item's Parent Items" ], "summary": "Retrieves a list of module item's parent items", "operationId": "ModuleItem'sParentItemsController_GetParents", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemParentContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Module Item's Parent Items" ], "summary": "Updates an existing module item's parent item", "operationId": "ModuleItem'sParentItemsController_UpdateParents", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemParentContract" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemParentContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemParentContract" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemParentContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemParentContract" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemParentContract]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/{moduleItemId}/related-items": { "get": { "tags": [ "Module Item's Related Items" ], "summary": "Retrieves a list of module item's related items", "operationId": "ModuleItem'sRelatedItemsController_Get", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItemRelatedItem.ModuleItemRelatedItemContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Module Item's Related Items" ], "summary": "Updates an existing module item's related items", "operationId": "ModuleItem'sRelatedItemsController_Update", "parameters": [ { "name": "moduleItemId", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemRelatedItem.UpdateModuleItemRelatedItemContract" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemRelatedItem.UpdateModuleItemRelatedItemContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemRelatedItem.UpdateModuleItemRelatedItemContract" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemRelatedItem.UpdateModuleItemRelatedItemContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemRelatedItem.UpdateModuleItemRelatedItemContract" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemRelatedItem.ModuleItemRelatedItemContract" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } } }, "/api/v2/admin/module-items": { "post": { "tags": [ "Module Items" ], "summary": "Creates a new module item", "operationId": "ModuleItemsController_Create", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestCreateModels" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestCreateModels" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestCreateModels" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestCreateModels" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestCreateModels" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/{id}": { "get": { "tags": [ "Module Items" ], "summary": "Retrieves a single module item", "operationId": "ModuleItemsController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Module item id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Module Items" ], "summary": "Updates an existing module item", "operationId": "ModuleItemsController_Update", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Module Items" ], "summary": "Deletes an existing module item", "operationId": "ModuleItemsController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } } }, "/api/v2/admin/module-items/{id}/seo": { "get": { "tags": [ "Module Items" ], "summary": "Retrieves a module item seo data", "operationId": "ModuleItemsController_GetSeo", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Module Items" ], "summary": "Updates an existing module item seo data", "operationId": "ModuleItemsController_UpdateSeo", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/{id}/set-homepage": { "post": { "tags": [ "Module Items" ], "summary": "Creates a new module item set home page", "operationId": "ModuleItemsController_SetHomepage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-items/{moduleId}/list": { "get": { "tags": [ "Module Items" ], "summary": "Retrieves a list of module items by using a \"where\" filtering", "operationId": "ModuleItemsController_GetList", "parameters": [ { "name": "moduleId", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } } }, "/api/v2/admin/module-layouts/{id}": { "get": { "tags": [ "Module Layouts" ], "summary": "Retrieves a single module layout", "operationId": "ModuleLayoutsController_Get", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleLayoutContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Module Layouts" ], "summary": "Updates an existing module layout", "operationId": "ModuleLayoutsController_Update", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.RequestModuleLayoutContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.RequestModuleLayoutContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.RequestModuleLayoutContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.RequestModuleLayoutContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.RequestModuleLayoutContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleLayoutContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } }, "delete": { "tags": [ "Module Layouts" ], "summary": "Deletes an existing module layout", "operationId": "ModuleLayoutsController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/module-layouts/{moduleId}": { "post": { "tags": [ "Module Layouts" ], "summary": "Creates a new module layout", "operationId": "ModuleLayoutsController_Create", "parameters": [ { "name": "moduleId", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.RequestModuleLayoutContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.RequestModuleLayoutContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.RequestModuleLayoutContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.RequestModuleLayoutContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.RequestModuleLayoutContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleLayoutContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } } }, "/api/v2/admin/module-layouts/{moduleId}/list": { "get": { "tags": [ "Module Layouts" ], "summary": "Retrieves a list of module layouts by using a \"where\" filtering", "operationId": "ModuleLayoutsController_GetList", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "moduleId", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleLayoutContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/modules/{id}/properties": { "get": { "tags": [ "Module Properties" ], "summary": "Retrieves a list of module properties", "operationId": "ModulePropertiesController_GetAll", "parameters": [ { "name": "id", "in": "path", "description": "Module properties id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertiesContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertiesContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertiesContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Module Properties" ], "summary": "Creates a new module property", "operationId": "ModulePropertiesController_Create", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyCreateRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyCreateRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyCreateRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyCreateRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyCreateRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyResponseContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyResponseContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyResponseContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } }, "put": { "tags": [ "Module Properties" ], "summary": "Updates an existing module property", "operationId": "ModulePropertiesController_UpdateProperties", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyResponseContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyResponseContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyResponseContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } } }, "/api/v2/admin/modules/{id}/properties-order": { "put": { "tags": [ "Module Properties" ], "summary": " Changes properties sort order", "operationId": "ModulePropertiesController_PropertiesOrder", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertiesContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertiesContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertiesContract" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } } }, "/api/v2/admin/modules/{id}/properties/{alias}": { "delete": { "tags": [ "Module Properties" ], "summary": "Deletes an existing module properties", "operationId": "ModulePropertiesController_DeleteProperty", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "alias", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/modules/{id}/property-settings": { "get": { "tags": [ "Module Properties" ], "summary": "Retrieves a module property settings", "operationId": "ModulePropertiesController_GetDefaults", "parameters": [ { "name": "id", "in": "path", "description": "Module properties defaults id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Module Properties" ], "summary": "Updates an existing module property settings", "operationId": "ModulePropertiesController_UpdatePropertySettings", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" } } } }, "/api/v2/admin/modules": { "get": { "tags": [ "Modules" ], "summary": "Retrieves a list of modules by using a \"where\" filtering", "operationId": "ModulesController_GetList", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Modules" ], "summary": "Creates a new module", "operationId": "ModulesController_Post", "requestBody": { "description": "Module model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateModuleContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateModuleContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateModuleContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateModuleContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CreateModuleContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/modules/{id}": { "get": { "tags": [ "Modules" ], "summary": "Retrieves a single module", "operationId": "ModulesController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Module id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Modules" ], "summary": "Updates an existing module", "operationId": "ModulesController_Put", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Edit Module model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditModuleContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditModuleContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditModuleContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditModuleContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EditModuleContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Modules" ], "summary": "Deletes an existing module", "operationId": "ModulesController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Module id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/modules/{id}/category-list": { "get": { "tags": [ "Modules" ], "summary": "Retrieves a module category list", "operationId": "ModulesController_GetModuleCategoryList", "parameters": [ { "name": "id", "in": "path", "description": "Module id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "query", "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleCategoryDataContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/payment-gateways": { "get": { "tags": [ "Payment Gateway Settings" ], "summary": "Retrieves a payment gateways", "operationId": "PaymentGatewaySettingsController_Get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewayToCurrencyCountryContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Payment Gateway Settings" ], "summary": "Updates an existing payment gateway settings", "operationId": "PaymentGatewaySettingsController_UpdatePaymentGatewaySettings", "requestBody": { "description": "Updated order status model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/payment-gateways/{paymentGatewayId}": { "delete": { "tags": [ "Payment Gateway Settings" ], "summary": "Deletes an existing payment gateway settings", "operationId": "PaymentGatewaySettingsController_Delete", "parameters": [ { "name": "paymentGatewayId", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/payment-gateways/flow": { "put": { "tags": [ "Payment Gateway Settings" ], "summary": "Updates an existing payment flow settings", "operationId": "PaymentGatewaySettingsController_UpdatePaymentFlowSettings", "requestBody": { "description": "Updated order status model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/payment-gateways/flow/{paymentFlowSettingsId}": { "delete": { "tags": [ "Payment Gateway Settings" ], "summary": "Deletes an existing payment flow settings", "operationId": "PaymentGatewaySettingsController_DeleteFlow", "parameters": [ { "name": "paymentFlowSettingsId", "in": "path", "description": "", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/payment-gateways/payment-providers-settings": { "get": { "tags": [ "Payment Gateway Settings" ], "summary": "Retrieves a payment gateway settings", "operationId": "PaymentGatewaySettingsController_GetAll", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentProvidersSettingsContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/print/{orderId}/{type}": { "get": { "tags": [ "Print" ], "summary": "Retrieves a print version of the order asset by type", "operationId": "PrintController_GetHtml", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.Print.PrintFileType" } } ], "responses": { "200": { "description": "\n \n\n \n Invoice\n \n \n \n \n\n \n
\n
\n \"logo\"\n
\n
\n

Bill To:
\n Test User
\n test@example.com\n

\n

Order Name: Invoice Example
\n Date: April 09, 2024 at 02.58 PM\n

\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ProductPriceQuantityTotal
Example Product$5.001$5.00
\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Subtotal:$5.00
Shipping:$0.00
Discount:$0.00
Tax:$0.00
Order Total$5.00
\n
\n
\n

Copyright © 2024 MAX. All rights reserved.

\n
\n
\n \n\n ", "content": { "text/html": { "schema": { "title": "DXP.System.String", "type": "string" } }, "application/json": { "schema": { "title": "DXP.System.String", "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "text/html": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/html": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/server-monitoring": { "get": { "tags": [ "Server Monitoring" ], "summary": "Retrieves a single server monitoring", "operationId": "ServerMonitoringController_GetServersInfo", "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/server-monitoring/slots": { "get": { "tags": [ "Server Monitoring" ], "summary": "Retrieves a list of server monitoring slots", "operationId": "ServerMonitoringController_GetSlots", "parameters": [ { "name": "InstanceId", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "PeriodStart", "in": "query", "schema": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time" } }, { "name": "PeriodEnd", "in": "query", "schema": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/site-globals": { "get": { "tags": [ "Site Globals" ], "summary": "Retrieves a list of site global property groups by using a \"where\" filtering", "operationId": "SiteGlobalsController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Site Globals" ], "summary": "Creates a new site global property group", "operationId": "SiteGlobalsController_Create", "requestBody": { "description": "Site global property group model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyGroupRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyGroupRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyGroupRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyGroupRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyGroupRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Site Globals" ], "summary": "Deletes an existing site global property group", "operationId": "SiteGlobalsController_Delete", "requestBody": { "description": "Existent site global property group ids.", "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/site-globals/{group_id}": { "put": { "tags": [ "Site Globals" ], "summary": "Updates an existing site global property group", "operationId": "SiteGlobalsController_Update", "parameters": [ { "name": "group_id", "in": "path", "description": "Existent site global property group id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated site global property group model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyGroupRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyGroupRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyGroupRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyGroupRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyGroupRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/site-globals/{group_id}/property": { "post": { "tags": [ "Site Globals" ], "summary": "Creates a new site global group property", "operationId": "SiteGlobalsController_CreateProperty", "parameters": [ { "name": "group_id", "in": "path", "description": "Site global property group id", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Site global property model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/site-globals/group/{group_id}": { "get": { "tags": [ "Site Globals" ], "summary": "Retrieves a single site global property group", "operationId": "SiteGlobalsController_Get", "parameters": [ { "name": "group_id", "in": "path", "description": "Site global property group id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/site-globals/properties": { "get": { "tags": [ "Site Globals" ], "summary": "Retrieves a list of site global group properies by using a \"where\" filtering", "operationId": "SiteGlobalsController_GetProperies", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/site-globals/property": { "delete": { "tags": [ "Site Globals" ], "summary": "Deletes an existing site global group property", "operationId": "SiteGlobalsController_DeleteProperties", "requestBody": { "description": "Existent site global property ids.", "content": { "application/json-patch+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "application/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "application/*+json": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/site-globals/property/{property_id}": { "get": { "tags": [ "Site Globals" ], "summary": "Retrieves a single site global group property", "operationId": "SiteGlobalsController_GetProperty", "parameters": [ { "name": "property_id", "in": "path", "description": "Site global property id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Site Globals" ], "summary": "Updates an existing site global group property", "operationId": "SiteGlobalsController_UpdateProperty", "parameters": [ { "name": "property_id", "in": "path", "description": "Existent site global property id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated site global property model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/snippets": { "get": { "tags": [ "Snippets" ], "summary": "Retrieves a list of snippets by using a \"where\" filtering", "operationId": "SnippetsController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract]" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Snippets" ], "summary": "Creates a new snippet", "operationId": "SnippetsController_Post", "requestBody": { "description": "Snippet model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/snippets/{id}": { "get": { "tags": [ "Snippets" ], "summary": "Retrieves a single snippet", "operationId": "SnippetsController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Snippet id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Snippets" ], "summary": "Updates an existing snippet", "operationId": "SnippetsController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent snippet id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated snippet model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Snippets" ], "summary": "Deletes an existing snippet", "operationId": "SnippetsController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent snippet id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/system-emails": { "get": { "tags": [ "System Emails" ], "summary": "Retrieves a list of system emails by using a \"where\" filtering", "operationId": "SystemEmailsController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailContract]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailContract]" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/system-emails/{id}": { "get": { "tags": [ "System Emails" ], "summary": "Retrieves a single system email", "operationId": "SystemEmailsController_Get", "parameters": [ { "name": "id", "in": "path", "description": "System email id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "System Emails" ], "summary": "Updates an existing system email", "operationId": "SystemEmailsController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent system email id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated email model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/system-emails/restore-to-default/{id}": { "get": { "tags": [ "System Emails" ], "summary": "Retrieves a restore to default", "operationId": "SystemEmailsController_RestoreToDefault", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "DXP.System.String", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.String", "type": "string" } }, "text/json": { "schema": { "title": "DXP.System.String", "type": "string" } }, "text/plain": { "schema": { "title": "DXP.System.String", "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/system-emails/variables": { "get": { "tags": [ "System Emails" ], "summary": "Retrieves a single system email variables", "operationId": "SystemEmailsController_GetVariables", "parameters": [ { "name": "systemEvent", "in": "query", "schema": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.Emails.Enums.SystemEmail" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/json": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } }, "text/plain": { "schema": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/system-pages": { "get": { "tags": [ "System Pages" ], "summary": "Retrieves a list of system pages by using a \"where\" filtering", "operationId": "SystemPagesController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageContract]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageContract]" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/system-pages/{id}": { "get": { "tags": [ "System Pages" ], "summary": "Retrieves a single system page", "operationId": "SystemPagesController_Get", "parameters": [ { "name": "id", "in": "path", "description": "System page id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "System Pages" ], "summary": "Updates an existing system page", "operationId": "SystemPagesController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent system page id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated page model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/system-pages/{id}/seo": { "get": { "tags": [ "System Pages" ], "summary": "Retrieves a single system page seo", "operationId": "SystemPagesController_GetSeo", "parameters": [ { "name": "id", "in": "path", "description": "System page id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "System Pages" ], "summary": "Updates an existing system page seo", "operationId": "SystemPagesController_PutSeo", "parameters": [ { "name": "id", "in": "path", "description": "Existent system page id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated page seo model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/system-pages/restore-to-default/{id}": { "get": { "tags": [ "System Pages" ], "summary": "Retrieves a single system page", "operationId": "SystemPagesController_GetDefaultContent", "parameters": [ { "name": "id", "in": "path", "description": "System page id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "DXP.System.String", "type": "string" } }, "text/json": { "schema": { "title": "DXP.System.String", "type": "string" } }, "text/plain": { "schema": { "title": "DXP.System.String", "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/url-redirects": { "get": { "tags": [ "Url Redirect" ], "summary": "Retrieves a list of url redirects by using a \"where\" filtering", "operationId": "UrlRedirectController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract]" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Url Redirect" ], "summary": "Creates a new url redirect", "operationId": "UrlRedirectController_Post", "requestBody": { "description": "Url redirect model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/url-redirects/{id}": { "get": { "tags": [ "Url Redirect" ], "summary": "Retrieves a single url redirect", "operationId": "UrlRedirectController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Url redirect id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Url Redirect" ], "summary": "Updates an existing url redirect", "operationId": "UrlRedirectController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent url redirect id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated url redirect model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Url Redirect" ], "summary": "Deletes an existing url redirect", "operationId": "UrlRedirectController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent url redirect id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/url-rewrites": { "get": { "tags": [ "Url Rewrite" ], "summary": "Retrieves a list of url rewrites by using a \"where\" filtering", "operationId": "UrlRewriteController_GetAll", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract]" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Url Rewrite" ], "summary": "Creates a new url rewrite", "operationId": "UrlRewriteController_Post", "requestBody": { "description": "Url rewrite model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/url-rewrites/{id}": { "get": { "tags": [ "Url Rewrite" ], "summary": "Retrieves a single url rewrite", "operationId": "UrlRewriteController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Url rewrite id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Url Rewrite" ], "summary": "Updates an existing url rewrite", "operationId": "UrlRewriteController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent url rewrite id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated url rewrite model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Url Rewrite" ], "summary": "Deletes an existing url rewrite", "operationId": "UrlRewriteController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent url rewrite id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/workflows": { "get": { "tags": [ "Workflows" ], "summary": "Retrieves a list of workflows by using a \"where\" filtering", "operationId": "WorkflowsController_GetList", "parameters": [ { "name": "Where", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Order_By", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Semantic_Query", "in": "query", "schema": { "title": "DXP.System.String", "type": "string" } }, { "name": "Min_Score", "in": "query", "schema": { "title": "DXP.System.Nullable`1", "type": "number", "format": "double" } }, { "name": "Offset", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowShortContract]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Workflows" ], "summary": "Creates a new workflow", "operationId": "WorkflowsController_Post", "requestBody": { "description": "Workflow model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowRequestContract" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v2/admin/workflows/{id}": { "get": { "tags": [ "Workflows" ], "summary": "Retrieves a single workflow", "operationId": "WorkflowsController_Get", "parameters": [ { "name": "id", "in": "path", "description": "Workflow id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowContract" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Workflows" ], "summary": "Updates an existing workflow", "operationId": "WorkflowsController_Put", "parameters": [ { "name": "id", "in": "path", "description": "Existent workflow id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated workflow model.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowRequestContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowRequestContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowRequestContract" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowRequestContract" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowRequestContract" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherContract" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Workflows" ], "summary": "Deletes an existing workflow", "operationId": "WorkflowsController_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Existent workflow id.", "required": true, "schema": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } } }, "components": { "schemas": { "Microsoft.AspNetCore.Mvc.ProblemDetails": { "title": "DXP.Microsoft.AspNetCore.Mvc.ProblemDetails", "type": "object", "properties": { "Type": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "A URI reference that identifies the problem type.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Title": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Short, human-readable summary of the problem type.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Status": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "The HTTP status code generated for this problem. Read-only.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Detail": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Human-readable explanation specific to this occurrence of the problem.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Instance": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "A URI reference that identifies the specific occurrence of the problem.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } }, "additionalProperties": { "title": "DXP.System.Object" } }, "System.ValueTuple`2[System.String,System.String]": { "title": "DXP.System.ValueTuple`2", "type": "object", "properties": { "Item1": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The stored value of a key/value pair, typically the code sent to the provider.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Item2": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The display name of a key/value pair, shown to the user for the matching value.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } }, "additionalProperties": false }, "Treepl.Basis.Data.VirtualPointer": { "title": "DXP.Treepl.Basis.Data.VirtualPointer", "type": "object", "properties": { "Pointer": { "title": "DXP.System.UInt64", "type": "integer", "format": "int64", "readOnly": true, "description": "Internal reference identifier that locates the target entity instance the pointer refers to.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "TypeId": { "title": "DXP.System.UInt32", "type": "integer", "format": "int32", "description": "Identifier of the related type.", "x-doc-source": "rule" }, "InstanceId": { "title": "DXP.System.UInt32", "type": "integer", "format": "int32", "description": "Identifier of the related instance.", "x-doc-source": "rule" }, "DbTypeId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "readOnly": true, "description": "Identifier of the related db type.", "x-doc-source": "rule" }, "DbInstanceId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "readOnly": true, "description": "Identifier of the related db instance.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Admin.Models.Common.EcommerceSettings.Enums.ValueType": { "title": "DXP.Admin.Models.Common.EcommerceSettings.Enums.ValueType", "enum": [ "BooleanValue", "NumberValue", "StringValue", "DateTimeValue", "DropDown", "FolderPath" ], "type": "string" }, "Treepl.CMS.Admin.Models.Common.Forms.EnumResponseModel`1[eCommerce.BusinessModel.PaymentFormType]": { "title": "DXP.Admin.Models.Common.Forms.EnumResponseModel`1", "type": "object", "properties": { "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Human-readable display name shown to users.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Value": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The stored value of a payment form type option, paired with its display name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentFormType", "description": "System (pre-defined fields like \"Email\") or Custom (manually added fields). Possible values: Generic, SingleItem, CheckOut, Recurring, Quote." } }, "additionalProperties": false }, "Treepl.CMS.Admin.Models.Common.Forms.Request.UpdateTemplateFormRequest": { "title": "DXP.Admin.Models.Common.Forms.Request.UpdateTemplateFormRequest", "required": [ "Template" ], "type": "object", "properties": { "Template": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The Liquid/HTML template file that controls the form's markup and styling.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Admin.Models.Common.SecureZones.PaymentIntervalState": { "title": "DXP.Admin.Models.Common.SecureZones.PaymentIntervalState", "type": "object", "properties": { "AccessType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.RecurringType", "description": "The billing interval this payment option represents, from daily through yearly. None means no recurring interval is set.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "IsEnable": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether this billing interval is available for selection.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Display name of the payment interval state, shown to users.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } }, "additionalProperties": false }, "Treepl.CMS.Admin.Models.Common.ShippingOption.BaseDisplayResponseModel": { "title": "DXP.Admin.Models.Common.ShippingOption.BaseDisplayResponseModel", "type": "object", "properties": { "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Display name of the base display, shown to users." }, "Value": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The packaging dimensions identifier used for cost calculation." } }, "additionalProperties": false }, "Treepl.CMS.Admin.Models.Measurement.DimensionUnits": { "title": "DXP.Admin.Models.Measurement.DimensionUnits", "enum": [ "CM", "IN", "MM", "M", "FT", "YD" ], "type": "string" }, "Treepl.CMS.Admin.Models.Measurement.WeightUnits": { "title": "DXP.Admin.Models.Measurement.WeightUnits", "enum": [ "KG", "LB", "OZ", "G" ], "type": "string" }, "Treepl.CMS.Core.Enums.CustomerType": { "title": "DXP.Core.Enums.CustomerType", "enum": [ "Consumer", "Wholesaler" ], "type": "string" }, "Treepl.CMS.Data.Core.Services.CrmPropertyGroups.Models.IDefaultCaseFieldContract": { "title": "DXP.Data.Core.Services.CrmPropertyGroups.Models.IDefaultCaseFieldContract", "type": "object", "properties": { "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "System alias of the form." }, "Value": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The value entered for this CRM field.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.FieldType", "description": "'StatusShort' technical key (alias). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator." } }, "additionalProperties": false }, "Treepl.CMS.Data.Core.Services.EmailMessageService.Models.EmailMessageEvents": { "title": "DXP.Data.Core.Services.EmailMessageService.Models.EmailMessageEvents", "enum": [ "None", "ModuleItemCreated", "ModuleItemUpdated", "ModuleItemDeleted", "ModuleItemUpdatedDraft", "ModuleItemPublishedDraft" ], "type": "string" }, "Treepl.CMS.Data.Core.Services.Emails.Enums.EmailSection": { "title": "DXP.Data.Core.Services.Emails.Enums.EmailSection", "enum": [ "WorkflowNotification", "FollowUpNotification", "AbandonedCartNotification", "RecurringReminderNotification" ], "type": "string" }, "Treepl.CMS.Data.Core.Services.Emails.Enums.SystemEmail": { "title": "DXP.Data.Core.Services.Emails.Enums.SystemEmail", "enum": [ "AdminResetMemberPassword", "ConfirmEmailNotification", "OfflineCreditCardPayment", "GiftVoucher", "InviteAdminUser", "InvoiceEcom", "LowStockNotification", "OrderStatus", "PasswordRetrieveEmail", "Quote", "RestoreAdminUserPassword", "SecureZoneLoginDetails", "StorageLimitNotification", "SupplierNotification", "WorkflowNotification" ], "type": "string" }, "Treepl.CMS.Data.Core.Services.PaymentGatewaySettings.Enums.CheckoutIntegrationType": { "title": "DXP.Data.Core.Services.PaymentGatewaySettings.Enums.CheckoutIntegrationType", "enum": [ "Redirect", "Modal", "Inline" ], "type": "string" }, "Treepl.CMS.Data.Core.Services.PaymentGatewaySettings.Enums.EnvironmentEndpoint": { "title": "DXP.Data.Core.Services.PaymentGatewaySettings.Enums.EnvironmentEndpoint", "enum": [ "Production", "Sandbox" ], "type": "string" }, "Treepl.CMS.Data.Core.Services.Print.PrintFileType": { "title": "DXP.Data.Core.Services.Print.PrintFileType", "enum": [ "Invoice", "PackingSlip", "PackageLabel" ], "type": "string" }, "Treepl.CMS.Data.Core.Services.Settings.Miscs.SettingsFieldType": { "title": "DXP.Data.Core.Services.Settings.Miscs.SettingsFieldType", "enum": [ "MainCSS", "EcommerceJS", "RecaptchaJS", "PaymentJS", "AceTextWrapper", "Enable24HoursFormat", "DisableNotificationWhenSavingToWysiwyg", "DisableAutocompleteForAlreadyTakenUrlSlugs", "EnableFilesRestrictions", "ForbiddenFileTypes", "RecaptchaScore", "RecaptchaVersion", "RecaptchaSecretV2", "RecaptchaSitekeyV2", "RecaptchaSecretV3", "RecaptchaSitekeyV3", "ShoppingCartLifeTimeInHours", "AbandonedCartTimeInHours", "DimensionUnits", "WeightUnits", "AccountUploadFolderPath", "AccountSecureUploads", "EnableEmailVerification", "AllowListingCrmContactsData", "DiscountApplyType", "RememberMe", "ExcludeUrlRules" ], "type": "string" }, "Treepl.CMS.Data.Core.Services.Templates.Models.FillState": { "title": "DXP.Data.Core.Services.Templates.Models.FillState", "enum": [ "UseGlobal", "Enable", "Disable" ], "type": "string" }, "Treepl.CMS.Public.API.v2.Contracts.AdminMenus.AdminMenuContract": { "title": "DXP.OpenAPI.v2.Contracts.AdminMenus.AdminMenuContract", "type": "object", "properties": { "EntityAlias": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Technical alias of the entity to which the item leads." }, "IsDisabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the menu item will be disabled." }, "EntityType": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Object type. Helps the system determine processing logic." }, "DefaultName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Standard menu item name." }, "DefaultItemsView": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Specifies the display mode for related data." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Display name of the menu item." }, "Href": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The URL or path where the administrator will go after clicking on the item." }, "Type": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Menu item type." }, "Icon": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Use the add file icon () in this field to choose from a range of system icons or alternatively upload your own custom image." }, "Enable": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Items are enabled by default. Uncheck this option to hide this menu item from the admin, but not delete it permanently." }, "Weight": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The ordinal number (weight) for sorting. The lower the number, the higher the item in the list." }, "Children": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminMenus.AdminMenuContract" }, "nullable": true, "description": "An array of child elements. Used to create drop-down lists or multi-level menu structures." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdminMenus.AdminMenusContract": { "title": "DXP.OpenAPI.v2.Contracts.AdminMenus.AdminMenusContract", "type": "object", "properties": { "Default": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminMenus.AdminMenuContract" }, "nullable": true, "description": "Built-in admin menu items that ship with the platform, defining the standard navigation of the site's admin panel.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Custom": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminMenus.AdminMenuContract" }, "nullable": true, "description": "Admin menu items added by the agency on top of the defaults, letting them extend the admin navigation with their own sections and links.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleContract": { "title": "DXP.OpenAPI.v2.Contracts.AdminRoles.AdminRoleContract", "type": "object", "properties": { "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique identifier assigned by the platform.", "x-doc-source": "rule" }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the admin role.", "x-doc-source": "rule" }, "Restrictions": { "title": "DXP.System.Collections.Generic.Dictionary`2", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.RestrictionsRoleContract" }, "nullable": true, "description": "Per-entity access rules that define what this role can see and do across CMS, Ecommerce, CRM and other modules.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "HasAccessToFtp": { "title": "DXP.System.Boolean", "type": "boolean", "readOnly": true, "description": "Whether the role has access to the site's file storage over FTP.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.AdminRoles.AdminRoleRequestContract", "type": "object", "properties": { "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the admin role.", "x-doc-source": "rule" }, "Restrictions": { "title": "DXP.System.Collections.Generic.Dictionary`2", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.RestrictionsRoleContract" }, "nullable": true, "description": "Per-entity access rules that define what this role can see and do across CMS, Ecommerce, CRM and other modules.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "HasAccessToFtp": { "title": "DXP.System.Boolean", "type": "boolean", "readOnly": true, "description": "Grants the role access to the site's file storage over FTP.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleRestrictionContract": { "title": "DXP.OpenAPI.v2.Contracts.AdminRoles.AdminRoleRestrictionContract", "type": "object", "properties": { "EntityAlias": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Machine alias of the entity the restrictions apply to, such as a specific custom module or CRM group.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "EntityType": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Kind of entity the restrictions target, for example a page, module or ecommerce section.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the admin role restriction.", "x-doc-source": "rule" }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Machine-readable alias for the admin role restriction.", "x-doc-source": "rule" }, "Restrictions": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.RestrictionContract" }, "nullable": true, "description": "The individual permission toggles granted or denied for this entity.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleSimpleContract": { "title": "DXP.OpenAPI.v2.Contracts.AdminRoles.AdminRoleSimpleContract", "type": "object", "properties": { "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique identifier assigned by the platform.", "x-doc-source": "rule" }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the admin role.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdminRoles.RestrictionContract": { "title": "DXP.OpenAPI.v2.Contracts.AdminRoles.RestrictionContract", "type": "object", "properties": { "Label": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Human-readable name of the permission shown in the admin panel, such as View, Create or Delete.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Machine-readable alias for the restriction.", "x-doc-source": "rule" }, "Value": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether this permission is granted for the role.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdminRoles.RestrictionRoleContract": { "title": "DXP.OpenAPI.v2.Contracts.AdminRoles.RestrictionRoleContract", "type": "object", "properties": { "Value": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether this permission is granted for the role.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Weight": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Sort priority for manual ordering. Higher-priority items appear first.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdminRoles.RestrictionsRoleContract": { "title": "DXP.OpenAPI.v2.Contracts.AdminRoles.RestrictionsRoleContract", "type": "object", "properties": { "Restrictions": { "title": "DXP.System.Collections.Generic.Dictionary`2", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.RestrictionRoleContract" }, "nullable": true, "description": "Per-entity access rules that define what this role can see and do across CMS, Ecommerce, CRM and other modules.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserContract": { "title": "DXP.OpenAPI.v2.Contracts.AdminUsers.AdminUserContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The unique identifier of the administrator entry in the access rights table. Read-only." }, "IsInvited": { "title": "DXP.System.Boolean", "type": "boolean", "description": "A boolean flag indicating whether the user has been sent an email invitation. If true, the user has yet to confirm registration or set a password." }, "FirstName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "User name." }, "LastName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "User's last name." }, "Email": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "An email address that is also the login for entering the admin panel." }, "EnableOse": { "title": "DXP.System.Boolean", "type": "boolean", "description": "This flag enables specific access rights to the advanced operator interface." }, "UserId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Global user identifier in a common authentication system." }, "RoleId": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "The numeric identifier of the assigned role, which defines the set of available permissions." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.AdminUsers.AdminUserRequestContract", "required": [ "Email", "FirstName", "LastName" ], "type": "object", "properties": { "FirstName": { "title": "DXP.System.String", "maxLength": 100, "minLength": 2, "type": "string", "description": "User name." }, "LastName": { "title": "DXP.System.String", "maxLength": 100, "minLength": 2, "type": "string", "description": "User's last name." }, "Email": { "title": "DXP.System.String", "minLength": 1, "type": "string", "format": "email", "description": "An email address that is also the login for entering the admin panel." }, "EnableOse": { "title": "DXP.System.Boolean", "type": "boolean", "description": "This flag enables specific access rights to the advanced operator interface." }, "Role": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Access level granted to the member." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserUpdateContract": { "title": "DXP.OpenAPI.v2.Contracts.AdminUsers.AdminUserUpdateContract", "type": "object", "properties": { "EnableOse": { "title": "DXP.System.Boolean", "type": "boolean", "description": "This flag enables specific access rights to the advanced operator interface." }, "Role": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Access level granted to the member." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupContract": { "title": "DXP.OpenAPI.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupContract", "type": "object", "properties": { "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique identifier. Technical record number in the database. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the advanced crm group." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "The Liquid reference that can be used to access this Properties value." }, "ApplyToTypes": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/eCommerce.BusinessModel.ApplyToType" }, "nullable": true, "description": "An array of strings that indicates which objects in CRM this group belongs to." }, "Properties": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.CrmFieldContract" }, "nullable": true, "description": "Describes the configuration of specific fields (attributes) in your CRM group. Each object in the array is an instruction to the CMS on how to display and validate the field." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupCreateContract": { "title": "DXP.OpenAPI.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupCreateContract", "required": [ "Alias", "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "type": "string", "example": "string", "description": "Name of the advanced crm group." }, "Alias": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "pattern": "^([a-zA-Z0-9-_])*$", "type": "string", "example": "string", "description": "The Liquid reference that can be used to access this Properties value." }, "ApplyToTypes": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/eCommerce.BusinessModel.ApplyToType" }, "nullable": true, "description": "An array of strings that indicates which objects in CRM this group belongs to." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupTypeContract": { "title": "DXP.OpenAPI.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupTypeContract", "type": "object", "properties": { "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Display name of the advanced crm group type, shown to users.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Value": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The technical key of the object type this group can be applied to (for example Contacts or Order).", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupUpdateContract": { "title": "DXP.OpenAPI.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupUpdateContract", "required": [ "Alias", "Name" ], "type": "object", "properties": { "Properties": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.CrmFieldRequestContract" }, "nullable": true, "description": "The fields (attributes) that make up this CRM group. Each entry defines how a field is displayed and validated.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Name": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "type": "string", "example": "string", "description": "Name of the advanced crm group." }, "Alias": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "pattern": "^([a-zA-Z0-9-_])*$", "type": "string", "example": "string", "description": "The Liquid reference that can be used to access this Properties value." }, "ApplyToTypes": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/eCommerce.BusinessModel.ApplyToType" }, "nullable": true, "description": "An array of strings that indicates which objects in CRM this group belongs to." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.CrmFieldContract": { "title": "DXP.OpenAPI.v2.Contracts.AdvancedCrmGroups.CrmFieldContract", "required": [ "Name" ], "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Name": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "type": "string", "example": "string", "description": "Name of the crm field." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.FieldType", "description": "Data type. Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator." }, "IsMandatory": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Determines whether a field is required. Available for: [ DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Upload ] by default: false." }, "Options": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "An array of strings that indicates which objects in CRM this group belongs to. Available for: [ CheckboxList, DropdownList, ListboxList, RadioList ]" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.CrmFieldRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.AdvancedCrmGroups.CrmFieldRequestContract", "required": [ "Name" ], "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier assigned by the platform.", "x-doc-source": "rule" }, "Name": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "type": "string", "example": "string", "description": "Name of the crm field." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.FieldType", "description": "The input type of the CRM field, which controls how it is rendered and validated. Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "IsMandatory": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether the field must be filled in before the record can be saved.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Options": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "The list of choices offered by the field. Applies only to selection types such as CheckboxList, DropdownList, ListboxList, and RadioList.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.AdvancedOptionsContract": { "title": "DXP.OpenAPI.v2.Contracts.AdvancedOptionsContract", "type": "object", "properties": { "ChildModuleId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "AdvancedOptions setting. Identifier of the related child module whose objects can serve as nested elements in the current module." }, "AllowItemsTreeView": { "title": "DXP.System.Boolean", "type": "boolean", "description": "AdvancedOptions setting. Allows displaying elements in the form of a classic hierarchical tree." }, "AllowItemsSimplifiedTreeView": { "title": "DXP.System.Boolean", "type": "boolean", "description": "AdvancedOptions setting. Allows the use of a simplified (compact) tree view." }, "AllowItemsListView": { "title": "DXP.System.Boolean", "type": "boolean", "description": "AdvancedOptions setting. Allows displaying elements as a linear list (table)." }, "AllowMultipleParentItems": { "title": "DXP.System.Boolean", "type": "boolean", "description": "AdvancedOptions setting. Allows a single element to have multiple parent nodes (creating a network structure instead of a strict tree)." }, "EnableSubscription": { "title": "DXP.System.Boolean", "type": "boolean", "description": "AdvancedOptions setting. Activates the functionality for users to subscribe to changes in module elements." }, "EnableRelatedModuleItems": { "title": "DXP.System.Boolean", "type": "boolean", "description": "AdvancedOptions setting. Enables integration and display of related objects from other system modules." }, "DefaultItemsView": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "AdvancedOptions setting. Defines the default display mode for the list of elements." }, "RootTreeLevelViewAllowAddItemsOfParentType": { "title": "DXP.System.Boolean", "type": "boolean", "description": "AdvancedOptions setting. Allows creating elements of the same type as the root at the top level." }, "RootTreeLevelViewAllowAddItemsOfChildType": { "title": "DXP.System.Boolean", "type": "boolean", "description": "AdvancedOptions setting. Allows creating child elements for root nodes." }, "InnerTreeLevelViewAllowAddItemsOfParentType": { "title": "DXP.System.Boolean", "type": "boolean", "description": "AdvancedOptions setting. Allows creating elements of the same type (\"siblings\") at internal hierarchy levels." }, "InnerTreeLevelViewAllowAddItemsOfChildType": { "title": "DXP.System.Boolean", "type": "boolean", "description": "AdvancedOptions setting. Allows creating nested elements (\"descendants\") for internal nodes." }, "AllowCreatingForeignItems": { "title": "DXP.System.Boolean", "type": "boolean", "description": "AdvancedOptions setting. Determines whether elements belonging to other data types or modules can be added to the structure." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ApplyDiscountCodeToOrderContract": { "title": "DXP.OpenAPI.v2.Contracts.ApplyDiscountCodeToOrderContract", "type": "object", "properties": { "DiscountId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Identifier of the related discount.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ApplyGiftVoucherToOrderContract": { "title": "DXP.OpenAPI.v2.Contracts.ApplyGiftVoucherToOrderContract", "type": "object", "properties": { "GiftVoucherId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Identifier of the related gift voucher.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ApplyShippingInfoToOrderContract": { "title": "DXP.OpenAPI.v2.Contracts.ApplyShippingInfoToOrderContract", "type": "object", "properties": { "ShippingOptionId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Identifier of the related shipping option.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ApplyTaxToOrderContract": { "title": "DXP.OpenAPI.v2.Contracts.ApplyTaxToOrderContract", "type": "object", "properties": { "TaxId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Identifier of the related tax.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.CaseContract": { "title": "DXP.OpenAPI.v2.Contracts.CaseContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "OrderId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related order." }, "FormId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related form." }, "MemberId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related member." }, "CreatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time of case creation in UTC. Read-only." }, "CustomCrmGroups": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Shared.Contracts.DefaultCrmGroupContract" }, "nullable": true, "example": { "": { "": "", "": false, "": 0 } }, "description": "Custom CRM group field values attached to this record." }, "Member": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.MemberShortInfoContract", "description": "The member (site user) this record is linked to." }, "Form": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CaseFormContract", "description": "Form the submission belongs to." }, "CaseFields": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Shared.Contracts.DefaultCaseFieldContract" }, "nullable": true, "example": { "": "", "": false, "": 0 }, "description": "This is a dynamic object that contains the values of the form fields on which the Case is created." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.CaseEventContract": { "title": "DXP.OpenAPI.v2.Contracts.CaseEventContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Event ID. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "System name of the event." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.CaseFormContract": { "title": "DXP.OpenAPI.v2.Contracts.CaseFormContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Event ID. Read-only." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "System alias of the form." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "System name of the event." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.CategoryContract": { "title": "DXP.OpenAPI.v2.Contracts.CategoryContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. The technical ID of the category in the database. Used as ParentId for creating subcategories. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Public category name that is displayed in the menu." }, "FullName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Full category name that may include the parent element name and subcategory. Read-only." }, "NestingLevel": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Nesting level. Defines the depth of the category in the tree. 1 — root category. 2 and above — subcategories of the corresponding level. Read-only." }, "Weight": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Weight (priority). Used for manual sorting. The higher or lower the number (depending on the logic), the higher the category is displayed in the list. For the default category — 246 for the default subcategory — 14." }, "Children": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CategoryContract" }, "nullable": true, "description": "Array of subcategories. Contains a list of objects of the same type that are children of this category. Allows building a tree-like structure in a single request." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ContactContract": { "title": "DXP.OpenAPI.v2.Contracts.ContactContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Email": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "User's email." }, "FirstName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The contact's first name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "LastName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The contact's last name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "CrmType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.CrmType", "description": "Type of record in the CRM system. Possible values: Contact, Member." }, "EmailConfirmed": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Email confirmation status." }, "Role": { "$ref": "#/components/schemas/eCommerce.BusinessModel.MemberRole", "description": "Access level granted to the member. Possible values: General, AdminUser." }, "CreatedDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time of record creation." }, "Address": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Street/residential address." }, "City": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "City of residence." }, "State": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "State of residence." }, "ZipCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Postal code." }, "Country": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Country." }, "BillingAddress": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The street and number of the contact's billing address.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "BillingCity": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The city of the contact's billing address.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "BillingState": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The state, province, or region of the contact's billing address.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "BillingZipCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The postal code of the contact's billing address.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "BillingCountry": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The country of the contact's billing address.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Site": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The member's website address." }, "Phone": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The contact's phone number, ideally in E.164 format.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Status": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Current object status." }, "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Free-text notes for internal use." }, "Type": { "$ref": "#/components/schemas/Treepl.CMS.Core.Enums.CustomerType", "description": "User category. Possible values: Consumer, Wholesaler." }, "IsDataUsingAllowed": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Consent to the use of personal data." }, "CustomCrmGroups": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Shared.Contracts.DefaultCrmGroupContract" }, "nullable": true, "example": { "": { "": "", "": false, "": 0 } }, "description": "Custom CRM group field values attached to this record." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ContactSecureZonesContract": { "title": "DXP.OpenAPI.v2.Contracts.ContactSecureZonesContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the contact secure zones.", "x-doc-source": "rule" }, "ExpiryDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Expiry timestamp (ISO 8601).", "x-doc-source": "rule" }, "CreatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "When the record was created (ISO 8601). Read-only.", "x-doc-source": "rule" }, "UpdatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "When the record was last updated (ISO 8601).", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ContentTemplates.ContentTemplateContract": { "title": "DXP.OpenAPI.v2.Contracts.ContentTemplates.ContentTemplateContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Aunique identifier. The technical ID of the template in the database. Read-only." }, "Content": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Template body (HTML). Contains markup with placeholders ({{pageContent}}), where the system inserts the dynamic page content." }, "FtpPath": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "File path. The physical location of the template file on the server or FTP storage. Read-only." }, "IsSystem": { "title": "DXP.System.Boolean", "type": "boolean", "description": "System flag. True: the template is basic (system), it is usually forbidden to delete or rename. False: a custom template created by the administrator (set upon creation)." }, "IsDefault": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Default usage. Defines whether this template will be automatically selected for new pages of this type." }, "AmpContent": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "AMP markup. A special version of the template for Google Accelerated Mobile Pages. Contains markup with placeholders ({{pageContent}})" }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Template name that is displayed in the admin panel." }, "Settings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContentTemplates.ContentTemplateSettingsContract", "description": "Technical configuration. A set of switches (UseGlobal, Enable, Disable) for managing the functionality of the page that uses this template. Contains [MainCSS],[RecaptchaJS],[EcommerceJS],[PaymentJS]" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ContentTemplates.ContentTemplateSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.ContentTemplates.ContentTemplateSettingsContract", "type": "object", "properties": { "MainCSS": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.Templates.Models.FillState", "description": "Controls whether the site's main stylesheet is loaded on pages that use this template. Possible values: UseGlobal, Enable, Disable.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "RecaptchaJS": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.Templates.Models.FillState", "description": "Controls whether the Google reCAPTCHA protection script is loaded on pages that use this template. Possible values: UseGlobal, Enable, Disable.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "EcommerceJS": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.Templates.Models.FillState", "description": "Controls whether the e-commerce scripts (cart, price tracking, sales analytics) are loaded on pages that use this template. Possible values: UseGlobal, Enable, Disable.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "PaymentJS": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.Templates.Models.FillState", "description": "Controls whether the payment provider libraries (Stripe, PayPal, and similar) are loaded on pages that use this template. Possible values: UseGlobal, Enable, Disable.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.CreateCategoryContract": { "title": "DXP.OpenAPI.v2.Contracts.CreateCategoryContract", "required": [ "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Category/subcategory name, understandable to a human, that is displayed to the user. Use a unique name for creation/editing." }, "ParentId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Parent element identifier. Use -1 to create a main (root) category. Use the ID of an existing category to create a subcategory." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.CreateContactContract": { "title": "DXP.OpenAPI.v2.Contracts.CreateContactContract", "required": [ "Email", "FirstName" ], "type": "object", "properties": { "Email": { "title": "DXP.System.String", "maxLength": 1000, "minLength": 1, "pattern": "\\w+([-+.']\\w+)*@\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*", "type": "string", "description": "Primary contact identifier. Must be unique in the system. Email validity verification is performed." }, "FirstName": { "title": "DXP.System.String", "maxLength": 1000, "minLength": 1, "type": "string", "description": "Client's first name." }, "LastName": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Client's last name." }, "Password": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Password. Pass only for Member." }, "CrmType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.CrmType", "description": "Defines the access level. Member: client with access (if password is provided). Contact: regular lead or record in the database." }, "Role": { "$ref": "#/components/schemas/eCommerce.BusinessModel.MemberRole", "description": "Role in the system or position. General: by default. Nullable: false." }, "Address": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Physical address (street, house number)." }, "City": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "City of residence." }, "State": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Province, state, or region." }, "ZipCode": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Postal code." }, "Country": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Country (it is recommended to use ISO codes)." }, "BillingAddress": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Billing address (may match the physical address)." }, "BillingCity": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Billing address city." }, "BillingState": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Province/state of the billing address." }, "BillingZipCode": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Billing address postal code." }, "BillingCountry": { "title": "DXP.System.String", "maxLength": 10, "type": "string", "nullable": true, "description": "Billing address country." }, "Site": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "URL of the contact's or company's website." }, "Phone": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Phone number (E.164 format recommended)." }, "Status": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Contact lifecycle (for example: Active, Lead, Archived)." }, "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Arbitrary internal administrator notes about this contact." }, "Type": { "$ref": "#/components/schemas/Treepl.CMS.Core.Enums.CustomerType", "description": "Classification. Consumer: by default. Nullable: false." }, "IsDataUsingAllowed": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Consent to data processing. A key parameter for GDPR. True allows marketing communications." }, "CustomCrmGroups": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Shared.Contracts.DefaultCrmGroupContract" }, "nullable": true, "example": { "": { "": "", "": false, "": 0 } }, "description": "Custom fields. An object containing additional properties grouped by technical names (for example, hobbies or specific settings). This is a dynamic section, where keys (for example, at-api-crm-group) correspond to internal identifiers of field groups in your CRM. Films (string): Example of a text field (for example, movie preferences) and depending on the settings, may be required. Field types are." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.CreateModuleContract": { "title": "DXP.OpenAPI.v2.Contracts.CreateModuleContract", "required": [ "AdvancedOptions", "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 255, "minLength": 2, "type": "string", "example": "string", "description": "Name of the create module." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Is a critically important system identifier. Is a static string used by the software to reference the module. Cannot be empty/absent (nullable: false)." }, "Title": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Module title for the interface." }, "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Free-text notes for internal use." }, "MediaFolder": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "This is the folder that is displayed by default in the media manager when selecting content for this module." }, "NewItemButtonValue": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Text that will be displayed on the button for creating a new item." }, "UrlSlug": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Part of the URL path for module items." }, "Icon": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Relative path to the icon file within the system directory or media storage." }, "LastUpdatedDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "When the record was last updated (ISO 8601). Read-only.", "x-doc-source": "rule" }, "IsDefault": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, marks this as the site's default module.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "SecureZones": { "title": "DXP.System.Int32[]", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "Identifiers of the secure zones the module is bound to, controlling which member groups can view its content.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "DisableDetailLayout": { "title": "DXP.System.Boolean", "type": "boolean", "description": "This is a logical toggle that determines whether elements of this module will have their own separate page on the site." }, "MediaFilesUploadFolder": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "This is a system path to the directory (folder) designed for automatic storage of media files (images, documents, videos) uploaded by users through records of this module." }, "ExtraSettings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ExtraSettingsContract", "description": "Container for additional module settings, such as change-history rollback.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "SiteUserPermissions": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteUserPermissionsContract", "description": "User permissions settings." }, "AdvancedOptions": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedOptionsContract", "description": "Advanced module settings controlling item hierarchy, tree/list views, subscriptions, and related-item behavior in the admin panel.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.CreateOrderContract": { "title": "DXP.OpenAPI.v2.Contracts.CreateOrderContract", "required": [ "ShippingCountry" ], "type": "object", "properties": { "AWBNumber": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Intended for the Air Waybill (or any other shipment tracking/consignment number) from your freight provider." }, "InvoiceDate": { "title": "DXP.System.Nullable`1", "type": "string", "format": "date-time", "nullable": true, "description": "Date-time - the date and time the invoice was generated." }, "InvoiceNumber": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "A number assigned incrementally to each order." }, "MainOrderId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related main order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "MemberId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The CRM Contact who submitted the Order (this field is not editable)." }, "OrderName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The Order name is generally constructed by the name of the Form used for taking the Order then appended with the Order date." }, "PaymentState": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentState", "description": "Current payment status. Possible values: None, Succeeded, RequiresCapture, RequiresAction, Canceled, Processing, Pending." }, "StatusId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The current status of the Order. See eCommerce Settings / Manage Status for more details." }, "TrackingURL": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Intended for the URL used for consignment tracking by your freight provider." }, "ShippingZipCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The contact's shipping zipcode/postcode as entered during the checkout process." }, "ShippingState": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The contact's shipping state/territory as entered during the checkout process." }, "ShippingAddress": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The contact's shipping address line (unit/number and street) as entered during the checkout process." }, "ShippingCity": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The contact's shipping city/suburb/provence as entered during the checkout process." }, "ShippingCountry": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The contact's shipping country as entered during the checkout process." }, "GenerateInvoiceNumber": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Request only. If true, the system will automatically generate an invoice number. Missing from the response." }, "GenerateVATInvoiceNumber": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When true, the system automatically assigns a VAT invoice number to the new order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.CreateOrderLineContract": { "title": "DXP.OpenAPI.v2.Contracts.CreateOrderLineContract", "required": [ "ProductId", "Quantity" ], "type": "object", "properties": { "ProductId": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "description": "Unique system identifier of the product. Used to synchronize inventory balances." }, "ProductName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Product name that will be displayed in the order." }, "Quantity": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "description": "The number of units of a product that the customer purchases." }, "UnitPrice": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Price per unit of product at the time of order placement." }, "Attributes": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ProductAttributeContract" }, "nullable": true, "description": "An array of additional characteristics (variations) of the selected product." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.CreateOrderPaymentContract": { "title": "DXP.OpenAPI.v2.Contracts.CreateOrderPaymentContract", "type": "object", "properties": { "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Free text comment for the payment. Here you can specify the transaction number from the payment system." }, "PaymentType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentType", "description": "Payment method. Possible values: CreditCard, Cash, Free, Paypal, Cheque, EFT, MoneyOrder, Other, Refund." }, "Amount": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "This is a numeric value. The value must not be less than 0." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.CustomerTypeContract": { "title": "DXP.OpenAPI.v2.Contracts.CustomerTypeContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier assigned by the platform.", "x-doc-source": "rule" }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the customer type.", "x-doc-source": "rule" }, "IsDefault": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether this is the customer type applied by default to new customers.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract": { "title": "DXP.OpenAPI.v2.Contracts.DiscountCodes.DiscountContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Code": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "A unique coupon code (for example, SUMMER2024) that the user enters in the cart." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.DiscountCodeType", "description": "Discount type. Possible values: FixedAmount, PercentageOfOrder, FreeShipping." }, "Description": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Description of the discount.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Discount currency." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "This is the main \"on/off\" (boolean) of your discount or promo code." }, "Amount": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "This is the numerical value of the discount amount." }, "MinOrderCostLimitation": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Minimum order amount after which the coupon becomes active." }, "UseExpireAfterRedemption": { "title": "DXP.System.Boolean", "type": "boolean", "description": "This is a logical switch (checkbox) that determines the coupon expiration mode." }, "ExpireAfter": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "This is a numerical indicator of the coupon's lifespan in dynamic mode." }, "ReleaseDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time of the beginning of the action." }, "ExpiryDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time of expiration." }, "Catalogs": { "title": "DXP.System.Int32[]", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "An array of directory IDs. 0 is the ID of the main catalog. It tells the system which sections of the store this setting will work in." }, "ApplyDiscountToCatalogs": { "title": "DXP.System.Boolean", "type": "boolean", "description": "A boolean flag indicating that if this setting contains a discount, it should automatically apply to all products within the above catalogs." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.DiscountCodes.DiscountRequestContract", "type": "object", "properties": { "Code": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The actual code your customers need to enter in order to redeem this voucher. This code can contain spaces and special characters and is not case sensitive(when redeeming)." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.DiscountCodeType", "description": "Defines the calculation logic Percentage Of Order allows the amount of the discount to be applied as a percentage reduction of the total order price. Possible values: FixedAmount, PercentageOfOrder, FreeShipping." }, "Description": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The description, or notes, about the discount code providing further info to the admin user about the code. This value is not displayed on the front-end." }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The currency in which the discount code can be used." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Set the discount code as enabled when checked(uncheck to disable)." }, "Amount": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The value used to calculate the discount applied. This value can be a fixed amount or a percentage, depending on the 'Type' setting above." }, "MinOrderCostLimitation": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Assigns a restriction on the use of the discount code unless the order total exceeds or is equal to, this minimum value threshold(before tax). Positive value." }, "UseExpireAfterRedemption": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Enable discount code expiration after a defined number of redemptions have taken place. The discount code will be marked as disabled once its redemption threshold has been reached." }, "ExpireAfter": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "A number defining the number of times the code can be used. This value will also reduce as redemptions occur. Available when UseExpireAfterRedemption = true. Positive value." }, "ReleaseDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Set a date and time in which this discount code will become enabled for use in your shopping cart." }, "ExpiryDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Set a date and time in which this discount code will become disabled and no longer able to be redeemed in your shopping cart." }, "Catalogs": { "title": "DXP.System.Int32[]", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "Define the catalog/s allowed for use of this discount code. Available when ApplyDiscountToCatalogs = true." }, "ApplyDiscountToCatalogs": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Define the catalog/s allowed for use of this discount code." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.DiscountContract": { "title": "DXP.OpenAPI.v2.Contracts.DiscountContract", "type": "object", "properties": { "Code": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The code a customer enters at checkout to apply this discount.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Cost": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "'ShippingInfo' the cost of delivery services. Added to the cost of goods to form TotalCost." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.CountryContract": { "title": "DXP.OpenAPI.v2.Contracts.EcommerceSettings.CountryContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Country": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Country (it is recommended to use ISO codes).", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Abbreviation": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Standard two-letter code for the country (for example, US or AU).", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Code": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "A unique coupon code (for example, SUMMER2024) that the user enters in the cart." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.EcommerceSettingContract": { "title": "DXP.OpenAPI.v2.Contracts.EcommerceSettings.EcommerceSettingContract", "type": "object", "properties": { "GroupTitle": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Heading of the settings group this block of fields belongs to, used to organize the eCommerce settings screen.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Fields": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.SettingsFieldContract" }, "nullable": true, "description": "The individual settings that make up this group, each with its own title, value, and type.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.EcommerceSettingsRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.EcommerceSettings.EcommerceSettingsRequestContract", "required": [ "DimensionUnits", "DiscountApplyType", "ShoppingCartLifeTimeInHours", "WeightUnits" ], "type": "object", "properties": { "ShoppingCartLifeTimeInHours": { "title": "DXP.System.Nullable`1", "maximum": 876000, "minimum": 1, "type": "integer", "format": "int32", "description": "The number of hours a user's shopping cart will remain active and accessible. The minimum value allowed in this setting is 1 hour and the maximum is 876000 hours." }, "AbandonedCartTimeInHours": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "The minimum value allowed in this setting is 1 hour and the maximum is 876000 hours. This setting is only available when using the Aboandoned Cart Recovery extension." }, "DimensionUnits": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Measurement.DimensionUnits", "description": "The unit of measurement used for products width, height and depth dimensions for use in shipping calculations. Possible values: CM, IN, MM, M, FT, YD." }, "WeightUnits": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Measurement.WeightUnits", "description": "The unit of measurement used for products weight for use in shipping calculations. Possible values: KG, LB, OZ, G." }, "DiscountApplyType": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The logic of applying discounts." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.SettingsFieldContract": { "title": "DXP.OpenAPI.v2.Contracts.EcommerceSettings.SettingsFieldContract", "type": "object", "properties": { "Description": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Description of the settings field.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Options": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Available choices for a field rendered as a dropdown. Empty for fields that take a free value.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Value": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Current value stored for this setting, serialized as text regardless of the field's underlying data type.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "ValueType": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.EcommerceSettings.Enums.ValueType", "description": "How the field's value should be interpreted and edited. Possible values: BooleanValue, NumberValue, StringValue, DateTimeValue, DropDown, FolderPath.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "FieldType": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.Settings.Miscs.SettingsFieldType", "description": "Identifies which specific eCommerce setting this entry controls. Possible values: MainCSS, EcommerceJS, RecaptchaJS, PaymentJS, AceTextWrapper, Enable24HoursFormat, DisableNotificationWhenSavingToWysiwyg, DisableAutocompleteForAlreadyTakenUrlSlugs, EnableFilesRestrictions, ForbiddenFileTypes, RecaptchaScore, RecaptchaVersion, RecaptchaSecretV2, RecaptchaSitekeyV2, RecaptchaSecretV3, RecaptchaSitekeyV3, ShoppingCartLifeTimeInHours, AbandonedCartTimeInHours, DimensionUnits, WeightUnits, AccountUploadFolderPath, AccountSecureUploads, EnableEmailVerification, AllowListingCrmContactsData, DiscountApplyType, RememberMe, ExcludeUrlRules.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Title": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Human-readable label for the setting as shown in the admin.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.EcommerceSettings.ShippingSettingsContract", "type": "object", "properties": { "ShippingCountriesId": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Identifier of the related shipping countries.", "x-doc-source": "rule" }, "DefaultCountryId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Identifier of the related default country.", "x-doc-source": "rule" }, "IsMandatoryShippingCountry": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the customer must specify a shipping country before checkout can proceed.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "SubtotalWithTax": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the order subtotal shown to the customer includes tax rather than listing it separately.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.EcommerceSettings.ShippingTaxSettingsContract", "type": "object", "properties": { "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique identifier. Technical record number in the database. Read-only." }, "CurrencyCountry": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.CurrencyCountryContract", "description": "The currency-and-country market this shipping and tax configuration applies to.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "TaxSettings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.TaxSettingsContract", "description": "Tax rules for this market, including what tax applies to, auto-selection behavior, and the rounding strategy.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ShippingSettings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingSettingsContract", "description": "Shipping rules for this market, such as whether a shipping country is required and how subtotals are calculated.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.EcommerceSettings.ShippingTaxSettingsRequestContract", "type": "object", "properties": { "CurrencyCountry": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.CurrencyCountryContract", "description": "The currency-and-country market the submitted shipping and tax settings apply to.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "TaxSettings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.TaxSettingsContract", "description": "Tax rules to save for this market, including what tax applies to, auto-selection behavior, and the rounding strategy.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ShippingSettings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingSettingsContract", "description": "Shipping rules to save for this market, such as whether a shipping country is required and how subtotals are calculated.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsResponseContract": { "title": "DXP.OpenAPI.v2.Contracts.EcommerceSettings.ShippingTaxSettingsResponseContract", "type": "object", "properties": { "AvailableCurrencyCountry": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.CurrencyCountryContract" }, "nullable": true, "description": "The currency-and-country combinations for which shipping and tax can be configured, used to populate market selectors.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "AppliesTo": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.TaxAppliesContract" }, "nullable": true, "readOnly": true, "description": "The entities tax can be applied to (shipping options and gift vouchers), used to drive the tax-applies-to selectors.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "TaxRoundingStrategy": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.TaxRoundingStrategyContract" }, "nullable": true, "readOnly": true, "description": "The rounding strategies available for tax calculation, offered as choices in the settings UI.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Settings": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.ShippingTaxSettingsContract" }, "nullable": true, "description": "The saved shipping and tax configuration, one entry per currency-country market.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.TaxAppliesContract": { "title": "DXP.OpenAPI.v2.Contracts.EcommerceSettings.TaxAppliesContract", "type": "object", "properties": { "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "readOnly": true, "description": "Display name of the tax applies, shown to users.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "TaxAppliesEnumeration": { "$ref": "#/components/schemas/eCommerce.BusinessModel.TaxAppliesEnumeration", "description": "Which entity a tax rate can be charged on. ShippingOptions applies tax to shipping charges. GiftVouchers applies it to gift voucher purchases.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.TaxRoundingStrategyContract": { "title": "DXP.OpenAPI.v2.Contracts.EcommerceSettings.TaxRoundingStrategyContract", "type": "object", "properties": { "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "readOnly": true, "description": "Display name of the tax rounding strategy, shown to users.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "TaxRoundingStrategy": { "$ref": "#/components/schemas/eCommerce.BusinessModel.TaxRoundingStrategy", "description": "How tax amounts are rounded. WithErrorCompensation adjusts rounding across line items so the total tax matches the expected sum. WithoutErrorCompensation rounds each line independently.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EcommerceSettings.TaxSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.EcommerceSettings.TaxSettingsContract", "type": "object", "properties": { "TaxAppliesTo": { "title": "DXP.System.Collections.Generic.IList`1", "type": "array", "items": { "$ref": "#/components/schemas/eCommerce.BusinessModel.TaxAppliesEnumeration" }, "nullable": true, "description": "The entities tax is charged on for this market, chosen from shipping options and gift vouchers.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "AutoSelectTaxIfOnlyOneOptionalAvailable": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the single available tax option is selected automatically at checkout instead of prompting the customer.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "HideIfOnlyOneTaxInTheList": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the tax selector is hidden from the customer if only one tax option exists.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "EnableTaxDrop": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable tax drop is on.", "x-doc-source": "rule" }, "TaxRoundingStrategy": { "$ref": "#/components/schemas/eCommerce.BusinessModel.TaxRoundingStrategy", "description": "How tax amounts are rounded for this market. WithErrorCompensation adjusts rounding across line items so the total matches the expected sum. WithoutErrorCompensation rounds each line independently.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EditContactContract": { "title": "DXP.OpenAPI.v2.Contracts.EditContactContract", "required": [ "Email", "FirstName" ], "type": "object", "properties": { "Email": { "title": "DXP.System.String", "maxLength": 1000, "minLength": 1, "type": "string", "format": "email", "description": "Primary contact identifier. Must be unique in the system. Email validity verification is performed." }, "FirstName": { "title": "DXP.System.String", "maxLength": 1000, "minLength": 1, "type": "string", "description": "Client's first name." }, "LastName": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Client's last name." }, "CrmType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.CrmType", "description": "Defines the access level. Member: client with access (if password is provided). Contact: regular lead or record in the database." }, "Role": { "$ref": "#/components/schemas/eCommerce.BusinessModel.MemberRole", "description": "Role in the system or position. General: by default. Nullable: false." }, "Address": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Physical address (street, house number)." }, "City": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "City of residence." }, "State": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Province, state, or region." }, "ZipCode": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Postal code." }, "Country": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Country (it is recommended to use ISO codes)." }, "BillingAddress": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Billing address (may match the physical address)." }, "BillingCity": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Billing address city." }, "BillingState": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Province/state of the billing address." }, "BillingZipCode": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Billing address postal code." }, "BillingCountry": { "title": "DXP.System.String", "maxLength": 10, "type": "string", "nullable": true, "description": "Billing address country." }, "Site": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "URL of the contact's or company's website." }, "Phone": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Phone number (E.164 format recommended)." }, "Status": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Contact lifecycle (for example: Active, Lead, Archived)." }, "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Arbitrary internal administrator notes about this contact." }, "Type": { "$ref": "#/components/schemas/Treepl.CMS.Core.Enums.CustomerType", "description": "Classification. Consumer: by default. Nullable: false." }, "IsDataUsingAllowed": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Consent to data processing. A key parameter for GDPR. True allows marketing communications." }, "CustomCrmGroups": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Shared.Contracts.DefaultCrmGroupContract" }, "nullable": true, "example": { "": { "": "", "": false, "": 0 } }, "description": "Custom fields. An object containing additional properties grouped by technical names (for example, hobbies or specific settings). This is a dynamic section, where keys (for example, at-api-crm-group) correspond to internal identifiers of field groups in your CRM. Films (string): Example of a text field (for example, movie preferences) and depending on the settings, may be required. Field types are." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EditModuleContract": { "title": "DXP.OpenAPI.v2.Contracts.EditModuleContract", "required": [ "AdvancedOptions", "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the edit module." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Is a critically important system identifier. Is a static string used by the software to reference the module. Cannot be empty/absent (nullable: false)." }, "Title": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Module title for the interface." }, "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Free-text notes for internal use." }, "MediaFolder": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "This is the folder that is displayed by default in the media manager when selecting content for this module." }, "NewItemButtonValue": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Text that will be displayed on the button for creating a new item." }, "UrlSlug": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Part of the URL path for module items." }, "Icon": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Relative path to the icon file within the system directory or media storage." }, "LastUpdatedDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "When the record was last updated (ISO 8601). Read-only.", "x-doc-source": "rule" }, "IsDefault": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, marks this as the site's default module.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "SecureZones": { "title": "DXP.System.Int32[]", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "Identifiers of the secure zones the module is bound to, controlling which member groups can view its content.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "DisableDetailLayout": { "title": "DXP.System.Boolean", "type": "boolean", "description": "This is a logical toggle that determines whether elements of this module will have their own separate page on the site." }, "MediaFilesUploadFolder": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "This is a system path to the directory (folder) designed for automatic storage of media files (images, documents, videos) uploaded by users through records of this module." }, "ExtraSettings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ExtraSettingsContract", "description": "Container for additional module settings, such as change-history rollback.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "SiteUserPermissions": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteUserPermissionsContract", "description": "User permissions settings." }, "AdvancedOptions": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedOptionsContract", "description": "Advanced module settings controlling item hierarchy, tree/list views, subscriptions, and related-item behavior in the admin panel.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EditOrderContract": { "title": "DXP.OpenAPI.v2.Contracts.EditOrderContract", "required": [ "ShippingCountry" ], "type": "object", "properties": { "AWBNumber": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Intended for the Air Waybill (or any other shipment tracking/consignment number) from your freight provider." }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Currency code (e.g. USD).", "x-doc-source": "rule" }, "Country": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Country (it is recommended to use ISO codes).", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "InvoiceDate": { "title": "DXP.System.Nullable`1", "type": "string", "format": "date-time", "nullable": true, "description": "Date-time - the date and time the invoice was generated." }, "InvoiceNumber": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "A number assigned incrementally to each order." }, "MainOrderId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related main order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "MemberId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The CRM Contact who submitted the Order (this field is not editable)." }, "OrderName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The Order name is generally constructed by the name of the Form used for taking the Order then appended with the Order date." }, "PaymentState": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentState", "description": "Current payment status. Possible values: None, Succeeded, RequiresCapture, RequiresAction, Canceled, Processing, Pending." }, "StatusId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The current status of the Order. See eCommerce Settings / Manage Status for more details." }, "TrackingURL": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Intended for the URL used for consignment tracking by your freight provider." }, "ShippingZipCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The contact's shipping zipcode/postcode as entered during the checkout process." }, "ShippingState": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The contact's shipping state/territory as entered during the checkout process." }, "ShippingAddress": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The contact's shipping address line (unit/number and street) as entered during the checkout process." }, "ShippingCity": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The contact's shipping city/suburb/provence as entered during the checkout process." }, "ShippingCountry": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The contact's shipping country as entered during the checkout process." }, "GenerateInvoiceNumber": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Request only. If true, the system will automatically generate an invoice number. Missing from the response." }, "GenerateVATInvoiceNumber": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When true, the system automatically assigns a VAT invoice number to the order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EmailNotificationsContract": { "title": "DXP.OpenAPI.v2.Contracts.EmailNotificationsContract", "type": "object", "properties": { "EmailContent": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "EmailNotification setting. Responsible for the email body." }, "EmailFromAddress": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "EmailNotification setting. Sender's email address." }, "EmailSubject": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "EmailNotification setting. Responsible for the email subject." }, "FromName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "EmailNotification setting. Sender's name." }, "TemplateId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "EmailNotification setting. System email template identifier." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EmailSender.CaseNotificationRequest": { "title": "DXP.OpenAPI.v2.Contracts.EmailSender.CaseNotificationRequest", "required": [ "CaseId" ], "type": "object", "properties": { "CaseId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related case.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EmailSender.EmailNotificationRequest": { "title": "DXP.OpenAPI.v2.Contracts.EmailSender.EmailNotificationRequest", "required": [ "Email" ], "type": "object", "properties": { "Email": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Email address.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EmailSender.GiftVoucherNotificationRequest": { "title": "DXP.OpenAPI.v2.Contracts.EmailSender.GiftVoucherNotificationRequest", "required": [ "GiftVoucherId" ], "type": "object", "properties": { "GiftVoucherId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related gift voucher.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EmailSender.ModuleItemNotificationRequest": { "title": "DXP.OpenAPI.v2.Contracts.EmailSender.ModuleItemNotificationRequest", "required": [ "Email", "EmailMessageEvent", "ModuleItemId" ], "type": "object", "properties": { "Email": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Email address.", "x-doc-source": "rule" }, "ModuleItemId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related module item.", "x-doc-source": "rule" }, "EmailMessageEvent": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.EmailMessageService.Models.EmailMessageEvents", "description": "The module item lifecycle event that the notification email is sent for. Determines which template placeholders are filled from the item's data. Possible values: None, ModuleItemCreated, ModuleItemUpdated, ModuleItemDeleted, ModuleItemUpdatedDraft, ModuleItemPublishedDraft.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EmailSender.OrderNotificationRequest": { "title": "DXP.OpenAPI.v2.Contracts.EmailSender.OrderNotificationRequest", "required": [ "OrderId" ], "type": "object", "properties": { "OrderId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related order.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EmailSender.WorkflowNotificationRequest": { "title": "DXP.OpenAPI.v2.Contracts.EmailSender.WorkflowNotificationRequest", "type": "object", "properties": { "CaseId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related case.", "x-doc-source": "rule" }, "OrderId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related order.", "x-doc-source": "rule" }, "CustomWorkflowIds": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "Identifiers of custom workflows to run alongside sending the email, such as changing an order status or creating a CRM task.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateContract": { "title": "DXP.OpenAPI.v2.Contracts.EmailTemplates.EmailTemplateContract", "type": "object", "properties": { "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique identifier. Technical record number in the database. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the email template." }, "Body": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The body of the email. Typically contains HTML code with formatting, styles, and placeholders for dynamic data." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.EmailTemplates.EmailTemplateRequestContract", "required": [ "Body", "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "type": "string", "example": "string", "description": "Name of the email template." }, "Body": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The main content of the letter body must contains {{this.emailContent}} liquid tag." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract": { "title": "DXP.OpenAPI.v2.Contracts.Emails.EmailContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the email." }, "EmailTemplateId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The identifier of the visual framework (template) that defines the design (logos, footer, fonts)." }, "FromName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Sender display name." }, "FromEmail": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The system address from which the letter originates." }, "Subject": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "A message subject that clearly indicates the essence of the event." }, "Body": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Message body." }, "CreatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time of case creation in UTC. Read-only." }, "GroupName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The name of the group or category to which this letter belongs." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Emails.EmailGroupContract": { "title": "DXP.OpenAPI.v2.Contracts.Emails.EmailGroupContract", "type": "object", "properties": { "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique identifier. Technical record number in the database. Read-only." }, "Type": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Machine key of the email group, identifying its category and purpose (for example WorkflowNotification or AbandonedCartNotification).", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Display name of the email group, shown to users.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Emails.EmailGroupType": { "title": "DXP.OpenAPI.v2.Contracts.Emails.EmailGroupType", "enum": [ "WorkflowNotification", "FollowUpNotification", "AbandonedCartNotification", "RecurringReminderNotification" ], "type": "string" }, "Treepl.CMS.Public.API.v2.Contracts.Emails.EmailRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.Emails.EmailRequestContract", "required": [ "Body", "EmailGroupType", "FromEmail", "FromName", "Name", "Subject" ], "type": "object", "properties": { "EmailGroupType": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailGroupType", "description": "Specifies the category and purpose of the letter. Possible values: WorkflowNotification, FollowUpNotification, AbandonedCartNotification, RecurringReminderNotification." }, "Name": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "type": "string", "example": "string", "description": "Name of the email." }, "FromName": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Sender display name." }, "FromEmail": { "title": "DXP.System.String", "minLength": 1, "type": "string", "format": "email", "description": "The system address from which the letter originates." }, "Subject": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "A message subject that clearly indicates the essence of the event." }, "EmailTemplateId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The identifier of the visual framework (template) that defines the design (logos, footer, fonts)." }, "Body": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Message body." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Emails.EmailUpdateRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.Emails.EmailUpdateRequestContract", "required": [ "Body", "FromEmail", "FromName", "Name", "Subject" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "type": "string", "example": "string", "description": "Name of the email update." }, "FromName": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Sender display name." }, "FromEmail": { "title": "DXP.System.String", "minLength": 1, "type": "string", "format": "email", "description": "The system address from which the letter originates." }, "Subject": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "A message subject that clearly indicates the essence of the event." }, "EmailTemplateId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The identifier of the visual framework (template) that defines the design (logos, footer, fonts)." }, "Body": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Message body." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.EventBookingContract": { "title": "DXP.OpenAPI.v2.Contracts.EventBookingContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Event ID. Read-only." }, "EventId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Event ID. Connection to a specific event." }, "OrderId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related order." }, "FormId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related form." }, "MemberId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related member." }, "Allocation": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of \"allocated\" units." }, "CreatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time of case creation in UTC. Read-only." }, "CustomCrmGroups": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Shared.Contracts.DefaultCrmGroupContract" }, "nullable": true, "example": { "": { "": "", "": false, "": 0 } }, "description": "Dynamic CRM groups with custom fields." }, "Member": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.MemberShortInfoContract", "description": "The member (site user) this record is linked to." }, "Form": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CaseFormContract", "description": "Form the submission belongs to." }, "Event": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CaseEventContract", "description": "Event details for this booking." }, "EventBookingFields": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Shared.Contracts.DefaultCaseFieldContract" }, "nullable": true, "example": { "": "", "": false, "": 0 }, "description": "This is a dynamic object that contains the values of the form fields on which the EventBooking is created." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ExtraSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.ExtraSettingsContract", "type": "object", "properties": { "EnableRollback": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Setting ExtraSettings, which enables the rollback (restore) function for changes to previous versions." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerContract": { "title": "DXP.OpenAPI.v2.Contracts.FileManager.FileManagerContract", "type": "object", "properties": { "Path": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Path to the directory where the object will be created." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the file manager." }, "SizeBytes": { "title": "DXP.System.Int64", "type": "integer", "format": "int64", "description": "The size of the file in bytes." }, "Content": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Usually returns null or a truncated string in list views, but contains the file data (e.g., Base64) when requesting a specific file." }, "Extension": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The file format (e.g.,.pdf,.jpg,.zip)." }, "IsEmpty": { "title": "DXP.System.Boolean", "type": "boolean", "description": "True: The folder contains no files/subfolders, or the file is 0 bytes." }, "Url": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The public or signed permanent link to access/download the file." }, "DateUpdated": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Timestamp of the last modification." }, "IsFolder": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Logical check box." }, "SecureZoneIds": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "A collection of identifiers for Access Control Lists (ACL). It defines which membership levels or secure zones have permission to view this file. Empty by default." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerCreateContract": { "title": "DXP.OpenAPI.v2.Contracts.FileManager.FileManagerCreateContract", "required": [ "IsFolder", "Name", "Path" ], "type": "object", "properties": { "Path": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Path to the directory where the object will be created." }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the file manager." }, "Content": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Usually returns null or a truncated string in list views, but contains the file data (e.g., Base64) when requesting a specific file." }, "IsFolder": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Logical check box. True — create a new directory. False — create a file." }, "CreateWithIncrement": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Automatic resolution of name conflicts. For folders, this is typically 0 or the sum of its contents." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerDeleteContract": { "title": "DXP.OpenAPI.v2.Contracts.FileManager.FileManagerDeleteContract", "required": [ "IsFolder", "Url" ], "type": "object", "properties": { "Url": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "URL.", "x-doc-source": "rule" }, "IsFolder": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Logical check box. True — create a new directory. False — create a file." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.FileManager.FileManagerUpdateContract": { "title": "DXP.OpenAPI.v2.Contracts.FileManager.FileManagerUpdateContract", "required": [ "IsFolder", "Name", "NewName", "Path" ], "type": "object", "properties": { "NewName": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "New name to rename the file or folder to.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Path": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Path to the directory where the object will be created." }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the file manager." }, "Content": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Usually returns null or a truncated string in list views, but contains the file data (e.g., Base64) when requesting a specific file." }, "IsFolder": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Logical check box. True — create a new directory. False — create a file." }, "CreateWithIncrement": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Automatic resolution of name conflicts. For folders, this is typically 0 or the sum of its contents." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.FileManager.FileSecureZoneUpdateContract": { "title": "DXP.OpenAPI.v2.Contracts.FileManager.FileSecureZoneUpdateContract", "required": [ "IsFolder", "Url" ], "type": "object", "properties": { "Url": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "URL.", "x-doc-source": "rule" }, "IsFolder": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Logical check box. True — create a new directory. False — create a file." }, "SecureZoneIds": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Identifiers of the secure zones (membership levels) allowed to access the file or folder. Empty means no access restriction.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Forms.FormAutoresponderContract": { "title": "DXP.OpenAPI.v2.Contracts.Forms.FormAutoresponderContract", "type": "object", "properties": { "FromName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The display name of the sender (e.g., \"Support Team\" or \"Company Name\")." }, "FromEmail": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The email address the response is sent from. Must be a valid email format." }, "Subject": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The email's subject line. Often supports Liquid placeholders like {{FormName}}." }, "Body": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The main content of the email. Can contain plain text, HTML, or Liquid variables." }, "TemplateId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The ID of the global Email Design Template used to wrap the Body (header/footer)." }, "EnableEditor": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the Body, should be rendered in a WYSIWYG (Rich Text) editor in the admin panel." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Forms.FormContract": { "title": "DXP.OpenAPI.v2.Contracts.Forms.FormContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier for the field definition in the database. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Public subfield name." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Technical ID for the developer." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentFormType", "description": "System (pre-defined fields like \"Email\") or Custom (manually added fields). Possible values: Generic, SingleItem, CheckOut, Recurring, Quote." }, "IsSendConfirmEmailNotification": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, sends a confirmation email to the admin upon submission." }, "IsSendSecureZoneLoginDetailsEmail": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Automatically sends login/password if the form registers a new user." }, "IsSecureSubmission": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Encrypts or restricts the submission data for privacy compliance." }, "SubmissionFolderPath": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Path to a folder on the internal CMS server (local storage). Used for standard file access via the admin panel or file explorer." }, "FtpPath": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Path to external storage (FTP/SFTP server). Used to automatically transfer downloaded files to another server or backup platform. Read-only." }, "CreatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "The immutable date and time when the record was generated in the system. Read-only." }, "EnabledAutoresponder": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Activates or deactivates the automatic \"Thank You\" email sent to the user immediately after they submit the form." }, "Template": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The path or name of the Liquid/HTML file that controls the form's structure and styling (e.g., _layouts/contact-form.html)." }, "RecurringType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.RecurringType", "description": "For recurring forms, how often the associated payment or subscription repeats. Possible values: None, Daily, Weekly, Fortnightly, Monthly, Quarterly, HalfYearly, Yearly.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "EnableDefaultJSValidation": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the system injects built-in JavaScript to validate fields before the POST." }, "SecureZoneIds": { "title": "DXP.System.Int32[]", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "Lists the zones the user will be automatically added to after submission." }, "CustomWorkflowIds": { "title": "DXP.System.Int32[]", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "Triggers specific backend processes (e.g., Lead sync to CRM)." }, "FormFields": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormFieldContract" }, "nullable": true, "description": "A collection of objects that defines the structural building blocks of a form." }, "FormAutoresponder": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormAutoresponderContract", "description": "Defines the automated \"Thank You\" email sent to the user immediately after a successful form submission." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Forms.FormCreateContract": { "title": "DXP.OpenAPI.v2.Contracts.Forms.FormCreateContract", "required": [ "Alias", "FormFields", "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "type": "string", "example": "string", "description": "Name of the form." }, "Alias": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "pattern": "^([a-zA-Z0-9-_])*$", "type": "string", "example": "string", "description": "System reference for the form. Changing the alias will result in any existing references to the previous Form alias breaking." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentFormType", "description": "Menu item type. Possible values: Generic, SingleItem, CheckOut, Recurring, Quote.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "RecurringType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.RecurringType", "description": "Defines if this form/item repeats. Available for RecurringType = Recurring. Possible values: None, Daily, Weekly, Fortnightly, Monthly, Quarterly, HalfYearly, Yearly." }, "FormFields": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormFieldCreateContract" }, "description": "The fields that make up the form, defining what inputs the visitor sees and fills in.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Forms.FormFieldContract": { "title": "DXP.OpenAPI.v2.Contracts.Forms.FormFieldContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier for the field definition in the database. Read-only." }, "IsMandatory": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the field becomes mandatory (validation required)." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Public subfield name." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Technical ID for the developer." }, "IsEditable": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "If false, the field is rendered as read-only or hidden from the user." }, "IsComposite": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "Structural Flag: If true, this field is a container for multiple sub-inputs (defined in the Properties array)." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.FieldGroupType", "description": "System (pre-defined fields like \"Email\") or Custom (manually added fields)." }, "Properties": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormFieldPropertyContract" }, "nullable": true, "description": "A nested list of specific input elements (sub-fields) that belong to this FormField." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Forms.FormFieldCreateContract": { "title": "DXP.OpenAPI.v2.Contracts.Forms.FormFieldCreateContract", "type": "object", "properties": { "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the form field." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "System reference for the form. Changing the alias will result in any existing references to the previous Form alias breaking." }, "IsEditable": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "Whether the user can edit this field. When false it renders as read-only or hidden.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "IsComposite": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "Whether the field is a container that groups several sub-inputs listed in Properties, rather than a single input.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.FieldGroupType", "description": "Menu item type. Possible values: System, Custom, CustomCrmGroup.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Properties": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormFieldPropertyContract" }, "nullable": true, "description": "The sub-inputs that belong to this field, used when the field is composite.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Forms.FormFieldPropertyContract": { "title": "DXP.OpenAPI.v2.Contracts.Forms.FormFieldPropertyContract", "required": [ "Alias", "Name", "Type" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "type": "string", "example": "string", "description": "Public subfield name." }, "Alias": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "pattern": "^([a-zA-Z0-9-_])*$", "type": "string", "example": "string", "description": "Technical ID for the developer." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.FieldType", "description": "System (pre-defined fields like \"Email\") or Custom (manually added fields). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator." }, "IsMandatory": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the field becomes mandatory (validation required)." }, "Options": { "title": "DXP.System.String[]", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array of values for lists (Dropdown, Radio, CheckboxList)." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Forms.FormSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.Forms.FormSettingsContract", "type": "object", "properties": { "IsEnabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether the form's autoresponder or notification settings block is active.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "FromName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The display name of the sender (e.g., \"Support Team\" or \"Company Name\")." }, "FromEmail": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The email address the response is sent from. Must be a valid email format." }, "Subject": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The email's subject line. Often supports Liquid placeholders like {{FormName}}." }, "EnableEditor": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the Body, should be rendered in a WYSIWYG (Rich Text) editor in the admin panel." }, "EnableDefaultJSValidation": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the system injects built-in JavaScript to validate fields before the POST." }, "Body": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The main content of the email. Can contain plain text, HTML, or Liquid variables." }, "TemplateId": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "The ID of the global Email Design Template used to wrap the Body (header/footer)." }, "IsSecureSubmission": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Encrypts or restricts the submission data for privacy compliance." }, "SubmissionFolderPath": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Path to a folder on the internal CMS server (local storage). Used for standard file access via the admin panel or file explorer." }, "CustomWorkflowIds": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "Triggers specific backend processes (e.g., Lead sync to CRM)." }, "SecureZoneIds": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "Lists the zones the user will be automatically added to after submission." }, "IsSendSecureZoneLoginDetailsEmail": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Automatically sends login/password if the form registers a new user." }, "IsSendConfirmEmailNotification": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, sends a confirmation email to the admin upon submission." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Forms.FormUpdateContract": { "title": "DXP.OpenAPI.v2.Contracts.Forms.FormUpdateContract", "required": [ "Alias", "FormFields", "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "type": "string", "example": "string", "description": "Name of the form." }, "Alias": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "pattern": "^([a-zA-Z0-9-_])*$", "type": "string", "example": "string", "description": "System reference for the form. Changing the alias will result in any existing references to the previous Form alias breaking." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentFormType", "description": "Menu item type. Possible values: Generic, SingleItem, CheckOut, Recurring, Quote.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "RecurringType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.RecurringType", "description": "Defines if this form/item repeats. Available for RecurringType = Recurring. Possible values: None, Daily, Weekly, Fortnightly, Monthly, Quarterly, HalfYearly, Yearly." }, "FormFields": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormFieldContract" }, "description": "The full set of fields to save for the form, replacing the existing field layout on update.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.FrontendApiRestrictionSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.FrontendApiRestrictionSettingsContract", "type": "object", "properties": { "NotificationSettings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.NotificationSettingsContract", "description": "Defines the logic of automatic notifications when a restriction is triggered or an action is performed." }, "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier of the restriction rule. Read-only." }, "Enable": { "title": "DXP.System.Boolean", "type": "boolean", "description": "EmailNotification setting. Whether Email sending is enabled." }, "FrontendApiRestrictionType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.FrontendApiRestrictionType", "description": "The type of operation to which the restriction is applied. Possible values: AddItems, DeleteItems, EditDraftItems, EditItems, PublishDraftItems, GoogleEvent, SecureZoneSubscribers." }, "HasOwnership": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether ownership rights to the object are considered when checking access." }, "OwnershipRestriction": { "$ref": "#/components/schemas/eCommerce.BusinessModel.OwnershipRestriction", "description": "Defines the access level based on ownership rights. Possible values: OnlyOwnerAllowed, AnyoneAllowed." }, "UserTypeApiRestriction": { "$ref": "#/components/schemas/eCommerce.BusinessModel.UserTypeApiRestriction", "description": "The category of users to which the rule applies. Possible values: LoggedInUser, UserFromSecureZone, AdminUser." }, "SecureZones": { "title": "DXP.System.Int32[]", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "List of security zone identifiers for which this rule applies." }, "Title": { "title": "DXP.System.String", "type": "string", "nullable": true, "readOnly": true, "description": "A user-friendly name for the rule (for example, \"Create Module Item\")." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.GiftVoucherContract": { "title": "DXP.OpenAPI.v2.Contracts.GiftVoucherContract", "type": "object", "properties": { "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "'ShippingInfo' recipient's name." }, "Cost": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "'ShippingInfo' the cost of delivery services. Added to the cost of goods to form TotalCost." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherContract": { "title": "DXP.OpenAPI.v2.Contracts.GiftVouchers.GiftVoucherContract", "required": [ "Name" ], "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Balance": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Any remaining value of the voucher(ie:if not used in full with previous order/s). For shop created vouchers, a link will be available here to the related customers Order)" }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the gift voucher." }, "Amount": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The total value of the gift voucher." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Uncheck this option to disable the item from being usable in the website shopping cart." }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The currency in which you want the gift voucher created in." }, "OrderId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The order ID to which the certificate is linked (if it was purchased through the cart)." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.GiftVoucherType", "description": "For shop created vouchers the value will be 'Via Shop'. Admin created vouchers will have a value of 'Manual'. This can not be edited." }, "Recipient": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.RecipientContract", "description": "The person the voucher is issued to, holding their name, email, and personal message.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.GiftVouchers.GiftVoucherRequestContract", "required": [ "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "The recipient's name(can be full name or just first name,or even a nickname. It's up to you)." }, "Amount": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The total value of the gift voucher. Must be greater than 0." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Uncheck this option to disable the item from being usable in the website shopping cart." }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The currency in which you want the gift voucher created in." }, "OrderId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The order ID to which the certificate is linked (if it was purchased through the cart)." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.GiftVoucherType", "description": "For shop created vouchers the value will be 'Via Shop'. Admin created vouchers will have a value of 'Manual'. This can not be edited." }, "Recipient": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.RecipientContract", "description": "The person the voucher is issued to. Carries the recipient's name, email address, and an optional personal message (which supports Liquid).", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.RecipientContract": { "title": "DXP.OpenAPI.v2.Contracts.GiftVouchers.RecipientContract", "type": "object", "properties": { "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the recipient." }, "Email": { "title": "DXP.System.String", "type": "string", "format": "email", "nullable": true, "description": "The recipient's email address." }, "Message": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Any personal message to the recipient." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract": { "title": "DXP.OpenAPI.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "GroupId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The unique ID of the Property Group (tab or section) where this specific property belongs." }, "CreatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Timestamp of when this record was created. Read-only." }, "LiquidOutput": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The full Liquid tag used to render the property's value (e.g., {{ item. Properties['MyAlias']. Value }})." }, "LiquidShortOutput": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Shorthand Liquid tag for rendering this global property's value, omitting the full object path for cleaner code (for example {{ MyAlias }}).", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "HTMLLiquidOutput": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Liquid snippet wrapped in basic HTML formatting." }, "HTMLLiquidShortOutput": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "A Liquid tag already wrapped in HTML tags (e.g., {{ShortAlias}}). It is used for quick UI generation." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the global variables property." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "The Liquid reference that can be used to access this Properties value." }, "ShortAlias": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Technical alias — a machine-readable key.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "SortOrder": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Controls the display sequence in the admin UI or frontend list." }, "Type": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.SiteGlobalsPropertyType", "description": "The data field type used for inputting and storing the Property value. Possible values: DateTime, Media, Textbox, TextboxMultiple." }, "Value": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The actual content stored in this field." }, "HTMLAlias": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "A version of the Alias optimized for HTML. Usually replaces dots or underscores with hyphens to match CSS/HTML standards." }, "ShortHTMLAlias": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "A compact, minified version of the HTML identifier. Used to keep the DOM lean or for specific internal JS selectors." }, "Layout": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Defines a specific template or visual style for this property." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract": { "title": "DXP.OpenAPI.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyGroupContract", "required": [ "Alias", "EnableOse", "EnableToolbox", "Name", "ShortAlias" ], "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "CreatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Timestamp of when this record was created. Read-only." }, "Properties": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GlobalVariablesPropertyGroup.GlobalVariablesPropertyContract" }, "nullable": true, "description": "A collection of custom fields (attributes) associated with this item." }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the global variables property group." }, "Alias": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "The Liquid reference that can be used to access this Properties value." }, "ShortAlias": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Technical alias — a machine-readable key.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "EnableOse": { "title": "DXP.System.Nullable`1", "type": "boolean", "description": "Activates On-Screen Editing. Allows admins to edit content directly on the frontend." }, "EnableToolbox": { "title": "DXP.System.Nullable`1", "type": "boolean", "description": "Enables the side Toolbox/Widget bar for this specific module or layout. ." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.MemberShortInfoContract": { "title": "DXP.OpenAPI.v2.Contracts.MemberShortInfoContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "'Member' a unique user identifier in the system. Read-only." }, "Email": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'Member' contact email to which notifications about order status and invoices are sent." }, "FirstName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'Member' buyer's name." }, "LastName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'Member' buyer's last name." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.MemberSnapshotContract": { "title": "DXP.OpenAPI.v2.Contracts.MemberSnapshotContract", "type": "object", "properties": { "Email": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'Member' contact email to which notifications about order status and invoices are sent." }, "FirstName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'Member' buyer's name." }, "LastName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'Member' buyer's last name." }, "BillingAddress": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The billing street address captured on the order at the time it was placed.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "BillingCity": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The billing city captured on the order at the time it was placed.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "BillingState": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The billing state or region captured on the order at the time it was placed.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "BillingZipCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The billing postal code captured on the order at the time it was placed.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "BillingCountry": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The billing country captured on the order at the time it was placed.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupContract": { "title": "DXP.OpenAPI.v2.Contracts.Menus.LayoutGroupContract", "required": [ "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 50, "minLength": 2, "pattern": "^[a-zA-Z0-9()\\-\\s]+$", "type": "string", "example": "string", "description": "Name of the layout group." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Menus.LayoutGroupItemContract": { "title": "DXP.OpenAPI.v2.Contracts.Menus.LayoutGroupItemContract", "required": [ "ItemName", "LayoutGroup" ], "type": "object", "properties": { "ItemContent": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "HTML/Liquid layout code. Contains the markup that will be rendered on the page." }, "ItemName": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Text label shown for the menu item." }, "LayoutGroup": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Group binding: Determines where this layout will be available for selection." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Menus.MenuRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.Menus.MenuRequestContract", "required": [ "Alias", "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 50, "minLength": 2, "pattern": "^[a-zA-Z0-9()\\-\\s]+$", "type": "string", "example": "string", "description": "Name of the menu." }, "Alias": { "title": "DXP.System.String", "maxLength": 50, "minLength": 2, "pattern": "^([^\\.])([^\\/:*?\"<>|])*?([^\\.])$", "type": "string", "example": "string", "description": "A technical unique key or system name. Used by the frontend to bind icons, styles, or section switching logic without binding to the localization of the name. Alias - unique within one menu level." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Menus.UpdateLayoutGroupContract": { "title": "DXP.OpenAPI.v2.Contracts.Menus.UpdateLayoutGroupContract", "required": [ "NewName", "OldName" ], "type": "object", "properties": { "OldName": { "title": "DXP.System.String", "maxLength": 50, "minLength": 2, "pattern": "^[a-zA-Z0-9()\\-\\s]+$", "type": "string", "example": "string", "description": "Current name of the layout group being renamed, used to locate the group to update.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "NewName": { "title": "DXP.System.String", "maxLength": 50, "minLength": 2, "pattern": "^[a-zA-Z0-9()\\-\\s]+$", "type": "string", "example": "string", "description": "New name to assign to the layout group.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.MobileAuth.IsDeviceRefisteredRequest": { "title": "DXP.OpenAPI.v2.Contracts.MobileAuth.IsDeviceRefisteredRequest", "type": "object", "properties": { "KeyId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Identifier of the related key.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleCategoryDataContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleCategoryDataContract", "type": "object", "properties": { "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "System name of the module (technical name)." }, "ItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of items.", "x-doc-source": "rule" }, "FullName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Full category name including its parent path, showing where the category sits in the hierarchy. Read-only.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Url": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "URL.", "x-doc-source": "rule" }, "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier of the restriction rule. Read-only." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier of the restriction rule. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "System name of the module (technical name)." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Alias (nickname) used for programmatic access to the module." }, "Title": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "A user-friendly name for the rule (for example, \"Create Module Item\")." }, "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Arbitrary technical notes or description of the module's purpose." }, "MediaFolder": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Folder name or path to the directory where media files of this module are stored." }, "NewItemButtonValue": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The text displayed on the button for creating a new module item." }, "UrlSlug": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "User-friendly part of the URL for accessing module resources." }, "Icon": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Path to the icon file (usually in SVG format) that visualizes the module in the menu." }, "LastUpdatedDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time of the last update to the module configuration. Read-only." }, "IsDefault": { "title": "DXP.System.Boolean", "type": "boolean", "description": "A boolean flag that indicates whether this module is the default module." }, "SecureZones": { "title": "DXP.System.Int32[]", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "List of security zone identifiers for which this rule applies." }, "ExtraSettings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ExtraSettingsContract", "description": "Container for additional specific settings." }, "SiteUserPermissions": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteUserPermissionsContract", "description": "User permissions settings." }, "AdvancedOptions": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedOptionsContract", "description": "Advanced module parameters." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeContract", "required": [ "AttributeType", "Name" ], "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The identifier of a specific option. Options setting. Read-only." }, "Options": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionContract" }, "nullable": true, "description": "The name of the option presented within the Attribute group input." }, "AttributeType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.AttributeType", "description": "Attribute type. Possible values: Checkbox, Dropdown, Radiolist, UserInput.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "IsInventory": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Allows the attribute groups options to be added to the inventory control when inventory 'variations' are generated." }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "The title for the attribute group." }, "Required": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Turns on validation for the attribute group, enforcing the user to select one of its options before adding to the cart." }, "ValueType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.AttributeValueType", "description": "Fixed price (currently the only option) allows attribute options to have a set price that increases the main product price when selected. Possible values: FixedPrice." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionContract", "required": [ "Name" ], "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The identifier of a specific option. Options setting. Read-only." }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "The title for the attribute group." }, "Image": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Allows the addition of an image to depict the option." }, "OptionPrices": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.OptionPriceContract" }, "nullable": true, "description": "Price list for different markets." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeOptionRequestContract", "required": [ "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "The title for the attribute group." }, "Image": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Allows the addition of an image to depict the option. Use the 'add file' icon () to browse for or upload an image file." }, "OptionPrices": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.OptionPriceContract" }, "nullable": true, "description": "Price list for different markets." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeRequestContract", "required": [ "AttributeType", "Name" ], "type": "object", "properties": { "AttributeType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.AttributeType", "description": "Attribute type. Possible values: Checkbox, Dropdown, Radiolist, UserInput.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "IsInventory": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Allows the attribute groups options to be added to the inventory control when inventory 'variations' are generated." }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "The title for the attribute group." }, "Required": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Turns on validation for the attribute group, enforcing the user to select one of its options before adding to the cart." }, "ValueType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.AttributeValueType", "description": "Fixed price (currently the only option) allows attribute options to have a set price that increases the main product price when selected. Possible values: FixedPrice." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.OptionPriceContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItemAttributes.OptionPriceContract", "type": "object", "properties": { "Value": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The premium amount or fixed cost of the option." }, "CurrencyCountry": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Full name of the country for which this price is relevant." }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Two-letter currency code by standard." }, "CountryAbbriviation": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Two-letter country code." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract", "required": [ "DisplayName", "IsMain", "ItemId", "Name" ], "type": "object", "properties": { "ItemId": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "description": "A unique identifier for a product that is part of a group." }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the module item grouped item." }, "DisplayName": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Public name that the customer sees on the website." }, "IsMain": { "title": "DXP.System.Nullable`1", "type": "boolean", "description": "Determines whether this product is the main (base) product in the group." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.InventoryProductContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItemInventory.InventoryProductContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier assigned by the platform.", "x-doc-source": "rule" }, "SKUCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Stock Keeping Unit code identifying this inventory variant.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "InStock": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Current number of units of this variant available in stock.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enabled is on.", "x-doc-source": "rule" }, "Title": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Display name of this inventory variant (typically its attribute combination).", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "PreOrder": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of units of this variant available for pre-order beyond current stock.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.InventoryProductRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItemInventory.InventoryProductRequestContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier assigned by the platform.", "x-doc-source": "rule" }, "SKUCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Stock Keeping Unit code identifying this inventory variant.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "InStock": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of units of this variant to record as available in stock.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enabled is on.", "x-doc-source": "rule" }, "Title": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Display name of this inventory variant (typically its attribute combination).", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "PreOrder": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of units of this variant to make available for pre-order beyond current stock.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.ModuleItemInventoryContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItemInventory.ModuleItemInventoryContract", "type": "object", "properties": { "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enabled is on.", "x-doc-source": "rule" }, "LowStockNotification": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Stock threshold at or below which a low-stock notification is triggered.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "HasAttributes": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether the item has product attributes (such as size or color) that split its inventory into variants.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "WhenOutOfStock": { "$ref": "#/components/schemas/eCommerce.BusinessModel.WhenOutOfStock", "description": "Behavior applied to the product once its stock reaches zero. Possible values: HideProduct, EnablePreOrdering, ShowButNotAcceptOrders.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "HasGeneratedInventoryProducts": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether variant inventory records have been generated from the item's attribute combinations.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "InventoryProducts": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.InventoryProductContract" }, "nullable": true, "description": "Per-variant inventory records, each tracking its own stock, SKU, and pre-order allowance.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.ModuleItemInventoryRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItemInventory.ModuleItemInventoryRequestContract", "type": "object", "properties": { "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enabled is on.", "x-doc-source": "rule" }, "LowStockNotification": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Stock threshold at or below which a low-stock notification is triggered.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "WhenOutOfStock": { "$ref": "#/components/schemas/eCommerce.BusinessModel.WhenOutOfStock", "description": "Behavior applied to the product once its stock reaches zero. Possible values: HideProduct, EnablePreOrdering, ShowButNotAcceptOrders.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "InventoryProducts": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemInventory.InventoryProductRequestContract" }, "nullable": true, "description": "Per-variant inventory records to set, each with its own stock, SKU, and pre-order allowance.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItemRelatedItem.ModuleItemRelatedItemContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItemRelatedItem.ModuleItemRelatedItemContract", "type": "object", "properties": { "ItemId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier of the parent product in the system." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the module item related item." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItemRelatedItem.UpdateModuleItemRelatedItemContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItemRelatedItem.UpdateModuleItemRelatedItemContract", "required": [ "ItemId", "Name" ], "type": "object", "properties": { "ItemId": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "description": "Unique identifier of the parent product in the system." }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the update module item related item." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItems.CreateModuleItemPriceContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItems.CreateModuleItemPriceContract", "type": "object", "properties": { "CustomerTypeId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Customer Category ID. Allows you to set different prices for different segments." }, "TaxId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The identifier of the tax rule that applies to this price." }, "RecommendedPrice": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Recommended retail price." }, "SellPrice": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The actual selling price at which the customer purchases the product." }, "EnableVolumeDiscount": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the bulk discounts feature is activated for this product depending on the quantity." }, "TaxNeverApplies": { "title": "DXP.System.Boolean", "type": "boolean", "description": "\"No tax\" flag. If true, the system will ignore any tax charges for this item (for example, for specific product categories or exports)." }, "PriceQuantityDiscounts": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PriceQuantityDiscountContract" }, "nullable": true, "description": "Determines the price based on the number of items in the cart." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItems.ModuleItemContract", "required": [ "ModuleId", "Name", "UrlSlug" ], "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Url": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "URL-friendly identifier." }, "ItemRating": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Average rating of the object." }, "UrlList": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "A list of relative URLs (slugs) that lead to detailed pages or resources for specific module elements." }, "LastUpdatedDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "The date and time the object was last updated. Read-only." }, "ItemCategoriesIdList": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "A list of unique identifiers (IDs) of the categories to which this item belongs." }, "SiteSearchKeywordsString": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Additional keywords for this item, joined into a single comma-separated string, used to improve internal site search relevance.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "IsActiveDraft": { "title": "DXP.System.Boolean", "type": "boolean", "description": "A flag indicating the current draft status of the object." }, "EventProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemEventPropertiesModel", "description": "An object that contains additional metadata or specific properties associated with an event." }, "ProductProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemProductProperties", "description": "Product Features Collection." }, "ParentName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Parent object or category name." }, "ParentUrl": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Relative or absolute URL path to the parent object's page." }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the module item." }, "UrlSlug": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "URL-friendly identifier." }, "ParentId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the direct parent item." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether the item is active and visible in the system." }, "ReleaseDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time when the item becomes publicly available." }, "ExpiryDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time when the item expires and is no longer available." }, "Description": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Textual description of the item." }, "Weighting": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Numeric priority value used for ordering or ranking items." }, "DisableForSiteSearch": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Specifies whether the item should be excluded from the site search index." }, "SKUCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Stock Keeping Unit identifier." }, "CreatedByMemberId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the member who created the item." }, "Author": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "IIdentifier of the author associated with the item." }, "ModuleId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related module." }, "TemplateId": { "title": "DXP.System.UInt32", "type": "integer", "format": "int32", "description": "Identifier of the template used to render the item." }, "LayoutId": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": -1, "type": "integer", "format": "int32", "description": "Identifier of the layout applied to the item." }, "Parents": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "Array (integer)- an array of parent category/element IDs." }, "ItemCategories": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array (string)- list of category identifiers or names assigned to the item." }, "ItemTags": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array (string)- list of tags associated with the item for classification and filtering." }, "SiteSearchKeywords": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Additional keywords used to improve search relevance for this item." }, "CustomProperties": { "title": "DXP.System.Collections.Generic.IDictionary`2", "type": "object", "additionalProperties": { "title": "DXP.System.Object" }, "nullable": true, "description": "An object containing additional attributes specific to a given content type." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemDraftContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItems.ModuleItemDraftContract", "required": [ "ModuleId", "Name", "UrlSlug" ], "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Url": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "URL-friendly identifier." }, "ItemRating": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Average rating of the object." }, "UrlList": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "A list of relative URLs (slugs) that lead to detailed pages or resources for specific module elements." }, "LastUpdatedDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "The date and time the object was last updated. Read-only." }, "ItemCategoriesIdList": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "A list of unique identifiers (IDs) of the categories to which this item belongs." }, "SiteSearchKeywordsString": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Additional keywords for this draft item, joined into a single comma-separated string, used to improve internal site search relevance.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "IsActiveDraft": { "title": "DXP.System.Boolean", "type": "boolean", "description": "A flag indicating the current draft status of the object." }, "EventProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemEventPropertiesModel", "description": "An object that contains additional metadata or specific properties associated with an event." }, "ProductProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemProductProperties", "description": "Product Features Collection." }, "ParentName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Parent object or category name." }, "ParentUrl": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Relative or absolute URL path to the parent object's page." }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the module item draft." }, "UrlSlug": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "URL-friendly identifier." }, "ParentId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the direct parent item." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether the item is active and visible in the system." }, "ReleaseDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time when the item becomes publicly available." }, "ExpiryDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time when the item expires and is no longer available." }, "Description": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Textual description of the item." }, "Weighting": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Numeric priority value used for ordering or ranking items." }, "DisableForSiteSearch": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Specifies whether the item should be excluded from the site search index." }, "SKUCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Stock Keeping Unit identifier." }, "CreatedByMemberId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the member who created the item." }, "Author": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "IIdentifier of the author associated with the item." }, "ModuleId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related module." }, "TemplateId": { "title": "DXP.System.UInt32", "type": "integer", "format": "int32", "description": "Identifier of the template used to render the item." }, "LayoutId": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": -1, "type": "integer", "format": "int32", "description": "Identifier of the layout applied to the item." }, "Parents": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "Array (integer)- an array of parent category/element IDs." }, "ItemCategories": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array (string)- list of category identifiers or names assigned to the item." }, "ItemTags": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array (string)- list of tags associated with the item for classification and filtering." }, "SiteSearchKeywords": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Additional keywords used to improve search relevance for this item." }, "CustomProperties": { "title": "DXP.System.Collections.Generic.IDictionary`2", "type": "object", "additionalProperties": { "title": "DXP.System.Object" }, "nullable": true, "description": "An object containing additional attributes specific to a given content type." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemParentContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItems.ModuleItemParentContract", "type": "object", "properties": { "ItemId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier of the parent product in the system." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the module item parent." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemPriceContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItems.ModuleItemPriceContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "CurrencyCountry": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Geographical binding of a specific price offer." }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Currency code (e.g. USD).", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Country": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Country (it is recommended to use ISO codes).", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "CustomerTypeId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Customer Category ID. Allows you to set different prices for different segments." }, "TaxId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The identifier of the tax rule that applies to this price." }, "RecommendedPrice": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Recommended retail price." }, "SellPrice": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The actual selling price at which the customer purchases the product." }, "EnableVolumeDiscount": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the bulk discounts feature is activated for this product depending on the quantity." }, "TaxNeverApplies": { "title": "DXP.System.Boolean", "type": "boolean", "description": "\"No tax\" flag. If true, the system will ignore any tax charges for this item (for example, for specific product categories or exports)." }, "PriceQuantityDiscounts": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PriceQuantityDiscountContract" }, "nullable": true, "description": "Determines the price based on the number of items in the cart." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItems.ModuleItemSeoContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "SEOTitle": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Title used in the page's SEO metadata and shown in search-engine results.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "MetaDescription": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Meta description shown in search-engine result snippets for the item's page.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "CanonicalLink": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Canonical URL that tells search engines the preferred address for this page, avoiding duplicate-content issues.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "SocialMetaTags": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Social meta tags (such as Open Graph or Twitter Card markup) used when the item's page is shared on social networks.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "SeoPriority": { "title": "DXP.System.Double", "type": "number", "format": "double", "description": "Priority value for this page in the generated sitemap, hinting its relative importance to search engines.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "EnableAMP": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable amp is on.", "x-doc-source": "rule" }, "AMPContent": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Accelerated Mobile Pages (AMP) HTML content served for this item's page.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "ShowPageForSearchEngine": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Show page for search engine.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "OpenGraphProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoOpenGraphPropertiesContract", "description": "Open Graph properties (title, type, image, locale, URL) that control how the page appears when shared on social networks.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoOpenGraphPropertiesContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItems.ModuleItemSeoOpenGraphPropertiesContract", "type": "object", "properties": { "Image": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Image URL shown in the link preview when the page is shared on social networks.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Locale": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Locale of the page content declared in Open Graph markup (for example, en_US).", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Title": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Title shown in the link preview when the page is shared on social networks.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Type": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Open Graph object type of the page (for example, website or article).", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Url": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "URL-friendly identifier." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItems.ModuleItemSeoUpdateContract", "type": "object", "properties": { "SEOTitle": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Title used in the page's SEO metadata and shown in search-engine results.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "MetaDescription": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Meta description shown in search-engine result snippets for the item's page.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "CanonicalLink": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Canonical URL that tells search engines the preferred address for this page, avoiding duplicate-content issues.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "SocialMetaTags": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Social meta tags (such as Open Graph or Twitter Card markup) used when the item's page is shared on social networks.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "SeoPriority": { "title": "DXP.System.Double", "type": "number", "format": "double", "description": "Priority value for this page in the generated sitemap, hinting its relative importance to search engines.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "EnableAMP": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable amp is on.", "x-doc-source": "rule" }, "AMPContent": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Accelerated Mobile Pages (AMP) HTML content served for this item's page.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "ShowPageForSearchEngine": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Show page for search engine.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "OpenGraphProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemSeoOpenGraphPropertiesContract", "description": "Open Graph properties (title, type, image, locale, URL) that control how the page appears when shared on social networks.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleItems.UpdateModuleItemPriceContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleItems.UpdateModuleItemPriceContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier assigned by the platform.", "x-doc-source": "rule" }, "CustomerTypeId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Customer Category ID. Allows you to set different prices for different segments." }, "TaxId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The identifier of the tax rule that applies to this price." }, "RecommendedPrice": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Recommended retail price." }, "SellPrice": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The actual selling price at which the customer purchases the product." }, "EnableVolumeDiscount": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the bulk discounts feature is activated for this product depending on the quantity." }, "TaxNeverApplies": { "title": "DXP.System.Boolean", "type": "boolean", "description": "\"No tax\" flag. If true, the system will ignore any tax charges for this item (for example, for specific product categories or exports)." }, "PriceQuantityDiscounts": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PriceQuantityDiscountContract" }, "nullable": true, "description": "Determines the price based on the number of items in the cart." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleLayoutContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleLayoutContract", "required": [ "Name", "Type" ], "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "FtpPath": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Physical path to the template file on the server. Used for file synchronization. Read-only." }, "Name": { "title": "DXP.System.String", "maxLength": 255, "minLength": 2, "type": "string", "example": "string", "description": "Name of the module layout." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.LayoutType", "description": "The type of module that determines its functional purpose. Possible values: Detail, List." }, "Template": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Defines the visual structure and display logic of the module content." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertiesContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleProperties.ModulePropertiesContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Guid", "type": "string", "format": "uuid", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the module properties." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "The technical name (alias) used in code to refer to this property. Identical to the name." }, "Mandatory": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Determines whether a field is required." }, "SortOrder": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "A numeric value that determines the order in which the property is displayed among others in the edit form." }, "IsMultiple": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether the property can take multiple values." }, "DisplayValue": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Display value.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Text instructions or description for the content manager explaining the purpose of the Umbraco Forms field." }, "DisplayNotesInline": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Determines whether notes/tooltips will be displayed directly next to the input field." }, "DisplayDownloadableCheckbox": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Adds an option (checkbox) that allows you to mark the content of a property as downloadable." }, "EnableWysiwyg": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Includes a visual editor (WYSIWYG) for this property, allowing you to format the text." }, "EnableCodeEditor": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "Activates the code editor (with syntax highlighting) instead of plain text." }, "PreValues": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array (string) - array of preset values." }, "EditorAlias": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Technical identifier (alias) of a specific property editor." }, "Value": { "title": "DXP.System.Object", "nullable": true, "description": "Whether this permission is granted for the role.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Indexer": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Technical indexer key used to reference this property's value in Liquid templates and internally.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Unique": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, values entered for this property must be unique across all items in the module.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyCreateRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleProperties.ModulePropertyCreateRequestContract", "required": [ "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the module property create." }, "Mandatory": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Determines whether a field is required." }, "IsMultiple": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether the property can take multiple values. Available for: [ List (Dropdown List) ] by default: false." }, "DisplayNotesInline": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Determines whether notes/tooltips will be displayed directly next to the input field." }, "DisplayDownloadableCheckbox": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Adds an option (checkbox) that allows you to mark the content of a property as downloadable. Available for: [ Media ] by default: false." }, "EnableWysiwyg": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Includes a visual editor (WYSIWYG) for this property, allowing you to format the text. Available for: [ Multiline (Text)] by default: false." }, "SortOrder": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "A numeric value that determines the order in which the property is displayed among others in the edit form." }, "EnableCodeEditor": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "Activates the code editor (with syntax highlighting) instead of plain text. Available for: [ Multiline (Text) ] by default: false." }, "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Text instructions or description for the content manager explaining the purpose of the Umbraco Forms field." }, "EditorAlias": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Technical identifier (alias) of a specific property editor." }, "PreValues": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array (string) - array of preset values available for: [ Data Source, List (Checkbox List), List (Dropdown List), List (Radio List) ]" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleProperties.ModulePropertyDefaultsContract", "type": "object", "properties": { "CategoriesRootId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Identifier of the related categories root.", "x-doc-source": "rule" }, "DefaultTemplate": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Identifier or name of the template applied by default to new items in the module.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "DisableItemsForSiteSearch": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether disable items for site search is on.", "x-doc-source": "rule" }, "EnableAuthor": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable author is on.", "x-doc-source": "rule" }, "EnableCategories": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable categories is on.", "x-doc-source": "rule" }, "EnableExpirationDate": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable expiration date is on.", "x-doc-source": "rule" }, "EnableMultipleDetailLayout": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable multiple detail layout is on.", "x-doc-source": "rule" }, "EnableReleaseDate": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable release date is on.", "x-doc-source": "rule" }, "EnableTags": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable tags is on.", "x-doc-source": "rule" }, "EnableWeighting": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable weighting is on.", "x-doc-source": "rule" }, "ItemExpiry": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Default number of days after which new items in the module expire.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "SeoPriority": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Default sitemap priority assigned to new items in the module.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ShowNewItemsForSearchEngines": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Show new items for search engines.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleProperties.ModulePropertyRequestContract", "required": [ "Alias", "Name" ], "type": "object", "properties": { "Alias": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Machine-readable alias for the module property.", "x-doc-source": "rule" }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the module property." }, "Mandatory": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Determines whether a field is required." }, "IsMultiple": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether the property can take multiple values. Available for: [ List (Dropdown List) ] by default: false." }, "DisplayNotesInline": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Determines whether notes/tooltips will be displayed directly next to the input field." }, "DisplayDownloadableCheckbox": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Adds an option (checkbox) that allows you to mark the content of a property as downloadable. Available for: [ Media ] by default: false." }, "EnableWysiwyg": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Includes a visual editor (WYSIWYG) for this property, allowing you to format the text. Available for: [ Multiline (Text)] by default: false." }, "SortOrder": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "A numeric value that determines the order in which the property is displayed among others in the edit form." }, "EnableCodeEditor": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "Activates the code editor (with syntax highlighting) instead of plain text. Available for: [ Multiline (Text) ] by default: false." }, "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Text instructions or description for the content manager explaining the purpose of the Umbraco Forms field." }, "EditorAlias": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Technical identifier (alias) of a specific property editor." }, "PreValues": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array (string) - array of preset values available for: [ Data Source, List (Checkbox List), List (Dropdown List), List (Radio List) ]" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ModuleProperties.ModulePropertyResponseContract": { "title": "DXP.OpenAPI.v2.Contracts.ModuleProperties.ModulePropertyResponseContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Guid", "type": "string", "format": "uuid", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the module property." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "The technical name (alias) used in code to refer to this property. Identical to the name." }, "Mandatory": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Determines whether a field is required." }, "SortOrder": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "A numeric value that determines the order in which the property is displayed among others in the edit form." }, "IsMultiple": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether the property can take multiple values." }, "DisplayValue": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Display value.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Text instructions or description for the content manager explaining the purpose of the Umbraco Forms field." }, "EnableWysiwyg": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Includes a visual editor (WYSIWYG) for this property, allowing you to format the text." }, "PreValues": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array (string) - array of preset values." }, "EditorAlias": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Technical identifier (alias) of a specific property editor." }, "Value": { "title": "DXP.System.Object", "nullable": true, "description": "Whether this permission is granted for the role.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.NotificationSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.NotificationSettingsContract", "type": "object", "properties": { "CustomWorkflowIds": { "title": "DXP.System.Int32[]", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "An array of identifiers for custom workflows (Workflows) that are triggered automatically." }, "EmailNotification": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailNotificationsContract", "description": "Email settings. Relates to the NotificationSettings object." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.OrderContract": { "title": "DXP.OpenAPI.v2.Contracts.OrderContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "'Member' a unique user identifier in the system. Read-only." }, "AWBNumber": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Intended for the Air Waybill (or any other shipment tracking/consignment number) from your freight provider." }, "CurrencyCountry": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The Currency/Country pair used for the payment processing (this field is not editable)." }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Order currency code." }, "Country": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'ShippingInfo' the contact's shipping country as entered during the checkout process." }, "InvoiceDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date-time - the date and time the invoice was generated." }, "InvoiceNumber": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "A number assigned incrementally to each order." }, "VATInvoiceNumber": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "The VAT invoice number assigned to the order for tax reporting.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "InvoiceCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Formatted identifier." }, "IsDeleted": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Soft delete flag for the order." }, "IsRecurring": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether this order is a recurring payment (auto-renewal or subscription)." }, "MainOrderId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related main order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "MemberId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The CRM Contact who submitted the Order (this field is not editable)." }, "OrderName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The Order name is generally constructed by the name of the Form used for taking the Order then appended with the Order date." }, "PaymentState": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentState", "description": "Current payment status. Possible values: None, Succeeded, RequiresCapture, RequiresAction, Canceled, Processing, Pending." }, "StatusId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The current status of the Order. See eCommerce Settings / Manage Status for more details." }, "TotalCost": { "title": "DXP.System.Double", "type": "number", "format": "double", "description": "The total amount or the Order (this field is not editable)." }, "CreatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date-time - the date and time the Order was created in the CRM (this field is not editable). Read-only." }, "HasSubscriptions": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether the order contains at least one product that is a subscription (for example, access to a service for a month)." }, "HasPaidSubscription": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether this order was successfully paid for as part of a subscription." }, "TrackingURL": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Intended for the URL used for consignment tracking by your freight provider." }, "TransactionId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique transaction identifier from the payment gateway." }, "AmountPaid": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The amount that has already been actually received by the system. When it equals TotalCost, the order is considered fully paid." }, "AmountPending": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "An amount that is pending (for example, a bank transfer that has not yet been confirmed or a card hold)." }, "OrderCaseType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.OrderCaseType", "description": "Order category for internal processing. Possible values: FormCase, EventCase, None." }, "StatusShort": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusShortContract", "description": "This is a mapping object that decodes the system StatusId." }, "Discount": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountContract", "description": "Discount amount (promotional codes, promotions)." }, "GiftVoucher": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVoucherContract", "description": "Amount paid with a gift certificate." }, "Tax": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderTaxContract", "description": "Tax amount. May be included in the price or added on top depending on the region." }, "ShippingInfo": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingInfoContract", "description": "This is an object that contains detailed information about logistics and delivery address." }, "Member": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.MemberShortInfoContract", "description": "Contains basic information about the customer who placed the order." }, "MemberSnapshot": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.MemberSnapshotContract", "description": "A frozen copy of the customer's details as they were when the order was placed, preserved even if the contact later changes.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "OrderLines": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderLineContract" }, "nullable": true, "description": "List of product items in the order." }, "Payments": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentContract" }, "nullable": true, "description": "Transaction history for this order. Allows you to track multiple payment attempts (for example, if the first was declined and the second was successful). Contains payment details and dates." }, "CustomCrmGroups": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Shared.Contracts.DefaultCrmGroupContract" }, "nullable": true, "example": { "": { "": "", "": false, "": 0 } }, "description": "JSON object for custom CRM metadata. Used to group customers or orders by specific marketing tags (e.g. \"VIP\", \"Black Friday Hunter\")." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.OrderLineContract": { "title": "DXP.OpenAPI.v2.Contracts.OrderLineContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "'Member' a unique user identifier in the system. Read-only." }, "EntityType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.EntityType", "description": "Entity type. Possible values: Form, ModuleItem, SecureZoneSubscription." }, "ProductId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique system identifier of the product. Used to synchronize inventory balances." }, "ModuleId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The ID of the module or plugin responsible for this product type." }, "ProductName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Product name that will be displayed in the order." }, "Quantity": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The number of units of a product that the customer purchases." }, "TaxRate": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The percentage tax rate that applies to this specific product." }, "UnitPrice": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Price per unit of product at the time of order placement." }, "TotalPrice": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Total cost of the linece per unit of product at the time of order placement." }, "FileName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "File name, if this line applies to a digital product." }, "IsDownload": { "title": "DXP.System.Boolean", "type": "boolean", "description": "A flag indicating whether this item is a downloadable file." }, "Attributes": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ProductAttributeContract" }, "nullable": true, "description": "An array of additional characteristics (variations) of the selected product." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusFullContract": { "title": "DXP.OpenAPI.v2.Contracts.OrderStatuses.OrderStatusFullContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "EmailId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The ID of the email template (Email Template) that will be automatically sent to the customer when the order transitions to this status." }, "NotifyCustomer": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the customer will receive a notification about the order status change." }, "IsSystem": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether the status is system (default)." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the order status full." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.OrderState", "description": "Technical status code. Possible values: New, AwaitingPayment, Paid, PaymentFailed, PaymentCanceled, PendingCharge, Custom, ReturnRequested, PartiallyRefunded, Refunded." }, "TypeDisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "readOnly": true, "description": "Text that the user sees instead of the technical code Type." }, "Workflows": { "title": "DXP.System.Int32[]", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "An array of identifiers of automatic processes that are launched with this status." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.OrderStatuses.OrderStatusRequestContract", "required": [ "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 150, "minLength": 1, "pattern": "^[^.\\\\\\\\/:*?\\\"<>|]?[^\\\\\\\\/:*?\\\"<>|]*", "type": "string", "example": "string", "description": "Status name that the administrator and the client see." }, "NotifyCustomer": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the system will automatically send the customer a notification that the status of their order has changed." }, "Workflows": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array of business process identifiers or names." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusShortContract": { "title": "DXP.OpenAPI.v2.Contracts.OrderStatuses.OrderStatusShortContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "'Member' a unique user identifier in the system. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "'ShippingInfo' recipient's name." }, "Type": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'StatusShort' technical key (alias)." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.OrderTaxContract": { "title": "DXP.OpenAPI.v2.Contracts.OrderTaxContract", "type": "object", "properties": { "Code": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The identifier of the tax rule applied to the order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Rate": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The tax rate applied, expressed as a percentage.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.PaymentContract": { "title": "DXP.OpenAPI.v2.Contracts.PaymentContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "'Member' a unique user identifier in the system. Read-only." }, "Amount": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "This is a numeric value." }, "AmountCaptured": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The amount that was actually written off." }, "GatewayReason": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Response or status code from the payment gateway." }, "TransactionId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique transaction identifier from the payment gateway." }, "Status": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Current status of the operation." }, "PaymentType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentType", "description": "Payment method. Possible values: CreditCard, Cash, Free, Paypal, Cheque, EFT, MoneyOrder, Other, Refund." }, "PaymentGatewayType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentGatewayType", "description": "Current status of the operation. Possible values: stripe, eway, paypal, bamboraEU, authorizeNet, paypalFlow, stripeElements, braintree." }, "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Free text comment for the payment. Here you can specify the transaction number from the payment system." }, "CreatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date-time - the date and time the Order was created in the CRM (this field is not editable). Read-only." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.CurrencyCountryRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.PaymentGatewaySettings.CurrencyCountryRequestContract", "required": [ "CountryAbbreviation", "CountryId", "Currency", "CurrencyId", "Hash" ], "type": "object", "properties": { "Hash": { "title": "DXP.System.Int64", "type": "integer", "format": "int64", "description": "Technical control number to verify data integrity." }, "CurrencyId": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Internal system identifier of the country in the database." }, "Currency": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Currency code (e.g. USD).", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "CountryId": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Internal system identifier of the country in the database." }, "CountryAbbreviation": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Standard two-letter country code." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentFlowSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.PaymentGatewaySettings.PaymentFlowSettingsContract", "type": "object", "properties": { "CountryCurrency": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.CurrencyCountryContract", "description": "Determines for which market they are applied." }, "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique identifier. Technical record number in the database. Read-only." }, "Settings": { "title": "DXP.System.Object", "nullable": true, "description": "Configuration options for this resource." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentGatewayType", "description": "Provider name. Possible values: stripe, eway, paypal, bamboraEU, authorizeNet, paypalFlow, stripeElements, braintree." }, "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The name of the payment method that the customer sees at checkout." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsContract", "type": "object", "properties": { "CountryCurrency": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.CurrencyCountryContract", "description": "Determines for which market they are applied." }, "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique identifier. Technical record number in the database. Read-only." }, "Settings": { "title": "DXP.System.Object", "nullable": true, "description": "Configuration options for this resource." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentGatewayType", "description": "Provider name. Possible values: stripe, eway, paypal, bamboraEU, authorizeNet, paypalFlow, stripeElements, braintree." }, "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The name of the payment method that the customer sees at checkout." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsRequestContract", "required": [ "CountryCurrency", "Settings", "Type" ], "type": "object", "properties": { "CountryCurrency": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.CurrencyCountryRequestContract", "description": "Determines for which market they are applied." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentGatewayType", "description": "Provider name. Possible values: stripe, eway, paypal, bamboraEU, authorizeNet, paypalFlow, stripeElements, braintree." }, "Settings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentSettingsContract", "description": "Technical keys and logic." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewayToCurrencyCountryContract": { "title": "DXP.OpenAPI.v2.Contracts.PaymentGatewaySettings.PaymentGatewayToCurrencyCountryContract", "type": "object", "properties": { "CountryCurrency": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.CurrencyCountryContract", "description": "Determines for which market they are applied." }, "PaymentGatewaySettings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentGatewaySettingsContract", "description": "The payment gateway configuration bound to this currency-and-country market, including the chosen provider and its credentials.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "PaymentFlowSettings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentFlowSettingsContract", "description": "Checkout flow behavior for this market's gateway, such as two-step card capture, immediate subscription access, and how the payment form is displayed.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentProvidersSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.PaymentGatewaySettings.PaymentProvidersSettingsContract", "type": "object", "properties": { "PaymentGateways": { "title": "DXP.System.Collections.Generic.IList`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.CurrencyCountryContract" }, "nullable": true, "description": "The currency-and-country markets that have a payment gateway configured.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "PaymentTypes": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/System.ValueTuple`2[System.String,System.String]" }, "nullable": true, "description": "The available payment provider types, each paired with its display name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Endpoints": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "The gateway operating modes available for selection, such as Production and Sandbox.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "BamboraLanguage": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/System.ValueTuple`2[System.String,System.String]" }, "nullable": true, "description": "The interface languages supported by the Bambora gateway payment page, each paired with its display name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "CheckoutIntegrations": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "The available payment-form display methods, such as Redirect, Modal, and Inline.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.PaymentGatewaySettings.PaymentSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.PaymentGatewaySettings.PaymentSettingsContract", "type": "object", "properties": { "ApiKey": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions." }, "ApiSecret": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions." }, "ClientKey": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions." }, "SignatureKey": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions." }, "HashKey": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Credentials from your gateway account. Either of the Stripe Test keys or Live keys can be used here depending on if you are running test transactions or are accepting live transactions." }, "MerchantNumber": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Your unique ID in the payment gateway system." }, "CurrencyId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Internal system identifier of the country in the database." }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Currency code (e.g. USD).", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Image": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "A link to your brand logo that will be displayed on the payment page." }, "WebhooksToken": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Secret token for validating incoming messages (Webhooks) from the gateway about successful payment." }, "Password": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Additional password if the gateway requires Basic Auth or specific authorization." }, "Appearance": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "JSON string or theme name for design customization (button colors, fonts)." }, "Endpoint": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.PaymentGatewaySettings.Enums.EnvironmentEndpoint", "description": "Gateway operating mode. Possible values: Production, Sandbox." }, "TwoStepCardPayments": { "title": "DXP.System.Boolean", "type": "boolean", "description": "With this option enabled, the customer's card payment, at time of form submission, is authorised only and the funds will be captured later, after a second step has been completed - such as processing the payment from the Order details pages in the WebinOne admin once the purchase has been delivered, for example." }, "GiveAccessForSubscriptionImmediately": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Allows the client to use the service immediately after creating a subscription, without waiting for final confirmation from the bank." }, "CheckoutIntegration": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.PaymentGatewaySettings.Enums.CheckoutIntegrationType", "description": "Payment display method. Possible values: Redirect, Modal, Inline." }, "ShowSuccessPage": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether to show the default gateway successful payment page after the transaction is complete." }, "Language": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The language of the payment page interface for the customer." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.PriceQuantityDiscountContract": { "title": "DXP.OpenAPI.v2.Contracts.PriceQuantityDiscountContract", "type": "object", "properties": { "MinQuantity": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Minimum number of units after which this price starts to apply." }, "Value": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Special price per unit when the specified quantity is reached." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ProductAttributeContract": { "title": "DXP.OpenAPI.v2.Contracts.ProductAttributeContract", "type": "object", "properties": { "AttributeId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related attribute." }, "OptionsIds": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "List of selected values for this attribute." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.RequestModuleLayoutContract": { "title": "DXP.OpenAPI.v2.Contracts.RequestModuleLayoutContract", "required": [ "Name", "Type" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 255, "minLength": 2, "type": "string", "example": "string", "description": "Name of the request module layout." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.LayoutType", "description": "The type of module that determines its functional purpose. List: by default. Nullable: false." }, "Template": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Defines the visual structure and display logic of the module content." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.CurrencyCountryContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.CurrencyCountryContract", "type": "object", "properties": { "Hash": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int64", "nullable": true, "description": "Technical control number to verify data integrity." }, "CurrencyId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "This is the internal technical identifier of the currency in the database." }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The generally accepted three-letter currency code by standard." }, "CountryId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Internal system identifier of the country in the database." }, "CountryAbbreviation": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Standard two-letter country code." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.FileInformationContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.FileInformationContract", "type": "object", "properties": { "LocationPath": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The storage path where the file or folder is located.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the file information." }, "SizeBytes": { "title": "DXP.System.Int64", "type": "integer", "format": "int64", "description": "The size of the file in bytes.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Content": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The raw contents of the file, when returned inline.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Extension": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The file format identifier (e.g., pdf, mp4, zip). Used for UI icons and filtering." }, "IsEmpty": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether the file or folder has no content.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Url": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The direct path or CDN link to the hosted file (e.g., /assets/docs/manual.pdf)." }, "LastWriteTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "When the file was last modified.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "IsFolder": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether this entry is a folder rather than a file.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "SecureZoneIds": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "A list of Secure Zone IDs that have permission to view or download this file." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.OptionsContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.OptionsContract", "type": "object", "properties": { "ExpiryOptions": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "The available access-expiry options that can be applied to a subscription.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "AccessType": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Sets the access type to this Secure Zone." }, "RenuwalRate": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.PaymentIntervalStateContract" }, "nullable": true, "description": "The available renewal (billing) intervals and whether each is enabled for the secure zone.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "CountryCurrency": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.CurrencyCountryContract" }, "nullable": true, "description": "Determines for which market they are applied.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.PaymentIntervalStateContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.PaymentIntervalStateContract", "type": "object", "properties": { "AccessType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.RecurringType", "description": "Sets the access type to this Secure Zone. Possible values: None, Daily, Weekly, Fortnightly, Monthly, Quarterly, HalfYearly, Yearly." }, "IsEnable": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether this renewal interval is available for selection.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Display name of the payment interval state, shown to users.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.PriceContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.PriceContract", "type": "object", "properties": { "Value": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The numerical value of the cost." }, "CurrencyCountry": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.CurrencyCountryContract", "description": "Describes the financial and geographical anchoring of the price." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.SecureContentContract", "required": [ "Url" ], "type": "object", "properties": { "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique identifier. Technical record number in the database. Read-only." }, "Url": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The direct path or CDN link to the hosted file (e.g., /assets/docs/manual.pdf)." }, "Extension": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The file format identifier (e.g., pdf, mp4, zip). Used for UI icons and filtering." }, "SecureZoneIds": { "title": "DXP.System.Collections.Generic.IList`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "A list of Secure Zone IDs that have permission to view or download this file." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.SecureContentRequestContract", "required": [ "Url" ], "type": "object", "properties": { "Url": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The direct path or CDN link to the hosted file (e.g., /assets/docs/manual.pdf)." }, "Extension": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The file format identifier (e.g., pdf, mp4, zip). Used for UI icons and filtering." }, "SecureZoneIds": { "title": "DXP.System.Collections.Generic.IList`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "A list of Secure Zone IDs that have permission to view or download this file." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentListContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.SecureZoneContentListContract", "type": "object", "properties": { "Secured": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentUrlContract" }, "nullable": true, "description": "The content URLs that are currently protected by the secure zone and require membership to access.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "UnSecured": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentUrlContract" }, "nullable": true, "description": "The content URLs that are publicly accessible and not protected by the secure zone.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.SecureZoneContentRequestContract", "type": "object", "properties": { "ContentIds": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "An array of unique identifiers. Can contain page IDs, content blocks, or media files." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContentUrlContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.SecureZoneContentUrlContract", "type": "object", "properties": { "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique identifier. Technical record number in the database. Read-only." }, "Url": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The direct path or CDN link to the hosted file (e.g., /assets/docs/manual.pdf)." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.SecureZoneContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the secure zone." }, "LandingPageId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Selecting a Page here determines the page to redirect a user to after a Secure Zone signup form submission." }, "CountPaidSubscribers": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of users who have already paid." }, "MembersCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Total number of participants." }, "ExpiryDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Expiry timestamp (ISO 8601).", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ExpiryDateOption": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Expiry date option.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ExpiryAfter": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Expiry after.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "AccessType": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Sets the access type to this Secure Zone." }, "PaymentInterval": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "When 'Paid Access' type is applied, this option allows a billing recursion to the Secure Zone." }, "Prices": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.PriceContract" }, "nullable": true, "description": "An array of objects with prices for different currencies/countries." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberAddContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.SecureZoneMemberAddContract", "type": "object", "properties": { "SendNotification": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, the system will automatically send an email notification to each user about granting access." }, "MemberIds": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "A list of unique user IDs that are granted access." }, "SecureZonePointer": { "$ref": "#/components/schemas/Treepl.Basis.Data.VirtualPointer", "description": "Reference to the secure zone the listed members are being added to.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.SecureZoneMemberContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "FirstName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The member's first name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "LastName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The member's last name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Email": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Email address.", "x-doc-source": "rule" }, "CreatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "When the record was created (ISO 8601). Read-only.", "x-doc-source": "rule" }, "ExpiryDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Expiry timestamp (ISO 8601).", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.SecureZoneMemberRequestContract", "type": "object", "properties": { "MemberIds": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "A list of unique user IDs that are granted access." }, "SecureZonePointer": { "$ref": "#/components/schemas/Treepl.Basis.Data.VirtualPointer", "description": "Reference to the secure zone the members are being managed in.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.SecureZoneRequestContract", "required": [ "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "type": "string", "example": "string", "description": "Name of the secure zone." }, "LandingPageId": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "Selecting a Page here determines the page to redirect a user to after a Secure Zone signup form submission." }, "ExpiryDateOption": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Expiry date option.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ExpiryDateTime": { "title": "DXP.System.Nullable`1", "type": "string", "format": "date-time", "nullable": true, "description": "Expiry timestamp (ISO 8601).", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ExpiryAfter": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "Expiry after.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "AccessType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.AccessType", "description": "Sets the access type to this Secure Zone. \"Free Access\" allows subscriptions without requiring payment. \"Paid Access\" allows pricing to be assigned to the Secure Zone via subscription forms." }, "PaymentInterval": { "$ref": "#/components/schemas/eCommerce.BusinessModel.RecurringType", "description": "When 'Paid Access' type is applied, this option allows a billing recursion to the Secure Zone. \"Weekly\" billing recurs every week from initial subscription date. \"Monthly\" billing recurs every month from initial subscription date. \"Yearly\" billing recurs every year from initial subscription date. \"Daily\" billing recurs every day from initial subscription date." }, "Prices": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.PriceContract" }, "nullable": true, "description": "An array of objects with prices for different currencies/countries. Available for AccessType=Paid. If AccessType=Free, an empty array is returned." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneSecureContentContract": { "title": "DXP.OpenAPI.v2.Contracts.SecureZones.SecureZoneSecureContentContract", "type": "object", "properties": { "FolderContent": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.FileInformationContract" }, "nullable": true, "description": "Files and folders available within the secure zone's storage location.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "SecureZoneSecuredContent": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureContentContract" }, "nullable": true, "description": "The content items that have been explicitly secured behind this member area.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SetContactPasswordContract": { "title": "DXP.OpenAPI.v2.Contracts.SetContactPasswordContract", "type": "object", "properties": { "Password": { "title": "DXP.System.String", "maxLength": 1000, "type": "string", "nullable": true, "description": "Password. Pass only for Member." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ShippingInfoContract": { "title": "DXP.OpenAPI.v2.Contracts.ShippingInfoContract", "type": "object", "properties": { "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "'ShippingInfo' recipient's name." }, "Cost": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "'ShippingInfo' the cost of delivery services. Added to the cost of goods to form TotalCost." }, "Address": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'ShippingInfo' the contact's shipping address line (unit/number and street) as entered during the checkout process." }, "City": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'ShippingInfo' the contact's shipping city/suburb/provence as entered during the checkout process." }, "State": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'ShippingInfo' the contact's shipping state/territory as entered during the checkout process." }, "Zipcode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'ShippingInfo' the contact's shipping zipcode/postcode as entered during the checkout process." }, "Country": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "'ShippingInfo' the contact's shipping country as entered during the checkout process." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.SeoCountryContract": { "title": "DXP.OpenAPI.v2.Contracts.ShippingOptions.SeoCountryContract", "type": "object", "properties": { "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Internal system ID of the service. Read-only." }, "Country": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The currency setting in which the shipping option is to be used." }, "Abbreviation": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Standard two-letter code for the country (for example, US or AU).", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionContract": { "title": "DXP.OpenAPI.v2.Contracts.ShippingOptions.ShippingOptionContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Internal system ID of the service. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "The descriptive name of the shipping option that will be displayed in the shopping cart shipping dropdown." }, "Price": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "A per order value representing the starting/base price of the shipping option (further values as per below 'Settings' may be calculated along with this price)." }, "IsEnabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Is this method active for customer selection." }, "CurrencyCountry": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The currency-and-country market this shipping option is offered in.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The currency setting in which the shipping option is to be used." }, "Country": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The currency setting in which the shipping option is to be used." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.ShippingOptionType", "description": "Numeric identifier of the service category. Possible values: UserDefined, AustraliaPost, FedEx, UPS, USPS, DHL, CanadaPost, NewZealandPost." }, "TaxId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The tax ID that is applied to the shipping cost." }, "TaxNeverApplies": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system." }, "ChosenShippingProviderServices": { "title": "DXP.System.Int32[]", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system." }, "ProviderSettings": { "title": "DXP.System.Object", "nullable": true, "description": "Additional serialized settings (usually a JSON or XML string)." }, "ShippingSettings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingSettingsContract", "description": "Rules and restrictions that govern when this option appears in the cart and how its cost is calculated, such as handling charges, weight and size limits, order-value ranges, and allowed customer types and countries.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Settings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionSettingsContract", "description": "This is a set of rules and restrictions that determine when and how a shipping method appears in the cart." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionProviderServiceContract": { "title": "DXP.OpenAPI.v2.Contracts.ShippingOptions.ShippingOptionProviderServiceContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Internal system ID of the service. Read-only." }, "Code": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Technical code (e.g. Dhl_express or np_warehouse) that is sent to the provider's API." }, "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Display name of the shipping option provider service, shown to users." }, "Description": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Description of conditions." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.ShippingOptionType", "description": "Numeric identifier of the service category. Possible values: UserDefined, AustraliaPost, FedEx, UPS, USPS, DHL, CanadaPost, NewZealandPost." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionProviderSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.ShippingOptions.ShippingOptionProviderSettingsContract", "type": "object", "properties": { "ProviderSettingsTemplate": { "title": "DXP.System.Object", "nullable": true, "description": "Template describing the credential and configuration fields required by the selected integrated shipping provider, used to render the provider's settings form.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "AccountTypes": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.ShippingOption.BaseDisplayResponseModel" }, "nullable": true, "description": "This is an array of specific delivery types." }, "DeliveryConfirmations": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.ShippingOption.BaseDisplayResponseModel" }, "nullable": true, "description": "Methods of verifying that the customer has received the goods." }, "PackageType": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.ShippingOption.BaseDisplayResponseModel" }, "nullable": true, "description": "Allowed shipment formats." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.ShippingOptions.ShippingOptionRequestContract", "required": [ "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "The descriptive name of the shipping option that will be displayed in the shopping cart shipping dropdown." }, "Price": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "A per order value representing the starting/base price of the shipping option (further values as per below 'Settings' may be calculated along with this price)." }, "IsEnabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Is this method active for customer selection." }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The currency setting in which the shipping option is to be used." }, "Country": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The currency setting in which the shipping option is to be used." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.ShippingOptionType", "description": "Provider type. Possible values: UserDefined, AustraliaPost, FedEx, UPS, USPS, DHL, CanadaPost, NewZealandPost." }, "TaxId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The tax ID that is applied to the shipping cost." }, "TaxNeverApplies": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system. Available for all types except User Defined." }, "ChosenShippingProviderServices": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system. Available for all types except User Defined." }, "ProviderSettings": { "title": "DXP.System.Object", "nullable": true, "description": "Additional serialized settings (usually a JSON or XML string)." }, "Settings": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionSettingsContract", "description": "This is a set of rules and restrictions that determine when and how a shipping method appears in the cart." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.ShippingOptions.ShippingOptionSettingsContract", "type": "object", "properties": { "HandlingCharge": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "This is a fixed amount for processing the entire order." }, "AdditionalPerItemHandlingCharge": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "This is an additional fee for each unit of goods in the order." }, "MinWeight": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Physical limitations of the package (weight and dimensions) under which this method is available." }, "MaxWeight": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Physical limitations of the package (weight and dimensions) under which this method is available." }, "MinWidth": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Physical limitations of the package (weight and dimensions) under which this method is available." }, "MaxWidth": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Physical limitations of the package (weight and dimensions) under which this method is available." }, "MinHeight": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Physical limitations of the package (weight and dimensions) under which this method is available." }, "MaxHeight": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Physical limitations of the package (weight and dimensions) under which this method is available." }, "MinDepth": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Physical limitations of the package (weight and dimensions) under which this method is available." }, "MaxDepth": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Physical limitations of the package (weight and dimensions) under which this method is available." }, "MinOrderPrice": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Cart value range." }, "MaxOrderPrice": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Cart value range." }, "AllowedCustomersTypes": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "An array of customer group IDs (for example, only for \"B2B\" or \"VIP\")." }, "LimitDeliveryFollowingCountries": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "List of country codes to which delivery is made by this method." }, "ExcludeShippingForCatalogs": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "List of product category IDs for which this method is not available." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingSettingsContract": { "title": "DXP.OpenAPI.v2.Contracts.ShippingOptions.ShippingSettingsContract", "type": "object", "properties": { "Services": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingSettingsServiceContract" }, "nullable": true, "description": "This is an array of specific delivery types." }, "AccountTypes": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.ShippingOption.BaseDisplayResponseModel" }, "nullable": true, "description": "This is an array of specific delivery types." }, "DeliveryConfirmations": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.ShippingOption.BaseDisplayResponseModel" }, "nullable": true, "description": "Methods of verifying that the customer has received the goods." }, "PackageType": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Admin.Models.Common.ShippingOption.BaseDisplayResponseModel" }, "nullable": true, "description": "Allowed shipment formats." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingSettingsServiceContract": { "title": "DXP.OpenAPI.v2.Contracts.ShippingOptions.ShippingSettingsServiceContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Internal system ID of the service. Read-only." }, "Code": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Technical code (e.g. Dhl_express or np_warehouse) that is sent to the provider's API." }, "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Display name of the shipping settings service, shown to users." }, "Description": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Description of conditions." }, "Type": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Numeric identifier of the service category." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyGroupRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.SiteGlobals.GlobalVariablesPropertyGroupRequestContract", "required": [ "Alias", "EnableOse", "EnableToolbox", "Name", "ShortAlias" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "The name of the field in the interface (e.g., \"Price\", \"Color\"). What the content manager sees when filling out the form." }, "Alias": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Technical key. Used by a programmer in Liquid or the API to access a value (e.g., {{ item. Properties['color'] }})." }, "ShortAlias": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Technical alias — a machine-readable key.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "EnableOse": { "title": "DXP.System.Nullable`1", "type": "boolean", "description": "Activates On-Screen Editing. Allows admins to edit content directly on the frontend." }, "EnableToolbox": { "title": "DXP.System.Nullable`1", "type": "boolean", "description": "Enables the side Toolbox/Widget bar for this specific module or layout." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.GlobalVariablesPropertyRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.SiteGlobals.GlobalVariablesPropertyRequestContract", "required": [ "Alias", "HTMLAlias", "Layout", "Name", "ShortAlias", "ShortHTMLAlias", "Type", "Value" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "The name of the field in the interface (e.g., \"Price\", \"Color\"). What the content manager sees when filling out the form." }, "Alias": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Technical key. Used by a programmer in Liquid or the API to access a value (e.g., {{ item. Properties['color'] }})." }, "ShortAlias": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Technical alias — a machine-readable key.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Type": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.SiteGlobalsPropertyType", "description": "The data field type used for inputting and storing the Property value. Possible values: DateTime, Media, Textbox, TextboxMultiple." }, "Value": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The actual content stored in this field." }, "HTMLAlias": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "A version of the Alias optimized for HTML. Usually replaces dots or underscores with hyphens to match CSS/HTML standards." }, "ShortHTMLAlias": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "A compact, minified version of the HTML identifier. Used to keep the DOM lean or for specific internal JS selectors." }, "Layout": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Defines a specific template or visual style for this property." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SiteGlobals.SiteGlobalsPropertyType": { "title": "DXP.OpenAPI.v2.Contracts.SiteGlobals.SiteGlobalsPropertyType", "enum": [ "DateTime", "Media", "Textbox", "TextboxMultiple" ], "type": "string" }, "Treepl.CMS.Public.API.v2.Contracts.SiteUserPermissionsContract": { "title": "DXP.OpenAPI.v2.Contracts.SiteUserPermissionsContract", "type": "object", "properties": { "SpecifyExpiryDate": { "title": "DXP.System.Boolean", "type": "boolean", "description": "SiteUserPermissions setting. If true, the system allows (or requires) setting an expiration date for user access rights." }, "RequiresApproval": { "title": "DXP.System.Boolean", "type": "boolean", "description": "SiteUserPermissions setting. Determines whether user actions require prior approval by an administrator before publication or saving." }, "FrontendApiRestrictionSettings": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.FrontendApiRestrictionSettingsContract" }, "nullable": true, "description": "An array of objects describing specific restrictions for different types of operations (for example, adding, editing)." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract": { "title": "DXP.OpenAPI.v2.Contracts.Snippets.SnippetContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Internal name. Snippet name for administrators." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Technical alias. A unique key used to identify the snippet in the system without being tied to the ID." }, "Content": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Snippet body. Text or code that is rendered on the page." }, "FtpPath": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "File path. Location of the physical.html file on the server, where the snippet content is duplicated for quick system access. Read-only." }, "LiquidAlias": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Insertion code. A ready-made code fragment (Liquid syntax) that an administrator can copy and paste into any page template to display this snippet." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Status. If false, the snippet is ignored during page rendering, even if the insertion code (LiquidAlias) is present in the template." }, "CodeEditor": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Editing mode. Indicates to the admin panel interface that the content is program code and requires syntax highlighting (JS/HTML)." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.Snippets.SnippetRequestContract", "required": [ "Alias", "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Snippet name. Used to identify the block in the administrator's list (for example: \"Footer Contact Block\")." }, "Alias": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Unique alias (ID). A short text identifier by which the snippet is called in template code (for example: {% component type: \"snippet\", alias: \"header\" %}). Cannot be empty/absent (nullable: false)." }, "Content": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Snippet content. Text, HTML markup, or JavaScript code that will be inserted at the snippet call location. Nullable: true." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Activity status. Determines whether the snippet will be displayed on the site. Default: true if false, there will be an empty space instead of the snippet content." }, "CodeEditor": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Editor mode. True: in the admin panel interface, highlight content as code (HTML/JS). False: display as plain text or through a visual editor (WYSIWYG)." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailContract": { "title": "DXP.OpenAPI.v2.Contracts.SystemEmail.SystemEmailContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Technical name of the system sheet." }, "DeliveryOption": { "$ref": "#/components/schemas/eCommerce.BusinessModel.SystemEmailDeliveryOption", "description": "Templates are used as a wrapper for the system email and are handy for setting a single, consistant layout for different content/messages. Possible values: SendAlways, NeverSend, SendOnlyFirstRecurringPayment." }, "EmailTemplateId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Templates are used as a wrapper for the system email and are handy for setting a single, consistant layout for different content/messages." }, "FromName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "This is the sending name of the email sent to the recipient." }, "FromEmail": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "This is the sending email address of the email sent to the recipient." }, "Subject": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "This is the subject line of the email sent to the recipient." }, "Body": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "This is the body content of the email sent to the recipient." }, "SystemEvent": { "$ref": "#/components/schemas/eCommerce.BusinessModel.SystemEvent", "description": "The key parameter that links this letter to the system code. Possible values: PasswordRetrieveEmail, RestoreAdminUserPassword, InviteAdminUser, AdminResetMemberPassword, Invoice, OrderStatusChanged, Quote, GiftVoucher, DropShipping, FirstCartRecoveryEmail, SecondCartRecoveryEmail, LowStockNotification, InvoiceEcom, SupplierNotification, OfflineCreditCardPayment, DoubleOptInEmail, SecureZoneLoginDetails, AffiliateProgramDetails, Forums, ForumsSubscriberAlertforNewPosts, ForumsSubscriberAlertforNewTopics, CustomerServiceTicketing, WorkflowNotification, ThirdrdPartyWorkflowEmails, WorkflowTask, WorkflowCompletion, WorkflowReminder, WorkflowEscalation, WorkflowRejection, ConfirmEmailNotification, OrderStatus, TellAFriend, StorageLimitNotification, FollowUpNotification, AbandonedCartNotification, ItemsLimitNotification, CrmLimitNotification, RecurringReminderNotification." }, "DeliveryOptions": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailDeliveryOptionContract" }, "nullable": true, "description": "List of all available delivery modes for selection in the admin panel." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailDeliveryOptionContract": { "title": "DXP.OpenAPI.v2.Contracts.SystemEmail.SystemEmailDeliveryOptionContract", "type": "object", "properties": { "DisplayName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "A clear name for the administrator." }, "Value": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The technical value that is recorded in the DeliveryOption field." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.SystemEmail.SystemEmailRequestContract", "required": [ "Body", "DeliveryOption", "FromEmail", "FromName", "Name", "Subject" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 250, "minLength": 2, "type": "string", "example": "string", "description": "Technical name of the system sheet." }, "FromName": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "This is the sending name of the email sent to the recipient." }, "FromEmail": { "title": "DXP.System.String", "minLength": 1, "type": "string", "format": "email", "description": "This is the sending email address of the email sent to the recipient. If using a non-verified email domain you'll see a warning message." }, "Subject": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "This is the subject line of the email sent to the recipient." }, "EmailTemplateId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Templates are used as a wrapper for the system email and are handy for setting a single, consistant layout for different content/messages." }, "Body": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "This is the body content of the email sent to the recipient." }, "DeliveryOption": { "$ref": "#/components/schemas/eCommerce.BusinessModel.SystemEmailDeliveryOption", "description": "Templates are used as a wrapper for the system email and are handy for setting a single, consistant layout for different content/messages. Possible values: SendAlways, NeverSend, SendOnlyFirstRecurringPayment." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SystemPages.OpenGraphContract": { "title": "DXP.OpenAPI.v2.Contracts.SystemPages.OpenGraphContract", "type": "object", "properties": { "title": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Title shown in the preview card when the page is shared on social networks.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "type": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Open Graph object type of the page, such as website or article, telling social platforms how to render the preview.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "url": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "URL.", "x-doc-source": "rule" }, "locale": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Locale of the shared content, such as en_US, used by social platforms to localize the preview.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "image": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Image displayed in the preview card when the page is shared on social networks.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageContract": { "title": "DXP.OpenAPI.v2.Contracts.SystemPages.SystemPageContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Url - path to the page on the website. Name - internal name for administrator. Read-only." }, "Url": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "URL.", "x-doc-source": "rule" }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the system page.", "x-doc-source": "rule" }, "Description": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The main text and visual content of the page." }, "TemplateId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Layout template identifier. It defines the page structure: the presence of a header, footer, and sidebars into which the system page content will be embedded." }, "Enable": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Page activity status." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.SystemPages.SystemPageRequestContract", "required": [ "TemplateId" ], "type": "object", "properties": { "Description": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The main text and visual content of the page." }, "TemplateId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Layout template identifier. It defines the page structure: the presence of a header, footer, and sidebars into which the system page content will be embedded." }, "Enable": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Page activity status. If true, the page is available at its system address. If false — the page is disabled." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoContract": { "title": "DXP.OpenAPI.v2.Contracts.SystemPages.SystemPageSeoContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Url - path to the page on the website. Name - internal name for administrator. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the system page seo.", "x-doc-source": "rule" }, "SEOTitle": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Title tag shown in the browser tab and used by search engines for this system page.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "MetaDescription": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Meta description summarizing the page, used by search engines in result snippets.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "ShowPageForSearchEngine": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Show page for search engine.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "CanonicalLink": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Canonical URL that tells search engines the preferred address for this page, consolidating duplicate content.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "EnableAMP": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable amp is on.", "x-doc-source": "rule" }, "AMPContent": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Accelerated Mobile Pages markup served as the fast-loading mobile version of this system page.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "SocialMetaTags": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Extra social sharing meta tags injected into the page head for platforms that read them when the page is shared.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "SeoPriority": { "title": "DXP.System.Double", "type": "number", "format": "double", "description": "Priority hint for this page in the generated XML sitemap, signalling its relative importance to search crawlers.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Url": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "URL.", "x-doc-source": "rule" }, "OpenGraphProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.OpenGraphContract", "description": "Open Graph metadata controlling how the page appears when shared on social networks, such as the title, type, image and locale.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageSeoRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.SystemPages.SystemPageSeoRequestContract", "type": "object", "properties": { "SEOTitle": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Title tag shown in the browser tab and used by search engines for this system page.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "MetaDescription": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Meta description summarizing the page, used by search engines in result snippets.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "ShowPageForSearchEngine": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Show page for search engine.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "CanonicalLink": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Canonical URL that tells search engines the preferred address for this page, consolidating duplicate content.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "EnableAMP": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable amp is on.", "x-doc-source": "rule" }, "AMPContent": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Accelerated Mobile Pages markup served as the fast-loading mobile version of this system page.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "SocialMetaTags": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Extra social sharing meta tags injected into the page head for platforms that read them when the page is shared.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "SeoPriority": { "title": "DXP.System.Double", "maximum": 1, "minimum": 0, "type": "number", "format": "double", "description": "Priority hint for this page in the generated XML sitemap, signalling its relative importance to search crawlers.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "OpenGraphProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.OpenGraphContract", "description": "Open Graph metadata controlling how the page appears when shared on social networks, such as the title, type, image and locale.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract": { "title": "DXP.OpenAPI.v2.Contracts.Taxes.TaxContract", "required": [ "TaxCode" ], "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "TaxCode": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "A descriptive display name for the tax rate (ie: GST, VAT, OH State Tax, etc.)." }, "Country": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The shipping country this tax rate will display for when selected from the shopping cart stage." }, "Rate": { "title": "DXP.System.Decimal", "maximum": 1, "minimum": 0, "type": "number", "format": "double", "description": "A percentage value (between 0 and 100) used for the tax calculations." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.Taxes.TaxRequestContract", "required": [ "TaxCode" ], "type": "object", "properties": { "TaxCode": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "A descriptive display name for the tax rate (ie: GST, VAT, OH State Tax, etc.)." }, "Country": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The shipping country this tax rate will display for when selected from the shopping cart stage." }, "Rate": { "title": "DXP.System.Decimal", "maximum": 1, "minimum": 0, "type": "number", "format": "double", "description": "A percentage value (between 0 and 100) used for the tax calculations." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.TrashedOrderContract": { "title": "DXP.OpenAPI.v2.Contracts.TrashedOrderContract", "type": "object", "properties": { "MovedToTrashDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Moved to trash timestamp (ISO 8601).", "x-doc-source": "rule" }, "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier assigned by the platform.", "x-doc-source": "rule" }, "AWBNumber": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The Air Waybill or shipment tracking number from the freight provider, preserved on the trashed order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "CurrencyCountry": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The currency and country pair used for payment processing on this order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Currency": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Currency code (e.g. USD).", "x-doc-source": "rule" }, "Country": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Country (it is recommended to use ISO codes).", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "InvoiceDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "The date and time the invoice was generated for this order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "InvoiceNumber": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "The invoice number assigned incrementally to this order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "VATInvoiceNumber": { "title": "DXP.System.Nullable`1", "type": "integer", "format": "int32", "nullable": true, "description": "The VAT invoice number assigned to this order for tax reporting.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "InvoiceCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The formatted invoice identifier for this order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "IsDeleted": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether the order is soft-deleted.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "IsRecurring": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether the order is a recurring payment, such as an auto-renewal or subscription. True means the system created it automatically from a previous order. False means the customer placed it directly.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "MainOrderId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related main order.", "x-doc-source": "rule" }, "MemberId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related member.", "x-doc-source": "rule" }, "OrderName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The order name, usually built from the form used to place it plus the order date.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "PaymentState": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentState", "description": "The current payment status of the order. Possible values: None, Succeeded, RequiresCapture, RequiresAction, Canceled, Processing, Pending.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "StatusId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related status.", "x-doc-source": "rule" }, "TotalCost": { "title": "DXP.System.Double", "type": "number", "format": "double", "description": "The total amount of the order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "CreatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "When the record was created (ISO 8601). Read-only.", "x-doc-source": "rule" }, "HasSubscriptions": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether the order contains at least one subscription product, such as timed access to a service.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "HasPaidSubscription": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether a subscription in this order was successfully paid for.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TrackingURL": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The consignment tracking URL from the freight provider, for use in order and invoice emails.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TransactionId": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Identifier of the related transaction.", "x-doc-source": "rule" }, "AmountPaid": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Identifier of the related amount pa.", "x-doc-source": "rule" }, "AmountPending": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "The amount still awaiting confirmation, such as an unconfirmed bank transfer or a card hold.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "OrderCaseType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.OrderCaseType", "description": "The category of the order for internal processing. Possible values: FormCase, EventCase, None.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "StatusShort": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusShortContract", "description": "A compact object that decodes the numeric StatusId into a readable status name and technical key.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Discount": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountContract", "description": "Discount amount (promotional codes, promotions).", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "GiftVoucher": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVoucherContract", "description": "The gift voucher applied to the order, including the amount paid with it.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Tax": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderTaxContract", "description": "The tax applied to the order, which may be included in the price or added on top depending on the region.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "ShippingInfo": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingInfoContract", "description": "The logistics and delivery details for the order, including recipient name, shipping cost, and address.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Member": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.MemberShortInfoContract", "description": "Basic details of the customer who placed the order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "MemberSnapshot": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.MemberSnapshotContract", "description": "A frozen copy of the customer's details as they were when the order was placed.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "OrderLines": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderLineContract" }, "nullable": true, "description": "The list of product line items in the order.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Payments": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentContract" }, "nullable": true, "description": "The transaction history for the order, tracking each payment attempt with its details and date.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "CustomCrmGroups": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Shared.Contracts.DefaultCrmGroupContract" }, "nullable": true, "example": { "": { "": "", "": false, "": 0 } }, "description": "Custom CRM metadata attached to the order, used to group orders or customers by tags such as VIP or Black Friday Hunter.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.UpdateCategoryContract": { "title": "DXP.OpenAPI.v2.Contracts.UpdateCategoryContract", "required": [ "Name" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Category/subcategory name, understandable to a human, that is displayed to the user. Use a unique name for creation/editing." }, "ParentId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Parent element identifier. Use -1 to create a main (root) category. Use the ID of an existing category to create a subcategory." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.UpdateOrderLineContract": { "title": "DXP.OpenAPI.v2.Contracts.UpdateOrderLineContract", "required": [ "ProductId" ], "type": "object", "properties": { "ProductId": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "Unique system identifier of the product. Used to synchronize inventory balances." }, "ProductName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Product name that will be displayed in the order." }, "Quantity": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The number of units of a product that the customer purchases." }, "UnitPrice": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Price per unit of product at the time of order placement." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.UpdateOrderPaymentContract": { "title": "DXP.OpenAPI.v2.Contracts.UpdateOrderPaymentContract", "type": "object", "properties": { "Notes": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Free text comment for the payment. Here you can specify the transaction number from the payment system." }, "PaymentType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.PaymentType", "description": "Payment method. Possible values: CreditCard, Cash, Free, Paypal, Cheque, EFT, MoneyOrder, Other, Refund." }, "Amount": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "This is a numeric value. The value must not be less than 0." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract": { "title": "DXP.OpenAPI.v2.Contracts.UrlRedirects.UrlRedirectContract", "required": [ "Destination", "Source" ], "type": "object", "properties": { "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique identifier. Technical record number in the database. Read-only." }, "Source": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The starting address (path) from which the user should be redirected (for example, /old-product-page)." }, "Destination": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The destination address where the user should go (e.g. /new-category/product-name). This can be either a relative path or a full link." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Redirect status. True — redirection is working, false — redirection is disabled (the rule is saved in the system, but not executed)." }, "CaseInSensitive": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Case sensitivity." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.UrlRedirects.UrlRedirectRequestContract", "required": [ "Destination", "Source" ], "type": "object", "properties": { "Source": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The starting address (path) from which the user should be redirected (for example, /old-product-page)." }, "Destination": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The destination address where the user should go (e.g. /new-category/product-name). This can be either a relative path or a full link." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Redirect status. True — redirection is working, false — redirection is disabled (the rule is saved in the system, but not executed)." }, "CaseInSensitive": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Case sensitivity. If true, then the queries /PROMO and /promo will work the same. If false, the redirect will only work if the uppercase and lowercase letters match exactly." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract": { "title": "DXP.OpenAPI.v2.Contracts.UrlRewrites.UrlRewriteContract", "required": [ "RewriteTo", "RewrittenUrl" ], "type": "object", "properties": { "Id": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Unique identifier. Technical record number in the database. Read-only." }, "RewrittenUrl": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "\"Mask\" or visible address. What the user sees in the browser or types into the search bar (for example, /contacts)." }, "RewriteTo": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The actual technical path to the file or handler on the server that should execute the request (for example, /pages/static.aspx?id=12)." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Rule status. True — the rule is active and requests are being processed, false — the server ignores this rule." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.UrlRewrites.UrlRewriteRequestContract", "required": [ "RewriteTo", "RewrittenUrl" ], "type": "object", "properties": { "RewrittenUrl": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "\"Mask\" or visible address. What the user sees in the browser or types into the search bar (for example, /contacts)." }, "RewriteTo": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "The actual technical path to the file or handler on the server that should execute the request (for example, /pages/static.aspx?id=12)." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Rule status. True — the rule is active and requests are being processed, false — the server ignores this rule." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowContract": { "title": "DXP.OpenAPI.v2.Contracts.Workflows.WorkflowContract", "type": "object", "properties": { "EmailId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "The template ID of the email that will be used." }, "CreatedDateTime": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time of case creation in UTC. Read-only." }, "DisableSenderReplyTo": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "If true, the Reply-To address will be disabled in the sent message." }, "Recipients": { "title": "DXP.System.String[]", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "An array of strings specifying the recipients of the letter.ue, the Reply-To address will be disabled in the sent message." }, "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the workflow." }, "IsDefault": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, this workflow is executed automatically for all entities of this type, unless other specific rules are specified. True: by default." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowRequestContract": { "title": "DXP.OpenAPI.v2.Contracts.Workflows.WorkflowRequestContract", "required": [ "Name", "Recipients" ], "type": "object", "properties": { "Name": { "title": "DXP.System.String", "maxLength": 255, "minLength": 2, "type": "string", "example": "string", "description": "Name of the workflow." }, "EmailId": { "title": "DXP.System.Int32", "minimum": 1, "type": "integer", "format": "int32", "description": "The template ID of the email that will be used." }, "DisableSenderReplyTo": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "If true, the Reply-To address will be disabled in the sent message." }, "Recipients": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "description": "An array of strings specifying the recipients of the letter.ue, the Reply-To address will be disabled in the sent message." } }, "additionalProperties": false }, "Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowShortContract": { "title": "DXP.OpenAPI.v2.Contracts.Workflows.WorkflowShortContract", "type": "object", "properties": { "Id": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Unique identifier. Technical record number in the database. Read-only." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the workflow short." }, "IsDefault": { "title": "DXP.System.Boolean", "type": "boolean", "description": "If true, this workflow is executed automatically for all entities of this type, unless other specific rules are specified. True: by default." }, "DisableSenderReplyTo": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "If true, the Reply-To address will be disabled in the sent message." } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Interfaces.FileManager.IFileManagerResponseModel": { "title": "DXP.Public.Bll.v2.Domains.Interfaces.FileManager.IFileManagerResponseModel", "type": "object", "properties": { "Path": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Path to the directory where the object will be created." }, "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Name of the ifile manager." }, "SizeBytes": { "title": "DXP.System.Int64", "type": "integer", "format": "int64", "description": "The size of the file in bytes." }, "Content": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Usually returns null or a truncated string in list views, but contains the file data (e.g., Base64) when requesting a specific file." }, "Extension": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The file format (e.g.,.pdf,.jpg,.zip)." }, "IsEmpty": { "title": "DXP.System.Boolean", "type": "boolean", "description": "True: The folder contains no files/subfolders, or the file is 0 bytes." }, "Url": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The public or signed permanent link to access/download the file." }, "DateUpdated": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Timestamp of the last modification." }, "IsFolder": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Logical check box." }, "SecureZoneIds": { "title": "DXP.System.Collections.Generic.List`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "A collection of identifiers for Access Control Lists (ACL). It defines which membership levels or secure zones have permission to view this file. Empty by default." } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestCreateModel": { "title": "DXP.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestCreateModel", "required": [ "Name", "Settings" ], "type": "object", "properties": { "Content": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The main HTML/text content. The body of the page that the user sees in a regular browser. Supports HTML markup, scripts, and styles. Must contain the {{pageContent}} liquid tag. Cannot be empty/absent (nullable: false)." }, "IsDefault": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Defines whether this content variant is the main one. If multiple variants exist for a single URL, the system will display the one where this is enabled. Disabled by default." }, "Name": { "title": "DXP.System.String", "maxLength": 255, "minLength": 2, "type": "string", "example": "string", "description": "A human-readable name that is displayed to the user." }, "AmpContent": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Content for the AMP version. A special simplified markup for Accelerated Mobile Pages (Google's accelerated mobile pages). Used for fast loading on mobile devices. Must contain the {{pageContent}} liquid tag. Cannot be empty/absent (nullable: false)." }, "Settings": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Record.Models.ContentTemplates.ContentTemplateSettingsPublicV2", "description": "Technical configurations. A group of settings that defines which external resources and scripts will be connected to the page. Flexible resource management is provided for each parameter in Settings." } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestUpdateModel": { "title": "DXP.Public.Bll.v2.Domains.Models.ContentTemplates.ContentTemplateRequestUpdateModel", "required": [ "Name", "Settings" ], "type": "object", "properties": { "Content": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The main HTML/text content. The body of the page that the user sees in a regular browser. Supports HTML markup, scripts, and styles. Must contain the {{pageContent}} liquid tag. Cannot be empty/absent (nullable: false)." }, "IsDefault": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Defines whether this content variant is the main one. If multiple variants exist for a single URL, the system will display the one where this is enabled. Disabled by default." }, "Name": { "title": "DXP.System.String", "maxLength": 255, "minLength": 2, "type": "string", "example": "string", "description": "A human-readable name that is displayed to the user." }, "AmpContent": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Content for the AMP version. A special simplified markup for Accelerated Mobile Pages (Google's accelerated mobile pages). Used for fast loading on mobile devices. Must contain the {{pageContent}} liquid tag. Cannot be empty/absent (nullable: false)." }, "Settings": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Record.Models.ContentTemplates.ContentTemplateSettingsPublicV2", "description": "Technical configurations. A group of settings that defines which external resources and scripts will be connected to the page. Flexible resource management is provided for each parameter in Settings." } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleSimpleContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminRoles.AdminRoleSimpleContract" }, "nullable": true, "description": "The admin roles on the current page of results, each with its identifier and name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdminUsers.AdminUserContract" }, "nullable": true, "description": "The admin panel users on the current page of results.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.AdvancedCrmGroups.AdvancedCrmGroupContract" }, "nullable": true, "description": "The page of Advanced CRM groups returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.CaseContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CaseContract" }, "nullable": true, "description": "The page of CRM cases returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.CategoryContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CategoryContract" }, "nullable": true, "description": "The page of categories returned by the listing. Each entry is a full category object. The tree structure is expressed through the nested Children of each item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ContactContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContactContract" }, "nullable": true, "description": "The page of contacts returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ContentTemplates.ContentTemplateContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ContentTemplates.ContentTemplateContract" }, "nullable": true, "description": "The page of content templates returned by the listing. Each entry is a full template object with its body, settings and flags.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.CustomerTypeContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.CustomerTypeContract" }, "nullable": true, "description": "The page of customer types returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.DiscountCodes.DiscountContract" }, "nullable": true, "description": "The page of discount codes returned by the listing, one entry per code.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EmailTemplates.EmailTemplateContract" }, "nullable": true, "description": "The email templates on the current page of results.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Emails.EmailContract" }, "nullable": true, "description": "The emails on the current page of results.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.EventBookingContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.EventBookingContract" }, "nullable": true, "description": "The page of event bookings returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Forms.FormContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Forms.FormContract" }, "nullable": true, "description": "The page of forms returned by the list endpoint. Each entry is one form definition.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.GiftVouchers.GiftVoucherContract" }, "nullable": true, "description": "The page of gift vouchers returned by the listing, one entry per voucher.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Menus.MenuContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.OpenAPI.v2.Contracts.Menus.MenuContract", "type": "object", "properties": { "Id": { "type": "integer", "example": 1, "description": "Unique identifier assigned by the platform.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Name": { "type": "string", "example": "string", "description": "Human-readable name.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Alias": { "type": "string", "example": "string", "description": "Machine-readable alias.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "LiquidAlias": { "type": "string", "example": "string", "description": "Technical alias — a machine-readable key used in Liquid templates.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "MenuItemsJson": { "type": "array", "items": { "type": "object", "properties": { "ItemId": { "type": "string", "example": "string", "description": "Identifier of the related item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "ItemName": { "type": "string", "example": "string", "description": "Text label shown for the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemUrl": { "type": "string", "example": "string", "description": "The URL the menu item links to.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTargetFrame": { "type": "string", "example": "string", "description": "Target frame or window for the link (e.g. _blank opens a new tab).", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemClass": { "type": "string", "example": "string", "description": "CSS class applied to the menu item for styling.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemTitle": { "type": "string", "example": "string", "description": "Title (tooltip) text shown when hovering the menu item.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemCustomAttribute": { "type": "string", "example": "string", "description": "Custom HTML attribute added to the menu item element.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ItemEnabled": { "type": "boolean", "example": true, "description": "Whether the menu item is visible in the rendered menu.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ReleaseDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item becomes publicly available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "ExpiryDate": { "type": "string", "format": "date-time", "example": "2025-03-25T09:23:00Z", "description": "Date and time when the item expires and is no longer available.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" }, "children": { "type": "array", "items": { "type": "object" }, "description": "An array of child elements. Used to create drop-down lists or multi-level menu structures.", "x-doc-source": "ai-inferred", "x-doc-confidence": "low" } } }, "example": [ { "ItemId": "string", "ItemName": "string", "ItemUrl": "string", "ItemTargetFrame": "string", "ItemClass": "string", "ItemTitle": "string", "ItemCustomAttribute": "string", "ItemEnabled": true, "ReleaseDate": "2025-03-25T09:23:00Z", "ExpiryDate": "2025-03-25T09:23:00Z", "children": [] } ], "description": "Menu items stored as a JSON structure.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" } } }, "nullable": true, "description": "The page of menus returned by the listing. Each entry is a menu object with its name, alias and item tree.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleContract" }, "nullable": true, "description": "The page of modules returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemAttributes.ModuleItemAttributeContract" }, "nullable": true, "description": "The page of module item attributes returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemGroupedItems.ModuleItemGroupedItemContract" }, "nullable": true, "description": "The page of items grouped under this module item returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItemRelatedItem.ModuleItemRelatedItemContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItemRelatedItem.ModuleItemRelatedItemContract" }, "nullable": true, "description": "The page of items related to this module item returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemContract" }, "nullable": true, "description": "The page of module items returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemParentContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemParentContract" }, "nullable": true, "description": "The page of parent items for this module item returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemPriceContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleItems.ModuleItemPriceContract" }, "nullable": true, "description": "The page of module item price records returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ModuleLayoutContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ModuleLayoutContract" }, "nullable": true, "description": "The page of module layouts returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.OrderContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderContract" }, "nullable": true, "description": "The page of orders returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusFullContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.OrderStatuses.OrderStatusFullContract" }, "nullable": true, "description": "The page of order statuses returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.PaymentContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.PaymentContract" }, "nullable": true, "description": "The page of order payments returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneContract" }, "nullable": true, "description": "The page of secure zones (member areas) returned by the list endpoint.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SecureZones.SecureZoneMemberContract" }, "nullable": true, "description": "The page of members belonging to the secure zone.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.ShippingOptions.ShippingOptionContract" }, "nullable": true, "description": "The page of shipping options returned by the listing, one entry per option.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Snippets.SnippetContract" }, "nullable": true, "description": "The page of snippets returned by the listing. Each entry is a full snippet object with its content, alias and status.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemEmail.SystemEmailContract" }, "nullable": true, "description": "The system emails on the current page of results.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.SystemPages.SystemPageContract" }, "nullable": true, "description": "The page of system pages returned by the listing. Each entry is a system page object such as the 404, search results or checkout page.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Taxes.TaxContract" }, "nullable": true, "description": "The page of tax rates returned by the listing, one entry per tax rate.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.TrashedOrderContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.TrashedOrderContract" }, "nullable": true, "description": "The page of trashed (soft-deleted) orders returned by this listing.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRedirects.UrlRedirectContract" }, "nullable": true, "description": "The page of URL redirect rules returned by the listing. Each entry maps a source path to a destination.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.UrlRewrites.UrlRewriteContract" }, "nullable": true, "description": "The page of URL rewrite rules returned by the listing. Each entry maps a visible address to the technical path that handles it.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1[Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowShortContract]": { "title": "DXP.Public.Bll.v2.Domains.Models.EntityCollectionPublicV2`1", "type": "object", "properties": { "Items": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.API.v2.Contracts.Workflows.WorkflowShortContract" }, "nullable": true, "description": "The page of workflows returned by the listing. Each entry is a summary of an automation workflow, such as its name and email template.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "TotalItemsCount": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of total items.", "x-doc-source": "rule" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.Forms.FieldModel": { "title": "DXP.Public.Bll.v2.Domains.Models.Forms.FieldModel", "type": "object", "properties": { "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Public subfield name." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Technical ID for the developer." }, "IsEditable": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "If false, the field is rendered as read-only or hidden from the user." }, "IsComposite": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "Structural Flag: If true, this field is a container for multiple sub-inputs (defined in the Properties array)." }, "GroupType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.FieldGroupType", "description": "Where the field's group originates from, which determines how it is managed. Possible values: System, Custom, CustomCrmGroup.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Properties": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.Forms.PropertyModel" }, "nullable": true, "description": "A nested list of specific input elements (sub-fields) that belong to this FormField." } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.Forms.GroupFieldModel": { "title": "DXP.Public.Bll.v2.Domains.Models.Forms.GroupFieldModel", "type": "object", "properties": { "GroupName": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The display name of a group that bundles related fields together in the form layout.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "Fields": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.Forms.FieldModel" }, "nullable": true, "description": "The fields that belong to this group.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.Forms.PropertyModel": { "title": "DXP.Public.Bll.v2.Domains.Models.Forms.PropertyModel", "type": "object", "properties": { "Name": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Public subfield name." }, "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "Technical ID for the developer." }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.FieldType", "description": "System (pre-defined fields like \"Email\") or Custom (manually added fields). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator." }, "IsMandatory": { "title": "DXP.System.Nullable`1", "type": "boolean", "nullable": true, "description": "If true, the field becomes mandatory (validation required)." }, "Options": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array of values for lists (Dropdown, Radio, CheckboxList)." } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemEventPropertiesModel": { "title": "DXP.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemEventPropertiesModel", "type": "object", "properties": { "HideWhenFull": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the event is hidden from the site once its capacity is fully booked.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "AllowMultipleSubscriptionPerEmail": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether allow multiple subscription per email is on.", "x-doc-source": "rule" }, "Capacity": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Maximum number of subscriptions (attendees) the event can accept.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Allocation": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Number of places currently allocated (already booked) against the event capacity.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "EventDateStart": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time when the event starts.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "EventDateEnd": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time when the event ends.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemEventPropertiesRequestModel": { "title": "DXP.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemEventPropertiesRequestModel", "type": "object", "properties": { "HideWhenFull": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the event is hidden from the site once its capacity is fully booked.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "AllowMultipleSubscriptionPerEmail": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether allow multiple subscription per email is on.", "x-doc-source": "rule" }, "Capacity": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Maximum number of subscriptions (attendees) the event can accept.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "EventDateStart": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time when the event starts.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "EventDateEnd": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time when the event ends.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemProductProperties": { "title": "DXP.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemProductProperties", "type": "object", "properties": { "SmallImage": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Path to the product's small (thumbnail) image.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "LargeImage": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Path to the product's large (full-size) image.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "OnSale": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the product is marked as being on sale.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "IsGiftVoucher": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the product is treated as a gift voucher rather than a physical or digital good.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "ProductWeight": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Physical weight of the product, used for shipping calculations.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "ProductWidth": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Physical width of the product, used for shipping and packaging.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "ProductHeight": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Physical height of the product, used for shipping and packaging.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "ProductDepth": { "title": "DXP.System.Decimal", "type": "number", "format": "double", "description": "Physical depth of the product, used for shipping and packaging.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "EnableDropShipping": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Whether enable drop shipping is on.", "x-doc-source": "rule" }, "UnitType": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Label for the unit in which the product is sold (for example, piece, kg, box).", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "MinimumUnits": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Smallest quantity a customer may order in a single purchase.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "MaximumUnits": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Largest quantity a customer may order in a single purchase.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "RecurringType": { "$ref": "#/components/schemas/eCommerce.BusinessModel.RecurringType", "description": "Billing frequency when the product is sold as a recurring subscription. Possible values: None, Daily, Weekly, Fortnightly, Monthly, Quarterly, HalfYearly, Yearly.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "IsShippable": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the product requires shipping and shipping options are applied at checkout.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "IsDownloadable": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the product delivers a downloadable file after purchase.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "NumberOfPossibleDownloads": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "How many times a buyer may download the file after purchasing a downloadable product.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Supplier": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the supplier associated with this product.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "IsHide": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the product is hidden from the storefront.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "InStock": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Current number of units available in stock.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "IsDisable": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the product is disabled and cannot be ordered.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "IsGroupedProduct": { "title": "DXP.System.Boolean", "type": "boolean", "description": "When enabled, the product is a grouped product that bundles other products together.", "x-doc-source": "ai-inferred", "x-doc-confidence": "med" }, "DownloadableFileLink": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Path or link to the file delivered when the product is downloadable.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestCreateModels": { "title": "DXP.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestCreateModels", "required": [ "ModuleId", "Name", "UrlSlug" ], "type": "object", "properties": { "EventProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemEventPropertiesRequestModel", "description": "Event-specific settings (dates, capacity, booking rules) applied when the item represents an event.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "ProductProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemProductProperties", "description": "Product-specific settings (pricing, stock, dimensions, shipping) applied when the item represents a product.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the module item." }, "UrlSlug": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "URL-friendly identifier." }, "ParentId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the direct parent item." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether the item is active and visible in the system. By default - true." }, "ReleaseDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time when the item becomes publicly available." }, "ExpiryDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time when the item expires and is no longer available." }, "Description": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Textual description of the item." }, "Weighting": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Numeric priority value used for ordering or ranking items." }, "DisableForSiteSearch": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Specifies whether the item should be excluded from the site search index. By default - true." }, "SKUCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Stock Keeping Unit identifier." }, "CreatedByMemberId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the member who created the item." }, "Author": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "IIdentifier of the author associated with the item." }, "ModuleId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related module." }, "TemplateId": { "title": "DXP.System.UInt32", "type": "integer", "format": "int32", "description": "Identifier of the template used to render the item." }, "LayoutId": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": -1, "type": "integer", "format": "int32", "description": "Identifier of the layout applied to the item." }, "Parents": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "Array (integer) - an array of parent category/element IDs." }, "ItemCategories": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array (string)- list of category identifiers or names assigned to the item." }, "ItemTags": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array (string)- list of tags associated with the item for classification and filtering." }, "SiteSearchKeywords": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Additional keywords used to improve search relevance for this item." }, "CustomProperties": { "title": "DXP.System.Collections.Generic.IDictionary`2", "type": "object", "additionalProperties": { "title": "DXP.System.Object" }, "nullable": true, "description": "An object containing additional attributes specific to a given content type." } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel": { "title": "DXP.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemRequestUpdateModel", "required": [ "ModuleId", "Name", "UrlSlug" ], "type": "object", "properties": { "EventProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemEventPropertiesRequestModel", "description": "Event-specific settings (dates, capacity, booking rules) applied when the item represents an event.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "ProductProperties": { "$ref": "#/components/schemas/Treepl.CMS.Public.Bll.v2.Domains.Models.ModuleItems.ModuleItemProductProperties", "description": "Product-specific settings (pricing, stock, dimensions, shipping) applied when the item represents a product.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Name": { "title": "DXP.System.String", "minLength": 1, "type": "string", "example": "string", "description": "Name of the module item request update." }, "UrlSlug": { "title": "DXP.System.String", "minLength": 1, "type": "string", "description": "URL-friendly identifier." }, "ParentId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the direct parent item." }, "Enabled": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Indicates whether the item is active and visible in the system. By default - true." }, "ReleaseDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time when the item becomes publicly available." }, "ExpiryDate": { "title": "DXP.System.DateTime", "type": "string", "format": "date-time", "description": "Date and time when the item expires and is no longer available." }, "Description": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Textual description of the item." }, "Weighting": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Numeric priority value used for ordering or ranking items." }, "DisableForSiteSearch": { "title": "DXP.System.Boolean", "type": "boolean", "description": "Specifies whether the item should be excluded from the site search index. By default - true." }, "SKUCode": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "Stock Keeping Unit identifier." }, "CreatedByMemberId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the member who created the item." }, "Author": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "IIdentifier of the author associated with the item." }, "ModuleId": { "title": "DXP.System.Int32", "type": "integer", "format": "int32", "description": "Identifier of the related module." }, "TemplateId": { "title": "DXP.System.UInt32", "type": "integer", "format": "int32", "description": "Identifier of the template used to render the item." }, "LayoutId": { "title": "DXP.System.Int32", "maximum": 2147483647, "minimum": -1, "type": "integer", "format": "int32", "description": "Identifier of the layout applied to the item." }, "Parents": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.Int32", "type": "integer", "format": "int32" }, "nullable": true, "description": "Array (integer) - an array of parent category/element IDs." }, "ItemCategories": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array (string)- list of category identifiers or names assigned to the item." }, "ItemTags": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Array (string)- list of tags associated with the item for classification and filtering." }, "SiteSearchKeywords": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "title": "DXP.System.String", "type": "string" }, "nullable": true, "description": "Additional keywords used to improve search relevance for this item." }, "CustomProperties": { "title": "DXP.System.Collections.Generic.IDictionary`2", "type": "object", "additionalProperties": { "title": "DXP.System.Object" }, "nullable": true, "description": "An object containing additional attributes specific to a given content type." } }, "additionalProperties": false }, "Treepl.CMS.Public.Bll.v2.Domains.Models.ShippingOptions.ShippingOptionTypePublicApi": { "title": "DXP.Public.Bll.v2.Domains.Models.ShippingOptions.ShippingOptionTypePublicApi", "enum": [ "UserDefined", "AustraliaPost", "FedEx", "UPS", "USPS", "CanadaPost", "NewZealandPost" ], "type": "string" }, "Treepl.CMS.Public.Bll.v2.Record.Models.ContentTemplates.ContentTemplateSettingsPublicV2": { "title": "DXP.Public.Bll.v2.Record.Models.ContentTemplates.ContentTemplateSettingsPublicV2", "type": "object", "properties": { "MainCSS": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.Templates.Models.FillState", "description": "Manages the connection of the main site stylesheet. UseGlobal is selected by default." }, "RecaptchaJS": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.Templates.Models.FillState", "description": "Manages the display of Google ReCAPTCHA protection. UseGlobal is selected by default." }, "EcommerceJS": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.Templates.Models.FillState", "description": "Manages the loading of e-commerce scripts (cart, price tracking, sales analytics). UseGlobal is selected by default." }, "PaymentJS": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.Templates.Models.FillState", "description": "Manages the loading of payment libraries (Stripe, PayPal, etc.). UseGlobal is selected by default." } }, "additionalProperties": false }, "Treepl.CMS.Shared.Contracts.DefaultCaseFieldContract": { "title": "DXP.Shared.Contracts.DefaultCaseFieldContract", "type": "object", "properties": { "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "System alias of the form." }, "Value": { "title": "DXP.System.String", "type": "string", "nullable": true, "description": "The value entered for this CRM field.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" }, "Type": { "$ref": "#/components/schemas/eCommerce.BusinessModel.FieldType", "description": "User category. Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator." } }, "additionalProperties": false }, "Treepl.CMS.Shared.Contracts.DefaultCrmGroupContract": { "title": "DXP.Shared.Contracts.DefaultCrmGroupContract", "type": "object", "properties": { "Alias": { "title": "DXP.System.String", "type": "string", "nullable": true, "example": "string", "description": "System alias of the form." }, "Fields": { "title": "DXP.System.Collections.Generic.IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/Treepl.CMS.Data.Core.Services.CrmPropertyGroups.Models.IDefaultCaseFieldContract" }, "nullable": true, "description": "The individual field values stored in this CRM group.", "x-doc-source": "ai-inferred", "x-doc-confidence": "high" } }, "additionalProperties": false }, "eCommerce.BusinessModel.AccessType": { "title": "DXP.eCommerce.BusinessModel.AccessType", "enum": [ "Free", "Paid" ], "type": "string" }, "eCommerce.BusinessModel.ApplyToType": { "title": "DXP.eCommerce.BusinessModel.ApplyToType", "enum": [ "Contacts", "Order", "FormSubmission", "BookingSubscription" ], "type": "string" }, "eCommerce.BusinessModel.AttributeType": { "title": "DXP.eCommerce.BusinessModel.AttributeType", "enum": [ "Checkbox", "Dropdown", "Radiolist", "UserInput" ], "type": "string" }, "eCommerce.BusinessModel.AttributeValueType": { "title": "DXP.eCommerce.BusinessModel.AttributeValueType", "enum": [ "FixedPrice" ], "type": "string" }, "eCommerce.BusinessModel.CrmType": { "title": "DXP.eCommerce.BusinessModel.CrmType", "enum": [ "Contact", "Member" ], "type": "string" }, "eCommerce.BusinessModel.DiscountCodeType": { "title": "DXP.eCommerce.BusinessModel.DiscountCodeType", "enum": [ "FixedAmount", "PercentageOfOrder", "FreeShipping" ], "type": "string" }, "eCommerce.BusinessModel.EntityType": { "title": "DXP.eCommerce.BusinessModel.EntityType", "enum": [ "Form", "ModuleItem", "SecureZoneSubscription" ], "type": "string" }, "eCommerce.BusinessModel.FieldGroupType": { "title": "DXP.eCommerce.BusinessModel.FieldGroupType", "enum": [ "System", "Custom", "CustomCrmGroup" ], "type": "string" }, "eCommerce.BusinessModel.FieldType": { "title": "DXP.eCommerce.BusinessModel.FieldType", "enum": [ "DateTime", "CheckboxList", "DropdownList", "ListboxList", "RadioList", "Multiline", "String", "Boolean", "Recaptcha", "Upload", "Password", "AcceptPayment", "AcceptEventSubscription", "IsDataUsingAllowed", "Country", "HiddenValidator" ], "type": "string" }, "eCommerce.BusinessModel.FrontendApiRestrictionType": { "title": "DXP.eCommerce.BusinessModel.FrontendApiRestrictionType", "enum": [ "AddItems", "DeleteItems", "EditDraftItems", "EditItems", "PublishDraftItems", "GoogleEvent", "SecureZoneSubscribers" ], "type": "string" }, "eCommerce.BusinessModel.GiftVoucherType": { "title": "DXP.eCommerce.BusinessModel.GiftVoucherType", "enum": [ "Manual", "ViaShop" ], "type": "string" }, "eCommerce.BusinessModel.LayoutType": { "title": "DXP.eCommerce.BusinessModel.LayoutType", "enum": [ "Detail", "List" ], "type": "string" }, "eCommerce.BusinessModel.MemberRole": { "title": "DXP.eCommerce.BusinessModel.MemberRole", "enum": [ "General", "AdminUser" ], "type": "string" }, "eCommerce.BusinessModel.OrderCaseType": { "title": "DXP.eCommerce.BusinessModel.OrderCaseType", "enum": [ "FormCase", "EventCase", "None" ], "type": "string" }, "eCommerce.BusinessModel.OrderState": { "title": "DXP.eCommerce.BusinessModel.OrderState", "enum": [ "New", "AwaitingPayment", "Paid", "PaymentFailed", "PaymentCanceled", "PendingCharge", "Custom", "ReturnRequested", "PartiallyRefunded", "Refunded" ], "type": "string" }, "eCommerce.BusinessModel.OwnershipRestriction": { "title": "DXP.eCommerce.BusinessModel.OwnershipRestriction", "enum": [ "OnlyOwnerAllowed", "AnyoneAllowed" ], "type": "string" }, "eCommerce.BusinessModel.PaymentFormType": { "title": "DXP.eCommerce.BusinessModel.PaymentFormType", "enum": [ "Generic", "SingleItem", "CheckOut", "Recurring", "Quote" ], "type": "string" }, "eCommerce.BusinessModel.PaymentGatewayType": { "title": "DXP.eCommerce.BusinessModel.PaymentGatewayType", "enum": [ "stripe", "eway", "paypal", "bamboraEU", "authorizeNet", "paypalFlow", "stripeElements", "braintree" ], "type": "string" }, "eCommerce.BusinessModel.PaymentState": { "title": "DXP.eCommerce.BusinessModel.PaymentState", "enum": [ "None", "Succeeded", "RequiresCapture", "RequiresAction", "Canceled", "Processing", "Pending" ], "type": "string" }, "eCommerce.BusinessModel.PaymentType": { "title": "DXP.eCommerce.BusinessModel.PaymentType", "enum": [ "CreditCard", "Cash", "Free", "Paypal", "Cheque", "EFT", "MoneyOrder", "Other", "Refund" ], "type": "string" }, "eCommerce.BusinessModel.RecurringType": { "title": "DXP.eCommerce.BusinessModel.RecurringType", "enum": [ "None", "Daily", "Weekly", "Fortnightly", "Monthly", "Quarterly", "HalfYearly", "Yearly" ], "type": "string" }, "eCommerce.BusinessModel.ShippingOptionType": { "title": "DXP.eCommerce.BusinessModel.ShippingOptionType", "enum": [ "UserDefined", "AustraliaPost", "FedEx", "UPS", "USPS", "DHL", "CanadaPost", "NewZealandPost" ], "type": "string" }, "eCommerce.BusinessModel.SystemEmailDeliveryOption": { "title": "DXP.eCommerce.BusinessModel.SystemEmailDeliveryOption", "enum": [ "SendAlways", "NeverSend", "SendOnlyFirstRecurringPayment" ], "type": "string" }, "eCommerce.BusinessModel.SystemEvent": { "title": "DXP.eCommerce.BusinessModel.SystemEvent", "enum": [ "PasswordRetrieveEmail", "RestoreAdminUserPassword", "InviteAdminUser", "AdminResetMemberPassword", "Invoice", "OrderStatusChanged", "Quote", "GiftVoucher", "DropShipping", "FirstCartRecoveryEmail", "SecondCartRecoveryEmail", "LowStockNotification", "InvoiceEcom", "SupplierNotification", "OfflineCreditCardPayment", "DoubleOptInEmail", "SecureZoneLoginDetails", "AffiliateProgramDetails", "Forums", "ForumsSubscriberAlertforNewPosts", "ForumsSubscriberAlertforNewTopics", "CustomerServiceTicketing", "WorkflowNotification", "ThirdrdPartyWorkflowEmails", "WorkflowTask", "WorkflowCompletion", "WorkflowReminder", "WorkflowEscalation", "WorkflowRejection", "ConfirmEmailNotification", "OrderStatus", "TellAFriend", "StorageLimitNotification", "FollowUpNotification", "AbandonedCartNotification", "ItemsLimitNotification", "CrmLimitNotification", "RecurringReminderNotification" ], "type": "string" }, "eCommerce.BusinessModel.TaxAppliesEnumeration": { "title": "DXP.eCommerce.BusinessModel.TaxAppliesEnumeration", "enum": [ "ShippingOptions", "GiftVouchers" ], "type": "string" }, "eCommerce.BusinessModel.TaxRoundingStrategy": { "title": "DXP.eCommerce.BusinessModel.TaxRoundingStrategy", "enum": [ "WithErrorCompensation", "WithoutErrorCompensation" ], "type": "string" }, "eCommerce.BusinessModel.UserTypeApiRestriction": { "title": "DXP.eCommerce.BusinessModel.UserTypeApiRestriction", "enum": [ "LoggedInUser", "UserFromSecureZone", "AdminUser" ], "type": "string" }, "eCommerce.BusinessModel.WhenOutOfStock": { "title": "DXP.eCommerce.BusinessModel.WhenOutOfStock", "enum": [ "HideProduct", "EnablePreOrdering", "ShowButNotAcceptOrders" ], "type": "string" } }, "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "JWT bearer token from the OAuth token endpoint. Scoped to a single site." } } }, "security": [ { "Bearer": [] } ], "servers": [ { "url": "https://{site}.webinone.com", "variables": { "site": { "default": "your-site", "description": "Your WebinOne site subdomain." } } } ] }