feat: Add unlockRequests endpoint to RequestQueue client (#700)

Implement the `unlockRequests` method in the RequestQueue client to
support the new API endpoint. Update the mock server and tests to
include the endpoint.

Author: drobnikj

src/resource_clients/request_queue.ts

@@ -503,6 +503,22 @@ export class RequestQueueClient extends ResourceClient {
         return cast(parseDateFields(pluckData(response.data)));
     }
 
+    /**
+     * https://docs.apify.com/api/v2/request-queue-requests-unlock-post
+     */
+    async unlockRequests(): Promise<RequestQueueClientUnlockRequestsResult> {
+        const response = await this.httpClient.call({
+            url: this._url('requests/unlock'),
+            method: 'POST',
+            timeout: this.timeoutMillis,
+            params: this._params({
+                clientKey: this.clientKey,
+            }),
+        });
+
+        return cast(parseDateFields(pluckData(response.data)));
+    }
+
     /**
      * https://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests
      *
@@ -676,6 +692,10 @@ interface UnprocessedRequest {
     method?: AllowedHttpMethods;
 }
 
+export interface RequestQueueClientUnlockRequestsResult {
+    unlockedCount: number;
+}
+
 export interface RequestQueueClientBatchRequestsOperationResult {
     processedRequests: ProcessedRequest[];
     unprocessedRequests: UnprocessedRequest[];

test/mock_server/routes/request_queues.js

@@ -16,6 +16,7 @@ const ROUTES = [
     { id: 'put-lock-request', method: 'PUT', path: '/:queueId/requests/:requestId/lock' },
     { id: 'delete-lock-request', method: 'DELETE', path: '/:queueId/requests/:requestId/lock' },
     { id: 'batch-insert', method: 'POST', path: '/:queueId/requests/batch', type: 'dummyBatchOperation' },
+    { id: 'unlock-requests', method: 'POST', path: '/:queueId/requests/unlock' },
     { id: 'batch-delete', method: 'DELETE', path: '/:queueId/requests/batch', type: 'dummyBatchOperation' },
     { id: 'get-request', method: 'GET', path: '/:queueId/requests/:requestId' },
     { id: 'delete-request', method: 'DELETE', path: '/:queueId/requests/:requestId' },

test/request_queues.test.js

@@ -166,6 +166,18 @@ describe('Request Queue methods', () => {
             validateRequest({ forefront }, { queueId }, request);
         });
 
+        test('unlockRequests() works', async () => {
+            const queueId = 'some-id';
+
+            const res = await client.requestQueue(queueId).unlockRequests();
+            expect(res.id).toEqual('unlock-requests');
+            validateRequest({}, { queueId });
+
+            const browserRes = await page.evaluate((id) => client.requestQueue(id).unlockRequests(), queueId);
+            expect(browserRes).toEqual(res);
+            validateRequest({}, { queueId });
+        });
+
         test('getRequest() works', async () => {
             const queueId = 'some-id';
             const requestId = 'xxx';