{"id":"d38ac7e4-4334-4f01-9ae7-8c7de6858c9d","createdDate":"2024-02-20T12:45:29.395Z","updatedDate":"2024-02-20T12:45:29.395Z","resourceId":"358831aa-cf03-4a7a-90a8-2d962b8ed3cc","api":{"schema":{"object":{"displayName":"Folder Object","description":"","slug":"folder-object","$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder","legacyExamples":[{"title":"Folder","content":"{\n \"id\": \"60baab4a44554097bf1f56370df245f2\",\n \"displayName\": \"empty folder\",\n \"parentFolderId\": \"media-root\",\n \"createdDate\": \"2022-08-30T17:21:03Z\",\n \"updatedDate\": \"2022-08-30T17:21:03Z\",\n \"state\": \"OK\"\n}"}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"methods":[{"summary":"List Folders","description":"Retrieves a list of folders in the Media Manager. To retrieve a list of folders within a specific folder in the Media Manager, pass the specific folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves a list of folders within the root folder of the Media Manager.","operationId":"com.wix.media.site_media.v1.FoldersService.ListFolders","parameters":[{"name":"parentFolderId","in":"query","description":"ID of the folder's parent folder.\n
Default: `media-root` folder.","required":false,"schema":{"title":"parentFolderId","description":"ID of the folder's parent folder.\n
Default: `media-root` folder.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"sort","in":"query","description":"Field name and order to sort by. One of:
\n* `displayName`\n* `updatedDate`\nDefault: `updatedDate` in `desc` order.","required":false,"schema":{"$ref":"#/components/schemas/wix.common.Sorting","summary":"sort","description":"Field name and order to sort by. One of:
\n* `displayName`\n* `updatedDate`\nDefault: `updatedDate` in `desc` order.","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"paging","in":"query","description":"Cursor and paging information.","required":false,"schema":{"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.CursorPaging","summary":"paging","description":"Cursor and paging information.","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.ListFoldersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-media/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-media/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_LIST"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Media Manager","scopeId":"SCOPE.DC-MEDIA.READ-MEDIAMANAGER"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.ListFoldersRequest","responseMessage":"com.wix.media.site_media.v1.ListFoldersResponse"},"legacyExamples":[{"name":"ListFolders","type":"METHOD","content":{"title":"List folders in a specific parent folder","description":"This example sorts by `displayName` in `DESC` order with a paging limit of 2.","request":"curl -X GET \\\n 'https://www.wixapis.com/site-media/v1/folders?parentFolderId=25284aa06584441ea94338fdcfbaba12&sort.fieldName=displayName&sort.order=DESC&paging.limit=2' \\\n -H 'Authorization: '","response":"{\n \"folders\": [\n {\n \"id\": \"d147e1ab3e8b4114ad93d13bb9e23540\",\n \"displayName\": \"misc\",\n \"parentFolderId\": \"25284aa06584441ea94338fdcfbaba12\",\n \"createdDate\": \"2022-08-30T16:56:29Z\",\n \"updatedDate\": \"2022-08-30T16:56:29Z\",\n \"state\": \"OK\"\n },\n {\n \"id\": \"5bfba6861eed4f009c6abba0dc8b47db\",\n \"displayName\": \"images\",\n \"parentFolderId\": \"25284aa06584441ea94338fdcfbaba12\",\n \"createdDate\": \"2022-04-17T15:37:02Z\",\n \"updatedDate\": \"2022-04-26T20:09:32Z\",\n \"state\": \"OK\"\n }\n ],\n \"nextCursor\": {\n \"cursors\": {\n \"next\": \"\"\n },\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"get","path":"/v1/folders","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_LIST"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Media Manager","scopeId":"SCOPE.DC-MEDIA.READ-MEDIAMANAGER"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.ListFoldersRequest","responseMessage":"com.wix.media.site_media.v1.ListFoldersResponse"},"legacyExamples":[{"name":"ListFolders","type":"METHOD","content":{"title":"List folders in a specific parent folder","description":"This example sorts by `displayName` in `DESC` order with a paging limit of 2.","request":"curl -X GET \\\n 'https://www.wixapis.com/site-media/v1/folders?parentFolderId=25284aa06584441ea94338fdcfbaba12&sort.fieldName=displayName&sort.order=DESC&paging.limit=2' \\\n -H 'Authorization: '","response":"{\n \"folders\": [\n {\n \"id\": \"d147e1ab3e8b4114ad93d13bb9e23540\",\n \"displayName\": \"misc\",\n \"parentFolderId\": \"25284aa06584441ea94338fdcfbaba12\",\n \"createdDate\": \"2022-08-30T16:56:29Z\",\n \"updatedDate\": \"2022-08-30T16:56:29Z\",\n \"state\": \"OK\"\n },\n {\n \"id\": \"5bfba6861eed4f009c6abba0dc8b47db\",\n \"displayName\": \"images\",\n \"parentFolderId\": \"25284aa06584441ea94338fdcfbaba12\",\n \"createdDate\": \"2022-04-17T15:37:02Z\",\n \"updatedDate\": \"2022-04-26T20:09:32Z\",\n \"state\": \"OK\"\n }\n ],\n \"nextCursor\": {\n \"cursors\": {\n \"next\": \"\"\n },\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"List Folders","slugifiedName":"list-folders"}},{"summary":"Create Folder","description":"Creates a new folder in the Media Manager.
\n\nUse the `parentFolderId` parameter to specify in which existing folder you want the new folder to be created.\nIf no folder is specified, the new folder is created in the `media-root` folder.","operationId":"com.wix.media.site_media.v1.FoldersService.CreateFolder","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.CreateFolderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-media/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-media/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateFolderRequest","description":"","properties":{"displayName":{"title":"displayName","description":"Folder name that appears in the Media Manager.","maxLength":200,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"parentFolderId":{"title":"parentFolderId","description":"ID of the folder's parent folder.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["displayName"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_CREATE"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.CreateFolderRequest","responseMessage":"com.wix.media.site_media.v1.CreateFolderResponse"},"legacyExamples":[{"name":"CreateFolder","type":"METHOD","content":{"title":"Create a folder","request":"curl -X POST \\\n 'https://www.wixapis.com/site-media/v1/folders' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"displayName\": \"New Folder\",\n \"parentFolderId\": \"25284aa06584441ea94338fdcfbaba12\"\n }'","response":"{\n \"folder\": {\n \"id\": \"d147e1ab3e8b4114ad93d13bb9e23540\",\n \"displayName\": \"New Folder\",\n \"parentFolderId\": \"25284aa06584441ea94338fdcfbaba12\",\n \"createdDate\": \"2022-08-30T16:56:29.000Z\",\n \"updatedDate\": \"2022-08-30T16:56:29.000Z\",\n \"state\": \"OK\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"post","path":"/v1/folders","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_CREATE"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.CreateFolderRequest","responseMessage":"com.wix.media.site_media.v1.CreateFolderResponse"},"legacyExamples":[{"name":"CreateFolder","type":"METHOD","content":{"title":"Create a folder","request":"curl -X POST \\\n 'https://www.wixapis.com/site-media/v1/folders' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"displayName\": \"New Folder\",\n \"parentFolderId\": \"25284aa06584441ea94338fdcfbaba12\"\n }'","response":"{\n \"folder\": {\n \"id\": \"d147e1ab3e8b4114ad93d13bb9e23540\",\n \"displayName\": \"New Folder\",\n \"parentFolderId\": \"25284aa06584441ea94338fdcfbaba12\",\n \"createdDate\": \"2022-08-30T16:56:29.000Z\",\n \"updatedDate\": \"2022-08-30T16:56:29.000Z\",\n \"state\": \"OK\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Create Folder","slugifiedName":"create-folder"}},{"summary":"Get Folder","description":"Gets information from a specific folder in the Media Manager.","operationId":"com.wix.media.site_media.v1.FoldersService.GetFolder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"folderId","description":"Folder ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.GetFolderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-media/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-media/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_READ"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Media Manager","scopeId":"SCOPE.DC-MEDIA.READ-MEDIAMANAGER"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.GetFolderRequest","responseMessage":"com.wix.media.site_media.v1.GetFolderResponse"},"legacyExamples":[{"name":"GetFolder","type":"METHOD","content":{"title":"Get information about a folder","request":"curl -X GET \\\n 'https://www.wixapis.com/site-media/v1/folders/12vn4498977596aeebcf5c41eca01c0d99667ac9' \\\n -H 'Authorization: '","response":"{\n \"folder\": {\n \"id\": \"25284aa06584441ea94338fdcfbaba12\",\n \"displayName\": \"Example folder\",\n \"parentFolderId\": \"media-root\",\n \"createdDate\": \"2022-04-17T21:48:34.000Z\",\n \"updatedDate\": \"2022-04-26T20:07:18.000Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"get","path":"/v1/folders/{folderId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_READ"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Media Manager","scopeId":"SCOPE.DC-MEDIA.READ-MEDIAMANAGER"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.GetFolderRequest","responseMessage":"com.wix.media.site_media.v1.GetFolderResponse"},"legacyExamples":[{"name":"GetFolder","type":"METHOD","content":{"title":"Get information about a folder","request":"curl -X GET \\\n 'https://www.wixapis.com/site-media/v1/folders/12vn4498977596aeebcf5c41eca01c0d99667ac9' \\\n -H 'Authorization: '","response":"{\n \"folder\": {\n \"id\": \"25284aa06584441ea94338fdcfbaba12\",\n \"displayName\": \"Example folder\",\n \"parentFolderId\": \"media-root\",\n \"createdDate\": \"2022-04-17T21:48:34.000Z\",\n \"updatedDate\": \"2022-04-26T20:07:18.000Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Get Folder","slugifiedName":"get-folder"}},{"summary":"Search Folders","description":"Searches the Media Manager and returns a list of folders that match the terms specified in the parameters.
\n\nIf no parameters are specified, the endpoint returns all folders in the `MEDIA_ROOT` folder.","operationId":"com.wix.media.site_media.v1.FoldersService.SearchFolders","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.SearchFoldersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-media/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-media/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SearchFoldersRequest","description":"","properties":{"rootFolder":{"title":"rootFolder","description":"A root folder in the media manager to search in.
\nDefault: `MEDIA_ROOT`.","type":"string","$ref":"#/components/schemas/com.wix.media.site_media.v1.RootFolder","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"$ref":"#/components/schemas/wix.common.Sorting","summary":"sort","description":"Field name and order to sort by. One of:
\n* `displayName`\n* `updatedDate`\nDefault: `updatedDate` in `desc` order.","x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.CursorPaging","summary":"paging","description":"Cursor and paging information.","x-wix-docs":{"exposure":"PUBLIC"}},"search":{"title":"search","description":"Term to search for, such as the value of a folder's `displayName`.
\nFor example, if a folder's `displayName` is 'my-videos-folder', the search term is 'my-videos-folder'.","maxLength":200,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_LIST"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Media Manager","scopeId":"SCOPE.DC-MEDIA.READ-MEDIAMANAGER"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.SearchFoldersRequest","responseMessage":"com.wix.media.site_media.v1.SearchFoldersResponse"},"legacyExamples":[{"name":"SearchFolders","type":"METHOD","content":{"title":"Search folders","request":"curl -X POST \\\n 'https://www.wixapis.com/site-media/v1/folders/search' \\\n -H 'Authorization: '\n --data-binary '{\n \"rootFolder\": \"TRASH_ROOT\",\n \"sort\": {\n \"fieldName\": \"displayName\",\n \"order\": \"DESC\"\n },\n \"paging\": {\n \"limit\": 20\n }\n }'","response":"{\n \"folders\": [\n {\n \"id\": \"d147e1ab3e8b4114ad93d13bb9e23540\",\n \"displayName\": \"a deleted folder\",\n \"parentFolderId\": \"trash-root\",\n \"createdDate\": \"2022-08-30T16:56:29Z\",\n \"updatedDate\": \"2022-08-30T16:56:29Z\",\n \"state\": \"OK\"\n },\n {\n \"id\": \"5bfba6861eed4f009c6abba0dc8b47db\",\n \"displayName\": \"Deleted Folder 2\",\n \"parentFolderId\": \"trash-root\",\n \"createdDate\": \"2022-04-17T15:37:02Z\",\n \"updatedDate\": \"2022-04-26T20:09:32Z\",\n \"state\": \"OK\"\n }\n ],\n \"nextCursor\": {\n \"cursors\": {\n \"next\": \"\"\n },\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"post","path":"/v1/folders/search","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_LIST"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Media Manager","scopeId":"SCOPE.DC-MEDIA.READ-MEDIAMANAGER"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.SearchFoldersRequest","responseMessage":"com.wix.media.site_media.v1.SearchFoldersResponse"},"legacyExamples":[{"name":"SearchFolders","type":"METHOD","content":{"title":"Search folders","request":"curl -X POST \\\n 'https://www.wixapis.com/site-media/v1/folders/search' \\\n -H 'Authorization: '\n --data-binary '{\n \"rootFolder\": \"TRASH_ROOT\",\n \"sort\": {\n \"fieldName\": \"displayName\",\n \"order\": \"DESC\"\n },\n \"paging\": {\n \"limit\": 20\n }\n }'","response":"{\n \"folders\": [\n {\n \"id\": \"d147e1ab3e8b4114ad93d13bb9e23540\",\n \"displayName\": \"a deleted folder\",\n \"parentFolderId\": \"trash-root\",\n \"createdDate\": \"2022-08-30T16:56:29Z\",\n \"updatedDate\": \"2022-08-30T16:56:29Z\",\n \"state\": \"OK\"\n },\n {\n \"id\": \"5bfba6861eed4f009c6abba0dc8b47db\",\n \"displayName\": \"Deleted Folder 2\",\n \"parentFolderId\": \"trash-root\",\n \"createdDate\": \"2022-04-17T15:37:02Z\",\n \"updatedDate\": \"2022-04-26T20:09:32Z\",\n \"state\": \"OK\"\n }\n ],\n \"nextCursor\": {\n \"cursors\": {\n \"next\": \"\"\n },\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Search Folders","slugifiedName":"search-folders"}},{"summary":"Update Folder","description":"Updates a folder.
\n\nYou can use the `parentFolderId` parameter to move a folder from its current parent folder to a different parent folder.","operationId":"com.wix.media.site_media.v1.FoldersService.UpdateFolder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"folder.id","description":"Folder ID. Generated when a folder is created in the Media Manager.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.UpdateFolderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-media/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-media/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateFolderRequest","description":"","properties":{"folder":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder","summary":"folder","description":"The folder to update.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["folder.id","folder"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_UPDATE"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.UpdateFolderRequest","responseMessage":"com.wix.media.site_media.v1.UpdateFolderResponse"},"legacyExamples":[{"name":"UpdateFolder","type":"METHOD","content":{"title":"Update a folder","request":"curl -X PATCH \\\n 'https://www.wixapis.com/site-media/v1/folders/12vn4498977596aeebcf5c41eca01c0d99667ac9' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"folder\": {\n \"displayName\": \"New Folder Name\",\n \"parentFolderId\": \"media-root\"\n },\n \"fieldMask\": {\n \"paths\": [\n \"folder.displayName\",\n \"folder.parentFolderId\"\n ]\n }\n }'","response":"{\n \"folder\": {\n \"id\": \"12vn4498977596aeebcf5c41eca01c0d99667ac9\",\n \"displayName\": \"New Folder Name\",\n \"parentFolderId\": \"media-root\",\n \"createdDate\": \"2022-04-17T21:48:34.000Z\",\n \"updatedDate\": \"2022-08-30T17:09:48.000Z\",\n \"state\": \"OK\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"patch","path":"/v1/folders/{folder.id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_UPDATE"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.UpdateFolderRequest","responseMessage":"com.wix.media.site_media.v1.UpdateFolderResponse"},"legacyExamples":[{"name":"UpdateFolder","type":"METHOD","content":{"title":"Update a folder","request":"curl -X PATCH \\\n 'https://www.wixapis.com/site-media/v1/folders/12vn4498977596aeebcf5c41eca01c0d99667ac9' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"folder\": {\n \"displayName\": \"New Folder Name\",\n \"parentFolderId\": \"media-root\"\n },\n \"fieldMask\": {\n \"paths\": [\n \"folder.displayName\",\n \"folder.parentFolderId\"\n ]\n }\n }'","response":"{\n \"folder\": {\n \"id\": \"12vn4498977596aeebcf5c41eca01c0d99667ac9\",\n \"displayName\": \"New Folder Name\",\n \"parentFolderId\": \"media-root\",\n \"createdDate\": \"2022-04-17T21:48:34.000Z\",\n \"updatedDate\": \"2022-08-30T17:09:48.000Z\",\n \"state\": \"OK\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Update Folder","slugifiedName":"update-folder"}},{"summary":"Generate Folder Download Url","description":"Generates a URL for downloading a compressed file containing a specific folder in the Media Manager.
\n\nThe compressed file can contain sub-folders, and up to 1000 files.
","operationId":"com.wix.media.site_media.v1.FoldersService.GenerateFolderDownloadUrl","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"folderId","description":"Folder ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.GenerateFolderDownloadUrlResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-media/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-media/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"GenerateFolderDownloadUrlRequest","description":"","properties":{},"deprecated":false,"required":["folderId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_DOWNLOAD"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.GenerateFolderDownloadUrlRequest","responseMessage":"com.wix.media.site_media.v1.GenerateFolderDownloadUrlResponse"},"legacyExamples":[{"name":"GenerateFolderDownloadUrl","type":"METHOD","content":{"title":"Generate a URL for downloading a zip file containing the specified folder's content","request":"curl -X POST \\\n 'https://www.wixapis.com/site-media/v1/folders/0c237d681c214835a0b6817a83460281/generate-download-url' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\","response":"{\n \"downloadUrl\": \"https://archive.wixmp.com/archive/wix/722c679976fd424bb5dd4a0077ae458d\"\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"post","path":"/v1/folders/{folderId}/generate-download-url","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_DOWNLOAD"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.GenerateFolderDownloadUrlRequest","responseMessage":"com.wix.media.site_media.v1.GenerateFolderDownloadUrlResponse"},"legacyExamples":[{"name":"GenerateFolderDownloadUrl","type":"METHOD","content":{"title":"Generate a URL for downloading a zip file containing the specified folder's content","request":"curl -X POST \\\n 'https://www.wixapis.com/site-media/v1/folders/0c237d681c214835a0b6817a83460281/generate-download-url' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\","response":"{\n \"downloadUrl\": \"https://archive.wixmp.com/archive/wix/722c679976fd424bb5dd4a0077ae458d\"\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Generate Folder Download Url","slugifiedName":"generate-folder-download-url"}},{"summary":"Bulk Delete Folders","description":"Temporarily deletes the specified folders from the Media Manager.
\n\nThe deleted folders are moved to the Media Manager's `trash-root` folder (trash bin) unless permanently deleted. To permanently delete folders, pass the `permanent` parameter with the value `true`. Permanently deleting folders isn't reversible, so make sure that the files in these folders aren't being used in a site or in any other way as the files will no longer be accessible.\n\nNote the following:\n* When a folder is deleted, the files in that folder are deleted.\n* The specified folders can be from different parent folders.\n* Moving multiple folders at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.\n* Attempting to delete folders that are already in the trash bin doesn't result in an error.\n* If your site contains files from a deleted media folder, the files still appear on your site as the deleted folder is still in the Media Manager (in the trash bin).\n* You can use the [Bulk Restore Folders From Trash Bin](https://dev.wix.com/api/rest/media/media-manager/folders/bulk-restore-folders-from-trash-bin) endpoint to restore folders from the Media Manager's trash bin.","operationId":"com.wix.media.site_media.v1.FoldersService.BulkDeleteFolders","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.BulkDeleteFoldersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-media/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-media/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkDeleteFoldersRequest","description":"","properties":{"folderIds":{"title":"folderIds","description":"IDs of the folders to move to the Media Manager's trash bin.","maxItems":100,"maxLength":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"permanent":{"title":"permanent","description":"Whether the specified folders are permanently deleted.
\nDefault: `false`","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["folderIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_MOVE_TO_TRASH"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.BulkDeleteFoldersRequest","responseMessage":"com.wix.media.site_media.v1.BulkDeleteFoldersResponse"},"legacyExamples":[{"name":"BulkDeleteFolders","type":"METHOD","content":{"title":"Bulk delete folders","request":"curl -X POST \\\n 'https://www.wixapis.com/site-media/v1/bulk/folders/delete' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"folderIds\": [\"25284aa06584441ea94338fdcfbaba12\", \"9v38fdcfbaba12eeb55bcf5c41eca01c0\"]\n }'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"post","path":"/v1/bulk/folders/delete","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_MOVE_TO_TRASH"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.BulkDeleteFoldersRequest","responseMessage":"com.wix.media.site_media.v1.BulkDeleteFoldersResponse"},"legacyExamples":[{"name":"BulkDeleteFolders","type":"METHOD","content":{"title":"Bulk delete folders","request":"curl -X POST \\\n 'https://www.wixapis.com/site-media/v1/bulk/folders/delete' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"folderIds\": [\"25284aa06584441ea94338fdcfbaba12\", \"9v38fdcfbaba12eeb55bcf5c41eca01c0\"]\n }'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Bulk Delete Folders","slugifiedName":"bulk-delete-folders"}},{"summary":"Bulk Restore Folders From Trash Bin","description":"Restores the specified folders from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.","operationId":"com.wix.media.site_media.v1.FoldersService.BulkRestoreFoldersFromTrashBin","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.BulkRestoreFoldersFromTrashBinResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-media/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-media/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkRestoreFoldersFromTrashBinRequest","description":"","properties":{"folderIds":{"title":"folderIds","description":"IDs of the folders to restore from the Media Manager's trash bin.","maxItems":100,"maxLength":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["folderIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_RESTORE_FROM_TRASH"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.BulkRestoreFoldersFromTrashBinRequest","responseMessage":"com.wix.media.site_media.v1.BulkRestoreFoldersFromTrashBinResponse"},"legacyExamples":[{"name":"BulkRestoreFoldersFromTrashBin","type":"METHOD","content":{"title":"Bulk restore deleted folders and their content","request":"curl -X POST \\\n 'https://www.wixapis.com/site-media/v1/bulk/trash-bin/folders/restore' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"folderIds\": [\"25284aa06584441ea94338fdcfbaba12\", \"9v38fdcfbaba12eeb55bcf5c41eca01c0\"]\n }'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"post","path":"/v1/bulk/trash-bin/folders/restore","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_RESTORE_FROM_TRASH"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.BulkRestoreFoldersFromTrashBinRequest","responseMessage":"com.wix.media.site_media.v1.BulkRestoreFoldersFromTrashBinResponse"},"legacyExamples":[{"name":"BulkRestoreFoldersFromTrashBin","type":"METHOD","content":{"title":"Bulk restore deleted folders and their content","request":"curl -X POST \\\n 'https://www.wixapis.com/site-media/v1/bulk/trash-bin/folders/restore' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"folderIds\": [\"25284aa06584441ea94338fdcfbaba12\", \"9v38fdcfbaba12eeb55bcf5c41eca01c0\"]\n }'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Bulk Restore Folders From Trash Bin","slugifiedName":"bulk-restore-folders-from-trash-bin"}},{"summary":"List Deleted Folders","description":"Retrieves a list of folders in the Media Manager's trash bin.","operationId":"com.wix.media.site_media.v1.FoldersService.ListDeletedFolders","parameters":[{"name":"parentFolderId","in":"query","description":"ID of the folder's parent folder.","required":false,"schema":{"title":"parentFolderId","description":"ID of the folder's parent folder.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"sort","in":"query","description":"Field name and order to sort by. One of:
\n* `displayName`\n* `updatedDate`\nDefault: `updatedDate` in `desc` order.","required":false,"schema":{"$ref":"#/components/schemas/wix.common.Sorting","summary":"sort","description":"Field name and order to sort by. One of:
\n* `displayName`\n* `updatedDate`\nDefault: `updatedDate` in `desc` order.","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"paging","in":"query","description":"Cursor and paging information.","required":false,"schema":{"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.CursorPaging","summary":"paging","description":"Cursor and paging information.","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.ListDeletedFoldersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-media/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-media/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_LIST_DELETED"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Media Manager","scopeId":"SCOPE.DC-MEDIA.READ-MEDIAMANAGER"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.ListDeletedFoldersRequest","responseMessage":"com.wix.media.site_media.v1.ListDeletedFoldersResponse"},"legacyExamples":[{"name":"ListDeletedFolders","type":"METHOD","content":{"title":"List folders in the Media Manager's trash bin","description":"This example sorts by `updatedDate` in `DESC` order with a paging limit of 2.","request":"curl -X GET \\\n 'https://www.wixapis.com/site-media/v1/trash-bin/folders?sort.fieldName=updateDate&sort.order=DESC&paging.limit=2' \\\n -H 'Authorization: '","response":"{\n \"folders\": [\n {\n \"id\": \"d147e1ab3e8b4114ad93d13bb9e23540\",\n \"displayName\": \"New Folder\",\n \"parentFolderId\": \"trash-root\",\n \"createdDate\": \"2022-08-30T16:56:29Z\",\n \"updatedDate\": \"2022-08-30T16:56:29Z\",\n \"state\": \"OK\"\n },\n {\n \"id\": \"5bfba6861eed4f009c6abba0dc8b47db\",\n \"displayName\": \"New Folder 2\",\n \"parentFolderId\": \"trash-root\",\n \"createdDate\": \"2022-04-17T15:37:02Z\",\n \"updatedDate\": \"2022-04-26T20:09:32Z\",\n \"state\": \"OK\"\n }\n ],\n \"nextCursor\": {\n \"cursors\": {\n \"next\": \"\"\n },\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"get","path":"/v1/trash-bin/folders","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.media.site_media.v1.FoldersService","errors":[],"exposure":"PUBLIC","permissions":["MEDIA.SITE_MEDIA_FOLDERS_LIST_DELETED"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Media Manager","scopeId":"SCOPE.DC-MEDIA.READ-MEDIAMANAGER"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"protoArtifactId":"com.wixpress.proto:wix-privatemedia-proxy-api","serviceArtifactId":"com.wixpress.prospero.wix-privatemedia-proxy-server","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.media.site_media.v1.ListDeletedFoldersRequest","responseMessage":"com.wix.media.site_media.v1.ListDeletedFoldersResponse"},"legacyExamples":[{"name":"ListDeletedFolders","type":"METHOD","content":{"title":"List folders in the Media Manager's trash bin","description":"This example sorts by `updatedDate` in `DESC` order with a paging limit of 2.","request":"curl -X GET \\\n 'https://www.wixapis.com/site-media/v1/trash-bin/folders?sort.fieldName=updateDate&sort.order=DESC&paging.limit=2' \\\n -H 'Authorization: '","response":"{\n \"folders\": [\n {\n \"id\": \"d147e1ab3e8b4114ad93d13bb9e23540\",\n \"displayName\": \"New Folder\",\n \"parentFolderId\": \"trash-root\",\n \"createdDate\": \"2022-08-30T16:56:29Z\",\n \"updatedDate\": \"2022-08-30T16:56:29Z\",\n \"state\": \"OK\"\n },\n {\n \"id\": \"5bfba6861eed4f009c6abba0dc8b47db\",\n \"displayName\": \"New Folder 2\",\n \"parentFolderId\": \"trash-root\",\n \"createdDate\": \"2022-04-17T15:37:02Z\",\n \"updatedDate\": \"2022-04-26T20:09:32Z\",\n \"state\": \"OK\"\n }\n ],\n \"nextCursor\": {\n \"cursors\": {\n \"next\": \"\"\n },\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"List Deleted Folders","slugifiedName":"list-deleted-folders"}}],"webhooks":[{"summary":"Folder Created","title":"Folder Created","description":"Triggered when a folder is created.\n\nThis event is also triggred when a folder is restored from the Media Manager's trash bin.","permissions":["MEDIA.SITE_MEDIA_FOLDERS_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.media.site_media.v1.folder","serviceName":"com.wix.media.site_media.v1.FoldersService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Media Manager","scopeId":"SCOPE.DC-MEDIA.READ-MEDIAMANAGER"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"legacyExamples":[{"name":"FolderCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\" : \"52269077-05f2-4b59-ba4f-36ef8c4c1e11\",\n \"entityFqdn\" : \"wix.media.site_media.v1.folder\",\n \"slug\" : \"created\",\n \"entityId\" : \"25284aa06584441ea94338fdcfbaba12\",\n \"createdEvent\" : {\n \"entityAsJson\" : {\n \"id\": \"25284aa06584441ea94338fdcfbaba12\",\n \"displayName\": \"Example folder\",\n \"parentFolderId\": \"media-root\",\n \"createdDate\": \"2022-04-17T21:48:34.000Z\",\n \"updatedDate\": \"2022-04-26T20:07:18.000Z\",\n \"state\": \"OK\"\n }\n },\n \"eventTime\" : \"2020-10-18T13:40:58.304800Z\",\n \"triggeredByAnonymizeRequest\" : false\n}"}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder","contentLink":{"displayName":"Folder Created","slugifiedName":"folder-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Folder Updated","title":"Folder Updated","description":"Triggered when a folder is updated, including when a folder is moved to a different parent folder.","permissions":["MEDIA.SITE_MEDIA_FOLDERS_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.media.site_media.v1.folder","serviceName":"com.wix.media.site_media.v1.FoldersService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Media Manager","scopeId":"SCOPE.DC-MEDIA.READ-MEDIAMANAGER"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"legacyExamples":[{"name":"FolderUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"686563e5-74ed-489a-88ee-b07d1657c18d\",\n \"entityFqdn\": \"wix.media.site_media.v1.folder\",\n \"slug\": \"updated\",\n \"entityId\": \"25284aa06584441ea94338fdcfbaba12\",\n \"updatedEvent\": {\n \"currentEntityAsJson\": {\n \"id\": \"25284aa06584441ea94338fdcfbaba12\",\n \"displayName\": \"Example folder\",\n \"parentFolderId\": \"media-root\",\n \"createdDate\": \"2022-04-17T21:48:34.000Z\",\n \"updatedDate\": \"2022-04-26T20:07:18.000Z\",\n \"state\": \"OK\"\n }\n },\n \"eventTime\": \"2022-04-17T21:48:50.730Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder","contentLink":{"displayName":"Folder Updated","slugifiedName":"folder-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Folder Deleted","title":"Folder Deleted","description":"Triggered when a folder is deleted.\n\nIf the `movedToTrash` property in the event object is `true`, the folder was moved to the Media Manager's trash bin. If the `movedToTrash` property in the event object is `false`, the folder was permanently deleted.","permissions":["MEDIA.SITE_MEDIA_FOLDERS_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.media.site_media.v1.folder","serviceName":"com.wix.media.site_media.v1.FoldersService","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Read Media Manager","scopeId":"SCOPE.DC-MEDIA.READ-MEDIAMANAGER"},{"name":"Manage Media Manager","scopeId":"SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER"}],"legacyExamples":[{"name":"FolderDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"44bb8fd1-ee47-4673-9aez-26783569dcf2\",\n \"entityFqdn\": \"wix.media.site_media.v1.folder\",\n \"slug\": \"deleted\",\n \"entityId\": \"25284aa06584441ea94338fdcfbaba12\",\n \"deletedEvent\": {\n \"movedToTrash\": false\n },\n \"eventTime\": \"2023-01-05T14:06:11.408Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder","contentLink":{"displayName":"Folder Deleted","slugifiedName":"folder-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[],"components":{"schemas":{"com.wix.media.site_media.v1.Folder":{"type":"object","properties":{"id":{"title":"id","description":"Folder ID. Generated when a folder is created in the Media Manager.","readOnly":false,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"displayName":{"title":"displayName","description":"Folder name as it appears in the Media Manager.","maxLength":256,"readOnly":false,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"parentFolderId":{"title":"parentFolderId","description":"ID of the folder's parent folder.
Default: `media-root` folder.","readOnly":false,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"title":"createdDate","description":"Date the folder was created.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"updatedDate":{"title":"updatedDate","description":"Date the folder was updated.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"state":{"title":"state","description":"State of the folder.","readOnly":true,"type":"string","$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder.State","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Folder","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"title":"seconds","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"title":"nanos","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"com.wix.media.site_media.v1.Folder.State":{"type":"string","description":"","title":"State","enum":["OK","DELETED"]},"com.wix.media.site_media.v1.Namespace":{"type":"string","description":"","title":"Namespace","enum":["NO_NAMESPACE","OTHERS","WIX_VIDEO","WIX_MUSIC","ALBUMS_AND_ART_STORE","WIX_ECOM","PHOTO_SHARE_APP","SHARING_APP","CHAT","LOGO_BUILDER","ALBUMS_OLD","CHAT_MOBILE","WIX_FORMS"]},"com.wix.media.site_media.v1.CreateFolderRequest":{"type":"object","properties":{"displayName":{"title":"displayName","description":"Folder name that appears in the Media Manager.","maxLength":200,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"parentFolderId":{"title":"parentFolderId","description":"ID of the folder's parent folder.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateFolderRequest","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"com.wix.media.site_media.v1.CreateFolderResponse":{"type":"object","properties":{"folder":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder","summary":"folder","description":"Information about the newly created folder.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateFolderResponse","description":""},"com.wix.media.site_media.v1.GetFolderRequest":{"type":"object","properties":{"folderId":{"title":"folderId","description":"Folder ID.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetFolderRequest","description":""},"com.wix.media.site_media.v1.GetFolderResponse":{"type":"object","properties":{"folder":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder","summary":"folder","description":"Information about the folder.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetFolderResponse","description":""},"com.wix.media.site_media.v1.ListFoldersRequest":{"type":"object","properties":{"parentFolderId":{"title":"parentFolderId","description":"ID of the folder's parent folder.\n
Default: `media-root` folder.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"$ref":"#/components/schemas/wix.common.Sorting","summary":"sort","description":"Field name and order to sort by. One of:
\n* `displayName`\n* `updatedDate`\nDefault: `updatedDate` in `desc` order.","x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.CursorPaging","summary":"paging","description":"Cursor and paging information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListFoldersRequest","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"title":"fieldName","description":"Name of the field to sort by.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"title":"order","description":"Sort order.","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wix.media.site_media.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"title":"limit","description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"cursor":{"title":"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.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CursorPaging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int32Value","description":""},"com.wix.media.site_media.v1.ListFoldersResponse":{"type":"object","properties":{"folders":{"title":"folders","description":"Information about the folders in the requested folder.","maxItems":200,"type":"array","items":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder"},"x-wix-docs":{"exposure":"PUBLIC"}},"nextCursor":{"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.PagingMetadataV2","summary":"nextCursor","description":"The next cursor if it exists.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListFoldersResponse","description":""},"com.wix.media.site_media.upstream.wix.common.PagingMetadataV2":{"type":"object","properties":{"total":{"title":"total","description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"cursors":{"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.Cursors","summary":"cursors","description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PagingMetadataV2","description":""},"com.wix.media.site_media.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"title":"next","description":"Cursor string pointing to the next page in the list of results.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Cursors","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"com.wix.media.site_media.v1.SearchFoldersRequest":{"type":"object","properties":{"rootFolder":{"title":"rootFolder","description":"A root folder in the media manager to search in.
\nDefault: `MEDIA_ROOT`.","type":"string","$ref":"#/components/schemas/com.wix.media.site_media.v1.RootFolder","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"$ref":"#/components/schemas/wix.common.Sorting","summary":"sort","description":"Field name and order to sort by. One of:
\n* `displayName`\n* `updatedDate`\nDefault: `updatedDate` in `desc` order.","x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.CursorPaging","summary":"paging","description":"Cursor and paging information.","x-wix-docs":{"exposure":"PUBLIC"}},"search":{"title":"search","description":"Term to search for, such as the value of a folder's `displayName`.
\nFor example, if a folder's `displayName` is 'my-videos-folder', the search term is 'my-videos-folder'.","maxLength":200,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SearchFoldersRequest","description":""},"com.wix.media.site_media.v1.RootFolder":{"type":"string","description":"","title":"RootFolder","enum":["MEDIA_ROOT","TRASH_ROOT","VISITOR_UPLOADS_ROOT"]},"com.wix.media.site_media.v1.SearchFoldersResponse":{"type":"object","properties":{"folders":{"title":"folders","description":"Information about the folders in the requested folder.","maxItems":200,"type":"array","items":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder"},"x-wix-docs":{"exposure":"PUBLIC"}},"nextCursor":{"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.PagingMetadataV2","summary":"nextCursor","description":"The next cursor if it exists.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SearchFoldersResponse","description":""},"com.wix.media.site_media.v1.UpdateFolderRequest":{"type":"object","properties":{"folder":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder","summary":"folder","description":"The folder to update.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateFolderRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"title":"paths","description":"","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FieldMask","description":""},"com.wix.media.site_media.v1.UpdateFolderResponse":{"type":"object","properties":{"folder":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder","summary":"folder","description":"Information about the updated folder.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateFolderResponse","description":""},"com.wix.media.site_media.v1.GenerateFolderDownloadUrlRequest":{"type":"object","properties":{"folderId":{"title":"folderId","description":"Folder ID.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GenerateFolderDownloadUrlRequest","description":""},"com.wix.media.site_media.v1.GenerateFolderDownloadUrlResponse":{"type":"object","properties":{"downloadUrl":{"title":"downloadUrl","description":"URL for downloading a specific folder in the Media Manager.","format":"WEB_URL","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GenerateFolderDownloadUrlResponse","description":""},"com.wix.media.site_media.v1.BulkDeleteFoldersRequest":{"type":"object","properties":{"folderIds":{"title":"folderIds","description":"IDs of the folders to move to the Media Manager's trash bin.","maxItems":100,"maxLength":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"permanent":{"title":"permanent","description":"Whether the specified folders are permanently deleted.
\nDefault: `false`","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkDeleteFoldersRequest","description":""},"com.wix.media.site_media.v1.BulkDeleteFoldersResponse":{"type":"object","properties":{},"title":"BulkDeleteFoldersResponse","description":""},"com.wix.media.site_media.v1.BulkRestoreFoldersFromTrashBinRequest":{"type":"object","properties":{"folderIds":{"title":"folderIds","description":"IDs of the folders to restore from the Media Manager's trash bin.","maxItems":100,"maxLength":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkRestoreFoldersFromTrashBinRequest","description":""},"com.wix.media.site_media.v1.BulkRestoreFoldersFromTrashBinResponse":{"type":"object","properties":{},"title":"BulkRestoreFoldersFromTrashBinResponse","description":""},"com.wix.media.site_media.v1.ListDeletedFoldersRequest":{"type":"object","properties":{"parentFolderId":{"title":"parentFolderId","description":"ID of the folder's parent folder.","maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"$ref":"#/components/schemas/wix.common.Sorting","summary":"sort","description":"Field name and order to sort by. One of:
\n* `displayName`\n* `updatedDate`\nDefault: `updatedDate` in `desc` order.","x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.CursorPaging","summary":"paging","description":"Cursor and paging information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListDeletedFoldersRequest","description":""},"com.wix.media.site_media.v1.ListDeletedFoldersResponse":{"type":"object","properties":{"folders":{"title":"folders","description":"List of folders in the Media Manager's trash bin.","maxItems":200,"type":"array","items":{"$ref":"#/components/schemas/com.wix.media.site_media.v1.Folder"},"x-wix-docs":{"exposure":"PUBLIC"}},"nextCursor":{"$ref":"#/components/schemas/com.wix.media.site_media.upstream.wix.common.PagingMetadataV2","summary":"nextCursor","description":"The next cursor if it exists.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListDeletedFoldersResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"title":"id","description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"entityFqdn":{"title":"entityFqdn","description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"slug":{"title":"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","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"entityId":{"title":"entityId","description":"ID of the entity associated with the event.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"eventTime":{"title":"eventTime","description":"Event timestamp.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"triggeredByAnonymizeRequest":{"title":"triggeredByAnonymizeRequest","description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"originatedFrom":{"title":"originatedFrom","description":"If present, indicates the action that triggered the event.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"entityEventSequence":{"title":"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.","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC"}}},"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":{"$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"updatedEvent":{"$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"deletedEvent":{"$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"actionEvent":{"$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","description":"","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"title":"entityAsJson","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"title":"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.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EntityUpdatedEvent","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":{"title":"nullValue","description":"","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"title":"numberValue","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"title":"stringValue","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"title":"boolValue","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"title":"structValue","description":"","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"title":"listValue","description":"","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"title":"fields","description":"","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Struct","description":""},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"title":"values","description":"","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"title":"deletedEntityAsJson","description":"Entity that was deleted","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"title":"bodyAsJson","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int64Value","description":""}}},"title":"Folder","description":"","fqdn":"wix.media.site_media.v1.folder"},"articles":[]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Search Folders

Permission Scopes