@gradientedge/commercetools-utils
    Preparing search index...

    Interface ReviewRatingSetMessage

    Generated after a successful Set Rating update action.

    interface ReviewRatingSetMessage {
        createdAt: string;
        createdBy?: CreatedBy;
        id: string;
        includedInStatistics: boolean;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        newRating?: number;
        oldRating?: number;
        resource: Reference;
        resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
        resourceVersion: number;
        sequenceNumber: number;
        target?: Reference;
        type: "ReviewRatingSet";
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt createdBy? id includedInStatistics lastModifiedAt lastModifiedBy? newRating? oldRating? resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber target? type version

    Properties

    createdAt: string

    Date and time (UTC) the Message was generated.

    createdBy?: CreatedBy

    IDs and references that created the Message.

    id: string

    Unique identifier of the Message. Can be used to track which Messages have been processed.

    includedInStatistics: boolean

    Whether the Review was taken into account in the ratings statistics of the target.

    lastModifiedAt: string

    Value of createdAt.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the Message.

    newRating?: number

    The rating of the Review after the Set Rating update action.

    oldRating?: number

    The rating of the Review before the Set Rating update action.

    resource: Reference

    Reference to the resource on which the change or action was performed.

    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers

    User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

    resourceVersion: number

    Version of the resource on which the change or action was performed.

    sequenceNumber: number

    Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

    target?: Reference

    Reference to the resource that the Review belongs to.

    type: "ReviewRatingSet"

    Message Type of the Message.

    version: number

    Version of a resource. In case of Messages, this is always 1.

    Settings

    Member Visibility

    On This Page

    Properties