inner content

{"id":"deb4c7b1-6e5c-4f50-ad3d-7359a328faf6","createdDate":"2025-01-01T04:14:39.126Z","updatedDate":"2025-01-01T04:14:39.126Z","resourceId":"d6022ae9-8d44-4a72-8b97-6bde30e2b756","api":{"schema":{"object":{"displayName":"Project Object","description":"","slug":"project-object","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","legacyExamples":[{"title":"Project","content":"{\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 5,\n \"title\": \"Sample Project\",\n \"description\": \"This is a sample description for the project.\",\n \"hidden\": false,\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"64c4566-e87b-77d3-a456-4266141779902\",\n \"url\": \"https://example.com/cover.jpg\",\n \"altText\": \"Project cover image\"\n }\n },\n \"collectionIds\": [\n \"123e4567-e89b-12d3-a456-426614174001\",\n \"123e4567-e89b-12d3-a456-426614174002\"\n ],\n \"details\": [\n {\n \"label\": \"GitHub\",\n \"link\": {\n \"text\": \"View on GitHub\",\n \"url\": \"https://github.com/example/project\",\n \"target\": \"_blank\"\n }\n },\n {\n \"label\": \"Description\",\n \"text\": \"A detailed description of the project.\"\n }\n ],\n \"slug\": \"sample-project\",\n \"createdDate\": \"2024-07-31T12:00:00Z\",\n \"updatedDate\": \"2024-07-31T12:00:00Z\",\n \"url\": {\n \"relativePath\": \"/project/sample-project\",\n \"url\": \"https://portfolio.com/project/sample-project\"\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/photography-server.git"},"methods":[{"summary":"List Projects","description":"Retrieves a list of all projects in a portfolio.","operationId":"com.wixpress.portfolio.projects.ProjectsService.ListProjects","parameters":[{"name":"paging","in":"query","description":"Projects limit per response is maximum 100, In the first request the cursor is None ?","required":false,"schema":{"description":"Projects limit per response is maximum 100, In the first request the cursor is None ?","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"includePageUrl","in":"query","description":"Whether to include the project's relative path and full URL in the response. Default: `false`","required":false,"schema":{"description":"Whether to include the project's relative path and full URL in the response. Default: `false`","title":"includePageUrl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.portfolio.projects.ListProjectsResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.portfolio.projects.ProjectsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["PORTFOLIO.PROJECT_READ"],"protoArtifactId":"com.wixpress.portfolio:projects-service","serviceArtifactId":"com.wixpress.portfolio.projects-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.portfolio.projects.ListProjectsRequest","responseMessage":"com.wixpress.portfolio.projects.ListProjectsResponse"},"legacyExamples":[{"name":"ListProjects","type":"METHOD","content":{"title":"List Projects","request":"curl -X GET \\\n'https://www.wixapis.com/api/v1/portfolio/projects' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\","response":"{\n \"projects\": [\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 1,\n \"title\": \"Project Title\",\n \"description\": \"Project Description\",\n \"hidden\": false,\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"72144e4567-e89b-12d3-a456-426619234\",\n \"url\": \"https://example.com/image-10.jpg\",\n }\n },\n \"collectionIds\": [\"123e4567-e89b-12d3-a456-426614174001\"],\n \"details\": [\n \"label\": \"text\",\n \"text\": \"My project is in memory of Sally Lang.\"\n ],\n \"slug\": \"project-title\",\n \"createdDate\": \"2024-07-31T12:00:00Z\",\n \"updatedDate\": \"2024-07-31T12:00:00Z\"\n }\n ],\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"total\": 1,\n \"tooManyToCount\": false,\n \"cursors\": {\n \"next\": \"next_cursor\",\n \"prev\": \"prev_cursor\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/photography-server.git"},"httpMethod":"get","path":"/api/v1/portfolio/projects","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"manage._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://editor.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"editor._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://blocks.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"blocks._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://create.editorx/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"create.editorx","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://*.dev.wix-code.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"*.dev.wix-code.com","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://_/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://www.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"www._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://www.wixapis.com/portfolio/v1/projects","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/portfolio/v1/projects","destinationPath":"/api/v1/portfolio/projects","url":"www.wixapis.com","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}}],"triggeredEvents":[],"serviceName":"com.wixpress.portfolio.projects.ProjectsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["PORTFOLIO.PROJECT_READ"],"protoArtifactId":"com.wixpress.portfolio:projects-service","serviceArtifactId":"com.wixpress.portfolio.projects-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.portfolio.projects.ListProjectsRequest","responseMessage":"com.wixpress.portfolio.projects.ListProjectsResponse"},"legacyExamples":[{"name":"ListProjects","type":"METHOD","content":{"title":"List Projects","request":"curl -X GET \\\n'https://www.wixapis.com/api/v1/portfolio/projects' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\","response":"{\n \"projects\": [\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 1,\n \"title\": \"Project Title\",\n \"description\": \"Project Description\",\n \"hidden\": false,\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"72144e4567-e89b-12d3-a456-426619234\",\n \"url\": \"https://example.com/image-10.jpg\",\n }\n },\n \"collectionIds\": [\"123e4567-e89b-12d3-a456-426614174001\"],\n \"details\": [\n \"label\": \"text\",\n \"text\": \"My project is in memory of Sally Lang.\"\n ],\n \"slug\": \"project-title\",\n \"createdDate\": \"2024-07-31T12:00:00Z\",\n \"updatedDate\": \"2024-07-31T12:00:00Z\"\n }\n ],\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"total\": 1,\n \"tooManyToCount\": false,\n \"cursors\": {\n \"next\": \"next_cursor\",\n \"prev\": \"prev_cursor\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/photography-server.git","contentLink":{"displayName":"List Projects","slugifiedName":"list-projects"},"permissionScopes":[{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"}],"isAdminMethod":false},{"summary":"Create Project","description":"Creates a project.","operationId":"com.wixpress.portfolio.projects.ProjectsService.CreateProject","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.portfolio.projects.CreateProjectResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateProjectRequest","description":"","properties":{"project":{"description":"Project to create.","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","summary":"project","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["project","project.source.appDefId","project.source.externalId","project.source.sourceName"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Project Created","description":"Triggered when a project is created.","permissions":["PORTFOLIO.PROJECT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.portfolio.projects.v1.project","serviceName":"com.wixpress.portfolio.projects.ProjectsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.portfolio.projects.v1.project_created","sourceRepo":"git@github.com:wix-private/photography-server.git"}],"serviceName":"com.wixpress.portfolio.projects.ProjectsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["PORTFOLIO.PROJECT_CREATE"],"protoArtifactId":"com.wixpress.portfolio:projects-service","serviceArtifactId":"com.wixpress.portfolio.projects-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.portfolio.projects.CreateProjectRequest","responseMessage":"com.wixpress.portfolio.projects.CreateProjectResponse"},"legacyExamples":[{"name":"CreateProject","type":"METHOD","content":{"title":"Create Project","request":"curl -X POST \\\n'https://www.wixapis.com/api/v1/portfolio/projects' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\\n-d '{\n \"project\": {\n \"title\": \"Project Title\",\n \"description\": \"This is a project description.\",\n \"hidden\": false,\n \"collectionIds\": [\"123e4567-e89b-12d3-a456-426614174001\"],\n \"slug\": \"new-project-title\",\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"9ab44e4567-e89b-12d3-a456-4266141747\",\n \"url\": \"https://example.com/cover_image.jpg\",\n }\n },\n }\n}'","response":"{\n \"project\": {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 1,\n \"title\": \"Project Title\",\n \"description\": \"This is a project description.\",\n \"hidden\": false,\n \"collectionIds\": [\"123e4567-e89b-12d3-a456-426614174001\"],\n \"slug\": \"new-project-title\",\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"9ab44e4567-e89b-12d3-a456-4266141747\",\n \"url\": \"https://example.com/cover_image.jpg\",\n }\n },\n \"createdDate\": \"2024-07-31T12:00:00Z\",\n \"updatedDate\": \"2024-09-31T12:00:00Z\",\n \"seoData\": {\n \"settings\": {\n \"keywords\": [\n {\n \"isMain\": true,\n \"origin\": \"marketing-persona\",\n \"term\": \"investment management\"\n }\n ],\n \"preventAutoRedirect\": false\n },\n \"tags\": [\n {\n \"children\": \"Investment Experts Share Growth Strategies\",\n \"custom\": false,\n \"disabled\": false,\n \"type\": \"title\"\n },\n {\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false,\n \"props\": {\n \"content\": \"Investment strategies explained by investment experts. Investment experts offer valuable insights for growth.\",\n \"name\": \"description\"\n },\n \"type\": \"meta\"\n }\n ]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/photography-server.git"},"httpMethod":"post","path":"/api/v1/portfolio/projects","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"manage._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://editor.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"editor._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://blocks.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"blocks._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://create.editorx/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"create.editorx","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://*.dev.wix-code.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"*.dev.wix-code.com","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://_/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://www.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"www._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://www.wixapis.com/portfolio/v1/projects","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/portfolio/v1/projects","destinationPath":"/api/v1/portfolio/projects","url":"www.wixapis.com","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}}],"triggeredEvents":[{"title":"Project Created","description":"Triggered when a project is created.","permissions":["PORTFOLIO.PROJECT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.portfolio.projects.v1.project","serviceName":"com.wixpress.portfolio.projects.ProjectsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.portfolio.projects.v1.project_created","sourceRepo":"git@github.com:wix-private/photography-server.git"}],"serviceName":"com.wixpress.portfolio.projects.ProjectsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["PORTFOLIO.PROJECT_CREATE"],"protoArtifactId":"com.wixpress.portfolio:projects-service","serviceArtifactId":"com.wixpress.portfolio.projects-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.portfolio.projects.CreateProjectRequest","responseMessage":"com.wixpress.portfolio.projects.CreateProjectResponse"},"legacyExamples":[{"name":"CreateProject","type":"METHOD","content":{"title":"Create Project","request":"curl -X POST \\\n'https://www.wixapis.com/api/v1/portfolio/projects' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\\n-d '{\n \"project\": {\n \"title\": \"Project Title\",\n \"description\": \"This is a project description.\",\n \"hidden\": false,\n \"collectionIds\": [\"123e4567-e89b-12d3-a456-426614174001\"],\n \"slug\": \"new-project-title\",\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"9ab44e4567-e89b-12d3-a456-4266141747\",\n \"url\": \"https://example.com/cover_image.jpg\",\n }\n },\n }\n}'","response":"{\n \"project\": {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 1,\n \"title\": \"Project Title\",\n \"description\": \"This is a project description.\",\n \"hidden\": false,\n \"collectionIds\": [\"123e4567-e89b-12d3-a456-426614174001\"],\n \"slug\": \"new-project-title\",\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"9ab44e4567-e89b-12d3-a456-4266141747\",\n \"url\": \"https://example.com/cover_image.jpg\",\n }\n },\n \"createdDate\": \"2024-07-31T12:00:00Z\",\n \"updatedDate\": \"2024-09-31T12:00:00Z\",\n \"seoData\": {\n \"settings\": {\n \"keywords\": [\n {\n \"isMain\": true,\n \"origin\": \"marketing-persona\",\n \"term\": \"investment management\"\n }\n ],\n \"preventAutoRedirect\": false\n },\n \"tags\": [\n {\n \"children\": \"Investment Experts Share Growth Strategies\",\n \"custom\": false,\n \"disabled\": false,\n \"type\": \"title\"\n },\n {\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false,\n \"props\": {\n \"content\": \"Investment strategies explained by investment experts. Investment experts offer valuable insights for growth.\",\n \"name\": \"description\"\n },\n \"type\": \"meta\"\n }\n ]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/photography-server.git","contentLink":{"displayName":"Create Project","slugifiedName":"create-project"},"permissionScopes":[{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"}],"isAdminMethod":true},{"summary":"Get Project","description":"Retrieves a project.","operationId":"com.wixpress.portfolio.projects.ProjectsService.GetProject","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"projectId","description":"ID of the project to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"includePageUrl","in":"query","description":"Whether to include the project's relative path and full URL in the response. Default: `false`","required":false,"schema":{"description":"Whether to include the project's relative path and full URL in the response. Default: `false`","title":"includePageUrl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.portfolio.projects.GetProjectResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.portfolio.projects.ProjectsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["PORTFOLIO.PROJECT_READ"],"protoArtifactId":"com.wixpress.portfolio:projects-service","serviceArtifactId":"com.wixpress.portfolio.projects-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.portfolio.projects.GetProjectRequest","responseMessage":"com.wixpress.portfolio.projects.GetProjectResponse"},"legacyExamples":[{"name":"GetProject","type":"METHOD","content":{"title":"Get Project","request":"curl -X GET \\\n'https://www.wixapis.com/api/v1/portfolio/projects/123e4567-e89b-12d3-a456-426614174000?includePageUrl=true' \\\n-H 'Authorization: ' \\","response":"{\n \"project\": {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 1,\n \"title\": \"Project Title\",\n \"description\": \"Project Description\",\n \"hidden\": false,\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"72144e4567-e89b-12d3-a456-426619234\",\n \"url\": \"https://example.com/image-10.jpg\",\n }\n },\n \"collectionIds\": [\"123e4567-e89b-12d3-a456-426614174001\"],\n \"details\": [],\n \"slug\": \"project-title\",\n \"createdDate\": \"2024-07-31T12:00:00Z\",\n \"updatedDate\": \"2024-09-31T12:00:00Z\",\n \"url\": {\n \"relativePath\": \"/projects/project-title\",\n \"url\": \"https://example.com/projects/project-title\"\n },\n \"seoData\": {\n \"settings\": {\n \"keywords\": [\n {\n \"isMain\": true,\n \"origin\": \"marketing-persona\",\n \"term\": \"investment management\"\n }\n ],\n \"preventAutoRedirect\": false\n },\n \"tags\": [\n {\n \"children\": \"Investment Experts Share Growth Strategies\",\n \"custom\": false,\n \"disabled\": false,\n \"type\": \"title\"\n },\n {\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false,\n \"props\": {\n \"content\": \"Investment strategies explained by investment experts. Investment experts offer valuable insights for growth.\",\n \"name\": \"description\"\n },\n \"type\": \"meta\"\n }\n ]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/photography-server.git"},"httpMethod":"get","path":"/api/v1/portfolio/projects/{projectId}","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"manage._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://editor.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"editor._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://blocks.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"blocks._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://create.editorx/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"create.editorx","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://*.dev.wix-code.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"*.dev.wix-code.com","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://_/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://www.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"www._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://www.wixapis.com/portfolio/v1/projects","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/portfolio/v1/projects","destinationPath":"/api/v1/portfolio/projects","url":"www.wixapis.com","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}}],"triggeredEvents":[],"serviceName":"com.wixpress.portfolio.projects.ProjectsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["PORTFOLIO.PROJECT_READ"],"protoArtifactId":"com.wixpress.portfolio:projects-service","serviceArtifactId":"com.wixpress.portfolio.projects-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.portfolio.projects.GetProjectRequest","responseMessage":"com.wixpress.portfolio.projects.GetProjectResponse"},"legacyExamples":[{"name":"GetProject","type":"METHOD","content":{"title":"Get Project","request":"curl -X GET \\\n'https://www.wixapis.com/api/v1/portfolio/projects/123e4567-e89b-12d3-a456-426614174000?includePageUrl=true' \\\n-H 'Authorization: ' \\","response":"{\n \"project\": {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 1,\n \"title\": \"Project Title\",\n \"description\": \"Project Description\",\n \"hidden\": false,\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"72144e4567-e89b-12d3-a456-426619234\",\n \"url\": \"https://example.com/image-10.jpg\",\n }\n },\n \"collectionIds\": [\"123e4567-e89b-12d3-a456-426614174001\"],\n \"details\": [],\n \"slug\": \"project-title\",\n \"createdDate\": \"2024-07-31T12:00:00Z\",\n \"updatedDate\": \"2024-09-31T12:00:00Z\",\n \"url\": {\n \"relativePath\": \"/projects/project-title\",\n \"url\": \"https://example.com/projects/project-title\"\n },\n \"seoData\": {\n \"settings\": {\n \"keywords\": [\n {\n \"isMain\": true,\n \"origin\": \"marketing-persona\",\n \"term\": \"investment management\"\n }\n ],\n \"preventAutoRedirect\": false\n },\n \"tags\": [\n {\n \"children\": \"Investment Experts Share Growth Strategies\",\n \"custom\": false,\n \"disabled\": false,\n \"type\": \"title\"\n },\n {\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false,\n \"props\": {\n \"content\": \"Investment strategies explained by investment experts. Investment experts offer valuable insights for growth.\",\n \"name\": \"description\"\n },\n \"type\": \"meta\"\n }\n ]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/photography-server.git","contentLink":{"displayName":"Get Project","slugifiedName":"get-project"},"permissionScopes":[{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"}],"isAdminMethod":false},{"summary":"Delete Project","description":"Deletes a project.","operationId":"com.wixpress.portfolio.projects.ProjectsService.DeleteProject","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"projectId","description":"ID of the project to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.portfolio.projects.DeleteProjectResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[{"title":"Project Deleted","description":"Triggered when a project is deleted.","permissions":["PORTFOLIO.PROJECT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.portfolio.projects.v1.project","serviceName":"com.wixpress.portfolio.projects.ProjectsService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.portfolio.projects.v1.project_deleted","sourceRepo":"git@github.com:wix-private/photography-server.git"}],"serviceName":"com.wixpress.portfolio.projects.ProjectsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["PORTFOLIO.PROJECT_DELETE"],"protoArtifactId":"com.wixpress.portfolio:projects-service","serviceArtifactId":"com.wixpress.portfolio.projects-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.portfolio.projects.DeleteProjectRequest","responseMessage":"com.wixpress.portfolio.projects.DeleteProjectResponse"},"legacyExamples":[{"name":"DeleteProject","type":"METHOD","content":{"title":"Delete Project","request":"curl -X DELETE \\\n'https://www.wixapis.com/api/v1/portfolio/projects/c68c0dc5-088f-4205-b202-3eef797ea0ab' \\\n-H 'Authorization: ' \\","response":"{\n \"projectId\": \"c68c0dc5-088f-4205-b202-3eef797ea0ab\"\n}"}}],"sourceRepo":"git@github.com:wix-private/photography-server.git"},"httpMethod":"delete","path":"/api/v1/portfolio/projects/{projectId}","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"manage._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://editor.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"editor._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://blocks.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"blocks._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://create.editorx/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"create.editorx","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://*.dev.wix-code.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"*.dev.wix-code.com","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://_/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://www.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"www._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://www.wixapis.com/portfolio/v1/projects","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/portfolio/v1/projects","destinationPath":"/api/v1/portfolio/projects","url":"www.wixapis.com","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}}],"triggeredEvents":[{"title":"Project Deleted","description":"Triggered when a project is deleted.","permissions":["PORTFOLIO.PROJECT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.portfolio.projects.v1.project","serviceName":"com.wixpress.portfolio.projects.ProjectsService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.portfolio.projects.v1.project_deleted","sourceRepo":"git@github.com:wix-private/photography-server.git"}],"serviceName":"com.wixpress.portfolio.projects.ProjectsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["PORTFOLIO.PROJECT_DELETE"],"protoArtifactId":"com.wixpress.portfolio:projects-service","serviceArtifactId":"com.wixpress.portfolio.projects-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.portfolio.projects.DeleteProjectRequest","responseMessage":"com.wixpress.portfolio.projects.DeleteProjectResponse"},"legacyExamples":[{"name":"DeleteProject","type":"METHOD","content":{"title":"Delete Project","request":"curl -X DELETE \\\n'https://www.wixapis.com/api/v1/portfolio/projects/c68c0dc5-088f-4205-b202-3eef797ea0ab' \\\n-H 'Authorization: ' \\","response":"{\n \"projectId\": \"c68c0dc5-088f-4205-b202-3eef797ea0ab\"\n}"}}],"sourceRepo":"git@github.com:wix-private/photography-server.git","contentLink":{"displayName":"Delete Project","slugifiedName":"delete-project"},"permissionScopes":[{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"}],"isAdminMethod":true},{"summary":"Update Project","description":"Updates a project.","operationId":"com.wixpress.portfolio.projects.ProjectsService.UpdateProject","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"project.id","description":"Project ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.portfolio.projects.UpdateProjectResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateProjectRequest","description":"","properties":{"project":{"description":"Project to update.","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","summary":"project","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["project","project.id","project.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Project Updated","description":"Triggered when a project is updated.","permissions":["PORTFOLIO.PROJECT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.portfolio.projects.v1.project","serviceName":"com.wixpress.portfolio.projects.ProjectsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.portfolio.projects.v1.project_updated","sourceRepo":"git@github.com:wix-private/photography-server.git"}],"serviceName":"com.wixpress.portfolio.projects.ProjectsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["PORTFOLIO.PROJECT_UPDATE"],"protoArtifactId":"com.wixpress.portfolio:projects-service","serviceArtifactId":"com.wixpress.portfolio.projects-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.portfolio.projects.UpdateProjectRequest","responseMessage":"com.wixpress.portfolio.projects.UpdateProjectResponse"},"legacyExamples":[{"name":"UpdateProject","type":"METHOD","content":{"title":"Update Project","request":"curl -X PATCH \\\n'https://www.wixapis.com/api/v1/portfolio/projects/123e4567-e89b-12d3-a456-426614174000' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\\n-d '{\n \"project\": {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 1,\n \"title\": \"Updated Project Title\",\n \"description\": \"This is an updated project description.\",\n \"hidden\": false,\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"9ab44e4567-e89b-12d3-a456-4266141747\",\n \"url\": \"https://example.com/updated_cover_image1.jpg\"\n }\n },\n \"slug\": \"updated-project-title\"\n }\n}'","response":"{\n \"project\": {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 2,\n \"title\": \"Updated Project Title\",\n \"description\": \"This is an updated project description.\",\n \"hidden\": false,\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"9ab44e4567-e89b-12d3-a456-4266141747\",\n \"url\": \"https://example.com/updated_cover_image1.jpg\"\n }\n },\n \"collectionIds\": [\"123e4567-e89b-12d3-a456-426614174001\"],\n \"slug\": \"updated-project-title\",\n \"createdDate\": \"2024-07-31T12:00:00Z\",\n \"updatedDate\": \"2024-09-31T12:30:00Z\",\n \"url\": {\n \"relativePath\": \"/projects/updated-project-title\",\n \"url\": \"https://example.com/projects/updated-project-title\"\n },\n \"seoData\": {\n \"settings\": {\n \"keywords\": [\n {\n \"isMain\": true,\n \"origin\": \"marketing-persona\",\n \"term\": \"investment management\"\n }\n ],\n \"preventAutoRedirect\": false\n },\n \"tags\": [\n {\n \"children\": \"Investment Experts Share Growth Strategies\",\n \"custom\": false,\n \"disabled\": false,\n \"type\": \"title\"\n },\n {\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false,\n \"props\": {\n \"content\": \"Investment strategies explained by investment experts. Investment experts offer valuable insights for growth.\",\n \"name\": \"description\"\n },\n \"type\": \"meta\"\n }\n ]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/photography-server.git"},"httpMethod":"patch","path":"/api/v1/portfolio/projects/{project.id}","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"manage._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://editor.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"editor._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://blocks.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"blocks._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://create.editorx/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"create.editorx","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://*.dev.wix-code.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"*.dev.wix-code.com","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://_/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://www.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"www._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://www.wixapis.com/portfolio/v1/projects","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/portfolio/v1/projects","destinationPath":"/api/v1/portfolio/projects","url":"www.wixapis.com","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}}],"triggeredEvents":[{"title":"Project Updated","description":"Triggered when a project is updated.","permissions":["PORTFOLIO.PROJECT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.portfolio.projects.v1.project","serviceName":"com.wixpress.portfolio.projects.ProjectsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.portfolio.projects.v1.project_updated","sourceRepo":"git@github.com:wix-private/photography-server.git"}],"serviceName":"com.wixpress.portfolio.projects.ProjectsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["PORTFOLIO.PROJECT_UPDATE"],"protoArtifactId":"com.wixpress.portfolio:projects-service","serviceArtifactId":"com.wixpress.portfolio.projects-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.portfolio.projects.UpdateProjectRequest","responseMessage":"com.wixpress.portfolio.projects.UpdateProjectResponse"},"legacyExamples":[{"name":"UpdateProject","type":"METHOD","content":{"title":"Update Project","request":"curl -X PATCH \\\n'https://www.wixapis.com/api/v1/portfolio/projects/123e4567-e89b-12d3-a456-426614174000' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\\n-d '{\n \"project\": {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 1,\n \"title\": \"Updated Project Title\",\n \"description\": \"This is an updated project description.\",\n \"hidden\": false,\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"9ab44e4567-e89b-12d3-a456-4266141747\",\n \"url\": \"https://example.com/updated_cover_image1.jpg\"\n }\n },\n \"slug\": \"updated-project-title\"\n }\n}'","response":"{\n \"project\": {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 2,\n \"title\": \"Updated Project Title\",\n \"description\": \"This is an updated project description.\",\n \"hidden\": false,\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"9ab44e4567-e89b-12d3-a456-4266141747\",\n \"url\": \"https://example.com/updated_cover_image1.jpg\"\n }\n },\n \"collectionIds\": [\"123e4567-e89b-12d3-a456-426614174001\"],\n \"slug\": \"updated-project-title\",\n \"createdDate\": \"2024-07-31T12:00:00Z\",\n \"updatedDate\": \"2024-09-31T12:30:00Z\",\n \"url\": {\n \"relativePath\": \"/projects/updated-project-title\",\n \"url\": \"https://example.com/projects/updated-project-title\"\n },\n \"seoData\": {\n \"settings\": {\n \"keywords\": [\n {\n \"isMain\": true,\n \"origin\": \"marketing-persona\",\n \"term\": \"investment management\"\n }\n ],\n \"preventAutoRedirect\": false\n },\n \"tags\": [\n {\n \"children\": \"Investment Experts Share Growth Strategies\",\n \"custom\": false,\n \"disabled\": false,\n \"type\": \"title\"\n },\n {\n \"children\": \"\",\n \"custom\": false,\n \"disabled\": false,\n \"props\": {\n \"content\": \"Investment strategies explained by investment experts. Investment experts offer valuable insights for growth.\",\n \"name\": \"description\"\n },\n \"type\": \"meta\"\n }\n ]\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/photography-server.git","contentLink":{"displayName":"Update Project","slugifiedName":"update-project"},"permissionScopes":[{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"}],"isAdminMethod":true},{"summary":"Query Projects","description":"Retrieves a list of projects, given the provided paging, filtering, and sorting. Up to 100 projects can be returned per request.\n\nThe default `sort` is `id` in `ASC`.\n\nFor a detailed list of supported operations, see [Projects: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/sort-and-filter).\nTo learn how to query projects, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).","operationId":"com.wixpress.portfolio.projects.ProjectsService.QueryProjects","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.portfolio.projects.QueryProjectsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryProjectsRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includePageUrl":{"description":"Whether to include the project's relative path and full URL in the response. Default: `false`","title":"includePageUrl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["query"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.portfolio.projects.ProjectsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["PORTFOLIO.PROJECT_READ"],"protoArtifactId":"com.wixpress.portfolio:projects-service","serviceArtifactId":"com.wixpress.portfolio.projects-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.portfolio.projects.QueryProjectsRequest","responseMessage":"com.wixpress.portfolio.projects.QueryProjectsResponse"},"legacyExamples":[{"name":"QueryProjects","type":"METHOD","content":{"title":"Query Projects","request":"curl -X POST \\\n'https://www.wixapis.com/api/v1/portfolio/projects/query' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\\n-d '{\n \"query\": {\n \"filter\": {\n \"title\": {\n \"$contains\": \"Project\"\n }\n },\n \"sort\": [\n {\n \"fieldName\": \"createdDate\",\n \"order\": \"ASC\"\n }\n ],\n \"cursorPaging\": {\n \"limit\": 10\n }\n },\n \"includePageUrl\": true\n}'","response":"{\n \"projects\": [\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 1,\n \"title\": \"Project Title\",\n \"description\": \"Project Description\",\n \"hidden\": false,\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"9ab44e4567-e89b-12d3-a456-4266141747\",\n \"url\": \"https://example.com/updated_cover_image1.jpg\"\n }\n }\n \"collectionIds\": [\"123e4567-e89b-12d3-a456-426614174001\"],\n \"slug\": \"project-title\",\n \"details\": [\n \"label\": \"link\",\n \"link\": {\n \"text\": \"Learn more about my project.\",\n \"url\": \"www.my-project.com\",\n \"target\": \"'_blank'\"\n }\n ],\n \"createdDate\": \"2024-07-31T12:00:00Z\",\n \"updatedDate\": \"2024-07-31T12:00:00Z\",\n \"url\": {\n \"relative\": \"/projects/project-title\",\n \"url\": \"https://example.com/projects/project-title\"\n }\n }\n ],\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"total\": 1,\n \"tooManyToCount\": false,\n \"cursors\": {\n \"next\": \"next_cursor\",\n \"prev\": \"prev_cursor\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/photography-server.git"},"httpMethod":"post","path":"/api/v1/portfolio/projects/query","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"manage._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://editor.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"editor._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://blocks.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"blocks._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://create.editorx/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"create.editorx","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://*.dev.wix-code.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"*.dev.wix-code.com","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://_/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://www.wix.com/_api/projects-service","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/projects-service","destinationPath":"/api","url":"www._base_domain_","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}},{"url":"https://www.wixapis.com/portfolio/v1/projects","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/portfolio/v1/projects","destinationPath":"/api/v1/portfolio/projects","url":"www.wixapis.com","serviceName":"com.wixpress.portfolio.projects.ProjectsService"}}],"triggeredEvents":[],"serviceName":"com.wixpress.portfolio.projects.ProjectsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["PORTFOLIO.PROJECT_READ"],"protoArtifactId":"com.wixpress.portfolio:projects-service","serviceArtifactId":"com.wixpress.portfolio.projects-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.portfolio.projects.QueryProjectsRequest","responseMessage":"com.wixpress.portfolio.projects.QueryProjectsResponse"},"legacyExamples":[{"name":"QueryProjects","type":"METHOD","content":{"title":"Query Projects","request":"curl -X POST \\\n'https://www.wixapis.com/api/v1/portfolio/projects/query' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\\n-d '{\n \"query\": {\n \"filter\": {\n \"title\": {\n \"$contains\": \"Project\"\n }\n },\n \"sort\": [\n {\n \"fieldName\": \"createdDate\",\n \"order\": \"ASC\"\n }\n ],\n \"cursorPaging\": {\n \"limit\": 10\n }\n },\n \"includePageUrl\": true\n}'","response":"{\n \"projects\": [\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"revision\": 1,\n \"title\": \"Project Title\",\n \"description\": \"Project Description\",\n \"hidden\": false,\n \"coverImage\": {\n \"imageInfo\": {\n \"id\": \"9ab44e4567-e89b-12d3-a456-4266141747\",\n \"url\": \"https://example.com/updated_cover_image1.jpg\"\n }\n }\n \"collectionIds\": [\"123e4567-e89b-12d3-a456-426614174001\"],\n \"slug\": \"project-title\",\n \"details\": [\n \"label\": \"link\",\n \"link\": {\n \"text\": \"Learn more about my project.\",\n \"url\": \"www.my-project.com\",\n \"target\": \"'_blank'\"\n }\n ],\n \"createdDate\": \"2024-07-31T12:00:00Z\",\n \"updatedDate\": \"2024-07-31T12:00:00Z\",\n \"url\": {\n \"relative\": \"/projects/project-title\",\n \"url\": \"https://example.com/projects/project-title\"\n }\n }\n ],\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"total\": 1,\n \"tooManyToCount\": false,\n \"cursors\": {\n \"next\": \"next_cursor\",\n \"prev\": \"prev_cursor\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/photography-server.git","contentLink":{"displayName":"Query Projects","slugifiedName":"query-projects"},"permissionScopes":[{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"}],"isAdminMethod":false}],"webhooks":[{"summary":"Project Created","title":"Project Created","description":"Triggered when a project is created.","permissions":["PORTFOLIO.PROJECT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.portfolio.projects.v1.project","serviceName":"com.wixpress.portfolio.projects.ProjectsService","domainEvent":"CREATED","eventType":"wix.portfolio.projects.v1.project_created","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/photography-server.git","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","contentLink":{"displayName":"Project Created","slugifiedName":"project-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"}]},{"summary":"Project Deleted","title":"Project Deleted","description":"Triggered when a project is deleted.","permissions":["PORTFOLIO.PROJECT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.portfolio.projects.v1.project","serviceName":"com.wixpress.portfolio.projects.ProjectsService","domainEvent":"DELETED","eventType":"wix.portfolio.projects.v1.project_deleted","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/photography-server.git","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","contentLink":{"displayName":"Project Deleted","slugifiedName":"project-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"}]},{"summary":"Project Updated","title":"Project Updated","description":"Triggered when a project is updated.","permissions":["PORTFOLIO.PROJECT_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.portfolio.projects.v1.project","serviceName":"com.wixpress.portfolio.projects.ProjectsService","domainEvent":"UPDATED","eventType":"wix.portfolio.projects.v1.project_updated","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/photography-server.git","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","contentLink":{"displayName":"Project Updated","slugifiedName":"project-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Projects API\n\n

\n Developer Preview\n
\n APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.\n

\n\n \n\n\nThe Projects API allows you to manage projects in a site's portfolio. Learn more about [projects in Wix Portfolio](fallback::https://support.wix.com/en/article/wix-portfolio-managing-your-wix-portfolio#managing-your-projects).\n\n\nWith the Projects API, you can:\n\n+ Create, update, and delete projects. \n+ Retrieve, list, and query projects.\n+ Listen for events when a project is created, updated, and deleted. \n\n## Before you begin\n\nIt’s important to note the following points before starting to code:\n\n+ To add or update a cover image or video for projects, first upload the media file to the [Wix Media Manager](fallback::https://support.wix.com/en/article/wix-media-about-the-media-manager) by calling the [Import File](fallback::https://dev.wix.com/docs/rest/assets/media/media-manager/files/import-file) method.\n+ You can only use this API on sites where a Wix user has installed the [Wix Portfolio app](fallback::https://www.wix.com/app-market/web-solution/wix-portfolio?appIndex=0&collimp_id=b54d3569-fdaa-49f6-83f8-2ac6e400bd11&referralSectionName=wix%20portfolio).\n\n## Use cases\n\n+ [Delete residential building projects older than 2 years](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/sample-flows#delete-residential-building-projects-older-than-2-years).\n+ [Fetch project information for your art gallery](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/sample-flows#fetch-project-information-for-your-art-gallery).\n\n\n"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Use Cases and Flows\n\nThis article presents possible use cases and corresponding sample flows that you can support. This can be a helpful jumping off point as you plan your implementation.\n\n## Delete residential building projects older than 2 years\nYou can integrate with the Projects API to display residential building projects available for investment. To keep listings current, once a year you might want to delete projects that are over 2 years old.\n\n1. Call [Create Projects](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/create-project) to create a project for each residential building available for investment. \n\n2. Once a year, call [Query Projects](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/query-projects) using the created date property to retrieve all projects in the site's portfolio older than 2 years. Record the returned project IDs. \n\n2. For each project ID returned, call [Delete Project](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/bulk-update-projects) to remove the project from the portfolio. \n\n## Fetch project information for your art gallery\n\nYou can create a curated art gallery that lists various artists' projects. To display the most up-to-date projects from your artists, set the gallery to automatically fetch and display projects whenever Wix users add, update, or delete them. \n\n1. Wix users can create and manage projects in a Wix Portfolio. \n\n2. Listen for the [Project Created](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/project-created), [Project Updated](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/project-updated), and [Project Deleted](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/project-deleted) events to detect when projects have been added, updated, or deleted. Retrieve the latest project data from the event object.\n\n3. Reflect the changes in your gallery."},{"displayName":"Sort and Filter","slugifyName":"sort-and-filter","content":"# Projects: Supported Filters and Sorting\n\nThis article covers field support for filtering and sorting in the Projects API.\n\n\nThe following table shows field support for filters and sorting for the projects object when calling [Query Projects](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/query-projects):\n\n\n| Field | Supported Filters | Sortable |\n| ---------------------| ------------------------------------------------------------------------------ | ---------- |\n| `id` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `title` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `description` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `slug` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `hidden` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | |\n| `collectionIds` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | |\n| `createdDate` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `updatedDate` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |"}],"components":{"schemas":{"com.wixpress.portfolio.projects.Project":{"type":"object","properties":{"id":{"description":"Project ID.","readOnly":true,"format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.","readOnly":true,"title":"revision","type":"integer","format":"uint64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Project title.","maxLength":100,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Project description.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hidden":{"description":"Whether the project is hidden from the portfolio. Default: `false`","title":"hidden","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"collectionIds":{"description":"IDs of the collections that include the project.","format":"GUID","maxItems":1000,"title":"collectionIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"details":{"description":"Project details.","title":"details","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.portfolio.projects.ProjectDetail"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"Project slug.","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the project was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the project was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Project page URL and and relative path. Returned when `includePageUrl` is `true` in the request.","readOnly":true,"$ref":"#/components/schemas/wix.common.PageUrlV2","summary":"url","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"seoData":{"description":"Project SEO data.","$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema","summary":"seoData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Project","description":"","oneOf":[{"description":"","summary":"cover","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project.cover"}]},"com.wixpress.portfolio.projects.Project.cover":{"type":"object","title":"cover","properties":{"coverImage":{"description":"Project cover image.","$ref":"#/components/schemas/com.wixpress.portfolio.common.Image","summary":"coverImage","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"coverVideo":{"description":"Project cover video.","$ref":"#/components/schemas/com.wixpress.portfolio.common.Video","summary":"coverVideo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.UInt64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UInt64Value","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"com.wixpress.portfolio.common.Image":{"type":"object","properties":{"imageInfo":{"description":"Information about the Wix Media image.","$ref":"#/components/schemas/upstream.wix.common.portfolio.common.Image","summary":"imageInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"focalPoint":{"description":"Focal point of the image.","$ref":"#/components/schemas/com.wixpress.portfolio.common.Point","summary":"focalPoint","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"com.wixpress.portfolio.common.Image.ImageType":{"type":"string","description":"","title":"ImageType","enum":[{"order":0,"value":"UNDEFINED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"WIX_MEDIA","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"EXTERNAL","description":"","maturity":"GA","exposure":"PUBLIC"}]},"upstream.wix.common.portfolio.common.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID. Required.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Image URL.","readOnly":true,"title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Original image height. Required.","title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Original image width. Required.","title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Image filename.","title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"com.wixpress.portfolio.common.Point":{"type":"object","properties":{"x":{"description":"X-coordinate of the focal point.","title":"x","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"y":{"description":"Y-coordinate of the focal point.","title":"y","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Point","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":[{"order":0,"value":"NULL_VALUE","description":"","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.portfolio.common.UnsharpMasking":{"type":"object","properties":{"amount":{"description":"Unsharp masking amount. Controls the sharpening strength.
\n\nMin: `0`
\nMax: `5`","minimum":0,"maximum":5,"title":"amount","$ref":"#/components/schemas/google.protobuf.FloatValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"radius":{"description":"Unsharp masking radius in pixels. Controls the sharpening width.","title":"radius","$ref":"#/components/schemas/google.protobuf.FloatValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"threshold":{"description":"Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply.
\n\nMin: `0`
\nMax: `1`","minimum":0,"maximum":1,"title":"threshold","$ref":"#/components/schemas/google.protobuf.FloatValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UnsharpMasking","description":""},"google.protobuf.FloatValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"float","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FloatValue","description":""},"com.wixpress.portfolio.common.Video":{"type":"object","properties":{"videoInfo":{"description":"Information about the Wix Media video.","$ref":"#/components/schemas/upstream.wix.common.portfolio.common.VideoV2","summary":"videoInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"durationInMillis":{"description":"Manually defined Video duration in milliseconds.","title":"durationInMillis","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Video","description":""},"upstream.wix.common.portfolio.common.VideoV2":{"type":"object","properties":{"id":{"description":"WixMedia ID. Required.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Video URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"resolutions":{"description":"Available resolutions for the video, starting with the optimal resolution.","maxItems":100,"title":"resolutions","type":"array","items":{"$ref":"#/components/schemas/upstream.wix.common.portfolio.common.VideoResolution"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Video filename.","title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"posters":{"description":"Video posters.","title":"posters","type":"array","items":{"$ref":"#/components/schemas/upstream.wix.common.portfolio.common.Image"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VideoV2","description":""},"upstream.wix.common.portfolio.common.VideoResolution":{"type":"object","properties":{"url":{"description":"Video URL. Required.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Video height. Required.","title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Video width. Required.","title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"format":{"description":"Video format for example, mp4, hls. Required.","title":"format","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quality":{"description":"Video quality for example 480p, 720p.","title":"quality","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Video filename.","title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"VideoResolution","description":""},"com.wixpress.portfolio.projects.ProjectDetail":{"type":"object","properties":{"label":{"description":"Project label.","title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProjectDetail","description":"Project label.\nOne of:\n+ `text`\n+ `link`","oneOf":[{"description":"","summary":"value","$ref":"#/components/schemas/com.wixpress.portfolio.projects.ProjectDetail.value"}]},"com.wixpress.portfolio.projects.ProjectDetail.value":{"type":"object","title":"value","properties":{"text":{"description":"Project label in plain text format.","title":"text","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"link":{"description":"Project label in link format.","$ref":"#/components/schemas/com.wixpress.portfolio.projects.DetailsLink","summary":"link","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.portfolio.projects.DetailsLink":{"type":"object","properties":{"text":{"description":"Display text of the link.","title":"text","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Target URL of the link.","format":"WEB_URL","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"target":{"description":"Whether the link opens in a new tab or window. One of:\n* `'_blank'`: The link opens in a new tab or window.\n* `'_self'`: The link opens in the same tab or window.","title":"target","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DetailsLink","description":""},"com.wixpress.portfolio.projects.ProjectSource":{"type":"object","properties":{"appDefId":{"description":"App definition id","immutable":true,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalId":{"description":"External source id","immutable":true,"title":"externalId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sourceName":{"description":"Source name","maxLength":100,"immutable":true,"title":"sourceName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Source description","immutable":true,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"link":{"description":"link to external source","format":"WEB_URL","title":"link","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"syncStatus":{"description":"Sync status","title":"syncStatus","type":"string","$ref":"#/components/schemas/com.wixpress.portfolio.projects.ProjectSource.SyncStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"notEditableFields":{"description":"fields that are synced from external source, should be blocked to update in UI","title":"notEditableFields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastSync":{"description":"last date the project was synced","title":"lastSync","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProjectSource","description":""},"com.wixpress.portfolio.projects.ProjectSource.SyncStatus":{"type":"string","description":"","title":"SyncStatus","enum":[{"order":0,"value":"SYNCED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"SYNCING","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"NOT_SYNCED","description":"","maturity":"GA","exposure":"PUBLIC"}]},"wix.common.PageUrlV2":{"type":"object","properties":{"relativePath":{"description":"The relative path for the page within the site. For example, `/product-page/a-product`.","title":"relativePath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"The page's full URL. For example, `https://mysite.com/product-page/a-product`.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PageUrlV2","description":""},"com.wixpress.advanced.seo.SeoSchema":{"type":"object","properties":{"tags":{"description":"SEO tag information.","title":"tags","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Tag"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"settings":{"description":"SEO general settings.","$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Settings","summary":"settings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SeoSchema","description":"The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\nThe search engines use this information for ranking purposes, or to display snippets in the search results.\nThis data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself."},"com.wixpress.advanced.seo.SeoSchema.Keyword":{"type":"object","properties":{"term":{"description":"Keyword value.","title":"term","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isMain":{"description":"Whether the keyword is the main focus keyword.","title":"isMain","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"origin":{"description":"The source that added the keyword terms to the SEO settings.","maxLength":1000,"title":"origin","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Keyword","description":""},"com.wixpress.advanced.seo.SeoSchema.Tag":{"type":"object","properties":{"type":{"description":"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.","title":"type","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"props":{"description":"A `{\"key\": \"value\"}` pair object where each SEO tag property (`\"name\"`, `\"content\"`, `\"rel\"`, `\"href\"`) contains a value.\nFor example: `{\"name\": \"description\", \"content\": \"the description itself\"}`.","title":"props","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"meta":{"description":"SEO tag meta data. For example, `{\"height\": 300, \"width\": 240}`.","title":"meta","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"children":{"description":"SEO tag inner content. For example, ` inner content `.","title":"children","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"Whether the tag is a custom tag.","title":"custom","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disabled":{"description":"Whether the tag is disabled.","title":"disabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Tag","description":""},"com.wixpress.advanced.seo.SeoSchema.Settings":{"type":"object","properties":{"preventAutoRedirect":{"description":"Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n\n\nDefault: `false` (Auto Redirect is enabled.)","title":"preventAutoRedirect","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"keywords":{"description":"User-selected keyword terms for a specific page.","maxItems":5,"title":"keywords","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Keyword"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Settings","description":""},"com.wixpress.portfolio.portfolioapp.MenuSettingUpdatedEvent":{"type":"object","properties":{},"title":"MenuSettingUpdatedEvent","description":""},"com.wixpress.portfolio.portfolioapp.GetProjectPageDataRequest":{"type":"object","properties":{"collectionSlug":{"description":"Slug of the project's current collection","title":"collectionSlug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"projectSlug":{"description":"Project's slug","title":"projectSlug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetProjectPageDataRequest","description":""},"com.wixpress.portfolio.portfolioapp.GetProjectPageDataResponse":{"type":"object","properties":{"project":{"description":"Project data","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","summary":"project","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previousProject":{"description":"Previous project slug","$ref":"#/components/schemas/com.wixpress.portfolio.portfolioapp.ProjectSlug","summary":"previousProject","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nextProject":{"description":"Next project slug","$ref":"#/components/schemas/com.wixpress.portfolio.portfolioapp.ProjectSlug","summary":"nextProject","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetProjectPageDataResponse","description":""},"com.wixpress.portfolio.portfolioapp.ProjectSlug":{"type":"object","properties":{"projectId":{"description":"Project id","format":"GUID","title":"projectId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"Project slug","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProjectSlug","description":""},"com.wixpress.portfolio.portfolioapp.CreateNewPortfolioAppRequest":{"type":"object","properties":{},"title":"CreateNewPortfolioAppRequest","description":""},"com.wixpress.portfolio.portfolioapp.CreateNewPortfolioAppResponse":{"type":"object","properties":{},"title":"CreateNewPortfolioAppResponse","description":""},"com.wixpress.metasite.event.api.MetaSiteSpecialEvent":{"type":"object","properties":{"metaSiteId":{"description":"A meta site id.","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A meta site version. Monotonically increasing.","title":"version","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timestamp":{"description":"A timestamp of the event.","title":"timestamp","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"assets":{"description":"TODO(meta-site): Change validation once validations are disabled for consumers\nMore context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659","maxItems":4000,"title":"assets","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.metasite.event.api.Asset"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MetaSiteSpecialEvent","description":"","oneOf":[{"description":"","summary":"payload","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSiteSpecialEvent.payload"}]},"com.wixpress.metasite.event.api.MetaSiteSpecialEvent.payload":{"type":"object","title":"payload","properties":{"siteCreated":{"description":"Emitted on a meta site creation.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteCreated","summary":"siteCreated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteTransferred":{"description":"Emitted on a meta site transfer completion.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteTransferred","summary":"siteTransferred","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteDeleted":{"description":"Emitted on a meta site deletion.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteDeleted","summary":"siteDeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteUndeleted":{"description":"Emitted on a meta site restoration.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteUndeleted","summary":"siteUndeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sitePublished":{"description":"Emitted on the first* publish of the meta site (* switching from unpublished to published state).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SitePublished","summary":"sitePublished","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteUnpublished":{"description":"Emitted on a meta site unpublish.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteUnpublished","summary":"siteUnpublished","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMarkedAsTemplate":{"description":"Emitted when meta site is marked as template.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteMarkedAsTemplate","summary":"siteMarkedAsTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMarkedAsWixSite":{"description":"Emitted when meta site is marked as a WixSite.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteMarkedAsWixSite","summary":"siteMarkedAsWixSite","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceProvisioned":{"description":"Emitted when an application is provisioned (installed).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.ServiceProvisioned","summary":"serviceProvisioned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceRemoved":{"description":"Emitted when an application is removed (uninstalled).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.ServiceRemoved","summary":"serviceRemoved","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteRenamedPayload":{"description":"Emitted when meta site name (URL slug) is changed.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteRenamed","summary":"siteRenamedPayload","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hardDeleted":{"description":"Emitted when meta site was permanently deleted.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteHardDeleted","summary":"hardDeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespaceChanged":{"description":"Emitted on a namespace change.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.NamespaceChanged","summary":"namespaceChanged","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"studioAssigned":{"description":"Emitted when Studio is attached.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.StudioAssigned","summary":"studioAssigned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"studioUnassigned":{"description":"Emitted when Studio is detached.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.StudioUnassigned","summary":"studioUnassigned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.metasite.event.api.Asset":{"type":"object","properties":{"appDefId":{"description":"An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"An instance id. For legacy reasons may be UUID or a string.","maxLength":200,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"state":{"description":"An application state.","title":"state","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.Asset.State","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Asset","description":""},"com.wixpress.metasite.event.api.Asset.State":{"type":"string","description":"","title":"State","enum":[{"order":0,"value":"UNKNOWN","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ENABLED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"DISABLED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"PENDING","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"DEMO","description":"","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.metasite.event.api.SiteCreated":{"type":"object","properties":{"originTemplateId":{"description":"A template identifier (empty if not created from a template).","maxLength":36,"title":"originTemplateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ownerId":{"description":"An account id of the owner.","format":"GUID","title":"ownerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"context":{"description":"A context in which meta site was created.","title":"context","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteCreatedContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originMetaSiteId":{"description":"A meta site id from which this site was created.\n\nIn case of a creation from a template it's a template id.\nIn case of a site duplication (\"Save As\" in dashboard or duplicate in UM) it's an id of a source site.","format":"GUID","title":"originMetaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteName":{"description":"A meta site name (URL slug).","maxLength":20,"title":"siteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespace":{"description":"A namespace.","title":"namespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteCreated","description":""},"com.wixpress.metasite.event.api.SiteCreatedContext":{"type":"string","description":"","title":"SiteCreatedContext","enum":[{"order":0,"value":"OTHER","description":"A valid option, we don't expose all reasons why site might be created.","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"FROM_TEMPLATE","description":"A meta site was created from template.","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"DUPLICATE_BY_SITE_TRANSFER","description":"A meta site was created by copying of the transfferred meta site.","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"DUPLICATE","description":"A copy of existing meta site.","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"OLD_SITE_TRANSFER","description":"A meta site was created as a transfferred site (copy of the original), old flow, should die soon.","maturity":"GA","exposure":"PUBLIC"},{"order":5,"value":"FLASH","description":"deprecated A meta site was created for Flash editor.","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.metasite.event.api.MetaSite.Namespace":{"type":"string","description":"","title":"Namespace","enum":[{"order":0,"value":"UNKNOWN_NAMESPACE","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"WIX","description":"Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"SHOUT_OUT","description":"ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"ALBUMS","description":"MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"WIX_STORES_TEST_DRIVE","description":"Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":5,"value":"HOTELS","description":"Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":6,"value":"CLUBS","description":"Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":7,"value":"ONBOARDING_DRAFT","description":"A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":8,"value":"DEV_SITE","description":"AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":9,"value":"LOGOS","description":"LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":10,"value":"VIDEO_MAKER","description":"VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":11,"value":"PARTNER_DASHBOARD","description":"MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":12,"value":"DEV_CENTER_COMPANY","description":"MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":13,"value":"HTML_DRAFT","description":"A draft created by HTML editor on open. Upon \"first save\" it will be moved to be of WIX domain.\n\nMeta site with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":14,"value":"SITELESS_BUSINESS","description":"the user-journey for Fitness users who want to start from managing their business instead of designing their website.\nWill be accessible from Site List and will not have a website app.\nOnce the user attaches a site, the site will become a regular wixsite.","maturity":"GA","exposure":"PUBLIC"},{"order":15,"value":"CREATOR_ECONOMY","description":"Belongs to \"strategic products\" company. Supports new product in the creator's economy space.","maturity":"GA","exposure":"PUBLIC"},{"order":16,"value":"DASHBOARD_FIRST","description":"It is to be used in the Business First efforts.","maturity":"GA","exposure":"PUBLIC"},{"order":17,"value":"ANYWHERE","description":"Bookings business flow with no site.","maturity":"GA","exposure":"PUBLIC"},{"order":18,"value":"HEADLESS","description":"Namespace for Headless Backoffice with no editor","maturity":"GA","exposure":"PUBLIC"},{"order":19,"value":"ACCOUNT_MASTER_CMS","description":"Namespace for master site that will exist in parent account that will be referenced by subaccounts\nThe site will be used for account level CSM feature for enterprise","maturity":"GA","exposure":"PUBLIC"},{"order":20,"value":"RISE","description":"Rise.ai Siteless account management for Gift Cards and Store Credit.","maturity":"GA","exposure":"PUBLIC"},{"order":21,"value":"BRANDED_FIRST","description":"As part of the branded app new funnel, users now can create a meta site that will be branded app first.\nThere's a blank site behind the scene but it's blank).\nThe Mobile company will be the owner of this namespace.","maturity":"GA","exposure":"PUBLIC"},{"order":22,"value":"NOWNIA","description":"Nownia.com Siteless account management for Ai Scheduling Assistant.","maturity":"GA","exposure":"PUBLIC"},{"order":23,"value":"UGC_TEMPLATE","description":"UGC Templates are templates that are created by users for personal use and to sale to other users.\nThe Partners company owns this namespace.","maturity":"GA","exposure":"PUBLIC"},{"order":24,"value":"CODUX","description":"Codux Headless Sites","maturity":"GA","exposure":"PUBLIC"},{"order":25,"value":"MEDIA_DESIGN_CREATOR","description":"Bobb - AI Design Creator.","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.metasite.event.api.SiteTransferred":{"type":"object","properties":{"oldOwnerId":{"description":"A previous owner id (user that transfers meta site).","format":"GUID","title":"oldOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newOwnerId":{"description":"A new owner id (user that accepts meta site).","format":"GUID","title":"newOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteTransferred","description":"Site transferred to another user."},"com.wixpress.metasite.event.api.SiteDeleted":{"type":"object","properties":{"deleteContext":{"description":"A deletion context.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext","summary":"deleteContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteDeleted","description":"Soft deletion of the meta site. Could be restored."},"com.wixpress.metasite.event.api.DeleteContext":{"type":"object","properties":{"dateDeleted":{"description":"When the meta site was deleted.","title":"dateDeleted","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteStatus":{"description":"A status.","title":"deleteStatus","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext.DeleteStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteOrigin":{"description":"A reason (flow).","maxLength":255,"title":"deleteOrigin","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initiatorId":{"description":"A service that deleted it.","maxLength":255,"title":"initiatorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteContext","description":""},"com.wixpress.metasite.event.api.DeleteContext.DeleteStatus":{"type":"string","description":"","title":"DeleteStatus","enum":[{"order":0,"value":"UNKNOWN","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"TRASH","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"DELETED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"PENDING_PURGE","description":"","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.metasite.event.api.SiteUndeleted":{"type":"object","properties":{},"title":"SiteUndeleted","description":"Restoration of the meta site."},"com.wixpress.metasite.event.api.SitePublished":{"type":"object","properties":{},"title":"SitePublished","description":"First publish of a meta site. Or subsequent publish after unpublish."},"com.wixpress.metasite.event.api.SiteUnpublished":{"type":"object","properties":{"urls":{"description":"A list of URLs previously associated with the meta site.","maxLength":4000,"maxItems":10000,"title":"urls","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteUnpublished","description":""},"com.wixpress.metasite.event.api.SiteMarkedAsTemplate":{"type":"object","properties":{},"title":"SiteMarkedAsTemplate","description":""},"com.wixpress.metasite.event.api.SiteMarkedAsWixSite":{"type":"object","properties":{},"title":"SiteMarkedAsWixSite","description":""},"com.wixpress.metasite.event.api.ServiceProvisioned":{"type":"object","properties":{"appDefId":{"description":"Either UUID or EmbeddedServiceType.","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"Not only UUID. Something here could be something weird.","maxLength":36,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originInstanceId":{"description":"An instance id from which this instance is originated.","maxLength":36,"title":"originInstanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A version.","maxLength":500,"title":"version","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originMetaSiteId":{"description":"The origin meta site id","format":"GUID","title":"originMetaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceProvisioned","description":"Represents a service provisioned a site.\n\nNote on `origin_instance_id`:\nThere is no guarantee that you will be able to find a meta site using `origin_instance_id`.\nThis is because of the following scenario:\n\nImagine you have a template where a third-party application (TPA) includes some stub data,\nsuch as a product catalog. When you create a site from this template, you inherit this\ndefault product catalog. However, if the template's product catalog is modified,\nyour site will retain the catalog as it was at the time of site creation. This ensures that\nyour site remains consistent with what you initially received and does not include any\nchanges made to the original template afterward.\nTo ensure this, the TPA on the template gets a new instance_id."},"com.wixpress.metasite.event.api.ServiceRemoved":{"type":"object","properties":{"appDefId":{"description":"Either UUID or EmbeddedServiceType.","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"Not only UUID. Something here could be something weird.","maxLength":36,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A version.","maxLength":500,"title":"version","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceRemoved","description":""},"com.wixpress.metasite.event.api.SiteRenamed":{"type":"object","properties":{"newSiteName":{"description":"A new meta site name (URL slug).","maxLength":20,"title":"newSiteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oldSiteName":{"description":"A previous meta site name (URL slug).","maxLength":255,"title":"oldSiteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteRenamed","description":"Rename of the site. Meaning, free public url has been changed as well."},"com.wixpress.metasite.event.api.SiteHardDeleted":{"type":"object","properties":{"deleteContext":{"description":"A deletion context.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext","summary":"deleteContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteHardDeleted","description":"Hard deletion of the meta site.\n\nCould not be restored. Therefore it's desirable to cleanup data."},"com.wixpress.metasite.event.api.NamespaceChanged":{"type":"object","properties":{"oldNamespace":{"description":"A previous namespace.","title":"oldNamespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newNamespace":{"description":"A new namespace.","title":"newNamespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NamespaceChanged","description":""},"com.wixpress.metasite.event.api.StudioAssigned":{"type":"object","properties":{},"title":"StudioAssigned","description":"Assigned Studio editor"},"com.wixpress.metasite.event.api.StudioUnassigned":{"type":"object","properties":{},"title":"StudioUnassigned","description":"Unassigned Studio editor"},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":[{"order":0,"value":"UNKNOWN","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ANONYMOUS_VISITOR","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"MEMBER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"WIX_USER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"APP","description":"","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.html.cache.invalidate.InvalidateCache":{"type":"object","properties":{"reason":{"description":"tell us why you're invalidating the cache. You don't need to add your app name","maxLength":256,"title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"localDc":{"description":"Is local DS","title":"localDc","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hardPurge":{"description":"","title":"hardPurge","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InvalidateCache","description":"","oneOf":[{"description":"","summary":"getBy","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.getBy"}]},"com.wixpress.html.cache.invalidate.InvalidateCache.getBy":{"type":"object","title":"getBy","properties":{"metaSiteId":{"description":"Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteId":{"description":"Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"siteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"app":{"description":"Invalidate by App","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.App","summary":"app","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"page":{"description":"Invalidate by page id","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.Page","summary":"page","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uri":{"description":"Invalidate by URI path","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.URI","summary":"uri","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"file":{"description":"Invalidate by file (for media files such as PDFs)","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.File","summary":"file","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.html.cache.invalidate.InvalidateCache.App":{"type":"object","properties":{"appDefId":{"description":"The AppDefId","minLength":1,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"The instance Id","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"App","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.Page":{"type":"object","properties":{"metaSiteId":{"description":"the msid the page is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pageId":{"description":"Invalidate by Page ID","minLength":1,"title":"pageId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Page","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.URI":{"type":"object","properties":{"metaSiteId":{"description":"the msid the URI is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uriPath":{"description":"URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes","minLength":1,"title":"uriPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"URI","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.File":{"type":"object","properties":{"metaSiteId":{"description":"the msid the file is related to","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileName":{"description":"Invalidate by filename (for media files such as PDFs)","minLength":1,"maxLength":256,"title":"fileName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"File","description":""},"com.wixpress.portfolio.projects.SyncProjectWithCollectionMappings":{"type":"object","properties":{"projectId":{"description":"Id of recently updated Project","format":"GUID","title":"projectId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldMaskPaths":{"description":"fields that were updated in the given project","maxItems":100,"title":"fieldMaskPaths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SyncProjectWithCollectionMappings","description":""},"com.wixpress.portfolio.projects.DeletedProjectRestored":{"type":"object","properties":{"projectId":{"description":"the id of the project that was restored","format":"GUID","title":"projectId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletionTimestamp":{"description":"timestamp for when the project was originally deleted.","title":"deletionTimestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeletedProjectRestored","description":""},"com.wixpress.portfolio.projects.CreateProjectRequest":{"type":"object","properties":{"project":{"description":"Project to create.","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","summary":"project","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateProjectRequest","description":""},"com.wixpress.portfolio.projects.CreateProjectResponse":{"type":"object","properties":{"project":{"description":"Created project.","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","summary":"project","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateProjectResponse","description":""},"com.wixpress.portfolio.projects.GetProjectRequest":{"type":"object","properties":{"projectId":{"description":"ID of the project to retrieve.","format":"GUID","title":"projectId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includePageUrl":{"description":"Whether to include the project's relative path and full URL in the response. Default: `false`","title":"includePageUrl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetProjectRequest","description":""},"com.wixpress.portfolio.projects.GetProjectResponse":{"type":"object","properties":{"project":{"description":"The requested project.","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","summary":"project","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetProjectResponse","description":""},"com.wixpress.portfolio.projects.ListProjectsRequest":{"type":"object","properties":{"paging":{"description":"Projects limit per response is maximum 100, In the first request the cursor is None ?","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includePageUrl":{"description":"Whether to include the project's relative path and full URL in the response. Default: `false`","title":"includePageUrl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListProjectsRequest","description":""},"wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"com.wixpress.portfolio.projects.ListProjectsResponse":{"type":"object","properties":{"projects":{"description":"List of projects.","title":"projects","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Paging metadata.","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListProjectsResponse","description":""},"wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wixpress.portfolio.projects.UpdateProjectRequest":{"type":"object","properties":{"project":{"description":"Project to update.","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","summary":"project","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateProjectRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"com.wixpress.portfolio.projects.UpdateProjectResponse":{"type":"object","properties":{"project":{"description":"Updated project.","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","summary":"project","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateProjectResponse","description":""},"com.wixpress.portfolio.projects.BulkUpdateProjectsRequest":{"type":"object","properties":{"projects":{"description":"Projects to update.","maxItems":100,"title":"projects","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.portfolio.projects.MaskedProject"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnFullEntity":{"description":"Whether to include the updated projects in the response. Set to `true` to receive the projects in the response. Default: `false`","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateProjectsRequest","description":""},"com.wixpress.portfolio.projects.MaskedProject":{"type":"object","properties":{"project":{"description":"Project to update.","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","summary":"project","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MaskedProject","description":""},"com.wixpress.portfolio.projects.BulkUpdateProjectsResponse":{"type":"object","properties":{"results":{"description":"Items created by bulk action.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.portfolio.projects.BulkUpdateProjectsResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateProjectsResponse","description":""},"com.wixpress.portfolio.projects.BulkUpdateProjectsResult":{"type":"object","properties":{"itemMetadata":{"description":"Item metadata.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"project":{"description":"Updated project.","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","summary":"project","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateProjectsResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"com.wixpress.portfolio.projects.DeleteProjectRequest":{"type":"object","properties":{"projectId":{"description":"ID of the project to delete.","format":"GUID","title":"projectId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteProjectRequest","description":""},"com.wixpress.portfolio.projects.DeleteProjectResponse":{"type":"object","properties":{"projectId":{"description":"ID of the deleted project.","format":"GUID","title":"projectId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteProjectResponse","description":""},"com.wixpress.portfolio.projects.QueryProjectsRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includePageUrl":{"description":"Whether to include the project's relative path and full URL in the response. Default: `false`","title":"includePageUrl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryProjectsRequest","description":""},"wix.common.QueryV2":{"type":"object","properties":{"filter":{"description":"Filter object.\n\nLearn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object.\n\nLearn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.","title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.","title":"fieldsets","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryV2","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.common.QueryV2.pagingMethod"}]},"wix.common.QueryV2.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":[{"order":0,"value":"ASC","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"DESC","description":"","maturity":"GA","exposure":"PUBLIC"}]},"wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"com.wixpress.portfolio.projects.QueryProjectsResponse":{"type":"object","properties":{"projects":{"description":"List of projects.","title":"projects","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Paging metadata.","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryProjectsResponse","description":""},"com.wixpress.portfolio.projects.UpdateProjectOrderInCollectionRequest":{"type":"object","properties":{"projectId":{"description":"ID of the project to update.","format":"GUID","title":"projectId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"collectionId":{"description":"Collection ID.","format":"GUID","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sortOrder":{"description":"Index that determines the placement of a project within the collection.","title":"sortOrder","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateProjectOrderInCollectionRequest","description":""},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoubleValue","description":""},"com.wixpress.portfolio.projects.UpdateProjectOrderInCollectionResponse":{"type":"object","properties":{"projectInCollection":{"description":"Updated project placement within the specified collection.","$ref":"#/components/schemas/com.wixpress.portfolio.projects.ProjectsInCollections","summary":"projectInCollection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateProjectOrderInCollectionResponse","description":""},"com.wixpress.portfolio.projects.ProjectsInCollections":{"type":"object","properties":{"collectionId":{"description":"Collection ID.","format":"GUID","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"project":{"description":"Project object.","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","summary":"project","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sortOrder":{"description":"Index that determines the placement of a project within the collection.
\n\nDefault: [Epoch](https://www.epoch101.com/) timestamp.
","title":"sortOrder","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"id":{"description":"Project placement ID.","readOnly":true,"format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProjectsInCollections","description":""},"com.wixpress.portfolio.projects.QueryProjectWithCollectionInfoRequest":{"type":"object","properties":{"query":{"description":"WQL expression","$ref":"#/components/schemas/wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includePageUrl":{"description":"Include page url","title":"includePageUrl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryProjectWithCollectionInfoRequest","description":""},"com.wixpress.portfolio.projects.QueryProjectWithCollectionInfoResponse":{"type":"object","properties":{"projects":{"description":"The retrieved Projects in Collection","title":"projects","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.portfolio.projects.ProjectsInCollections"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Paging metadata","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryProjectWithCollectionInfoResponse","description":""},"com.wixpress.portfolio.projects.RestoreProjectFromTrashBinRequest":{"type":"object","properties":{"projectId":{"description":"id of deleted project to restore from trash bin.","format":"GUID","title":"projectId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreProjectFromTrashBinRequest","description":""},"com.wixpress.portfolio.projects.RestoreProjectFromTrashBinResponse":{"type":"object","properties":{"project":{"description":"project that was restored from trash bin","$ref":"#/components/schemas/com.wixpress.portfolio.projects.Project","summary":"project","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreProjectFromTrashBinResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""}}},"title":"Project","description":"","fqdn":"wix.portfolio.projects.v1.project"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Projects API\n\n