/
task_collection.ts
57 lines (48 loc) · 1.57 KB
/
task_collection.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
import ow from 'ow';
import { Task, TaskUpdateData } from './task';
import { ApiClientSubResourceOptions } from '../base/api_client';
import { ResourceCollectionClient } from '../base/resource_collection_client';
import { PaginatedList } from '../utils';
export class TaskCollectionClient extends ResourceCollectionClient {
/**
* @hidden
*/
constructor(options: ApiClientSubResourceOptions) {
super({
resourcePath: 'actor-tasks',
...options,
});
}
/**
* https://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks
* @param {object} [options]
* @param {number} [options.limit]
* @param {number} [options.offset]
* @param {boolean} [options.desc]
* @return {Promise<PaginationList>}
*/
async list(options: TaskCollectionListOptions = {}): Promise<PaginatedList<TaskList>> {
ow(options, ow.object.exactShape({
limit: ow.optional.number,
offset: ow.optional.number,
desc: ow.optional.boolean,
}));
return this._list(options);
}
/**
* https://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task
*/
async create(task: TaskCreateData): Promise<Task> {
ow(task, ow.object);
return this._create(task);
}
}
export interface TaskCollectionListOptions {
limit?: number;
offset?: number;
desc?: boolean;
}
export type TaskList = Omit<Task, 'options' | 'input'>;
export interface TaskCreateData extends TaskUpdateData {
actId: string;
}