@wix/autocms-collection-metadata-service 1.0.7 → 1.0.9

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.
@@ -1,1242 +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
- /** Contains the CMS metadata for the given collection. */
480
- interface CollectionMetadata {
481
- /** ID of the associated data collection. */
482
- dataCollectionId?: string;
483
- /** ID of the active named (custom) view. Learn more about [creating custom collection views](https://support.wix.com/en/article/cms-creating-custom-collection-views) in the CMS. */
484
- activeNamedViewId?: string | null;
485
- /** Whether to [hide the table layout view](https://support.wix.com/en/article/cms-setting-field-validations-in-your-collections#hiding-the-table-layout-to-prevent-empty-required-fields). Default: `false`. */
486
- hideTableView?: boolean | null;
487
- /** List of [custom collection views](https://support.wix.com/en/article/cms-creating-custom-collection-views). */
488
- namedViews?: Record<string, any>[] | null;
489
- /** Custom view to mirror on the Wix site. Learn more about [mirroring item order to the site's connected elements](https://support.wix.com/en/article/cms-mirroring-the-order-of-items-in-your-collection-to-your-sites-connected-elements). */
490
- namedViewIdForSiteSort?: string | null;
491
- /** Collection permission template. Each collection has a permissions template that determines what Learn more about [collection permissions](https://support.wix.com/en/article/cms-changing-your-collection-permissions). */
492
- permissionsTemplate?: PermissionsTemplateType;
493
- }
494
- declare enum PermissionsTemplateType {
495
- UNDEFINED = "UNDEFINED",
496
- SHOW_CONTENT = "SHOW_CONTENT",
497
- COLLECT_CONTENT = "COLLECT_CONTENT",
498
- CUSTOM = "CUSTOM"
499
- }
500
- interface CreateCollectionMetadataRequest {
501
- /** Collection metadata details. */
502
- collectionMetadata: CollectionMetadata;
503
- }
504
- interface CreateCollectionMetadataResponse {
505
- /** Created collection metadata instance. */
506
- collectionMetadata?: CollectionMetadata;
507
- }
508
- interface GetCollectionMetadataRequest {
509
- /** ID of the collection for which to retrieve metadata. */
510
- dataCollectionId?: string;
511
- }
512
- interface GetCollectionMetadataResponse {
513
- /** Retrieved collection metadata instance. */
514
- collectionMetadata?: CollectionMetadata;
515
- }
516
- interface UpdateCollectionMetadataRequest {
517
- /**
518
- * TODO CLARIFY WHAT THIS MEANS:
519
- * ID of metadata to update, ignored if **collection_metadata.data_collection_id** is non-empty // a technical workaround
520
- * exists because of docs generation issue with nested fields and ** path variables
521
- * TODO shouldn't this be required? // Yes
522
- * ID of the collection for which to update metadata.
523
- */
524
- dataCollectionId?: string;
525
- /** Collection metadata to update. Only the specified fields are affected. Fields not mentioned remain unchanged. */
526
- collectionMetadata: CollectionMetadata;
527
- }
528
- interface UpdateCollectionMetadataResponse {
529
- /** Updated collection metadata instance. */
530
- collectionMetadata?: CollectionMetadata;
531
- }
532
- interface ReplaceCollectionMetadataRequest {
533
- /** Collection metadata to replace existing metadata. */
534
- items?: CollectionMetadata[];
535
- }
536
- interface ReplaceCollectionMetadataResponse {
537
- }
538
- interface DeleteCollectionMetadataRequest {
539
- /** ID of the collection for which to delete metadata. */
540
- dataCollectionId?: string;
541
- }
542
- interface DeleteCollectionMetadataResponse {
543
- }
544
- interface ListCollectionMetadataRequest {
545
- /** Paging settings. */
546
- paging?: CursorPaging;
547
- }
548
- interface CursorPaging {
549
- /** Maximum number of items to return in the results. */
550
- limit?: number | null;
551
- /**
552
- * Pointer to the next or previous page in the list of results.
553
- *
554
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
555
- * Not relevant for the first request.
556
- */
557
- cursor?: string | null;
558
- }
559
- interface ListCollectionMetadataResponse {
560
- /** List of collection metadata instances. */
561
- items?: CollectionMetadata[];
562
- /** Paging information. */
563
- pagingMetadata?: CursorPagingMetadata;
564
- }
565
- interface CursorPagingMetadata {
566
- /** Number of items returned in current page. */
567
- count?: number | null;
568
- /** Cursor strings that point to the next page, previous page, or both. */
569
- cursors?: Cursors;
570
- /**
571
- * Whether there are more pages to retrieve following the current page.
572
- *
573
- * + `true`: Another page of results can be retrieved.
574
- * + `false`: This is the last page.
575
- */
576
- hasNext?: boolean | null;
577
- }
578
- interface Cursors {
579
- /** Cursor string pointing to the next page in the list of results. */
580
- next?: string | null;
581
- /** Cursor pointing to the previous page in the list of results. */
582
- prev?: string | null;
583
- }
584
- interface DomainEvent extends DomainEventBodyOneOf {
585
- createdEvent?: EntityCreatedEvent;
586
- updatedEvent?: EntityUpdatedEvent;
587
- deletedEvent?: EntityDeletedEvent;
588
- actionEvent?: ActionEvent;
589
- /**
590
- * Unique event ID.
591
- * Allows clients to ignore duplicate webhooks.
592
- */
593
- _id?: string;
594
- /**
595
- * Assumes actions are also always typed to an entity_type
596
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
597
- */
598
- entityFqdn?: string;
599
- /**
600
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
601
- * This is although the created/updated/deleted notion is duplication of the oneof types
602
- * Example: created/updated/deleted/started/completed/email_opened
603
- */
604
- slug?: string;
605
- /** ID of the entity associated with the event. */
606
- entityId?: string;
607
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
608
- eventTime?: Date | null;
609
- /**
610
- * Whether the event was triggered as a result of a privacy regulation application
611
- * (for example, GDPR).
612
- */
613
- triggeredByAnonymizeRequest?: boolean | null;
614
- /** If present, indicates the action that triggered the event. */
615
- originatedFrom?: string | null;
616
- /**
617
- * A sequence number defining the order of updates to the underlying entity.
618
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
619
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
620
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
621
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
622
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
623
- */
624
- entityEventSequence?: string | null;
625
- }
626
- /** @oneof */
627
- interface DomainEventBodyOneOf {
628
- createdEvent?: EntityCreatedEvent;
629
- updatedEvent?: EntityUpdatedEvent;
630
- deletedEvent?: EntityDeletedEvent;
631
- actionEvent?: ActionEvent;
632
- }
633
- interface EntityCreatedEvent {
634
- entity?: string;
635
- }
636
- interface RestoreInfo {
637
- deletedDate?: Date | null;
638
- }
639
- interface EntityUpdatedEvent {
640
- /**
641
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
642
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
643
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
644
- */
645
- currentEntity?: string;
646
- }
647
- interface EntityDeletedEvent {
648
- /** Entity that was deleted */
649
- deletedEntity?: string | null;
650
- }
651
- interface ActionEvent {
652
- body?: string;
653
- }
654
- interface Empty {
655
- }
656
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
657
- /** Emitted on a meta site creation. */
658
- siteCreated?: SiteCreated;
659
- /** Emitted on a meta site transfer completion. */
660
- siteTransferred?: SiteTransferred;
661
- /** Emitted on a meta site deletion. */
662
- siteDeleted?: SiteDeleted;
663
- /** Emitted on a meta site restoration. */
664
- siteUndeleted?: SiteUndeleted;
665
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
666
- sitePublished?: SitePublished;
667
- /** Emitted on a meta site unpublish. */
668
- siteUnpublished?: SiteUnpublished;
669
- /** Emitted when meta site is marked as template. */
670
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
671
- /** Emitted when meta site is marked as a WixSite. */
672
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
673
- /** Emitted when an application is provisioned (installed). */
674
- serviceProvisioned?: ServiceProvisioned;
675
- /** Emitted when an application is removed (uninstalled). */
676
- serviceRemoved?: ServiceRemoved;
677
- /** Emitted when meta site name (URL slug) is changed. */
678
- siteRenamedPayload?: SiteRenamed;
679
- /** Emitted when meta site was permanently deleted. */
680
- hardDeleted?: SiteHardDeleted;
681
- /** Emitted on a namespace change. */
682
- namespaceChanged?: NamespaceChanged;
683
- /** Emitted when Studio is attached. */
684
- studioAssigned?: StudioAssigned;
685
- /** Emitted when Studio is detached. */
686
- studioUnassigned?: StudioUnassigned;
687
- /** A meta site id. */
688
- metaSiteId?: string;
689
- /** A meta site version. Monotonically increasing. */
690
- version?: string;
691
- /** A timestamp of the event. */
692
- timestamp?: string;
693
- /**
694
- * TODO(meta-site): Change validation once validations are disabled for consumers
695
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
696
- */
697
- assets?: Asset[];
698
- }
699
- /** @oneof */
700
- interface MetaSiteSpecialEventPayloadOneOf {
701
- /** Emitted on a meta site creation. */
702
- siteCreated?: SiteCreated;
703
- /** Emitted on a meta site transfer completion. */
704
- siteTransferred?: SiteTransferred;
705
- /** Emitted on a meta site deletion. */
706
- siteDeleted?: SiteDeleted;
707
- /** Emitted on a meta site restoration. */
708
- siteUndeleted?: SiteUndeleted;
709
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
710
- sitePublished?: SitePublished;
711
- /** Emitted on a meta site unpublish. */
712
- siteUnpublished?: SiteUnpublished;
713
- /** Emitted when meta site is marked as template. */
714
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
715
- /** Emitted when meta site is marked as a WixSite. */
716
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
717
- /** Emitted when an application is provisioned (installed). */
718
- serviceProvisioned?: ServiceProvisioned;
719
- /** Emitted when an application is removed (uninstalled). */
720
- serviceRemoved?: ServiceRemoved;
721
- /** Emitted when meta site name (URL slug) is changed. */
722
- siteRenamedPayload?: SiteRenamed;
723
- /** Emitted when meta site was permanently deleted. */
724
- hardDeleted?: SiteHardDeleted;
725
- /** Emitted on a namespace change. */
726
- namespaceChanged?: NamespaceChanged;
727
- /** Emitted when Studio is attached. */
728
- studioAssigned?: StudioAssigned;
729
- /** Emitted when Studio is detached. */
730
- studioUnassigned?: StudioUnassigned;
731
- }
732
- interface Asset {
733
- /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
734
- appDefId?: string;
735
- /** An instance id. For legacy reasons may be UUID or a string. */
736
- instanceId?: string;
737
- /** An application state. */
738
- state?: State;
739
- }
740
- declare enum State {
741
- UNKNOWN = "UNKNOWN",
742
- ENABLED = "ENABLED",
743
- DISABLED = "DISABLED",
744
- PENDING = "PENDING",
745
- DEMO = "DEMO"
746
- }
747
- interface SiteCreated {
748
- /** A template identifier (empty if not created from a template). */
749
- originTemplateId?: string;
750
- /** An account id of the owner. */
751
- ownerId?: string;
752
- /** A context in which meta site was created. */
753
- context?: SiteCreatedContext;
754
- /**
755
- * A meta site id from which this site was created.
756
- *
757
- * In case of a creation from a template it's a template id.
758
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
759
- */
760
- originMetaSiteId?: string | null;
761
- /** A meta site name (URL slug). */
762
- siteName?: string;
763
- /** A namespace. */
764
- namespace?: Namespace;
765
- }
766
- declare enum SiteCreatedContext {
767
- /** A valid option, we don't expose all reasons why site might be created. */
768
- OTHER = "OTHER",
769
- /** A meta site was created from template. */
770
- FROM_TEMPLATE = "FROM_TEMPLATE",
771
- /** A meta site was created by copying of the transfferred meta site. */
772
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
773
- /** A copy of existing meta site. */
774
- DUPLICATE = "DUPLICATE",
775
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
776
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
777
- /** deprecated A meta site was created for Flash editor. */
778
- FLASH = "FLASH"
779
- }
780
- declare enum Namespace {
781
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
782
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
783
- WIX = "WIX",
784
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
785
- SHOUT_OUT = "SHOUT_OUT",
786
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
787
- ALBUMS = "ALBUMS",
788
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
789
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
790
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
791
- HOTELS = "HOTELS",
792
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
793
- CLUBS = "CLUBS",
794
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
795
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
796
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
797
- DEV_SITE = "DEV_SITE",
798
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
799
- LOGOS = "LOGOS",
800
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
801
- VIDEO_MAKER = "VIDEO_MAKER",
802
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
803
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
804
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
805
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
806
- /**
807
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
808
- *
809
- * Meta site with this namespace will *not* be shown in a user's site list by default.
810
- */
811
- HTML_DRAFT = "HTML_DRAFT",
812
- /**
813
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
814
- * Will be accessible from Site List and will not have a website app.
815
- * Once the user attaches a site, the site will become a regular wixsite.
816
- */
817
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
818
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
819
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
820
- /** It is to be used in the Business First efforts. */
821
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
822
- /** Bookings business flow with no site. */
823
- ANYWHERE = "ANYWHERE",
824
- /** Namespace for Headless Backoffice with no editor */
825
- HEADLESS = "HEADLESS",
826
- /**
827
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
828
- * The site will be used for account level CSM feature for enterprise
829
- */
830
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
831
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
832
- RISE = "RISE",
833
- /**
834
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
835
- * There's a blank site behind the scene but it's blank).
836
- * The Mobile company will be the owner of this namespace.
837
- */
838
- BRANDED_FIRST = "BRANDED_FIRST",
839
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
840
- NOWNIA = "NOWNIA",
841
- /**
842
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
843
- * The Partners company owns this namespace.
844
- */
845
- UGC_TEMPLATE = "UGC_TEMPLATE",
846
- /** Codux Headless Sites */
847
- CODUX = "CODUX"
848
- }
849
- /** Site transferred to another user. */
850
- interface SiteTransferred {
851
- /** A previous owner id (user that transfers meta site). */
852
- oldOwnerId?: string;
853
- /** A new owner id (user that accepts meta site). */
854
- newOwnerId?: string;
855
- }
856
- /** Soft deletion of the meta site. Could be restored. */
857
- interface SiteDeleted {
858
- /** A deletion context. */
859
- deleteContext?: DeleteContext;
860
- }
861
- interface DeleteContext {
862
- /** When the meta site was deleted. */
863
- dateDeleted?: Date | null;
864
- /** A status. */
865
- deleteStatus?: DeleteStatus;
866
- /** A reason (flow). */
867
- deleteOrigin?: string;
868
- /** A service that deleted it. */
869
- initiatorId?: string | null;
870
- }
871
- declare enum DeleteStatus {
872
- UNKNOWN = "UNKNOWN",
873
- TRASH = "TRASH",
874
- DELETED = "DELETED",
875
- PENDING_PURGE = "PENDING_PURGE"
876
- }
877
- /** Restoration of the meta site. */
878
- interface SiteUndeleted {
879
- }
880
- /** First publish of a meta site. Or subsequent publish after unpublish. */
881
- interface SitePublished {
882
- }
883
- interface SiteUnpublished {
884
- /** A list of URLs previously associated with the meta site. */
885
- urls?: string[];
886
- }
887
- interface SiteMarkedAsTemplate {
888
- }
889
- interface SiteMarkedAsWixSite {
890
- }
891
- interface ServiceProvisioned {
892
- /** Either UUID or EmbeddedServiceType. */
893
- appDefId?: string;
894
- /** Not only UUID. Something here could be something weird. */
895
- instanceId?: string;
896
- /** An instance id from which this instance is originated. */
897
- originInstanceId?: string;
898
- /** A version. */
899
- version?: string | null;
900
- /** The origin meta site id */
901
- originMetaSiteId?: string | null;
902
- }
903
- interface ServiceRemoved {
904
- /** Either UUID or EmbeddedServiceType. */
905
- appDefId?: string;
906
- /** Not only UUID. Something here could be something weird. */
907
- instanceId?: string;
908
- /** A version. */
909
- version?: string | null;
910
- }
911
- /** Rename of the site. Meaning, free public url has been changed as well. */
912
- interface SiteRenamed {
913
- /** A new meta site name (URL slug). */
914
- newSiteName?: string;
915
- /** A previous meta site name (URL slug). */
916
- oldSiteName?: string;
917
- }
918
- /**
919
- * Hard deletion of the meta site.
920
- *
921
- * Could not be restored. Therefore it's desirable to cleanup data.
922
- */
923
- interface SiteHardDeleted {
924
- /** A deletion context. */
925
- deleteContext?: DeleteContext;
926
- }
927
- interface NamespaceChanged {
928
- /** A previous namespace. */
929
- oldNamespace?: Namespace;
930
- /** A new namespace. */
931
- newNamespace?: Namespace;
932
- }
933
- /** Assigned Studio editor */
934
- interface StudioAssigned {
935
- }
936
- /** Unassigned Studio editor */
937
- interface StudioUnassigned {
938
- }
939
- interface MessageEnvelope {
940
- /** App instance ID. */
941
- instanceId?: string | null;
942
- /** Event type. */
943
- eventType?: string;
944
- /** The identification type and identity data. */
945
- identity?: IdentificationData;
946
- /** Stringify payload. */
947
- data?: string;
948
- }
949
- interface IdentificationData extends IdentificationDataIdOneOf {
950
- /** ID of a site visitor that has not logged in to the site. */
951
- anonymousVisitorId?: string;
952
- /** ID of a site visitor that has logged in to the site. */
953
- memberId?: string;
954
- /** ID of a Wix user (site owner, contributor, etc.). */
955
- wixUserId?: string;
956
- /** ID of an app. */
957
- appId?: string;
958
- /** @readonly */
959
- identityType?: WebhookIdentityType;
960
- }
961
- /** @oneof */
962
- interface IdentificationDataIdOneOf {
963
- /** ID of a site visitor that has not logged in to the site. */
964
- anonymousVisitorId?: string;
965
- /** ID of a site visitor that has logged in to the site. */
966
- memberId?: string;
967
- /** ID of a Wix user (site owner, contributor, etc.). */
968
- wixUserId?: string;
969
- /** ID of an app. */
970
- appId?: string;
971
- }
972
- declare enum WebhookIdentityType {
973
- UNKNOWN = "UNKNOWN",
974
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
975
- MEMBER = "MEMBER",
976
- WIX_USER = "WIX_USER",
977
- APP = "APP"
978
- }
979
- interface CollectionMetadataNonNullableFields {
980
- dataCollectionId: string;
981
- permissionsTemplate: PermissionsTemplateType;
982
- }
983
- interface CreateCollectionMetadataResponseNonNullableFields {
984
- collectionMetadata?: CollectionMetadataNonNullableFields;
985
- }
986
- interface GetCollectionMetadataResponseNonNullableFields {
987
- collectionMetadata?: CollectionMetadataNonNullableFields;
988
- }
989
- interface UpdateCollectionMetadataResponseNonNullableFields {
990
- collectionMetadata?: CollectionMetadataNonNullableFields;
991
- }
992
- interface ListCollectionMetadataResponseNonNullableFields {
993
- items: CollectionMetadataNonNullableFields[];
994
- }
995
- interface BaseEventMetadata {
996
- /** App instance ID. */
997
- instanceId?: string | null;
998
- /** Event type. */
999
- eventType?: string;
1000
- /** The identification type and identity data. */
1001
- identity?: IdentificationData;
1002
- }
1003
- interface EventMetadata extends BaseEventMetadata {
1004
- /**
1005
- * Unique event ID.
1006
- * Allows clients to ignore duplicate webhooks.
1007
- */
1008
- _id?: string;
1009
- /**
1010
- * Assumes actions are also always typed to an entity_type
1011
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1012
- */
1013
- entityFqdn?: string;
1014
- /**
1015
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1016
- * This is although the created/updated/deleted notion is duplication of the oneof types
1017
- * Example: created/updated/deleted/started/completed/email_opened
1018
- */
1019
- slug?: string;
1020
- /** ID of the entity associated with the event. */
1021
- entityId?: string;
1022
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1023
- eventTime?: Date | null;
1024
- /**
1025
- * Whether the event was triggered as a result of a privacy regulation application
1026
- * (for example, GDPR).
1027
- */
1028
- triggeredByAnonymizeRequest?: boolean | null;
1029
- /** If present, indicates the action that triggered the event. */
1030
- originatedFrom?: string | null;
1031
- /**
1032
- * A sequence number defining the order of updates to the underlying entity.
1033
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1034
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1035
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1036
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1037
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1038
- */
1039
- entityEventSequence?: string | null;
1040
- }
1041
- interface CollectionMetadataCreatedEnvelope {
1042
- entity: CollectionMetadata;
1043
- metadata: EventMetadata;
1044
- }
1045
- interface CollectionMetadataUpdatedEnvelope {
1046
- entity: CollectionMetadata;
1047
- metadata: EventMetadata;
1048
- }
1049
- interface CollectionMetadataDeletedEnvelope {
1050
- metadata: EventMetadata;
1051
- }
1052
- interface ReplaceCollectionMetadataOptions {
1053
- /** Collection metadata to replace existing metadata. */
1054
- items?: CollectionMetadata[];
1055
- }
1056
- interface ListCollectionMetadataOptions {
1057
- /** Paging settings. */
1058
- paging?: CursorPaging;
1059
- }
1060
-
1061
- declare function createCollectionMetadata$1(httpClient: HttpClient): CreateCollectionMetadataSignature;
1062
- interface CreateCollectionMetadataSignature {
1063
- /**
1064
- * Creates a new collection metadata instance.
1065
- *
1066
- * In case of an error, this endpoint returns the following codes:
1067
- * - `METADATA_EXISTS`: Metadata already exists for the specified collection.
1068
- * @param - Collection metadata details.
1069
- * @returns Created collection metadata instance.
1070
- */
1071
- (collectionMetadata: CollectionMetadata): Promise<CollectionMetadata & CollectionMetadataNonNullableFields>;
1072
- }
1073
- declare function getCollectionMetadata$1(httpClient: HttpClient): GetCollectionMetadataSignature;
1074
- interface GetCollectionMetadataSignature {
1075
- /**
1076
- * Gets a collection metadata instance.
1077
- *
1078
- * In case of an error, this endpoint returns the following codes:
1079
- * - `ITEM_NOT_FOUND`: No metadata exists for the specified collection.
1080
- * @param - ID of the collection for which to retrieve metadata.
1081
- * @returns Retrieved collection metadata instance.
1082
- */
1083
- (dataCollectionId: string): Promise<CollectionMetadata & CollectionMetadataNonNullableFields>;
1084
- }
1085
- declare function updateCollectionMetadata$1(httpClient: HttpClient): UpdateCollectionMetadataSignature;
1086
- interface UpdateCollectionMetadataSignature {
1087
- /**
1088
- * Updates the metadata for the specified collection.
1089
- *
1090
- * In case of an error, this endpoint returns the following codes:
1091
- * - `ITEM_NOT_FOUND`: No metadata exists for the specified collection.
1092
- * @param - TODO CLARIFY WHAT THIS MEANS:
1093
- * ID of metadata to update, ignored if **collection_metadata.data_collection_id** is non-empty // a technical workaround
1094
- * exists because of docs generation issue with nested fields and ** path variables
1095
- * TODO shouldn't this be required? // Yes
1096
- * ID of the collection for which to update metadata.
1097
- * @param - Collection metadata to update. Only the specified fields are affected. Fields not mentioned remain unchanged.
1098
- * @returns Updated collection metadata instance.
1099
- */
1100
- (dataCollectionId: string, collectionMetadata: CollectionMetadata): Promise<CollectionMetadata & CollectionMetadataNonNullableFields>;
1101
- }
1102
- declare function replaceCollectionMetadata$1(httpClient: HttpClient): ReplaceCollectionMetadataSignature;
1103
- interface ReplaceCollectionMetadataSignature {
1104
- /**
1105
- * Completely replaces all existing collection metadata with the provided metadata.
1106
- */
1107
- (options?: ReplaceCollectionMetadataOptions | undefined): Promise<void>;
1108
- }
1109
- declare function deleteCollectionMetadata$1(httpClient: HttpClient): DeleteCollectionMetadataSignature;
1110
- interface DeleteCollectionMetadataSignature {
1111
- /**
1112
- * Deletes a collection metadata instance. (1)
1113
- * Deletes the specified collection's metadata. (2)
1114
- * @param - ID of the collection for which to delete metadata.
1115
- */
1116
- (dataCollectionId: string): Promise<void>;
1117
- }
1118
- declare function listCollectionMetadata$1(httpClient: HttpClient): ListCollectionMetadataSignature;
1119
- interface ListCollectionMetadataSignature {
1120
- /**
1121
- * Lists all collection metadata.
1122
- */
1123
- (options?: ListCollectionMetadataOptions | undefined): Promise<ListCollectionMetadataResponse & ListCollectionMetadataResponseNonNullableFields>;
1124
- }
1125
- declare const onCollectionMetadataCreated$1: EventDefinition<CollectionMetadataCreatedEnvelope, "wix.cloud.autocms.v3.collection_metadata_created">;
1126
- declare const onCollectionMetadataUpdated$1: EventDefinition<CollectionMetadataUpdatedEnvelope, "wix.cloud.autocms.v3.collection_metadata_updated">;
1127
- declare const onCollectionMetadataDeleted$1: EventDefinition<CollectionMetadataDeletedEnvelope, "wix.cloud.autocms.v3.collection_metadata_deleted">;
1128
-
1129
- declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
1130
-
1131
- declare const createCollectionMetadata: MaybeContext<BuildRESTFunction<typeof createCollectionMetadata$1> & typeof createCollectionMetadata$1>;
1132
- declare const getCollectionMetadata: MaybeContext<BuildRESTFunction<typeof getCollectionMetadata$1> & typeof getCollectionMetadata$1>;
1133
- declare const updateCollectionMetadata: MaybeContext<BuildRESTFunction<typeof updateCollectionMetadata$1> & typeof updateCollectionMetadata$1>;
1134
- declare const replaceCollectionMetadata: MaybeContext<BuildRESTFunction<typeof replaceCollectionMetadata$1> & typeof replaceCollectionMetadata$1>;
1135
- declare const deleteCollectionMetadata: MaybeContext<BuildRESTFunction<typeof deleteCollectionMetadata$1> & typeof deleteCollectionMetadata$1>;
1136
- declare const listCollectionMetadata: MaybeContext<BuildRESTFunction<typeof listCollectionMetadata$1> & typeof listCollectionMetadata$1>;
1137
-
1138
- type _publicOnCollectionMetadataCreatedType = typeof onCollectionMetadataCreated$1;
1139
- /**
1140
- * Triggered when a collection metadata instance is created.
1141
- */
1142
- declare const onCollectionMetadataCreated: ReturnType<typeof createEventModule<_publicOnCollectionMetadataCreatedType>>;
1143
-
1144
- type _publicOnCollectionMetadataUpdatedType = typeof onCollectionMetadataUpdated$1;
1145
- /**
1146
- * Triggered when a collection metadata instance is updated.
1147
- */
1148
- declare const onCollectionMetadataUpdated: ReturnType<typeof createEventModule<_publicOnCollectionMetadataUpdatedType>>;
1149
-
1150
- type _publicOnCollectionMetadataDeletedType = typeof onCollectionMetadataDeleted$1;
1151
- /**
1152
- * Triggered when a collection metadata instance is deleted.
1153
- */
1154
- declare const onCollectionMetadataDeleted: ReturnType<typeof createEventModule<_publicOnCollectionMetadataDeletedType>>;
1155
-
1156
- type context_ActionEvent = ActionEvent;
1157
- type context_Asset = Asset;
1158
- type context_BaseEventMetadata = BaseEventMetadata;
1159
- type context_CollectionMetadata = CollectionMetadata;
1160
- type context_CollectionMetadataCreatedEnvelope = CollectionMetadataCreatedEnvelope;
1161
- type context_CollectionMetadataDeletedEnvelope = CollectionMetadataDeletedEnvelope;
1162
- type context_CollectionMetadataNonNullableFields = CollectionMetadataNonNullableFields;
1163
- type context_CollectionMetadataUpdatedEnvelope = CollectionMetadataUpdatedEnvelope;
1164
- type context_CreateCollectionMetadataRequest = CreateCollectionMetadataRequest;
1165
- type context_CreateCollectionMetadataResponse = CreateCollectionMetadataResponse;
1166
- type context_CreateCollectionMetadataResponseNonNullableFields = CreateCollectionMetadataResponseNonNullableFields;
1167
- type context_CursorPaging = CursorPaging;
1168
- type context_CursorPagingMetadata = CursorPagingMetadata;
1169
- type context_Cursors = Cursors;
1170
- type context_DeleteCollectionMetadataRequest = DeleteCollectionMetadataRequest;
1171
- type context_DeleteCollectionMetadataResponse = DeleteCollectionMetadataResponse;
1172
- type context_DeleteContext = DeleteContext;
1173
- type context_DeleteStatus = DeleteStatus;
1174
- declare const context_DeleteStatus: typeof DeleteStatus;
1175
- type context_DomainEvent = DomainEvent;
1176
- type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
1177
- type context_Empty = Empty;
1178
- type context_EntityCreatedEvent = EntityCreatedEvent;
1179
- type context_EntityDeletedEvent = EntityDeletedEvent;
1180
- type context_EntityUpdatedEvent = EntityUpdatedEvent;
1181
- type context_EventMetadata = EventMetadata;
1182
- type context_GetCollectionMetadataRequest = GetCollectionMetadataRequest;
1183
- type context_GetCollectionMetadataResponse = GetCollectionMetadataResponse;
1184
- type context_GetCollectionMetadataResponseNonNullableFields = GetCollectionMetadataResponseNonNullableFields;
1185
- type context_IdentificationData = IdentificationData;
1186
- type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
1187
- type context_ListCollectionMetadataOptions = ListCollectionMetadataOptions;
1188
- type context_ListCollectionMetadataRequest = ListCollectionMetadataRequest;
1189
- type context_ListCollectionMetadataResponse = ListCollectionMetadataResponse;
1190
- type context_ListCollectionMetadataResponseNonNullableFields = ListCollectionMetadataResponseNonNullableFields;
1191
- type context_MessageEnvelope = MessageEnvelope;
1192
- type context_MetaSiteSpecialEvent = MetaSiteSpecialEvent;
1193
- type context_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;
1194
- type context_Namespace = Namespace;
1195
- declare const context_Namespace: typeof Namespace;
1196
- type context_NamespaceChanged = NamespaceChanged;
1197
- type context_PermissionsTemplateType = PermissionsTemplateType;
1198
- declare const context_PermissionsTemplateType: typeof PermissionsTemplateType;
1199
- type context_ReplaceCollectionMetadataOptions = ReplaceCollectionMetadataOptions;
1200
- type context_ReplaceCollectionMetadataRequest = ReplaceCollectionMetadataRequest;
1201
- type context_ReplaceCollectionMetadataResponse = ReplaceCollectionMetadataResponse;
1202
- type context_RestoreInfo = RestoreInfo;
1203
- type context_ServiceProvisioned = ServiceProvisioned;
1204
- type context_ServiceRemoved = ServiceRemoved;
1205
- type context_SiteCreated = SiteCreated;
1206
- type context_SiteCreatedContext = SiteCreatedContext;
1207
- declare const context_SiteCreatedContext: typeof SiteCreatedContext;
1208
- type context_SiteDeleted = SiteDeleted;
1209
- type context_SiteHardDeleted = SiteHardDeleted;
1210
- type context_SiteMarkedAsTemplate = SiteMarkedAsTemplate;
1211
- type context_SiteMarkedAsWixSite = SiteMarkedAsWixSite;
1212
- type context_SitePublished = SitePublished;
1213
- type context_SiteRenamed = SiteRenamed;
1214
- type context_SiteTransferred = SiteTransferred;
1215
- type context_SiteUndeleted = SiteUndeleted;
1216
- type context_SiteUnpublished = SiteUnpublished;
1217
- type context_State = State;
1218
- declare const context_State: typeof State;
1219
- type context_StudioAssigned = StudioAssigned;
1220
- type context_StudioUnassigned = StudioUnassigned;
1221
- type context_UpdateCollectionMetadataRequest = UpdateCollectionMetadataRequest;
1222
- type context_UpdateCollectionMetadataResponse = UpdateCollectionMetadataResponse;
1223
- type context_UpdateCollectionMetadataResponseNonNullableFields = UpdateCollectionMetadataResponseNonNullableFields;
1224
- type context_WebhookIdentityType = WebhookIdentityType;
1225
- declare const context_WebhookIdentityType: typeof WebhookIdentityType;
1226
- type context__publicOnCollectionMetadataCreatedType = _publicOnCollectionMetadataCreatedType;
1227
- type context__publicOnCollectionMetadataDeletedType = _publicOnCollectionMetadataDeletedType;
1228
- type context__publicOnCollectionMetadataUpdatedType = _publicOnCollectionMetadataUpdatedType;
1229
- declare const context_createCollectionMetadata: typeof createCollectionMetadata;
1230
- declare const context_deleteCollectionMetadata: typeof deleteCollectionMetadata;
1231
- declare const context_getCollectionMetadata: typeof getCollectionMetadata;
1232
- declare const context_listCollectionMetadata: typeof listCollectionMetadata;
1233
- declare const context_onCollectionMetadataCreated: typeof onCollectionMetadataCreated;
1234
- declare const context_onCollectionMetadataDeleted: typeof onCollectionMetadataDeleted;
1235
- declare const context_onCollectionMetadataUpdated: typeof onCollectionMetadataUpdated;
1236
- declare const context_replaceCollectionMetadata: typeof replaceCollectionMetadata;
1237
- declare const context_updateCollectionMetadata: typeof updateCollectionMetadata;
1238
- declare namespace context {
1239
- export { type context_ActionEvent as ActionEvent, type context_Asset as Asset, type context_BaseEventMetadata as BaseEventMetadata, type context_CollectionMetadata as CollectionMetadata, type context_CollectionMetadataCreatedEnvelope as CollectionMetadataCreatedEnvelope, type context_CollectionMetadataDeletedEnvelope as CollectionMetadataDeletedEnvelope, type context_CollectionMetadataNonNullableFields as CollectionMetadataNonNullableFields, type context_CollectionMetadataUpdatedEnvelope as CollectionMetadataUpdatedEnvelope, type context_CreateCollectionMetadataRequest as CreateCollectionMetadataRequest, type context_CreateCollectionMetadataResponse as CreateCollectionMetadataResponse, type context_CreateCollectionMetadataResponseNonNullableFields as CreateCollectionMetadataResponseNonNullableFields, type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_Cursors as Cursors, type context_DeleteCollectionMetadataRequest as DeleteCollectionMetadataRequest, type context_DeleteCollectionMetadataResponse as DeleteCollectionMetadataResponse, type context_DeleteContext as DeleteContext, context_DeleteStatus as DeleteStatus, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, type context_GetCollectionMetadataRequest as GetCollectionMetadataRequest, type context_GetCollectionMetadataResponse as GetCollectionMetadataResponse, type context_GetCollectionMetadataResponseNonNullableFields as GetCollectionMetadataResponseNonNullableFields, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_ListCollectionMetadataOptions as ListCollectionMetadataOptions, type context_ListCollectionMetadataRequest as ListCollectionMetadataRequest, type context_ListCollectionMetadataResponse as ListCollectionMetadataResponse, type context_ListCollectionMetadataResponseNonNullableFields as ListCollectionMetadataResponseNonNullableFields, type context_MessageEnvelope as MessageEnvelope, type context_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type context_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, context_Namespace as Namespace, type context_NamespaceChanged as NamespaceChanged, context_PermissionsTemplateType as PermissionsTemplateType, type context_ReplaceCollectionMetadataOptions as ReplaceCollectionMetadataOptions, type context_ReplaceCollectionMetadataRequest as ReplaceCollectionMetadataRequest, type context_ReplaceCollectionMetadataResponse as ReplaceCollectionMetadataResponse, type context_RestoreInfo as RestoreInfo, type context_ServiceProvisioned as ServiceProvisioned, type context_ServiceRemoved as ServiceRemoved, type context_SiteCreated as SiteCreated, context_SiteCreatedContext as SiteCreatedContext, type context_SiteDeleted as SiteDeleted, type context_SiteHardDeleted as SiteHardDeleted, type context_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type context_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type context_SitePublished as SitePublished, type context_SiteRenamed as SiteRenamed, type context_SiteTransferred as SiteTransferred, type context_SiteUndeleted as SiteUndeleted, type context_SiteUnpublished as SiteUnpublished, context_State as State, type context_StudioAssigned as StudioAssigned, type context_StudioUnassigned as StudioUnassigned, type context_UpdateCollectionMetadataRequest as UpdateCollectionMetadataRequest, type context_UpdateCollectionMetadataResponse as UpdateCollectionMetadataResponse, type context_UpdateCollectionMetadataResponseNonNullableFields as UpdateCollectionMetadataResponseNonNullableFields, context_WebhookIdentityType as WebhookIdentityType, type context__publicOnCollectionMetadataCreatedType as _publicOnCollectionMetadataCreatedType, type context__publicOnCollectionMetadataDeletedType as _publicOnCollectionMetadataDeletedType, type context__publicOnCollectionMetadataUpdatedType as _publicOnCollectionMetadataUpdatedType, context_createCollectionMetadata as createCollectionMetadata, context_deleteCollectionMetadata as deleteCollectionMetadata, context_getCollectionMetadata as getCollectionMetadata, context_listCollectionMetadata as listCollectionMetadata, context_onCollectionMetadataCreated as onCollectionMetadataCreated, context_onCollectionMetadataDeleted as onCollectionMetadataDeleted, context_onCollectionMetadataUpdated as onCollectionMetadataUpdated, onCollectionMetadataCreated$1 as publicOnCollectionMetadataCreated, onCollectionMetadataDeleted$1 as publicOnCollectionMetadataDeleted, onCollectionMetadataUpdated$1 as publicOnCollectionMetadataUpdated, context_replaceCollectionMetadata as replaceCollectionMetadata, context_updateCollectionMetadata as updateCollectionMetadata };
1240
- }
1241
-
1242
- export { context as autocms };