Assignments: Fix started_at Regression (#310)

* Assignments: Fix `started_at` Regression Signed-off-by: Collin Bachman <3395010+bachmacintosh@users.noreply.github.com> * Keep started_at optional Signed-off-by: Collin Bachman <3395010+bachmacintosh@users.noreply.github.com> * Fix validatePayload Signed-off-by: Collin Bachman <3395010+bachmacintosh@users.noreply.github.com> * Update example Signed-off-by: Collin Bachman <3395010+bachmacintosh@users.noreply.github.com> * Update tests Signed-off-by: Collin Bachman <3395010+bachmacintosh@users.noreply.github.com> * Bump version Signed-off-by: Collin Bachman <3395010+bachmacintosh@users.noreply.github.com> --------- Signed-off-by: Collin Bachman <3395010+bachmacintosh@users.noreply.github.com>
bachmacintosh · Oct 27, 2024 · d435f71 · d435f71
1 parent 65f108e
commit d435f71
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 9 deletions.
diff --git a/EXAMPLES.md b/EXAMPLES.md
@@ -270,7 +270,9 @@ async function startAssignment(id: number, started_at?: WKDatableString | Date):
   let payload: WKAssignmentPayload = {};
   if (typeof started_at !== "undefined" && (isWKDatableString(started_at) || started_at instanceof Date)) {
     payload = {
-      started_at,
+      assignment: {
+        started_at,
+      },
     };
   }
   const request = new WKRequestFactory({ apiToken: WANIKANI_API_TOKEN, revision: WK_API_REVISION }).assignments.start(

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@bachmacintosh/wanikani-api-types",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "Regularly updated type definitions for the WaniKani API",
   "keywords": [
     "wanikani",

diff --git a/src/assignments/v20170710.ts b/src/assignments/v20170710.ts
@@ -209,7 +209,12 @@ export interface WKAssignmentParameters extends WKCollectionParameters {
  */
 export interface WKAssignmentPayload {
   /**
-   * When the assignment was started. Must be greater than or equal to the assignment's `unlocked_at` date.
-   */
-  started_at?: Date | WKDatableString;
+   * Specify properties of the Assignment; currently only `started_at` is supported.
+   */
+  assignment: {
+    /**
+     * When the assignment was started. Must be greater than or equal to the assignment's `unlocked_at` date.
+     */
+    started_at?: Date | WKDatableString;
+  };
 }
diff --git a/src/base/v20170710.ts b/src/base/v20170710.ts
@@ -845,7 +845,9 @@ export function validatePayload<T extends keyof WKPayloadMap>(type: T, payload:
 
   /* Create required dummy parameters */
   const assignmentStartPayload: Required<WKAssignmentPayload> = {
-    started_at: new Date(),
+    assignment: {
+      started_at: new Date(),
+    },
   };
   const reviewCreatePayloadAssignment: Required<WKReviewPayload> = {
     review: {

diff --git a/tests/base/validatePayload.test.ts b/tests/base/validatePayload.test.ts
@@ -6,7 +6,9 @@ import type { WKReviewPayload } from "../../src/reviews/v20170710";
 import { validatePayload } from "../../src/base/v20170710";
 
 const assignmentStartPayload: Required<WKAssignmentPayload> = {
-  started_at: new Date(),
+  assignment: {
+    started_at: new Date(),
+  },
 };
 const reviewCreatePayloadAssignment: Required<WKReviewPayload> = {
   review: {

diff --git a/tests/requests/WKRequestFactory.test.ts b/tests/requests/WKRequestFactory.test.ts
@@ -93,10 +93,12 @@ it("Returns PUT request for starting an Assignment", () => {
     "Content-Type": "application/json",
     "X-Forwarded-For": "192.168.1.1",
   };
-  const expectedBody = `{"started_at":"2023-02-04T15:30:00.000Z"}`;
+  const expectedBody = `{"assignment":{"started_at":"2023-02-04T15:30:00.000Z"}}`;
 
   const payload: WKAssignmentPayload = {
-    started_at: new Date("2023-02-04T15:30:00.000Z"),
+    assignment: {
+      started_at: new Date("2023-02-04T15:30:00.000Z"),
+    },
   };
 
   const request = wanikani.assignments.start(123, payload, putPostOptions);