-
Notifications
You must be signed in to change notification settings - Fork 0
/
shared.ts
60 lines (52 loc) · 1.06 KB
/
shared.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
58
59
60
interface RequestOptions {
apiKey?: string;
correlationId?: string;
}
type QueryValue =
| boolean
| number
| string
| null
| undefined
| Record<string, string>
| (number | string)[];
interface PaginatedQuery {
[key: string]: QueryValue;
[key: number]: QueryValue;
page?: number;
size?: number;
}
interface PaginatedList<T> {
pagination: {
totalItems: number;
pageNumber: number;
pageSize: number;
totalPages: number;
};
data: T[];
}
type Create<T, C> = {
create(model: C, options?: RequestOptions): Promise<T>;
};
type Retrieve<T> = {
retrieve(id: string, options?: RequestOptions): Promise<T>;
};
type Update<T, U> = {
update(id: string, model: U, options?: RequestOptions): Promise<T>;
};
type Delete = {
delete(id: string, options?: RequestOptions): Promise<void>;
};
type List<T, Q extends PaginatedQuery = PaginatedQuery> = {
list(query?: Q, options?: RequestOptions): Promise<PaginatedList<T>>;
};
export type {
RequestOptions,
PaginatedQuery,
PaginatedList,
Create,
Retrieve,
Update,
Delete,
List,
};