@bachman-dev/wanikani-api-types - v2.0.0
    Preparing search index...

    Interface ReviewPayload

    The payload used in the request to create a new review via the WaniKani API.

    interface ReviewPayload {
        review: {
            incorrect_meaning_answers: SafeInteger;
            incorrect_reading_answers: SafeInteger;
            created_at?: Date | DatableString;
        } & (
            | { assignment_id: SafeInteger; subject_id?: undefined }
            | { subject_id: SafeInteger; assignment_id?: undefined }
        );
    }
    Index

    Properties

    Properties

    review: {
        incorrect_meaning_answers: SafeInteger;
        incorrect_reading_answers: SafeInteger;
        created_at?: Date | DatableString;
    } & (
        | { assignment_id: SafeInteger; subject_id?: undefined }
        | { subject_id: SafeInteger; assignment_id?: undefined }
    )

    A review object with either the assignment_id or subject_id specified.

    Type declaration

    • incorrect_meaning_answers: SafeInteger

      Must be zero or a positive number. This is the number of times the meaning was answered incorrectly.

    • incorrect_reading_answers: SafeInteger

      Must be zero or a positive number. This is the number of times the reading was answered incorrectly. Note that subjects with a type of radical do not quiz on readings. Thus, set this value to 0.

    • Optionalcreated_at?: Date | DatableString

      Timestamp when the review was completed. Defaults to the time of the request if omitted from the request body. Must be in the past, but after assignment.available_at.

    • { assignment_id: SafeInteger; subject_id?: undefined }
      • assignment_id: SafeInteger

        Unique identifier of the assignment. This or subject_id must be set.

      • Optionalsubject_id?: undefined

        The subject_id should not be set at the same time as assignment_id.

    • { subject_id: SafeInteger; assignment_id?: undefined }
      • subject_id: SafeInteger

        Unique identifier of the subject. This or assignment_id must be set.

      • Optionalassignment_id?: undefined

        The assignment_id should never be set at the same time as subject_id.