feat: add runs() and builds() top level endpoints (#468)

Closes #296
apify · Feb 16, 2024 · 252d2ac · 252d2ac
1 parent 0408407
commit 252d2ac
Show file tree

Hide file tree

Showing 7 changed files with 232 additions and 209 deletions.
diff --git a/src/apify_client.ts b/src/apify_client.ts
@@ -8,7 +8,7 @@ import { RequestInterceptorFunction } from './interceptors';
 import { ActorClient } from './resource_clients/actor';
 import { ActorCollectionClient } from './resource_clients/actor_collection';
 import { BuildClient } from './resource_clients/build';
-// import { BuildCollectionClient } from './resource_clients/build_collection';
+import { BuildCollectionClient } from './resource_clients/build_collection';
 import { DatasetClient } from './resource_clients/dataset';
 import { DatasetCollectionClient } from './resource_clients/dataset_collection';
 import { KeyValueStoreClient } from './resource_clients/key_value_store';
@@ -17,7 +17,7 @@ import { LogClient } from './resource_clients/log';
 import { RequestQueueClient, RequestQueueUserOptions } from './resource_clients/request_queue';
 import { RequestQueueCollectionClient } from './resource_clients/request_queue_collection';
 import { RunClient } from './resource_clients/run';
-// import { RunCollectionClient } from './resource_clients/run_collection';
+import { RunCollectionClient } from './resource_clients/run_collection';
 import { ScheduleClient } from './resource_clients/schedule';
 import { ScheduleCollectionClient } from './resource_clients/schedule_collection';
 import { StoreCollectionClient } from './resource_clients/store_collection';
@@ -107,13 +107,12 @@ export class ApifyClient {
         });
     }
 
-    // TODO we don't have this endpoint yet
-    // /**
-    //  * @return {BuildCollectionClient}
-    //  */
-    // builds() {
-    //     return new BuildCollectionClient(this._options());
-    // }
+    /**
+     * https://docs.apify.com/api/v2#/reference/actor-builds/build-collection
+     */
+    builds(): BuildCollectionClient {
+        return new BuildCollectionClient(this._options());
+    }
 
     /**
      * https://docs.apify.com/api/v2#/reference/actor-builds/build-object
@@ -203,13 +202,15 @@ export class ApifyClient {
         return new RequestQueueClient(apiClientOptions, options);
     }
 
-    // TODO we don't have this endpoint yet
-    // /**
-    //  * @return {RunCollectionClient}
-    //  */
-    // runs() {
-    //     return new RunCollectionClient(this._options());
-    // }
+    /**
+     * https://docs.apify.com/api/v2#/reference/actor-runs/run-collection
+     */
+    runs(): RunCollectionClient {
+        return new RunCollectionClient({
+            ...this._options(),
+            resourcePath: 'actor-runs',
+        });
+    }
 
     /**
      * https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages

diff --git a/src/resource_clients/build_collection.ts b/src/resource_clients/build_collection.ts
@@ -1,15 +1,15 @@
 import ow from 'ow';
 
 import { Build } from './build';
-import { ApiClientOptions } from '../base/api_client';
+import { ApiClientOptionsWithOptionalResourcePath } from '../base/api_client';
 import { ResourceCollectionClient } from '../base/resource_collection_client';
 import { PaginatedList } from '../utils';
 
 export class BuildCollectionClient extends ResourceCollectionClient {
     /**
      * @hidden
      */
-    constructor(options: ApiClientOptions) {
+    constructor(options: ApiClientOptionsWithOptionalResourcePath) {
         super({
             ...options,
             resourcePath: options.resourcePath || 'actor-builds',

diff --git a/src/resource_clients/run_collection.ts b/src/resource_clients/run_collection.ts
@@ -2,15 +2,15 @@ import { ACT_JOB_STATUSES } from '@apify/consts';
 import ow from 'ow';
 
 import { ActorRunListItem } from './actor';
-import { ApiClientSubResourceOptions } from '../base/api_client';
+import { ApiClientOptionsWithOptionalResourcePath } from '../base/api_client';
 import { ResourceCollectionClient } from '../base/resource_collection_client';
 import { PaginatedList } from '../utils';
 
 export class RunCollectionClient extends ResourceCollectionClient {
     /**
      * @hidden
      */
-    constructor(options: ApiClientSubResourceOptions) {
+    constructor(options: ApiClientOptionsWithOptionalResourcePath) {
         super({
             resourcePath: 'runs',
             ...options,

diff --git a/test/builds.test.js b/test/builds.test.js
@@ -35,7 +35,7 @@ describe('Build methods', () => {
     });
 
     describe('builds()', () => {
-        test.skip('list() works', async () => {
+        test('list() works', async () => {
             const query = {
                 limit: 5,
                 offset: 3,

diff --git a/test/mock_server/routes/builds.js b/test/mock_server/routes/builds.js
@@ -5,6 +5,7 @@ const { addRoutes } = require('./add_routes');
 const builds = express.Router();
 
 const ROUTES = [
+    { id: 'list-builds', method: 'GET', path: '/' },
     { id: 'get-build', method: 'GET', path: '/:buildId', type: 'responseJsonMock' },
     { id: 'abort-build', method: 'POST', path: '/:buildId/abort' },
     { id: 'build-log', method: 'GET', path: '/:buildId/log', type: 'text' },

diff --git a/test/mock_server/routes/runs.js b/test/mock_server/routes/runs.js
@@ -5,6 +5,7 @@ const { addRoutes } = require('./add_routes');
 const runs = express.Router();
 
 const ROUTES = [
+    { id: 'list-runs', method: 'GET', path: '/' },
     { id: 'get-run', method: 'GET', path: '/:runId', type: 'responseJsonMock' },
     { id: 'abort-run', method: 'POST', path: '/:runId/abort' },
     { id: 'metamorph-run', method: 'POST', path: '/:runId/metamorph' },