@wix/auto_sdk_online-programs_sections 1.0.15 → 1.0.16

package/build/internal/cjs/meta.d.ts

@@ -111,11 +111,29 @@ interface Image {
     width?: number;
     /** Image alt text. */
     altText?: string | null;
+    /**
+     * Image URL expiration date (when relevant).
+     * @internal
+     * @readonly
+     */
+    urlExpirationDate?: Date | null;
     /**
      * Image filename.
      * @readonly
      */
     filename?: string | null;
+    /**
+     * Image size in bytes.
+     * @internal
+     * @readonly
+     * @format DECIMAL_VALUE
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Focal point of the image.
+     * @internal
+     */
+    focalPoint?: FocalPoint;
 }
 interface FocalPoint {
     /** X-coordinate of the focal point. */
@@ -130,6 +148,11 @@ interface FocalPoint {
 interface VideoV2 {
     /** WixMedia ID. */
     id?: string;
+    /**
+     * Original video URL.
+     * @internal
+     */
+    url?: string;
     /**
      * Available resolutions for the video, starting with the optimal resolution.
      * @readonly
@@ -141,6 +164,55 @@ interface VideoV2 {
      * @readonly
      */
     filename?: string | null;
+    /**
+     * Video posters.
+     * @internal
+     * @readonly
+     */
+    posters?: Image[];
+    /**
+     * Original video size in bytes.
+     * @internal
+     * @readonly
+     * @format DECIMAL_VALUE
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Video URL expiration date (when relevant).
+     * @internal
+     * @readonly
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Original video duration in milliseconds.
+     * @internal
+     * @readonly
+     */
+    durationInMilliseconds?: number | null;
+    /**
+     * A short title for the video. will be used for SEO purposes.
+     * @internal
+     * @maxLength 300
+     */
+    title?: string | null;
+    /**
+     * A long description for the video. will be used for SEO purposes.
+     * @internal
+     * @maxLength 2000
+     */
+    description?: string | null;
+    /**
+     * Original video height.
+     * @internal
+     * @readonly
+     */
+    height?: number | null;
+    /**
+     * Original video width.
+     * @internal
+     * @readonly
+     */
+    width?: number | null;
 }
 interface VideoResolution {
     /** Video URL. */
@@ -149,8 +221,68 @@ interface VideoResolution {
     height?: number;
     /** Video width. */
     width?: number;
+    /**
+     * Deprecated. Use the `posters` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    poster?: Image;
     /** Video format for example, mp4, hls. */
     format?: string;
+    /**
+     * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
+     * @internal
+     * @format DECIMAL_VALUE
+     * @deprecated
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Video quality. For example: 480p, 720p.
+     * @internal
+     */
+    quality?: string | null;
+    /**
+     * Video filename.
+     * @internal
+     */
+    filename?: string | null;
+    /**
+     * Video duration in seconds.
+     * @internal
+     * @readonly
+     * @deprecated Video duration in seconds.
+     * @replacedBy duration_in_milliseconds
+     * @targetRemovalDate 2024-08-01
+     */
+    durationInSeconds?: number | null;
+    /**
+     * Video duration in milliseconds.
+     * @internal
+     * @readonly
+     */
+    durationInMilliseconds?: number | null;
+    /**
+     * When true, this is a protected asset, and calling the URL will return a 403 error.
+     * In order to access private assets, make a request to:
+     * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
+     * @internal
+     * @readonly
+     */
+    private?: boolean | null;
+    /**
+     * Key to identify the video resolution's relationship to the original media in WixMedia.
+     * Can be used to request a download for the specific video resolution.
+     * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
+     * @internal
+     * @readonly
+     */
+    assetKey?: string | null;
 }
 declare enum State {
     /** the section isn't ready to be shown to participants. */
@@ -459,6 +591,13 @@ interface GetSectionResponse {
 interface UpdateSectionRequest {
     /** Section to update. Include `section.id`, `section.revision`, and the fields to update. */
     section?: Section;
+    /**
+     * Field mask that specifies which fields to update.
+     *
+     * Fields that aren't included in `fieldMask.paths` are ignored.
+     * @internal
+     */
+    fieldMask?: string[];
     /**
      * Predefined sets of fields to return.
      * @maxSize 1
@@ -549,6 +688,20 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
     /**
      * Origin point for geo-distance sorting on a GEO field
      * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -600,6 +753,13 @@ interface CursorPagingMetadata {
      * + `false`: This is the last page.
      */
     hasNext?: boolean | null;
+    /**
+     * Total number of items matching the filter.
+     * Available only on the first page of *Search* results, not included in *Query* or *List* results.
+     * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.
+     * @internal
+     */
+    total?: number | null;
 }
 interface Cursors {
     /**
@@ -776,8 +936,18 @@ interface DomainEventBodyOneOf {
 }
 interface EntityCreatedEvent {
     entityAsJson?: string;
+    /**
+     * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
+     * @internal
+     */
+    triggeredByUndelete?: boolean | null;
     /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
     restoreInfo?: RestoreInfo;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface RestoreInfo {
     deletedDate?: Date | null;
@@ -789,10 +959,42 @@ interface EntityUpdatedEvent {
      * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
      */
     currentEntityAsJson?: string;
+    /**
+     * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
+     * wont populate it / have any reference to it in the API.
+     * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
+     * the developer should send only the new (current) entity.
+     * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
+     * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
+     * @internal
+     * @deprecated
+     */
+    previousEntityAsJson?: string | null;
+    /**
+     * Map of fully qualified field paths to their previous values for fields that changed.
+     * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
+     * @internal
+     */
+    modifiedFields?: Record<string, any>;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface EntityDeletedEvent {
+    /**
+     * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
+     * @internal
+     */
+    movedToTrash?: boolean | null;
     /** Entity that was deleted. */
     deletedEntityAsJson?: string | null;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface ActionEvent {
     bodyAsJson?: string;