{"id":"f60a86a0-fa15-4a32-9d00-168c73a6b94f","createdDate":"2024-07-22T07:10:13.167Z","updatedDate":"2024-07-22T07:10:13.167Z","resourceId":"78f08a58-da9a-4f7b-a07e-62e59dc678cd","sdk":{"schema":{"name":"velo-events_wix-media.v2","fqn":"","slug":"velo-events-wix-media-v2","typesMap":{"docs/media-enterprise-public-media-v1-enterprise-category.EnterpriseCategoryCreated":{"name":"EnterpriseCategoryCreated","fqn":"docs/media-enterprise-public-media-v1-enterprise-category.EnterpriseCategoryCreated","slug":"enterprise-category-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EnterpriseCategory","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-category.EnterpriseCategory"},"description":"Created enterprise category."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-category.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-enterprise-public-media-v1-enterprise-category.EnterpriseCategory":{"name":"EnterpriseCategory","fqn":"docs/media-enterprise-public-media-v1-enterprise-category.EnterpriseCategory","slug":"enterprise-category","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the category was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Id of the category"},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the category was updated."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The display name that will be shown for the item"},{"name":"parentCategoryId","slug":"parent-category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Id of the parent category, will default to the account master category"},{"name":"publishStatus","slug":"publish-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PublishStatus","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-category.PublishStatus"},"description":"Publish status of the category"},{"name":"sortOrder","slug":"sort-order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Sort order number of the category, will determine the order of the category with other categories under the same parent category"}]},"docs/media-enterprise-public-media-v1-enterprise-category.MediaType":{"name":"MediaType","fqn":"docs/media-enterprise-public-media-v1-enterprise-category.MediaType","slug":"media-type","actions":[],"enumValues":["ARCHIVE","AUDIO","DOCUMENT","IMAGE","MIXED","MODEL3D","VECTOR","VIDEO"],"properties":[]},"docs/media-enterprise-public-media-v1-enterprise-category.PublishStatus":{"name":"PublishStatus","fqn":"docs/media-enterprise-public-media-v1-enterprise-category.PublishStatus","slug":"publish-status","actions":[],"enumValues":["PUBLISHED","UNDEFINED","UNPUBLISHED","WIX_ONLY"],"properties":[]},"docs/media-enterprise-public-media-v1-enterprise-category.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/media-enterprise-public-media-v1-enterprise-category.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/media-enterprise-public-media-v1-enterprise-category.EnterpriseCategoryDeleted":{"name":"EnterpriseCategoryDeleted","fqn":"docs/media-enterprise-public-media-v1-enterprise-category.EnterpriseCategoryDeleted","slug":"enterprise-category-deleted","actions":[],"properties":[{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-category.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-enterprise-public-media-v1-enterprise-category.EnterpriseCategoryUpdated":{"name":"EnterpriseCategoryUpdated","fqn":"docs/media-enterprise-public-media-v1-enterprise-category.EnterpriseCategoryUpdated","slug":"enterprise-category-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EnterpriseCategory","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-category.EnterpriseCategory"},"description":"Updated enterprise category."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-category.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseItemCreated":{"name":"EnterpriseItemCreated","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseItemCreated","slug":"enterprise-item-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EnterpriseMediaItem","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseMediaItem"},"description":"Created enterprise item."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseMediaItem":{"name":"EnterpriseMediaItem","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseMediaItem","slug":"enterprise-media-item","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the item was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Id of the item in public media"},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the item was updated."},{"name":"assets","slug":"assets","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemAssets","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.ItemAssets"},"description":"The aspect ratio of the item\nAn object containing urls for different views of the item"},{"name":"displayTags","slug":"display-tags","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Tags describing the image, part of searchable fields"},{"name":"internalId","slug":"internal-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"An internal id used with different wix media systems"},{"name":"internalTags","slug":"internal-tags","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Tags for internal client use, part of searchable fields"},{"name":"mediaType","slug":"media-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MediaType","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.MediaType"},"description":"Media type of the item"},{"name":"parentCategoryIds","slug":"parent-category-ids","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Category ids this item belongs to"},{"name":"publishStatus","slug":"publish-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PublishStatus","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.PublishStatus"},"description":"Status of the item"},{"name":"sizeInBytes","slug":"size-in-bytes","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Size of the uploaded file in bytes."},{"name":"systemTags","slug":"system-tags","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Tags for filtering items in the search"},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The item title, part of searchable fields"}]},"docs/media-enterprise-public-media-v1-enterprise-item.ItemAssets":{"name":"ItemAssets","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.ItemAssets","slug":"item-assets","actions":[],"oneofProperties":{"assets":[{"name":"archive","slug":"archive","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Archive","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.Archive"},"description":"Information about the archive."},{"name":"audio","slug":"audio","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Assets for audio media type"},{"name":"document","slug":"document","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Assets for document media type"},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Assets for image media type"},{"name":"model3d","slug":"model3d","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Model3D","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.Model3D"},"description":"Information about the 3D Model."},{"name":"vector","slug":"vector","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Assets for vector media type"},{"name":"video","slug":"video","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Assets for video media type"}]},"properties":[]},"docs/media-enterprise-public-media-v1-enterprise-item.Archive":{"name":"Archive","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.Archive","slug":"archive","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"WixMedia ID."},{"name":"filename","slug":"filename","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Archive filename."},{"name":"sizeInBytes","slug":"size-in-bytes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Archive size in bytes."},{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Archive URL."},{"name":"urlExpirationDate","slug":"url-expiration-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Archive URL expiration date (when relevant)."}]},"docs/media-enterprise-public-media-v1-enterprise-item.Model3D":{"name":"Model3D","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.Model3D","slug":"model3d","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"WixMedia 3D ID."},{"name":"altText","slug":"alt-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"3D alt text."},{"name":"filename","slug":"filename","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"3D filename."},{"name":"sizeInBytes","slug":"size-in-bytes","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"3D size in bytes."},{"name":"thumbnail","slug":"thumbnail","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"3D thumbnail Image"},{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"3D URL."},{"name":"urlExpirationDate","slug":"url-expiration-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"3D URL expiration date (when relevant)."}]},"docs/media-enterprise-public-media-v1-enterprise-item.MediaType":{"name":"MediaType","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.MediaType","slug":"media-type","actions":[],"enumValues":["ARCHIVE","AUDIO","DOCUMENT","IMAGE","MIXED","MODEL3D","VECTOR","VIDEO"],"properties":[]},"docs/media-enterprise-public-media-v1-enterprise-item.PublishStatus":{"name":"PublishStatus","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.PublishStatus","slug":"publish-status","actions":[],"enumValues":["PUBLISHED","UNDEFINED","UNPUBLISHED","WIX_ONLY"],"properties":[]},"docs/media-enterprise-public-media-v1-enterprise-item.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseItemItemCategoriesChanged":{"name":"EnterpriseItemItemCategoriesChanged","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseItemItemCategoriesChanged","slug":"enterprise-item-item-categories-changed","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemCategoriesChanged","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.ItemCategoriesChanged"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-enterprise-public-media-v1-enterprise-item.ItemCategoriesChanged":{"name":"ItemCategoriesChanged","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.ItemCategoriesChanged","slug":"item-categories-changed","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EnterpriseMediaItem","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseMediaItem"},"description":"The full updated item information"},{"name":"itemCategoryIds","slug":"item-category-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"A list of the current item categories"},{"name":"linkedCategoryIds","slug":"linked-category-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"A list of the categories that where linked to the item"},{"name":"unlinkedCategoryIds","slug":"unlinked-category-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"A list of the categories that where unlinked from the item"}]},"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseItemPublishStatusChanged":{"name":"EnterpriseItemPublishStatusChanged","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseItemPublishStatusChanged","slug":"enterprise-item-publish-status-changed","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PublishStatusChanged","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.PublishStatusChanged"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-enterprise-public-media-v1-enterprise-item.PublishStatusChanged":{"name":"PublishStatusChanged","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.PublishStatusChanged","slug":"publish-status-changed","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EnterpriseMediaItem","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseMediaItem"},"description":"The full updated item information"},{"name":"publishStatus","slug":"publish-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PublishStatus","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.PublishStatus"},"description":"The new item status"}]},"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseItemUpdated":{"name":"EnterpriseItemUpdated","fqn":"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseItemUpdated","slug":"enterprise-item-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EnterpriseMediaItem","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.EnterpriseMediaItem"},"description":"Updated enterprise item."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-enterprise-public-media-v1-enterprise-item.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-site-media-v1-file-descriptor.FileDescriptorDeleted":{"name":"FileDescriptorDeleted","fqn":"docs/media-site-media-v1-file-descriptor.FileDescriptorDeleted","slug":"file-descriptor-deleted","actions":[],"properties":[{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-site-media-v1-file-descriptor.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-site-media-v1-file-descriptor.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/media-site-media-v1-file-descriptor.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/media-site-media-v1-file-descriptor.FileDescriptorFileFailed":{"name":"FileDescriptorFileFailed","fqn":"docs/media-site-media-v1-file-descriptor.FileDescriptorFileFailed","slug":"file-descriptor-file-failed","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileFailed","referenceFqn":"docs/media-site-media-v1-file-descriptor.FileFailed"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-site-media-v1-file-descriptor.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-site-media-v1-file-descriptor.FileFailed":{"name":"FileFailed","fqn":"docs/media-site-media-v1-file-descriptor.FileFailed","slug":"file-failed","actions":[],"properties":[{"name":"externalInfo","slug":"external-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExternalInfo","referenceFqn":"docs/media-site-media-v1-file-descriptor.ExternalInfo"},"description":"External information passed in the file import or upload."}]},"docs/media-site-media-v1-file-descriptor.ExternalInfo":{"name":"ExternalInfo","fqn":"docs/media-site-media-v1-file-descriptor.ExternalInfo","slug":"external-info","actions":[],"properties":[{"name":"externalIds","slug":"external-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"External IDs to pass in the [File Ready](https://dev.wix.com/api/rest/media/media-manager/files/file-ready-domain-event) or [File Failed](https://dev.wix.com/api/rest/media/media-manager/files/file-failed-domain-event) events."},{"name":"origin","slug":"origin","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"External information to pass in the [File Ready](https://dev.wix.com/api/rest/media/media-manager/files/file-ready-domain-event) or [File Failed](https://dev.wix.com/api/rest/media/media-manager/files/file-failed-domain-event) events."}]},"docs/media-site-media-v1-file-descriptor.FileDescriptorFileReady":{"name":"FileDescriptorFileReady","fqn":"docs/media-site-media-v1-file-descriptor.FileDescriptorFileReady","slug":"file-descriptor-file-ready","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileReady","referenceFqn":"docs/media-site-media-v1-file-descriptor.FileReady"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-site-media-v1-file-descriptor.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-site-media-v1-file-descriptor.FileReady":{"name":"FileReady","fqn":"docs/media-site-media-v1-file-descriptor.FileReady","slug":"file-ready","actions":[],"properties":[{"name":"externalInfo","slug":"external-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExternalInfo","referenceFqn":"docs/media-site-media-v1-file-descriptor.ExternalInfo"},"description":"External information passed in the file import or upload."},{"name":"file","slug":"file","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileDescriptor","referenceFqn":"docs/media-site-media-v1-file-descriptor.FileDescriptor"},"description":"File entity that is ready with full information"},{"name":"triggeredByUndelete","slug":"triggered-by-undelete","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"The File was restored from the trash-bin"}]},"docs/media-site-media-v1-file-descriptor.FileDescriptor":{"name":"FileDescriptor","fqn":"docs/media-site-media-v1-file-descriptor.FileDescriptor","slug":"file-descriptor","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the file was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"File ID. Generated when a file is uploaded to the Media Manager."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the file was updated."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"File name as it appears in the Media Manager."},{"name":"hash","slug":"hash","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"File hash."},{"name":"labels","slug":"labels","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images."},{"name":"media","slug":"media","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileMedia","referenceFqn":"docs/media-site-media-v1-file-descriptor.FileMedia"},"description":"Media file content."},{"name":"mediaType","slug":"media-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MediaType","referenceFqn":"docs/media-site-media-v1-file-descriptor.MediaType"},"description":"Media file type."},{"name":"operationStatus","slug":"operation-status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OperationStatus","referenceFqn":"docs/media-site-media-v1-file-descriptor.OperationStatus"},"description":"Status of the file that was uploaded.\n* `FAILED`: The file failed to upload, for example, during media post processing.\n* `READY`: The file uploaded, finished all processing, and is ready for use.\n* `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file."},{"name":"parentFolderId","slug":"parent-folder-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the file's parent folder."},{"name":"private","slug":"private","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the link to the uploaded file is public or private. Private links require a token."},{"name":"siteId","slug":"site-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The Wix site ID where the media file is stored."},{"name":"sizeInBytes","slug":"size-in-bytes","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Size of the uploaded file in bytes."},{"name":"sourceUrl","slug":"source-url","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL where the file was uploaded from."},{"name":"state","slug":"state","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"State","referenceFqn":"docs/media-site-media-v1-file-descriptor.State"},"description":"State of the file."},{"name":"thumbnailUrl","slug":"thumbnail-url","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL of the file's thumbnail."},{"name":"url","slug":"url","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Static URL of the file."}]},"docs/media-site-media-v1-file-descriptor.IdentityInfo":{"name":"IdentityInfo","fqn":"docs/media-site-media-v1-file-descriptor.IdentityInfo","slug":"identity-info","actions":[],"properties":[{"name":"identityId","slug":"identity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"User Id. empty when UNKNOWN"},{"name":"identityType","slug":"identity-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"IdentityType","referenceFqn":"docs/media-site-media-v1-file-descriptor.IdentityType"},"description":"The type of the user that uploaded the file"}]},"docs/media-site-media-v1-file-descriptor.IdentityType":{"name":"IdentityType","fqn":"docs/media-site-media-v1-file-descriptor.IdentityType","slug":"identity-type","actions":[],"enumValues":["ANONYMOUS_VISITOR","APP","MEMBER","UNKNOWN","WIX_USER"],"properties":[]},"docs/media-site-media-v1-file-descriptor.FileMedia":{"name":"FileMedia","fqn":"docs/media-site-media-v1-file-descriptor.FileMedia","slug":"file-media","actions":[],"oneofProperties":{"media":[{"name":"archive","slug":"archive","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Archive","referenceFqn":"docs/media-site-media-v1-file-descriptor.Archive"},"description":"Information about the archive."},{"name":"audio","slug":"audio","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AudioV2","referenceFqn":"docs/media-site-media-v1-file-descriptor.AudioV2"},"description":"Information about the audio."},{"name":"document","slug":"document","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Information about the document."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ImageMedia","referenceFqn":"docs/media-site-media-v1-file-descriptor.ImageMedia"},"description":"Information about the image."},{"name":"model3d","slug":"model3d","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Model3D","referenceFqn":"docs/media-site-media-v1-file-descriptor.Model3D"},"description":"Information about the 3D Model."},{"name":"vector","slug":"vector","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ImageMedia","referenceFqn":"docs/media-site-media-v1-file-descriptor.ImageMedia"},"description":"Information about the vector."},{"name":"video","slug":"video","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Information about the video."}]},"properties":[]},"docs/media-site-media-v1-file-descriptor.Archive":{"name":"Archive","fqn":"docs/media-site-media-v1-file-descriptor.Archive","slug":"archive","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"WixMedia ID."},{"name":"filename","slug":"filename","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Archive filename."},{"name":"sizeInBytes","slug":"size-in-bytes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Archive size in bytes."},{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Archive URL."},{"name":"urlExpirationDate","slug":"url-expiration-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Archive URL expiration date (when relevant)."}]},"docs/media-site-media-v1-file-descriptor.AudioV2":{"name":"AudioV2","fqn":"docs/media-site-media-v1-file-descriptor.AudioV2","slug":"audio-v2","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"WixMedia ID."},{"name":"assets","slug":"assets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Audio formats available for this file."},{"name":"bitrate","slug":"bitrate","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Audio bitrate."},{"name":"duration","slug":"duration","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Audio duration in seconds."},{"name":"format","slug":"format","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Audio format."},{"name":"sizeInBytes","slug":"size-in-bytes","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Audio size in bytes."}]},"docs/media-site-media-v1-file-descriptor.ImageMedia":{"name":"ImageMedia","fqn":"docs/media-site-media-v1-file-descriptor.ImageMedia","slug":"image-media","actions":[],"properties":[{"name":"caption","slug":"caption","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional, An AI generated description of the image"},{"name":"colors","slug":"colors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Colors","referenceFqn":"docs/media-site-media-v1-file-descriptor.Colors"},"description":"Image colors."},{"name":"containsText","slug":"contains-text","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Optional, return true or false if the image has text, or empty for unknown"},{"name":"faces","slug":"faces","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FaceRecognition","referenceFqn":"docs/media-site-media-v1-file-descriptor.FaceRecognition"}},"description":"Information about faces in the image. Use to crop images without cutting out faces."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Image data."},{"name":"previewImage","slug":"preview-image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Information about the image preview.\nYou can use this to display a preview for private images."}]},"docs/media-site-media-v1-file-descriptor.Colors":{"name":"Colors","fqn":"docs/media-site-media-v1-file-descriptor.Colors","slug":"colors","actions":[],"properties":[{"name":"palette","slug":"palette","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Color","referenceFqn":"docs/media-site-media-v1-file-descriptor.Color"}},"description":"Color palette of the image."},{"name":"prominent","slug":"prominent","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Color","referenceFqn":"docs/media-site-media-v1-file-descriptor.Color"},"description":"Main color of the image."}]},"docs/media-site-media-v1-file-descriptor.Color":{"name":"Color","fqn":"docs/media-site-media-v1-file-descriptor.Color","slug":"color","actions":[],"properties":[{"name":"hex","slug":"hex","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"HEX color."},{"name":"rgb","slug":"rgb","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ColorRGB","referenceFqn":"docs/media-site-media-v1-file-descriptor.ColorRGB"},"description":"RGB color."}]},"docs/media-site-media-v1-file-descriptor.ColorRGB":{"name":"ColorRGB","fqn":"docs/media-site-media-v1-file-descriptor.ColorRGB","slug":"color-rgb","actions":[],"properties":[{"name":"b","slug":"b","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Blue channel."},{"name":"g","slug":"g","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Green channel."},{"name":"r","slug":"r","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Red channel."}]},"docs/media-site-media-v1-file-descriptor.FaceRecognition":{"name":"FaceRecognition","fqn":"docs/media-site-media-v1-file-descriptor.FaceRecognition","slug":"face-recognition","actions":[],"properties":[{"name":"confidence","slug":"confidence","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The accuracy percentage of the face recognition. The likelihood that a face is detected."},{"name":"height","slug":"height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Face pixel height."},{"name":"width","slug":"width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Face pixel width."},{"name":"x","slug":"x","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Top left x pixel coordinate of the face."},{"name":"y","slug":"y","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Top left y pixel coordinate of the face."}]},"docs/media-site-media-v1-file-descriptor.Model3D":{"name":"Model3D","fqn":"docs/media-site-media-v1-file-descriptor.Model3D","slug":"model3d","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"WixMedia 3D ID."},{"name":"altText","slug":"alt-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"3D alt text."},{"name":"filename","slug":"filename","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"3D filename."},{"name":"sizeInBytes","slug":"size-in-bytes","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"3D size in bytes."},{"name":"thumbnail","slug":"thumbnail","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"3D thumbnail Image"},{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"3D URL."},{"name":"urlExpirationDate","slug":"url-expiration-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"3D URL expiration date (when relevant)."}]},"docs/media-site-media-v1-file-descriptor.OtherMedia":{"name":"OtherMedia","fqn":"docs/media-site-media-v1-file-descriptor.OtherMedia","slug":"other-media","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"WixMedia ID. for use with Site Media APIs only"},{"name":"internalMediaType","slug":"internal-media-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The media type of the file: 'site_icon', 'swf', 'package', 'ufont'"},{"name":"sizeInBytes","slug":"size-in-bytes","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"size in bytes. Optional."}]},"docs/media-site-media-v1-file-descriptor.MediaType":{"name":"MediaType","fqn":"docs/media-site-media-v1-file-descriptor.MediaType","slug":"media-type","actions":[],"enumValues":["ARCHIVE","AUDIO","DOCUMENT","IMAGE","MODEL3D","OTHER","UNKNOWN","VECTOR","VIDEO"],"properties":[]},"docs/media-site-media-v1-file-descriptor.Namespace":{"name":"Namespace","fqn":"docs/media-site-media-v1-file-descriptor.Namespace","slug":"namespace","actions":[],"enumValues":["ALBUMS_AND_ART_STORE","ALBUMS_OLD","CHAT","CHAT_MOBILE","LOGO_BUILDER","NO_NAMESPACE","OTHERS","PHOTO_SHARE_APP","SHARING_APP","WIX_ECOM","WIX_FORMS","WIX_MUSIC","WIX_VIDEO"],"properties":[]},"docs/media-site-media-v1-file-descriptor.OperationStatus":{"name":"OperationStatus","fqn":"docs/media-site-media-v1-file-descriptor.OperationStatus","slug":"operation-status","actions":[],"enumValues":["FAILED","PENDING","READY"],"properties":[]},"docs/media-site-media-v1-file-descriptor.State":{"name":"State","fqn":"docs/media-site-media-v1-file-descriptor.State","slug":"state","actions":[],"enumValues":["DELETED","OK"],"properties":[]},"docs/media-site-media-v1-file-descriptor.FileDescriptorUpdated":{"name":"FileDescriptorUpdated","fqn":"docs/media-site-media-v1-file-descriptor.FileDescriptorUpdated","slug":"file-descriptor-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileDescriptor","referenceFqn":"docs/media-site-media-v1-file-descriptor.FileDescriptor"},"description":"Updated file descriptor."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-site-media-v1-file-descriptor.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-site-media-v1-folder.FolderCreated":{"name":"FolderCreated","fqn":"docs/media-site-media-v1-folder.FolderCreated","slug":"folder-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Folder","referenceFqn":"docs/media-site-media-v1-folder.Folder"},"description":"Created folder."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-site-media-v1-folder.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-site-media-v1-folder.Folder":{"name":"Folder","fqn":"docs/media-site-media-v1-folder.Folder","slug":"folder","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the folder was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Folder ID. Generated when a folder is created in the Media Manager."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the folder was updated."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Folder name as it appears in the Media Manager."},{"name":"parentFolderId","slug":"parent-folder-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the folder's parent folder.
Default: `media-root` folder."},{"name":"state","slug":"state","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"State","referenceFqn":"docs/media-site-media-v1-folder.State"},"description":"State of the folder."}]},"docs/media-site-media-v1-folder.Namespace":{"name":"Namespace","fqn":"docs/media-site-media-v1-folder.Namespace","slug":"namespace","actions":[],"enumValues":["ALBUMS_AND_ART_STORE","ALBUMS_OLD","CHAT","CHAT_MOBILE","LOGO_BUILDER","NO_NAMESPACE","OTHERS","PHOTO_SHARE_APP","SHARING_APP","WIX_ECOM","WIX_FORMS","WIX_MUSIC","WIX_VIDEO"],"properties":[]},"docs/media-site-media-v1-folder.State":{"name":"State","fqn":"docs/media-site-media-v1-folder.State","slug":"state","actions":[],"enumValues":["DELETED","OK"],"properties":[]},"docs/media-site-media-v1-folder.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/media-site-media-v1-folder.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/media-site-media-v1-folder.FolderDeleted":{"name":"FolderDeleted","fqn":"docs/media-site-media-v1-folder.FolderDeleted","slug":"folder-deleted","actions":[],"properties":[{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-site-media-v1-folder.BackendEventMetadata"},"description":"Event metadata."}]},"docs/media-site-media-v1-folder.FolderUpdated":{"name":"FolderUpdated","fqn":"docs/media-site-media-v1-folder.FolderUpdated","slug":"folder-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Folder","referenceFqn":"docs/media-site-media-v1-folder.Folder"},"description":"Updated folder."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/media-site-media-v1-folder.BackendEventMetadata"},"description":"Event metadata."}]}},"actions":[{"name":"onFileDescriptorDeleted","fqn":"wixMediaSiteMedia_onFileDescriptorDeleted","slug":"on-file-descriptor-deleted","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event that triggers when a file is deleted","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixMediaSiteMedia_onFileDescriptorDeleted(event) {\n const eventTime = event.metadata.eventTime;\n const entityId = event.metadata.entityId;\n \n console.log(`File with ID ${entityId} was deleted at ${eventTime}.`);\n}\n \n/* Full event object:\n * {\n * \"metadata\": {\n * \"entityId\": \"d4dde1_e26da94b5cb440649ede0c433425449c~mv2.jpg\",\n * \"eventTime\": \"2023-09-18T10:22:56.532Z\",\n * \"id\": \"c5ad126c-26f0-4ccf-a53c-fa43ea1428bf\",\n * \"triggeredByAnonymizeRequest\": false\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileDescriptorDeleted","referenceFqn":"docs/media-site-media-v1-file-descriptor.FileDescriptorDeleted"},"description":"Contains metadata for the event."}],"description":"Triggered when a file is deleted.","originalName":"wixMediaSiteMedia_onFileDescriptorDeleted"},{"name":"onFileDescriptorFileFailed","fqn":"wixMediaSiteMedia_onFileDescriptorFileFailed","slug":"on-file-descriptor-file-failed","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event that triggers when a file fails during essential post-upload processing","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixMediaSiteMedia_onFileDescriptorFileFailed(event) {\n const eventTime = event.metadata.eventTime;\n const entityId = event.metadata.entityId;\n \n console.log(`File with ID ${entityId} failed during essential post-upload processing at ${eventTime}.`);\n}\n \n/* Full event object:\n * {\n * \"data\": {\n * \"externalInfo\": {}\n * },\n * \"metadata\": {\n * \"entityId\": \"d4dde1_f6660fb1274c41bf87514db2f5926ae0\",\n * \"eventTime\": \"2023-09-18T10:27:33.046Z\",\n * \"id\": \"8cf0189d-9f49-45c5-9f3c-bc7928a42e34\",\n * \"triggeredByAnonymizeRequest\": false\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileDescriptorFileFailed","referenceFqn":"docs/media-site-media-v1-file-descriptor.FileDescriptorFileFailed"},"description":"Information about the failed file and metadata for the event."}],"description":"Triggered when a file fails during post-upload processing.","originalName":"wixMediaSiteMedia_onFileDescriptorFileFailed"},{"name":"onFileDescriptorFileReady","fqn":"wixMediaSiteMedia_onFileDescriptorFileReady","slug":"on-file-descriptor-file-ready","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event that triggers when a file is ready to be used","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixMediaSiteMedia_onFileDescriptorFileReady(event) {\n const displayName = event.data.file.displayName;\n const parentFolderId = event.data.parentFolderId;\n const eventTime = event.metadata.eventTime;\n\n console.log(`${displayName}, located in the parent folder with ID ${parentFolderId}, is ready to be used. Completion of post-upload processing was at ${eventTime}.`)\n}\n\n/* Full event object:\n * {\n * \"data\": {\n * \"externalInfo\": {},\n * \"file\": {\n * \"_createdDate\": \"2023-08-09T08:45:49.000Z\",\n * \"_id\": \"d4dde1_e26da94b5cb440649ede0c433425449c~mv2.jpg\",\n * \"_updatedDate\": \"2023-08-09T08:45:49.000Z\",\n * \"displayName\": \"mountains.jpg\",\n * \"hash\": \"800fae3e0cb7908518a391c25864436c\",\n * \"labels\": [\n * \"mountainous range\",\n * \"mountain range\",\n * \"mountain peak\",\n * \"mountains\",\n * \"snow capped mountains\",\n * \"mountainous landscape\"\n * ],\n * \"media\": {\n * \"image\": {\n * \"colors\": {\n * \"palette\": [\n * {\n * \"rgb\": {\n * \"b\": 47,\n * \"g\": 36,\n * \"r\": 31\n * }\n * },\n * {\n * \"rgb\": {\n * \"b\": 155,\n * \"g\": 153,\n * \"r\": 195\n * }\n * },\n * {\n * \"rgb\": {\n * \"b\": 141,\n * \"g\": 123,\n * \"r\": 138\n * }\n * },\n * {\n * \"rgb\": {\n * \"b\": 177,\n * \"g\": 161,\n * \"r\": 190\n * }\n * },\n * {\n * \"rgb\": {\n * \"b\": 179,\n * \"g\": 178,\n * \"r\": 217\n * }\n * },\n * {\n * \"rgb\": {\n * \"b\": 160,\n * \"g\": 176,\n * \"r\": 229\n * }\n * },\n * {\n * \"rgb\": {\n * \"b\": 176,\n * \"g\": 151,\n * \"r\": 162\n * }\n * },\n * {\n * \"rgb\": {\n * \"b\": 93,\n * \"g\": 78,\n * \"r\": 71\n * }\n * },\n * {\n * \"rgb\": {\n * \"b\": 45,\n * \"g\": 63,\n * \"r\": 107\n * }\n * },\n * {\n * \"rgb\": {\n * \"b\": 104,\n * \"g\": 88,\n * \"r\": 82\n * }\n * }\n * ],\n * \"prominent\": {\n * \"rgb\": {\n * \"b\": 47,\n * \"g\": 36,\n * \"r\": 31\n * }\n * }\n * },\n * \"faces\": [],\n * \"image\": \"wix:image://v1/d4dde1_e26da94b5cb440649ede0c433425449c~mv2.jpg/mountains.jpg#originWidth=5833&originHeight=3894\"\n * }\n * },\n * \"mediaType\": \"IMAGE\",\n * \"operationStatus\": \"READY\",\n * \"parentFolderId\": \"media-root\",\n * \"private\": false,\n * \"siteId\": \"c96bcd13-173a-4938-88e0-a126391adf49\",\n * \"sizeInBytes\": \"3013886\",\n * \"thumbnailUrl\": \"https://static.wixstatic.com/media/d4dde1_e26da94b5cb440649ede0c433425449c~mv2.jpg\",\n * \"url\": \"https://static.wixstatic.com/media/d4dde1_e26da94b5cb440649ede0c433425449c~mv2.jpg\"\n * },\n * \"triggeredByUndelete\": true\n * },\n * \"metadata\": {\n * \"entityId\": \"d4dde1_e26da94b5cb440649ede0c433425449c~mv2.jpg\",\n * \"eventTime\": \"2023-09-18T10:22:49.159Z\",\n * \"id\": \"6057a4bd-86d1-428e-bfe5-026dcc869ec3\",\n * \"triggeredByAnonymizeRequest\": false\n * }\n * }\n */\n"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileDescriptorFileReady","referenceFqn":"docs/media-site-media-v1-file-descriptor.FileDescriptorFileReady"},"description":"Information about the file and metadata for the event."}],"description":"Triggered when a file is ready to be used, after any post-upload processing.\n\n\n\nThis event is also triggered when a file is restored from the Media Manager's trash bin.","originalName":"wixMediaSiteMedia_onFileDescriptorFileReady"},{"name":"onFileDescriptorUpdated","fqn":"wixMediaSiteMedia_onFileDescriptorUpdated","slug":"on-file-descriptor-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event that triggers when a file is updated","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixMediaSiteMedia_onFileDescriptorUpdated(event) {\n const eventTime = event.metadata.eventTime;\n const displayName = event.entity.displayName;\n const parentFolder = event.entity.parentFolderId;\n \n console.log(`${displayName}, currently located in the parent folder with ID ${parentFolder}, was updated at ${eventTime}.`)\n}\n\n/* Full event object:\n * {\n * \"entity\": {\n * \"displayName\": \"image1\",\n * \"mediaType\": \"IMAGE\",\n * \"private\": false,\n * \"operationStatus\": \"READY\",\n * \"url\": \"https://static.wixstatic.com/media/d4dde1_e76448de45bf4deb912b373bc7c3ac6f~mv2.jpg\",\n * \"_id\": \"d4dde1_e76448de45bf4deb912b373bc7c3ac6f~mv2.jpg\",\n * \"_createdDate\": \"2023-08-09T08:45:43.000Z\",\n * \"_updatedDate\": \"2023-09-18T10:22:38.000Z\",\n * \"hash\": \"7fc91042c9a56b42223aa2f94ccdcecd\",\n * \"labels\": [\n * \"label1\",\n * \"label2\"\n * ],\n * \"sizeInBytes\": \"6312959\",\n * \"media\": {\n * \"image\": {\n * \"image\": \"wix:image://v1/d4dde1_e76448de45bf4deb912b373bc7c3ac6f~mv2.jpg/image1#originWidth=5616&originHeight=3744\",\n * \"colors\": {\n * \"prominent\": {\n * \"rgb\": {\n * \"r\": 39,\n * \"g\": 36,\n * \"b\": 26\n * }\n * },\n * \"palette\": [\n * {\n * \"rgb\": {\n * \"r\": 39,\n * \"g\": 36,\n * \"b\": 26\n * }\n * },\n * {\n * \"rgb\": {\n * \"r\": 119,\n * \"g\": 125,\n * \"b\": 135\n * }\n * },\n * {\n * \"rgb\": {\n * \"r\": 208,\n * \"g\": 209,\n * \"b\": 208\n * }\n * },\n * {\n * \"rgb\": {\n * \"r\": 130,\n * \"g\": 108,\n * \"b\": 40\n * }\n * },\n * {\n * \"rgb\": {\n * \"r\": 75,\n * \"g\": 101,\n * \"b\": 133\n * }\n * },\n * {\n * \"rgb\": {\n * \"r\": 94,\n * \"g\": 78,\n * \"b\": 36\n * }\n * },\n * {\n * \"rgb\": {\n * \"r\": 148,\n * \"g\": 161,\n * \"b\": 178\n * }\n * },\n * {\n * \"rgb\": {\n * \"r\": 163,\n * \"g\": 177,\n * \"b\": 192\n * }\n * },\n * {\n * \"rgb\": {\n * \"r\": 208,\n * \"g\": 184,\n * \"b\": 159\n * }\n * },\n * {\n * \"rgb\": {\n * \"r\": 183,\n * \"g\": 159,\n * \"b\": 137\n * }\n * }\n * ]\n * },\n * \"faces\": []\n * }\n * },\n * \"metadata\": {\n * \"entityId\": \"d4dde1_e76448de45bf4deb912b373bc7c3ac6f~mv2.jpg\",\n * \"eventTime\": \"2023-09-18T10:22:39.193Z\",\n * \"id\": \"acfe4b7a-bc6a-41f5-8fb3-d0f1301fea51\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"siteId\": \"c96bcd13-173a-4938-88e0-a126391adf49\",\n * \"thumbnailUrl\": \"https://static.wixstatic.com/media/d4dde1_e76448de45bf4deb912b373bc7c3ac6f~mv2.jpg\",\n * \"parentFolderId\": \"b2bc72834460412494c93617d88b8c89\"\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileDescriptorUpdated","referenceFqn":"docs/media-site-media-v1-file-descriptor.FileDescriptorUpdated"},"description":"Information about the updated file and metadata for the event."}],"originalName":"wixMediaSiteMedia_onFileDescriptorUpdated"},{"name":"onFolderCreated","fqn":"wixMediaSiteMedia_onFolderCreated","slug":"on-folder-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event that triggers when a folder is created","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixMediaSiteMedia_onFolderCreated(event) {\n const displayName = event.entity.displayName;\n const parentFolderId = event.entity.parentFolderId;\n const eventTime = event.metadata.eventTime;\n\n console.log(`New folder, \"${displayName},\" was created in the parent folder with ID ${parentFolderId} at ${eventTime}.`);\n}\n\n/* Full event object:\n * {\n * \"entity\": {\n * \"_createdDate\": \"2023-09-18T10:20:23.000Z\",\n * \"_id\": \"a7b49f96836a48febefb10f669c14ab0\",\n * \"_updatedDate\": \"2023-09-18T10:20:23.000Z\",\n * \"displayName\": \"Videos\",\n * \"parentFolderId\": \"media-root\"\n * },\n * \"metadata\": {\n * \"entityId\": \"a7b49f96836a48febefb10f669c14ab0\",\n * \"eventTime\": \"2023-09-18T10:20:24.401Z\",\n * \"id\": \"00c0a4d0-1987-4d2f-9cb4-0dec0b969d60\",\n * \"triggeredByAnonymizeRequest\": false\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FolderCreated","referenceFqn":"docs/media-site-media-v1-folder.FolderCreated"},"description":"Information about the created file and metadata for the event."}],"description":"Triggered when a folder is created.\n\nThis event is also triggered when a folder is restored from the Media Manager's trash bin.","originalName":"wixMediaSiteMedia_onFolderCreated"},{"name":"onFolderDeleted","fqn":"wixMediaSiteMedia_onFolderDeleted","slug":"on-folder-deleted","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event that triggers when a folder is deleted","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixMediaSiteMedia_onFolderDeleted(event) {\n const folderId = event.metadata.entityId;\n const eventTime = event.metadata.eventTime;\n\n console.log(`Folder with ID ${folderId} was deleted at ${eventTime}.`)\n}\n\n/* Full event object:\n * {\n * \"metadata\": {\n * \"entityId\": \"a7b49f96836a48febefb10f669c14ab0\",\n * \"eventTime\": \"2023-09-18T10:25:38.721Z\",\n * \"id\": \"2ce042ce-3a31-4c3a-8b34-4c5e223a4b15\",\n * \"triggeredByAnonymizeRequest\": false\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FolderDeleted","referenceFqn":"docs/media-site-media-v1-folder.FolderDeleted"},"description":"Contains metadata for the event."}],"description":"Triggered when a folder is deleted.","originalName":"wixMediaSiteMedia_onFolderDeleted"},{"name":"onFolderUpdated","fqn":"wixMediaSiteMedia_onFolderUpdated","slug":"on-folder-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event that triggers when a folder is updated","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixMediaSiteMedia_onFolderUpdated(event) {\n const displayName = event.entity.displayName;\n const parentFolderId = event.entity.parentFolderId;\n const eventTime = event.metadata.eventTime;\n \n console.log(`Folder, \"${displayName},\" that is found in the folder with ID ${parentFolderId}, was updated at ${eventTime}.`);\n}\n\n/* Full event object:\n * {\n * \"entity\": {\n * \"_createdDate\": \"2023-08-21T05:34:03.000Z\",\n * \"_id\": \"302fc049d70c41dea33fa4a27ab481ba\",\n * \"_updatedDate\": \"2023-09-18T10:20:49.000Z\",\n * \"displayName\": \"Folder31\",\n * \"parentFolderId\": \"media-root\"\n * },\n * \"metadata\": {\n * \"entityId\": \"302fc049d70c41dea33fa4a27ab481ba\",\n * \"eventTime\": \"2023-09-18T10:20:50.411Z\",\n * \"id\": \"f5b62b5f-9f83-41d3-b0cd-8cae506b3d35\",\n * \"triggeredByAnonymizeRequest\": false\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FolderUpdated","referenceFqn":"docs/media-site-media-v1-folder.FolderUpdated"},"description":"Information about the updated file and metadata for the event."}],"originalName":"wixMediaSiteMedia_onFolderUpdated"}],"webhooks":[],"articles":[{"content":"---\ntitle: Introduction\n---\n\n# Introduction\n\n\n\n\nWix Media events are triggered on your site's backend when certain events occur in your media manager.\nYou can write event handlers that react to these events. Event handler functions receive data\nthat corresponds to the event that was fired. Use event handlers to create custom responses\nto media events. \n\nTo add a Wix Media event handler, add an **events.js** file to the **Backend** section of your site\nif one does not already exists. All event handler functions for your site are defined in this\nfile. \n\n\n> **Notes:**\n> - This module is [universal](/api-overview/api-versions#universal-modules). Functions in this module can run on both the backend and frontend, unless specified otherwise.\n> - Backend events don't work when previewing your site.\n\n\nEvent handler functions are defined using the following pattern:\n```javascript\nexport function _(event) {}\n```\n\nFor example, an event handler that handles the update of a file descriptor looks like:\n```javascript\nexport function wixMediaSiteMedia_onFileDescriptorUpdated(event) {}\n```","displayName":"Introduction","slugifyName":"introduction"}],"namespaces":[],"builderTypes":[],"properties":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.72"}}

onFileDescriptorFileReady( )