/
build_collection.ts
41 lines (34 loc) · 1.32 KB
/
build_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
import ow from 'ow';
import { Build } from './build';
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: ApiClientOptionsWithOptionalResourcePath) {
super({
...options,
resourcePath: options.resourcePath || 'actor-builds',
});
}
/**
* https://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds
*/
async list(options: BuildCollectionClientListOptions = {}): Promise<BuildCollectionClientListResult> {
ow(options, ow.object.exactShape({
limit: ow.optional.number,
offset: ow.optional.number,
desc: ow.optional.boolean,
}));
return this._list(options);
}
}
export interface BuildCollectionClientListOptions {
limit?: number;
offset?: number;
desc?: boolean;
}
export type BuildCollectionClientListItem = Required<Pick<Build, 'id' | 'status' | 'startedAt' | 'finishedAt'>> & Partial<Pick<Build, 'meta' | 'usageTotalUsd'>>
export type BuildCollectionClientListResult = PaginatedList<BuildCollectionClientListItem>;