1 | import { BaseCollection, CursorPaginatedCollection, CursorPaginatedCollectionProp, DefaultElements, ISO8601Timestamp, Link, MakeRequest, MakeRequestPayload } from '../common-types';
|
2 | import { AsyncActionProcessingOptions } from '../methods/action';
|
3 | import { ReleaseActionProps } from './release-action';
|
4 |
|
5 | declare type Entity = 'Entry' | 'Asset';
|
6 | export interface ReleaseQueryOptions {
|
7 |
|
8 | 'entities.sys.linkType'?: string;
|
9 |
|
10 | 'entities.sys.id[in]'?: string;
|
11 |
|
12 | 'sys.id[in]'?: string;
|
13 |
|
14 | 'title[match]'?: string;
|
15 |
|
16 | pageNext?: string;
|
17 | |
18 |
|
19 |
|
20 |
|
21 | limit?: number;
|
22 | |
23 |
|
24 |
|
25 |
|
26 | order?: string;
|
27 | |
28 |
|
29 |
|
30 | 'sys.createdBy.sys.id[in]'?: string;
|
31 | }
|
32 | export declare type ReleaseSysProps = {
|
33 | id: string;
|
34 | type: 'Release';
|
35 | version: number;
|
36 | space: Link<'Space'>;
|
37 | environment: Link<'Environment'>;
|
38 | createdBy: Link<'User'> | Link<'AppDefinition'>;
|
39 | updatedBy: Link<'User'> | Link<'AppDefinition'>;
|
40 | createdAt: ISO8601Timestamp;
|
41 | updatedAt: ISO8601Timestamp;
|
42 | lastAction?: Link<'ReleaseAction'>;
|
43 | };
|
44 |
|
45 | export interface ReleaseProps {
|
46 | title: string;
|
47 | sys: ReleaseSysProps;
|
48 | entities: BaseCollection<Link<Entity>>;
|
49 | }
|
50 | export interface ReleasePayload extends MakeRequestPayload {
|
51 | title: string;
|
52 | entities: BaseCollection<Link<Entity>>;
|
53 | }
|
54 | export interface ReleaseValidatePayload {
|
55 | action?: 'publish';
|
56 | }
|
57 | export interface ReleaseValidateOptions {
|
58 | payload?: ReleaseValidatePayload;
|
59 | processingOptions?: AsyncActionProcessingOptions;
|
60 | }
|
61 | export interface ReleaseApiMethods {
|
62 |
|
63 | update(payload: ReleasePayload): Promise<Release>;
|
64 |
|
65 | delete(): Promise<void>;
|
66 |
|
67 | publish(options?: AsyncActionProcessingOptions): Promise<ReleaseActionProps<'publish'>>;
|
68 |
|
69 | unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseActionProps<'unpublish'>>;
|
70 |
|
71 | validate({ payload, options, }?: {
|
72 | payload?: ReleaseValidatePayload;
|
73 | options?: AsyncActionProcessingOptions;
|
74 | }): Promise<ReleaseActionProps<'validate'>>;
|
75 | }
|
76 | export interface Release extends ReleaseProps, ReleaseApiMethods, DefaultElements<ReleaseProps> {
|
77 | }
|
78 |
|
79 |
|
80 |
|
81 |
|
82 |
|
83 |
|
84 |
|
85 | export declare function wrapRelease(makeRequest: MakeRequest, data: ReleaseProps): Release;
|
86 |
|
87 |
|
88 |
|
89 | export declare const wrapReleaseCollection: (makeRequest: MakeRequest, data: CursorPaginatedCollectionProp<ReleaseProps>) => CursorPaginatedCollection<Release, ReleaseProps>;
|
90 | export {};
|