Add support for GET /requests endpoint 🦅

README.md

@@ -30,6 +30,17 @@ const api = new TestingFarmAPI("https://api.dev.testing-farm.io/v0.1");
 await api.about();
 ```
 
+### List a Test Requests
+
+documentation of - [`GET /requests`](https://api.dev.testing-farm.io/redoc#operation/get_test_requests_v0_1_requests_get)
+
+```typescript
+const queryParams = { /* https://api.dev.testing-farm.io/redoc#operation/get_test_requests_v0_1_requests_get */ }
+
+const requests: Requests[] = await api.requests(queryParams);
+const requests: unknown = await api.requests(queryParams, false);
+```
+
 ### Request a New Test
 
 documentation of - [`POST /requests`](https://api.dev.testing-farm.io/redoc#operation/request_a_new_test_v0_1_requests_post)

src/index.ts

@@ -10,6 +10,7 @@
   ErrorResponse,
   CancelRequestResponse,
   cancelRequestResponseSchema,
+  RequestsFilter,
 } from './schema';
 import {
   composesSchema,
@@ -51,6 +52,16 @@
     this.link = new PublicLink(urlSchema.parse(instance));
   }
 
+  async requests(filter: RequestsFilter): Promise<Request[]>;
+  async requests(filter: RequestsFilter, strict: boolean): Promise<unknown>;
+  async requests(filter: RequestsFilter, strict?: boolean): Promise<unknown> {
+    if (!this.isStrict(strict)) {
+      return this.link.get('requests', filter);
+    }
+
+    return requestSchema.array().parse(await this.link.get('requests', filter));
+  }
+
   async newRequest(request: NewRequest): Promise<NewRequestResponse>;
   async newRequest(request: NewRequest, strict: boolean): Promise<unknown>;
   async newRequest(request: NewRequest, strict?: boolean): Promise<unknown> {

src/link.ts

@@ -30,14 +30,39 @@
 
   protected abstract request(config: AxiosRequestConfig): Promise<unknown>;
 
-  protected buildURL(path: string): URL {
+  protected buildURL(path: string): URL;
+  protected buildURL<P extends Record<string, string>>(
+    path: string,
+    searchParams: P
+  ): URL;
+  protected buildURL<P extends Record<string, string>>(
+    path: string,
+    searchParams?: P
+  ): URL {
     let url = new URL(`${this.instance.pathname}/${path}`, this.instance);
+
+    if (searchParams) {
+      url.search = new URLSearchParams(searchParams).toString();
+    }
+
     return url;
   }
 
-  async get(path: string): Promise<unknown> {
+  async get(path: string): Promise<unknown>;
+  async get<P extends Record<string, string>>(
+    path: string,
+    searchParams: P
+  ): Promise<unknown>;
+  async get<P extends Record<string, string>>(
+    path: string,
+    searchParams?: P
+  ): Promise<unknown> {
+    const url = searchParams
+      ? this.buildURL(path, searchParams)
+      : this.buildURL(path);
+
     const config: AxiosRequestConfig = {
-      url: this.buildURL(path).toString(),
+      url: url.toString(),
       method: 'GET',
     };
 

src/schema.ts

@@ -113,6 +113,15 @@ const settingsSchema = z.object({
     .optional(),
 });
 
+export const requestsFilterSchema = z.object({
+  state: z.string(),
+  user_id: z.string(),
+  created_before: z.string(),
+  created_after: z.string(),
+});
+
+export type RequestsFilter = z.infer<typeof requestsFilterSchema>;
+
 export const newRequestSchema = z.object({
   api_key: z.string().min(1),
   test: testObjectSchema,