@wix/auto_sdk_editor-branches_branches 1.0.11 → 1.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +89 -1
- package/build/cjs/index.js +726 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1265 -1
- package/build/cjs/index.typings.js +602 -15
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +317 -1
- package/build/cjs/meta.js +430 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +89 -0
- package/build/es/index.mjs +687 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{internal/cjs/src/editor-branches-v1-branch-branches.universal.d.ts → es/index.typings.d.mts} +156 -109
- package/build/es/index.typings.mjs +566 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +317 -0
- package/build/es/meta.mjs +400 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +89 -1
- package/build/internal/cjs/index.js +726 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +1265 -1
- package/build/internal/cjs/index.typings.js +602 -15
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +317 -1
- package/build/internal/cjs/meta.js +430 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +89 -0
- package/build/internal/es/index.mjs +687 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/{cjs/src/editor-branches-v1-branch-branches.universal.d.ts → internal/es/index.typings.d.mts} +156 -109
- package/build/internal/es/index.typings.mjs +566 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +317 -0
- package/build/internal/es/meta.mjs +400 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +12 -10
- package/build/cjs/src/editor-branches-v1-branch-branches.context.d.ts +0 -21
- package/build/cjs/src/editor-branches-v1-branch-branches.context.js +0 -33
- package/build/cjs/src/editor-branches-v1-branch-branches.context.js.map +0 -1
- package/build/cjs/src/editor-branches-v1-branch-branches.http.d.ts +0 -22
- package/build/cjs/src/editor-branches-v1-branch-branches.http.js +0 -286
- package/build/cjs/src/editor-branches-v1-branch-branches.http.js.map +0 -1
- package/build/cjs/src/editor-branches-v1-branch-branches.meta.d.ts +0 -27
- package/build/cjs/src/editor-branches-v1-branch-branches.meta.js +0 -161
- package/build/cjs/src/editor-branches-v1-branch-branches.meta.js.map +0 -1
- package/build/cjs/src/editor-branches-v1-branch-branches.public.d.ts +0 -69
- package/build/cjs/src/editor-branches-v1-branch-branches.public.js +0 -92
- package/build/cjs/src/editor-branches-v1-branch-branches.public.js.map +0 -1
- package/build/cjs/src/editor-branches-v1-branch-branches.types.d.ts +0 -930
- package/build/cjs/src/editor-branches-v1-branch-branches.types.js +0 -160
- package/build/cjs/src/editor-branches-v1-branch-branches.types.js.map +0 -1
- package/build/cjs/src/editor-branches-v1-branch-branches.universal.js +0 -433
- package/build/cjs/src/editor-branches-v1-branch-branches.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/editor-branches-v1-branch-branches.context.d.ts +0 -21
- package/build/es/src/editor-branches-v1-branch-branches.context.js +0 -21
- package/build/es/src/editor-branches-v1-branch-branches.context.js.map +0 -1
- package/build/es/src/editor-branches-v1-branch-branches.http.d.ts +0 -22
- package/build/es/src/editor-branches-v1-branch-branches.http.js +0 -276
- package/build/es/src/editor-branches-v1-branch-branches.http.js.map +0 -1
- package/build/es/src/editor-branches-v1-branch-branches.meta.d.ts +0 -27
- package/build/es/src/editor-branches-v1-branch-branches.meta.js +0 -128
- package/build/es/src/editor-branches-v1-branch-branches.meta.js.map +0 -1
- package/build/es/src/editor-branches-v1-branch-branches.public.d.ts +0 -69
- package/build/es/src/editor-branches-v1-branch-branches.public.js +0 -73
- package/build/es/src/editor-branches-v1-branch-branches.public.js.map +0 -1
- package/build/es/src/editor-branches-v1-branch-branches.types.d.ts +0 -930
- package/build/es/src/editor-branches-v1-branch-branches.types.js +0 -157
- package/build/es/src/editor-branches-v1-branch-branches.types.js.map +0 -1
- package/build/es/src/editor-branches-v1-branch-branches.universal.d.ts +0 -1218
- package/build/es/src/editor-branches-v1-branch-branches.universal.js +0 -400
- package/build/es/src/editor-branches-v1-branch-branches.universal.js.map +0 -1
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.context.d.ts +0 -21
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.context.js +0 -33
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.context.js.map +0 -1
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.http.d.ts +0 -22
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.http.js +0 -286
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.http.js.map +0 -1
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.meta.d.ts +0 -27
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.meta.js +0 -161
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.meta.js.map +0 -1
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.public.d.ts +0 -69
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.public.js +0 -92
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.public.js.map +0 -1
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.types.d.ts +0 -930
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.types.js +0 -160
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.types.js.map +0 -1
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.universal.js +0 -433
- package/build/internal/cjs/src/editor-branches-v1-branch-branches.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/editor-branches-v1-branch-branches.context.d.ts +0 -21
- package/build/internal/es/src/editor-branches-v1-branch-branches.context.js +0 -21
- package/build/internal/es/src/editor-branches-v1-branch-branches.context.js.map +0 -1
- package/build/internal/es/src/editor-branches-v1-branch-branches.http.d.ts +0 -22
- package/build/internal/es/src/editor-branches-v1-branch-branches.http.js +0 -276
- package/build/internal/es/src/editor-branches-v1-branch-branches.http.js.map +0 -1
- package/build/internal/es/src/editor-branches-v1-branch-branches.meta.d.ts +0 -27
- package/build/internal/es/src/editor-branches-v1-branch-branches.meta.js +0 -128
- package/build/internal/es/src/editor-branches-v1-branch-branches.meta.js.map +0 -1
- package/build/internal/es/src/editor-branches-v1-branch-branches.public.d.ts +0 -69
- package/build/internal/es/src/editor-branches-v1-branch-branches.public.js +0 -73
- package/build/internal/es/src/editor-branches-v1-branch-branches.public.js.map +0 -1
- package/build/internal/es/src/editor-branches-v1-branch-branches.types.d.ts +0 -930
- package/build/internal/es/src/editor-branches-v1-branch-branches.types.js +0 -157
- package/build/internal/es/src/editor-branches-v1-branch-branches.types.js.map +0 -1
- package/build/internal/es/src/editor-branches-v1-branch-branches.universal.d.ts +0 -1218
- package/build/internal/es/src/editor-branches-v1-branch-branches.universal.js +0 -400
- package/build/internal/es/src/editor-branches-v1-branch-branches.universal.js.map +0 -1
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
2
3
|
/**
|
|
3
4
|
* A branch is a version of draft site content that can be edited independently. Also known as a test site.
|
|
4
5
|
* Read more about branches in this [article](https://support.wix.com/en/article/about-test-sites).
|
|
5
6
|
*/
|
|
6
|
-
|
|
7
|
+
interface Branch extends BranchSourceOneOf {
|
|
7
8
|
/** Source branch properties. */
|
|
8
9
|
sourceBranchProperties?: SourceBranch;
|
|
9
10
|
/** Source template properties. */
|
|
@@ -62,13 +63,13 @@ export interface Branch extends BranchSourceOneOf {
|
|
|
62
63
|
extendedFields?: ExtendedFields;
|
|
63
64
|
}
|
|
64
65
|
/** @oneof */
|
|
65
|
-
|
|
66
|
+
interface BranchSourceOneOf {
|
|
66
67
|
/** Source branch properties. */
|
|
67
68
|
sourceBranchProperties?: SourceBranch;
|
|
68
69
|
/** Source template properties. */
|
|
69
70
|
sourceTemplateProperties?: SourceTemplate;
|
|
70
71
|
}
|
|
71
|
-
|
|
72
|
+
declare enum Type {
|
|
72
73
|
/** Unknown branch type. */
|
|
73
74
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
74
75
|
/** A branch created by a Wix user, that can be accessed for editing and publishing via the editor UI. */
|
|
@@ -79,8 +80,8 @@ export declare enum Type {
|
|
|
79
80
|
ORIGINAL_BRANCH = "ORIGINAL_BRANCH"
|
|
80
81
|
}
|
|
81
82
|
/** @enumType */
|
|
82
|
-
|
|
83
|
-
|
|
83
|
+
type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'USER' | 'TECHNICAL' | 'ORIGINAL_BRANCH';
|
|
84
|
+
declare enum SourceType {
|
|
84
85
|
/** Unknown source type. */
|
|
85
86
|
UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
|
|
86
87
|
/** This branch's source was a branch. */
|
|
@@ -89,12 +90,12 @@ export declare enum SourceType {
|
|
|
89
90
|
SOURCE_TEMPLATE = "SOURCE_TEMPLATE"
|
|
90
91
|
}
|
|
91
92
|
/** @enumType */
|
|
92
|
-
|
|
93
|
-
|
|
93
|
+
type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'SOURCE_BRANCH' | 'SOURCE_TEMPLATE';
|
|
94
|
+
interface EditorType {
|
|
94
95
|
/** Editor type */
|
|
95
96
|
editorTypeOptions?: EditorTypeOptionsWithLiterals;
|
|
96
97
|
}
|
|
97
|
-
|
|
98
|
+
declare enum EditorTypeOptions {
|
|
98
99
|
/** Unknown editor type */
|
|
99
100
|
UNKNOWN_EDITOR_TYPE = "UNKNOWN_EDITOR_TYPE",
|
|
100
101
|
/** STUDIO */
|
|
@@ -103,8 +104,8 @@ export declare enum EditorTypeOptions {
|
|
|
103
104
|
CLASSIC = "CLASSIC"
|
|
104
105
|
}
|
|
105
106
|
/** @enumType */
|
|
106
|
-
|
|
107
|
-
|
|
107
|
+
type EditorTypeOptionsWithLiterals = EditorTypeOptions | 'UNKNOWN_EDITOR_TYPE' | 'STUDIO' | 'CLASSIC';
|
|
108
|
+
interface SourceBranch {
|
|
108
109
|
/**
|
|
109
110
|
* Source branch ID.
|
|
110
111
|
* @format GUID
|
|
@@ -113,14 +114,14 @@ export interface SourceBranch {
|
|
|
113
114
|
/** Source branch revision. */
|
|
114
115
|
branchRevision?: string | null;
|
|
115
116
|
}
|
|
116
|
-
|
|
117
|
+
interface SourceTemplate {
|
|
117
118
|
/**
|
|
118
119
|
* Source template ID.
|
|
119
120
|
* @format GUID
|
|
120
121
|
*/
|
|
121
122
|
templateId?: string;
|
|
122
123
|
}
|
|
123
|
-
|
|
124
|
+
interface ExtendedFields {
|
|
124
125
|
/**
|
|
125
126
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
126
127
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -131,47 +132,47 @@ export interface ExtendedFields {
|
|
|
131
132
|
*/
|
|
132
133
|
namespaces?: Record<string, Record<string, any>>;
|
|
133
134
|
}
|
|
134
|
-
|
|
135
|
+
interface CreateBranchRequest {
|
|
135
136
|
/** Branch to be created. */
|
|
136
137
|
branch: Branch;
|
|
137
138
|
}
|
|
138
|
-
|
|
139
|
+
interface CreateBranchResponse {
|
|
139
140
|
/** Created branch. */
|
|
140
141
|
branch?: Branch;
|
|
141
142
|
}
|
|
142
|
-
|
|
143
|
+
interface GetBranchRequest {
|
|
143
144
|
/**
|
|
144
145
|
* ID of branch to retrieve.
|
|
145
146
|
* @format GUID
|
|
146
147
|
*/
|
|
147
148
|
branchId: string;
|
|
148
149
|
}
|
|
149
|
-
|
|
150
|
+
interface GetBranchResponse {
|
|
150
151
|
/** Requested branch. */
|
|
151
152
|
branch?: Branch;
|
|
152
153
|
}
|
|
153
|
-
|
|
154
|
+
interface UpdateBranchRequest {
|
|
154
155
|
/** Branch to be updated. */
|
|
155
156
|
branch: Branch;
|
|
156
157
|
}
|
|
157
|
-
|
|
158
|
+
interface UpdateBranchResponse {
|
|
158
159
|
/** Updated branch. */
|
|
159
160
|
branch?: Branch;
|
|
160
161
|
}
|
|
161
|
-
|
|
162
|
+
interface DeleteBranchRequest {
|
|
162
163
|
/**
|
|
163
164
|
* ID of branch to delete.
|
|
164
165
|
* @format GUID
|
|
165
166
|
*/
|
|
166
167
|
branchId: string;
|
|
167
168
|
}
|
|
168
|
-
|
|
169
|
+
interface DeleteBranchResponse {
|
|
169
170
|
}
|
|
170
|
-
|
|
171
|
+
interface QueryBranchesRequest {
|
|
171
172
|
/** WQL expression. */
|
|
172
173
|
query?: CursorQuery;
|
|
173
174
|
}
|
|
174
|
-
|
|
175
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
175
176
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
176
177
|
cursorPaging?: CursorPaging;
|
|
177
178
|
/**
|
|
@@ -203,11 +204,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
203
204
|
sort?: Sorting[];
|
|
204
205
|
}
|
|
205
206
|
/** @oneof */
|
|
206
|
-
|
|
207
|
+
interface CursorQueryPagingMethodOneOf {
|
|
207
208
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
208
209
|
cursorPaging?: CursorPaging;
|
|
209
210
|
}
|
|
210
|
-
|
|
211
|
+
interface Sorting {
|
|
211
212
|
/**
|
|
212
213
|
* Name of the field to sort by.
|
|
213
214
|
* @maxLength 512
|
|
@@ -216,13 +217,13 @@ export interface Sorting {
|
|
|
216
217
|
/** Sort order. */
|
|
217
218
|
order?: SortOrderWithLiterals;
|
|
218
219
|
}
|
|
219
|
-
|
|
220
|
+
declare enum SortOrder {
|
|
220
221
|
ASC = "ASC",
|
|
221
222
|
DESC = "DESC"
|
|
222
223
|
}
|
|
223
224
|
/** @enumType */
|
|
224
|
-
|
|
225
|
-
|
|
225
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
226
|
+
interface CursorPaging {
|
|
226
227
|
/**
|
|
227
228
|
* Maximum number of items to return in the results.
|
|
228
229
|
* @max 100
|
|
@@ -237,13 +238,13 @@ export interface CursorPaging {
|
|
|
237
238
|
*/
|
|
238
239
|
cursor?: string | null;
|
|
239
240
|
}
|
|
240
|
-
|
|
241
|
+
interface QueryBranchesResponse {
|
|
241
242
|
/** List of branches. */
|
|
242
243
|
branches?: Branch[];
|
|
243
244
|
/** Paging metadata */
|
|
244
245
|
pagingMetadata?: CursorPagingMetadata;
|
|
245
246
|
}
|
|
246
|
-
|
|
247
|
+
interface CursorPagingMetadata {
|
|
247
248
|
/** Number of items returned in the response. */
|
|
248
249
|
count?: number | null;
|
|
249
250
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -256,7 +257,7 @@ export interface CursorPagingMetadata {
|
|
|
256
257
|
*/
|
|
257
258
|
hasNext?: boolean | null;
|
|
258
259
|
}
|
|
259
|
-
|
|
260
|
+
interface Cursors {
|
|
260
261
|
/**
|
|
261
262
|
* Cursor string pointing to the next page in the list of results.
|
|
262
263
|
* @maxLength 16000
|
|
@@ -268,7 +269,7 @@ export interface Cursors {
|
|
|
268
269
|
*/
|
|
269
270
|
prev?: string | null;
|
|
270
271
|
}
|
|
271
|
-
|
|
272
|
+
interface UpdateExtendedFieldsRequest {
|
|
272
273
|
/** ID of the entity to update. */
|
|
273
274
|
_id?: string;
|
|
274
275
|
/** Identifier for the app whose extended fields are being updated. */
|
|
@@ -276,11 +277,11 @@ export interface UpdateExtendedFieldsRequest {
|
|
|
276
277
|
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
277
278
|
namespaceData?: Record<string, any> | null;
|
|
278
279
|
}
|
|
279
|
-
|
|
280
|
+
interface UpdateExtendedFieldsResponse {
|
|
280
281
|
/** Updated branch. */
|
|
281
282
|
branch?: Branch;
|
|
282
283
|
}
|
|
283
|
-
|
|
284
|
+
interface HtmlSitePublished {
|
|
284
285
|
/**
|
|
285
286
|
* Application instance ID
|
|
286
287
|
* @maxLength 50
|
|
@@ -310,16 +311,16 @@ export interface HtmlSitePublished {
|
|
|
310
311
|
/** Site's publish date */
|
|
311
312
|
publishDate?: string;
|
|
312
313
|
}
|
|
313
|
-
|
|
314
|
+
interface Page {
|
|
314
315
|
/**
|
|
315
316
|
* Page's Id
|
|
316
317
|
* @maxLength 100
|
|
317
318
|
*/
|
|
318
319
|
_id?: string;
|
|
319
320
|
}
|
|
320
|
-
|
|
321
|
+
interface Empty {
|
|
321
322
|
}
|
|
322
|
-
|
|
323
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
323
324
|
/** Emitted on a meta site creation. */
|
|
324
325
|
siteCreated?: SiteCreated;
|
|
325
326
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -385,7 +386,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
385
386
|
assets?: Asset[];
|
|
386
387
|
}
|
|
387
388
|
/** @oneof */
|
|
388
|
-
|
|
389
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
389
390
|
/** Emitted on a meta site creation. */
|
|
390
391
|
siteCreated?: SiteCreated;
|
|
391
392
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -435,7 +436,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
435
436
|
/** Emitted when Picasso is detached. */
|
|
436
437
|
picassoUnassigned?: PicassoUnassigned;
|
|
437
438
|
}
|
|
438
|
-
|
|
439
|
+
interface Asset {
|
|
439
440
|
/**
|
|
440
441
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
441
442
|
* @maxLength 36
|
|
@@ -449,7 +450,7 @@ export interface Asset {
|
|
|
449
450
|
/** An application state. */
|
|
450
451
|
state?: StateWithLiterals;
|
|
451
452
|
}
|
|
452
|
-
|
|
453
|
+
declare enum State {
|
|
453
454
|
UNKNOWN = "UNKNOWN",
|
|
454
455
|
ENABLED = "ENABLED",
|
|
455
456
|
DISABLED = "DISABLED",
|
|
@@ -457,8 +458,8 @@ export declare enum State {
|
|
|
457
458
|
DEMO = "DEMO"
|
|
458
459
|
}
|
|
459
460
|
/** @enumType */
|
|
460
|
-
|
|
461
|
-
|
|
461
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
462
|
+
interface SiteCreated {
|
|
462
463
|
/**
|
|
463
464
|
* A template identifier (empty if not created from a template).
|
|
464
465
|
* @maxLength 36
|
|
@@ -487,7 +488,7 @@ export interface SiteCreated {
|
|
|
487
488
|
/** A namespace. */
|
|
488
489
|
namespace?: NamespaceWithLiterals;
|
|
489
490
|
}
|
|
490
|
-
|
|
491
|
+
declare enum SiteCreatedContext {
|
|
491
492
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
492
493
|
OTHER = "OTHER",
|
|
493
494
|
/** A meta site was created from template. */
|
|
@@ -502,8 +503,8 @@ export declare enum SiteCreatedContext {
|
|
|
502
503
|
FLASH = "FLASH"
|
|
503
504
|
}
|
|
504
505
|
/** @enumType */
|
|
505
|
-
|
|
506
|
-
|
|
506
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
507
|
+
declare enum Namespace {
|
|
507
508
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
508
509
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
509
510
|
WIX = "WIX",
|
|
@@ -583,12 +584,14 @@ export declare enum Namespace {
|
|
|
583
584
|
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
584
585
|
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
585
586
|
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
586
|
-
MIMIR = "MIMIR"
|
|
587
|
+
MIMIR = "MIMIR",
|
|
588
|
+
/** Wix Twins platform. */
|
|
589
|
+
TWINS = "TWINS"
|
|
587
590
|
}
|
|
588
591
|
/** @enumType */
|
|
589
|
-
|
|
592
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS';
|
|
590
593
|
/** Site transferred to another user. */
|
|
591
|
-
|
|
594
|
+
interface SiteTransferred {
|
|
592
595
|
/**
|
|
593
596
|
* A previous owner id (user that transfers meta site).
|
|
594
597
|
* @format GUID
|
|
@@ -601,11 +604,11 @@ export interface SiteTransferred {
|
|
|
601
604
|
newOwnerId?: string;
|
|
602
605
|
}
|
|
603
606
|
/** Soft deletion of the meta site. Could be restored. */
|
|
604
|
-
|
|
607
|
+
interface SiteDeleted {
|
|
605
608
|
/** A deletion context. */
|
|
606
609
|
deleteContext?: DeleteContext;
|
|
607
610
|
}
|
|
608
|
-
|
|
611
|
+
interface DeleteContext {
|
|
609
612
|
/** When the meta site was deleted. */
|
|
610
613
|
dateDeleted?: Date | null;
|
|
611
614
|
/** A status. */
|
|
@@ -621,7 +624,7 @@ export interface DeleteContext {
|
|
|
621
624
|
*/
|
|
622
625
|
initiatorId?: string | null;
|
|
623
626
|
}
|
|
624
|
-
|
|
627
|
+
declare enum DeleteStatus {
|
|
625
628
|
UNKNOWN = "UNKNOWN",
|
|
626
629
|
TRASH = "TRASH",
|
|
627
630
|
DELETED = "DELETED",
|
|
@@ -629,14 +632,14 @@ export declare enum DeleteStatus {
|
|
|
629
632
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
630
633
|
}
|
|
631
634
|
/** @enumType */
|
|
632
|
-
|
|
635
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
633
636
|
/** Restoration of the meta site. */
|
|
634
|
-
|
|
637
|
+
interface SiteUndeleted {
|
|
635
638
|
}
|
|
636
639
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
637
|
-
|
|
640
|
+
interface SitePublished {
|
|
638
641
|
}
|
|
639
|
-
|
|
642
|
+
interface SiteUnpublished {
|
|
640
643
|
/**
|
|
641
644
|
* A list of URLs previously associated with the meta site.
|
|
642
645
|
* @maxLength 4000
|
|
@@ -644,9 +647,9 @@ export interface SiteUnpublished {
|
|
|
644
647
|
*/
|
|
645
648
|
urls?: string[];
|
|
646
649
|
}
|
|
647
|
-
|
|
650
|
+
interface SiteMarkedAsTemplate {
|
|
648
651
|
}
|
|
649
|
-
|
|
652
|
+
interface SiteMarkedAsWixSite {
|
|
650
653
|
}
|
|
651
654
|
/**
|
|
652
655
|
* Represents a service provisioned a site.
|
|
@@ -663,7 +666,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
663
666
|
* changes made to the original template afterward.
|
|
664
667
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
665
668
|
*/
|
|
666
|
-
|
|
669
|
+
interface ServiceProvisioned {
|
|
667
670
|
/**
|
|
668
671
|
* Either UUID or EmbeddedServiceType.
|
|
669
672
|
* @maxLength 36
|
|
@@ -690,7 +693,7 @@ export interface ServiceProvisioned {
|
|
|
690
693
|
*/
|
|
691
694
|
originMetaSiteId?: string | null;
|
|
692
695
|
}
|
|
693
|
-
|
|
696
|
+
interface ServiceRemoved {
|
|
694
697
|
/**
|
|
695
698
|
* Either UUID or EmbeddedServiceType.
|
|
696
699
|
* @maxLength 36
|
|
@@ -708,7 +711,7 @@ export interface ServiceRemoved {
|
|
|
708
711
|
version?: string | null;
|
|
709
712
|
}
|
|
710
713
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
711
|
-
|
|
714
|
+
interface SiteRenamed {
|
|
712
715
|
/**
|
|
713
716
|
* A new meta site name (URL slug).
|
|
714
717
|
* @maxLength 20
|
|
@@ -725,21 +728,21 @@ export interface SiteRenamed {
|
|
|
725
728
|
*
|
|
726
729
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
727
730
|
*/
|
|
728
|
-
|
|
731
|
+
interface SiteHardDeleted {
|
|
729
732
|
/** A deletion context. */
|
|
730
733
|
deleteContext?: DeleteContext;
|
|
731
734
|
}
|
|
732
|
-
|
|
735
|
+
interface NamespaceChanged {
|
|
733
736
|
/** A previous namespace. */
|
|
734
737
|
oldNamespace?: NamespaceWithLiterals;
|
|
735
738
|
/** A new namespace. */
|
|
736
739
|
newNamespace?: NamespaceWithLiterals;
|
|
737
740
|
}
|
|
738
741
|
/** Assigned Studio editor */
|
|
739
|
-
|
|
742
|
+
interface StudioAssigned {
|
|
740
743
|
}
|
|
741
744
|
/** Unassigned Studio editor */
|
|
742
|
-
|
|
745
|
+
interface StudioUnassigned {
|
|
743
746
|
}
|
|
744
747
|
/**
|
|
745
748
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -749,13 +752,13 @@ export interface StudioUnassigned {
|
|
|
749
752
|
*
|
|
750
753
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
751
754
|
*/
|
|
752
|
-
|
|
755
|
+
interface SiteUrlChanged {
|
|
753
756
|
}
|
|
754
757
|
/**
|
|
755
758
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
756
759
|
* Consumed by other teams to remove relevant data.
|
|
757
760
|
*/
|
|
758
|
-
|
|
761
|
+
interface SitePurgedExternally {
|
|
759
762
|
/**
|
|
760
763
|
* @maxLength 2048
|
|
761
764
|
* @maxSize 100
|
|
@@ -765,35 +768,35 @@ export interface SitePurgedExternally {
|
|
|
765
768
|
appDefId?: string[];
|
|
766
769
|
}
|
|
767
770
|
/** Assigned Odeditor */
|
|
768
|
-
|
|
771
|
+
interface OdeditorAssigned {
|
|
769
772
|
}
|
|
770
773
|
/** Unassigned Odeditor */
|
|
771
|
-
|
|
774
|
+
interface OdeditorUnassigned {
|
|
772
775
|
}
|
|
773
776
|
/** Assigned Picasso editor */
|
|
774
|
-
|
|
777
|
+
interface PicassoAssigned {
|
|
775
778
|
}
|
|
776
779
|
/** Unassigned Picasso */
|
|
777
|
-
|
|
780
|
+
interface PicassoUnassigned {
|
|
778
781
|
}
|
|
779
|
-
|
|
782
|
+
interface SetDefaultBranchRequest {
|
|
780
783
|
/**
|
|
781
784
|
* Branch Id.
|
|
782
785
|
* @format GUID
|
|
783
786
|
*/
|
|
784
787
|
branchId: string;
|
|
785
788
|
}
|
|
786
|
-
|
|
789
|
+
interface SetDefaultBranchResponse {
|
|
787
790
|
/** Updated branch. */
|
|
788
791
|
branch?: Branch;
|
|
789
792
|
}
|
|
790
|
-
|
|
793
|
+
interface GetDefaultBranchRequest {
|
|
791
794
|
}
|
|
792
|
-
|
|
795
|
+
interface GetDefaultBranchResponse {
|
|
793
796
|
/** Default branch. */
|
|
794
797
|
branch?: Branch;
|
|
795
798
|
}
|
|
796
|
-
|
|
799
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
797
800
|
createdEvent?: EntityCreatedEvent;
|
|
798
801
|
updatedEvent?: EntityUpdatedEvent;
|
|
799
802
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -828,19 +831,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
828
831
|
entityEventSequence?: string | null;
|
|
829
832
|
}
|
|
830
833
|
/** @oneof */
|
|
831
|
-
|
|
834
|
+
interface DomainEventBodyOneOf {
|
|
832
835
|
createdEvent?: EntityCreatedEvent;
|
|
833
836
|
updatedEvent?: EntityUpdatedEvent;
|
|
834
837
|
deletedEvent?: EntityDeletedEvent;
|
|
835
838
|
actionEvent?: ActionEvent;
|
|
836
839
|
}
|
|
837
|
-
|
|
840
|
+
interface EntityCreatedEvent {
|
|
838
841
|
entity?: string;
|
|
839
842
|
}
|
|
840
|
-
|
|
843
|
+
interface RestoreInfo {
|
|
841
844
|
deletedDate?: Date | null;
|
|
842
845
|
}
|
|
843
|
-
|
|
846
|
+
interface EntityUpdatedEvent {
|
|
844
847
|
/**
|
|
845
848
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
846
849
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -848,14 +851,14 @@ export interface EntityUpdatedEvent {
|
|
|
848
851
|
*/
|
|
849
852
|
currentEntity?: string;
|
|
850
853
|
}
|
|
851
|
-
|
|
854
|
+
interface EntityDeletedEvent {
|
|
852
855
|
/** Entity that was deleted. */
|
|
853
856
|
deletedEntity?: string | null;
|
|
854
857
|
}
|
|
855
|
-
|
|
858
|
+
interface ActionEvent {
|
|
856
859
|
body?: string;
|
|
857
860
|
}
|
|
858
|
-
|
|
861
|
+
interface MessageEnvelope {
|
|
859
862
|
/**
|
|
860
863
|
* App instance ID.
|
|
861
864
|
* @format GUID
|
|
@@ -871,7 +874,7 @@ export interface MessageEnvelope {
|
|
|
871
874
|
/** Stringify payload. */
|
|
872
875
|
data?: string;
|
|
873
876
|
}
|
|
874
|
-
|
|
877
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
875
878
|
/**
|
|
876
879
|
* ID of a site visitor that has not logged in to the site.
|
|
877
880
|
* @format GUID
|
|
@@ -896,7 +899,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
896
899
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
897
900
|
}
|
|
898
901
|
/** @oneof */
|
|
899
|
-
|
|
902
|
+
interface IdentificationDataIdOneOf {
|
|
900
903
|
/**
|
|
901
904
|
* ID of a site visitor that has not logged in to the site.
|
|
902
905
|
* @format GUID
|
|
@@ -918,7 +921,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
918
921
|
*/
|
|
919
922
|
appId?: string;
|
|
920
923
|
}
|
|
921
|
-
|
|
924
|
+
declare enum WebhookIdentityType {
|
|
922
925
|
UNKNOWN = "UNKNOWN",
|
|
923
926
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
924
927
|
MEMBER = "MEMBER",
|
|
@@ -926,8 +929,50 @@ export declare enum WebhookIdentityType {
|
|
|
926
929
|
APP = "APP"
|
|
927
930
|
}
|
|
928
931
|
/** @enumType */
|
|
929
|
-
|
|
930
|
-
|
|
932
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
933
|
+
/** @docsIgnore */
|
|
934
|
+
type CreateBranchApplicationErrors = {
|
|
935
|
+
code?: 'SOURCE_BRANCH_NOT_FOUND';
|
|
936
|
+
description?: string;
|
|
937
|
+
data?: Record<string, any>;
|
|
938
|
+
} | {
|
|
939
|
+
code?: 'TEMPLATE_ID_NOT_SUPPORTED';
|
|
940
|
+
description?: string;
|
|
941
|
+
data?: Record<string, any>;
|
|
942
|
+
} | {
|
|
943
|
+
code?: 'ORIGINAL_BRANCH_ALREADY_EXISTS';
|
|
944
|
+
description?: string;
|
|
945
|
+
data?: Record<string, any>;
|
|
946
|
+
} | {
|
|
947
|
+
code?: 'TARGET_BRANCH_SITE_HEADER_ALREADY_EXISTS';
|
|
948
|
+
description?: string;
|
|
949
|
+
data?: Record<string, any>;
|
|
950
|
+
} | {
|
|
951
|
+
code?: 'ILLEGAL_SOURCE_TYPE';
|
|
952
|
+
description?: string;
|
|
953
|
+
data?: Record<string, any>;
|
|
954
|
+
} | {
|
|
955
|
+
code?: 'SOURCE_USER_BRANCH_NOT_EXISTS';
|
|
956
|
+
description?: string;
|
|
957
|
+
data?: Record<string, any>;
|
|
958
|
+
};
|
|
959
|
+
/** @docsIgnore */
|
|
960
|
+
type UpdateBranchApplicationErrors = {
|
|
961
|
+
code?: 'FORBIDDEN_UPDATE_ORIGINAL_BRANCH_TYPE';
|
|
962
|
+
description?: string;
|
|
963
|
+
data?: Record<string, any>;
|
|
964
|
+
};
|
|
965
|
+
/** @docsIgnore */
|
|
966
|
+
type DeleteBranchApplicationErrors = {
|
|
967
|
+
code?: 'BRANCH_NOT_FOUND';
|
|
968
|
+
description?: string;
|
|
969
|
+
data?: Record<string, any>;
|
|
970
|
+
} | {
|
|
971
|
+
code?: 'FORBIDDEN_DELETE_ORIGINAL_BRANCH';
|
|
972
|
+
description?: string;
|
|
973
|
+
data?: Record<string, any>;
|
|
974
|
+
};
|
|
975
|
+
interface BaseEventMetadata {
|
|
931
976
|
/**
|
|
932
977
|
* App instance ID.
|
|
933
978
|
* @format GUID
|
|
@@ -941,7 +986,7 @@ export interface BaseEventMetadata {
|
|
|
941
986
|
/** The identification type and identity data. */
|
|
942
987
|
identity?: IdentificationData;
|
|
943
988
|
}
|
|
944
|
-
|
|
989
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
945
990
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
946
991
|
_id?: string;
|
|
947
992
|
/**
|
|
@@ -971,7 +1016,7 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
971
1016
|
*/
|
|
972
1017
|
entityEventSequence?: string | null;
|
|
973
1018
|
}
|
|
974
|
-
|
|
1019
|
+
interface BranchCreatedEnvelope {
|
|
975
1020
|
entity: Branch;
|
|
976
1021
|
metadata: EventMetadata;
|
|
977
1022
|
}
|
|
@@ -980,8 +1025,8 @@ export interface BranchCreatedEnvelope {
|
|
|
980
1025
|
* @eventType wix.editor.branches.v1.branch_created
|
|
981
1026
|
* @slug created
|
|
982
1027
|
*/
|
|
983
|
-
|
|
984
|
-
|
|
1028
|
+
declare function onBranchCreated(handler: (event: BranchCreatedEnvelope) => void | Promise<void>): void;
|
|
1029
|
+
interface BranchDeletedEnvelope {
|
|
985
1030
|
entity: Branch;
|
|
986
1031
|
metadata: EventMetadata;
|
|
987
1032
|
}
|
|
@@ -990,8 +1035,8 @@ export interface BranchDeletedEnvelope {
|
|
|
990
1035
|
* @eventType wix.editor.branches.v1.branch_deleted
|
|
991
1036
|
* @slug deleted
|
|
992
1037
|
*/
|
|
993
|
-
|
|
994
|
-
|
|
1038
|
+
declare function onBranchDeleted(handler: (event: BranchDeletedEnvelope) => void | Promise<void>): void;
|
|
1039
|
+
interface BranchUpdatedEnvelope {
|
|
995
1040
|
entity: Branch;
|
|
996
1041
|
metadata: EventMetadata;
|
|
997
1042
|
}
|
|
@@ -1000,8 +1045,7 @@ export interface BranchUpdatedEnvelope {
|
|
|
1000
1045
|
* @eventType wix.editor.branches.v1.branch_updated
|
|
1001
1046
|
* @slug updated
|
|
1002
1047
|
*/
|
|
1003
|
-
|
|
1004
|
-
type BranchNonNullablePaths = `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions`;
|
|
1048
|
+
declare function onBranchUpdated(handler: (event: BranchUpdatedEnvelope) => void | Promise<void>): void;
|
|
1005
1049
|
/**
|
|
1006
1050
|
* Creates a branch.
|
|
1007
1051
|
* If a source branch is not provided, the branch will include a blank website.
|
|
@@ -1013,7 +1057,9 @@ type BranchNonNullablePaths = `sourceBranchProperties.branchId` | `sourceTemplat
|
|
|
1013
1057
|
* @returns Created branch.
|
|
1014
1058
|
* @fqn wix.editor.branches.v1.BranchesService.CreateBranch
|
|
1015
1059
|
*/
|
|
1016
|
-
|
|
1060
|
+
declare function createBranch(branch: Branch): Promise<NonNullablePaths<Branch, `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions`, 3> & {
|
|
1061
|
+
__applicationErrorsType?: CreateBranchApplicationErrors;
|
|
1062
|
+
}>;
|
|
1017
1063
|
/**
|
|
1018
1064
|
* Retrieves a branch.
|
|
1019
1065
|
* @param branchId - ID of branch to retrieve.
|
|
@@ -1024,7 +1070,7 @@ export declare function createBranch(branch: Branch): Promise<NonNullablePaths<B
|
|
|
1024
1070
|
* @returns Requested branch.
|
|
1025
1071
|
* @fqn wix.editor.branches.v1.BranchesService.GetBranch
|
|
1026
1072
|
*/
|
|
1027
|
-
|
|
1073
|
+
declare function getBranch(branchId: string): Promise<NonNullablePaths<Branch, `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions`, 3>>;
|
|
1028
1074
|
/**
|
|
1029
1075
|
* Updates a branch.
|
|
1030
1076
|
*
|
|
@@ -1039,8 +1085,10 @@ export declare function getBranch(branchId: string): Promise<NonNullablePaths<Br
|
|
|
1039
1085
|
* @returns Updated branch.
|
|
1040
1086
|
* @fqn wix.editor.branches.v1.BranchesService.UpdateBranch
|
|
1041
1087
|
*/
|
|
1042
|
-
|
|
1043
|
-
|
|
1088
|
+
declare function updateBranch(_id: string, branch: NonNullablePaths<UpdateBranch, `revision`, 2>): Promise<NonNullablePaths<Branch, `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions`, 3> & {
|
|
1089
|
+
__applicationErrorsType?: UpdateBranchApplicationErrors;
|
|
1090
|
+
}>;
|
|
1091
|
+
interface UpdateBranch {
|
|
1044
1092
|
/** Source branch properties. */
|
|
1045
1093
|
sourceBranchProperties?: SourceBranch;
|
|
1046
1094
|
/** Source template properties. */
|
|
@@ -1107,7 +1155,9 @@ export interface UpdateBranch {
|
|
|
1107
1155
|
* @permissionId EDITOR.BRANCH_DELETE
|
|
1108
1156
|
* @fqn wix.editor.branches.v1.BranchesService.DeleteBranch
|
|
1109
1157
|
*/
|
|
1110
|
-
|
|
1158
|
+
declare function deleteBranch(branchId: string): Promise<void & {
|
|
1159
|
+
__applicationErrorsType?: DeleteBranchApplicationErrors;
|
|
1160
|
+
}>;
|
|
1111
1161
|
/**
|
|
1112
1162
|
* Retrieves a list of branches, given the specified [paging, filtering, and sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
|
|
1113
1163
|
* @public
|
|
@@ -1115,7 +1165,7 @@ export declare function deleteBranch(branchId: string): Promise<void>;
|
|
|
1115
1165
|
* @permissionId EDITOR.BRANCH_READ
|
|
1116
1166
|
* @fqn wix.editor.branches.v1.BranchesService.QueryBranches
|
|
1117
1167
|
*/
|
|
1118
|
-
|
|
1168
|
+
declare function queryBranches(): BranchesQueryBuilder;
|
|
1119
1169
|
interface QueryCursorResult {
|
|
1120
1170
|
cursors: Cursors;
|
|
1121
1171
|
hasNext: () => boolean;
|
|
@@ -1123,13 +1173,13 @@ interface QueryCursorResult {
|
|
|
1123
1173
|
length: number;
|
|
1124
1174
|
pageSize: number;
|
|
1125
1175
|
}
|
|
1126
|
-
|
|
1176
|
+
interface BranchesQueryResult extends QueryCursorResult {
|
|
1127
1177
|
items: Branch[];
|
|
1128
1178
|
query: BranchesQueryBuilder;
|
|
1129
1179
|
next: () => Promise<BranchesQueryResult>;
|
|
1130
1180
|
prev: () => Promise<BranchesQueryResult>;
|
|
1131
1181
|
}
|
|
1132
|
-
|
|
1182
|
+
interface BranchesQueryBuilder {
|
|
1133
1183
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1134
1184
|
* @param value - Value to compare against.
|
|
1135
1185
|
* @documentationMaturity preview
|
|
@@ -1202,9 +1252,7 @@ export interface BranchesQueryBuilder {
|
|
|
1202
1252
|
* @permissionId EDITOR.SET_DEFAULT_BRANCH
|
|
1203
1253
|
* @fqn wix.editor.branches.v1.BranchesService.SetDefaultBranch
|
|
1204
1254
|
*/
|
|
1205
|
-
|
|
1206
|
-
[P in BranchNonNullablePaths]: `branch.${P}`;
|
|
1207
|
-
}[BranchNonNullablePaths]>>;
|
|
1255
|
+
declare function setDefaultBranch(branchId: string): Promise<NonNullablePaths<SetDefaultBranchResponse, `branch.sourceBranchProperties.branchId` | `branch.sourceTemplateProperties.templateId` | `branch.type` | `branch.sourceType` | `branch.editorType.editorTypeOptions`, 4>>;
|
|
1208
1256
|
/**
|
|
1209
1257
|
* Get default branch.
|
|
1210
1258
|
* @public
|
|
@@ -1212,7 +1260,6 @@ export declare function setDefaultBranch(branchId: string): Promise<NonNullableP
|
|
|
1212
1260
|
* @permissionId EDITOR.BRANCH_READ
|
|
1213
1261
|
* @fqn wix.editor.branches.v1.BranchesService.GetDefaultBranch
|
|
1214
1262
|
*/
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
}
|
|
1218
|
-
export {};
|
|
1263
|
+
declare function getDefaultBranch(): Promise<NonNullablePaths<GetDefaultBranchResponse, `branch.sourceBranchProperties.branchId` | `branch.sourceTemplateProperties.templateId` | `branch.type` | `branch.sourceType` | `branch.editorType.editorTypeOptions`, 4>>;
|
|
1264
|
+
|
|
1265
|
+
export { type ActionEvent, type Asset, type BaseEventMetadata, type Branch, type BranchCreatedEnvelope, type BranchDeletedEnvelope, type BranchSourceOneOf, type BranchUpdatedEnvelope, type BranchesQueryBuilder, type BranchesQueryResult, type CreateBranchApplicationErrors, type CreateBranchRequest, type CreateBranchResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteBranchApplicationErrors, type DeleteBranchRequest, type DeleteBranchResponse, type DeleteContext, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type EditorType, EditorTypeOptions, type EditorTypeOptionsWithLiterals, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetBranchRequest, type GetBranchResponse, type GetDefaultBranchRequest, type GetDefaultBranchResponse, type HtmlSitePublished, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type Page, type PicassoAssigned, type PicassoUnassigned, type QueryBranchesRequest, type QueryBranchesResponse, type RestoreInfo, type ServiceProvisioned, type ServiceRemoved, type SetDefaultBranchRequest, type SetDefaultBranchResponse, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, type SourceBranch, type SourceTemplate, SourceType, type SourceTypeWithLiterals, State, type StateWithLiterals, type StudioAssigned, type StudioUnassigned, Type, type TypeWithLiterals, type UpdateBranch, type UpdateBranchApplicationErrors, type UpdateBranchRequest, type UpdateBranchResponse, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createBranch, deleteBranch, getBranch, getDefaultBranch, onBranchCreated, onBranchDeleted, onBranchUpdated, queryBranches, setDefaultBranch, updateBranch };
|