Typescript SDK Type Docs
    Preparing search index...

    Interface ChangeStateTypeChange

    Change triggered by the Change State Type update action.

    interface ChangeStateTypeChange {
        change: string;
        nextValue: StateTypeEnum;
        previousValue: StateTypeEnum;
        type: "ChangeStateTypeChange";
    }

    Hierarchy (View Summary)

    Index

    Properties

    change: string

    Change type on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

    [Records](ctp:history:type:Record) can be filtered by this value using the `changes` query parameter.
    
    nextValue: StateTypeEnum

    Value after the change.

    previousValue: StateTypeEnum

    Value before the change.

    type: "ChangeStateTypeChange"

    Unique discriminator value to reliably deserialize the data type.