1 | import { DefaultElements, ISO8601Timestamp, BasicCursorPaginationOptions, MetaLinkProps, Link, MakeRequest, SysLink } from '../common-types';
|
2 |
|
3 |
|
4 |
|
5 | declare enum ScheduledActionStatus {
|
6 |
|
7 | scheduled = "scheduled",
|
8 |
|
9 | inProgress = "inProgress",
|
10 |
|
11 | succeeded = "succeeded",
|
12 |
|
13 | failed = "failed",
|
14 |
|
15 | canceled = "canceled"
|
16 | }
|
17 | declare type SchedulableEntityType = 'Entry' | 'Asset' | 'Release';
|
18 | declare type SchedulableActionType = 'publish' | 'unpublish';
|
19 | declare type ErrorDetail = {
|
20 | error: any;
|
21 | };
|
22 | interface ScheduledActionFailedError {
|
23 | sys: {
|
24 | type: 'Error';
|
25 | id: string;
|
26 | };
|
27 | message?: string;
|
28 | details?: {
|
29 | errors: ErrorDetail[];
|
30 | };
|
31 | }
|
32 | export declare type ScheduledActionSysProps = {
|
33 | id: string;
|
34 | type: 'ScheduledAction';
|
35 | version: number;
|
36 | space: SysLink;
|
37 | status: ScheduledActionStatus;
|
38 | createdAt: ISO8601Timestamp;
|
39 | createdBy: Link<'User'> | Link<'AppDefinition'>;
|
40 |
|
41 | canceledAt?: ISO8601Timestamp;
|
42 | canceledBy?: Link<'User'> | Link<'AppDefinition'>;
|
43 |
|
44 | updatedAt: ISO8601Timestamp;
|
45 | updatedBy: Link<'User'> | Link<'AppDefinition'>;
|
46 | };
|
47 | export declare type ScheduledActionProps = {
|
48 | sys: ScheduledActionSysProps;
|
49 | action: SchedulableActionType;
|
50 | entity: Link<SchedulableEntityType>;
|
51 | environment?: {
|
52 | sys: MetaLinkProps;
|
53 | };
|
54 | scheduledFor: {
|
55 | datetime: ISO8601Timestamp;
|
56 | |
57 |
|
58 |
|
59 |
|
60 |
|
61 |
|
62 | timezone?: string;
|
63 | };
|
64 | |
65 |
|
66 |
|
67 |
|
68 |
|
69 |
|
70 |
|
71 |
|
72 |
|
73 |
|
74 |
|
75 |
|
76 |
|
77 |
|
78 |
|
79 | error?: ScheduledActionFailedError;
|
80 | };
|
81 | export declare type CreateUpdateScheduledActionProps = Pick<ScheduledActionProps, 'action' | 'entity' | 'environment' | 'scheduledFor'>;
|
82 | export interface ScheduledActionCollection {
|
83 | sys: {
|
84 | type: 'Array';
|
85 | };
|
86 | pages: BasicCursorPaginationOptions;
|
87 | limit: number;
|
88 | items: ScheduledActionProps[];
|
89 | }
|
90 | export interface ScheduledActionQueryOptions extends BasicCursorPaginationOptions {
|
91 | 'environment.sys.id': string;
|
92 | [key: string]: any;
|
93 | }
|
94 | export declare type ScheduledActionApi = {
|
95 | delete(): Promise<ScheduledAction>;
|
96 | update(): Promise<ScheduledAction>;
|
97 | };
|
98 | export interface ScheduledAction extends ScheduledActionProps, DefaultElements<ScheduledActionProps>, ScheduledActionApi {
|
99 | }
|
100 | export default function getInstanceMethods(makeRequest: MakeRequest): ScheduledActionApi;
|
101 |
|
102 |
|
103 |
|
104 | export declare function wrapScheduledAction(makeRequest: MakeRequest, data: ScheduledActionProps): ScheduledAction;
|
105 |
|
106 |
|
107 |
|
108 | export declare const wrapScheduledActionCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<ScheduledActionProps>) => import("../common-types").Collection<ScheduledAction, ScheduledActionProps>;
|
109 | export {};
|