Add responce types for Tag, History, WikiCount #28

nulab · May 22, 2023 · 53da8fb · 53da8fb
1 parent 644fbfa
commit 53da8fb
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 6 deletions.
diff --git a/dist/types/backlog.d.ts b/dist/types/backlog.d.ts
@@ -397,11 +397,11 @@ export default class Backlog extends Request {
     /**
      * https://developer.nulab.com/docs/backlog/api/2/count-wiki-page/
      */
-    getWikisCount(projectIdOrKey: string | number): Promise<any>;
+    getWikisCount(projectIdOrKey: string | number): Promise<Entity.Wiki.WikiCount>;
     /**
      * https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-tag-list/
      */
-    getWikisTags(projectIdOrKey: string | number): Promise<any>;
+    getWikisTags(projectIdOrKey: string | number): Promise<Entity.Wiki.Tag[]>;
     /**
      * https://developer.nulab.com/docs/backlog/api/2/add-wiki-page/
      */
@@ -449,7 +449,7 @@ export default class Backlog extends Request {
     /**
      * https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-history/
      */
-    getWikisHistory(wikiId: number, params: Option.Wiki.GetWikisHistoryParams): Promise<any>;
+    getWikisHistory(wikiId: number, params: Option.Wiki.GetWikisHistoryParams): Promise<Entity.Wiki.History[]>;
     /**
      * https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-star/
      */

diff --git a/dist/types/entity.d.ts b/dist/types/entity.d.ts
@@ -225,3 +225,20 @@ export declare namespace Star {
         count: number;
     }
 }
+export declare namespace Wiki {
+    interface Tag {
+        id: number;
+        name: string;
+    }
+    interface History {
+        pageId: number;
+        version: number;
+        name: string;
+        content: string;
+        createdUser: User.User;
+        created: string;
+    }
+    interface WikiCount {
+        count: number;
+    }
+}
diff --git a/src/backlog.ts b/src/backlog.ts
@@ -789,14 +789,14 @@ export default class Backlog extends Request {
   /**
    * https://developer.nulab.com/docs/backlog/api/2/count-wiki-page/
    */
-  public getWikisCount(projectIdOrKey: string | number): Promise<any> {
+  public getWikisCount(projectIdOrKey: string | number): Promise<Entity.Wiki.WikiCount> {
     return this.get(`wikis/count`, { projectIdOrKey });
   }
 
   /**
    * https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-tag-list/
    */
-  public getWikisTags(projectIdOrKey: string | number): Promise<any> {
+  public getWikisTags(projectIdOrKey: string | number): Promise<Entity.Wiki.Tag[]> {
     return this.get(`wikis/tags`, { projectIdOrKey });
   }
 
@@ -884,7 +884,7 @@ export default class Backlog extends Request {
    */
   public getWikisHistory(
     wikiId: number, params: Option.Wiki.GetWikisHistoryParams
-  ): Promise<any> {
+  ): Promise<Entity.Wiki.History[]> {
     return this.get(`wikis/${wikiId}/history`, params);
   }
 

diff --git a/src/entity.ts b/src/entity.ts
@@ -258,4 +258,24 @@ export namespace Star {
   export interface StarCount {
     count: number;
   }
+}
+
+export namespace Wiki {
+  export interface Tag {
+    id: number;
+    name: string;
+  }
+
+  export interface History {
+    pageId: number;
+    version: number;
+    name: string;
+    content: string;
+    createdUser: User.User;
+    created: string;
+  }
+
+  export interface WikiCount {
+    count: number;
+  }
 }