Interface WKPayloadMap

Map PUT and POST requests to the WaniKani API, to their respective Payload types.

interface WKPayloadMap {
    "POST /reviews": WKReviewPayload;
    "POST /study_materials": WKStudyMaterialCreatePayload;
    "PUT /assignments/<id>/start": WKAssignmentPayload;
    "PUT /study_materials/<id>": Partial<WKStudyMaterialBaseData>;
    "PUT /user": WKUserPreferencesPayload;
}

Index

Properties

POST /reviews POST /study_materials PUT /assignments/<id>/start PUT /study_materials/<id> PUT /user

Properties

POST /reviews

"POST /reviews": WKReviewPayload

Payload to create a Review.

POST /study_materials

"POST /study_materials": WKStudyMaterialCreatePayload

Payload to create a new Study Material.

PUT /assignments/<id>/start

"PUT /assignments/<id>/start": WKAssignmentPayload

Payload to start an Assignment.

PUT /study_materials/<id>

"PUT /study_materials/<id>": Partial<WKStudyMaterialBaseData>

Payload to update an existing Study Material.

PUT /user

"PUT /user": WKUserPreferencesPayload

Payload to update the User's Preferences.