@wix/categories 1.0.69 → 1.0.70
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/context.js.map +1 -0
- package/context.ts +1 -0
- package/index.js.map +1 -0
- package/index.ts +3 -0
- package/meta.js.map +1 -0
- package/meta.ts +1 -0
- package/package.json +23 -18
- package/build/cjs/context.js.map +0 -1
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/meta.js.map +0 -1
- package/context/package.json +0 -7
- package/meta/package.json +0 -7
- package/type-bundles/context.bundle.d.ts +0 -4747
- package/type-bundles/index.bundle.d.ts +0 -4747
- package/type-bundles/meta.bundle.d.ts +0 -5488
- /package/{build/cjs/context.d.ts → context.d.ts} +0 -0
- /package/{build/cjs/context.js → context.js} +0 -0
- /package/{build/cjs/index.d.ts → index.d.ts} +0 -0
- /package/{build/cjs/index.js → index.js} +0 -0
- /package/{build/cjs/meta.d.ts → meta.d.ts} +0 -0
- /package/{build/cjs/meta.js → meta.js} +0 -0
|
@@ -1,4747 +0,0 @@
|
|
|
1
|
-
type HostModule<T, H extends Host> = {
|
|
2
|
-
__type: 'host';
|
|
3
|
-
create(host: H): T;
|
|
4
|
-
};
|
|
5
|
-
type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
|
|
6
|
-
type Host<Environment = unknown> = {
|
|
7
|
-
channel: {
|
|
8
|
-
observeState(callback: (props: unknown, environment: Environment) => unknown): {
|
|
9
|
-
disconnect: () => void;
|
|
10
|
-
} | Promise<{
|
|
11
|
-
disconnect: () => void;
|
|
12
|
-
}>;
|
|
13
|
-
};
|
|
14
|
-
environment?: Environment;
|
|
15
|
-
/**
|
|
16
|
-
* Optional name of the environment, use for logging
|
|
17
|
-
*/
|
|
18
|
-
name?: string;
|
|
19
|
-
/**
|
|
20
|
-
* Optional bast url to use for API requests, for example `www.wixapis.com`
|
|
21
|
-
*/
|
|
22
|
-
apiBaseUrl?: string;
|
|
23
|
-
/**
|
|
24
|
-
* Possible data to be provided by every host, for cross cutting concerns
|
|
25
|
-
* like internationalization, billing, etc.
|
|
26
|
-
*/
|
|
27
|
-
essentials?: {
|
|
28
|
-
/**
|
|
29
|
-
* The language of the currently viewed session
|
|
30
|
-
*/
|
|
31
|
-
language?: string;
|
|
32
|
-
/**
|
|
33
|
-
* The locale of the currently viewed session
|
|
34
|
-
*/
|
|
35
|
-
locale?: string;
|
|
36
|
-
/**
|
|
37
|
-
* Any headers that should be passed through to the API requests
|
|
38
|
-
*/
|
|
39
|
-
passThroughHeaders?: Record<string, string>;
|
|
40
|
-
};
|
|
41
|
-
};
|
|
42
|
-
|
|
43
|
-
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
44
|
-
interface HttpClient {
|
|
45
|
-
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
46
|
-
fetchWithAuth: typeof fetch;
|
|
47
|
-
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
48
|
-
getActiveToken?: () => string | undefined;
|
|
49
|
-
}
|
|
50
|
-
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
51
|
-
type HttpResponse<T = any> = {
|
|
52
|
-
data: T;
|
|
53
|
-
status: number;
|
|
54
|
-
statusText: string;
|
|
55
|
-
headers: any;
|
|
56
|
-
request?: any;
|
|
57
|
-
};
|
|
58
|
-
type RequestOptions<_TResponse = any, Data = any> = {
|
|
59
|
-
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
60
|
-
url: string;
|
|
61
|
-
data?: Data;
|
|
62
|
-
params?: URLSearchParams;
|
|
63
|
-
} & APIMetadata;
|
|
64
|
-
type APIMetadata = {
|
|
65
|
-
methodFqn?: string;
|
|
66
|
-
entityFqdn?: string;
|
|
67
|
-
packageName?: string;
|
|
68
|
-
};
|
|
69
|
-
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
70
|
-
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
71
|
-
__type: 'event-definition';
|
|
72
|
-
type: Type;
|
|
73
|
-
isDomainEvent?: boolean;
|
|
74
|
-
transformations?: (envelope: unknown) => Payload;
|
|
75
|
-
__payload: Payload;
|
|
76
|
-
};
|
|
77
|
-
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
78
|
-
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
79
|
-
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
80
|
-
|
|
81
|
-
type ServicePluginMethodInput = {
|
|
82
|
-
request: any;
|
|
83
|
-
metadata: any;
|
|
84
|
-
};
|
|
85
|
-
type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
|
|
86
|
-
type ServicePluginMethodMetadata = {
|
|
87
|
-
name: string;
|
|
88
|
-
primaryHttpMappingPath: string;
|
|
89
|
-
transformations: {
|
|
90
|
-
fromREST: (...args: unknown[]) => ServicePluginMethodInput;
|
|
91
|
-
toREST: (...args: unknown[]) => unknown;
|
|
92
|
-
};
|
|
93
|
-
};
|
|
94
|
-
type ServicePluginDefinition<Contract extends ServicePluginContract> = {
|
|
95
|
-
__type: 'service-plugin-definition';
|
|
96
|
-
componentType: string;
|
|
97
|
-
methods: ServicePluginMethodMetadata[];
|
|
98
|
-
__contract: Contract;
|
|
99
|
-
};
|
|
100
|
-
declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
|
|
101
|
-
type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
|
|
102
|
-
declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
|
|
103
|
-
|
|
104
|
-
type RequestContext = {
|
|
105
|
-
isSSR: boolean;
|
|
106
|
-
host: string;
|
|
107
|
-
protocol?: string;
|
|
108
|
-
};
|
|
109
|
-
type ResponseTransformer = (data: any, headers?: any) => any;
|
|
110
|
-
/**
|
|
111
|
-
* Ambassador request options types are copied mostly from AxiosRequestConfig.
|
|
112
|
-
* They are copied and not imported to reduce the amount of dependencies (to reduce install time).
|
|
113
|
-
* https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
|
|
114
|
-
*/
|
|
115
|
-
type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
|
|
116
|
-
type AmbassadorRequestOptions<T = any> = {
|
|
117
|
-
_?: T;
|
|
118
|
-
url?: string;
|
|
119
|
-
method?: Method;
|
|
120
|
-
params?: any;
|
|
121
|
-
data?: any;
|
|
122
|
-
transformResponse?: ResponseTransformer | ResponseTransformer[];
|
|
123
|
-
};
|
|
124
|
-
type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
|
|
125
|
-
__isAmbassador: boolean;
|
|
126
|
-
};
|
|
127
|
-
type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
|
|
128
|
-
type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
|
|
129
|
-
|
|
130
|
-
declare global {
|
|
131
|
-
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
132
|
-
interface SymbolConstructor {
|
|
133
|
-
readonly observable: symbol;
|
|
134
|
-
}
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
declare const emptyObjectSymbol: unique symbol;
|
|
138
|
-
|
|
139
|
-
/**
|
|
140
|
-
Represents a strictly empty plain object, the `{}` value.
|
|
141
|
-
|
|
142
|
-
When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
|
|
143
|
-
|
|
144
|
-
@example
|
|
145
|
-
```
|
|
146
|
-
import type {EmptyObject} from 'type-fest';
|
|
147
|
-
|
|
148
|
-
// The following illustrates the problem with `{}`.
|
|
149
|
-
const foo1: {} = {}; // Pass
|
|
150
|
-
const foo2: {} = []; // Pass
|
|
151
|
-
const foo3: {} = 42; // Pass
|
|
152
|
-
const foo4: {} = {a: 1}; // Pass
|
|
153
|
-
|
|
154
|
-
// With `EmptyObject` only the first case is valid.
|
|
155
|
-
const bar1: EmptyObject = {}; // Pass
|
|
156
|
-
const bar2: EmptyObject = 42; // Fail
|
|
157
|
-
const bar3: EmptyObject = []; // Fail
|
|
158
|
-
const bar4: EmptyObject = {a: 1}; // Fail
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
|
|
162
|
-
|
|
163
|
-
@category Object
|
|
164
|
-
*/
|
|
165
|
-
type EmptyObject = {[emptyObjectSymbol]?: never};
|
|
166
|
-
|
|
167
|
-
/**
|
|
168
|
-
Returns a boolean for whether the two given types are equal.
|
|
169
|
-
|
|
170
|
-
@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
|
|
171
|
-
@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
|
|
172
|
-
|
|
173
|
-
Use-cases:
|
|
174
|
-
- If you want to make a conditional branch based on the result of a comparison of two types.
|
|
175
|
-
|
|
176
|
-
@example
|
|
177
|
-
```
|
|
178
|
-
import type {IsEqual} from 'type-fest';
|
|
179
|
-
|
|
180
|
-
// This type returns a boolean for whether the given array includes the given item.
|
|
181
|
-
// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
|
|
182
|
-
type Includes<Value extends readonly any[], Item> =
|
|
183
|
-
Value extends readonly [Value[0], ...infer rest]
|
|
184
|
-
? IsEqual<Value[0], Item> extends true
|
|
185
|
-
? true
|
|
186
|
-
: Includes<rest, Item>
|
|
187
|
-
: false;
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
@category Type Guard
|
|
191
|
-
@category Utilities
|
|
192
|
-
*/
|
|
193
|
-
type IsEqual<A, B> =
|
|
194
|
-
(<G>() => G extends A ? 1 : 2) extends
|
|
195
|
-
(<G>() => G extends B ? 1 : 2)
|
|
196
|
-
? true
|
|
197
|
-
: false;
|
|
198
|
-
|
|
199
|
-
/**
|
|
200
|
-
Filter out keys from an object.
|
|
201
|
-
|
|
202
|
-
Returns `never` if `Exclude` is strictly equal to `Key`.
|
|
203
|
-
Returns `never` if `Key` extends `Exclude`.
|
|
204
|
-
Returns `Key` otherwise.
|
|
205
|
-
|
|
206
|
-
@example
|
|
207
|
-
```
|
|
208
|
-
type Filtered = Filter<'foo', 'foo'>;
|
|
209
|
-
//=> never
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
@example
|
|
213
|
-
```
|
|
214
|
-
type Filtered = Filter<'bar', string>;
|
|
215
|
-
//=> never
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
@example
|
|
219
|
-
```
|
|
220
|
-
type Filtered = Filter<'bar', 'foo'>;
|
|
221
|
-
//=> 'bar'
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
@see {Except}
|
|
225
|
-
*/
|
|
226
|
-
type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
|
|
227
|
-
|
|
228
|
-
type ExceptOptions = {
|
|
229
|
-
/**
|
|
230
|
-
Disallow assigning non-specified properties.
|
|
231
|
-
|
|
232
|
-
Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
|
|
233
|
-
|
|
234
|
-
@default false
|
|
235
|
-
*/
|
|
236
|
-
requireExactProps?: boolean;
|
|
237
|
-
};
|
|
238
|
-
|
|
239
|
-
/**
|
|
240
|
-
Create a type from an object type without certain keys.
|
|
241
|
-
|
|
242
|
-
We recommend setting the `requireExactProps` option to `true`.
|
|
243
|
-
|
|
244
|
-
This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
|
|
245
|
-
|
|
246
|
-
This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
|
|
247
|
-
|
|
248
|
-
@example
|
|
249
|
-
```
|
|
250
|
-
import type {Except} from 'type-fest';
|
|
251
|
-
|
|
252
|
-
type Foo = {
|
|
253
|
-
a: number;
|
|
254
|
-
b: string;
|
|
255
|
-
};
|
|
256
|
-
|
|
257
|
-
type FooWithoutA = Except<Foo, 'a'>;
|
|
258
|
-
//=> {b: string}
|
|
259
|
-
|
|
260
|
-
const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
|
|
261
|
-
//=> errors: 'a' does not exist in type '{ b: string; }'
|
|
262
|
-
|
|
263
|
-
type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
|
|
264
|
-
//=> {a: number} & Partial<Record<"b", never>>
|
|
265
|
-
|
|
266
|
-
const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
|
|
267
|
-
//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
|
|
268
|
-
```
|
|
269
|
-
|
|
270
|
-
@category Object
|
|
271
|
-
*/
|
|
272
|
-
type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
|
|
273
|
-
[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
|
|
274
|
-
} & (Options['requireExactProps'] extends true
|
|
275
|
-
? Partial<Record<KeysType, never>>
|
|
276
|
-
: {});
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
Returns a boolean for whether the given type is `never`.
|
|
280
|
-
|
|
281
|
-
@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
|
|
282
|
-
@link https://stackoverflow.com/a/53984913/10292952
|
|
283
|
-
@link https://www.zhenghao.io/posts/ts-never
|
|
284
|
-
|
|
285
|
-
Useful in type utilities, such as checking if something does not occur.
|
|
286
|
-
|
|
287
|
-
@example
|
|
288
|
-
```
|
|
289
|
-
import type {IsNever, And} from 'type-fest';
|
|
290
|
-
|
|
291
|
-
// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
|
|
292
|
-
type AreStringsEqual<A extends string, B extends string> =
|
|
293
|
-
And<
|
|
294
|
-
IsNever<Exclude<A, B>> extends true ? true : false,
|
|
295
|
-
IsNever<Exclude<B, A>> extends true ? true : false
|
|
296
|
-
>;
|
|
297
|
-
|
|
298
|
-
type EndIfEqual<I extends string, O extends string> =
|
|
299
|
-
AreStringsEqual<I, O> extends true
|
|
300
|
-
? never
|
|
301
|
-
: void;
|
|
302
|
-
|
|
303
|
-
function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
|
|
304
|
-
if (input === output) {
|
|
305
|
-
process.exit(0);
|
|
306
|
-
}
|
|
307
|
-
}
|
|
308
|
-
|
|
309
|
-
endIfEqual('abc', 'abc');
|
|
310
|
-
//=> never
|
|
311
|
-
|
|
312
|
-
endIfEqual('abc', '123');
|
|
313
|
-
//=> void
|
|
314
|
-
```
|
|
315
|
-
|
|
316
|
-
@category Type Guard
|
|
317
|
-
@category Utilities
|
|
318
|
-
*/
|
|
319
|
-
type IsNever<T> = [T] extends [never] ? true : false;
|
|
320
|
-
|
|
321
|
-
/**
|
|
322
|
-
An if-else-like type that resolves depending on whether the given type is `never`.
|
|
323
|
-
|
|
324
|
-
@see {@link IsNever}
|
|
325
|
-
|
|
326
|
-
@example
|
|
327
|
-
```
|
|
328
|
-
import type {IfNever} from 'type-fest';
|
|
329
|
-
|
|
330
|
-
type ShouldBeTrue = IfNever<never>;
|
|
331
|
-
//=> true
|
|
332
|
-
|
|
333
|
-
type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
|
|
334
|
-
//=> 'bar'
|
|
335
|
-
```
|
|
336
|
-
|
|
337
|
-
@category Type Guard
|
|
338
|
-
@category Utilities
|
|
339
|
-
*/
|
|
340
|
-
type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
|
|
341
|
-
IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
|
|
342
|
-
);
|
|
343
|
-
|
|
344
|
-
/**
|
|
345
|
-
Extract the keys from a type where the value type of the key extends the given `Condition`.
|
|
346
|
-
|
|
347
|
-
Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
|
|
348
|
-
|
|
349
|
-
@example
|
|
350
|
-
```
|
|
351
|
-
import type {ConditionalKeys} from 'type-fest';
|
|
352
|
-
|
|
353
|
-
interface Example {
|
|
354
|
-
a: string;
|
|
355
|
-
b: string | number;
|
|
356
|
-
c?: string;
|
|
357
|
-
d: {};
|
|
358
|
-
}
|
|
359
|
-
|
|
360
|
-
type StringKeysOnly = ConditionalKeys<Example, string>;
|
|
361
|
-
//=> 'a'
|
|
362
|
-
```
|
|
363
|
-
|
|
364
|
-
To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
|
|
365
|
-
|
|
366
|
-
@example
|
|
367
|
-
```
|
|
368
|
-
import type {ConditionalKeys} from 'type-fest';
|
|
369
|
-
|
|
370
|
-
type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
|
|
371
|
-
//=> 'a' | 'c'
|
|
372
|
-
```
|
|
373
|
-
|
|
374
|
-
@category Object
|
|
375
|
-
*/
|
|
376
|
-
type ConditionalKeys<Base, Condition> =
|
|
377
|
-
{
|
|
378
|
-
// Map through all the keys of the given base type.
|
|
379
|
-
[Key in keyof Base]-?:
|
|
380
|
-
// Pick only keys with types extending the given `Condition` type.
|
|
381
|
-
Base[Key] extends Condition
|
|
382
|
-
// Retain this key
|
|
383
|
-
// If the value for the key extends never, only include it if `Condition` also extends never
|
|
384
|
-
? IfNever<Base[Key], IfNever<Condition, Key, never>, Key>
|
|
385
|
-
// Discard this key since the condition fails.
|
|
386
|
-
: never;
|
|
387
|
-
// Convert the produced object into a union type of the keys which passed the conditional test.
|
|
388
|
-
}[keyof Base];
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
Exclude keys from a shape that matches the given `Condition`.
|
|
392
|
-
|
|
393
|
-
This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
|
|
394
|
-
|
|
395
|
-
@example
|
|
396
|
-
```
|
|
397
|
-
import type {Primitive, ConditionalExcept} from 'type-fest';
|
|
398
|
-
|
|
399
|
-
class Awesome {
|
|
400
|
-
name: string;
|
|
401
|
-
successes: number;
|
|
402
|
-
failures: bigint;
|
|
403
|
-
|
|
404
|
-
run() {}
|
|
405
|
-
}
|
|
406
|
-
|
|
407
|
-
type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
|
|
408
|
-
//=> {run: () => void}
|
|
409
|
-
```
|
|
410
|
-
|
|
411
|
-
@example
|
|
412
|
-
```
|
|
413
|
-
import type {ConditionalExcept} from 'type-fest';
|
|
414
|
-
|
|
415
|
-
interface Example {
|
|
416
|
-
a: string;
|
|
417
|
-
b: string | number;
|
|
418
|
-
c: () => void;
|
|
419
|
-
d: {};
|
|
420
|
-
}
|
|
421
|
-
|
|
422
|
-
type NonStringKeysOnly = ConditionalExcept<Example, string>;
|
|
423
|
-
//=> {b: string | number; c: () => void; d: {}}
|
|
424
|
-
```
|
|
425
|
-
|
|
426
|
-
@category Object
|
|
427
|
-
*/
|
|
428
|
-
type ConditionalExcept<Base, Condition> = Except<
|
|
429
|
-
Base,
|
|
430
|
-
ConditionalKeys<Base, Condition>
|
|
431
|
-
>;
|
|
432
|
-
|
|
433
|
-
/**
|
|
434
|
-
* Descriptors are objects that describe the API of a module, and the module
|
|
435
|
-
* can either be a REST module or a host module.
|
|
436
|
-
* This type is recursive, so it can describe nested modules.
|
|
437
|
-
*/
|
|
438
|
-
type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
|
|
439
|
-
[key: string]: Descriptors | PublicMetadata | any;
|
|
440
|
-
};
|
|
441
|
-
/**
|
|
442
|
-
* This type takes in a descriptors object of a certain Host (including an `unknown` host)
|
|
443
|
-
* and returns an object with the same structure, but with all descriptors replaced with their API.
|
|
444
|
-
* Any non-descriptor properties are removed from the returned object, including descriptors that
|
|
445
|
-
* do not match the given host (as they will not work with the given host).
|
|
446
|
-
*/
|
|
447
|
-
type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
|
|
448
|
-
done: T;
|
|
449
|
-
recurse: T extends {
|
|
450
|
-
__type: typeof SERVICE_PLUGIN_ERROR_TYPE;
|
|
451
|
-
} ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
|
|
452
|
-
[Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
|
|
453
|
-
-1,
|
|
454
|
-
0,
|
|
455
|
-
1,
|
|
456
|
-
2,
|
|
457
|
-
3,
|
|
458
|
-
4,
|
|
459
|
-
5
|
|
460
|
-
][Depth]> : never;
|
|
461
|
-
}, EmptyObject>;
|
|
462
|
-
}[Depth extends -1 ? 'done' : 'recurse'];
|
|
463
|
-
type PublicMetadata = {
|
|
464
|
-
PACKAGE_NAME?: string;
|
|
465
|
-
};
|
|
466
|
-
|
|
467
|
-
declare global {
|
|
468
|
-
interface ContextualClient {
|
|
469
|
-
}
|
|
470
|
-
}
|
|
471
|
-
/**
|
|
472
|
-
* A type used to create concerete types from SDK descriptors in
|
|
473
|
-
* case a contextual client is available.
|
|
474
|
-
*/
|
|
475
|
-
type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
|
|
476
|
-
host: Host;
|
|
477
|
-
} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
|
|
478
|
-
|
|
479
|
-
interface Category {
|
|
480
|
-
/** Category ID. */
|
|
481
|
-
_id?: string | null;
|
|
482
|
-
/**
|
|
483
|
-
* Revision number, which increments by 1 each time the category is updated.
|
|
484
|
-
* To prevent conflicting changes, the current revision must be passed when updating.
|
|
485
|
-
*
|
|
486
|
-
* Ignored when creating a category.
|
|
487
|
-
* @readonly
|
|
488
|
-
*/
|
|
489
|
-
revision?: string | null;
|
|
490
|
-
/**
|
|
491
|
-
* Date and time the category was created.
|
|
492
|
-
* @readonly
|
|
493
|
-
*/
|
|
494
|
-
_createdDate?: Date | null;
|
|
495
|
-
/**
|
|
496
|
-
* Date and time the category was updated.
|
|
497
|
-
* @readonly
|
|
498
|
-
*/
|
|
499
|
-
_updatedDate?: Date | null;
|
|
500
|
-
/** Category name. */
|
|
501
|
-
name?: string | null;
|
|
502
|
-
/**
|
|
503
|
-
* Category image.
|
|
504
|
-
*
|
|
505
|
-
* + Pass WixMedia image ID for media previously saved in the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).
|
|
506
|
-
* + Pass full image URL to upload to Wix Media Manager.
|
|
507
|
-
*/
|
|
508
|
-
image?: string;
|
|
509
|
-
/**
|
|
510
|
-
* Number of items in this category.
|
|
511
|
-
* @readonly
|
|
512
|
-
*/
|
|
513
|
-
itemCounter?: number;
|
|
514
|
-
/**
|
|
515
|
-
* Category description.
|
|
516
|
-
* > **Note:** This field is returned only when you pass `fields: "DESCRIPTION"` in the request.
|
|
517
|
-
*/
|
|
518
|
-
description?: string | null;
|
|
519
|
-
/**
|
|
520
|
-
* Whether the category is visible to site visitors in dynamic pages.
|
|
521
|
-
*
|
|
522
|
-
* + If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
|
|
523
|
-
* + Passing `true` will fail if the visibility of any parent categories is `false`.
|
|
524
|
-
* + Default: `false`.
|
|
525
|
-
*/
|
|
526
|
-
visible?: boolean | null;
|
|
527
|
-
/**
|
|
528
|
-
* Category breadcrumbs.
|
|
529
|
-
*
|
|
530
|
-
* > **Note:** Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array in Categories API requests.
|
|
531
|
-
* @readonly
|
|
532
|
-
*/
|
|
533
|
-
breadcrumbsInfo?: BreadcrumbsInfo;
|
|
534
|
-
/** Parent category reference data. */
|
|
535
|
-
parentCategory?: ParentCategory;
|
|
536
|
-
/**
|
|
537
|
-
* Category slug.
|
|
538
|
-
*
|
|
539
|
-
* If not provided, the slug is autogenerated based on the category name.
|
|
540
|
-
*/
|
|
541
|
-
slug?: string | null;
|
|
542
|
-
/**
|
|
543
|
-
* Category description using rich content.
|
|
544
|
-
* > **Note:** Returned only when you pass `"RICH_CONTENT_DESCRIPTION"` to the `fields` array in Categories API requests.
|
|
545
|
-
*
|
|
546
|
-
* <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="indent.emoji.divider.codeBlock.file.gallery.giphy.image.table.link.textHighlight.textColor" exampleid="7dc9240e-d548-417a-abcf-0291b68b4303">
|
|
547
|
-
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
548
|
-
* </widget>
|
|
549
|
-
*/
|
|
550
|
-
richContentDescription?: RichContent;
|
|
551
|
-
/**
|
|
552
|
-
* ID of the app responsible for managing the items in this category.
|
|
553
|
-
*
|
|
554
|
-
* Pass your app ID to restrict updating and deleting items in this category to your app only.
|
|
555
|
-
*/
|
|
556
|
-
managingAppId?: string | null;
|
|
557
|
-
/**
|
|
558
|
-
* Custom extended fields for the category object.
|
|
559
|
-
*
|
|
560
|
-
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
|
|
561
|
-
*/
|
|
562
|
-
extendedFields?: ExtendedFields;
|
|
563
|
-
}
|
|
564
|
-
interface BreadcrumbsInfo {
|
|
565
|
-
/**
|
|
566
|
-
* List of breadcrumb data. The current category isn't included in the list.
|
|
567
|
-
* @readonly
|
|
568
|
-
*/
|
|
569
|
-
breadcrumbs?: Breadcrumb[];
|
|
570
|
-
}
|
|
571
|
-
interface Breadcrumb {
|
|
572
|
-
/** Category ID. */
|
|
573
|
-
categoryId?: string;
|
|
574
|
-
/** Category name. */
|
|
575
|
-
categoryName?: string;
|
|
576
|
-
/** Category slug. */
|
|
577
|
-
categorySlug?: string;
|
|
578
|
-
}
|
|
579
|
-
interface ParentCategory {
|
|
580
|
-
/**
|
|
581
|
-
* Parent category ID.
|
|
582
|
-
*
|
|
583
|
-
* Default: root category ID
|
|
584
|
-
*/
|
|
585
|
-
_id?: string | null;
|
|
586
|
-
/**
|
|
587
|
-
* Index position of the category within the parent category.
|
|
588
|
-
* @readonly
|
|
589
|
-
*/
|
|
590
|
-
index?: number | null;
|
|
591
|
-
}
|
|
592
|
-
/**
|
|
593
|
-
* The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
|
|
594
|
-
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
595
|
-
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
596
|
-
*/
|
|
597
|
-
interface SeoSchema {
|
|
598
|
-
/** SEO tag information. */
|
|
599
|
-
tags?: Tag[];
|
|
600
|
-
/** SEO general settings. */
|
|
601
|
-
settings?: Settings;
|
|
602
|
-
}
|
|
603
|
-
interface Keyword {
|
|
604
|
-
/** Keyword value. */
|
|
605
|
-
term?: string;
|
|
606
|
-
/** Whether the keyword is the main focus keyword. */
|
|
607
|
-
isMain?: boolean;
|
|
608
|
-
/** The source that added the keyword terms to the SEO settings. */
|
|
609
|
-
origin?: string | null;
|
|
610
|
-
}
|
|
611
|
-
interface Tag {
|
|
612
|
-
/**
|
|
613
|
-
* SEO tag type.
|
|
614
|
-
*
|
|
615
|
-
*
|
|
616
|
-
* Supported values: `title`, `meta`, `script`, `link`.
|
|
617
|
-
*/
|
|
618
|
-
type?: string;
|
|
619
|
-
/**
|
|
620
|
-
* A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
|
|
621
|
-
* For example: `{"name": "description", "content": "the description itself"}`.
|
|
622
|
-
*/
|
|
623
|
-
props?: Record<string, any> | null;
|
|
624
|
-
/** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
|
|
625
|
-
meta?: Record<string, any> | null;
|
|
626
|
-
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
627
|
-
children?: string;
|
|
628
|
-
/** Whether the tag is a custom tag. */
|
|
629
|
-
custom?: boolean;
|
|
630
|
-
/** Whether the tag is disabled. */
|
|
631
|
-
disabled?: boolean;
|
|
632
|
-
}
|
|
633
|
-
interface Settings {
|
|
634
|
-
/**
|
|
635
|
-
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
636
|
-
*
|
|
637
|
-
*
|
|
638
|
-
* Default: `false` (Auto Redirect is enabled.)
|
|
639
|
-
*/
|
|
640
|
-
preventAutoRedirect?: boolean;
|
|
641
|
-
/** User-selected keyword terms for a specific page. */
|
|
642
|
-
keywords?: Keyword[];
|
|
643
|
-
}
|
|
644
|
-
interface RichContent {
|
|
645
|
-
/** Node objects representing a rich content document. */
|
|
646
|
-
nodes?: Node[];
|
|
647
|
-
/** Object metadata. */
|
|
648
|
-
metadata?: Metadata;
|
|
649
|
-
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
650
|
-
documentStyle?: DocumentStyle;
|
|
651
|
-
}
|
|
652
|
-
interface Node extends NodeDataOneOf {
|
|
653
|
-
/** Data for a button node. */
|
|
654
|
-
buttonData?: ButtonData;
|
|
655
|
-
/** Data for a code block node. */
|
|
656
|
-
codeBlockData?: CodeBlockData;
|
|
657
|
-
/** Data for a divider node. */
|
|
658
|
-
dividerData?: DividerData;
|
|
659
|
-
/** Data for a file node. */
|
|
660
|
-
fileData?: FileData;
|
|
661
|
-
/** Data for a gallery node. */
|
|
662
|
-
galleryData?: GalleryData;
|
|
663
|
-
/** Data for a GIF node. */
|
|
664
|
-
gifData?: GIFData;
|
|
665
|
-
/** Data for a heading node. */
|
|
666
|
-
headingData?: HeadingData;
|
|
667
|
-
/** Data for an embedded HTML node. */
|
|
668
|
-
htmlData?: HTMLData;
|
|
669
|
-
/** Data for an image node. */
|
|
670
|
-
imageData?: ImageData;
|
|
671
|
-
/** Data for a link preview node. */
|
|
672
|
-
linkPreviewData?: LinkPreviewData;
|
|
673
|
-
/** Data for a map node. */
|
|
674
|
-
mapData?: MapData;
|
|
675
|
-
/** Data for a paragraph node. */
|
|
676
|
-
paragraphData?: ParagraphData;
|
|
677
|
-
/** Data for a poll node. */
|
|
678
|
-
pollData?: PollData;
|
|
679
|
-
/** Data for a text node. Used to apply decorations to text. */
|
|
680
|
-
textData?: TextData;
|
|
681
|
-
/** Data for an app embed node. */
|
|
682
|
-
appEmbedData?: AppEmbedData;
|
|
683
|
-
/** Data for a video node. */
|
|
684
|
-
videoData?: VideoData;
|
|
685
|
-
/** Data for an oEmbed node. */
|
|
686
|
-
embedData?: EmbedData;
|
|
687
|
-
/** Data for a collapsible list node. */
|
|
688
|
-
collapsibleListData?: CollapsibleListData;
|
|
689
|
-
/** Data for a table node. */
|
|
690
|
-
tableData?: TableData;
|
|
691
|
-
/** Data for a table cell node. */
|
|
692
|
-
tableCellData?: TableCellData;
|
|
693
|
-
/** Data for a custom external node. */
|
|
694
|
-
externalData?: Record<string, any> | null;
|
|
695
|
-
/** Data for an audio node. */
|
|
696
|
-
audioData?: AudioData;
|
|
697
|
-
/** Data for an ordered list node. */
|
|
698
|
-
orderedListData?: OrderedListData;
|
|
699
|
-
/** Data for a bulleted list node. */
|
|
700
|
-
bulletedListData?: BulletedListData;
|
|
701
|
-
/** Data for a block quote node. */
|
|
702
|
-
blockquoteData?: BlockquoteData;
|
|
703
|
-
/** Data for a caption node. */
|
|
704
|
-
captionData?: CaptionData;
|
|
705
|
-
/** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
|
|
706
|
-
type?: NodeType;
|
|
707
|
-
/** Node ID. */
|
|
708
|
-
_id?: string;
|
|
709
|
-
/** A list of child nodes. */
|
|
710
|
-
nodes?: Node[];
|
|
711
|
-
/** Padding and background color styling for the node. */
|
|
712
|
-
style?: NodeStyle;
|
|
713
|
-
}
|
|
714
|
-
/** @oneof */
|
|
715
|
-
interface NodeDataOneOf {
|
|
716
|
-
/** Data for a button node. */
|
|
717
|
-
buttonData?: ButtonData;
|
|
718
|
-
/** Data for a code block node. */
|
|
719
|
-
codeBlockData?: CodeBlockData;
|
|
720
|
-
/** Data for a divider node. */
|
|
721
|
-
dividerData?: DividerData;
|
|
722
|
-
/** Data for a file node. */
|
|
723
|
-
fileData?: FileData;
|
|
724
|
-
/** Data for a gallery node. */
|
|
725
|
-
galleryData?: GalleryData;
|
|
726
|
-
/** Data for a GIF node. */
|
|
727
|
-
gifData?: GIFData;
|
|
728
|
-
/** Data for a heading node. */
|
|
729
|
-
headingData?: HeadingData;
|
|
730
|
-
/** Data for an embedded HTML node. */
|
|
731
|
-
htmlData?: HTMLData;
|
|
732
|
-
/** Data for an image node. */
|
|
733
|
-
imageData?: ImageData;
|
|
734
|
-
/** Data for a link preview node. */
|
|
735
|
-
linkPreviewData?: LinkPreviewData;
|
|
736
|
-
/** Data for a map node. */
|
|
737
|
-
mapData?: MapData;
|
|
738
|
-
/** Data for a paragraph node. */
|
|
739
|
-
paragraphData?: ParagraphData;
|
|
740
|
-
/** Data for a poll node. */
|
|
741
|
-
pollData?: PollData;
|
|
742
|
-
/** Data for a text node. Used to apply decorations to text. */
|
|
743
|
-
textData?: TextData;
|
|
744
|
-
/** Data for an app embed node. */
|
|
745
|
-
appEmbedData?: AppEmbedData;
|
|
746
|
-
/** Data for a video node. */
|
|
747
|
-
videoData?: VideoData;
|
|
748
|
-
/** Data for an oEmbed node. */
|
|
749
|
-
embedData?: EmbedData;
|
|
750
|
-
/** Data for a collapsible list node. */
|
|
751
|
-
collapsibleListData?: CollapsibleListData;
|
|
752
|
-
/** Data for a table node. */
|
|
753
|
-
tableData?: TableData;
|
|
754
|
-
/** Data for a table cell node. */
|
|
755
|
-
tableCellData?: TableCellData;
|
|
756
|
-
/** Data for a custom external node. */
|
|
757
|
-
externalData?: Record<string, any> | null;
|
|
758
|
-
/** Data for an audio node. */
|
|
759
|
-
audioData?: AudioData;
|
|
760
|
-
/** Data for an ordered list node. */
|
|
761
|
-
orderedListData?: OrderedListData;
|
|
762
|
-
/** Data for a bulleted list node. */
|
|
763
|
-
bulletedListData?: BulletedListData;
|
|
764
|
-
/** Data for a block quote node. */
|
|
765
|
-
blockquoteData?: BlockquoteData;
|
|
766
|
-
/** Data for a caption node. */
|
|
767
|
-
captionData?: CaptionData;
|
|
768
|
-
}
|
|
769
|
-
declare enum NodeType {
|
|
770
|
-
PARAGRAPH = "PARAGRAPH",
|
|
771
|
-
TEXT = "TEXT",
|
|
772
|
-
HEADING = "HEADING",
|
|
773
|
-
BULLETED_LIST = "BULLETED_LIST",
|
|
774
|
-
ORDERED_LIST = "ORDERED_LIST",
|
|
775
|
-
LIST_ITEM = "LIST_ITEM",
|
|
776
|
-
BLOCKQUOTE = "BLOCKQUOTE",
|
|
777
|
-
CODE_BLOCK = "CODE_BLOCK",
|
|
778
|
-
VIDEO = "VIDEO",
|
|
779
|
-
DIVIDER = "DIVIDER",
|
|
780
|
-
FILE = "FILE",
|
|
781
|
-
GALLERY = "GALLERY",
|
|
782
|
-
GIF = "GIF",
|
|
783
|
-
HTML = "HTML",
|
|
784
|
-
IMAGE = "IMAGE",
|
|
785
|
-
LINK_PREVIEW = "LINK_PREVIEW",
|
|
786
|
-
MAP = "MAP",
|
|
787
|
-
POLL = "POLL",
|
|
788
|
-
APP_EMBED = "APP_EMBED",
|
|
789
|
-
BUTTON = "BUTTON",
|
|
790
|
-
COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
|
|
791
|
-
TABLE = "TABLE",
|
|
792
|
-
EMBED = "EMBED",
|
|
793
|
-
COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
|
|
794
|
-
COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
|
|
795
|
-
COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
|
|
796
|
-
TABLE_CELL = "TABLE_CELL",
|
|
797
|
-
TABLE_ROW = "TABLE_ROW",
|
|
798
|
-
EXTERNAL = "EXTERNAL",
|
|
799
|
-
AUDIO = "AUDIO",
|
|
800
|
-
CAPTION = "CAPTION"
|
|
801
|
-
}
|
|
802
|
-
interface NodeStyle {
|
|
803
|
-
/** The top padding value in pixels. */
|
|
804
|
-
paddingTop?: string | null;
|
|
805
|
-
/** The bottom padding value in pixels. */
|
|
806
|
-
paddingBottom?: string | null;
|
|
807
|
-
/** The background color as a hexadecimal value. */
|
|
808
|
-
backgroundColor?: string | null;
|
|
809
|
-
}
|
|
810
|
-
interface ButtonData {
|
|
811
|
-
/** Styling for the button's container. */
|
|
812
|
-
containerData?: PluginContainerData;
|
|
813
|
-
/** The button type. */
|
|
814
|
-
type?: Type;
|
|
815
|
-
/** Styling for the button. */
|
|
816
|
-
styles?: Styles;
|
|
817
|
-
/** The text to display on the button. */
|
|
818
|
-
text?: string | null;
|
|
819
|
-
/** Button link details. */
|
|
820
|
-
link?: Link;
|
|
821
|
-
}
|
|
822
|
-
interface Border {
|
|
823
|
-
/** Border width in pixels. */
|
|
824
|
-
width?: number | null;
|
|
825
|
-
/** Border radius in pixels. */
|
|
826
|
-
radius?: number | null;
|
|
827
|
-
}
|
|
828
|
-
interface Colors {
|
|
829
|
-
/** The text color as a hexadecimal value. */
|
|
830
|
-
text?: string | null;
|
|
831
|
-
/** The border color as a hexadecimal value. */
|
|
832
|
-
border?: string | null;
|
|
833
|
-
/** The background color as a hexadecimal value. */
|
|
834
|
-
background?: string | null;
|
|
835
|
-
}
|
|
836
|
-
interface PluginContainerData {
|
|
837
|
-
/** The width of the node when it's displayed. */
|
|
838
|
-
width?: PluginContainerDataWidth;
|
|
839
|
-
/** The node's alignment within its container. */
|
|
840
|
-
alignment?: PluginContainerDataAlignment;
|
|
841
|
-
/** Spoiler cover settings for the node. */
|
|
842
|
-
spoiler?: Spoiler;
|
|
843
|
-
/** The height of the node when it's displayed. */
|
|
844
|
-
height?: Height;
|
|
845
|
-
/** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
|
|
846
|
-
textWrap?: boolean | null;
|
|
847
|
-
}
|
|
848
|
-
declare enum WidthType {
|
|
849
|
-
/** Width matches the content width */
|
|
850
|
-
CONTENT = "CONTENT",
|
|
851
|
-
/** Small Width */
|
|
852
|
-
SMALL = "SMALL",
|
|
853
|
-
/** Width will match the original asset width */
|
|
854
|
-
ORIGINAL = "ORIGINAL",
|
|
855
|
-
/** coast-to-coast display */
|
|
856
|
-
FULL_WIDTH = "FULL_WIDTH"
|
|
857
|
-
}
|
|
858
|
-
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
859
|
-
/**
|
|
860
|
-
* One of the following predefined width options:
|
|
861
|
-
* `CONTENT`: The width of the container matches the content width.
|
|
862
|
-
* `SMALL`: A small width.
|
|
863
|
-
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
864
|
-
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
865
|
-
*/
|
|
866
|
-
size?: WidthType;
|
|
867
|
-
/** A custom width value in pixels. */
|
|
868
|
-
custom?: string | null;
|
|
869
|
-
}
|
|
870
|
-
/** @oneof */
|
|
871
|
-
interface PluginContainerDataWidthDataOneOf {
|
|
872
|
-
/**
|
|
873
|
-
* One of the following predefined width options:
|
|
874
|
-
* `CONTENT`: The width of the container matches the content width.
|
|
875
|
-
* `SMALL`: A small width.
|
|
876
|
-
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
877
|
-
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
878
|
-
*/
|
|
879
|
-
size?: WidthType;
|
|
880
|
-
/** A custom width value in pixels. */
|
|
881
|
-
custom?: string | null;
|
|
882
|
-
}
|
|
883
|
-
declare enum PluginContainerDataAlignment {
|
|
884
|
-
/** Center Alignment */
|
|
885
|
-
CENTER = "CENTER",
|
|
886
|
-
/** Left Alignment */
|
|
887
|
-
LEFT = "LEFT",
|
|
888
|
-
/** Right Alignment */
|
|
889
|
-
RIGHT = "RIGHT"
|
|
890
|
-
}
|
|
891
|
-
interface Spoiler {
|
|
892
|
-
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
893
|
-
enabled?: boolean | null;
|
|
894
|
-
/** The description displayed on top of the spoiler cover. */
|
|
895
|
-
description?: string | null;
|
|
896
|
-
/** The text for the button used to remove the spoiler cover. */
|
|
897
|
-
buttonText?: string | null;
|
|
898
|
-
}
|
|
899
|
-
interface Height {
|
|
900
|
-
/** A custom height value in pixels. */
|
|
901
|
-
custom?: string | null;
|
|
902
|
-
}
|
|
903
|
-
declare enum Type {
|
|
904
|
-
/** Regular link button */
|
|
905
|
-
LINK = "LINK",
|
|
906
|
-
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
907
|
-
ACTION = "ACTION"
|
|
908
|
-
}
|
|
909
|
-
interface Styles {
|
|
910
|
-
/** Border attributes. */
|
|
911
|
-
border?: Border;
|
|
912
|
-
/** Color attributes. */
|
|
913
|
-
colors?: Colors;
|
|
914
|
-
}
|
|
915
|
-
interface Link extends LinkDataOneOf {
|
|
916
|
-
/** The absolute URL for the linked document. */
|
|
917
|
-
url?: string;
|
|
918
|
-
/** The target node's ID. Used for linking to another node in this object. */
|
|
919
|
-
anchor?: string;
|
|
920
|
-
/**
|
|
921
|
-
* he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
|
|
922
|
-
* `SELF` - Default. Opens the linked document in the same frame as the link.
|
|
923
|
-
* `BLANK` - Opens the linked document in a new browser tab or window.
|
|
924
|
-
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
925
|
-
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
926
|
-
*/
|
|
927
|
-
target?: Target;
|
|
928
|
-
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
929
|
-
rel?: Rel;
|
|
930
|
-
/** A serialized object used for a custom or external link panel. */
|
|
931
|
-
customData?: string | null;
|
|
932
|
-
}
|
|
933
|
-
/** @oneof */
|
|
934
|
-
interface LinkDataOneOf {
|
|
935
|
-
/** The absolute URL for the linked document. */
|
|
936
|
-
url?: string;
|
|
937
|
-
/** The target node's ID. Used for linking to another node in this object. */
|
|
938
|
-
anchor?: string;
|
|
939
|
-
}
|
|
940
|
-
declare enum Target {
|
|
941
|
-
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
942
|
-
SELF = "SELF",
|
|
943
|
-
/** Opens the linked document in a new window or tab */
|
|
944
|
-
BLANK = "BLANK",
|
|
945
|
-
/** Opens the linked document in the parent frame */
|
|
946
|
-
PARENT = "PARENT",
|
|
947
|
-
/** Opens the linked document in the full body of the window */
|
|
948
|
-
TOP = "TOP"
|
|
949
|
-
}
|
|
950
|
-
interface Rel {
|
|
951
|
-
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
952
|
-
nofollow?: boolean | null;
|
|
953
|
-
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
954
|
-
sponsored?: boolean | null;
|
|
955
|
-
/** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
|
|
956
|
-
ugc?: boolean | null;
|
|
957
|
-
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
958
|
-
noreferrer?: boolean | null;
|
|
959
|
-
}
|
|
960
|
-
interface CodeBlockData {
|
|
961
|
-
/** Styling for the code block's text. */
|
|
962
|
-
textStyle?: TextStyle;
|
|
963
|
-
}
|
|
964
|
-
interface TextStyle {
|
|
965
|
-
/** Text alignment. Defaults to `AUTO`. */
|
|
966
|
-
textAlignment?: TextAlignment;
|
|
967
|
-
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
968
|
-
lineHeight?: string | null;
|
|
969
|
-
}
|
|
970
|
-
declare enum TextAlignment {
|
|
971
|
-
/** browser default, eqivalent to `initial` */
|
|
972
|
-
AUTO = "AUTO",
|
|
973
|
-
/** Left align */
|
|
974
|
-
LEFT = "LEFT",
|
|
975
|
-
/** Right align */
|
|
976
|
-
RIGHT = "RIGHT",
|
|
977
|
-
/** Center align */
|
|
978
|
-
CENTER = "CENTER",
|
|
979
|
-
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
|
980
|
-
JUSTIFY = "JUSTIFY"
|
|
981
|
-
}
|
|
982
|
-
interface DividerData {
|
|
983
|
-
/** Styling for the divider's container. */
|
|
984
|
-
containerData?: PluginContainerData;
|
|
985
|
-
/** Divider line style. */
|
|
986
|
-
lineStyle?: LineStyle;
|
|
987
|
-
/** Divider width. */
|
|
988
|
-
width?: Width;
|
|
989
|
-
/** Divider alignment. */
|
|
990
|
-
alignment?: Alignment;
|
|
991
|
-
}
|
|
992
|
-
declare enum LineStyle {
|
|
993
|
-
/** Single Line */
|
|
994
|
-
SINGLE = "SINGLE",
|
|
995
|
-
/** Double Line */
|
|
996
|
-
DOUBLE = "DOUBLE",
|
|
997
|
-
/** Dashed Line */
|
|
998
|
-
DASHED = "DASHED",
|
|
999
|
-
/** Dotted Line */
|
|
1000
|
-
DOTTED = "DOTTED"
|
|
1001
|
-
}
|
|
1002
|
-
declare enum Width {
|
|
1003
|
-
/** Large line */
|
|
1004
|
-
LARGE = "LARGE",
|
|
1005
|
-
/** Medium line */
|
|
1006
|
-
MEDIUM = "MEDIUM",
|
|
1007
|
-
/** Small line */
|
|
1008
|
-
SMALL = "SMALL"
|
|
1009
|
-
}
|
|
1010
|
-
declare enum Alignment {
|
|
1011
|
-
/** Center alignment */
|
|
1012
|
-
CENTER = "CENTER",
|
|
1013
|
-
/** Left alignment */
|
|
1014
|
-
LEFT = "LEFT",
|
|
1015
|
-
/** Right alignment */
|
|
1016
|
-
RIGHT = "RIGHT"
|
|
1017
|
-
}
|
|
1018
|
-
interface FileData {
|
|
1019
|
-
/** Styling for the file's container. */
|
|
1020
|
-
containerData?: PluginContainerData;
|
|
1021
|
-
/** The source for the file's data. */
|
|
1022
|
-
src?: FileSource;
|
|
1023
|
-
/** File name. */
|
|
1024
|
-
name?: string | null;
|
|
1025
|
-
/** File type. */
|
|
1026
|
-
type?: string | null;
|
|
1027
|
-
/**
|
|
1028
|
-
* Use `sizeInKb` instead.
|
|
1029
|
-
* @deprecated
|
|
1030
|
-
*/
|
|
1031
|
-
size?: number | null;
|
|
1032
|
-
/** Settings for PDF files. */
|
|
1033
|
-
pdfSettings?: PDFSettings;
|
|
1034
|
-
/** File MIME type. */
|
|
1035
|
-
mimeType?: string | null;
|
|
1036
|
-
/** File path. */
|
|
1037
|
-
path?: string | null;
|
|
1038
|
-
/** File size in KB. */
|
|
1039
|
-
sizeInKb?: string | null;
|
|
1040
|
-
}
|
|
1041
|
-
declare enum ViewMode {
|
|
1042
|
-
/** No PDF view */
|
|
1043
|
-
NONE = "NONE",
|
|
1044
|
-
/** Full PDF view */
|
|
1045
|
-
FULL = "FULL",
|
|
1046
|
-
/** Mini PDF view */
|
|
1047
|
-
MINI = "MINI"
|
|
1048
|
-
}
|
|
1049
|
-
interface FileSource extends FileSourceDataOneOf {
|
|
1050
|
-
/** The absolute URL for the file's source. */
|
|
1051
|
-
url?: string | null;
|
|
1052
|
-
/**
|
|
1053
|
-
* Custom ID. Use `id` instead.
|
|
1054
|
-
* @deprecated
|
|
1055
|
-
*/
|
|
1056
|
-
custom?: string | null;
|
|
1057
|
-
/** An ID that's resolved to a URL by a resolver function. */
|
|
1058
|
-
_id?: string | null;
|
|
1059
|
-
/** Indicates whether the file's source is private. Defaults to `false`. */
|
|
1060
|
-
private?: boolean | null;
|
|
1061
|
-
}
|
|
1062
|
-
/** @oneof */
|
|
1063
|
-
interface FileSourceDataOneOf {
|
|
1064
|
-
/** The absolute URL for the file's source. */
|
|
1065
|
-
url?: string | null;
|
|
1066
|
-
/**
|
|
1067
|
-
* Custom ID. Use `id` instead.
|
|
1068
|
-
* @deprecated
|
|
1069
|
-
*/
|
|
1070
|
-
custom?: string | null;
|
|
1071
|
-
/** An ID that's resolved to a URL by a resolver function. */
|
|
1072
|
-
_id?: string | null;
|
|
1073
|
-
}
|
|
1074
|
-
interface PDFSettings {
|
|
1075
|
-
/**
|
|
1076
|
-
* PDF view mode. One of the following:
|
|
1077
|
-
* `NONE` : The PDF isn't displayed.
|
|
1078
|
-
* `FULL` : A full page view of the PDF is displayed.
|
|
1079
|
-
* `MINI` : A mini view of the PDF is displayed.
|
|
1080
|
-
*/
|
|
1081
|
-
viewMode?: ViewMode;
|
|
1082
|
-
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
1083
|
-
disableDownload?: boolean | null;
|
|
1084
|
-
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
1085
|
-
disablePrint?: boolean | null;
|
|
1086
|
-
}
|
|
1087
|
-
interface GalleryData {
|
|
1088
|
-
/** Styling for the gallery's container. */
|
|
1089
|
-
containerData?: PluginContainerData;
|
|
1090
|
-
/** The items in the gallery. */
|
|
1091
|
-
items?: Item[];
|
|
1092
|
-
/** Options for defining the gallery's appearance. */
|
|
1093
|
-
options?: GalleryOptions;
|
|
1094
|
-
/** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
|
|
1095
|
-
disableExpand?: boolean | null;
|
|
1096
|
-
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
1097
|
-
disableDownload?: boolean | null;
|
|
1098
|
-
}
|
|
1099
|
-
interface Media {
|
|
1100
|
-
/** The source for the media's data. */
|
|
1101
|
-
src?: FileSource;
|
|
1102
|
-
/** Media width in pixels. */
|
|
1103
|
-
width?: number | null;
|
|
1104
|
-
/** Media height in pixels. */
|
|
1105
|
-
height?: number | null;
|
|
1106
|
-
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
1107
|
-
duration?: number | null;
|
|
1108
|
-
}
|
|
1109
|
-
interface Image {
|
|
1110
|
-
/** Image file details. */
|
|
1111
|
-
media?: Media;
|
|
1112
|
-
/** Link details for images that are links. */
|
|
1113
|
-
link?: Link;
|
|
1114
|
-
}
|
|
1115
|
-
interface Video {
|
|
1116
|
-
/** Video file details. */
|
|
1117
|
-
media?: Media;
|
|
1118
|
-
/** Video thumbnail file details. */
|
|
1119
|
-
thumbnail?: Media;
|
|
1120
|
-
}
|
|
1121
|
-
interface Item extends ItemDataOneOf {
|
|
1122
|
-
/** An image item. */
|
|
1123
|
-
image?: Image;
|
|
1124
|
-
/** A video item. */
|
|
1125
|
-
video?: Video;
|
|
1126
|
-
/** Item title. */
|
|
1127
|
-
title?: string | null;
|
|
1128
|
-
/** Item's alternative text. */
|
|
1129
|
-
altText?: string | null;
|
|
1130
|
-
}
|
|
1131
|
-
/** @oneof */
|
|
1132
|
-
interface ItemDataOneOf {
|
|
1133
|
-
/** An image item. */
|
|
1134
|
-
image?: Image;
|
|
1135
|
-
/** A video item. */
|
|
1136
|
-
video?: Video;
|
|
1137
|
-
}
|
|
1138
|
-
interface GalleryOptions {
|
|
1139
|
-
/** Gallery layout. */
|
|
1140
|
-
layout?: Layout;
|
|
1141
|
-
/** Styling for gallery items. */
|
|
1142
|
-
item?: ItemStyle;
|
|
1143
|
-
/** Styling for gallery thumbnail images. */
|
|
1144
|
-
thumbnails?: Thumbnails;
|
|
1145
|
-
}
|
|
1146
|
-
declare enum LayoutType {
|
|
1147
|
-
/** Collage type */
|
|
1148
|
-
COLLAGE = "COLLAGE",
|
|
1149
|
-
/** Masonry type */
|
|
1150
|
-
MASONRY = "MASONRY",
|
|
1151
|
-
/** Grid type */
|
|
1152
|
-
GRID = "GRID",
|
|
1153
|
-
/** Thumbnail type */
|
|
1154
|
-
THUMBNAIL = "THUMBNAIL",
|
|
1155
|
-
/** Slider type */
|
|
1156
|
-
SLIDER = "SLIDER",
|
|
1157
|
-
/** Slideshow type */
|
|
1158
|
-
SLIDESHOW = "SLIDESHOW",
|
|
1159
|
-
/** Panorama type */
|
|
1160
|
-
PANORAMA = "PANORAMA",
|
|
1161
|
-
/** Column type */
|
|
1162
|
-
COLUMN = "COLUMN",
|
|
1163
|
-
/** Magic type */
|
|
1164
|
-
MAGIC = "MAGIC",
|
|
1165
|
-
/** Fullsize images type */
|
|
1166
|
-
FULLSIZE = "FULLSIZE"
|
|
1167
|
-
}
|
|
1168
|
-
declare enum Orientation {
|
|
1169
|
-
/** Rows Orientation */
|
|
1170
|
-
ROWS = "ROWS",
|
|
1171
|
-
/** Columns Orientation */
|
|
1172
|
-
COLUMNS = "COLUMNS"
|
|
1173
|
-
}
|
|
1174
|
-
declare enum Crop {
|
|
1175
|
-
/** Crop to fill */
|
|
1176
|
-
FILL = "FILL",
|
|
1177
|
-
/** Crop to fit */
|
|
1178
|
-
FIT = "FIT"
|
|
1179
|
-
}
|
|
1180
|
-
declare enum ThumbnailsAlignment {
|
|
1181
|
-
/** Top alignment */
|
|
1182
|
-
TOP = "TOP",
|
|
1183
|
-
/** Right alignment */
|
|
1184
|
-
RIGHT = "RIGHT",
|
|
1185
|
-
/** Bottom alignment */
|
|
1186
|
-
BOTTOM = "BOTTOM",
|
|
1187
|
-
/** Left alignment */
|
|
1188
|
-
LEFT = "LEFT",
|
|
1189
|
-
/** No thumbnail */
|
|
1190
|
-
NONE = "NONE"
|
|
1191
|
-
}
|
|
1192
|
-
interface Layout {
|
|
1193
|
-
/** Gallery layout type. */
|
|
1194
|
-
type?: LayoutType;
|
|
1195
|
-
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
1196
|
-
horizontalScroll?: boolean | null;
|
|
1197
|
-
/** Gallery orientation. */
|
|
1198
|
-
orientation?: Orientation;
|
|
1199
|
-
/** The number of columns to display on full size screens. */
|
|
1200
|
-
numberOfColumns?: number | null;
|
|
1201
|
-
/** The number of columns to display on mobile screens. */
|
|
1202
|
-
mobileNumberOfColumns?: number | null;
|
|
1203
|
-
}
|
|
1204
|
-
interface ItemStyle {
|
|
1205
|
-
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
1206
|
-
targetSize?: number | null;
|
|
1207
|
-
/** Item ratio */
|
|
1208
|
-
ratio?: number | null;
|
|
1209
|
-
/** Sets how item images are cropped. */
|
|
1210
|
-
crop?: Crop;
|
|
1211
|
-
/** The spacing between items in pixels. */
|
|
1212
|
-
spacing?: number | null;
|
|
1213
|
-
}
|
|
1214
|
-
interface Thumbnails {
|
|
1215
|
-
/** Thumbnail alignment. */
|
|
1216
|
-
placement?: ThumbnailsAlignment;
|
|
1217
|
-
/** Spacing between thumbnails in pixels. */
|
|
1218
|
-
spacing?: number | null;
|
|
1219
|
-
}
|
|
1220
|
-
interface GIFData {
|
|
1221
|
-
/** Styling for the GIF's container. */
|
|
1222
|
-
containerData?: PluginContainerData;
|
|
1223
|
-
/** The source of the full size GIF. */
|
|
1224
|
-
original?: GIF;
|
|
1225
|
-
/** The source of the downsized GIF. */
|
|
1226
|
-
downsized?: GIF;
|
|
1227
|
-
/** Height in pixels. */
|
|
1228
|
-
height?: number;
|
|
1229
|
-
/** Width in pixels. */
|
|
1230
|
-
width?: number;
|
|
1231
|
-
}
|
|
1232
|
-
interface GIF {
|
|
1233
|
-
/** GIF format URL. */
|
|
1234
|
-
gif?: string | null;
|
|
1235
|
-
/** MP4 format URL. */
|
|
1236
|
-
mp4?: string | null;
|
|
1237
|
-
/** Thumbnail URL. */
|
|
1238
|
-
still?: string | null;
|
|
1239
|
-
}
|
|
1240
|
-
interface HeadingData {
|
|
1241
|
-
/** Heading level from 1-6. */
|
|
1242
|
-
level?: number;
|
|
1243
|
-
/** Styling for the heading text. */
|
|
1244
|
-
textStyle?: TextStyle;
|
|
1245
|
-
/** Indentation level from 1-4. */
|
|
1246
|
-
indentation?: number | null;
|
|
1247
|
-
}
|
|
1248
|
-
interface HTMLData extends HTMLDataDataOneOf {
|
|
1249
|
-
/** The URL for the HTML code for the node. */
|
|
1250
|
-
url?: string;
|
|
1251
|
-
/** The HTML code for the node. */
|
|
1252
|
-
html?: string;
|
|
1253
|
-
/**
|
|
1254
|
-
* Whether this is an AdSense element. Use `source` instead.
|
|
1255
|
-
* @deprecated
|
|
1256
|
-
*/
|
|
1257
|
-
isAdsense?: boolean | null;
|
|
1258
|
-
/** Styling for the HTML node's container. */
|
|
1259
|
-
containerData?: PluginContainerData;
|
|
1260
|
-
/** The type of HTML code. */
|
|
1261
|
-
source?: Source;
|
|
1262
|
-
}
|
|
1263
|
-
/** @oneof */
|
|
1264
|
-
interface HTMLDataDataOneOf {
|
|
1265
|
-
/** The URL for the HTML code for the node. */
|
|
1266
|
-
url?: string;
|
|
1267
|
-
/** The HTML code for the node. */
|
|
1268
|
-
html?: string;
|
|
1269
|
-
/**
|
|
1270
|
-
* Whether this is an AdSense element. Use `source` instead.
|
|
1271
|
-
* @deprecated
|
|
1272
|
-
*/
|
|
1273
|
-
isAdsense?: boolean | null;
|
|
1274
|
-
}
|
|
1275
|
-
declare enum Source {
|
|
1276
|
-
HTML = "HTML",
|
|
1277
|
-
ADSENSE = "ADSENSE"
|
|
1278
|
-
}
|
|
1279
|
-
interface ImageData {
|
|
1280
|
-
/** Styling for the image's container. */
|
|
1281
|
-
containerData?: PluginContainerData;
|
|
1282
|
-
/** Image file details. */
|
|
1283
|
-
image?: Media;
|
|
1284
|
-
/** Link details for images that are links. */
|
|
1285
|
-
link?: Link;
|
|
1286
|
-
/** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
|
|
1287
|
-
disableExpand?: boolean | null;
|
|
1288
|
-
/** Image's alternative text. */
|
|
1289
|
-
altText?: string | null;
|
|
1290
|
-
/**
|
|
1291
|
-
* Deprecated: use Caption node instead.
|
|
1292
|
-
* @deprecated
|
|
1293
|
-
*/
|
|
1294
|
-
caption?: string | null;
|
|
1295
|
-
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
1296
|
-
disableDownload?: boolean | null;
|
|
1297
|
-
}
|
|
1298
|
-
interface LinkPreviewData {
|
|
1299
|
-
/** Styling for the link preview's container. */
|
|
1300
|
-
containerData?: PluginContainerData;
|
|
1301
|
-
/** Link details. */
|
|
1302
|
-
link?: Link;
|
|
1303
|
-
/** Preview title. */
|
|
1304
|
-
title?: string | null;
|
|
1305
|
-
/** Preview thumbnail URL. */
|
|
1306
|
-
thumbnailUrl?: string | null;
|
|
1307
|
-
/** Preview description. */
|
|
1308
|
-
description?: string | null;
|
|
1309
|
-
/** The preview content as HTML. */
|
|
1310
|
-
html?: string | null;
|
|
1311
|
-
}
|
|
1312
|
-
interface MapData {
|
|
1313
|
-
/** Styling for the map's container. */
|
|
1314
|
-
containerData?: PluginContainerData;
|
|
1315
|
-
/** Map settings. */
|
|
1316
|
-
mapSettings?: MapSettings;
|
|
1317
|
-
}
|
|
1318
|
-
interface MapSettings {
|
|
1319
|
-
/** The address to display on the map. */
|
|
1320
|
-
address?: string | null;
|
|
1321
|
-
/** Sets whether the map is draggable. */
|
|
1322
|
-
draggable?: boolean | null;
|
|
1323
|
-
/** Sets whether the location marker is visible. */
|
|
1324
|
-
marker?: boolean | null;
|
|
1325
|
-
/** Sets whether street view control is enabled. */
|
|
1326
|
-
streetViewControl?: boolean | null;
|
|
1327
|
-
/** Sets whether zoom control is enabled. */
|
|
1328
|
-
zoomControl?: boolean | null;
|
|
1329
|
-
/** Location latitude. */
|
|
1330
|
-
lat?: number | null;
|
|
1331
|
-
/** Location longitude. */
|
|
1332
|
-
lng?: number | null;
|
|
1333
|
-
/** Location name. */
|
|
1334
|
-
locationName?: string | null;
|
|
1335
|
-
/** Sets whether view mode control is enabled. */
|
|
1336
|
-
viewModeControl?: boolean | null;
|
|
1337
|
-
/** Initial zoom value. */
|
|
1338
|
-
initialZoom?: number | null;
|
|
1339
|
-
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1340
|
-
mapType?: MapType;
|
|
1341
|
-
}
|
|
1342
|
-
declare enum MapType {
|
|
1343
|
-
/** Roadmap map type */
|
|
1344
|
-
ROADMAP = "ROADMAP",
|
|
1345
|
-
/** Satellite map type */
|
|
1346
|
-
SATELITE = "SATELITE",
|
|
1347
|
-
/** Hybrid map type */
|
|
1348
|
-
HYBRID = "HYBRID",
|
|
1349
|
-
/** Terrain map type */
|
|
1350
|
-
TERRAIN = "TERRAIN"
|
|
1351
|
-
}
|
|
1352
|
-
interface ParagraphData {
|
|
1353
|
-
/** Styling for the paragraph text. */
|
|
1354
|
-
textStyle?: TextStyle;
|
|
1355
|
-
/** Indentation level from 1-4. */
|
|
1356
|
-
indentation?: number | null;
|
|
1357
|
-
/** Paragraph level */
|
|
1358
|
-
level?: number | null;
|
|
1359
|
-
}
|
|
1360
|
-
interface PollData {
|
|
1361
|
-
/** Styling for the poll's container. */
|
|
1362
|
-
containerData?: PluginContainerData;
|
|
1363
|
-
/** Poll data. */
|
|
1364
|
-
poll?: Poll;
|
|
1365
|
-
/** Layout settings for the poll and voting options. */
|
|
1366
|
-
layout?: PollDataLayout;
|
|
1367
|
-
/** Styling for the poll and voting options. */
|
|
1368
|
-
design?: Design;
|
|
1369
|
-
}
|
|
1370
|
-
declare enum ViewRole {
|
|
1371
|
-
/** Only Poll creator can view the results */
|
|
1372
|
-
CREATOR = "CREATOR",
|
|
1373
|
-
/** Anyone who voted can see the results */
|
|
1374
|
-
VOTERS = "VOTERS",
|
|
1375
|
-
/** Anyone can see the results, even if one didn't vote */
|
|
1376
|
-
EVERYONE = "EVERYONE"
|
|
1377
|
-
}
|
|
1378
|
-
declare enum VoteRole {
|
|
1379
|
-
/** Logged in member */
|
|
1380
|
-
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1381
|
-
/** Anyone */
|
|
1382
|
-
ALL = "ALL"
|
|
1383
|
-
}
|
|
1384
|
-
interface Permissions {
|
|
1385
|
-
/** Sets who can view the poll results. */
|
|
1386
|
-
view?: ViewRole;
|
|
1387
|
-
/** Sets who can vote. */
|
|
1388
|
-
vote?: VoteRole;
|
|
1389
|
-
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1390
|
-
allowMultipleVotes?: boolean | null;
|
|
1391
|
-
}
|
|
1392
|
-
interface Option {
|
|
1393
|
-
/** Option ID. */
|
|
1394
|
-
_id?: string | null;
|
|
1395
|
-
/** Option title. */
|
|
1396
|
-
title?: string | null;
|
|
1397
|
-
/** The image displayed with the option. */
|
|
1398
|
-
image?: Media;
|
|
1399
|
-
}
|
|
1400
|
-
interface PollSettings {
|
|
1401
|
-
/** Permissions settings for voting. */
|
|
1402
|
-
permissions?: Permissions;
|
|
1403
|
-
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
1404
|
-
showVoters?: boolean | null;
|
|
1405
|
-
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1406
|
-
showVotesCount?: boolean | null;
|
|
1407
|
-
}
|
|
1408
|
-
declare enum PollLayoutType {
|
|
1409
|
-
/** List */
|
|
1410
|
-
LIST = "LIST",
|
|
1411
|
-
/** Grid */
|
|
1412
|
-
GRID = "GRID"
|
|
1413
|
-
}
|
|
1414
|
-
declare enum PollLayoutDirection {
|
|
1415
|
-
/** Left-to-right */
|
|
1416
|
-
LTR = "LTR",
|
|
1417
|
-
/** Right-to-left */
|
|
1418
|
-
RTL = "RTL"
|
|
1419
|
-
}
|
|
1420
|
-
interface PollLayout {
|
|
1421
|
-
/** The layout for displaying the voting options. */
|
|
1422
|
-
type?: PollLayoutType;
|
|
1423
|
-
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
1424
|
-
direction?: PollLayoutDirection;
|
|
1425
|
-
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1426
|
-
enableImage?: boolean | null;
|
|
1427
|
-
}
|
|
1428
|
-
interface OptionLayout {
|
|
1429
|
-
/** Sets whether to display option images. Defaults to `false`. */
|
|
1430
|
-
enableImage?: boolean | null;
|
|
1431
|
-
}
|
|
1432
|
-
declare enum BackgroundType {
|
|
1433
|
-
/** Color background type */
|
|
1434
|
-
COLOR = "COLOR",
|
|
1435
|
-
/** Image background type */
|
|
1436
|
-
IMAGE = "IMAGE",
|
|
1437
|
-
/** Gradiant background type */
|
|
1438
|
-
GRADIENT = "GRADIENT"
|
|
1439
|
-
}
|
|
1440
|
-
interface Gradient {
|
|
1441
|
-
/** The gradient angle in degrees. */
|
|
1442
|
-
angle?: number | null;
|
|
1443
|
-
/** The start color as a hexademical value. */
|
|
1444
|
-
startColor?: string | null;
|
|
1445
|
-
/** The end color as a hexademical value. */
|
|
1446
|
-
lastColor?: string | null;
|
|
1447
|
-
}
|
|
1448
|
-
interface Background extends BackgroundBackgroundOneOf {
|
|
1449
|
-
/** The background color as a hexademical value. */
|
|
1450
|
-
color?: string | null;
|
|
1451
|
-
/** An image to use for the background. */
|
|
1452
|
-
image?: Media;
|
|
1453
|
-
/** Details for a gradient background. */
|
|
1454
|
-
gradient?: Gradient;
|
|
1455
|
-
/** Background type. For each option, include the relevant details. */
|
|
1456
|
-
type?: BackgroundType;
|
|
1457
|
-
}
|
|
1458
|
-
/** @oneof */
|
|
1459
|
-
interface BackgroundBackgroundOneOf {
|
|
1460
|
-
/** The background color as a hexademical value. */
|
|
1461
|
-
color?: string | null;
|
|
1462
|
-
/** An image to use for the background. */
|
|
1463
|
-
image?: Media;
|
|
1464
|
-
/** Details for a gradient background. */
|
|
1465
|
-
gradient?: Gradient;
|
|
1466
|
-
}
|
|
1467
|
-
interface PollDesign {
|
|
1468
|
-
/** Background styling. */
|
|
1469
|
-
background?: Background;
|
|
1470
|
-
/** Border radius in pixels. */
|
|
1471
|
-
borderRadius?: number | null;
|
|
1472
|
-
}
|
|
1473
|
-
interface OptionDesign {
|
|
1474
|
-
/** Border radius in pixels. */
|
|
1475
|
-
borderRadius?: number | null;
|
|
1476
|
-
}
|
|
1477
|
-
interface Poll {
|
|
1478
|
-
/** Poll ID. */
|
|
1479
|
-
_id?: string | null;
|
|
1480
|
-
/** Poll title. */
|
|
1481
|
-
title?: string | null;
|
|
1482
|
-
/** Poll creator ID. */
|
|
1483
|
-
creatorId?: string | null;
|
|
1484
|
-
/** Main poll image. */
|
|
1485
|
-
image?: Media;
|
|
1486
|
-
/** Voting options. */
|
|
1487
|
-
options?: Option[];
|
|
1488
|
-
/** The poll's permissions and display settings. */
|
|
1489
|
-
settings?: PollSettings;
|
|
1490
|
-
}
|
|
1491
|
-
interface PollDataLayout {
|
|
1492
|
-
/** Poll layout settings. */
|
|
1493
|
-
poll?: PollLayout;
|
|
1494
|
-
/** Voting otpions layout settings. */
|
|
1495
|
-
options?: OptionLayout;
|
|
1496
|
-
}
|
|
1497
|
-
interface Design {
|
|
1498
|
-
/** Styling for the poll. */
|
|
1499
|
-
poll?: PollDesign;
|
|
1500
|
-
/** Styling for voting options. */
|
|
1501
|
-
options?: OptionDesign;
|
|
1502
|
-
}
|
|
1503
|
-
interface TextData {
|
|
1504
|
-
/** The text to apply decorations to. */
|
|
1505
|
-
text?: string;
|
|
1506
|
-
/** The decorations to apply. */
|
|
1507
|
-
decorations?: Decoration[];
|
|
1508
|
-
}
|
|
1509
|
-
/** Adds appearence changes to text */
|
|
1510
|
-
interface Decoration extends DecorationDataOneOf {
|
|
1511
|
-
/** Data for an anchor link decoration. */
|
|
1512
|
-
anchorData?: AnchorData;
|
|
1513
|
-
/** Data for a color decoration. */
|
|
1514
|
-
colorData?: ColorData;
|
|
1515
|
-
/** Data for an external link decoration. */
|
|
1516
|
-
linkData?: LinkData;
|
|
1517
|
-
/** Data for a mention decoration. */
|
|
1518
|
-
mentionData?: MentionData;
|
|
1519
|
-
/** Data for a font size decoration. */
|
|
1520
|
-
fontSizeData?: FontSizeData;
|
|
1521
|
-
/** Font weight for a bold decoration. */
|
|
1522
|
-
fontWeightValue?: number | null;
|
|
1523
|
-
/** Data for an italic decoration. Defaults to `true`. */
|
|
1524
|
-
italicData?: boolean | null;
|
|
1525
|
-
/** Data for an underline decoration. Defaults to `true`. */
|
|
1526
|
-
underlineData?: boolean | null;
|
|
1527
|
-
/** Data for a spoiler decoration. */
|
|
1528
|
-
spoilerData?: SpoilerData;
|
|
1529
|
-
/** The type of decoration to apply. */
|
|
1530
|
-
type?: DecorationType;
|
|
1531
|
-
}
|
|
1532
|
-
/** @oneof */
|
|
1533
|
-
interface DecorationDataOneOf {
|
|
1534
|
-
/** Data for an anchor link decoration. */
|
|
1535
|
-
anchorData?: AnchorData;
|
|
1536
|
-
/** Data for a color decoration. */
|
|
1537
|
-
colorData?: ColorData;
|
|
1538
|
-
/** Data for an external link decoration. */
|
|
1539
|
-
linkData?: LinkData;
|
|
1540
|
-
/** Data for a mention decoration. */
|
|
1541
|
-
mentionData?: MentionData;
|
|
1542
|
-
/** Data for a font size decoration. */
|
|
1543
|
-
fontSizeData?: FontSizeData;
|
|
1544
|
-
/** Font weight for a bold decoration. */
|
|
1545
|
-
fontWeightValue?: number | null;
|
|
1546
|
-
/** Data for an italic decoration. Defaults to `true`. */
|
|
1547
|
-
italicData?: boolean | null;
|
|
1548
|
-
/** Data for an underline decoration. Defaults to `true`. */
|
|
1549
|
-
underlineData?: boolean | null;
|
|
1550
|
-
/** Data for a spoiler decoration. */
|
|
1551
|
-
spoilerData?: SpoilerData;
|
|
1552
|
-
}
|
|
1553
|
-
declare enum DecorationType {
|
|
1554
|
-
BOLD = "BOLD",
|
|
1555
|
-
ITALIC = "ITALIC",
|
|
1556
|
-
UNDERLINE = "UNDERLINE",
|
|
1557
|
-
SPOILER = "SPOILER",
|
|
1558
|
-
ANCHOR = "ANCHOR",
|
|
1559
|
-
MENTION = "MENTION",
|
|
1560
|
-
LINK = "LINK",
|
|
1561
|
-
COLOR = "COLOR",
|
|
1562
|
-
FONT_SIZE = "FONT_SIZE",
|
|
1563
|
-
EXTERNAL = "EXTERNAL"
|
|
1564
|
-
}
|
|
1565
|
-
interface AnchorData {
|
|
1566
|
-
/** The target node's ID. */
|
|
1567
|
-
anchor?: string;
|
|
1568
|
-
}
|
|
1569
|
-
interface ColorData {
|
|
1570
|
-
/** The text's background color as a hexadecimal value. */
|
|
1571
|
-
background?: string | null;
|
|
1572
|
-
/** The text's foreground color as a hexadecimal value. */
|
|
1573
|
-
foreground?: string | null;
|
|
1574
|
-
}
|
|
1575
|
-
interface LinkData {
|
|
1576
|
-
/** Link details. */
|
|
1577
|
-
link?: Link;
|
|
1578
|
-
}
|
|
1579
|
-
interface MentionData {
|
|
1580
|
-
/** The mentioned user's name. */
|
|
1581
|
-
name?: string;
|
|
1582
|
-
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
1583
|
-
slug?: string;
|
|
1584
|
-
/** Mentioned user's ID. */
|
|
1585
|
-
_id?: string | null;
|
|
1586
|
-
}
|
|
1587
|
-
interface FontSizeData {
|
|
1588
|
-
/** The units used for the font size. */
|
|
1589
|
-
unit?: FontType;
|
|
1590
|
-
/** Font size value. */
|
|
1591
|
-
value?: number | null;
|
|
1592
|
-
}
|
|
1593
|
-
declare enum FontType {
|
|
1594
|
-
PX = "PX",
|
|
1595
|
-
EM = "EM"
|
|
1596
|
-
}
|
|
1597
|
-
interface SpoilerData {
|
|
1598
|
-
/** Spoiler ID. */
|
|
1599
|
-
_id?: string | null;
|
|
1600
|
-
}
|
|
1601
|
-
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1602
|
-
/** Data for embedded Wix Bookings content. */
|
|
1603
|
-
bookingData?: BookingData;
|
|
1604
|
-
/** Data for embedded Wix Events content. */
|
|
1605
|
-
eventData?: EventData;
|
|
1606
|
-
/** The type of Wix App content being embedded. */
|
|
1607
|
-
type?: AppType;
|
|
1608
|
-
/** The ID of the embedded content. */
|
|
1609
|
-
itemId?: string | null;
|
|
1610
|
-
/** The name of the embedded content. */
|
|
1611
|
-
name?: string | null;
|
|
1612
|
-
/**
|
|
1613
|
-
* Deprecated: Use `image` instead.
|
|
1614
|
-
* @deprecated
|
|
1615
|
-
*/
|
|
1616
|
-
imageSrc?: string | null;
|
|
1617
|
-
/** The URL for the embedded content. */
|
|
1618
|
-
url?: string | null;
|
|
1619
|
-
/** An image for the embedded content. */
|
|
1620
|
-
image?: Media;
|
|
1621
|
-
}
|
|
1622
|
-
/** @oneof */
|
|
1623
|
-
interface AppEmbedDataAppDataOneOf {
|
|
1624
|
-
/** Data for embedded Wix Bookings content. */
|
|
1625
|
-
bookingData?: BookingData;
|
|
1626
|
-
/** Data for embedded Wix Events content. */
|
|
1627
|
-
eventData?: EventData;
|
|
1628
|
-
}
|
|
1629
|
-
declare enum AppType {
|
|
1630
|
-
PRODUCT = "PRODUCT",
|
|
1631
|
-
EVENT = "EVENT",
|
|
1632
|
-
BOOKING = "BOOKING"
|
|
1633
|
-
}
|
|
1634
|
-
interface BookingData {
|
|
1635
|
-
/** Booking duration in minutes. */
|
|
1636
|
-
durations?: string | null;
|
|
1637
|
-
}
|
|
1638
|
-
interface EventData {
|
|
1639
|
-
/** Event schedule. */
|
|
1640
|
-
scheduling?: string | null;
|
|
1641
|
-
/** Event location. */
|
|
1642
|
-
location?: string | null;
|
|
1643
|
-
}
|
|
1644
|
-
interface VideoData {
|
|
1645
|
-
/** Styling for the video's container. */
|
|
1646
|
-
containerData?: PluginContainerData;
|
|
1647
|
-
/** Video details. */
|
|
1648
|
-
video?: Media;
|
|
1649
|
-
/** Video thumbnail details. */
|
|
1650
|
-
thumbnail?: Media;
|
|
1651
|
-
/** Sets whether the video's download button is disabled. Defaults to `false`. */
|
|
1652
|
-
disableDownload?: boolean | null;
|
|
1653
|
-
/** Video title. */
|
|
1654
|
-
title?: string | null;
|
|
1655
|
-
/** Video options. */
|
|
1656
|
-
options?: PlaybackOptions;
|
|
1657
|
-
}
|
|
1658
|
-
interface PlaybackOptions {
|
|
1659
|
-
/** Sets whether the media will automatically start playing. */
|
|
1660
|
-
autoPlay?: boolean | null;
|
|
1661
|
-
/** Sets whether media's will be looped. */
|
|
1662
|
-
playInLoop?: boolean | null;
|
|
1663
|
-
/** Sets whether media's controls will be shown. */
|
|
1664
|
-
showControls?: boolean | null;
|
|
1665
|
-
}
|
|
1666
|
-
interface EmbedData {
|
|
1667
|
-
/** Styling for the oEmbed node's container. */
|
|
1668
|
-
containerData?: PluginContainerData;
|
|
1669
|
-
/** An [oEmbed](https://www.oembed.com) object. */
|
|
1670
|
-
oembed?: Oembed;
|
|
1671
|
-
/** Origin asset source. */
|
|
1672
|
-
src?: string | null;
|
|
1673
|
-
}
|
|
1674
|
-
interface Oembed {
|
|
1675
|
-
/** The resource type. */
|
|
1676
|
-
type?: string | null;
|
|
1677
|
-
/** The width of the resource specified in the `url` property in pixels. */
|
|
1678
|
-
width?: number | null;
|
|
1679
|
-
/** The height of the resource specified in the `url` property in pixels. */
|
|
1680
|
-
height?: number | null;
|
|
1681
|
-
/** Resource title. */
|
|
1682
|
-
title?: string | null;
|
|
1683
|
-
/** The source URL for the resource. */
|
|
1684
|
-
url?: string | null;
|
|
1685
|
-
/** HTML for embedding a video player. The HTML should have no padding or margins. */
|
|
1686
|
-
html?: string | null;
|
|
1687
|
-
/** The name of the author or owner of the resource. */
|
|
1688
|
-
authorName?: string | null;
|
|
1689
|
-
/** The URL for the author or owner of the resource. */
|
|
1690
|
-
authorUrl?: string | null;
|
|
1691
|
-
/** The name of the resource provider. */
|
|
1692
|
-
providerName?: string | null;
|
|
1693
|
-
/** The URL for the resource provider. */
|
|
1694
|
-
providerUrl?: string | null;
|
|
1695
|
-
/** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
|
|
1696
|
-
thumbnailUrl?: string | null;
|
|
1697
|
-
/** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
|
|
1698
|
-
thumbnailWidth?: string | null;
|
|
1699
|
-
/** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
|
|
1700
|
-
thumbnailHeight?: string | null;
|
|
1701
|
-
/** The URL for an embedded viedo. */
|
|
1702
|
-
videoUrl?: string | null;
|
|
1703
|
-
/** The oEmbed version number. This value must be `1.0`. */
|
|
1704
|
-
version?: string | null;
|
|
1705
|
-
}
|
|
1706
|
-
interface CollapsibleListData {
|
|
1707
|
-
/** Styling for the collapsible list's container. */
|
|
1708
|
-
containerData?: PluginContainerData;
|
|
1709
|
-
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
1710
|
-
expandOnlyOne?: boolean | null;
|
|
1711
|
-
/** Sets which items are expanded when the page loads. */
|
|
1712
|
-
initialExpandedItems?: InitialExpandedItems;
|
|
1713
|
-
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
1714
|
-
direction?: Direction;
|
|
1715
|
-
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1716
|
-
isQapageData?: boolean | null;
|
|
1717
|
-
}
|
|
1718
|
-
declare enum InitialExpandedItems {
|
|
1719
|
-
/** First item will be expended initally */
|
|
1720
|
-
FIRST = "FIRST",
|
|
1721
|
-
/** All items will expended initally */
|
|
1722
|
-
ALL = "ALL",
|
|
1723
|
-
/** All items collapsed initally */
|
|
1724
|
-
NONE = "NONE"
|
|
1725
|
-
}
|
|
1726
|
-
declare enum Direction {
|
|
1727
|
-
/** Left-to-right */
|
|
1728
|
-
LTR = "LTR",
|
|
1729
|
-
/** Right-to-left */
|
|
1730
|
-
RTL = "RTL"
|
|
1731
|
-
}
|
|
1732
|
-
interface TableData {
|
|
1733
|
-
/** Styling for the table's container. */
|
|
1734
|
-
containerData?: PluginContainerData;
|
|
1735
|
-
/** The table's dimensions. */
|
|
1736
|
-
dimensions?: Dimensions;
|
|
1737
|
-
/**
|
|
1738
|
-
* Deprecated: Use `rowHeader` and `columnHeader` instead.
|
|
1739
|
-
* @deprecated
|
|
1740
|
-
*/
|
|
1741
|
-
header?: boolean | null;
|
|
1742
|
-
/** Sets whether the table's first row is a header. Defaults to `false`. */
|
|
1743
|
-
rowHeader?: boolean | null;
|
|
1744
|
-
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1745
|
-
columnHeader?: boolean | null;
|
|
1746
|
-
}
|
|
1747
|
-
interface Dimensions {
|
|
1748
|
-
/** An array representing relative width of each column in relation to the other columns. */
|
|
1749
|
-
colsWidthRatio?: number[];
|
|
1750
|
-
/** An array representing the height of each row in pixels. */
|
|
1751
|
-
rowsHeight?: number[];
|
|
1752
|
-
/** An array representing the minimum width of each column in pixels. */
|
|
1753
|
-
colsMinWidth?: number[];
|
|
1754
|
-
}
|
|
1755
|
-
interface TableCellData {
|
|
1756
|
-
/** Styling for the cell's background color and text alignment. */
|
|
1757
|
-
cellStyle?: CellStyle;
|
|
1758
|
-
/** The cell's border colors. */
|
|
1759
|
-
borderColors?: BorderColors;
|
|
1760
|
-
}
|
|
1761
|
-
declare enum VerticalAlignment {
|
|
1762
|
-
/** Top alignment */
|
|
1763
|
-
TOP = "TOP",
|
|
1764
|
-
/** Middle alignment */
|
|
1765
|
-
MIDDLE = "MIDDLE",
|
|
1766
|
-
/** Bottom alignment */
|
|
1767
|
-
BOTTOM = "BOTTOM"
|
|
1768
|
-
}
|
|
1769
|
-
interface CellStyle {
|
|
1770
|
-
/** Vertical alignment for the cell's text. */
|
|
1771
|
-
verticalAlignment?: VerticalAlignment;
|
|
1772
|
-
/** Cell background color as a hexadecimal value. */
|
|
1773
|
-
backgroundColor?: string | null;
|
|
1774
|
-
}
|
|
1775
|
-
interface BorderColors {
|
|
1776
|
-
/** Left border color as a hexadecimal value. */
|
|
1777
|
-
left?: string | null;
|
|
1778
|
-
/** Right border color as a hexadecimal value. */
|
|
1779
|
-
right?: string | null;
|
|
1780
|
-
/** Top border color as a hexadecimal value. */
|
|
1781
|
-
top?: string | null;
|
|
1782
|
-
/** Bottom border color as a hexadecimal value. */
|
|
1783
|
-
bottom?: string | null;
|
|
1784
|
-
}
|
|
1785
|
-
/**
|
|
1786
|
-
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
1787
|
-
* `Value` type union.
|
|
1788
|
-
*
|
|
1789
|
-
* The JSON representation for `NullValue` is JSON `null`.
|
|
1790
|
-
*/
|
|
1791
|
-
declare enum NullValue {
|
|
1792
|
-
/** Null value. */
|
|
1793
|
-
NULL_VALUE = "NULL_VALUE"
|
|
1794
|
-
}
|
|
1795
|
-
/**
|
|
1796
|
-
* `ListValue` is a wrapper around a repeated field of values.
|
|
1797
|
-
*
|
|
1798
|
-
* The JSON representation for `ListValue` is JSON array.
|
|
1799
|
-
*/
|
|
1800
|
-
interface ListValue {
|
|
1801
|
-
/** Repeated field of dynamically typed values. */
|
|
1802
|
-
values?: any[];
|
|
1803
|
-
}
|
|
1804
|
-
interface AudioData {
|
|
1805
|
-
/** Styling for the audio node's container. */
|
|
1806
|
-
containerData?: PluginContainerData;
|
|
1807
|
-
/** Audio file details. */
|
|
1808
|
-
audio?: Media;
|
|
1809
|
-
/** Sets whether the audio node's download button is disabled. Defaults to `false`. */
|
|
1810
|
-
disableDownload?: boolean | null;
|
|
1811
|
-
/** Cover image. */
|
|
1812
|
-
coverImage?: Media;
|
|
1813
|
-
/** Track name. */
|
|
1814
|
-
name?: string | null;
|
|
1815
|
-
/** Author name. */
|
|
1816
|
-
authorName?: string | null;
|
|
1817
|
-
/** An HTML version of the audio node. */
|
|
1818
|
-
html?: string | null;
|
|
1819
|
-
}
|
|
1820
|
-
interface OrderedListData {
|
|
1821
|
-
/** Indentation level from 0-4. */
|
|
1822
|
-
indentation?: number;
|
|
1823
|
-
/** Offset level from 0-4. */
|
|
1824
|
-
offset?: number | null;
|
|
1825
|
-
/** List start number. */
|
|
1826
|
-
start?: number | null;
|
|
1827
|
-
}
|
|
1828
|
-
interface BulletedListData {
|
|
1829
|
-
/** Indentation level from 0-4. */
|
|
1830
|
-
indentation?: number;
|
|
1831
|
-
/** Offset level from 0-4. */
|
|
1832
|
-
offset?: number | null;
|
|
1833
|
-
}
|
|
1834
|
-
interface BlockquoteData {
|
|
1835
|
-
/** Indentation level from 1-4. */
|
|
1836
|
-
indentation?: number;
|
|
1837
|
-
}
|
|
1838
|
-
interface CaptionData {
|
|
1839
|
-
textStyle?: TextStyle;
|
|
1840
|
-
}
|
|
1841
|
-
interface Metadata {
|
|
1842
|
-
/** Schema version. */
|
|
1843
|
-
version?: number;
|
|
1844
|
-
/**
|
|
1845
|
-
* When the object was created.
|
|
1846
|
-
* @readonly
|
|
1847
|
-
* @deprecated
|
|
1848
|
-
*/
|
|
1849
|
-
createdTimestamp?: Date | null;
|
|
1850
|
-
/**
|
|
1851
|
-
* When the object was most recently updated.
|
|
1852
|
-
* @deprecated
|
|
1853
|
-
*/
|
|
1854
|
-
updatedTimestamp?: Date | null;
|
|
1855
|
-
/** Object ID. */
|
|
1856
|
-
_id?: string | null;
|
|
1857
|
-
}
|
|
1858
|
-
interface DocumentStyle {
|
|
1859
|
-
/** Styling for H1 nodes. */
|
|
1860
|
-
headerOne?: TextNodeStyle;
|
|
1861
|
-
/** Styling for H2 nodes. */
|
|
1862
|
-
headerTwo?: TextNodeStyle;
|
|
1863
|
-
/** Styling for H3 nodes. */
|
|
1864
|
-
headerThree?: TextNodeStyle;
|
|
1865
|
-
/** Styling for H4 nodes. */
|
|
1866
|
-
headerFour?: TextNodeStyle;
|
|
1867
|
-
/** Styling for H5 nodes. */
|
|
1868
|
-
headerFive?: TextNodeStyle;
|
|
1869
|
-
/** Styling for H6 nodes. */
|
|
1870
|
-
headerSix?: TextNodeStyle;
|
|
1871
|
-
/** Styling for paragraph nodes. */
|
|
1872
|
-
paragraph?: TextNodeStyle;
|
|
1873
|
-
/** Styling for block quote nodes. */
|
|
1874
|
-
blockquote?: TextNodeStyle;
|
|
1875
|
-
/** Styling for code block nodes. */
|
|
1876
|
-
codeBlock?: TextNodeStyle;
|
|
1877
|
-
}
|
|
1878
|
-
interface TextNodeStyle {
|
|
1879
|
-
/** The decorations to apply to the node. */
|
|
1880
|
-
decorations?: Decoration[];
|
|
1881
|
-
/** Padding and background color for the node. */
|
|
1882
|
-
nodeStyle?: NodeStyle;
|
|
1883
|
-
/** Line height for text in the node. */
|
|
1884
|
-
lineHeight?: string | null;
|
|
1885
|
-
}
|
|
1886
|
-
interface TreeReference {
|
|
1887
|
-
/**
|
|
1888
|
-
* Namespace of the app that manages the tree.
|
|
1889
|
-
*
|
|
1890
|
-
* For example, `"@wix/stores"`, `"@bookings/bookingslist"`, `"@achievements/quizzes"`.
|
|
1891
|
-
*/
|
|
1892
|
-
appNamespace?: string;
|
|
1893
|
-
/** Tree key. You must pass this when a single app manages more than one tree. */
|
|
1894
|
-
treeKey?: string | null;
|
|
1895
|
-
}
|
|
1896
|
-
interface ExtendedFields {
|
|
1897
|
-
/**
|
|
1898
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
1899
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
1900
|
-
*
|
|
1901
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
1902
|
-
*
|
|
1903
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
1904
|
-
*/
|
|
1905
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
1906
|
-
}
|
|
1907
|
-
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
1908
|
-
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
1909
|
-
metaSiteId?: string;
|
|
1910
|
-
/** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
|
|
1911
|
-
siteId?: string;
|
|
1912
|
-
/** Invalidate by App */
|
|
1913
|
-
app?: App;
|
|
1914
|
-
/** Invalidate by page id */
|
|
1915
|
-
page?: Page;
|
|
1916
|
-
/** Invalidate by URI path */
|
|
1917
|
-
uri?: URI;
|
|
1918
|
-
/** Invalidate by file (for media files such as PDFs) */
|
|
1919
|
-
file?: File;
|
|
1920
|
-
/** tell us why you're invalidating the cache. You don't need to add your app name */
|
|
1921
|
-
reason?: string | null;
|
|
1922
|
-
/** Is local DS */
|
|
1923
|
-
localDc?: boolean;
|
|
1924
|
-
hardPurge?: boolean;
|
|
1925
|
-
}
|
|
1926
|
-
/** @oneof */
|
|
1927
|
-
interface InvalidateCacheGetByOneOf {
|
|
1928
|
-
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
1929
|
-
metaSiteId?: string;
|
|
1930
|
-
/** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
|
|
1931
|
-
siteId?: string;
|
|
1932
|
-
/** Invalidate by App */
|
|
1933
|
-
app?: App;
|
|
1934
|
-
/** Invalidate by page id */
|
|
1935
|
-
page?: Page;
|
|
1936
|
-
/** Invalidate by URI path */
|
|
1937
|
-
uri?: URI;
|
|
1938
|
-
/** Invalidate by file (for media files such as PDFs) */
|
|
1939
|
-
file?: File;
|
|
1940
|
-
}
|
|
1941
|
-
interface App {
|
|
1942
|
-
/** The AppDefId */
|
|
1943
|
-
appDefId?: string;
|
|
1944
|
-
/** The instance Id */
|
|
1945
|
-
instanceId?: string;
|
|
1946
|
-
}
|
|
1947
|
-
interface Page {
|
|
1948
|
-
/** the msid the page is on */
|
|
1949
|
-
metaSiteId?: string;
|
|
1950
|
-
/** Invalidate by Page ID */
|
|
1951
|
-
pageId?: string;
|
|
1952
|
-
}
|
|
1953
|
-
interface URI {
|
|
1954
|
-
/** the msid the URI is on */
|
|
1955
|
-
metaSiteId?: string;
|
|
1956
|
-
/** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
|
|
1957
|
-
uriPath?: string;
|
|
1958
|
-
}
|
|
1959
|
-
interface File {
|
|
1960
|
-
/** the msid the file is related to */
|
|
1961
|
-
metaSiteId?: string;
|
|
1962
|
-
/** Invalidate by filename (for media files such as PDFs) */
|
|
1963
|
-
fileName?: string;
|
|
1964
|
-
}
|
|
1965
|
-
interface CategoryMoved {
|
|
1966
|
-
/** Category ID. */
|
|
1967
|
-
categoryId?: string;
|
|
1968
|
-
/** Parent category details. */
|
|
1969
|
-
parentCategory?: ParentCategory;
|
|
1970
|
-
/** Category tree reference details. */
|
|
1971
|
-
treeReference?: TreeReference;
|
|
1972
|
-
}
|
|
1973
|
-
interface ItemAddedToCategory {
|
|
1974
|
-
/** Category ID. */
|
|
1975
|
-
categoryId?: string;
|
|
1976
|
-
/** Details about the added item. */
|
|
1977
|
-
addedItem?: ItemReference;
|
|
1978
|
-
/** Category tree reference details. */
|
|
1979
|
-
treeReference?: TreeReference;
|
|
1980
|
-
}
|
|
1981
|
-
interface ItemReference {
|
|
1982
|
-
/**
|
|
1983
|
-
* ID of the item within the catalog it belongs to.
|
|
1984
|
-
*
|
|
1985
|
-
* For example, `product.id` for Wix Stores or `event.id` for Wix Events.
|
|
1986
|
-
*/
|
|
1987
|
-
catalogItemId?: string;
|
|
1988
|
-
/**
|
|
1989
|
-
* ID of the app providing the catalog.
|
|
1990
|
-
*
|
|
1991
|
-
* You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
|
|
1992
|
-
*
|
|
1993
|
-
* For items from Wix catalogs, the following values always apply:
|
|
1994
|
-
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
1995
|
-
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
1996
|
-
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
1997
|
-
*/
|
|
1998
|
-
appId?: string;
|
|
1999
|
-
}
|
|
2000
|
-
interface ItemsAddedToCategory {
|
|
2001
|
-
/** Category ID. */
|
|
2002
|
-
categoryId?: string;
|
|
2003
|
-
/** List of added items. */
|
|
2004
|
-
addedItems?: ItemReference[];
|
|
2005
|
-
/** Category tree reference details. */
|
|
2006
|
-
treeReference?: TreeReference;
|
|
2007
|
-
}
|
|
2008
|
-
interface ItemRemovedFromCategory {
|
|
2009
|
-
/** Category ID. */
|
|
2010
|
-
categoryId?: string;
|
|
2011
|
-
/** Details about the removed item. */
|
|
2012
|
-
removedItem?: ItemReference;
|
|
2013
|
-
/** Category tree reference details. */
|
|
2014
|
-
treeReference?: TreeReference;
|
|
2015
|
-
}
|
|
2016
|
-
interface ItemsRemovedFromCategory {
|
|
2017
|
-
/** Category ID. */
|
|
2018
|
-
categoryId?: string;
|
|
2019
|
-
/** List of removed items. */
|
|
2020
|
-
removedItems?: ItemReference[];
|
|
2021
|
-
/** Category tree reference details. */
|
|
2022
|
-
treeReference?: TreeReference;
|
|
2023
|
-
}
|
|
2024
|
-
interface ItemsArrangedInCategory {
|
|
2025
|
-
/** Category ID. */
|
|
2026
|
-
categoryId?: string;
|
|
2027
|
-
/** Category tree reference details. */
|
|
2028
|
-
treeReference?: TreeReference;
|
|
2029
|
-
}
|
|
2030
|
-
interface CreateCategoryRequest {
|
|
2031
|
-
/** Category to create. */
|
|
2032
|
-
category: Category;
|
|
2033
|
-
/** Category tree reference details. */
|
|
2034
|
-
treeReference: TreeReference;
|
|
2035
|
-
/** Fields to include in the response. */
|
|
2036
|
-
fields?: SingleEntityOpsRequestedFields[];
|
|
2037
|
-
}
|
|
2038
|
-
declare enum SingleEntityOpsRequestedFields {
|
|
2039
|
-
/** Not implemented. */
|
|
2040
|
-
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
2041
|
-
BREADCRUMBS_INFO = "BREADCRUMBS_INFO",
|
|
2042
|
-
DESCRIPTION = "DESCRIPTION",
|
|
2043
|
-
RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION"
|
|
2044
|
-
}
|
|
2045
|
-
interface CreateCategoryResponse {
|
|
2046
|
-
/** Created category. */
|
|
2047
|
-
category?: Category;
|
|
2048
|
-
}
|
|
2049
|
-
interface GetCategoryRequest {
|
|
2050
|
-
/** Category ID. */
|
|
2051
|
-
categoryId: string;
|
|
2052
|
-
/** Category tree reference details. */
|
|
2053
|
-
treeReference: TreeReference;
|
|
2054
|
-
/** Fields to include in the response. */
|
|
2055
|
-
fields?: SingleEntityOpsRequestedFields[];
|
|
2056
|
-
}
|
|
2057
|
-
interface GetCategoryResponse {
|
|
2058
|
-
/** Category. */
|
|
2059
|
-
category?: Category;
|
|
2060
|
-
}
|
|
2061
|
-
interface UpdateCategoryRequest {
|
|
2062
|
-
/** Category to update. */
|
|
2063
|
-
category: Category;
|
|
2064
|
-
/** Category tree reference details. */
|
|
2065
|
-
treeReference: TreeReference;
|
|
2066
|
-
/** Fields to include in the response. */
|
|
2067
|
-
fields?: SingleEntityOpsRequestedFields[];
|
|
2068
|
-
}
|
|
2069
|
-
interface UpdateCategoryResponse {
|
|
2070
|
-
/** Updated category. */
|
|
2071
|
-
category?: Category;
|
|
2072
|
-
}
|
|
2073
|
-
interface DeleteCategoryRequest {
|
|
2074
|
-
/** Category ID. */
|
|
2075
|
-
categoryId: string;
|
|
2076
|
-
/** Category tree reference details. */
|
|
2077
|
-
treeReference: TreeReference;
|
|
2078
|
-
}
|
|
2079
|
-
interface DeleteCategoryResponse {
|
|
2080
|
-
}
|
|
2081
|
-
interface QueryCategoriesRequest {
|
|
2082
|
-
/** Query options. */
|
|
2083
|
-
query?: CursorQuery;
|
|
2084
|
-
/** Category tree reference details. */
|
|
2085
|
-
treeReference: TreeReference;
|
|
2086
|
-
/**
|
|
2087
|
-
* Whether to return non-visible categories.
|
|
2088
|
-
*
|
|
2089
|
-
* Default: `false` (only visible categories are returned)
|
|
2090
|
-
*/
|
|
2091
|
-
returnNonVisibleCategories?: boolean;
|
|
2092
|
-
/** Fields to include in the response. */
|
|
2093
|
-
fields?: RequestedFields[];
|
|
2094
|
-
}
|
|
2095
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
2096
|
-
/** 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`. */
|
|
2097
|
-
cursorPaging?: CursorPaging;
|
|
2098
|
-
/**
|
|
2099
|
-
* Filter object in the following format:
|
|
2100
|
-
* `"filter" : {
|
|
2101
|
-
* "fieldName1": "value1",
|
|
2102
|
-
* "fieldName2":{"$operator":"value2"}
|
|
2103
|
-
* }`
|
|
2104
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
2105
|
-
*/
|
|
2106
|
-
filter?: Record<string, any> | null;
|
|
2107
|
-
/**
|
|
2108
|
-
* Sort object in the following format:
|
|
2109
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
2110
|
-
*/
|
|
2111
|
-
sort?: Sorting[];
|
|
2112
|
-
}
|
|
2113
|
-
/** @oneof */
|
|
2114
|
-
interface CursorQueryPagingMethodOneOf {
|
|
2115
|
-
/** 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`. */
|
|
2116
|
-
cursorPaging?: CursorPaging;
|
|
2117
|
-
}
|
|
2118
|
-
interface Sorting {
|
|
2119
|
-
/** Name of the field to sort by. */
|
|
2120
|
-
fieldName?: string;
|
|
2121
|
-
/** Sort order. */
|
|
2122
|
-
order?: SortOrder;
|
|
2123
|
-
}
|
|
2124
|
-
declare enum SortOrder {
|
|
2125
|
-
/** Ascending order. */
|
|
2126
|
-
ASC = "ASC",
|
|
2127
|
-
/** Descending order. */
|
|
2128
|
-
DESC = "DESC"
|
|
2129
|
-
}
|
|
2130
|
-
interface CursorPaging {
|
|
2131
|
-
/** Maximum number of items to return in the results. */
|
|
2132
|
-
limit?: number | null;
|
|
2133
|
-
/**
|
|
2134
|
-
* Pointer to the next or previous page in the list of results.
|
|
2135
|
-
*
|
|
2136
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2137
|
-
* Not relevant for the first request.
|
|
2138
|
-
*/
|
|
2139
|
-
cursor?: string | null;
|
|
2140
|
-
}
|
|
2141
|
-
declare enum RequestedFields {
|
|
2142
|
-
/** Not implemented. */
|
|
2143
|
-
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
2144
|
-
BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
|
|
2145
|
-
}
|
|
2146
|
-
interface QueryCategoriesResponse {
|
|
2147
|
-
/** List of categories. */
|
|
2148
|
-
categories?: Category[];
|
|
2149
|
-
/** Paging metadata. */
|
|
2150
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
2151
|
-
}
|
|
2152
|
-
interface CursorPagingMetadata {
|
|
2153
|
-
/** Number of items returned in the response. */
|
|
2154
|
-
count?: number | null;
|
|
2155
|
-
/** Cursor strings that point to the next page, previous page, or both. */
|
|
2156
|
-
cursors?: Cursors;
|
|
2157
|
-
/**
|
|
2158
|
-
* Whether there are more pages to retrieve following the current page.
|
|
2159
|
-
*
|
|
2160
|
-
* + `true`: Another page of results can be retrieved.
|
|
2161
|
-
* + `false`: This is the last page.
|
|
2162
|
-
*/
|
|
2163
|
-
hasNext?: boolean | null;
|
|
2164
|
-
}
|
|
2165
|
-
interface Cursors {
|
|
2166
|
-
/** Cursor string pointing to the next page in the list of results. */
|
|
2167
|
-
next?: string | null;
|
|
2168
|
-
/** Cursor pointing to the previous page in the list of results. */
|
|
2169
|
-
prev?: string | null;
|
|
2170
|
-
}
|
|
2171
|
-
interface ListCompactCategoriesByIdsRequest {
|
|
2172
|
-
/** List of category ids. */
|
|
2173
|
-
categoryIds?: string[];
|
|
2174
|
-
/** A reference to the tree that contains the categories. */
|
|
2175
|
-
treeReference?: TreeReference;
|
|
2176
|
-
}
|
|
2177
|
-
interface ListCompactCategoriesByIdsResponse {
|
|
2178
|
-
/** Categories which satisfy the provided ids. */
|
|
2179
|
-
categories?: CompactCategory[];
|
|
2180
|
-
}
|
|
2181
|
-
interface CompactCategory {
|
|
2182
|
-
/** Category ID. */
|
|
2183
|
-
_id?: string | null;
|
|
2184
|
-
/** Category name. */
|
|
2185
|
-
name?: string | null;
|
|
2186
|
-
}
|
|
2187
|
-
interface SearchCategoriesRequest {
|
|
2188
|
-
/** Search options. */
|
|
2189
|
-
search?: CursorSearch;
|
|
2190
|
-
/**
|
|
2191
|
-
* Category tree reference details.
|
|
2192
|
-
* > **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.
|
|
2193
|
-
*/
|
|
2194
|
-
treeReference: TreeReference;
|
|
2195
|
-
/**
|
|
2196
|
-
* Whether to return the categories with `visible: false`.
|
|
2197
|
-
*
|
|
2198
|
-
* Default: `false` - only visible categories are returned in the response
|
|
2199
|
-
*/
|
|
2200
|
-
returnNonVisibleCategories?: boolean;
|
|
2201
|
-
/** Fields to include in the response. */
|
|
2202
|
-
fields?: RequestedFields[];
|
|
2203
|
-
}
|
|
2204
|
-
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
2205
|
-
/**
|
|
2206
|
-
* Cursor pointing to page of results.
|
|
2207
|
-
* When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
2208
|
-
*/
|
|
2209
|
-
cursorPaging?: CursorPaging;
|
|
2210
|
-
/** A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
|
|
2211
|
-
filter?: Record<string, any> | null;
|
|
2212
|
-
/** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
|
|
2213
|
-
sort?: Sorting[];
|
|
2214
|
-
/** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
|
|
2215
|
-
aggregations?: Aggregation[];
|
|
2216
|
-
/** Free text to match in searchable fields */
|
|
2217
|
-
search?: SearchDetails;
|
|
2218
|
-
/**
|
|
2219
|
-
* UTC offset or IANA time zone. Valid values are
|
|
2220
|
-
* ISO 8601 UTC offsets, such as +02:00 or -06:00,
|
|
2221
|
-
* and IANA time zone IDs, such as Europe/Rome
|
|
2222
|
-
*
|
|
2223
|
-
* Affects all filters and aggregations returned values.
|
|
2224
|
-
* You may override this behavior in a specific filter by providing
|
|
2225
|
-
* timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
|
|
2226
|
-
*/
|
|
2227
|
-
timeZone?: string | null;
|
|
2228
|
-
}
|
|
2229
|
-
/** @oneof */
|
|
2230
|
-
interface CursorSearchPagingMethodOneOf {
|
|
2231
|
-
/**
|
|
2232
|
-
* Cursor pointing to page of results.
|
|
2233
|
-
* When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
2234
|
-
*/
|
|
2235
|
-
cursorPaging?: CursorPaging;
|
|
2236
|
-
}
|
|
2237
|
-
interface Aggregation extends AggregationKindOneOf {
|
|
2238
|
-
/** Value aggregation */
|
|
2239
|
-
value?: ValueAggregation;
|
|
2240
|
-
/** Range aggregation */
|
|
2241
|
-
range?: RangeAggregation;
|
|
2242
|
-
/** Scalar aggregation */
|
|
2243
|
-
scalar?: ScalarAggregation;
|
|
2244
|
-
/** Date histogram aggregation */
|
|
2245
|
-
dateHistogram?: DateHistogramAggregation;
|
|
2246
|
-
/** Nested aggregation */
|
|
2247
|
-
nested?: NestedAggregation;
|
|
2248
|
-
/** User-defined name of aggregation, should be unique, will appear in aggregation results */
|
|
2249
|
-
name?: string | null;
|
|
2250
|
-
/** Type of aggregation, client must provide matching aggregation field below */
|
|
2251
|
-
type?: AggregationType;
|
|
2252
|
-
/** Field to aggregate by, use dot notation to specify json path */
|
|
2253
|
-
fieldPath?: string;
|
|
2254
|
-
}
|
|
2255
|
-
/** @oneof */
|
|
2256
|
-
interface AggregationKindOneOf {
|
|
2257
|
-
/** Value aggregation */
|
|
2258
|
-
value?: ValueAggregation;
|
|
2259
|
-
/** Range aggregation */
|
|
2260
|
-
range?: RangeAggregation;
|
|
2261
|
-
/** Scalar aggregation */
|
|
2262
|
-
scalar?: ScalarAggregation;
|
|
2263
|
-
/** Date histogram aggregation */
|
|
2264
|
-
dateHistogram?: DateHistogramAggregation;
|
|
2265
|
-
/** Nested aggregation */
|
|
2266
|
-
nested?: NestedAggregation;
|
|
2267
|
-
}
|
|
2268
|
-
interface RangeBucket {
|
|
2269
|
-
/** Inclusive lower bound of the range. Required if to is not given */
|
|
2270
|
-
from?: number | null;
|
|
2271
|
-
/** Exclusive upper bound of the range. Required if from is not given */
|
|
2272
|
-
to?: number | null;
|
|
2273
|
-
}
|
|
2274
|
-
declare enum SortType {
|
|
2275
|
-
/** Sort by number of matches. */
|
|
2276
|
-
COUNT = "COUNT",
|
|
2277
|
-
/** Sort alphabetically by field value. */
|
|
2278
|
-
VALUE = "VALUE"
|
|
2279
|
-
}
|
|
2280
|
-
declare enum SortDirection {
|
|
2281
|
-
/** Sort in descending order. */
|
|
2282
|
-
DESC = "DESC",
|
|
2283
|
-
/** Sort in ascending order. */
|
|
2284
|
-
ASC = "ASC"
|
|
2285
|
-
}
|
|
2286
|
-
declare enum MissingValues {
|
|
2287
|
-
/** Exclude missing values from the aggregation results. */
|
|
2288
|
-
EXCLUDE = "EXCLUDE",
|
|
2289
|
-
/** Included missing values in the aggregation results. */
|
|
2290
|
-
INCLUDE = "INCLUDE"
|
|
2291
|
-
}
|
|
2292
|
-
interface IncludeMissingValuesOptions {
|
|
2293
|
-
/** Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
|
|
2294
|
-
addToBucket?: string;
|
|
2295
|
-
}
|
|
2296
|
-
declare enum ScalarType {
|
|
2297
|
-
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
2298
|
-
/** Count of distinct values. */
|
|
2299
|
-
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
2300
|
-
/** Minimum value. */
|
|
2301
|
-
MIN = "MIN",
|
|
2302
|
-
/** Maximum value. */
|
|
2303
|
-
MAX = "MAX"
|
|
2304
|
-
}
|
|
2305
|
-
interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
2306
|
-
/** Options for including missing values */
|
|
2307
|
-
includeOptions?: IncludeMissingValuesOptions;
|
|
2308
|
-
/** Type of sort to perform. */
|
|
2309
|
-
sortType?: SortType;
|
|
2310
|
-
/** Direction to sort in. */
|
|
2311
|
-
sortDirection?: SortDirection;
|
|
2312
|
-
/** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
|
|
2313
|
-
limit?: number | null;
|
|
2314
|
-
/**
|
|
2315
|
-
* Whether missing values are included in the aggregation results.
|
|
2316
|
-
* Default: `EXCLUDE`
|
|
2317
|
-
*/
|
|
2318
|
-
missingValues?: MissingValues;
|
|
2319
|
-
}
|
|
2320
|
-
/** @oneof */
|
|
2321
|
-
interface ValueAggregationOptionsOneOf {
|
|
2322
|
-
/** Options for including missing values */
|
|
2323
|
-
includeOptions?: IncludeMissingValuesOptions;
|
|
2324
|
-
}
|
|
2325
|
-
declare enum NestedAggregationType {
|
|
2326
|
-
/** Unknown aggregation type. */
|
|
2327
|
-
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
2328
|
-
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
2329
|
-
VALUE = "VALUE",
|
|
2330
|
-
/** An aggregation, where user can define set of ranges - each representing a bucket. */
|
|
2331
|
-
RANGE = "RANGE",
|
|
2332
|
-
/** A single-value metric aggregation - such as min, max, sum, and avg. */
|
|
2333
|
-
SCALAR = "SCALAR",
|
|
2334
|
-
/** An aggregation, where result buckets are dynamically built - one per time interval such as hour, day, and week. */
|
|
2335
|
-
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
2336
|
-
}
|
|
2337
|
-
interface RangeAggregation {
|
|
2338
|
-
/** List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds */
|
|
2339
|
-
buckets?: RangeBucket[];
|
|
2340
|
-
}
|
|
2341
|
-
interface ScalarAggregation {
|
|
2342
|
-
/** Define the operator for the scalar aggregation */
|
|
2343
|
-
type?: ScalarType;
|
|
2344
|
-
}
|
|
2345
|
-
interface DateHistogramAggregation {
|
|
2346
|
-
/** Interval for date histogram aggregation */
|
|
2347
|
-
interval?: Interval;
|
|
2348
|
-
}
|
|
2349
|
-
declare enum Interval {
|
|
2350
|
-
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
2351
|
-
/** Yearly interval */
|
|
2352
|
-
YEAR = "YEAR",
|
|
2353
|
-
/** Monthly interval */
|
|
2354
|
-
MONTH = "MONTH",
|
|
2355
|
-
/** Weekly interval */
|
|
2356
|
-
WEEK = "WEEK",
|
|
2357
|
-
/** Daily interval */
|
|
2358
|
-
DAY = "DAY",
|
|
2359
|
-
/** Hourly interval */
|
|
2360
|
-
HOUR = "HOUR",
|
|
2361
|
-
/** Minute interval */
|
|
2362
|
-
MINUTE = "MINUTE",
|
|
2363
|
-
/** Second interval */
|
|
2364
|
-
SECOND = "SECOND"
|
|
2365
|
-
}
|
|
2366
|
-
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
2367
|
-
/** Value aggregation */
|
|
2368
|
-
value?: ValueAggregation;
|
|
2369
|
-
/** Range aggregation */
|
|
2370
|
-
range?: RangeAggregation;
|
|
2371
|
-
/** Scalar aggregation */
|
|
2372
|
-
scalar?: ScalarAggregation;
|
|
2373
|
-
/** Date histogram aggregation */
|
|
2374
|
-
dateHistogram?: DateHistogramAggregation;
|
|
2375
|
-
/** User-defined name of aggregation, should be unique, will appear in aggregation results */
|
|
2376
|
-
name?: string | null;
|
|
2377
|
-
/** Type of aggregation client must provide matching aggregation field below */
|
|
2378
|
-
type?: NestedAggregationType;
|
|
2379
|
-
/** Field to aggregate by, use dont notation to specify json path */
|
|
2380
|
-
fieldPath?: string;
|
|
2381
|
-
}
|
|
2382
|
-
/** @oneof */
|
|
2383
|
-
interface NestedAggregationItemKindOneOf {
|
|
2384
|
-
/** Value aggregation */
|
|
2385
|
-
value?: ValueAggregation;
|
|
2386
|
-
/** Range aggregation */
|
|
2387
|
-
range?: RangeAggregation;
|
|
2388
|
-
/** Scalar aggregation */
|
|
2389
|
-
scalar?: ScalarAggregation;
|
|
2390
|
-
/** Date histogram aggregation */
|
|
2391
|
-
dateHistogram?: DateHistogramAggregation;
|
|
2392
|
-
}
|
|
2393
|
-
declare enum AggregationType {
|
|
2394
|
-
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
2395
|
-
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
2396
|
-
VALUE = "VALUE",
|
|
2397
|
-
/** An aggregation, where user can define set of ranges - each representing a bucket. */
|
|
2398
|
-
RANGE = "RANGE",
|
|
2399
|
-
/** A single-value metric aggregation - such as min, max, sum, and avg. */
|
|
2400
|
-
SCALAR = "SCALAR",
|
|
2401
|
-
/** An aggregation, where result buckets are dynamically built - one per time interval such as hour, day, and week. */
|
|
2402
|
-
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
2403
|
-
/** Multi-level aggregation, where each next aggregation is nested within the previous one. */
|
|
2404
|
-
NESTED = "NESTED"
|
|
2405
|
-
}
|
|
2406
|
-
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
2407
|
-
interface NestedAggregation {
|
|
2408
|
-
/** Flattened list of aggregations, where each next aggregation is nested within previous one */
|
|
2409
|
-
nestedAggregations?: NestedAggregationItem[];
|
|
2410
|
-
}
|
|
2411
|
-
interface SearchDetails {
|
|
2412
|
-
/** Defines how separate search terms in `expression` are combined. */
|
|
2413
|
-
mode?: Mode;
|
|
2414
|
-
/** Search term or expression. */
|
|
2415
|
-
expression?: string | null;
|
|
2416
|
-
/**
|
|
2417
|
-
* Fields in which to search for the `expression`. Use dot notation to specify field path.
|
|
2418
|
-
*
|
|
2419
|
-
* When empty - all searchable fields are looked at.
|
|
2420
|
-
*/
|
|
2421
|
-
fields?: string[];
|
|
2422
|
-
/** Whether to use fuzzy search - allowing typos and other minor errors in the search. */
|
|
2423
|
-
fuzzy?: boolean;
|
|
2424
|
-
}
|
|
2425
|
-
declare enum Mode {
|
|
2426
|
-
/** Any of the search terms must be present. */
|
|
2427
|
-
OR = "OR",
|
|
2428
|
-
/** All search terms must be present. */
|
|
2429
|
-
AND = "AND"
|
|
2430
|
-
}
|
|
2431
|
-
interface SearchCategoriesResponse {
|
|
2432
|
-
/** List of categories. */
|
|
2433
|
-
categories?: Category[];
|
|
2434
|
-
/** Paging metadata. */
|
|
2435
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
2436
|
-
/** Aggregation data. */
|
|
2437
|
-
aggregationData?: AggregationData;
|
|
2438
|
-
}
|
|
2439
|
-
interface AggregationData {
|
|
2440
|
-
/** key = aggregation name (as derived from search request) */
|
|
2441
|
-
results?: AggregationResults[];
|
|
2442
|
-
}
|
|
2443
|
-
interface ValueAggregationResult {
|
|
2444
|
-
/** Value of the field */
|
|
2445
|
-
value?: string;
|
|
2446
|
-
/** Count of entities with this value */
|
|
2447
|
-
count?: number;
|
|
2448
|
-
}
|
|
2449
|
-
interface RangeAggregationResult {
|
|
2450
|
-
/** Inclusive lower bound of the range */
|
|
2451
|
-
from?: number | null;
|
|
2452
|
-
/** Exclusive upper bound of the range */
|
|
2453
|
-
to?: number | null;
|
|
2454
|
-
/** Count of entities in this range */
|
|
2455
|
-
count?: number;
|
|
2456
|
-
}
|
|
2457
|
-
interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
|
|
2458
|
-
/** Value aggregation results */
|
|
2459
|
-
values?: ValueResults;
|
|
2460
|
-
/** Range aggregation results */
|
|
2461
|
-
ranges?: RangeResults;
|
|
2462
|
-
/** Scalar aggregation results */
|
|
2463
|
-
scalar?: AggregationResultsScalarResult;
|
|
2464
|
-
/** User-defined name of aggregation, matches the one provided in request */
|
|
2465
|
-
name?: string;
|
|
2466
|
-
/** Type of aggregation that matches result */
|
|
2467
|
-
type?: AggregationType;
|
|
2468
|
-
/** Field to aggregate by, matches the one provided in request */
|
|
2469
|
-
fieldPath?: string;
|
|
2470
|
-
}
|
|
2471
|
-
/** @oneof */
|
|
2472
|
-
interface NestedAggregationResultsResultOneOf {
|
|
2473
|
-
/** Value aggregation results */
|
|
2474
|
-
values?: ValueResults;
|
|
2475
|
-
/** Range aggregation results */
|
|
2476
|
-
ranges?: RangeResults;
|
|
2477
|
-
/** Scalar aggregation results */
|
|
2478
|
-
scalar?: AggregationResultsScalarResult;
|
|
2479
|
-
}
|
|
2480
|
-
interface ValueResults {
|
|
2481
|
-
/** List of value aggregations */
|
|
2482
|
-
results?: ValueAggregationResult[];
|
|
2483
|
-
}
|
|
2484
|
-
interface RangeResults {
|
|
2485
|
-
/** List of ranges returned in same order as requested */
|
|
2486
|
-
results?: RangeAggregationResult[];
|
|
2487
|
-
}
|
|
2488
|
-
interface AggregationResultsScalarResult {
|
|
2489
|
-
/** Type of scalar aggregation */
|
|
2490
|
-
type?: ScalarType;
|
|
2491
|
-
/** Value of the scalar aggregation */
|
|
2492
|
-
value?: number;
|
|
2493
|
-
}
|
|
2494
|
-
interface NestedValueAggregationResult {
|
|
2495
|
-
/** Value of the field */
|
|
2496
|
-
value?: string;
|
|
2497
|
-
/** Nested aggregations */
|
|
2498
|
-
nestedResults?: NestedAggregationResults;
|
|
2499
|
-
}
|
|
2500
|
-
interface ValueResult {
|
|
2501
|
-
/** Value of the field */
|
|
2502
|
-
value?: string;
|
|
2503
|
-
/** Count of entities with this value */
|
|
2504
|
-
count?: number | null;
|
|
2505
|
-
}
|
|
2506
|
-
interface RangeResult {
|
|
2507
|
-
/** Inclusive lower bound of the range */
|
|
2508
|
-
from?: number | null;
|
|
2509
|
-
/** Exclusive upper bound of the range */
|
|
2510
|
-
to?: number | null;
|
|
2511
|
-
/** Count of entities in this range */
|
|
2512
|
-
count?: number | null;
|
|
2513
|
-
}
|
|
2514
|
-
interface ScalarResult {
|
|
2515
|
-
/** Value of the scalar aggregation */
|
|
2516
|
-
value?: number;
|
|
2517
|
-
}
|
|
2518
|
-
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
2519
|
-
/** Value aggregation result */
|
|
2520
|
-
value?: ValueResult;
|
|
2521
|
-
/** Range aggregation result */
|
|
2522
|
-
range?: RangeResult;
|
|
2523
|
-
/** Scalar aggregation result */
|
|
2524
|
-
scalar?: ScalarResult;
|
|
2525
|
-
/** Date histogram aggregation result */
|
|
2526
|
-
dateHistogram?: ValueResult;
|
|
2527
|
-
}
|
|
2528
|
-
/** @oneof */
|
|
2529
|
-
interface NestedResultValueResultOneOf {
|
|
2530
|
-
/** Value aggregation result */
|
|
2531
|
-
value?: ValueResult;
|
|
2532
|
-
/** Range aggregation result */
|
|
2533
|
-
range?: RangeResult;
|
|
2534
|
-
/** Scalar aggregation result */
|
|
2535
|
-
scalar?: ScalarResult;
|
|
2536
|
-
/** Date histogram aggregation result */
|
|
2537
|
-
dateHistogram?: ValueResult;
|
|
2538
|
-
}
|
|
2539
|
-
interface Results {
|
|
2540
|
-
/** List of nested aggregations */
|
|
2541
|
-
results?: Record<string, NestedResultValue>;
|
|
2542
|
-
}
|
|
2543
|
-
interface DateHistogramResult {
|
|
2544
|
-
/** Date in ISO 8601 format */
|
|
2545
|
-
value?: string;
|
|
2546
|
-
/** Count of documents in the bucket */
|
|
2547
|
-
count?: number;
|
|
2548
|
-
}
|
|
2549
|
-
interface GroupByValueResults {
|
|
2550
|
-
/** List of value aggregations */
|
|
2551
|
-
results?: NestedValueAggregationResult[];
|
|
2552
|
-
}
|
|
2553
|
-
interface DateHistogramResults {
|
|
2554
|
-
/** List of date histogram aggregations */
|
|
2555
|
-
results?: DateHistogramResult[];
|
|
2556
|
-
}
|
|
2557
|
-
/**
|
|
2558
|
-
* Results of `NESTED` aggregation type in a flattened form
|
|
2559
|
-
* aggregations in resulting array are keyed by requested aggregation `name`.
|
|
2560
|
-
*/
|
|
2561
|
-
interface NestedResults {
|
|
2562
|
-
/** List of nested aggregations */
|
|
2563
|
-
results?: Results[];
|
|
2564
|
-
}
|
|
2565
|
-
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
2566
|
-
/** Value aggregation results */
|
|
2567
|
-
values?: ValueResults;
|
|
2568
|
-
/** Range aggregation results */
|
|
2569
|
-
ranges?: RangeResults;
|
|
2570
|
-
/** Scalar aggregation results */
|
|
2571
|
-
scalar?: AggregationResultsScalarResult;
|
|
2572
|
-
/** Group by value aggregation results */
|
|
2573
|
-
groupedByValue?: GroupByValueResults;
|
|
2574
|
-
/** Date histogram aggregation results */
|
|
2575
|
-
dateHistogram?: DateHistogramResults;
|
|
2576
|
-
/** Nested aggregation results */
|
|
2577
|
-
nested?: NestedResults;
|
|
2578
|
-
/** User-defined name of aggregation as derived from search request */
|
|
2579
|
-
name?: string;
|
|
2580
|
-
/** Type of aggregation that must match provided kind as derived from search request */
|
|
2581
|
-
type?: AggregationType;
|
|
2582
|
-
/** Field to aggregate by as derived from search request */
|
|
2583
|
-
fieldPath?: string;
|
|
2584
|
-
}
|
|
2585
|
-
/** @oneof */
|
|
2586
|
-
interface AggregationResultsResultOneOf {
|
|
2587
|
-
/** Value aggregation results */
|
|
2588
|
-
values?: ValueResults;
|
|
2589
|
-
/** Range aggregation results */
|
|
2590
|
-
ranges?: RangeResults;
|
|
2591
|
-
/** Scalar aggregation results */
|
|
2592
|
-
scalar?: AggregationResultsScalarResult;
|
|
2593
|
-
/** Group by value aggregation results */
|
|
2594
|
-
groupedByValue?: GroupByValueResults;
|
|
2595
|
-
/** Date histogram aggregation results */
|
|
2596
|
-
dateHistogram?: DateHistogramResults;
|
|
2597
|
-
/** Nested aggregation results */
|
|
2598
|
-
nested?: NestedResults;
|
|
2599
|
-
}
|
|
2600
|
-
interface DeprecatedSearchCategoriesWithOffsetRequest {
|
|
2601
|
-
/** WQL query expression. */
|
|
2602
|
-
search?: OffsetSearch;
|
|
2603
|
-
/** Category tree reference details. */
|
|
2604
|
-
treeReference?: TreeReference;
|
|
2605
|
-
/** Whether to return categories with `visible:false`. Default: false so only visible categories will be in response. */
|
|
2606
|
-
returnNonVisibleCategories?: boolean;
|
|
2607
|
-
/** Fields to include in the response. */
|
|
2608
|
-
fields?: RequestedFields[];
|
|
2609
|
-
}
|
|
2610
|
-
interface OffsetSearch extends OffsetSearchPagingMethodOneOf {
|
|
2611
|
-
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
2612
|
-
paging?: Paging;
|
|
2613
|
-
/** A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
|
|
2614
|
-
filter?: Record<string, any> | null;
|
|
2615
|
-
/** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
|
|
2616
|
-
sort?: Sorting[];
|
|
2617
|
-
/** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
|
|
2618
|
-
aggregations?: Aggregation[];
|
|
2619
|
-
/** Free text to match in searchable fields */
|
|
2620
|
-
search?: SearchDetails;
|
|
2621
|
-
/**
|
|
2622
|
-
* UTC offset or IANA time zone. Valid values are
|
|
2623
|
-
* ISO 8601 UTC offsets, such as +02:00 or -06:00,
|
|
2624
|
-
* and IANA time zone IDs, such as Europe/Rome
|
|
2625
|
-
*
|
|
2626
|
-
* Affects all filters and aggregations returned values.
|
|
2627
|
-
* You may override this behavior in a specific filter by providing
|
|
2628
|
-
* timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
|
|
2629
|
-
*/
|
|
2630
|
-
timeZone?: string | null;
|
|
2631
|
-
}
|
|
2632
|
-
/** @oneof */
|
|
2633
|
-
interface OffsetSearchPagingMethodOneOf {
|
|
2634
|
-
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
2635
|
-
paging?: Paging;
|
|
2636
|
-
}
|
|
2637
|
-
interface Paging {
|
|
2638
|
-
/** Number of items to load. */
|
|
2639
|
-
limit?: number | null;
|
|
2640
|
-
/** Number of items to skip in the current sort order. */
|
|
2641
|
-
offset?: number | null;
|
|
2642
|
-
}
|
|
2643
|
-
interface DeprecatedSearchCategoriesWithOffsetResponse {
|
|
2644
|
-
/** Categories which satisfy the provided query. */
|
|
2645
|
-
categories?: Category[];
|
|
2646
|
-
/** Paging metadata. */
|
|
2647
|
-
pagingMetadata?: PagingMetadata;
|
|
2648
|
-
/** Aggregation data. */
|
|
2649
|
-
aggregationData?: AggregationData;
|
|
2650
|
-
}
|
|
2651
|
-
interface PagingMetadata {
|
|
2652
|
-
/** Number of items returned in the response. */
|
|
2653
|
-
count?: number | null;
|
|
2654
|
-
/** Offset that was requested. */
|
|
2655
|
-
offset?: number | null;
|
|
2656
|
-
/** Total number of items that match the query. */
|
|
2657
|
-
total?: number | null;
|
|
2658
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
2659
|
-
tooManyToCount?: boolean | null;
|
|
2660
|
-
}
|
|
2661
|
-
interface CountCategoriesRequest {
|
|
2662
|
-
/**
|
|
2663
|
-
* Filter object.
|
|
2664
|
-
*
|
|
2665
|
-
* Learn more about the [filter object structure](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
2666
|
-
*/
|
|
2667
|
-
filter?: Record<string, any> | null;
|
|
2668
|
-
/** Search options. */
|
|
2669
|
-
search?: SearchDetails;
|
|
2670
|
-
/** Category tree reference details. */
|
|
2671
|
-
treeReference: TreeReference;
|
|
2672
|
-
/**
|
|
2673
|
-
* Whether to return categories with `visible: false` (hidden categories).
|
|
2674
|
-
*
|
|
2675
|
-
* Default: `false` - only visible categories are returned in the response
|
|
2676
|
-
*/
|
|
2677
|
-
returnNonVisibleCategories?: boolean;
|
|
2678
|
-
}
|
|
2679
|
-
interface CountCategoriesResponse {
|
|
2680
|
-
/** Total count of categories which satisfy the given filter and/or search. */
|
|
2681
|
-
count?: number;
|
|
2682
|
-
}
|
|
2683
|
-
interface MoveCategoryRequest {
|
|
2684
|
-
/** ID of the category to move. */
|
|
2685
|
-
categoryId: string;
|
|
2686
|
-
/** Category tree reference details. */
|
|
2687
|
-
treeReference: TreeReference;
|
|
2688
|
-
/**
|
|
2689
|
-
* Parent category ID.
|
|
2690
|
-
*
|
|
2691
|
-
* Default: root category ID
|
|
2692
|
-
*/
|
|
2693
|
-
parentCategoryId?: string | null;
|
|
2694
|
-
/**
|
|
2695
|
-
* Where to place the subcategory.
|
|
2696
|
-
*
|
|
2697
|
-
* + `FIRST`: Position the category as the first subcategory.
|
|
2698
|
-
* + `LAST`: Position the category as the last subcategory.
|
|
2699
|
-
* + `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`.
|
|
2700
|
-
*/
|
|
2701
|
-
position: Position;
|
|
2702
|
-
/** Required when passing `position: AFTER`. */
|
|
2703
|
-
moveAfterCategoryId?: string | null;
|
|
2704
|
-
}
|
|
2705
|
-
declare enum Position {
|
|
2706
|
-
UNKNOWN_POSITION = "UNKNOWN_POSITION",
|
|
2707
|
-
FIRST = "FIRST",
|
|
2708
|
-
LAST = "LAST",
|
|
2709
|
-
AFTER = "AFTER"
|
|
2710
|
-
}
|
|
2711
|
-
interface MoveCategoryResponse {
|
|
2712
|
-
/** Parent category ID. */
|
|
2713
|
-
parentCategoryId?: string | null;
|
|
2714
|
-
/** List of category IDs in the new order of arrangement. */
|
|
2715
|
-
categoriesAfterMove?: string[];
|
|
2716
|
-
}
|
|
2717
|
-
interface BulkCreateCategoriesRequest {
|
|
2718
|
-
/** List of categories to be created. */
|
|
2719
|
-
categories?: Category[];
|
|
2720
|
-
/** Category tree reference details. */
|
|
2721
|
-
treeReference?: TreeReference;
|
|
2722
|
-
/**
|
|
2723
|
-
* Whether to return the category entity in the response.
|
|
2724
|
-
*
|
|
2725
|
-
* Default: `false`
|
|
2726
|
-
*/
|
|
2727
|
-
returnEntity?: boolean;
|
|
2728
|
-
/** Fields to include in the response. */
|
|
2729
|
-
fields?: RequestedFields[];
|
|
2730
|
-
}
|
|
2731
|
-
interface BulkCreateCategoriesResponse {
|
|
2732
|
-
/** Categories created by bulk action. */
|
|
2733
|
-
results?: BulkCategoriesResult[];
|
|
2734
|
-
/** Bulk action metadata. */
|
|
2735
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2736
|
-
}
|
|
2737
|
-
interface BulkCategoriesResult {
|
|
2738
|
-
/** Bulk action metadata for category. */
|
|
2739
|
-
itemMetadata?: ItemMetadata;
|
|
2740
|
-
/**
|
|
2741
|
-
* Full category entity.
|
|
2742
|
-
*
|
|
2743
|
-
* Returned only if `returnEntity: true` is passed in the request.
|
|
2744
|
-
*/
|
|
2745
|
-
category?: Category;
|
|
2746
|
-
}
|
|
2747
|
-
interface ItemMetadata {
|
|
2748
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2749
|
-
_id?: string | null;
|
|
2750
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2751
|
-
originalIndex?: number;
|
|
2752
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2753
|
-
success?: boolean;
|
|
2754
|
-
/** Details about the error in case of failure. */
|
|
2755
|
-
error?: ApplicationError;
|
|
2756
|
-
}
|
|
2757
|
-
interface ApplicationError {
|
|
2758
|
-
/** Error code. */
|
|
2759
|
-
code?: string;
|
|
2760
|
-
/** Description of the error. */
|
|
2761
|
-
description?: string;
|
|
2762
|
-
/** Data related to the error. */
|
|
2763
|
-
data?: Record<string, any> | null;
|
|
2764
|
-
}
|
|
2765
|
-
interface BulkActionMetadata {
|
|
2766
|
-
/** Number of items that were successfully processed. */
|
|
2767
|
-
totalSuccesses?: number;
|
|
2768
|
-
/** Number of items that couldn't be processed. */
|
|
2769
|
-
totalFailures?: number;
|
|
2770
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2771
|
-
undetailedFailures?: number;
|
|
2772
|
-
}
|
|
2773
|
-
interface BulkUpdateCategoriesRequest {
|
|
2774
|
-
/** List of categories to update. */
|
|
2775
|
-
categories: MaskedCategory[];
|
|
2776
|
-
/** Category tree reference details. */
|
|
2777
|
-
treeReference: TreeReference;
|
|
2778
|
-
/**
|
|
2779
|
-
* Whether to return the full category entity in the response.
|
|
2780
|
-
*
|
|
2781
|
-
* Default: `false`
|
|
2782
|
-
*/
|
|
2783
|
-
returnEntity?: boolean;
|
|
2784
|
-
/** Fields to include in the response. */
|
|
2785
|
-
fields?: RequestedFields[];
|
|
2786
|
-
}
|
|
2787
|
-
interface MaskedCategory {
|
|
2788
|
-
/** Category to update. */
|
|
2789
|
-
category?: Category;
|
|
2790
|
-
}
|
|
2791
|
-
interface BulkUpdateCategoriesResponse {
|
|
2792
|
-
/** Categories updated by bulk action. */
|
|
2793
|
-
results?: BulkCategoriesResult[];
|
|
2794
|
-
/** Bulk action metadata. */
|
|
2795
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2796
|
-
}
|
|
2797
|
-
interface UpdateCategoryVisibilityRequest {
|
|
2798
|
-
/** Category ID. */
|
|
2799
|
-
categoryId: string;
|
|
2800
|
-
/**
|
|
2801
|
-
* Whether the category is visible to site visitors in dynamic pages.
|
|
2802
|
-
*
|
|
2803
|
-
* + If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
|
|
2804
|
-
* + Passing `true` will fail if the visibility of any parent categories is `false`.
|
|
2805
|
-
*/
|
|
2806
|
-
visible: boolean;
|
|
2807
|
-
/** Category tree reference details. */
|
|
2808
|
-
treeReference: TreeReference;
|
|
2809
|
-
/**
|
|
2810
|
-
* Latest revision of the category.
|
|
2811
|
-
* To prevent conflicting changes, the current revision must be passed on update.
|
|
2812
|
-
*/
|
|
2813
|
-
revision: string | null;
|
|
2814
|
-
/** Fields to include in the response. */
|
|
2815
|
-
fields?: SingleEntityOpsRequestedFields[];
|
|
2816
|
-
}
|
|
2817
|
-
interface UpdateCategoryVisibilityResponse {
|
|
2818
|
-
/** Updated category. */
|
|
2819
|
-
category?: Category;
|
|
2820
|
-
}
|
|
2821
|
-
interface BulkShowCategoriesRequest {
|
|
2822
|
-
/** IDs of the categories to update. */
|
|
2823
|
-
categoryIds: string[];
|
|
2824
|
-
/** Category tree reference details. */
|
|
2825
|
-
treeReference: TreeReference;
|
|
2826
|
-
/**
|
|
2827
|
-
* Whether to return the category entity in the response.
|
|
2828
|
-
*
|
|
2829
|
-
* Default: `false`
|
|
2830
|
-
*/
|
|
2831
|
-
returnEntity?: boolean;
|
|
2832
|
-
/** Fields to include in the response. */
|
|
2833
|
-
fields?: RequestedFields[];
|
|
2834
|
-
}
|
|
2835
|
-
interface BulkShowCategoriesResponse {
|
|
2836
|
-
/** Categories updated by bulk action. */
|
|
2837
|
-
results?: BulkCategoriesResult[];
|
|
2838
|
-
/** Bulk action metadata. */
|
|
2839
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2840
|
-
}
|
|
2841
|
-
interface BulkUpdateCategoryVisibilityByFilterRequest {
|
|
2842
|
-
/**
|
|
2843
|
-
* Filter object in the following format:
|
|
2844
|
-
* `"filter" : {
|
|
2845
|
-
* "fieldName1": "value1",
|
|
2846
|
-
* "fieldName2":{"$operator":"value2"}
|
|
2847
|
-
* }`
|
|
2848
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
2849
|
-
*/
|
|
2850
|
-
filter?: Record<string, any> | null;
|
|
2851
|
-
/** Category tree reference details. */
|
|
2852
|
-
treeReference?: TreeReference;
|
|
2853
|
-
/** value to set `visible` to. This value will be set for all categories that match the filter */
|
|
2854
|
-
visible?: boolean;
|
|
2855
|
-
}
|
|
2856
|
-
interface BulkUpdateCategoryVisibilityByFilterResponse {
|
|
2857
|
-
/**
|
|
2858
|
-
* Job ID.
|
|
2859
|
-
*
|
|
2860
|
-
* Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
|
|
2861
|
-
*/
|
|
2862
|
-
jobId?: string;
|
|
2863
|
-
}
|
|
2864
|
-
interface BulkDeleteCategoriesRequest {
|
|
2865
|
-
/** IDs of categories to be deleted. */
|
|
2866
|
-
categoryIds?: string[];
|
|
2867
|
-
}
|
|
2868
|
-
interface BulkDeleteCategoriesResponse {
|
|
2869
|
-
/** Categories deleted by bulk action. */
|
|
2870
|
-
results?: BulkDeleteCategoriesResponseBulkCategoriesResult[];
|
|
2871
|
-
/** Bulk action metadata. */
|
|
2872
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2873
|
-
}
|
|
2874
|
-
interface BulkDeleteCategoriesResponseBulkCategoriesResult {
|
|
2875
|
-
/** Information about successful action or error for failure. */
|
|
2876
|
-
itemMetadata?: ItemMetadata;
|
|
2877
|
-
}
|
|
2878
|
-
interface BulkDeleteCategoriesByFilterRequest {
|
|
2879
|
-
/**
|
|
2880
|
-
* Filter object in the following format:
|
|
2881
|
-
* `"filter" : {
|
|
2882
|
-
* "fieldName1": "value1",
|
|
2883
|
-
* "fieldName2":{"$operator":"value2"}
|
|
2884
|
-
* }`
|
|
2885
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
2886
|
-
*/
|
|
2887
|
-
filter?: Record<string, any> | null;
|
|
2888
|
-
/** Category tree reference details. */
|
|
2889
|
-
treeReference?: TreeReference;
|
|
2890
|
-
}
|
|
2891
|
-
interface BulkDeleteCategoriesByFilterResponse {
|
|
2892
|
-
/**
|
|
2893
|
-
* Job ID.
|
|
2894
|
-
*
|
|
2895
|
-
* Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
|
|
2896
|
-
*/
|
|
2897
|
-
jobId?: string;
|
|
2898
|
-
}
|
|
2899
|
-
interface BulkAddItemsToCategoryRequest {
|
|
2900
|
-
/** Category ID. */
|
|
2901
|
-
categoryId: string;
|
|
2902
|
-
/** List of items to add. */
|
|
2903
|
-
items: ItemReference[];
|
|
2904
|
-
/** Category tree reference details. */
|
|
2905
|
-
treeReference: TreeReference;
|
|
2906
|
-
}
|
|
2907
|
-
interface BulkAddItemsToCategoryResponse {
|
|
2908
|
-
/** List of items added to a category by bulk action. */
|
|
2909
|
-
results?: BulkItemsToCategoryResult[];
|
|
2910
|
-
/** Bulk action metadata. */
|
|
2911
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2912
|
-
}
|
|
2913
|
-
interface BulkItemsToCategoryResult {
|
|
2914
|
-
/** Bulk action metadata for item reference. */
|
|
2915
|
-
itemMetadata?: ItemReferenceMetadata;
|
|
2916
|
-
}
|
|
2917
|
-
interface ItemReferenceMetadata {
|
|
2918
|
-
/** Catalog and item reference info. */
|
|
2919
|
-
item?: ItemReference;
|
|
2920
|
-
/** Original index of the item within the request array. Allows for correlation between request and response items. */
|
|
2921
|
-
originalIndex?: number;
|
|
2922
|
-
/**
|
|
2923
|
-
* Whether the action was successful.
|
|
2924
|
-
* When `false`, the `error` field is populated.
|
|
2925
|
-
*/
|
|
2926
|
-
success?: boolean;
|
|
2927
|
-
/** Error details in the case of an unsuccessful action. */
|
|
2928
|
-
error?: ApplicationError;
|
|
2929
|
-
}
|
|
2930
|
-
interface BulkAddItemToCategoriesRequest {
|
|
2931
|
-
/** Item to add. */
|
|
2932
|
-
item: ItemReference;
|
|
2933
|
-
/** IDs of categories to which to add the item. */
|
|
2934
|
-
categoryIds: string[];
|
|
2935
|
-
/** Category tree reference details. */
|
|
2936
|
-
treeReference: TreeReference;
|
|
2937
|
-
}
|
|
2938
|
-
interface BulkAddItemToCategoriesResponse {
|
|
2939
|
-
/** Items added by bulk action. */
|
|
2940
|
-
results?: BulkItemToCategoriesResult[];
|
|
2941
|
-
/** Bulk action metadata. */
|
|
2942
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2943
|
-
}
|
|
2944
|
-
interface BulkItemToCategoriesResult {
|
|
2945
|
-
/** Bulk action metadata for category. */
|
|
2946
|
-
itemMetadata?: ItemMetadata;
|
|
2947
|
-
}
|
|
2948
|
-
interface BulkRemoveItemsFromCategoryRequest {
|
|
2949
|
-
/** Category ID. */
|
|
2950
|
-
categoryId: string;
|
|
2951
|
-
/** List of items to remove. */
|
|
2952
|
-
items: ItemReference[];
|
|
2953
|
-
/** Category tree reference details. */
|
|
2954
|
-
treeReference: TreeReference;
|
|
2955
|
-
}
|
|
2956
|
-
interface BulkRemoveItemsFromCategoryResponse {
|
|
2957
|
-
/** Items removed by bulk action. */
|
|
2958
|
-
results?: BulkItemsToCategoryResult[];
|
|
2959
|
-
/** Bulk action metadata. */
|
|
2960
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2961
|
-
}
|
|
2962
|
-
interface BulkRemoveItemFromCategoriesRequest {
|
|
2963
|
-
/** Item to remove. */
|
|
2964
|
-
item: ItemReference;
|
|
2965
|
-
/** IDs of categories from which to remove the item. */
|
|
2966
|
-
categoryIds: string[];
|
|
2967
|
-
/** Category tree reference details. */
|
|
2968
|
-
treeReference: TreeReference;
|
|
2969
|
-
}
|
|
2970
|
-
interface BulkRemoveItemFromCategoriesResponse {
|
|
2971
|
-
/** Items removed by bulk action. */
|
|
2972
|
-
results?: BulkItemToCategoriesResult[];
|
|
2973
|
-
/** Bulk action metadata. */
|
|
2974
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2975
|
-
}
|
|
2976
|
-
interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMethodOneOf {
|
|
2977
|
-
/**
|
|
2978
|
-
* Cursor paging options.
|
|
2979
|
-
*
|
|
2980
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
2981
|
-
*/
|
|
2982
|
-
cursorPaging?: CursorPaging;
|
|
2983
|
-
/** Category ID. */
|
|
2984
|
-
categoryId: string;
|
|
2985
|
-
/** Category tree reference details. */
|
|
2986
|
-
treeReference: TreeReference;
|
|
2987
|
-
/**
|
|
2988
|
-
* Whether to use category arrangement for sorting items.
|
|
2989
|
-
*
|
|
2990
|
-
* Default: `false`
|
|
2991
|
-
*/
|
|
2992
|
-
useCategoryArrangement?: boolean;
|
|
2993
|
-
/**
|
|
2994
|
-
* Whether to include items from subcategories.
|
|
2995
|
-
*
|
|
2996
|
-
* Default: `false` (only direct items of the category will be returned)
|
|
2997
|
-
*/
|
|
2998
|
-
includeItemsFromSubcategories?: boolean;
|
|
2999
|
-
}
|
|
3000
|
-
/** @oneof */
|
|
3001
|
-
interface ListItemsInCategoryRequestPagingMethodOneOf {
|
|
3002
|
-
/**
|
|
3003
|
-
* Cursor paging options.
|
|
3004
|
-
*
|
|
3005
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
3006
|
-
*/
|
|
3007
|
-
cursorPaging?: CursorPaging;
|
|
3008
|
-
}
|
|
3009
|
-
interface ListItemsInCategoryResponse {
|
|
3010
|
-
/** List of items in the category. */
|
|
3011
|
-
items?: ItemReference[];
|
|
3012
|
-
/** Paging metadata. */
|
|
3013
|
-
pagingMetadata?: PagingMetadataV2;
|
|
3014
|
-
}
|
|
3015
|
-
interface PagingMetadataV2 {
|
|
3016
|
-
/** Number of items returned in the response. */
|
|
3017
|
-
count?: number | null;
|
|
3018
|
-
/** Offset that was requested. */
|
|
3019
|
-
offset?: number | null;
|
|
3020
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
3021
|
-
total?: number | null;
|
|
3022
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
3023
|
-
cursors?: Cursors;
|
|
3024
|
-
}
|
|
3025
|
-
interface ListCategoriesForItemRequest {
|
|
3026
|
-
/** Item reference info. */
|
|
3027
|
-
item: ItemReference;
|
|
3028
|
-
/** Category tree reference details. */
|
|
3029
|
-
treeReference: TreeReference;
|
|
3030
|
-
}
|
|
3031
|
-
interface ListCategoriesForItemResponse {
|
|
3032
|
-
/** List of IDs of categories that directly contain this item. */
|
|
3033
|
-
directCategoryIds?: string[];
|
|
3034
|
-
/** List of IDs of categories that directly contain this item, and their parent category IDs. */
|
|
3035
|
-
allCategoryIds?: string[];
|
|
3036
|
-
}
|
|
3037
|
-
interface ListTreesRequest {
|
|
3038
|
-
}
|
|
3039
|
-
interface ListTreesResponse {
|
|
3040
|
-
/** List of trees. */
|
|
3041
|
-
trees?: TreeReference[];
|
|
3042
|
-
}
|
|
3043
|
-
interface MoveItemInCategoryRequest {
|
|
3044
|
-
/** Category ID. */
|
|
3045
|
-
categoryId?: string;
|
|
3046
|
-
/** Category tree reference details. */
|
|
3047
|
-
treeReference?: TreeReference;
|
|
3048
|
-
/** Item to move. */
|
|
3049
|
-
item?: ItemReference;
|
|
3050
|
-
/**
|
|
3051
|
-
* Where to move item.
|
|
3052
|
-
* `FIRST` - make `item` first item with manual arrangement. If before this operation category already has 100 manually arranged items, the 100th item will be removed from list of items with manual arrangement.
|
|
3053
|
-
* `LAST` - make `item` last item with manual arrangement. If before this operation category already has 100 manually arranged items, moving item will be not last but 100th.
|
|
3054
|
-
* `BEFORE` - requires `before_item`, `item` will be moved before it. If `before_item` was 100th item in category it will be removed from list of items with manual arrangement.
|
|
3055
|
-
* `NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.
|
|
3056
|
-
*/
|
|
3057
|
-
position?: MoveItemInCategoryRequestPosition;
|
|
3058
|
-
/** Required when `position` is `BEFORE`. `before_item` must be manually arranged item. */
|
|
3059
|
-
beforeItem?: ItemReference;
|
|
3060
|
-
}
|
|
3061
|
-
declare enum MoveItemInCategoryRequestPosition {
|
|
3062
|
-
UNKNOWN_POSITION = "UNKNOWN_POSITION",
|
|
3063
|
-
FIRST = "FIRST",
|
|
3064
|
-
LAST = "LAST",
|
|
3065
|
-
BEFORE = "BEFORE",
|
|
3066
|
-
NONE = "NONE"
|
|
3067
|
-
}
|
|
3068
|
-
interface MoveItemInCategoryResponse {
|
|
3069
|
-
/** Information about manually arranged items after move. */
|
|
3070
|
-
itemsAfterMove?: ItemReference[];
|
|
3071
|
-
}
|
|
3072
|
-
interface SetArrangedItemsRequest {
|
|
3073
|
-
/** Category ID. */
|
|
3074
|
-
categoryId: string;
|
|
3075
|
-
/** Category tree reference details. */
|
|
3076
|
-
treeReference: TreeReference;
|
|
3077
|
-
/** List of items to set. */
|
|
3078
|
-
items?: ItemReference[];
|
|
3079
|
-
}
|
|
3080
|
-
interface SetArrangedItemsResponse {
|
|
3081
|
-
/** List of arranged items. */
|
|
3082
|
-
items?: ItemReference[];
|
|
3083
|
-
}
|
|
3084
|
-
interface GetArrangedItemsRequest {
|
|
3085
|
-
/** Category ID. */
|
|
3086
|
-
categoryId: string;
|
|
3087
|
-
/** Category tree reference details. */
|
|
3088
|
-
treeReference: TreeReference;
|
|
3089
|
-
}
|
|
3090
|
-
interface GetArrangedItemsResponse {
|
|
3091
|
-
/** List of arranged items. */
|
|
3092
|
-
items?: ItemReference[];
|
|
3093
|
-
}
|
|
3094
|
-
interface GetCategoriesTreeRequest {
|
|
3095
|
-
/** Category tree reference details. */
|
|
3096
|
-
treeReference?: TreeReference;
|
|
3097
|
-
}
|
|
3098
|
-
interface GetCategoriesTreeResponse {
|
|
3099
|
-
/** Categories tree. */
|
|
3100
|
-
categoriesTree?: CategoryTreeNode[];
|
|
3101
|
-
}
|
|
3102
|
-
/** Represents a node in the view of categories tree */
|
|
3103
|
-
interface CategoryTreeNode {
|
|
3104
|
-
/** Category ID. */
|
|
3105
|
-
_id?: Uint8Array;
|
|
3106
|
-
/** List of subcategories. */
|
|
3107
|
-
subcategories?: CategoryTreeNode[];
|
|
3108
|
-
}
|
|
3109
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3110
|
-
createdEvent?: EntityCreatedEvent;
|
|
3111
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3112
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3113
|
-
actionEvent?: ActionEvent;
|
|
3114
|
-
/**
|
|
3115
|
-
* Unique event ID.
|
|
3116
|
-
* Allows clients to ignore duplicate webhooks.
|
|
3117
|
-
*/
|
|
3118
|
-
_id?: string;
|
|
3119
|
-
/**
|
|
3120
|
-
* Assumes actions are also always typed to an entity_type
|
|
3121
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
3122
|
-
*/
|
|
3123
|
-
entityFqdn?: string;
|
|
3124
|
-
/**
|
|
3125
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
3126
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
3127
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
3128
|
-
*/
|
|
3129
|
-
slug?: string;
|
|
3130
|
-
/** ID of the entity associated with the event. */
|
|
3131
|
-
entityId?: string;
|
|
3132
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
3133
|
-
eventTime?: Date | null;
|
|
3134
|
-
/**
|
|
3135
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
3136
|
-
* (for example, GDPR).
|
|
3137
|
-
*/
|
|
3138
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3139
|
-
/** If present, indicates the action that triggered the event. */
|
|
3140
|
-
originatedFrom?: string | null;
|
|
3141
|
-
/**
|
|
3142
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
3143
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
3144
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3145
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3146
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3147
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3148
|
-
*/
|
|
3149
|
-
entityEventSequence?: string | null;
|
|
3150
|
-
}
|
|
3151
|
-
/** @oneof */
|
|
3152
|
-
interface DomainEventBodyOneOf {
|
|
3153
|
-
createdEvent?: EntityCreatedEvent;
|
|
3154
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3155
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3156
|
-
actionEvent?: ActionEvent;
|
|
3157
|
-
}
|
|
3158
|
-
interface EntityCreatedEvent {
|
|
3159
|
-
entity?: string;
|
|
3160
|
-
}
|
|
3161
|
-
interface RestoreInfo {
|
|
3162
|
-
deletedDate?: Date | null;
|
|
3163
|
-
}
|
|
3164
|
-
interface EntityUpdatedEvent {
|
|
3165
|
-
/**
|
|
3166
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3167
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3168
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3169
|
-
*/
|
|
3170
|
-
currentEntity?: string;
|
|
3171
|
-
}
|
|
3172
|
-
interface EntityDeletedEvent {
|
|
3173
|
-
/** Entity that was deleted */
|
|
3174
|
-
deletedEntity?: string | null;
|
|
3175
|
-
}
|
|
3176
|
-
interface ActionEvent {
|
|
3177
|
-
body?: string;
|
|
3178
|
-
}
|
|
3179
|
-
interface Empty {
|
|
3180
|
-
}
|
|
3181
|
-
interface MessageEnvelope {
|
|
3182
|
-
/** App instance ID. */
|
|
3183
|
-
instanceId?: string | null;
|
|
3184
|
-
/** Event type. */
|
|
3185
|
-
eventType?: string;
|
|
3186
|
-
/** The identification type and identity data. */
|
|
3187
|
-
identity?: IdentificationData;
|
|
3188
|
-
/** Stringify payload. */
|
|
3189
|
-
data?: string;
|
|
3190
|
-
}
|
|
3191
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3192
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
3193
|
-
anonymousVisitorId?: string;
|
|
3194
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
3195
|
-
memberId?: string;
|
|
3196
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
3197
|
-
wixUserId?: string;
|
|
3198
|
-
/** ID of an app. */
|
|
3199
|
-
appId?: string;
|
|
3200
|
-
/** @readonly */
|
|
3201
|
-
identityType?: WebhookIdentityType;
|
|
3202
|
-
}
|
|
3203
|
-
/** @oneof */
|
|
3204
|
-
interface IdentificationDataIdOneOf {
|
|
3205
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
3206
|
-
anonymousVisitorId?: string;
|
|
3207
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
3208
|
-
memberId?: string;
|
|
3209
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
3210
|
-
wixUserId?: string;
|
|
3211
|
-
/** ID of an app. */
|
|
3212
|
-
appId?: string;
|
|
3213
|
-
}
|
|
3214
|
-
declare enum WebhookIdentityType {
|
|
3215
|
-
UNKNOWN = "UNKNOWN",
|
|
3216
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3217
|
-
MEMBER = "MEMBER",
|
|
3218
|
-
WIX_USER = "WIX_USER",
|
|
3219
|
-
APP = "APP"
|
|
3220
|
-
}
|
|
3221
|
-
interface BreadcrumbNonNullableFields {
|
|
3222
|
-
categoryId: string;
|
|
3223
|
-
categoryName: string;
|
|
3224
|
-
categorySlug: string;
|
|
3225
|
-
}
|
|
3226
|
-
interface BreadcrumbsInfoNonNullableFields {
|
|
3227
|
-
breadcrumbs: BreadcrumbNonNullableFields[];
|
|
3228
|
-
}
|
|
3229
|
-
interface TagNonNullableFields {
|
|
3230
|
-
type: string;
|
|
3231
|
-
children: string;
|
|
3232
|
-
custom: boolean;
|
|
3233
|
-
disabled: boolean;
|
|
3234
|
-
}
|
|
3235
|
-
interface KeywordNonNullableFields {
|
|
3236
|
-
term: string;
|
|
3237
|
-
isMain: boolean;
|
|
3238
|
-
}
|
|
3239
|
-
interface SettingsNonNullableFields {
|
|
3240
|
-
preventAutoRedirect: boolean;
|
|
3241
|
-
keywords: KeywordNonNullableFields[];
|
|
3242
|
-
}
|
|
3243
|
-
interface SeoSchemaNonNullableFields {
|
|
3244
|
-
tags: TagNonNullableFields[];
|
|
3245
|
-
settings?: SettingsNonNullableFields;
|
|
3246
|
-
}
|
|
3247
|
-
interface PluginContainerDataWidthNonNullableFields {
|
|
3248
|
-
size: WidthType;
|
|
3249
|
-
}
|
|
3250
|
-
interface PluginContainerDataNonNullableFields {
|
|
3251
|
-
width?: PluginContainerDataWidthNonNullableFields;
|
|
3252
|
-
alignment: PluginContainerDataAlignment;
|
|
3253
|
-
}
|
|
3254
|
-
interface LinkNonNullableFields {
|
|
3255
|
-
url: string;
|
|
3256
|
-
anchor: string;
|
|
3257
|
-
target: Target;
|
|
3258
|
-
}
|
|
3259
|
-
interface ButtonDataNonNullableFields {
|
|
3260
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3261
|
-
type: Type;
|
|
3262
|
-
link?: LinkNonNullableFields;
|
|
3263
|
-
}
|
|
3264
|
-
interface TextStyleNonNullableFields {
|
|
3265
|
-
textAlignment: TextAlignment;
|
|
3266
|
-
}
|
|
3267
|
-
interface CodeBlockDataNonNullableFields {
|
|
3268
|
-
textStyle?: TextStyleNonNullableFields;
|
|
3269
|
-
}
|
|
3270
|
-
interface DividerDataNonNullableFields {
|
|
3271
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3272
|
-
lineStyle: LineStyle;
|
|
3273
|
-
width: Width;
|
|
3274
|
-
alignment: Alignment;
|
|
3275
|
-
}
|
|
3276
|
-
interface PDFSettingsNonNullableFields {
|
|
3277
|
-
viewMode: ViewMode;
|
|
3278
|
-
}
|
|
3279
|
-
interface FileDataNonNullableFields {
|
|
3280
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3281
|
-
pdfSettings?: PDFSettingsNonNullableFields;
|
|
3282
|
-
}
|
|
3283
|
-
interface ImageNonNullableFields {
|
|
3284
|
-
link?: LinkNonNullableFields;
|
|
3285
|
-
}
|
|
3286
|
-
interface ItemNonNullableFields {
|
|
3287
|
-
image?: ImageNonNullableFields;
|
|
3288
|
-
}
|
|
3289
|
-
interface LayoutNonNullableFields {
|
|
3290
|
-
type: LayoutType;
|
|
3291
|
-
orientation: Orientation;
|
|
3292
|
-
}
|
|
3293
|
-
interface ItemStyleNonNullableFields {
|
|
3294
|
-
crop: Crop;
|
|
3295
|
-
}
|
|
3296
|
-
interface ThumbnailsNonNullableFields {
|
|
3297
|
-
placement: ThumbnailsAlignment;
|
|
3298
|
-
}
|
|
3299
|
-
interface GalleryOptionsNonNullableFields {
|
|
3300
|
-
layout?: LayoutNonNullableFields;
|
|
3301
|
-
item?: ItemStyleNonNullableFields;
|
|
3302
|
-
thumbnails?: ThumbnailsNonNullableFields;
|
|
3303
|
-
}
|
|
3304
|
-
interface GalleryDataNonNullableFields {
|
|
3305
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3306
|
-
items: ItemNonNullableFields[];
|
|
3307
|
-
options?: GalleryOptionsNonNullableFields;
|
|
3308
|
-
}
|
|
3309
|
-
interface GIFDataNonNullableFields {
|
|
3310
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3311
|
-
height: number;
|
|
3312
|
-
width: number;
|
|
3313
|
-
}
|
|
3314
|
-
interface HeadingDataNonNullableFields {
|
|
3315
|
-
level: number;
|
|
3316
|
-
textStyle?: TextStyleNonNullableFields;
|
|
3317
|
-
}
|
|
3318
|
-
interface HTMLDataNonNullableFields {
|
|
3319
|
-
url: string;
|
|
3320
|
-
html: string;
|
|
3321
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3322
|
-
source: Source;
|
|
3323
|
-
}
|
|
3324
|
-
interface ImageDataNonNullableFields {
|
|
3325
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3326
|
-
link?: LinkNonNullableFields;
|
|
3327
|
-
}
|
|
3328
|
-
interface LinkPreviewDataNonNullableFields {
|
|
3329
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3330
|
-
link?: LinkNonNullableFields;
|
|
3331
|
-
}
|
|
3332
|
-
interface MapSettingsNonNullableFields {
|
|
3333
|
-
mapType: MapType;
|
|
3334
|
-
}
|
|
3335
|
-
interface MapDataNonNullableFields {
|
|
3336
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3337
|
-
mapSettings?: MapSettingsNonNullableFields;
|
|
3338
|
-
}
|
|
3339
|
-
interface ParagraphDataNonNullableFields {
|
|
3340
|
-
textStyle?: TextStyleNonNullableFields;
|
|
3341
|
-
}
|
|
3342
|
-
interface PermissionsNonNullableFields {
|
|
3343
|
-
view: ViewRole;
|
|
3344
|
-
vote: VoteRole;
|
|
3345
|
-
}
|
|
3346
|
-
interface PollSettingsNonNullableFields {
|
|
3347
|
-
permissions?: PermissionsNonNullableFields;
|
|
3348
|
-
}
|
|
3349
|
-
interface PollNonNullableFields {
|
|
3350
|
-
settings?: PollSettingsNonNullableFields;
|
|
3351
|
-
}
|
|
3352
|
-
interface PollLayoutNonNullableFields {
|
|
3353
|
-
type: PollLayoutType;
|
|
3354
|
-
direction: PollLayoutDirection;
|
|
3355
|
-
}
|
|
3356
|
-
interface PollDataLayoutNonNullableFields {
|
|
3357
|
-
poll?: PollLayoutNonNullableFields;
|
|
3358
|
-
}
|
|
3359
|
-
interface BackgroundNonNullableFields {
|
|
3360
|
-
type: BackgroundType;
|
|
3361
|
-
}
|
|
3362
|
-
interface PollDesignNonNullableFields {
|
|
3363
|
-
background?: BackgroundNonNullableFields;
|
|
3364
|
-
}
|
|
3365
|
-
interface DesignNonNullableFields {
|
|
3366
|
-
poll?: PollDesignNonNullableFields;
|
|
3367
|
-
}
|
|
3368
|
-
interface PollDataNonNullableFields {
|
|
3369
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3370
|
-
poll?: PollNonNullableFields;
|
|
3371
|
-
layout?: PollDataLayoutNonNullableFields;
|
|
3372
|
-
design?: DesignNonNullableFields;
|
|
3373
|
-
}
|
|
3374
|
-
interface AnchorDataNonNullableFields {
|
|
3375
|
-
anchor: string;
|
|
3376
|
-
}
|
|
3377
|
-
interface LinkDataNonNullableFields {
|
|
3378
|
-
link?: LinkNonNullableFields;
|
|
3379
|
-
}
|
|
3380
|
-
interface MentionDataNonNullableFields {
|
|
3381
|
-
name: string;
|
|
3382
|
-
slug: string;
|
|
3383
|
-
}
|
|
3384
|
-
interface FontSizeDataNonNullableFields {
|
|
3385
|
-
unit: FontType;
|
|
3386
|
-
}
|
|
3387
|
-
interface DecorationNonNullableFields {
|
|
3388
|
-
anchorData?: AnchorDataNonNullableFields;
|
|
3389
|
-
linkData?: LinkDataNonNullableFields;
|
|
3390
|
-
mentionData?: MentionDataNonNullableFields;
|
|
3391
|
-
fontSizeData?: FontSizeDataNonNullableFields;
|
|
3392
|
-
type: DecorationType;
|
|
3393
|
-
}
|
|
3394
|
-
interface TextDataNonNullableFields {
|
|
3395
|
-
text: string;
|
|
3396
|
-
decorations: DecorationNonNullableFields[];
|
|
3397
|
-
}
|
|
3398
|
-
interface AppEmbedDataNonNullableFields {
|
|
3399
|
-
type: AppType;
|
|
3400
|
-
}
|
|
3401
|
-
interface VideoDataNonNullableFields {
|
|
3402
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3403
|
-
}
|
|
3404
|
-
interface EmbedDataNonNullableFields {
|
|
3405
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3406
|
-
}
|
|
3407
|
-
interface CollapsibleListDataNonNullableFields {
|
|
3408
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3409
|
-
initialExpandedItems: InitialExpandedItems;
|
|
3410
|
-
direction: Direction;
|
|
3411
|
-
}
|
|
3412
|
-
interface DimensionsNonNullableFields {
|
|
3413
|
-
colsWidthRatio: number[];
|
|
3414
|
-
rowsHeight: number[];
|
|
3415
|
-
colsMinWidth: number[];
|
|
3416
|
-
}
|
|
3417
|
-
interface TableDataNonNullableFields {
|
|
3418
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3419
|
-
dimensions?: DimensionsNonNullableFields;
|
|
3420
|
-
}
|
|
3421
|
-
interface CellStyleNonNullableFields {
|
|
3422
|
-
verticalAlignment: VerticalAlignment;
|
|
3423
|
-
}
|
|
3424
|
-
interface TableCellDataNonNullableFields {
|
|
3425
|
-
cellStyle?: CellStyleNonNullableFields;
|
|
3426
|
-
}
|
|
3427
|
-
interface AudioDataNonNullableFields {
|
|
3428
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
3429
|
-
}
|
|
3430
|
-
interface OrderedListDataNonNullableFields {
|
|
3431
|
-
indentation: number;
|
|
3432
|
-
}
|
|
3433
|
-
interface BulletedListDataNonNullableFields {
|
|
3434
|
-
indentation: number;
|
|
3435
|
-
}
|
|
3436
|
-
interface BlockquoteDataNonNullableFields {
|
|
3437
|
-
indentation: number;
|
|
3438
|
-
}
|
|
3439
|
-
interface CaptionDataNonNullableFields {
|
|
3440
|
-
textStyle?: TextStyleNonNullableFields;
|
|
3441
|
-
}
|
|
3442
|
-
interface NodeNonNullableFields {
|
|
3443
|
-
buttonData?: ButtonDataNonNullableFields;
|
|
3444
|
-
codeBlockData?: CodeBlockDataNonNullableFields;
|
|
3445
|
-
dividerData?: DividerDataNonNullableFields;
|
|
3446
|
-
fileData?: FileDataNonNullableFields;
|
|
3447
|
-
galleryData?: GalleryDataNonNullableFields;
|
|
3448
|
-
gifData?: GIFDataNonNullableFields;
|
|
3449
|
-
headingData?: HeadingDataNonNullableFields;
|
|
3450
|
-
htmlData?: HTMLDataNonNullableFields;
|
|
3451
|
-
imageData?: ImageDataNonNullableFields;
|
|
3452
|
-
linkPreviewData?: LinkPreviewDataNonNullableFields;
|
|
3453
|
-
mapData?: MapDataNonNullableFields;
|
|
3454
|
-
paragraphData?: ParagraphDataNonNullableFields;
|
|
3455
|
-
pollData?: PollDataNonNullableFields;
|
|
3456
|
-
textData?: TextDataNonNullableFields;
|
|
3457
|
-
appEmbedData?: AppEmbedDataNonNullableFields;
|
|
3458
|
-
videoData?: VideoDataNonNullableFields;
|
|
3459
|
-
embedData?: EmbedDataNonNullableFields;
|
|
3460
|
-
collapsibleListData?: CollapsibleListDataNonNullableFields;
|
|
3461
|
-
tableData?: TableDataNonNullableFields;
|
|
3462
|
-
tableCellData?: TableCellDataNonNullableFields;
|
|
3463
|
-
audioData?: AudioDataNonNullableFields;
|
|
3464
|
-
orderedListData?: OrderedListDataNonNullableFields;
|
|
3465
|
-
bulletedListData?: BulletedListDataNonNullableFields;
|
|
3466
|
-
blockquoteData?: BlockquoteDataNonNullableFields;
|
|
3467
|
-
captionData?: CaptionDataNonNullableFields;
|
|
3468
|
-
type: NodeType;
|
|
3469
|
-
_id: string;
|
|
3470
|
-
nodes: NodeNonNullableFields[];
|
|
3471
|
-
}
|
|
3472
|
-
interface MetadataNonNullableFields {
|
|
3473
|
-
version: number;
|
|
3474
|
-
}
|
|
3475
|
-
interface TextNodeStyleNonNullableFields {
|
|
3476
|
-
decorations: DecorationNonNullableFields[];
|
|
3477
|
-
}
|
|
3478
|
-
interface DocumentStyleNonNullableFields {
|
|
3479
|
-
headerOne?: TextNodeStyleNonNullableFields;
|
|
3480
|
-
headerTwo?: TextNodeStyleNonNullableFields;
|
|
3481
|
-
headerThree?: TextNodeStyleNonNullableFields;
|
|
3482
|
-
headerFour?: TextNodeStyleNonNullableFields;
|
|
3483
|
-
headerFive?: TextNodeStyleNonNullableFields;
|
|
3484
|
-
headerSix?: TextNodeStyleNonNullableFields;
|
|
3485
|
-
paragraph?: TextNodeStyleNonNullableFields;
|
|
3486
|
-
blockquote?: TextNodeStyleNonNullableFields;
|
|
3487
|
-
codeBlock?: TextNodeStyleNonNullableFields;
|
|
3488
|
-
}
|
|
3489
|
-
interface RichContentNonNullableFields {
|
|
3490
|
-
nodes: NodeNonNullableFields[];
|
|
3491
|
-
metadata?: MetadataNonNullableFields;
|
|
3492
|
-
documentStyle?: DocumentStyleNonNullableFields;
|
|
3493
|
-
}
|
|
3494
|
-
interface TreeReferenceNonNullableFields {
|
|
3495
|
-
appNamespace: string;
|
|
3496
|
-
}
|
|
3497
|
-
interface CategoryNonNullableFields {
|
|
3498
|
-
image: string;
|
|
3499
|
-
itemCounter: number;
|
|
3500
|
-
breadcrumbsInfo?: BreadcrumbsInfoNonNullableFields;
|
|
3501
|
-
seoData?: SeoSchemaNonNullableFields;
|
|
3502
|
-
richContentDescription?: RichContentNonNullableFields;
|
|
3503
|
-
treeReference?: TreeReferenceNonNullableFields;
|
|
3504
|
-
}
|
|
3505
|
-
interface CreateCategoryResponseNonNullableFields {
|
|
3506
|
-
category?: CategoryNonNullableFields;
|
|
3507
|
-
}
|
|
3508
|
-
interface GetCategoryResponseNonNullableFields {
|
|
3509
|
-
category?: CategoryNonNullableFields;
|
|
3510
|
-
}
|
|
3511
|
-
interface UpdateCategoryResponseNonNullableFields {
|
|
3512
|
-
category?: CategoryNonNullableFields;
|
|
3513
|
-
}
|
|
3514
|
-
interface QueryCategoriesResponseNonNullableFields {
|
|
3515
|
-
categories: CategoryNonNullableFields[];
|
|
3516
|
-
}
|
|
3517
|
-
interface ValueAggregationResultNonNullableFields {
|
|
3518
|
-
value: string;
|
|
3519
|
-
count: number;
|
|
3520
|
-
}
|
|
3521
|
-
interface ValueResultsNonNullableFields {
|
|
3522
|
-
results: ValueAggregationResultNonNullableFields[];
|
|
3523
|
-
}
|
|
3524
|
-
interface RangeAggregationResultNonNullableFields {
|
|
3525
|
-
count: number;
|
|
3526
|
-
}
|
|
3527
|
-
interface RangeResultsNonNullableFields {
|
|
3528
|
-
results: RangeAggregationResultNonNullableFields[];
|
|
3529
|
-
}
|
|
3530
|
-
interface AggregationResultsScalarResultNonNullableFields {
|
|
3531
|
-
type: ScalarType;
|
|
3532
|
-
value: number;
|
|
3533
|
-
}
|
|
3534
|
-
interface NestedAggregationResultsNonNullableFields {
|
|
3535
|
-
values?: ValueResultsNonNullableFields;
|
|
3536
|
-
ranges?: RangeResultsNonNullableFields;
|
|
3537
|
-
scalar?: AggregationResultsScalarResultNonNullableFields;
|
|
3538
|
-
name: string;
|
|
3539
|
-
type: AggregationType;
|
|
3540
|
-
fieldPath: string;
|
|
3541
|
-
}
|
|
3542
|
-
interface NestedValueAggregationResultNonNullableFields {
|
|
3543
|
-
value: string;
|
|
3544
|
-
nestedResults?: NestedAggregationResultsNonNullableFields;
|
|
3545
|
-
}
|
|
3546
|
-
interface GroupByValueResultsNonNullableFields {
|
|
3547
|
-
results: NestedValueAggregationResultNonNullableFields[];
|
|
3548
|
-
}
|
|
3549
|
-
interface DateHistogramResultNonNullableFields {
|
|
3550
|
-
value: string;
|
|
3551
|
-
count: number;
|
|
3552
|
-
}
|
|
3553
|
-
interface DateHistogramResultsNonNullableFields {
|
|
3554
|
-
results: DateHistogramResultNonNullableFields[];
|
|
3555
|
-
}
|
|
3556
|
-
interface AggregationResultsNonNullableFields {
|
|
3557
|
-
values?: ValueResultsNonNullableFields;
|
|
3558
|
-
ranges?: RangeResultsNonNullableFields;
|
|
3559
|
-
scalar?: AggregationResultsScalarResultNonNullableFields;
|
|
3560
|
-
groupedByValue?: GroupByValueResultsNonNullableFields;
|
|
3561
|
-
dateHistogram?: DateHistogramResultsNonNullableFields;
|
|
3562
|
-
name: string;
|
|
3563
|
-
type: AggregationType;
|
|
3564
|
-
fieldPath: string;
|
|
3565
|
-
}
|
|
3566
|
-
interface AggregationDataNonNullableFields {
|
|
3567
|
-
results: AggregationResultsNonNullableFields[];
|
|
3568
|
-
}
|
|
3569
|
-
interface SearchCategoriesResponseNonNullableFields {
|
|
3570
|
-
categories: CategoryNonNullableFields[];
|
|
3571
|
-
aggregationData?: AggregationDataNonNullableFields;
|
|
3572
|
-
}
|
|
3573
|
-
interface CountCategoriesResponseNonNullableFields {
|
|
3574
|
-
count: number;
|
|
3575
|
-
}
|
|
3576
|
-
interface MoveCategoryResponseNonNullableFields {
|
|
3577
|
-
categoriesAfterMove: string[];
|
|
3578
|
-
}
|
|
3579
|
-
interface ApplicationErrorNonNullableFields {
|
|
3580
|
-
code: string;
|
|
3581
|
-
description: string;
|
|
3582
|
-
}
|
|
3583
|
-
interface ItemMetadataNonNullableFields {
|
|
3584
|
-
originalIndex: number;
|
|
3585
|
-
success: boolean;
|
|
3586
|
-
error?: ApplicationErrorNonNullableFields;
|
|
3587
|
-
}
|
|
3588
|
-
interface BulkCategoriesResultNonNullableFields {
|
|
3589
|
-
itemMetadata?: ItemMetadataNonNullableFields;
|
|
3590
|
-
category?: CategoryNonNullableFields;
|
|
3591
|
-
}
|
|
3592
|
-
interface BulkActionMetadataNonNullableFields {
|
|
3593
|
-
totalSuccesses: number;
|
|
3594
|
-
totalFailures: number;
|
|
3595
|
-
undetailedFailures: number;
|
|
3596
|
-
}
|
|
3597
|
-
interface BulkUpdateCategoriesResponseNonNullableFields {
|
|
3598
|
-
results: BulkCategoriesResultNonNullableFields[];
|
|
3599
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
3600
|
-
}
|
|
3601
|
-
interface UpdateCategoryVisibilityResponseNonNullableFields {
|
|
3602
|
-
category?: CategoryNonNullableFields;
|
|
3603
|
-
}
|
|
3604
|
-
interface BulkShowCategoriesResponseNonNullableFields {
|
|
3605
|
-
results: BulkCategoriesResultNonNullableFields[];
|
|
3606
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
3607
|
-
}
|
|
3608
|
-
interface ItemReferenceNonNullableFields {
|
|
3609
|
-
catalogItemId: string;
|
|
3610
|
-
appId: string;
|
|
3611
|
-
}
|
|
3612
|
-
interface ItemReferenceMetadataNonNullableFields {
|
|
3613
|
-
item?: ItemReferenceNonNullableFields;
|
|
3614
|
-
originalIndex: number;
|
|
3615
|
-
success: boolean;
|
|
3616
|
-
error?: ApplicationErrorNonNullableFields;
|
|
3617
|
-
}
|
|
3618
|
-
interface BulkItemsToCategoryResultNonNullableFields {
|
|
3619
|
-
itemMetadata?: ItemReferenceMetadataNonNullableFields;
|
|
3620
|
-
}
|
|
3621
|
-
interface BulkAddItemsToCategoryResponseNonNullableFields {
|
|
3622
|
-
results: BulkItemsToCategoryResultNonNullableFields[];
|
|
3623
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
3624
|
-
}
|
|
3625
|
-
interface BulkItemToCategoriesResultNonNullableFields {
|
|
3626
|
-
itemMetadata?: ItemMetadataNonNullableFields;
|
|
3627
|
-
}
|
|
3628
|
-
interface BulkAddItemToCategoriesResponseNonNullableFields {
|
|
3629
|
-
results: BulkItemToCategoriesResultNonNullableFields[];
|
|
3630
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
3631
|
-
}
|
|
3632
|
-
interface BulkRemoveItemsFromCategoryResponseNonNullableFields {
|
|
3633
|
-
results: BulkItemsToCategoryResultNonNullableFields[];
|
|
3634
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
3635
|
-
}
|
|
3636
|
-
interface BulkRemoveItemFromCategoriesResponseNonNullableFields {
|
|
3637
|
-
results: BulkItemToCategoriesResultNonNullableFields[];
|
|
3638
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
3639
|
-
}
|
|
3640
|
-
interface ListItemsInCategoryResponseNonNullableFields {
|
|
3641
|
-
items: ItemReferenceNonNullableFields[];
|
|
3642
|
-
}
|
|
3643
|
-
interface ListCategoriesForItemResponseNonNullableFields {
|
|
3644
|
-
directCategoryIds: string[];
|
|
3645
|
-
allCategoryIds: string[];
|
|
3646
|
-
}
|
|
3647
|
-
interface ListTreesResponseNonNullableFields {
|
|
3648
|
-
trees: TreeReferenceNonNullableFields[];
|
|
3649
|
-
}
|
|
3650
|
-
interface SetArrangedItemsResponseNonNullableFields {
|
|
3651
|
-
items: ItemReferenceNonNullableFields[];
|
|
3652
|
-
}
|
|
3653
|
-
interface GetArrangedItemsResponseNonNullableFields {
|
|
3654
|
-
items: ItemReferenceNonNullableFields[];
|
|
3655
|
-
}
|
|
3656
|
-
interface BaseEventMetadata {
|
|
3657
|
-
/** App instance ID. */
|
|
3658
|
-
instanceId?: string | null;
|
|
3659
|
-
/** Event type. */
|
|
3660
|
-
eventType?: string;
|
|
3661
|
-
/** The identification type and identity data. */
|
|
3662
|
-
identity?: IdentificationData;
|
|
3663
|
-
}
|
|
3664
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
3665
|
-
/**
|
|
3666
|
-
* Unique event ID.
|
|
3667
|
-
* Allows clients to ignore duplicate webhooks.
|
|
3668
|
-
*/
|
|
3669
|
-
_id?: string;
|
|
3670
|
-
/**
|
|
3671
|
-
* Assumes actions are also always typed to an entity_type
|
|
3672
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
3673
|
-
*/
|
|
3674
|
-
entityFqdn?: string;
|
|
3675
|
-
/**
|
|
3676
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
3677
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
3678
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
3679
|
-
*/
|
|
3680
|
-
slug?: string;
|
|
3681
|
-
/** ID of the entity associated with the event. */
|
|
3682
|
-
entityId?: string;
|
|
3683
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
3684
|
-
eventTime?: Date | null;
|
|
3685
|
-
/**
|
|
3686
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
3687
|
-
* (for example, GDPR).
|
|
3688
|
-
*/
|
|
3689
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3690
|
-
/** If present, indicates the action that triggered the event. */
|
|
3691
|
-
originatedFrom?: string | null;
|
|
3692
|
-
/**
|
|
3693
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
3694
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
3695
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3696
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3697
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3698
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3699
|
-
*/
|
|
3700
|
-
entityEventSequence?: string | null;
|
|
3701
|
-
}
|
|
3702
|
-
interface CategoryMovedEnvelope {
|
|
3703
|
-
data: CategoryMoved;
|
|
3704
|
-
metadata: EventMetadata;
|
|
3705
|
-
}
|
|
3706
|
-
interface CategoryCreatedEnvelope {
|
|
3707
|
-
entity: Category;
|
|
3708
|
-
metadata: EventMetadata;
|
|
3709
|
-
}
|
|
3710
|
-
interface CategoryDeletedEnvelope {
|
|
3711
|
-
metadata: EventMetadata;
|
|
3712
|
-
}
|
|
3713
|
-
interface CategoryItemAddedToCategoryEnvelope {
|
|
3714
|
-
data: ItemAddedToCategory;
|
|
3715
|
-
metadata: EventMetadata;
|
|
3716
|
-
}
|
|
3717
|
-
interface CategoryItemRemovedFromCategoryEnvelope {
|
|
3718
|
-
data: ItemRemovedFromCategory;
|
|
3719
|
-
metadata: EventMetadata;
|
|
3720
|
-
}
|
|
3721
|
-
interface CategoryItemsArrangedInCategoryEnvelope {
|
|
3722
|
-
data: ItemsArrangedInCategory;
|
|
3723
|
-
metadata: EventMetadata;
|
|
3724
|
-
}
|
|
3725
|
-
interface CategoryUpdatedEnvelope {
|
|
3726
|
-
entity: Category;
|
|
3727
|
-
metadata: EventMetadata;
|
|
3728
|
-
}
|
|
3729
|
-
interface CreateCategoryOptions {
|
|
3730
|
-
/** Category tree reference details. */
|
|
3731
|
-
treeReference: TreeReference;
|
|
3732
|
-
/** Fields to include in the response. */
|
|
3733
|
-
fields?: SingleEntityOpsRequestedFields[];
|
|
3734
|
-
}
|
|
3735
|
-
interface GetCategoryOptions {
|
|
3736
|
-
/** Fields to include in the response. */
|
|
3737
|
-
fields?: SingleEntityOpsRequestedFields[];
|
|
3738
|
-
}
|
|
3739
|
-
interface UpdateCategory {
|
|
3740
|
-
/** Category ID. */
|
|
3741
|
-
_id?: string | null;
|
|
3742
|
-
/**
|
|
3743
|
-
* Revision number, which increments by 1 each time the category is updated.
|
|
3744
|
-
* To prevent conflicting changes, the current revision must be passed when updating.
|
|
3745
|
-
*
|
|
3746
|
-
* Ignored when creating a category.
|
|
3747
|
-
* @readonly
|
|
3748
|
-
*/
|
|
3749
|
-
revision?: string | null;
|
|
3750
|
-
/**
|
|
3751
|
-
* Date and time the category was created.
|
|
3752
|
-
* @readonly
|
|
3753
|
-
*/
|
|
3754
|
-
_createdDate?: Date | null;
|
|
3755
|
-
/**
|
|
3756
|
-
* Date and time the category was updated.
|
|
3757
|
-
* @readonly
|
|
3758
|
-
*/
|
|
3759
|
-
_updatedDate?: Date | null;
|
|
3760
|
-
/** Category name. */
|
|
3761
|
-
name?: string | null;
|
|
3762
|
-
/**
|
|
3763
|
-
* Category image.
|
|
3764
|
-
*
|
|
3765
|
-
* + Pass WixMedia image ID for media previously saved in the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).
|
|
3766
|
-
* + Pass full image URL to upload to Wix Media Manager.
|
|
3767
|
-
*/
|
|
3768
|
-
image?: string;
|
|
3769
|
-
/**
|
|
3770
|
-
* Number of items in this category.
|
|
3771
|
-
* @readonly
|
|
3772
|
-
*/
|
|
3773
|
-
itemCounter?: number;
|
|
3774
|
-
/**
|
|
3775
|
-
* Category description.
|
|
3776
|
-
* > **Note:** This field is returned only when you pass `fields: "DESCRIPTION"` in the request.
|
|
3777
|
-
*/
|
|
3778
|
-
description?: string | null;
|
|
3779
|
-
/**
|
|
3780
|
-
* Whether the category is visible to site visitors in dynamic pages.
|
|
3781
|
-
*
|
|
3782
|
-
* + If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
|
|
3783
|
-
* + Passing `true` will fail if the visibility of any parent categories is `false`.
|
|
3784
|
-
* + Default: `false`.
|
|
3785
|
-
*/
|
|
3786
|
-
visible?: boolean | null;
|
|
3787
|
-
/**
|
|
3788
|
-
* Category breadcrumbs.
|
|
3789
|
-
*
|
|
3790
|
-
* > **Note:** Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array in Categories API requests.
|
|
3791
|
-
* @readonly
|
|
3792
|
-
*/
|
|
3793
|
-
breadcrumbsInfo?: BreadcrumbsInfo;
|
|
3794
|
-
/** Parent category reference data. */
|
|
3795
|
-
parentCategory?: ParentCategory;
|
|
3796
|
-
/**
|
|
3797
|
-
* Category slug.
|
|
3798
|
-
*
|
|
3799
|
-
* If not provided, the slug is autogenerated based on the category name.
|
|
3800
|
-
*/
|
|
3801
|
-
slug?: string | null;
|
|
3802
|
-
/**
|
|
3803
|
-
* Category description using rich content.
|
|
3804
|
-
* > **Note:** Returned only when you pass `"RICH_CONTENT_DESCRIPTION"` to the `fields` array in Categories API requests.
|
|
3805
|
-
*
|
|
3806
|
-
* <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="indent.emoji.divider.codeBlock.file.gallery.giphy.image.table.link.textHighlight.textColor" exampleid="7dc9240e-d548-417a-abcf-0291b68b4303">
|
|
3807
|
-
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
3808
|
-
* </widget>
|
|
3809
|
-
*/
|
|
3810
|
-
richContentDescription?: RichContent;
|
|
3811
|
-
/**
|
|
3812
|
-
* ID of the app responsible for managing the items in this category.
|
|
3813
|
-
*
|
|
3814
|
-
* Pass your app ID to restrict updating and deleting items in this category to your app only.
|
|
3815
|
-
*/
|
|
3816
|
-
managingAppId?: string | null;
|
|
3817
|
-
/**
|
|
3818
|
-
* Custom extended fields for the category object.
|
|
3819
|
-
*
|
|
3820
|
-
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
|
|
3821
|
-
*/
|
|
3822
|
-
extendedFields?: ExtendedFields;
|
|
3823
|
-
}
|
|
3824
|
-
interface UpdateCategoryOptions {
|
|
3825
|
-
/** Category tree reference details. */
|
|
3826
|
-
treeReference: TreeReference;
|
|
3827
|
-
/** Fields to include in the response. */
|
|
3828
|
-
fields?: SingleEntityOpsRequestedFields[];
|
|
3829
|
-
}
|
|
3830
|
-
interface QueryCategoriesOptions {
|
|
3831
|
-
/** Category tree reference details. */
|
|
3832
|
-
treeReference: TreeReference;
|
|
3833
|
-
/**
|
|
3834
|
-
* Whether to return non-visible categories.
|
|
3835
|
-
*
|
|
3836
|
-
* Default: `false` (only visible categories are returned)
|
|
3837
|
-
*/
|
|
3838
|
-
returnNonVisibleCategories?: boolean | undefined;
|
|
3839
|
-
/** Fields to include in the response. */
|
|
3840
|
-
fields?: RequestedFields[] | undefined;
|
|
3841
|
-
}
|
|
3842
|
-
interface QueryCursorResult {
|
|
3843
|
-
cursors: Cursors;
|
|
3844
|
-
hasNext: () => boolean;
|
|
3845
|
-
hasPrev: () => boolean;
|
|
3846
|
-
length: number;
|
|
3847
|
-
pageSize: number;
|
|
3848
|
-
}
|
|
3849
|
-
interface CategoriesQueryResult extends QueryCursorResult {
|
|
3850
|
-
items: Category[];
|
|
3851
|
-
query: CategoriesQueryBuilder;
|
|
3852
|
-
next: () => Promise<CategoriesQueryResult>;
|
|
3853
|
-
prev: () => Promise<CategoriesQueryResult>;
|
|
3854
|
-
}
|
|
3855
|
-
interface CategoriesQueryBuilder {
|
|
3856
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3857
|
-
* @param value - Value to compare against.
|
|
3858
|
-
* @documentationMaturity preview
|
|
3859
|
-
*/
|
|
3860
|
-
eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
|
|
3861
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3862
|
-
* @param value - Value to compare against.
|
|
3863
|
-
* @documentationMaturity preview
|
|
3864
|
-
*/
|
|
3865
|
-
ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
|
|
3866
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3867
|
-
* @param value - Value to compare against.
|
|
3868
|
-
* @documentationMaturity preview
|
|
3869
|
-
*/
|
|
3870
|
-
ge: (propertyName: '_createdDate' | '_updatedDate' | 'parentCategory.index', value: any) => CategoriesQueryBuilder;
|
|
3871
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3872
|
-
* @param value - Value to compare against.
|
|
3873
|
-
* @documentationMaturity preview
|
|
3874
|
-
*/
|
|
3875
|
-
gt: (propertyName: '_createdDate' | '_updatedDate' | 'parentCategory.index', value: any) => CategoriesQueryBuilder;
|
|
3876
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3877
|
-
* @param value - Value to compare against.
|
|
3878
|
-
* @documentationMaturity preview
|
|
3879
|
-
*/
|
|
3880
|
-
le: (propertyName: '_createdDate' | '_updatedDate' | 'parentCategory.index', value: any) => CategoriesQueryBuilder;
|
|
3881
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3882
|
-
* @param value - Value to compare against.
|
|
3883
|
-
* @documentationMaturity preview
|
|
3884
|
-
*/
|
|
3885
|
-
lt: (propertyName: '_createdDate' | '_updatedDate' | 'parentCategory.index', value: any) => CategoriesQueryBuilder;
|
|
3886
|
-
/** @param propertyName - Property whose value is compared with `string`.
|
|
3887
|
-
* @param string - String to compare against. Case-insensitive.
|
|
3888
|
-
* @documentationMaturity preview
|
|
3889
|
-
*/
|
|
3890
|
-
startsWith: (propertyName: '_id' | 'name' | 'description' | 'parentCategory.id' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: string) => CategoriesQueryBuilder;
|
|
3891
|
-
/** @param propertyName - Property whose value is compared with `values`.
|
|
3892
|
-
* @param values - List of values to compare against.
|
|
3893
|
-
* @documentationMaturity preview
|
|
3894
|
-
*/
|
|
3895
|
-
hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any[]) => CategoriesQueryBuilder;
|
|
3896
|
-
/** @documentationMaturity preview */
|
|
3897
|
-
in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
|
|
3898
|
-
/** @documentationMaturity preview */
|
|
3899
|
-
exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: boolean) => CategoriesQueryBuilder;
|
|
3900
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
3901
|
-
* @documentationMaturity preview
|
|
3902
|
-
*/
|
|
3903
|
-
ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name' | 'parentCategory.id' | 'parentCategory.index' | 'managingAppId'>) => CategoriesQueryBuilder;
|
|
3904
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
3905
|
-
* @documentationMaturity preview
|
|
3906
|
-
*/
|
|
3907
|
-
descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name' | 'parentCategory.id' | 'parentCategory.index' | 'managingAppId'>) => CategoriesQueryBuilder;
|
|
3908
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
3909
|
-
* @documentationMaturity preview
|
|
3910
|
-
*/
|
|
3911
|
-
limit: (limit: number) => CategoriesQueryBuilder;
|
|
3912
|
-
/** @param cursor - A pointer to specific record
|
|
3913
|
-
* @documentationMaturity preview
|
|
3914
|
-
*/
|
|
3915
|
-
skipTo: (cursor: string) => CategoriesQueryBuilder;
|
|
3916
|
-
/** @documentationMaturity preview */
|
|
3917
|
-
find: () => Promise<CategoriesQueryResult>;
|
|
3918
|
-
}
|
|
3919
|
-
interface SearchCategoriesOptions {
|
|
3920
|
-
/** Search options. */
|
|
3921
|
-
search?: CursorSearch;
|
|
3922
|
-
/**
|
|
3923
|
-
* Category tree reference details.
|
|
3924
|
-
* > **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.
|
|
3925
|
-
*/
|
|
3926
|
-
treeReference: TreeReference;
|
|
3927
|
-
/**
|
|
3928
|
-
* Whether to return the categories with `visible: false`.
|
|
3929
|
-
*
|
|
3930
|
-
* Default: `false` - only visible categories are returned in the response
|
|
3931
|
-
*/
|
|
3932
|
-
returnNonVisibleCategories?: boolean;
|
|
3933
|
-
/** Fields to include in the response. */
|
|
3934
|
-
fields?: RequestedFields[];
|
|
3935
|
-
}
|
|
3936
|
-
interface CountCategoriesOptions {
|
|
3937
|
-
/**
|
|
3938
|
-
* Filter object.
|
|
3939
|
-
*
|
|
3940
|
-
* Learn more about the [filter object structure](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
3941
|
-
*/
|
|
3942
|
-
filter?: Record<string, any> | null;
|
|
3943
|
-
/** Search options. */
|
|
3944
|
-
search?: SearchDetails;
|
|
3945
|
-
/** Category tree reference details. */
|
|
3946
|
-
treeReference: TreeReference;
|
|
3947
|
-
/**
|
|
3948
|
-
* Whether to return categories with `visible: false` (hidden categories).
|
|
3949
|
-
*
|
|
3950
|
-
* Default: `false` - only visible categories are returned in the response
|
|
3951
|
-
*/
|
|
3952
|
-
returnNonVisibleCategories?: boolean;
|
|
3953
|
-
}
|
|
3954
|
-
interface MoveCategoryOptions {
|
|
3955
|
-
/**
|
|
3956
|
-
* Parent category ID.
|
|
3957
|
-
*
|
|
3958
|
-
* Default: root category ID
|
|
3959
|
-
*/
|
|
3960
|
-
parentCategoryId?: string | null;
|
|
3961
|
-
/**
|
|
3962
|
-
* Where to place the subcategory.
|
|
3963
|
-
*
|
|
3964
|
-
* + `FIRST`: Position the category as the first subcategory.
|
|
3965
|
-
* + `LAST`: Position the category as the last subcategory.
|
|
3966
|
-
* + `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`.
|
|
3967
|
-
*/
|
|
3968
|
-
position: Position;
|
|
3969
|
-
/** Required when passing `position: AFTER`. */
|
|
3970
|
-
moveAfterCategoryId?: string | null;
|
|
3971
|
-
}
|
|
3972
|
-
interface BulkUpdateCategoriesOptions {
|
|
3973
|
-
/** Category tree reference details. */
|
|
3974
|
-
treeReference: TreeReference;
|
|
3975
|
-
/**
|
|
3976
|
-
* Whether to return the full category entity in the response.
|
|
3977
|
-
*
|
|
3978
|
-
* Default: `false`
|
|
3979
|
-
*/
|
|
3980
|
-
returnEntity?: boolean;
|
|
3981
|
-
/** Fields to include in the response. */
|
|
3982
|
-
fields?: RequestedFields[];
|
|
3983
|
-
}
|
|
3984
|
-
interface UpdateCategoryVisibilityOptions {
|
|
3985
|
-
/**
|
|
3986
|
-
* Whether the category is visible to site visitors in dynamic pages.
|
|
3987
|
-
*
|
|
3988
|
-
* + If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
|
|
3989
|
-
* + Passing `true` will fail if the visibility of any parent categories is `false`.
|
|
3990
|
-
*/
|
|
3991
|
-
visible: boolean;
|
|
3992
|
-
/** Category tree reference details. */
|
|
3993
|
-
treeReference: TreeReference;
|
|
3994
|
-
/**
|
|
3995
|
-
* Latest revision of the category.
|
|
3996
|
-
* To prevent conflicting changes, the current revision must be passed on update.
|
|
3997
|
-
*/
|
|
3998
|
-
revision: string | null;
|
|
3999
|
-
/** Fields to include in the response. */
|
|
4000
|
-
fields?: SingleEntityOpsRequestedFields[];
|
|
4001
|
-
}
|
|
4002
|
-
interface BulkShowCategoriesOptions {
|
|
4003
|
-
/** Category tree reference details. */
|
|
4004
|
-
treeReference: TreeReference;
|
|
4005
|
-
/**
|
|
4006
|
-
* Whether to return the category entity in the response.
|
|
4007
|
-
*
|
|
4008
|
-
* Default: `false`
|
|
4009
|
-
*/
|
|
4010
|
-
returnEntity?: boolean;
|
|
4011
|
-
/** Fields to include in the response. */
|
|
4012
|
-
fields?: RequestedFields[];
|
|
4013
|
-
}
|
|
4014
|
-
interface BulkAddItemsToCategoryOptions {
|
|
4015
|
-
/** Category tree reference details. */
|
|
4016
|
-
treeReference: TreeReference;
|
|
4017
|
-
}
|
|
4018
|
-
interface BulkAddItemToCategoriesOptions {
|
|
4019
|
-
/** IDs of categories to which to add the item. */
|
|
4020
|
-
categoryIds: string[];
|
|
4021
|
-
/** Category tree reference details. */
|
|
4022
|
-
treeReference: TreeReference;
|
|
4023
|
-
}
|
|
4024
|
-
interface BulkRemoveItemsFromCategoryOptions {
|
|
4025
|
-
/** Category tree reference details. */
|
|
4026
|
-
treeReference: TreeReference;
|
|
4027
|
-
}
|
|
4028
|
-
interface BulkRemoveItemFromCategoriesOptions {
|
|
4029
|
-
/** IDs of categories from which to remove the item. */
|
|
4030
|
-
categoryIds: string[];
|
|
4031
|
-
/** Category tree reference details. */
|
|
4032
|
-
treeReference: TreeReference;
|
|
4033
|
-
}
|
|
4034
|
-
interface ListItemsInCategoryOptions extends ListItemsInCategoryRequestPagingMethodOneOf {
|
|
4035
|
-
/**
|
|
4036
|
-
* Whether to use category arrangement for sorting items.
|
|
4037
|
-
*
|
|
4038
|
-
* Default: `false`
|
|
4039
|
-
*/
|
|
4040
|
-
useCategoryArrangement?: boolean;
|
|
4041
|
-
/**
|
|
4042
|
-
* Whether to include items from subcategories.
|
|
4043
|
-
*
|
|
4044
|
-
* Default: `false` (only direct items of the category will be returned)
|
|
4045
|
-
*/
|
|
4046
|
-
includeItemsFromSubcategories?: boolean;
|
|
4047
|
-
/**
|
|
4048
|
-
* Cursor paging options.
|
|
4049
|
-
*
|
|
4050
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
4051
|
-
*/
|
|
4052
|
-
cursorPaging?: CursorPaging;
|
|
4053
|
-
}
|
|
4054
|
-
interface ListCategoriesForItemOptions {
|
|
4055
|
-
/** Category tree reference details. */
|
|
4056
|
-
treeReference: TreeReference;
|
|
4057
|
-
}
|
|
4058
|
-
interface SetArrangedItemsOptions {
|
|
4059
|
-
/** List of items to set. */
|
|
4060
|
-
items?: ItemReference[];
|
|
4061
|
-
}
|
|
4062
|
-
|
|
4063
|
-
declare function createCategory$1(httpClient: HttpClient): CreateCategorySignature;
|
|
4064
|
-
interface CreateCategorySignature {
|
|
4065
|
-
/**
|
|
4066
|
-
* Creates a category.
|
|
4067
|
-
* @param - Category to create.
|
|
4068
|
-
* @returns Created category.
|
|
4069
|
-
*/
|
|
4070
|
-
(category: Category, options?: CreateCategoryOptions | undefined): Promise<Category & CategoryNonNullableFields>;
|
|
4071
|
-
}
|
|
4072
|
-
declare function getCategory$1(httpClient: HttpClient): GetCategorySignature;
|
|
4073
|
-
interface GetCategorySignature {
|
|
4074
|
-
/**
|
|
4075
|
-
* Retrieves a category.
|
|
4076
|
-
* @param - Category ID.
|
|
4077
|
-
* @param - Category tree reference details.
|
|
4078
|
-
* @returns Category.
|
|
4079
|
-
*/
|
|
4080
|
-
(categoryId: string, treeReference: TreeReference, options?: GetCategoryOptions | undefined): Promise<Category & CategoryNonNullableFields>;
|
|
4081
|
-
}
|
|
4082
|
-
declare function updateCategory$1(httpClient: HttpClient): UpdateCategorySignature;
|
|
4083
|
-
interface UpdateCategorySignature {
|
|
4084
|
-
/**
|
|
4085
|
-
* Updates a category.
|
|
4086
|
-
*
|
|
4087
|
-
* Each time the category is updated, `revision` increments by 1.
|
|
4088
|
-
* The current `revision` must be passed when updating the category.
|
|
4089
|
-
* This ensures you're working with the latest category and prevents unintended overwrites.
|
|
4090
|
-
* @param - Category ID.
|
|
4091
|
-
* @returns Updated category.
|
|
4092
|
-
*/
|
|
4093
|
-
(_id: string | null, category: UpdateCategory, options?: UpdateCategoryOptions | undefined): Promise<Category & CategoryNonNullableFields>;
|
|
4094
|
-
}
|
|
4095
|
-
declare function deleteCategory$1(httpClient: HttpClient): DeleteCategorySignature;
|
|
4096
|
-
interface DeleteCategorySignature {
|
|
4097
|
-
/**
|
|
4098
|
-
* Deletes a category.
|
|
4099
|
-
* @param - Category ID.
|
|
4100
|
-
* @param - Category tree reference details.
|
|
4101
|
-
*/
|
|
4102
|
-
(categoryId: string, treeReference: TreeReference): Promise<void>;
|
|
4103
|
-
}
|
|
4104
|
-
declare function queryCategories$1(httpClient: HttpClient): QueryCategoriesSignature;
|
|
4105
|
-
interface QueryCategoriesSignature {
|
|
4106
|
-
/**
|
|
4107
|
-
* Retrieves a list of up to 1,000 categories, given the provided filtering, sorting, and cursor paging.
|
|
4108
|
-
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
4109
|
-
*
|
|
4110
|
-
* For field support for filters and sorting,
|
|
4111
|
-
* see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).
|
|
4112
|
-
*
|
|
4113
|
-
* To learn about working with _Query_ endpoints, see
|
|
4114
|
-
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
4115
|
-
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
4116
|
-
*/
|
|
4117
|
-
(options: QueryCategoriesOptions): CategoriesQueryBuilder;
|
|
4118
|
-
}
|
|
4119
|
-
declare function searchCategories$1(httpClient: HttpClient): SearchCategoriesSignature;
|
|
4120
|
-
interface SearchCategoriesSignature {
|
|
4121
|
-
/**
|
|
4122
|
-
* Retrieves a list of up to 1,000 categories, given the provided filtering, sorting, and cursor paging.
|
|
4123
|
-
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
4124
|
-
*
|
|
4125
|
-
*
|
|
4126
|
-
* Search Categories runs with these defaults, which you can override:
|
|
4127
|
-
*
|
|
4128
|
-
* - `createdDate` is sorted in `DESC` order
|
|
4129
|
-
* - `cursorPaging.limit` is `100`
|
|
4130
|
-
*
|
|
4131
|
-
* For field support for filters and sorting,
|
|
4132
|
-
* see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).
|
|
4133
|
-
*
|
|
4134
|
-
* To learn about working with _Search_ endpoints, see
|
|
4135
|
-
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
4136
|
-
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
4137
|
-
*/
|
|
4138
|
-
(options?: SearchCategoriesOptions | undefined): Promise<SearchCategoriesResponse & SearchCategoriesResponseNonNullableFields>;
|
|
4139
|
-
}
|
|
4140
|
-
declare function countCategories$1(httpClient: HttpClient): CountCategoriesSignature;
|
|
4141
|
-
interface CountCategoriesSignature {
|
|
4142
|
-
/**
|
|
4143
|
-
* Counts the number of categories that match the provided filtering.
|
|
4144
|
-
*
|
|
4145
|
-
* For field support for filters and sorting,
|
|
4146
|
-
* see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).
|
|
4147
|
-
*/
|
|
4148
|
-
(options?: CountCategoriesOptions | undefined): Promise<CountCategoriesResponse & CountCategoriesResponseNonNullableFields>;
|
|
4149
|
-
}
|
|
4150
|
-
declare function moveCategory$1(httpClient: HttpClient): MoveCategorySignature;
|
|
4151
|
-
interface MoveCategorySignature {
|
|
4152
|
-
/**
|
|
4153
|
-
* Moves a category within its parent category, or to a different parent category.
|
|
4154
|
-
* @param - ID of the category to move.
|
|
4155
|
-
* @param - Category tree reference details.
|
|
4156
|
-
*/
|
|
4157
|
-
(categoryId: string, treeReference: TreeReference, options?: MoveCategoryOptions | undefined): Promise<MoveCategoryResponse & MoveCategoryResponseNonNullableFields>;
|
|
4158
|
-
}
|
|
4159
|
-
declare function bulkUpdateCategories$1(httpClient: HttpClient): BulkUpdateCategoriesSignature;
|
|
4160
|
-
interface BulkUpdateCategoriesSignature {
|
|
4161
|
-
/**
|
|
4162
|
-
* Updates multiple categories.
|
|
4163
|
-
*
|
|
4164
|
-
* Each time a category is updated, `revision` increments by 1.
|
|
4165
|
-
* The current `revision` must be passed when updating a category.
|
|
4166
|
-
* This ensures you're working with the latest category and prevents unintended overwrites.
|
|
4167
|
-
* @param - List of categories to update.
|
|
4168
|
-
*/
|
|
4169
|
-
(categories: MaskedCategory[], options?: BulkUpdateCategoriesOptions | undefined): Promise<BulkUpdateCategoriesResponse & BulkUpdateCategoriesResponseNonNullableFields>;
|
|
4170
|
-
}
|
|
4171
|
-
declare function updateCategoryVisibility$1(httpClient: HttpClient): UpdateCategoryVisibilitySignature;
|
|
4172
|
-
interface UpdateCategoryVisibilitySignature {
|
|
4173
|
-
/**
|
|
4174
|
-
* Updates category visibility.
|
|
4175
|
-
*
|
|
4176
|
-
*
|
|
4177
|
-
* Each time a category is updated, `revision` increments by 1.
|
|
4178
|
-
* The current `revision` must be passed when updating a category.
|
|
4179
|
-
* This ensures you're working with the latest category and prevents unintended overwrites.
|
|
4180
|
-
* @param - Category ID.
|
|
4181
|
-
*/
|
|
4182
|
-
(categoryId: string, options?: UpdateCategoryVisibilityOptions | undefined): Promise<UpdateCategoryVisibilityResponse & UpdateCategoryVisibilityResponseNonNullableFields>;
|
|
4183
|
-
}
|
|
4184
|
-
declare function bulkShowCategories$1(httpClient: HttpClient): BulkShowCategoriesSignature;
|
|
4185
|
-
interface BulkShowCategoriesSignature {
|
|
4186
|
-
/** @param - IDs of the categories to update. */
|
|
4187
|
-
(categoryIds: string[], options?: BulkShowCategoriesOptions | undefined): Promise<BulkShowCategoriesResponse & BulkShowCategoriesResponseNonNullableFields>;
|
|
4188
|
-
}
|
|
4189
|
-
declare function bulkAddItemsToCategory$1(httpClient: HttpClient): BulkAddItemsToCategorySignature;
|
|
4190
|
-
interface BulkAddItemsToCategorySignature {
|
|
4191
|
-
/**
|
|
4192
|
-
* Adds multiple items to a single category.
|
|
4193
|
-
* @param - Category ID.
|
|
4194
|
-
* @param - List of items to add.
|
|
4195
|
-
*/
|
|
4196
|
-
(categoryId: string, items: ItemReference[], options: BulkAddItemsToCategoryOptions): Promise<BulkAddItemsToCategoryResponse & BulkAddItemsToCategoryResponseNonNullableFields>;
|
|
4197
|
-
}
|
|
4198
|
-
declare function bulkAddItemToCategories$1(httpClient: HttpClient): BulkAddItemToCategoriesSignature;
|
|
4199
|
-
interface BulkAddItemToCategoriesSignature {
|
|
4200
|
-
/**
|
|
4201
|
-
* Adds a single item to multiple categories.
|
|
4202
|
-
* @param - Item to add.
|
|
4203
|
-
*/
|
|
4204
|
-
(item: ItemReference, options: BulkAddItemToCategoriesOptions): Promise<BulkAddItemToCategoriesResponse & BulkAddItemToCategoriesResponseNonNullableFields>;
|
|
4205
|
-
}
|
|
4206
|
-
declare function bulkRemoveItemsFromCategory$1(httpClient: HttpClient): BulkRemoveItemsFromCategorySignature;
|
|
4207
|
-
interface BulkRemoveItemsFromCategorySignature {
|
|
4208
|
-
/**
|
|
4209
|
-
* Removes multiple items from a single category.
|
|
4210
|
-
* @param - Category ID.
|
|
4211
|
-
* @param - List of items to remove.
|
|
4212
|
-
*/
|
|
4213
|
-
(categoryId: string, items: ItemReference[], options: BulkRemoveItemsFromCategoryOptions): Promise<BulkRemoveItemsFromCategoryResponse & BulkRemoveItemsFromCategoryResponseNonNullableFields>;
|
|
4214
|
-
}
|
|
4215
|
-
declare function bulkRemoveItemFromCategories$1(httpClient: HttpClient): BulkRemoveItemFromCategoriesSignature;
|
|
4216
|
-
interface BulkRemoveItemFromCategoriesSignature {
|
|
4217
|
-
/**
|
|
4218
|
-
* Removes a single item from multiple categories.
|
|
4219
|
-
* @param - Item to remove.
|
|
4220
|
-
*/
|
|
4221
|
-
(item: ItemReference, options: BulkRemoveItemFromCategoriesOptions): Promise<BulkRemoveItemFromCategoriesResponse & BulkRemoveItemFromCategoriesResponseNonNullableFields>;
|
|
4222
|
-
}
|
|
4223
|
-
declare function listItemsInCategory$1(httpClient: HttpClient): ListItemsInCategorySignature;
|
|
4224
|
-
interface ListItemsInCategorySignature {
|
|
4225
|
-
/**
|
|
4226
|
-
* Retrieves a list of up to 100 items from a single category, given the provided cursor paging.
|
|
4227
|
-
*
|
|
4228
|
-
*
|
|
4229
|
-
* List Items In Categories defaults to sorting by the time the item was added to the category, in descending order.
|
|
4230
|
-
* @param - Category ID.
|
|
4231
|
-
* @param - Category tree reference details.
|
|
4232
|
-
*/
|
|
4233
|
-
(categoryId: string, treeReference: TreeReference, options?: ListItemsInCategoryOptions | undefined): Promise<ListItemsInCategoryResponse & ListItemsInCategoryResponseNonNullableFields>;
|
|
4234
|
-
}
|
|
4235
|
-
declare function listCategoriesForItem$1(httpClient: HttpClient): ListCategoriesForItemSignature;
|
|
4236
|
-
interface ListCategoriesForItemSignature {
|
|
4237
|
-
/**
|
|
4238
|
-
* Retrieves a list of categories that contain the specified item.
|
|
4239
|
-
* @param - Item reference info.
|
|
4240
|
-
*/
|
|
4241
|
-
(item: ItemReference, options: ListCategoriesForItemOptions): Promise<ListCategoriesForItemResponse & ListCategoriesForItemResponseNonNullableFields>;
|
|
4242
|
-
}
|
|
4243
|
-
declare function listTrees$1(httpClient: HttpClient): ListTreesSignature;
|
|
4244
|
-
interface ListTreesSignature {
|
|
4245
|
-
/**
|
|
4246
|
-
* Retrieves a list of all trees installed on the site, sorted by `appNamespace` in ascending order.
|
|
4247
|
-
*/
|
|
4248
|
-
(): Promise<ListTreesResponse & ListTreesResponseNonNullableFields>;
|
|
4249
|
-
}
|
|
4250
|
-
declare function setArrangedItems$1(httpClient: HttpClient): SetArrangedItemsSignature;
|
|
4251
|
-
interface SetArrangedItemsSignature {
|
|
4252
|
-
/**
|
|
4253
|
-
* Sets arranged items in a category.
|
|
4254
|
-
*
|
|
4255
|
-
* The order of items in the `items` array determines the order of items in the category.
|
|
4256
|
-
* The category's existing list of arranged items will be overridden.
|
|
4257
|
-
* @param - Category ID.
|
|
4258
|
-
* @param - Category tree reference details.
|
|
4259
|
-
*/
|
|
4260
|
-
(categoryId: string, treeReference: TreeReference, options?: SetArrangedItemsOptions | undefined): Promise<SetArrangedItemsResponse & SetArrangedItemsResponseNonNullableFields>;
|
|
4261
|
-
}
|
|
4262
|
-
declare function getArrangedItems$1(httpClient: HttpClient): GetArrangedItemsSignature;
|
|
4263
|
-
interface GetArrangedItemsSignature {
|
|
4264
|
-
/**
|
|
4265
|
-
* Retrieves a list of arranged items in a category.
|
|
4266
|
-
* @param - Category ID.
|
|
4267
|
-
* @param - Category tree reference details.
|
|
4268
|
-
*/
|
|
4269
|
-
(categoryId: string, treeReference: TreeReference): Promise<GetArrangedItemsResponse & GetArrangedItemsResponseNonNullableFields>;
|
|
4270
|
-
}
|
|
4271
|
-
declare const onCategoryMoved$1: EventDefinition<CategoryMovedEnvelope, "wix.categories.v1.category_category_moved">;
|
|
4272
|
-
declare const onCategoryCreated$1: EventDefinition<CategoryCreatedEnvelope, "wix.categories.v1.category_created">;
|
|
4273
|
-
declare const onCategoryDeleted$1: EventDefinition<CategoryDeletedEnvelope, "wix.categories.v1.category_deleted">;
|
|
4274
|
-
declare const onCategoryItemAddedToCategory$1: EventDefinition<CategoryItemAddedToCategoryEnvelope, "wix.categories.v1.category_item_added_to_category">;
|
|
4275
|
-
declare const onCategoryItemRemovedFromCategory$1: EventDefinition<CategoryItemRemovedFromCategoryEnvelope, "wix.categories.v1.category_item_removed_from_category">;
|
|
4276
|
-
declare const onCategoryItemsArrangedInCategory$1: EventDefinition<CategoryItemsArrangedInCategoryEnvelope, "wix.categories.v1.category_items_arranged_in_category">;
|
|
4277
|
-
declare const onCategoryUpdated$1: EventDefinition<CategoryUpdatedEnvelope, "wix.categories.v1.category_updated">;
|
|
4278
|
-
|
|
4279
|
-
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
4280
|
-
|
|
4281
|
-
declare const createCategory: MaybeContext<BuildRESTFunction<typeof createCategory$1> & typeof createCategory$1>;
|
|
4282
|
-
declare const getCategory: MaybeContext<BuildRESTFunction<typeof getCategory$1> & typeof getCategory$1>;
|
|
4283
|
-
declare const updateCategory: MaybeContext<BuildRESTFunction<typeof updateCategory$1> & typeof updateCategory$1>;
|
|
4284
|
-
declare const deleteCategory: MaybeContext<BuildRESTFunction<typeof deleteCategory$1> & typeof deleteCategory$1>;
|
|
4285
|
-
declare const queryCategories: MaybeContext<BuildRESTFunction<typeof queryCategories$1> & typeof queryCategories$1>;
|
|
4286
|
-
declare const searchCategories: MaybeContext<BuildRESTFunction<typeof searchCategories$1> & typeof searchCategories$1>;
|
|
4287
|
-
declare const countCategories: MaybeContext<BuildRESTFunction<typeof countCategories$1> & typeof countCategories$1>;
|
|
4288
|
-
declare const moveCategory: MaybeContext<BuildRESTFunction<typeof moveCategory$1> & typeof moveCategory$1>;
|
|
4289
|
-
declare const bulkUpdateCategories: MaybeContext<BuildRESTFunction<typeof bulkUpdateCategories$1> & typeof bulkUpdateCategories$1>;
|
|
4290
|
-
declare const updateCategoryVisibility: MaybeContext<BuildRESTFunction<typeof updateCategoryVisibility$1> & typeof updateCategoryVisibility$1>;
|
|
4291
|
-
declare const bulkShowCategories: MaybeContext<BuildRESTFunction<typeof bulkShowCategories$1> & typeof bulkShowCategories$1>;
|
|
4292
|
-
declare const bulkAddItemsToCategory: MaybeContext<BuildRESTFunction<typeof bulkAddItemsToCategory$1> & typeof bulkAddItemsToCategory$1>;
|
|
4293
|
-
declare const bulkAddItemToCategories: MaybeContext<BuildRESTFunction<typeof bulkAddItemToCategories$1> & typeof bulkAddItemToCategories$1>;
|
|
4294
|
-
declare const bulkRemoveItemsFromCategory: MaybeContext<BuildRESTFunction<typeof bulkRemoveItemsFromCategory$1> & typeof bulkRemoveItemsFromCategory$1>;
|
|
4295
|
-
declare const bulkRemoveItemFromCategories: MaybeContext<BuildRESTFunction<typeof bulkRemoveItemFromCategories$1> & typeof bulkRemoveItemFromCategories$1>;
|
|
4296
|
-
declare const listItemsInCategory: MaybeContext<BuildRESTFunction<typeof listItemsInCategory$1> & typeof listItemsInCategory$1>;
|
|
4297
|
-
declare const listCategoriesForItem: MaybeContext<BuildRESTFunction<typeof listCategoriesForItem$1> & typeof listCategoriesForItem$1>;
|
|
4298
|
-
declare const listTrees: MaybeContext<BuildRESTFunction<typeof listTrees$1> & typeof listTrees$1>;
|
|
4299
|
-
declare const setArrangedItems: MaybeContext<BuildRESTFunction<typeof setArrangedItems$1> & typeof setArrangedItems$1>;
|
|
4300
|
-
declare const getArrangedItems: MaybeContext<BuildRESTFunction<typeof getArrangedItems$1> & typeof getArrangedItems$1>;
|
|
4301
|
-
|
|
4302
|
-
type _publicOnCategoryMovedType = typeof onCategoryMoved$1;
|
|
4303
|
-
/**
|
|
4304
|
-
* Triggered when a category is moved.
|
|
4305
|
-
*/
|
|
4306
|
-
declare const onCategoryMoved: ReturnType<typeof createEventModule<_publicOnCategoryMovedType>>;
|
|
4307
|
-
|
|
4308
|
-
type _publicOnCategoryCreatedType = typeof onCategoryCreated$1;
|
|
4309
|
-
/** */
|
|
4310
|
-
declare const onCategoryCreated: ReturnType<typeof createEventModule<_publicOnCategoryCreatedType>>;
|
|
4311
|
-
|
|
4312
|
-
type _publicOnCategoryDeletedType = typeof onCategoryDeleted$1;
|
|
4313
|
-
/** */
|
|
4314
|
-
declare const onCategoryDeleted: ReturnType<typeof createEventModule<_publicOnCategoryDeletedType>>;
|
|
4315
|
-
|
|
4316
|
-
type _publicOnCategoryItemAddedToCategoryType = typeof onCategoryItemAddedToCategory$1;
|
|
4317
|
-
/**
|
|
4318
|
-
* Triggered when an item is added to a category.
|
|
4319
|
-
*/
|
|
4320
|
-
declare const onCategoryItemAddedToCategory: ReturnType<typeof createEventModule<_publicOnCategoryItemAddedToCategoryType>>;
|
|
4321
|
-
|
|
4322
|
-
type _publicOnCategoryItemRemovedFromCategoryType = typeof onCategoryItemRemovedFromCategory$1;
|
|
4323
|
-
/**
|
|
4324
|
-
* Triggered when an item is removed from a category.
|
|
4325
|
-
*/
|
|
4326
|
-
declare const onCategoryItemRemovedFromCategory: ReturnType<typeof createEventModule<_publicOnCategoryItemRemovedFromCategoryType>>;
|
|
4327
|
-
|
|
4328
|
-
type _publicOnCategoryItemsArrangedInCategoryType = typeof onCategoryItemsArrangedInCategory$1;
|
|
4329
|
-
/**
|
|
4330
|
-
* Triggered when items arrangement in category is changed.
|
|
4331
|
-
*/
|
|
4332
|
-
declare const onCategoryItemsArrangedInCategory: ReturnType<typeof createEventModule<_publicOnCategoryItemsArrangedInCategoryType>>;
|
|
4333
|
-
|
|
4334
|
-
type _publicOnCategoryUpdatedType = typeof onCategoryUpdated$1;
|
|
4335
|
-
/** */
|
|
4336
|
-
declare const onCategoryUpdated: ReturnType<typeof createEventModule<_publicOnCategoryUpdatedType>>;
|
|
4337
|
-
|
|
4338
|
-
type context_ActionEvent = ActionEvent;
|
|
4339
|
-
type context_Aggregation = Aggregation;
|
|
4340
|
-
type context_AggregationData = AggregationData;
|
|
4341
|
-
type context_AggregationKindOneOf = AggregationKindOneOf;
|
|
4342
|
-
type context_AggregationResults = AggregationResults;
|
|
4343
|
-
type context_AggregationResultsResultOneOf = AggregationResultsResultOneOf;
|
|
4344
|
-
type context_AggregationResultsScalarResult = AggregationResultsScalarResult;
|
|
4345
|
-
type context_AggregationType = AggregationType;
|
|
4346
|
-
declare const context_AggregationType: typeof AggregationType;
|
|
4347
|
-
type context_Alignment = Alignment;
|
|
4348
|
-
declare const context_Alignment: typeof Alignment;
|
|
4349
|
-
type context_AnchorData = AnchorData;
|
|
4350
|
-
type context_App = App;
|
|
4351
|
-
type context_AppEmbedData = AppEmbedData;
|
|
4352
|
-
type context_AppEmbedDataAppDataOneOf = AppEmbedDataAppDataOneOf;
|
|
4353
|
-
type context_AppType = AppType;
|
|
4354
|
-
declare const context_AppType: typeof AppType;
|
|
4355
|
-
type context_ApplicationError = ApplicationError;
|
|
4356
|
-
type context_AudioData = AudioData;
|
|
4357
|
-
type context_Background = Background;
|
|
4358
|
-
type context_BackgroundBackgroundOneOf = BackgroundBackgroundOneOf;
|
|
4359
|
-
type context_BackgroundType = BackgroundType;
|
|
4360
|
-
declare const context_BackgroundType: typeof BackgroundType;
|
|
4361
|
-
type context_BaseEventMetadata = BaseEventMetadata;
|
|
4362
|
-
type context_BlockquoteData = BlockquoteData;
|
|
4363
|
-
type context_BookingData = BookingData;
|
|
4364
|
-
type context_Border = Border;
|
|
4365
|
-
type context_BorderColors = BorderColors;
|
|
4366
|
-
type context_Breadcrumb = Breadcrumb;
|
|
4367
|
-
type context_BreadcrumbsInfo = BreadcrumbsInfo;
|
|
4368
|
-
type context_BulkActionMetadata = BulkActionMetadata;
|
|
4369
|
-
type context_BulkAddItemToCategoriesOptions = BulkAddItemToCategoriesOptions;
|
|
4370
|
-
type context_BulkAddItemToCategoriesRequest = BulkAddItemToCategoriesRequest;
|
|
4371
|
-
type context_BulkAddItemToCategoriesResponse = BulkAddItemToCategoriesResponse;
|
|
4372
|
-
type context_BulkAddItemToCategoriesResponseNonNullableFields = BulkAddItemToCategoriesResponseNonNullableFields;
|
|
4373
|
-
type context_BulkAddItemsToCategoryOptions = BulkAddItemsToCategoryOptions;
|
|
4374
|
-
type context_BulkAddItemsToCategoryRequest = BulkAddItemsToCategoryRequest;
|
|
4375
|
-
type context_BulkAddItemsToCategoryResponse = BulkAddItemsToCategoryResponse;
|
|
4376
|
-
type context_BulkAddItemsToCategoryResponseNonNullableFields = BulkAddItemsToCategoryResponseNonNullableFields;
|
|
4377
|
-
type context_BulkCategoriesResult = BulkCategoriesResult;
|
|
4378
|
-
type context_BulkCreateCategoriesRequest = BulkCreateCategoriesRequest;
|
|
4379
|
-
type context_BulkCreateCategoriesResponse = BulkCreateCategoriesResponse;
|
|
4380
|
-
type context_BulkDeleteCategoriesByFilterRequest = BulkDeleteCategoriesByFilterRequest;
|
|
4381
|
-
type context_BulkDeleteCategoriesByFilterResponse = BulkDeleteCategoriesByFilterResponse;
|
|
4382
|
-
type context_BulkDeleteCategoriesRequest = BulkDeleteCategoriesRequest;
|
|
4383
|
-
type context_BulkDeleteCategoriesResponse = BulkDeleteCategoriesResponse;
|
|
4384
|
-
type context_BulkDeleteCategoriesResponseBulkCategoriesResult = BulkDeleteCategoriesResponseBulkCategoriesResult;
|
|
4385
|
-
type context_BulkItemToCategoriesResult = BulkItemToCategoriesResult;
|
|
4386
|
-
type context_BulkItemsToCategoryResult = BulkItemsToCategoryResult;
|
|
4387
|
-
type context_BulkRemoveItemFromCategoriesOptions = BulkRemoveItemFromCategoriesOptions;
|
|
4388
|
-
type context_BulkRemoveItemFromCategoriesRequest = BulkRemoveItemFromCategoriesRequest;
|
|
4389
|
-
type context_BulkRemoveItemFromCategoriesResponse = BulkRemoveItemFromCategoriesResponse;
|
|
4390
|
-
type context_BulkRemoveItemFromCategoriesResponseNonNullableFields = BulkRemoveItemFromCategoriesResponseNonNullableFields;
|
|
4391
|
-
type context_BulkRemoveItemsFromCategoryOptions = BulkRemoveItemsFromCategoryOptions;
|
|
4392
|
-
type context_BulkRemoveItemsFromCategoryRequest = BulkRemoveItemsFromCategoryRequest;
|
|
4393
|
-
type context_BulkRemoveItemsFromCategoryResponse = BulkRemoveItemsFromCategoryResponse;
|
|
4394
|
-
type context_BulkRemoveItemsFromCategoryResponseNonNullableFields = BulkRemoveItemsFromCategoryResponseNonNullableFields;
|
|
4395
|
-
type context_BulkShowCategoriesOptions = BulkShowCategoriesOptions;
|
|
4396
|
-
type context_BulkShowCategoriesRequest = BulkShowCategoriesRequest;
|
|
4397
|
-
type context_BulkShowCategoriesResponse = BulkShowCategoriesResponse;
|
|
4398
|
-
type context_BulkShowCategoriesResponseNonNullableFields = BulkShowCategoriesResponseNonNullableFields;
|
|
4399
|
-
type context_BulkUpdateCategoriesOptions = BulkUpdateCategoriesOptions;
|
|
4400
|
-
type context_BulkUpdateCategoriesRequest = BulkUpdateCategoriesRequest;
|
|
4401
|
-
type context_BulkUpdateCategoriesResponse = BulkUpdateCategoriesResponse;
|
|
4402
|
-
type context_BulkUpdateCategoriesResponseNonNullableFields = BulkUpdateCategoriesResponseNonNullableFields;
|
|
4403
|
-
type context_BulkUpdateCategoryVisibilityByFilterRequest = BulkUpdateCategoryVisibilityByFilterRequest;
|
|
4404
|
-
type context_BulkUpdateCategoryVisibilityByFilterResponse = BulkUpdateCategoryVisibilityByFilterResponse;
|
|
4405
|
-
type context_BulletedListData = BulletedListData;
|
|
4406
|
-
type context_ButtonData = ButtonData;
|
|
4407
|
-
type context_CaptionData = CaptionData;
|
|
4408
|
-
type context_CategoriesQueryBuilder = CategoriesQueryBuilder;
|
|
4409
|
-
type context_CategoriesQueryResult = CategoriesQueryResult;
|
|
4410
|
-
type context_Category = Category;
|
|
4411
|
-
type context_CategoryCreatedEnvelope = CategoryCreatedEnvelope;
|
|
4412
|
-
type context_CategoryDeletedEnvelope = CategoryDeletedEnvelope;
|
|
4413
|
-
type context_CategoryItemAddedToCategoryEnvelope = CategoryItemAddedToCategoryEnvelope;
|
|
4414
|
-
type context_CategoryItemRemovedFromCategoryEnvelope = CategoryItemRemovedFromCategoryEnvelope;
|
|
4415
|
-
type context_CategoryItemsArrangedInCategoryEnvelope = CategoryItemsArrangedInCategoryEnvelope;
|
|
4416
|
-
type context_CategoryMoved = CategoryMoved;
|
|
4417
|
-
type context_CategoryMovedEnvelope = CategoryMovedEnvelope;
|
|
4418
|
-
type context_CategoryNonNullableFields = CategoryNonNullableFields;
|
|
4419
|
-
type context_CategoryTreeNode = CategoryTreeNode;
|
|
4420
|
-
type context_CategoryUpdatedEnvelope = CategoryUpdatedEnvelope;
|
|
4421
|
-
type context_CellStyle = CellStyle;
|
|
4422
|
-
type context_CodeBlockData = CodeBlockData;
|
|
4423
|
-
type context_CollapsibleListData = CollapsibleListData;
|
|
4424
|
-
type context_ColorData = ColorData;
|
|
4425
|
-
type context_Colors = Colors;
|
|
4426
|
-
type context_CompactCategory = CompactCategory;
|
|
4427
|
-
type context_CountCategoriesOptions = CountCategoriesOptions;
|
|
4428
|
-
type context_CountCategoriesRequest = CountCategoriesRequest;
|
|
4429
|
-
type context_CountCategoriesResponse = CountCategoriesResponse;
|
|
4430
|
-
type context_CountCategoriesResponseNonNullableFields = CountCategoriesResponseNonNullableFields;
|
|
4431
|
-
type context_CreateCategoryOptions = CreateCategoryOptions;
|
|
4432
|
-
type context_CreateCategoryRequest = CreateCategoryRequest;
|
|
4433
|
-
type context_CreateCategoryResponse = CreateCategoryResponse;
|
|
4434
|
-
type context_CreateCategoryResponseNonNullableFields = CreateCategoryResponseNonNullableFields;
|
|
4435
|
-
type context_Crop = Crop;
|
|
4436
|
-
declare const context_Crop: typeof Crop;
|
|
4437
|
-
type context_CursorPaging = CursorPaging;
|
|
4438
|
-
type context_CursorPagingMetadata = CursorPagingMetadata;
|
|
4439
|
-
type context_CursorQuery = CursorQuery;
|
|
4440
|
-
type context_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;
|
|
4441
|
-
type context_CursorSearch = CursorSearch;
|
|
4442
|
-
type context_CursorSearchPagingMethodOneOf = CursorSearchPagingMethodOneOf;
|
|
4443
|
-
type context_Cursors = Cursors;
|
|
4444
|
-
type context_DateHistogramAggregation = DateHistogramAggregation;
|
|
4445
|
-
type context_DateHistogramResult = DateHistogramResult;
|
|
4446
|
-
type context_DateHistogramResults = DateHistogramResults;
|
|
4447
|
-
type context_Decoration = Decoration;
|
|
4448
|
-
type context_DecorationDataOneOf = DecorationDataOneOf;
|
|
4449
|
-
type context_DecorationType = DecorationType;
|
|
4450
|
-
declare const context_DecorationType: typeof DecorationType;
|
|
4451
|
-
type context_DeleteCategoryRequest = DeleteCategoryRequest;
|
|
4452
|
-
type context_DeleteCategoryResponse = DeleteCategoryResponse;
|
|
4453
|
-
type context_DeprecatedSearchCategoriesWithOffsetRequest = DeprecatedSearchCategoriesWithOffsetRequest;
|
|
4454
|
-
type context_DeprecatedSearchCategoriesWithOffsetResponse = DeprecatedSearchCategoriesWithOffsetResponse;
|
|
4455
|
-
type context_Design = Design;
|
|
4456
|
-
type context_Dimensions = Dimensions;
|
|
4457
|
-
type context_Direction = Direction;
|
|
4458
|
-
declare const context_Direction: typeof Direction;
|
|
4459
|
-
type context_DividerData = DividerData;
|
|
4460
|
-
type context_DocumentStyle = DocumentStyle;
|
|
4461
|
-
type context_DomainEvent = DomainEvent;
|
|
4462
|
-
type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
|
|
4463
|
-
type context_EmbedData = EmbedData;
|
|
4464
|
-
type context_Empty = Empty;
|
|
4465
|
-
type context_EntityCreatedEvent = EntityCreatedEvent;
|
|
4466
|
-
type context_EntityDeletedEvent = EntityDeletedEvent;
|
|
4467
|
-
type context_EntityUpdatedEvent = EntityUpdatedEvent;
|
|
4468
|
-
type context_EventData = EventData;
|
|
4469
|
-
type context_EventMetadata = EventMetadata;
|
|
4470
|
-
type context_ExtendedFields = ExtendedFields;
|
|
4471
|
-
type context_File = File;
|
|
4472
|
-
type context_FileData = FileData;
|
|
4473
|
-
type context_FileSource = FileSource;
|
|
4474
|
-
type context_FileSourceDataOneOf = FileSourceDataOneOf;
|
|
4475
|
-
type context_FontSizeData = FontSizeData;
|
|
4476
|
-
type context_FontType = FontType;
|
|
4477
|
-
declare const context_FontType: typeof FontType;
|
|
4478
|
-
type context_GIF = GIF;
|
|
4479
|
-
type context_GIFData = GIFData;
|
|
4480
|
-
type context_GalleryData = GalleryData;
|
|
4481
|
-
type context_GalleryOptions = GalleryOptions;
|
|
4482
|
-
type context_GetArrangedItemsRequest = GetArrangedItemsRequest;
|
|
4483
|
-
type context_GetArrangedItemsResponse = GetArrangedItemsResponse;
|
|
4484
|
-
type context_GetArrangedItemsResponseNonNullableFields = GetArrangedItemsResponseNonNullableFields;
|
|
4485
|
-
type context_GetCategoriesTreeRequest = GetCategoriesTreeRequest;
|
|
4486
|
-
type context_GetCategoriesTreeResponse = GetCategoriesTreeResponse;
|
|
4487
|
-
type context_GetCategoryOptions = GetCategoryOptions;
|
|
4488
|
-
type context_GetCategoryRequest = GetCategoryRequest;
|
|
4489
|
-
type context_GetCategoryResponse = GetCategoryResponse;
|
|
4490
|
-
type context_GetCategoryResponseNonNullableFields = GetCategoryResponseNonNullableFields;
|
|
4491
|
-
type context_Gradient = Gradient;
|
|
4492
|
-
type context_GroupByValueResults = GroupByValueResults;
|
|
4493
|
-
type context_HTMLData = HTMLData;
|
|
4494
|
-
type context_HTMLDataDataOneOf = HTMLDataDataOneOf;
|
|
4495
|
-
type context_HeadingData = HeadingData;
|
|
4496
|
-
type context_Height = Height;
|
|
4497
|
-
type context_IdentificationData = IdentificationData;
|
|
4498
|
-
type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
|
|
4499
|
-
type context_Image = Image;
|
|
4500
|
-
type context_ImageData = ImageData;
|
|
4501
|
-
type context_IncludeMissingValuesOptions = IncludeMissingValuesOptions;
|
|
4502
|
-
type context_InitialExpandedItems = InitialExpandedItems;
|
|
4503
|
-
declare const context_InitialExpandedItems: typeof InitialExpandedItems;
|
|
4504
|
-
type context_Interval = Interval;
|
|
4505
|
-
declare const context_Interval: typeof Interval;
|
|
4506
|
-
type context_InvalidateCache = InvalidateCache;
|
|
4507
|
-
type context_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;
|
|
4508
|
-
type context_Item = Item;
|
|
4509
|
-
type context_ItemAddedToCategory = ItemAddedToCategory;
|
|
4510
|
-
type context_ItemDataOneOf = ItemDataOneOf;
|
|
4511
|
-
type context_ItemMetadata = ItemMetadata;
|
|
4512
|
-
type context_ItemReference = ItemReference;
|
|
4513
|
-
type context_ItemReferenceMetadata = ItemReferenceMetadata;
|
|
4514
|
-
type context_ItemRemovedFromCategory = ItemRemovedFromCategory;
|
|
4515
|
-
type context_ItemStyle = ItemStyle;
|
|
4516
|
-
type context_ItemsAddedToCategory = ItemsAddedToCategory;
|
|
4517
|
-
type context_ItemsArrangedInCategory = ItemsArrangedInCategory;
|
|
4518
|
-
type context_ItemsRemovedFromCategory = ItemsRemovedFromCategory;
|
|
4519
|
-
type context_Keyword = Keyword;
|
|
4520
|
-
type context_Layout = Layout;
|
|
4521
|
-
type context_LayoutType = LayoutType;
|
|
4522
|
-
declare const context_LayoutType: typeof LayoutType;
|
|
4523
|
-
type context_LineStyle = LineStyle;
|
|
4524
|
-
declare const context_LineStyle: typeof LineStyle;
|
|
4525
|
-
type context_Link = Link;
|
|
4526
|
-
type context_LinkData = LinkData;
|
|
4527
|
-
type context_LinkDataOneOf = LinkDataOneOf;
|
|
4528
|
-
type context_LinkPreviewData = LinkPreviewData;
|
|
4529
|
-
type context_ListCategoriesForItemOptions = ListCategoriesForItemOptions;
|
|
4530
|
-
type context_ListCategoriesForItemRequest = ListCategoriesForItemRequest;
|
|
4531
|
-
type context_ListCategoriesForItemResponse = ListCategoriesForItemResponse;
|
|
4532
|
-
type context_ListCategoriesForItemResponseNonNullableFields = ListCategoriesForItemResponseNonNullableFields;
|
|
4533
|
-
type context_ListCompactCategoriesByIdsRequest = ListCompactCategoriesByIdsRequest;
|
|
4534
|
-
type context_ListCompactCategoriesByIdsResponse = ListCompactCategoriesByIdsResponse;
|
|
4535
|
-
type context_ListItemsInCategoryOptions = ListItemsInCategoryOptions;
|
|
4536
|
-
type context_ListItemsInCategoryRequest = ListItemsInCategoryRequest;
|
|
4537
|
-
type context_ListItemsInCategoryRequestPagingMethodOneOf = ListItemsInCategoryRequestPagingMethodOneOf;
|
|
4538
|
-
type context_ListItemsInCategoryResponse = ListItemsInCategoryResponse;
|
|
4539
|
-
type context_ListItemsInCategoryResponseNonNullableFields = ListItemsInCategoryResponseNonNullableFields;
|
|
4540
|
-
type context_ListTreesRequest = ListTreesRequest;
|
|
4541
|
-
type context_ListTreesResponse = ListTreesResponse;
|
|
4542
|
-
type context_ListTreesResponseNonNullableFields = ListTreesResponseNonNullableFields;
|
|
4543
|
-
type context_ListValue = ListValue;
|
|
4544
|
-
type context_MapData = MapData;
|
|
4545
|
-
type context_MapSettings = MapSettings;
|
|
4546
|
-
type context_MapType = MapType;
|
|
4547
|
-
declare const context_MapType: typeof MapType;
|
|
4548
|
-
type context_MaskedCategory = MaskedCategory;
|
|
4549
|
-
type context_Media = Media;
|
|
4550
|
-
type context_MentionData = MentionData;
|
|
4551
|
-
type context_MessageEnvelope = MessageEnvelope;
|
|
4552
|
-
type context_Metadata = Metadata;
|
|
4553
|
-
type context_MissingValues = MissingValues;
|
|
4554
|
-
declare const context_MissingValues: typeof MissingValues;
|
|
4555
|
-
type context_Mode = Mode;
|
|
4556
|
-
declare const context_Mode: typeof Mode;
|
|
4557
|
-
type context_MoveCategoryOptions = MoveCategoryOptions;
|
|
4558
|
-
type context_MoveCategoryRequest = MoveCategoryRequest;
|
|
4559
|
-
type context_MoveCategoryResponse = MoveCategoryResponse;
|
|
4560
|
-
type context_MoveCategoryResponseNonNullableFields = MoveCategoryResponseNonNullableFields;
|
|
4561
|
-
type context_MoveItemInCategoryRequest = MoveItemInCategoryRequest;
|
|
4562
|
-
type context_MoveItemInCategoryRequestPosition = MoveItemInCategoryRequestPosition;
|
|
4563
|
-
declare const context_MoveItemInCategoryRequestPosition: typeof MoveItemInCategoryRequestPosition;
|
|
4564
|
-
type context_MoveItemInCategoryResponse = MoveItemInCategoryResponse;
|
|
4565
|
-
type context_NestedAggregation = NestedAggregation;
|
|
4566
|
-
type context_NestedAggregationItem = NestedAggregationItem;
|
|
4567
|
-
type context_NestedAggregationItemKindOneOf = NestedAggregationItemKindOneOf;
|
|
4568
|
-
type context_NestedAggregationResults = NestedAggregationResults;
|
|
4569
|
-
type context_NestedAggregationResultsResultOneOf = NestedAggregationResultsResultOneOf;
|
|
4570
|
-
type context_NestedAggregationType = NestedAggregationType;
|
|
4571
|
-
declare const context_NestedAggregationType: typeof NestedAggregationType;
|
|
4572
|
-
type context_NestedResultValue = NestedResultValue;
|
|
4573
|
-
type context_NestedResultValueResultOneOf = NestedResultValueResultOneOf;
|
|
4574
|
-
type context_NestedResults = NestedResults;
|
|
4575
|
-
type context_NestedValueAggregationResult = NestedValueAggregationResult;
|
|
4576
|
-
type context_Node = Node;
|
|
4577
|
-
type context_NodeDataOneOf = NodeDataOneOf;
|
|
4578
|
-
type context_NodeStyle = NodeStyle;
|
|
4579
|
-
type context_NodeType = NodeType;
|
|
4580
|
-
declare const context_NodeType: typeof NodeType;
|
|
4581
|
-
type context_NullValue = NullValue;
|
|
4582
|
-
declare const context_NullValue: typeof NullValue;
|
|
4583
|
-
type context_Oembed = Oembed;
|
|
4584
|
-
type context_OffsetSearch = OffsetSearch;
|
|
4585
|
-
type context_OffsetSearchPagingMethodOneOf = OffsetSearchPagingMethodOneOf;
|
|
4586
|
-
type context_Option = Option;
|
|
4587
|
-
type context_OptionDesign = OptionDesign;
|
|
4588
|
-
type context_OptionLayout = OptionLayout;
|
|
4589
|
-
type context_OrderedListData = OrderedListData;
|
|
4590
|
-
type context_Orientation = Orientation;
|
|
4591
|
-
declare const context_Orientation: typeof Orientation;
|
|
4592
|
-
type context_PDFSettings = PDFSettings;
|
|
4593
|
-
type context_Page = Page;
|
|
4594
|
-
type context_Paging = Paging;
|
|
4595
|
-
type context_PagingMetadata = PagingMetadata;
|
|
4596
|
-
type context_PagingMetadataV2 = PagingMetadataV2;
|
|
4597
|
-
type context_ParagraphData = ParagraphData;
|
|
4598
|
-
type context_ParentCategory = ParentCategory;
|
|
4599
|
-
type context_Permissions = Permissions;
|
|
4600
|
-
type context_PlaybackOptions = PlaybackOptions;
|
|
4601
|
-
type context_PluginContainerData = PluginContainerData;
|
|
4602
|
-
type context_PluginContainerDataAlignment = PluginContainerDataAlignment;
|
|
4603
|
-
declare const context_PluginContainerDataAlignment: typeof PluginContainerDataAlignment;
|
|
4604
|
-
type context_PluginContainerDataWidth = PluginContainerDataWidth;
|
|
4605
|
-
type context_PluginContainerDataWidthDataOneOf = PluginContainerDataWidthDataOneOf;
|
|
4606
|
-
type context_Poll = Poll;
|
|
4607
|
-
type context_PollData = PollData;
|
|
4608
|
-
type context_PollDataLayout = PollDataLayout;
|
|
4609
|
-
type context_PollDesign = PollDesign;
|
|
4610
|
-
type context_PollLayout = PollLayout;
|
|
4611
|
-
type context_PollLayoutDirection = PollLayoutDirection;
|
|
4612
|
-
declare const context_PollLayoutDirection: typeof PollLayoutDirection;
|
|
4613
|
-
type context_PollLayoutType = PollLayoutType;
|
|
4614
|
-
declare const context_PollLayoutType: typeof PollLayoutType;
|
|
4615
|
-
type context_PollSettings = PollSettings;
|
|
4616
|
-
type context_Position = Position;
|
|
4617
|
-
declare const context_Position: typeof Position;
|
|
4618
|
-
type context_QueryCategoriesOptions = QueryCategoriesOptions;
|
|
4619
|
-
type context_QueryCategoriesRequest = QueryCategoriesRequest;
|
|
4620
|
-
type context_QueryCategoriesResponse = QueryCategoriesResponse;
|
|
4621
|
-
type context_QueryCategoriesResponseNonNullableFields = QueryCategoriesResponseNonNullableFields;
|
|
4622
|
-
type context_RangeAggregation = RangeAggregation;
|
|
4623
|
-
type context_RangeAggregationResult = RangeAggregationResult;
|
|
4624
|
-
type context_RangeBucket = RangeBucket;
|
|
4625
|
-
type context_RangeResult = RangeResult;
|
|
4626
|
-
type context_RangeResults = RangeResults;
|
|
4627
|
-
type context_Rel = Rel;
|
|
4628
|
-
type context_RequestedFields = RequestedFields;
|
|
4629
|
-
declare const context_RequestedFields: typeof RequestedFields;
|
|
4630
|
-
type context_RestoreInfo = RestoreInfo;
|
|
4631
|
-
type context_Results = Results;
|
|
4632
|
-
type context_RichContent = RichContent;
|
|
4633
|
-
type context_ScalarAggregation = ScalarAggregation;
|
|
4634
|
-
type context_ScalarResult = ScalarResult;
|
|
4635
|
-
type context_ScalarType = ScalarType;
|
|
4636
|
-
declare const context_ScalarType: typeof ScalarType;
|
|
4637
|
-
type context_SearchCategoriesOptions = SearchCategoriesOptions;
|
|
4638
|
-
type context_SearchCategoriesRequest = SearchCategoriesRequest;
|
|
4639
|
-
type context_SearchCategoriesResponse = SearchCategoriesResponse;
|
|
4640
|
-
type context_SearchCategoriesResponseNonNullableFields = SearchCategoriesResponseNonNullableFields;
|
|
4641
|
-
type context_SearchDetails = SearchDetails;
|
|
4642
|
-
type context_SeoSchema = SeoSchema;
|
|
4643
|
-
type context_SetArrangedItemsOptions = SetArrangedItemsOptions;
|
|
4644
|
-
type context_SetArrangedItemsRequest = SetArrangedItemsRequest;
|
|
4645
|
-
type context_SetArrangedItemsResponse = SetArrangedItemsResponse;
|
|
4646
|
-
type context_SetArrangedItemsResponseNonNullableFields = SetArrangedItemsResponseNonNullableFields;
|
|
4647
|
-
type context_Settings = Settings;
|
|
4648
|
-
type context_SingleEntityOpsRequestedFields = SingleEntityOpsRequestedFields;
|
|
4649
|
-
declare const context_SingleEntityOpsRequestedFields: typeof SingleEntityOpsRequestedFields;
|
|
4650
|
-
type context_SortDirection = SortDirection;
|
|
4651
|
-
declare const context_SortDirection: typeof SortDirection;
|
|
4652
|
-
type context_SortOrder = SortOrder;
|
|
4653
|
-
declare const context_SortOrder: typeof SortOrder;
|
|
4654
|
-
type context_SortType = SortType;
|
|
4655
|
-
declare const context_SortType: typeof SortType;
|
|
4656
|
-
type context_Sorting = Sorting;
|
|
4657
|
-
type context_Source = Source;
|
|
4658
|
-
declare const context_Source: typeof Source;
|
|
4659
|
-
type context_Spoiler = Spoiler;
|
|
4660
|
-
type context_SpoilerData = SpoilerData;
|
|
4661
|
-
type context_Styles = Styles;
|
|
4662
|
-
type context_TableCellData = TableCellData;
|
|
4663
|
-
type context_TableData = TableData;
|
|
4664
|
-
type context_Tag = Tag;
|
|
4665
|
-
type context_Target = Target;
|
|
4666
|
-
declare const context_Target: typeof Target;
|
|
4667
|
-
type context_TextAlignment = TextAlignment;
|
|
4668
|
-
declare const context_TextAlignment: typeof TextAlignment;
|
|
4669
|
-
type context_TextData = TextData;
|
|
4670
|
-
type context_TextNodeStyle = TextNodeStyle;
|
|
4671
|
-
type context_TextStyle = TextStyle;
|
|
4672
|
-
type context_Thumbnails = Thumbnails;
|
|
4673
|
-
type context_ThumbnailsAlignment = ThumbnailsAlignment;
|
|
4674
|
-
declare const context_ThumbnailsAlignment: typeof ThumbnailsAlignment;
|
|
4675
|
-
type context_TreeReference = TreeReference;
|
|
4676
|
-
type context_Type = Type;
|
|
4677
|
-
declare const context_Type: typeof Type;
|
|
4678
|
-
type context_URI = URI;
|
|
4679
|
-
type context_UpdateCategory = UpdateCategory;
|
|
4680
|
-
type context_UpdateCategoryOptions = UpdateCategoryOptions;
|
|
4681
|
-
type context_UpdateCategoryRequest = UpdateCategoryRequest;
|
|
4682
|
-
type context_UpdateCategoryResponse = UpdateCategoryResponse;
|
|
4683
|
-
type context_UpdateCategoryResponseNonNullableFields = UpdateCategoryResponseNonNullableFields;
|
|
4684
|
-
type context_UpdateCategoryVisibilityOptions = UpdateCategoryVisibilityOptions;
|
|
4685
|
-
type context_UpdateCategoryVisibilityRequest = UpdateCategoryVisibilityRequest;
|
|
4686
|
-
type context_UpdateCategoryVisibilityResponse = UpdateCategoryVisibilityResponse;
|
|
4687
|
-
type context_UpdateCategoryVisibilityResponseNonNullableFields = UpdateCategoryVisibilityResponseNonNullableFields;
|
|
4688
|
-
type context_ValueAggregation = ValueAggregation;
|
|
4689
|
-
type context_ValueAggregationOptionsOneOf = ValueAggregationOptionsOneOf;
|
|
4690
|
-
type context_ValueAggregationResult = ValueAggregationResult;
|
|
4691
|
-
type context_ValueResult = ValueResult;
|
|
4692
|
-
type context_ValueResults = ValueResults;
|
|
4693
|
-
type context_VerticalAlignment = VerticalAlignment;
|
|
4694
|
-
declare const context_VerticalAlignment: typeof VerticalAlignment;
|
|
4695
|
-
type context_Video = Video;
|
|
4696
|
-
type context_VideoData = VideoData;
|
|
4697
|
-
type context_ViewMode = ViewMode;
|
|
4698
|
-
declare const context_ViewMode: typeof ViewMode;
|
|
4699
|
-
type context_ViewRole = ViewRole;
|
|
4700
|
-
declare const context_ViewRole: typeof ViewRole;
|
|
4701
|
-
type context_VoteRole = VoteRole;
|
|
4702
|
-
declare const context_VoteRole: typeof VoteRole;
|
|
4703
|
-
type context_WebhookIdentityType = WebhookIdentityType;
|
|
4704
|
-
declare const context_WebhookIdentityType: typeof WebhookIdentityType;
|
|
4705
|
-
type context_Width = Width;
|
|
4706
|
-
declare const context_Width: typeof Width;
|
|
4707
|
-
type context_WidthType = WidthType;
|
|
4708
|
-
declare const context_WidthType: typeof WidthType;
|
|
4709
|
-
type context__publicOnCategoryCreatedType = _publicOnCategoryCreatedType;
|
|
4710
|
-
type context__publicOnCategoryDeletedType = _publicOnCategoryDeletedType;
|
|
4711
|
-
type context__publicOnCategoryItemAddedToCategoryType = _publicOnCategoryItemAddedToCategoryType;
|
|
4712
|
-
type context__publicOnCategoryItemRemovedFromCategoryType = _publicOnCategoryItemRemovedFromCategoryType;
|
|
4713
|
-
type context__publicOnCategoryItemsArrangedInCategoryType = _publicOnCategoryItemsArrangedInCategoryType;
|
|
4714
|
-
type context__publicOnCategoryMovedType = _publicOnCategoryMovedType;
|
|
4715
|
-
type context__publicOnCategoryUpdatedType = _publicOnCategoryUpdatedType;
|
|
4716
|
-
declare const context_bulkAddItemToCategories: typeof bulkAddItemToCategories;
|
|
4717
|
-
declare const context_bulkAddItemsToCategory: typeof bulkAddItemsToCategory;
|
|
4718
|
-
declare const context_bulkRemoveItemFromCategories: typeof bulkRemoveItemFromCategories;
|
|
4719
|
-
declare const context_bulkRemoveItemsFromCategory: typeof bulkRemoveItemsFromCategory;
|
|
4720
|
-
declare const context_bulkShowCategories: typeof bulkShowCategories;
|
|
4721
|
-
declare const context_bulkUpdateCategories: typeof bulkUpdateCategories;
|
|
4722
|
-
declare const context_countCategories: typeof countCategories;
|
|
4723
|
-
declare const context_createCategory: typeof createCategory;
|
|
4724
|
-
declare const context_deleteCategory: typeof deleteCategory;
|
|
4725
|
-
declare const context_getArrangedItems: typeof getArrangedItems;
|
|
4726
|
-
declare const context_getCategory: typeof getCategory;
|
|
4727
|
-
declare const context_listCategoriesForItem: typeof listCategoriesForItem;
|
|
4728
|
-
declare const context_listItemsInCategory: typeof listItemsInCategory;
|
|
4729
|
-
declare const context_listTrees: typeof listTrees;
|
|
4730
|
-
declare const context_moveCategory: typeof moveCategory;
|
|
4731
|
-
declare const context_onCategoryCreated: typeof onCategoryCreated;
|
|
4732
|
-
declare const context_onCategoryDeleted: typeof onCategoryDeleted;
|
|
4733
|
-
declare const context_onCategoryItemAddedToCategory: typeof onCategoryItemAddedToCategory;
|
|
4734
|
-
declare const context_onCategoryItemRemovedFromCategory: typeof onCategoryItemRemovedFromCategory;
|
|
4735
|
-
declare const context_onCategoryItemsArrangedInCategory: typeof onCategoryItemsArrangedInCategory;
|
|
4736
|
-
declare const context_onCategoryMoved: typeof onCategoryMoved;
|
|
4737
|
-
declare const context_onCategoryUpdated: typeof onCategoryUpdated;
|
|
4738
|
-
declare const context_queryCategories: typeof queryCategories;
|
|
4739
|
-
declare const context_searchCategories: typeof searchCategories;
|
|
4740
|
-
declare const context_setArrangedItems: typeof setArrangedItems;
|
|
4741
|
-
declare const context_updateCategory: typeof updateCategory;
|
|
4742
|
-
declare const context_updateCategoryVisibility: typeof updateCategoryVisibility;
|
|
4743
|
-
declare namespace context {
|
|
4744
|
-
export { type context_ActionEvent as ActionEvent, type context_Aggregation as Aggregation, type context_AggregationData as AggregationData, type context_AggregationKindOneOf as AggregationKindOneOf, type context_AggregationResults as AggregationResults, type context_AggregationResultsResultOneOf as AggregationResultsResultOneOf, type context_AggregationResultsScalarResult as AggregationResultsScalarResult, context_AggregationType as AggregationType, context_Alignment as Alignment, type context_AnchorData as AnchorData, type context_App as App, type context_AppEmbedData as AppEmbedData, type context_AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOf, context_AppType as AppType, type context_ApplicationError as ApplicationError, type context_AudioData as AudioData, type context_Background as Background, type context_BackgroundBackgroundOneOf as BackgroundBackgroundOneOf, context_BackgroundType as BackgroundType, type context_BaseEventMetadata as BaseEventMetadata, type context_BlockquoteData as BlockquoteData, type context_BookingData as BookingData, type context_Border as Border, type context_BorderColors as BorderColors, type context_Breadcrumb as Breadcrumb, type context_BreadcrumbsInfo as BreadcrumbsInfo, type context_BulkActionMetadata as BulkActionMetadata, type context_BulkAddItemToCategoriesOptions as BulkAddItemToCategoriesOptions, type context_BulkAddItemToCategoriesRequest as BulkAddItemToCategoriesRequest, type context_BulkAddItemToCategoriesResponse as BulkAddItemToCategoriesResponse, type context_BulkAddItemToCategoriesResponseNonNullableFields as BulkAddItemToCategoriesResponseNonNullableFields, type context_BulkAddItemsToCategoryOptions as BulkAddItemsToCategoryOptions, type context_BulkAddItemsToCategoryRequest as BulkAddItemsToCategoryRequest, type context_BulkAddItemsToCategoryResponse as BulkAddItemsToCategoryResponse, type context_BulkAddItemsToCategoryResponseNonNullableFields as BulkAddItemsToCategoryResponseNonNullableFields, type context_BulkCategoriesResult as BulkCategoriesResult, type context_BulkCreateCategoriesRequest as BulkCreateCategoriesRequest, type context_BulkCreateCategoriesResponse as BulkCreateCategoriesResponse, type context_BulkDeleteCategoriesByFilterRequest as BulkDeleteCategoriesByFilterRequest, type context_BulkDeleteCategoriesByFilterResponse as BulkDeleteCategoriesByFilterResponse, type context_BulkDeleteCategoriesRequest as BulkDeleteCategoriesRequest, type context_BulkDeleteCategoriesResponse as BulkDeleteCategoriesResponse, type context_BulkDeleteCategoriesResponseBulkCategoriesResult as BulkDeleteCategoriesResponseBulkCategoriesResult, type context_BulkItemToCategoriesResult as BulkItemToCategoriesResult, type context_BulkItemsToCategoryResult as BulkItemsToCategoryResult, type context_BulkRemoveItemFromCategoriesOptions as BulkRemoveItemFromCategoriesOptions, type context_BulkRemoveItemFromCategoriesRequest as BulkRemoveItemFromCategoriesRequest, type context_BulkRemoveItemFromCategoriesResponse as BulkRemoveItemFromCategoriesResponse, type context_BulkRemoveItemFromCategoriesResponseNonNullableFields as BulkRemoveItemFromCategoriesResponseNonNullableFields, type context_BulkRemoveItemsFromCategoryOptions as BulkRemoveItemsFromCategoryOptions, type context_BulkRemoveItemsFromCategoryRequest as BulkRemoveItemsFromCategoryRequest, type context_BulkRemoveItemsFromCategoryResponse as BulkRemoveItemsFromCategoryResponse, type context_BulkRemoveItemsFromCategoryResponseNonNullableFields as BulkRemoveItemsFromCategoryResponseNonNullableFields, type context_BulkShowCategoriesOptions as BulkShowCategoriesOptions, type context_BulkShowCategoriesRequest as BulkShowCategoriesRequest, type context_BulkShowCategoriesResponse as BulkShowCategoriesResponse, type context_BulkShowCategoriesResponseNonNullableFields as BulkShowCategoriesResponseNonNullableFields, type context_BulkUpdateCategoriesOptions as BulkUpdateCategoriesOptions, type context_BulkUpdateCategoriesRequest as BulkUpdateCategoriesRequest, type context_BulkUpdateCategoriesResponse as BulkUpdateCategoriesResponse, type context_BulkUpdateCategoriesResponseNonNullableFields as BulkUpdateCategoriesResponseNonNullableFields, type context_BulkUpdateCategoryVisibilityByFilterRequest as BulkUpdateCategoryVisibilityByFilterRequest, type context_BulkUpdateCategoryVisibilityByFilterResponse as BulkUpdateCategoryVisibilityByFilterResponse, type context_BulletedListData as BulletedListData, type context_ButtonData as ButtonData, type context_CaptionData as CaptionData, type context_CategoriesQueryBuilder as CategoriesQueryBuilder, type context_CategoriesQueryResult as CategoriesQueryResult, type context_Category as Category, type context_CategoryCreatedEnvelope as CategoryCreatedEnvelope, type context_CategoryDeletedEnvelope as CategoryDeletedEnvelope, type context_CategoryItemAddedToCategoryEnvelope as CategoryItemAddedToCategoryEnvelope, type context_CategoryItemRemovedFromCategoryEnvelope as CategoryItemRemovedFromCategoryEnvelope, type context_CategoryItemsArrangedInCategoryEnvelope as CategoryItemsArrangedInCategoryEnvelope, type context_CategoryMoved as CategoryMoved, type context_CategoryMovedEnvelope as CategoryMovedEnvelope, type context_CategoryNonNullableFields as CategoryNonNullableFields, type context_CategoryTreeNode as CategoryTreeNode, type context_CategoryUpdatedEnvelope as CategoryUpdatedEnvelope, type context_CellStyle as CellStyle, type context_CodeBlockData as CodeBlockData, type context_CollapsibleListData as CollapsibleListData, type context_ColorData as ColorData, type context_Colors as Colors, type context_CompactCategory as CompactCategory, type context_CountCategoriesOptions as CountCategoriesOptions, type context_CountCategoriesRequest as CountCategoriesRequest, type context_CountCategoriesResponse as CountCategoriesResponse, type context_CountCategoriesResponseNonNullableFields as CountCategoriesResponseNonNullableFields, type context_CreateCategoryOptions as CreateCategoryOptions, type context_CreateCategoryRequest as CreateCategoryRequest, type context_CreateCategoryResponse as CreateCategoryResponse, type context_CreateCategoryResponseNonNullableFields as CreateCategoryResponseNonNullableFields, context_Crop as Crop, type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_CursorQuery as CursorQuery, type context_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type context_CursorSearch as CursorSearch, type context_CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOf, type context_Cursors as Cursors, type context_DateHistogramAggregation as DateHistogramAggregation, type context_DateHistogramResult as DateHistogramResult, type context_DateHistogramResults as DateHistogramResults, type context_Decoration as Decoration, type context_DecorationDataOneOf as DecorationDataOneOf, context_DecorationType as DecorationType, type context_DeleteCategoryRequest as DeleteCategoryRequest, type context_DeleteCategoryResponse as DeleteCategoryResponse, type context_DeprecatedSearchCategoriesWithOffsetRequest as DeprecatedSearchCategoriesWithOffsetRequest, type context_DeprecatedSearchCategoriesWithOffsetResponse as DeprecatedSearchCategoriesWithOffsetResponse, type context_Design as Design, type context_Dimensions as Dimensions, context_Direction as Direction, type context_DividerData as DividerData, type context_DocumentStyle as DocumentStyle, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_EmbedData as EmbedData, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventData as EventData, type context_EventMetadata as EventMetadata, type context_ExtendedFields as ExtendedFields, type context_File as File, type context_FileData as FileData, type context_FileSource as FileSource, type context_FileSourceDataOneOf as FileSourceDataOneOf, type context_FontSizeData as FontSizeData, context_FontType as FontType, type context_GIF as GIF, type context_GIFData as GIFData, type context_GalleryData as GalleryData, type context_GalleryOptions as GalleryOptions, type context_GetArrangedItemsRequest as GetArrangedItemsRequest, type context_GetArrangedItemsResponse as GetArrangedItemsResponse, type context_GetArrangedItemsResponseNonNullableFields as GetArrangedItemsResponseNonNullableFields, type context_GetCategoriesTreeRequest as GetCategoriesTreeRequest, type context_GetCategoriesTreeResponse as GetCategoriesTreeResponse, type context_GetCategoryOptions as GetCategoryOptions, type context_GetCategoryRequest as GetCategoryRequest, type context_GetCategoryResponse as GetCategoryResponse, type context_GetCategoryResponseNonNullableFields as GetCategoryResponseNonNullableFields, type context_Gradient as Gradient, type context_GroupByValueResults as GroupByValueResults, type context_HTMLData as HTMLData, type context_HTMLDataDataOneOf as HTMLDataDataOneOf, type context_HeadingData as HeadingData, type context_Height as Height, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_Image as Image, type context_ImageData as ImageData, type context_IncludeMissingValuesOptions as IncludeMissingValuesOptions, context_InitialExpandedItems as InitialExpandedItems, context_Interval as Interval, type context_InvalidateCache as InvalidateCache, type context_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf, type context_Item as Item, type context_ItemAddedToCategory as ItemAddedToCategory, type context_ItemDataOneOf as ItemDataOneOf, type context_ItemMetadata as ItemMetadata, type context_ItemReference as ItemReference, type context_ItemReferenceMetadata as ItemReferenceMetadata, type context_ItemRemovedFromCategory as ItemRemovedFromCategory, type context_ItemStyle as ItemStyle, type context_ItemsAddedToCategory as ItemsAddedToCategory, type context_ItemsArrangedInCategory as ItemsArrangedInCategory, type context_ItemsRemovedFromCategory as ItemsRemovedFromCategory, type context_Keyword as Keyword, type context_Layout as Layout, context_LayoutType as LayoutType, context_LineStyle as LineStyle, type context_Link as Link, type context_LinkData as LinkData, type context_LinkDataOneOf as LinkDataOneOf, type context_LinkPreviewData as LinkPreviewData, type context_ListCategoriesForItemOptions as ListCategoriesForItemOptions, type context_ListCategoriesForItemRequest as ListCategoriesForItemRequest, type context_ListCategoriesForItemResponse as ListCategoriesForItemResponse, type context_ListCategoriesForItemResponseNonNullableFields as ListCategoriesForItemResponseNonNullableFields, type context_ListCompactCategoriesByIdsRequest as ListCompactCategoriesByIdsRequest, type context_ListCompactCategoriesByIdsResponse as ListCompactCategoriesByIdsResponse, type context_ListItemsInCategoryOptions as ListItemsInCategoryOptions, type context_ListItemsInCategoryRequest as ListItemsInCategoryRequest, type context_ListItemsInCategoryRequestPagingMethodOneOf as ListItemsInCategoryRequestPagingMethodOneOf, type context_ListItemsInCategoryResponse as ListItemsInCategoryResponse, type context_ListItemsInCategoryResponseNonNullableFields as ListItemsInCategoryResponseNonNullableFields, type context_ListTreesRequest as ListTreesRequest, type context_ListTreesResponse as ListTreesResponse, type context_ListTreesResponseNonNullableFields as ListTreesResponseNonNullableFields, type context_ListValue as ListValue, type context_MapData as MapData, type context_MapSettings as MapSettings, context_MapType as MapType, type context_MaskedCategory as MaskedCategory, type context_Media as Media, type context_MentionData as MentionData, type context_MessageEnvelope as MessageEnvelope, type context_Metadata as Metadata, context_MissingValues as MissingValues, context_Mode as Mode, type context_MoveCategoryOptions as MoveCategoryOptions, type context_MoveCategoryRequest as MoveCategoryRequest, type context_MoveCategoryResponse as MoveCategoryResponse, type context_MoveCategoryResponseNonNullableFields as MoveCategoryResponseNonNullableFields, type context_MoveItemInCategoryRequest as MoveItemInCategoryRequest, context_MoveItemInCategoryRequestPosition as MoveItemInCategoryRequestPosition, type context_MoveItemInCategoryResponse as MoveItemInCategoryResponse, type context_NestedAggregation as NestedAggregation, type context_NestedAggregationItem as NestedAggregationItem, type context_NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOf, type context_NestedAggregationResults as NestedAggregationResults, type context_NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOf, context_NestedAggregationType as NestedAggregationType, type context_NestedResultValue as NestedResultValue, type context_NestedResultValueResultOneOf as NestedResultValueResultOneOf, type context_NestedResults as NestedResults, type context_NestedValueAggregationResult as NestedValueAggregationResult, type context_Node as Node, type context_NodeDataOneOf as NodeDataOneOf, type context_NodeStyle as NodeStyle, context_NodeType as NodeType, context_NullValue as NullValue, type context_Oembed as Oembed, type context_OffsetSearch as OffsetSearch, type context_OffsetSearchPagingMethodOneOf as OffsetSearchPagingMethodOneOf, type context_Option as Option, type context_OptionDesign as OptionDesign, type context_OptionLayout as OptionLayout, type context_OrderedListData as OrderedListData, context_Orientation as Orientation, type context_PDFSettings as PDFSettings, type context_Page as Page, type context_Paging as Paging, type context_PagingMetadata as PagingMetadata, type context_PagingMetadataV2 as PagingMetadataV2, type context_ParagraphData as ParagraphData, type context_ParentCategory as ParentCategory, type context_Permissions as Permissions, type context_PlaybackOptions as PlaybackOptions, type context_PluginContainerData as PluginContainerData, context_PluginContainerDataAlignment as PluginContainerDataAlignment, type context_PluginContainerDataWidth as PluginContainerDataWidth, type context_PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOf, type context_Poll as Poll, type context_PollData as PollData, type context_PollDataLayout as PollDataLayout, type context_PollDesign as PollDesign, type context_PollLayout as PollLayout, context_PollLayoutDirection as PollLayoutDirection, context_PollLayoutType as PollLayoutType, type context_PollSettings as PollSettings, context_Position as Position, type context_QueryCategoriesOptions as QueryCategoriesOptions, type context_QueryCategoriesRequest as QueryCategoriesRequest, type context_QueryCategoriesResponse as QueryCategoriesResponse, type context_QueryCategoriesResponseNonNullableFields as QueryCategoriesResponseNonNullableFields, type context_RangeAggregation as RangeAggregation, type context_RangeAggregationResult as RangeAggregationResult, type context_RangeBucket as RangeBucket, type context_RangeResult as RangeResult, type context_RangeResults as RangeResults, type context_Rel as Rel, context_RequestedFields as RequestedFields, type context_RestoreInfo as RestoreInfo, type context_Results as Results, type context_RichContent as RichContent, type context_ScalarAggregation as ScalarAggregation, type context_ScalarResult as ScalarResult, context_ScalarType as ScalarType, type context_SearchCategoriesOptions as SearchCategoriesOptions, type context_SearchCategoriesRequest as SearchCategoriesRequest, type context_SearchCategoriesResponse as SearchCategoriesResponse, type context_SearchCategoriesResponseNonNullableFields as SearchCategoriesResponseNonNullableFields, type context_SearchDetails as SearchDetails, type context_SeoSchema as SeoSchema, type context_SetArrangedItemsOptions as SetArrangedItemsOptions, type context_SetArrangedItemsRequest as SetArrangedItemsRequest, type context_SetArrangedItemsResponse as SetArrangedItemsResponse, type context_SetArrangedItemsResponseNonNullableFields as SetArrangedItemsResponseNonNullableFields, type context_Settings as Settings, context_SingleEntityOpsRequestedFields as SingleEntityOpsRequestedFields, context_SortDirection as SortDirection, context_SortOrder as SortOrder, context_SortType as SortType, type context_Sorting as Sorting, context_Source as Source, type context_Spoiler as Spoiler, type context_SpoilerData as SpoilerData, type context_Styles as Styles, type context_TableCellData as TableCellData, type context_TableData as TableData, type context_Tag as Tag, context_Target as Target, context_TextAlignment as TextAlignment, type context_TextData as TextData, type context_TextNodeStyle as TextNodeStyle, type context_TextStyle as TextStyle, type context_Thumbnails as Thumbnails, context_ThumbnailsAlignment as ThumbnailsAlignment, type context_TreeReference as TreeReference, context_Type as Type, type context_URI as URI, type context_UpdateCategory as UpdateCategory, type context_UpdateCategoryOptions as UpdateCategoryOptions, type context_UpdateCategoryRequest as UpdateCategoryRequest, type context_UpdateCategoryResponse as UpdateCategoryResponse, type context_UpdateCategoryResponseNonNullableFields as UpdateCategoryResponseNonNullableFields, type context_UpdateCategoryVisibilityOptions as UpdateCategoryVisibilityOptions, type context_UpdateCategoryVisibilityRequest as UpdateCategoryVisibilityRequest, type context_UpdateCategoryVisibilityResponse as UpdateCategoryVisibilityResponse, type context_UpdateCategoryVisibilityResponseNonNullableFields as UpdateCategoryVisibilityResponseNonNullableFields, type context_ValueAggregation as ValueAggregation, type context_ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOf, type context_ValueAggregationResult as ValueAggregationResult, type context_ValueResult as ValueResult, type context_ValueResults as ValueResults, context_VerticalAlignment as VerticalAlignment, type context_Video as Video, type context_VideoData as VideoData, context_ViewMode as ViewMode, context_ViewRole as ViewRole, context_VoteRole as VoteRole, context_WebhookIdentityType as WebhookIdentityType, context_Width as Width, context_WidthType as WidthType, type context__publicOnCategoryCreatedType as _publicOnCategoryCreatedType, type context__publicOnCategoryDeletedType as _publicOnCategoryDeletedType, type context__publicOnCategoryItemAddedToCategoryType as _publicOnCategoryItemAddedToCategoryType, type context__publicOnCategoryItemRemovedFromCategoryType as _publicOnCategoryItemRemovedFromCategoryType, type context__publicOnCategoryItemsArrangedInCategoryType as _publicOnCategoryItemsArrangedInCategoryType, type context__publicOnCategoryMovedType as _publicOnCategoryMovedType, type context__publicOnCategoryUpdatedType as _publicOnCategoryUpdatedType, context_bulkAddItemToCategories as bulkAddItemToCategories, context_bulkAddItemsToCategory as bulkAddItemsToCategory, context_bulkRemoveItemFromCategories as bulkRemoveItemFromCategories, context_bulkRemoveItemsFromCategory as bulkRemoveItemsFromCategory, context_bulkShowCategories as bulkShowCategories, context_bulkUpdateCategories as bulkUpdateCategories, context_countCategories as countCategories, context_createCategory as createCategory, context_deleteCategory as deleteCategory, context_getArrangedItems as getArrangedItems, context_getCategory as getCategory, context_listCategoriesForItem as listCategoriesForItem, context_listItemsInCategory as listItemsInCategory, context_listTrees as listTrees, context_moveCategory as moveCategory, context_onCategoryCreated as onCategoryCreated, context_onCategoryDeleted as onCategoryDeleted, context_onCategoryItemAddedToCategory as onCategoryItemAddedToCategory, context_onCategoryItemRemovedFromCategory as onCategoryItemRemovedFromCategory, context_onCategoryItemsArrangedInCategory as onCategoryItemsArrangedInCategory, context_onCategoryMoved as onCategoryMoved, context_onCategoryUpdated as onCategoryUpdated, onCategoryCreated$1 as publicOnCategoryCreated, onCategoryDeleted$1 as publicOnCategoryDeleted, onCategoryItemAddedToCategory$1 as publicOnCategoryItemAddedToCategory, onCategoryItemRemovedFromCategory$1 as publicOnCategoryItemRemovedFromCategory, onCategoryItemsArrangedInCategory$1 as publicOnCategoryItemsArrangedInCategory, onCategoryMoved$1 as publicOnCategoryMoved, onCategoryUpdated$1 as publicOnCategoryUpdated, context_queryCategories as queryCategories, context_searchCategories as searchCategories, context_setArrangedItems as setArrangedItems, context_updateCategory as updateCategory, context_updateCategoryVisibility as updateCategoryVisibility };
|
|
4745
|
-
}
|
|
4746
|
-
|
|
4747
|
-
export { context as categories };
|