Update get_suites response type for TestRail API compatibility

README.md

@@ -464,7 +464,7 @@ getSuite(suiteId: number): Promise<Suite>
 ```
 
 ```typescript
-getSuites(projectId: number): Promise<Suite[]>
+getSuites(projectId: number): Promise<Suites>
 ```
 
 ```typescript

src/TestRail.ts

@@ -1,7 +1,7 @@
 import type { TestRailCtx } from './TestRailCtx';
 import { TestRailException } from './TestRailException';
 import * as methods from './groups';
-import type { AddAttachment, AddCase, AddCaseField, AddConfig, AddConfigGroup, AddDataset, AddGroup, AddMilestone, AddPlan, AddPlanEntry, AddProject, AddResult, AddResults, AddResultsForCases, AddRun, AddRunToPlanEntry, AddSection, AddSharedStep, AddSuite, AddUser, AddVariable, AttachmentForCase, AttachmentForPlan, AttachmentForPlanEntry, AttachmentForRun, AttachmentForTest, Case, CaseField, CaseFilters, CaseHistory, CaseStatus, CaseType, Config, ConfigItem, CopyCasesToSection, CreatedAttachment, Dataset, DeleteCases, DeleteSharedStep, Group, Milestone, MilestoneFilters, MoveCasesToSection, MoveSection, Pagination, Plan, PlanEntry, PlanFilters, PlanItem, Priority, Project, ProjectFilters, Report, ReportUrls, Request, Response, Result, ResultField, ResultFilters, ResultForRunFilters, Role, Run, RunFilters, Section, SectionFilters, SharedStep, SharedStepFilters, SharedStepHistory, Status, Suite, Template, Test, TestFilters, UpdateCase, UpdateCases, UpdateConfig, UpdateConfigGroup, UpdateMilestone, UpdatePlan, UpdatePlanEntry, UpdateProject, UpdateRun, UpdateRunInPlanEntry, UpdateSection, UpdateSharedStep, UpdateSuite, User, UserFilters, Variable } from './payload';
+import type { AddAttachment, AddCase, AddCaseField, AddConfig, AddConfigGroup, AddDataset, AddGroup, AddMilestone, AddPlan, AddPlanEntry, AddProject, AddResult, AddResults, AddResultsForCases, AddRun, AddRunToPlanEntry, AddSection, AddSharedStep, AddSuite, AddUser, AddVariable, AttachmentForCase, AttachmentForPlan, AttachmentForPlanEntry, AttachmentForRun, AttachmentForTest, Case, CaseField, CaseFilters, CaseHistory, CaseStatus, CaseType, Config, ConfigItem, CopyCasesToSection, CreatedAttachment, Dataset, DeleteCases, DeleteSharedStep, Group, Milestone, MilestoneFilters, MoveCasesToSection, MoveSection, Pagination, Plan, PlanEntry, PlanFilters, PlanItem, Priority, Project, ProjectFilters, Report, ReportUrls, Request, Response, Result, ResultField, ResultFilters, ResultForRunFilters, Role, Run, RunFilters, Section, SectionFilters, SharedStep, SharedStepFilters, SharedStepHistory, Status, Suite, Suites, Template, Test, TestFilters, UpdateCase, UpdateCases, UpdateConfig, UpdateConfigGroup, UpdateMilestone, UpdatePlan, UpdatePlanEntry, UpdateProject, UpdateRun, UpdateRunInPlanEntry, UpdateSection, UpdateSharedStep, UpdateSuite, User, UserFilters, Variable } from './payload';
 
 export * from './payload';
 export type { Request as Payload, Response as Model };
@@ -420,7 +420,7 @@ export default class TestRail {
     return this.withCtx(options, (ctx) => methods.getSuite(ctx, suiteId));
   }
 
-  getSuites(projectId: number, options?: Signal): Promise<Suite[]> {
+  getSuites(projectId: number, options?: Signal): Promise<Suites> {
     return this.withCtx(options, (ctx) => methods.getSuites(ctx, projectId));
   }
 

src/groups/suites.ts

@@ -1,12 +1,12 @@
 import type { TestRailCtx } from '../TestRailCtx';
 import { _api } from '../internal/request';
-import type { AddSuite, Suite, UpdateSuite } from '../payload';
+import type { AddSuite, Suite, Suites, UpdateSuite } from '../payload';
 
 export function getSuite(ctx: TestRailCtx, suiteId: number): Promise<Suite> {
   return _api(ctx, 'GET', `get_suite/${suiteId}`);
 }
 
-export function getSuites(ctx: TestRailCtx, projectId: number): Promise<Suite[]> {
+export function getSuites(ctx: TestRailCtx, projectId: number): Promise<Suites> {
   return _api(ctx, 'GET', `get_suites/${projectId}`);
 }
 

src/payload/response/Suites.ts

@@ -0,0 +1,12 @@
+import { Suite } from "./Suite";
+
+export interface Suites extends Record<string, unknown> {
+  "offset": number,
+  "limit": number,
+  "size": number,
+  "_links": {
+    "next": string,
+    "prev": unknown
+  },
+  "suites": Suite[]
+}

src/payload/response/index.ts

@@ -35,6 +35,7 @@ export * from './SharedStep';
 export * from './SharedStepHistory';
 export * from './Status';
 export * from './Suite';
+export * from './Suites';
 export * from './Template';
 export * from './Test';
 export * from './User';