@wix/auto_sdk_seo_seo-patterns 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +141 -0
- package/build/cjs/index.js +455 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +777 -0
- package/build/cjs/index.typings.js +398 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +592 -0
- package/build/cjs/meta.js +335 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/schemas.d.ts +312 -0
- package/build/cjs/schemas.js +717 -0
- package/build/cjs/schemas.js.map +1 -0
- package/build/es/index.d.mts +141 -0
- package/build/es/index.mjs +423 -0
- package/build/es/index.mjs.map +1 -0
- package/build/es/index.typings.d.mts +777 -0
- package/build/es/index.typings.mjs +366 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +592 -0
- package/build/es/meta.mjs +300 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/schemas.d.mts +312 -0
- package/build/es/schemas.mjs +669 -0
- package/build/es/schemas.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +141 -0
- package/build/internal/cjs/index.js +455 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +777 -0
- package/build/internal/cjs/index.typings.js +398 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +634 -0
- package/build/internal/cjs/meta.js +335 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/schemas.d.ts +312 -0
- package/build/internal/cjs/schemas.js +717 -0
- package/build/internal/cjs/schemas.js.map +1 -0
- package/build/internal/es/index.d.mts +141 -0
- package/build/internal/es/index.mjs +423 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/index.typings.d.mts +777 -0
- package/build/internal/es/index.typings.mjs +366 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +634 -0
- package/build/internal/es/meta.mjs +300 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/build/internal/es/schemas.d.mts +312 -0
- package/build/internal/es/schemas.mjs +669 -0
- package/build/internal/es/schemas.mjs.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +61 -0
- package/schemas/package.json +3 -0
|
@@ -0,0 +1,592 @@
|
|
|
1
|
+
import { GetSeoPatternRequest as GetSeoPatternRequest$1, GetSeoPatternResponse as GetSeoPatternResponse$1, ListSeoPatternsRequest as ListSeoPatternsRequest$1, ListSeoPatternsResponse as ListSeoPatternsResponse$1, ListSeoPatternVariablesRequest as ListSeoPatternVariablesRequest$1, ListSeoPatternVariablesResponse as ListSeoPatternVariablesResponse$1, CreateSeoPatternRequest as CreateSeoPatternRequest$1, CreateSeoPatternResponse as CreateSeoPatternResponse$1, SetSeoPatternRequest as SetSeoPatternRequest$1, SetSeoPatternResponse as SetSeoPatternResponse$1, ResetSeoPatternToDefaultRequest as ResetSeoPatternToDefaultRequest$1, ResetSeoPatternToDefaultResponse as ResetSeoPatternToDefaultResponse$1 } from './index.typings.js';
|
|
2
|
+
import '@wix/sdk-types';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* An SEO pattern is a template of SEO tags defined for one page type, such as every blog
|
|
6
|
+
* post or every store product. A pattern's tags may contain variables, written as
|
|
7
|
+
* `{{variable}}`, that are filled in with each item's own values when its page renders,
|
|
8
|
+
* so a site owner sets the tags for a whole page type once instead of item by item.
|
|
9
|
+
*
|
|
10
|
+
* Every page type always has a pattern in effect. When a site has no pattern of its own
|
|
11
|
+
* for a page type, the built-in Wix default applies, and `source` reports which of the
|
|
12
|
+
* two is in effect.
|
|
13
|
+
*
|
|
14
|
+
* A change to a pattern reaches the live site without a site publish, and applies to
|
|
15
|
+
* every page of that type that has no SEO tags set for the item itself.
|
|
16
|
+
*/
|
|
17
|
+
interface SeoPattern {
|
|
18
|
+
/**
|
|
19
|
+
* SEO pattern ID, in the format `{pageType}`.
|
|
20
|
+
*
|
|
21
|
+
* For a pattern that applies to a single page built from a Wix Data collection, the
|
|
22
|
+
* format is `{pageType}:{pageId}`.
|
|
23
|
+
* @readonly
|
|
24
|
+
* @maxLength 400
|
|
25
|
+
*/
|
|
26
|
+
id?: string | null;
|
|
27
|
+
/**
|
|
28
|
+
* Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or
|
|
29
|
+
* `STORES_PRODUCT`.
|
|
30
|
+
*
|
|
31
|
+
* Calling with a page type Wix doesn't recognize fails with `UNSUPPORTED_PAGE_TYPE`,
|
|
32
|
+
* and the error lists the page types that are supported. For a page type provided by a
|
|
33
|
+
* Wix app, such as `BLOG_POST`, the app must be installed on the site.
|
|
34
|
+
*
|
|
35
|
+
* Page types aren't the same set as the item types of the Item SEO Tags API: a page
|
|
36
|
+
* type can support a pattern without supporting tags set per item, and the other way
|
|
37
|
+
* round.
|
|
38
|
+
* @maxLength 100
|
|
39
|
+
* @readonly
|
|
40
|
+
*/
|
|
41
|
+
pageType?: string;
|
|
42
|
+
/**
|
|
43
|
+
* ID of a single page built from a Wix Data collection, when the pattern applies to
|
|
44
|
+
* that page alone rather than to the whole page type.
|
|
45
|
+
*
|
|
46
|
+
* Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
|
|
47
|
+
* pattern for the type, and passing a page ID for one of those fails with
|
|
48
|
+
* `PAGE_ID_NOT_SUPPORTED`.
|
|
49
|
+
* @maxLength 200
|
|
50
|
+
*/
|
|
51
|
+
pageId?: string | null;
|
|
52
|
+
/**
|
|
53
|
+
* The site's own pattern for the page type, which takes precedence over the Wix
|
|
54
|
+
* default.
|
|
55
|
+
*
|
|
56
|
+
* Empty when the site has no pattern of its own, in which case `defaultPattern`
|
|
57
|
+
* applies. Setting this field replaces the pattern in full, so send the complete set of
|
|
58
|
+
* tag templates you want the page type to have.
|
|
59
|
+
*/
|
|
60
|
+
pattern?: SeoPatternBlob;
|
|
61
|
+
/**
|
|
62
|
+
* The pattern Wix provides for the page type, which applies whenever the site has no
|
|
63
|
+
* pattern of its own.
|
|
64
|
+
*
|
|
65
|
+
* Always returned, so you can compare a customized pattern with the one it started
|
|
66
|
+
* from, and see what a reset would restore.
|
|
67
|
+
* @readonly
|
|
68
|
+
*/
|
|
69
|
+
defaultPattern?: SeoPatternBlob;
|
|
70
|
+
/**
|
|
71
|
+
* Which pattern is in effect for the page type: the site's own, or the Wix default.
|
|
72
|
+
* @readonly
|
|
73
|
+
*/
|
|
74
|
+
source?: PatternSourceWithLiterals;
|
|
75
|
+
/**
|
|
76
|
+
* Language the pattern applies to, as an IETF BCP 47 language tag. For example,
|
|
77
|
+
* `en-US` for U.S. English.
|
|
78
|
+
*
|
|
79
|
+
* A page type has a single pattern, so this reports the site's primary language.
|
|
80
|
+
* @maxLength 100
|
|
81
|
+
* @readonly
|
|
82
|
+
*/
|
|
83
|
+
language?: string | null;
|
|
84
|
+
/**
|
|
85
|
+
* What made the most recent change to the pattern, for example a user or the site
|
|
86
|
+
* migration flow. Derived from the caller, not from the request.
|
|
87
|
+
*
|
|
88
|
+
* `ORIGIN_UNSPECIFIED` when the caller isn't one Wix identifies as a specific origin.
|
|
89
|
+
* Origin isn't stored with the pattern either, so Get SEO Pattern and List SEO Patterns
|
|
90
|
+
* always return `ORIGIN_UNSPECIFIED`.
|
|
91
|
+
* @readonly
|
|
92
|
+
*/
|
|
93
|
+
origin?: OriginWithLiterals;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* A set of SEO tag templates.
|
|
97
|
+
*
|
|
98
|
+
* Each tag has the same structure as a rendered SEO tag, except that its values may
|
|
99
|
+
* contain `{{variable}}` placeholders, which are replaced with an item's own values when
|
|
100
|
+
* its page renders.
|
|
101
|
+
*/
|
|
102
|
+
interface SeoPatternBlob {
|
|
103
|
+
/**
|
|
104
|
+
* The pattern's SEO tag templates.
|
|
105
|
+
*
|
|
106
|
+
* A tag may reference only the variables the page type offers. Call List SEO Pattern
|
|
107
|
+
* Variables for the page type to retrieve them.
|
|
108
|
+
*
|
|
109
|
+
* Max: 100 tags
|
|
110
|
+
* @maxSize 100
|
|
111
|
+
*/
|
|
112
|
+
tags?: Tag[];
|
|
113
|
+
}
|
|
114
|
+
interface Tag {
|
|
115
|
+
/**
|
|
116
|
+
* SEO tag type.
|
|
117
|
+
*
|
|
118
|
+
*
|
|
119
|
+
* Supported values: `title`, `meta`, `script`, `link`.
|
|
120
|
+
*/
|
|
121
|
+
type?: string;
|
|
122
|
+
/**
|
|
123
|
+
* A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
|
|
124
|
+
* For example: `{"name": "description", "content": "the description itself"}`.
|
|
125
|
+
*/
|
|
126
|
+
props?: Record<string, any> | null;
|
|
127
|
+
/** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
|
|
128
|
+
meta?: Record<string, any> | null;
|
|
129
|
+
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
130
|
+
children?: string;
|
|
131
|
+
/** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
|
|
132
|
+
custom?: boolean;
|
|
133
|
+
/** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
|
|
134
|
+
disabled?: boolean;
|
|
135
|
+
}
|
|
136
|
+
/** Which pattern is in effect for a page type. */
|
|
137
|
+
declare enum PatternSource {
|
|
138
|
+
/** Unknown source. */
|
|
139
|
+
PATTERN_SOURCE_UNSPECIFIED = "PATTERN_SOURCE_UNSPECIFIED",
|
|
140
|
+
/** The site has a pattern of its own for the page type, returned in `pattern`. */
|
|
141
|
+
PATTERN_SOURCE_USER = "PATTERN_SOURCE_USER",
|
|
142
|
+
/**
|
|
143
|
+
* The site has no pattern of its own for the page type, so the Wix default in
|
|
144
|
+
* `defaultPattern` applies.
|
|
145
|
+
*/
|
|
146
|
+
PATTERN_SOURCE_DEFAULT = "PATTERN_SOURCE_DEFAULT"
|
|
147
|
+
}
|
|
148
|
+
/** @enumType */
|
|
149
|
+
type PatternSourceWithLiterals = PatternSource | 'PATTERN_SOURCE_UNSPECIFIED' | 'PATTERN_SOURCE_USER' | 'PATTERN_SOURCE_DEFAULT';
|
|
150
|
+
/**
|
|
151
|
+
* What made a change to a site's SEO tags or patterns. Derived from the caller, not from
|
|
152
|
+
* the request.
|
|
153
|
+
*/
|
|
154
|
+
declare enum Origin {
|
|
155
|
+
/**
|
|
156
|
+
* Unknown origin. Returned by read methods, because origin isn't stored alongside the
|
|
157
|
+
* data it describes.
|
|
158
|
+
*/
|
|
159
|
+
ORIGIN_UNSPECIFIED = "ORIGIN_UNSPECIFIED",
|
|
160
|
+
/** A user, working in the dashboard or editor, or calling the API on their own behalf. */
|
|
161
|
+
ORIGIN_USER = "ORIGIN_USER",
|
|
162
|
+
/** The flow that imports an existing site into Wix. */
|
|
163
|
+
ORIGIN_MIGRATION = "ORIGIN_MIGRATION",
|
|
164
|
+
/** An AI agent or an automated suggestion flow. */
|
|
165
|
+
ORIGIN_AI = "ORIGIN_AI"
|
|
166
|
+
}
|
|
167
|
+
/** @enumType */
|
|
168
|
+
type OriginWithLiterals = Origin | 'ORIGIN_UNSPECIFIED' | 'ORIGIN_USER' | 'ORIGIN_MIGRATION' | 'ORIGIN_AI';
|
|
169
|
+
interface GetSeoPatternRequest {
|
|
170
|
+
/**
|
|
171
|
+
* Page type whose pattern to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
|
|
172
|
+
* `STORES_PRODUCT`.
|
|
173
|
+
* @maxLength 100
|
|
174
|
+
*/
|
|
175
|
+
pageType: string;
|
|
176
|
+
/**
|
|
177
|
+
* ID of a single page built from a Wix Data collection, to retrieve the pattern of that
|
|
178
|
+
* page alone.
|
|
179
|
+
*
|
|
180
|
+
* Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
|
|
181
|
+
* pattern for the type, and passing a page ID for one of those fails with
|
|
182
|
+
* `PAGE_ID_NOT_SUPPORTED`.
|
|
183
|
+
* @maxLength 200
|
|
184
|
+
*/
|
|
185
|
+
pageId?: string | null;
|
|
186
|
+
/**
|
|
187
|
+
* Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
|
|
188
|
+
*
|
|
189
|
+
* To address a single page built from a Wix Data collection, pass its `pageId`.
|
|
190
|
+
* @maxLength 200
|
|
191
|
+
*/
|
|
192
|
+
collectionName?: string | null;
|
|
193
|
+
}
|
|
194
|
+
interface GetSeoPatternResponse {
|
|
195
|
+
/**
|
|
196
|
+
* The page type's pattern: the site's own pattern, the Wix default, and which of the
|
|
197
|
+
* two is in effect.
|
|
198
|
+
*/
|
|
199
|
+
seoPattern?: SeoPattern;
|
|
200
|
+
}
|
|
201
|
+
interface ListSeoPatternsRequest {
|
|
202
|
+
}
|
|
203
|
+
interface ListSeoPatternsResponse {
|
|
204
|
+
/**
|
|
205
|
+
* The patterns stored for the site, one per page type.
|
|
206
|
+
*
|
|
207
|
+
* A page type that has never had a pattern stored isn't included. A page type that was
|
|
208
|
+
* reset to its Wix default is included, with an empty `pattern`.
|
|
209
|
+
* @maxSize 200
|
|
210
|
+
*/
|
|
211
|
+
seoPatterns?: SeoPattern[];
|
|
212
|
+
}
|
|
213
|
+
interface ListSeoPatternVariablesRequest {
|
|
214
|
+
/**
|
|
215
|
+
* Page type whose variables to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
|
|
216
|
+
* `STORES_PRODUCT`.
|
|
217
|
+
* @maxLength 100
|
|
218
|
+
*/
|
|
219
|
+
pageType: string;
|
|
220
|
+
}
|
|
221
|
+
interface ListSeoPatternVariablesResponse {
|
|
222
|
+
/**
|
|
223
|
+
* Variables a pattern for this page type may use in its tags. For example,
|
|
224
|
+
* `{{product.name}}` in a title template.
|
|
225
|
+
* @maxSize 500
|
|
226
|
+
*/
|
|
227
|
+
variables?: SeoPatternVariable[];
|
|
228
|
+
/**
|
|
229
|
+
* Variables a pattern for this page type may use in its structured data tags.
|
|
230
|
+
*
|
|
231
|
+
* A pattern may use these as well as the variables in `variables`.
|
|
232
|
+
* @maxSize 500
|
|
233
|
+
*/
|
|
234
|
+
structuredDataVariables?: SeoPatternVariable[];
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* A variable a pattern may reference, which is replaced with an item's own value when its
|
|
238
|
+
* page renders.
|
|
239
|
+
*/
|
|
240
|
+
interface SeoPatternVariable {
|
|
241
|
+
/**
|
|
242
|
+
* Name of the variable, without the surrounding braces. For example, `product.name`,
|
|
243
|
+
* which a pattern references as `{{product.name}}`.
|
|
244
|
+
* @maxLength 200
|
|
245
|
+
*/
|
|
246
|
+
key?: string;
|
|
247
|
+
/**
|
|
248
|
+
* Whether Wix offers this variable to site owners editing the pattern in the dashboard.
|
|
249
|
+
*
|
|
250
|
+
* `false` doesn't prevent a pattern from using the variable. It marks a variable Wix
|
|
251
|
+
* keeps out of the dashboard's list, typically because it's only meaningful in specific
|
|
252
|
+
* cases.
|
|
253
|
+
*/
|
|
254
|
+
userVisible?: boolean;
|
|
255
|
+
}
|
|
256
|
+
interface CreateSeoPatternRequest {
|
|
257
|
+
/**
|
|
258
|
+
* Page type whose pattern to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or
|
|
259
|
+
* `STORES_PRODUCT`.
|
|
260
|
+
* @maxLength 100
|
|
261
|
+
*/
|
|
262
|
+
pageType: string;
|
|
263
|
+
/**
|
|
264
|
+
* Pattern to create for the page type.
|
|
265
|
+
*
|
|
266
|
+
* `pattern` is the only field to send. The page type comes from the request path, and
|
|
267
|
+
* every other field is read-only. To create a pattern for a single page built from a
|
|
268
|
+
* Wix Data collection, set `pageId`.
|
|
269
|
+
*/
|
|
270
|
+
seoPattern: SeoPattern;
|
|
271
|
+
}
|
|
272
|
+
interface CreateSeoPatternResponse {
|
|
273
|
+
/**
|
|
274
|
+
* The created pattern, with `source` reporting that the site's own pattern is now in
|
|
275
|
+
* effect.
|
|
276
|
+
*/
|
|
277
|
+
seoPattern?: SeoPattern;
|
|
278
|
+
}
|
|
279
|
+
interface SetSeoPatternRequest {
|
|
280
|
+
/**
|
|
281
|
+
* Page type whose pattern to change. For example, `STATIC_PAGE`, `BLOG_POST`, or
|
|
282
|
+
* `STORES_PRODUCT`.
|
|
283
|
+
* @maxLength 100
|
|
284
|
+
*/
|
|
285
|
+
pageType: string;
|
|
286
|
+
/**
|
|
287
|
+
* Pattern to set for the page type.
|
|
288
|
+
*
|
|
289
|
+
* `pattern` is the only writable field, and setting it replaces the page type's tag
|
|
290
|
+
* templates in full. Sending an empty pattern clears it, which returns the page type to
|
|
291
|
+
* its Wix default.
|
|
292
|
+
*/
|
|
293
|
+
seoPattern: SeoPattern;
|
|
294
|
+
/**
|
|
295
|
+
* Fields to update.
|
|
296
|
+
*
|
|
297
|
+
* Required, and must name only writable fields. An empty field mask, an unknown field,
|
|
298
|
+
* or a read-only field fails with `INVALID_FIELD_MASK`.
|
|
299
|
+
*/
|
|
300
|
+
fieldMask: string[];
|
|
301
|
+
/**
|
|
302
|
+
* Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
|
|
303
|
+
*
|
|
304
|
+
* To address a single page built from a Wix Data collection, pass its `pageId`.
|
|
305
|
+
* @maxLength 200
|
|
306
|
+
*/
|
|
307
|
+
collectionName?: string | null;
|
|
308
|
+
/**
|
|
309
|
+
* ID of a single page built from a Wix Data collection, to change the pattern of that
|
|
310
|
+
* page alone.
|
|
311
|
+
*
|
|
312
|
+
* Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
|
|
313
|
+
* pattern for the type, and passing a page ID for one of those fails with
|
|
314
|
+
* `PAGE_ID_NOT_SUPPORTED`.
|
|
315
|
+
* @maxLength 200
|
|
316
|
+
*/
|
|
317
|
+
pageId?: string | null;
|
|
318
|
+
}
|
|
319
|
+
interface SetSeoPatternResponse {
|
|
320
|
+
/** The updated pattern. */
|
|
321
|
+
seoPattern?: SeoPattern;
|
|
322
|
+
}
|
|
323
|
+
interface ResetSeoPatternToDefaultRequest {
|
|
324
|
+
/**
|
|
325
|
+
* Page type whose pattern to reset. For example, `STATIC_PAGE`, `BLOG_POST`, or
|
|
326
|
+
* `STORES_PRODUCT`.
|
|
327
|
+
* @maxLength 100
|
|
328
|
+
*/
|
|
329
|
+
pageType: string;
|
|
330
|
+
/**
|
|
331
|
+
* Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
|
|
332
|
+
*
|
|
333
|
+
* To address a single page built from a Wix Data collection, pass its `pageId`.
|
|
334
|
+
* @maxLength 200
|
|
335
|
+
*/
|
|
336
|
+
collectionName?: string | null;
|
|
337
|
+
/**
|
|
338
|
+
* ID of a single page built from a Wix Data collection, to reset the pattern of that
|
|
339
|
+
* page alone.
|
|
340
|
+
*
|
|
341
|
+
* Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
|
|
342
|
+
* pattern for the type, and passing a page ID for one of those fails with
|
|
343
|
+
* `PAGE_ID_NOT_SUPPORTED`.
|
|
344
|
+
* @maxLength 200
|
|
345
|
+
*/
|
|
346
|
+
pageId?: string | null;
|
|
347
|
+
}
|
|
348
|
+
interface ResetSeoPatternToDefaultResponse {
|
|
349
|
+
/**
|
|
350
|
+
* The page type after the reset: an empty `pattern`, and `source` of
|
|
351
|
+
* `PATTERN_SOURCE_DEFAULT`.
|
|
352
|
+
*/
|
|
353
|
+
seoPattern?: SeoPattern;
|
|
354
|
+
}
|
|
355
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
356
|
+
createdEvent?: EntityCreatedEvent;
|
|
357
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
358
|
+
deletedEvent?: EntityDeletedEvent;
|
|
359
|
+
actionEvent?: ActionEvent;
|
|
360
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
361
|
+
id?: string;
|
|
362
|
+
/**
|
|
363
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
364
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
365
|
+
*/
|
|
366
|
+
entityFqdn?: string;
|
|
367
|
+
/**
|
|
368
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
369
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
370
|
+
*/
|
|
371
|
+
slug?: string;
|
|
372
|
+
/** ID of the entity associated with the event. */
|
|
373
|
+
entityId?: string;
|
|
374
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
375
|
+
eventTime?: Date | null;
|
|
376
|
+
/**
|
|
377
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
378
|
+
* (for example, GDPR).
|
|
379
|
+
*/
|
|
380
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
381
|
+
/** If present, indicates the action that triggered the event. */
|
|
382
|
+
originatedFrom?: string | null;
|
|
383
|
+
/**
|
|
384
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
|
|
385
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
386
|
+
*/
|
|
387
|
+
entityEventSequence?: string | null;
|
|
388
|
+
}
|
|
389
|
+
/** @oneof */
|
|
390
|
+
interface DomainEventBodyOneOf {
|
|
391
|
+
createdEvent?: EntityCreatedEvent;
|
|
392
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
393
|
+
deletedEvent?: EntityDeletedEvent;
|
|
394
|
+
actionEvent?: ActionEvent;
|
|
395
|
+
}
|
|
396
|
+
interface EntityCreatedEvent {
|
|
397
|
+
entityAsJson?: string;
|
|
398
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
399
|
+
restoreInfo?: RestoreInfo;
|
|
400
|
+
}
|
|
401
|
+
interface RestoreInfo {
|
|
402
|
+
deletedDate?: Date | null;
|
|
403
|
+
}
|
|
404
|
+
interface EntityUpdatedEvent {
|
|
405
|
+
/**
|
|
406
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
407
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
408
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
409
|
+
*/
|
|
410
|
+
currentEntityAsJson?: string;
|
|
411
|
+
}
|
|
412
|
+
interface EntityDeletedEvent {
|
|
413
|
+
/** Entity that was deleted. */
|
|
414
|
+
deletedEntityAsJson?: string | null;
|
|
415
|
+
}
|
|
416
|
+
interface ActionEvent {
|
|
417
|
+
bodyAsJson?: string;
|
|
418
|
+
}
|
|
419
|
+
interface MessageEnvelope {
|
|
420
|
+
/**
|
|
421
|
+
* App instance ID.
|
|
422
|
+
* @format GUID
|
|
423
|
+
*/
|
|
424
|
+
instanceId?: string | null;
|
|
425
|
+
/**
|
|
426
|
+
* Event type.
|
|
427
|
+
* @maxLength 150
|
|
428
|
+
*/
|
|
429
|
+
eventType?: string;
|
|
430
|
+
/** The identification type and identity data. */
|
|
431
|
+
identity?: IdentificationData;
|
|
432
|
+
/** Stringify payload. */
|
|
433
|
+
data?: string;
|
|
434
|
+
/** Details related to the account */
|
|
435
|
+
accountInfo?: AccountInfo;
|
|
436
|
+
}
|
|
437
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
438
|
+
/**
|
|
439
|
+
* ID of a site visitor that has not logged in to the site.
|
|
440
|
+
* @format GUID
|
|
441
|
+
*/
|
|
442
|
+
anonymousVisitorId?: string;
|
|
443
|
+
/**
|
|
444
|
+
* ID of a site visitor that has logged in to the site.
|
|
445
|
+
* @format GUID
|
|
446
|
+
*/
|
|
447
|
+
memberId?: string;
|
|
448
|
+
/**
|
|
449
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
450
|
+
* @format GUID
|
|
451
|
+
*/
|
|
452
|
+
wixUserId?: string;
|
|
453
|
+
/**
|
|
454
|
+
* ID of an app.
|
|
455
|
+
* @format GUID
|
|
456
|
+
*/
|
|
457
|
+
appId?: string;
|
|
458
|
+
/** @readonly */
|
|
459
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
460
|
+
}
|
|
461
|
+
/** @oneof */
|
|
462
|
+
interface IdentificationDataIdOneOf {
|
|
463
|
+
/**
|
|
464
|
+
* ID of a site visitor that has not logged in to the site.
|
|
465
|
+
* @format GUID
|
|
466
|
+
*/
|
|
467
|
+
anonymousVisitorId?: string;
|
|
468
|
+
/**
|
|
469
|
+
* ID of a site visitor that has logged in to the site.
|
|
470
|
+
* @format GUID
|
|
471
|
+
*/
|
|
472
|
+
memberId?: string;
|
|
473
|
+
/**
|
|
474
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
475
|
+
* @format GUID
|
|
476
|
+
*/
|
|
477
|
+
wixUserId?: string;
|
|
478
|
+
/**
|
|
479
|
+
* ID of an app.
|
|
480
|
+
* @format GUID
|
|
481
|
+
*/
|
|
482
|
+
appId?: string;
|
|
483
|
+
}
|
|
484
|
+
declare enum WebhookIdentityType {
|
|
485
|
+
UNKNOWN = "UNKNOWN",
|
|
486
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
487
|
+
MEMBER = "MEMBER",
|
|
488
|
+
WIX_USER = "WIX_USER",
|
|
489
|
+
APP = "APP"
|
|
490
|
+
}
|
|
491
|
+
/** @enumType */
|
|
492
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
493
|
+
interface AccountInfo {
|
|
494
|
+
/**
|
|
495
|
+
* ID of the Wix account associated with the event.
|
|
496
|
+
* @format GUID
|
|
497
|
+
*/
|
|
498
|
+
accountId?: string | null;
|
|
499
|
+
/**
|
|
500
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
501
|
+
* @format GUID
|
|
502
|
+
*/
|
|
503
|
+
parentAccountId?: string | null;
|
|
504
|
+
/**
|
|
505
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
506
|
+
* @format GUID
|
|
507
|
+
*/
|
|
508
|
+
siteId?: string | null;
|
|
509
|
+
}
|
|
510
|
+
/** @docsIgnore */
|
|
511
|
+
type GetSeoPatternApplicationErrors = {
|
|
512
|
+
code?: 'UNSUPPORTED_PAGE_TYPE';
|
|
513
|
+
description?: string;
|
|
514
|
+
data?: Record<string, any>;
|
|
515
|
+
};
|
|
516
|
+
/** @docsIgnore */
|
|
517
|
+
type ListSeoPatternVariablesApplicationErrors = {
|
|
518
|
+
code?: 'UNSUPPORTED_PAGE_TYPE';
|
|
519
|
+
description?: string;
|
|
520
|
+
data?: Record<string, any>;
|
|
521
|
+
};
|
|
522
|
+
/** @docsIgnore */
|
|
523
|
+
type CreateSeoPatternApplicationErrors = {
|
|
524
|
+
code?: 'UNSUPPORTED_PAGE_TYPE';
|
|
525
|
+
description?: string;
|
|
526
|
+
data?: Record<string, any>;
|
|
527
|
+
} | {
|
|
528
|
+
code?: 'INVALID_PATTERN';
|
|
529
|
+
description?: string;
|
|
530
|
+
data?: Record<string, any>;
|
|
531
|
+
} | {
|
|
532
|
+
code?: 'PATTERN_ALREADY_EXISTS';
|
|
533
|
+
description?: string;
|
|
534
|
+
data?: Record<string, any>;
|
|
535
|
+
};
|
|
536
|
+
/** @docsIgnore */
|
|
537
|
+
type SetSeoPatternApplicationErrors = {
|
|
538
|
+
code?: 'UNSUPPORTED_PAGE_TYPE';
|
|
539
|
+
description?: string;
|
|
540
|
+
data?: Record<string, any>;
|
|
541
|
+
} | {
|
|
542
|
+
code?: 'INVALID_PATTERN';
|
|
543
|
+
description?: string;
|
|
544
|
+
data?: Record<string, any>;
|
|
545
|
+
} | {
|
|
546
|
+
code?: 'INVALID_FIELD_MASK';
|
|
547
|
+
description?: string;
|
|
548
|
+
data?: Record<string, any>;
|
|
549
|
+
} | {
|
|
550
|
+
code?: 'PATTERN_NOT_FOUND';
|
|
551
|
+
description?: string;
|
|
552
|
+
data?: Record<string, any>;
|
|
553
|
+
};
|
|
554
|
+
/** @docsIgnore */
|
|
555
|
+
type ResetSeoPatternToDefaultApplicationErrors = {
|
|
556
|
+
code?: 'UNSUPPORTED_PAGE_TYPE';
|
|
557
|
+
description?: string;
|
|
558
|
+
data?: Record<string, any>;
|
|
559
|
+
} | {
|
|
560
|
+
code?: 'PATTERN_NOT_FOUND';
|
|
561
|
+
description?: string;
|
|
562
|
+
data?: Record<string, any>;
|
|
563
|
+
};
|
|
564
|
+
|
|
565
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
566
|
+
getUrl: (context: any) => string;
|
|
567
|
+
httpMethod: K;
|
|
568
|
+
path: string;
|
|
569
|
+
pathParams: M;
|
|
570
|
+
__requestType: T;
|
|
571
|
+
__originalRequestType: S;
|
|
572
|
+
__responseType: Q;
|
|
573
|
+
__originalResponseType: R;
|
|
574
|
+
};
|
|
575
|
+
declare function getSeoPattern(): __PublicMethodMetaInfo<'GET', {
|
|
576
|
+
pageType: string;
|
|
577
|
+
}, GetSeoPatternRequest$1, GetSeoPatternRequest, GetSeoPatternResponse$1, GetSeoPatternResponse>;
|
|
578
|
+
declare function listSeoPatterns(): __PublicMethodMetaInfo<'GET', {}, ListSeoPatternsRequest$1, ListSeoPatternsRequest, ListSeoPatternsResponse$1, ListSeoPatternsResponse>;
|
|
579
|
+
declare function listSeoPatternVariables(): __PublicMethodMetaInfo<'GET', {
|
|
580
|
+
pageType: string;
|
|
581
|
+
}, ListSeoPatternVariablesRequest$1, ListSeoPatternVariablesRequest, ListSeoPatternVariablesResponse$1, ListSeoPatternVariablesResponse>;
|
|
582
|
+
declare function createSeoPattern(): __PublicMethodMetaInfo<'POST', {
|
|
583
|
+
pageType: string;
|
|
584
|
+
}, CreateSeoPatternRequest$1, CreateSeoPatternRequest, CreateSeoPatternResponse$1, CreateSeoPatternResponse>;
|
|
585
|
+
declare function setSeoPattern(): __PublicMethodMetaInfo<'PATCH', {
|
|
586
|
+
pageType: string;
|
|
587
|
+
}, SetSeoPatternRequest$1, SetSeoPatternRequest, SetSeoPatternResponse$1, SetSeoPatternResponse>;
|
|
588
|
+
declare function resetSeoPatternToDefault(): __PublicMethodMetaInfo<'POST', {
|
|
589
|
+
pageType: string;
|
|
590
|
+
}, ResetSeoPatternToDefaultRequest$1, ResetSeoPatternToDefaultRequest, ResetSeoPatternToDefaultResponse$1, ResetSeoPatternToDefaultResponse>;
|
|
591
|
+
|
|
592
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type CreateSeoPatternApplicationErrors as CreateSeoPatternApplicationErrorsOriginal, type CreateSeoPatternRequest as CreateSeoPatternRequestOriginal, type CreateSeoPatternResponse as CreateSeoPatternResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type GetSeoPatternApplicationErrors as GetSeoPatternApplicationErrorsOriginal, type GetSeoPatternRequest as GetSeoPatternRequestOriginal, type GetSeoPatternResponse as GetSeoPatternResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ListSeoPatternVariablesApplicationErrors as ListSeoPatternVariablesApplicationErrorsOriginal, type ListSeoPatternVariablesRequest as ListSeoPatternVariablesRequestOriginal, type ListSeoPatternVariablesResponse as ListSeoPatternVariablesResponseOriginal, type ListSeoPatternsRequest as ListSeoPatternsRequestOriginal, type ListSeoPatternsResponse as ListSeoPatternsResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, PatternSource as PatternSourceOriginal, type PatternSourceWithLiterals as PatternSourceWithLiteralsOriginal, type ResetSeoPatternToDefaultApplicationErrors as ResetSeoPatternToDefaultApplicationErrorsOriginal, type ResetSeoPatternToDefaultRequest as ResetSeoPatternToDefaultRequestOriginal, type ResetSeoPatternToDefaultResponse as ResetSeoPatternToDefaultResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type SeoPatternBlob as SeoPatternBlobOriginal, type SeoPattern as SeoPatternOriginal, type SeoPatternVariable as SeoPatternVariableOriginal, type SetSeoPatternApplicationErrors as SetSeoPatternApplicationErrorsOriginal, type SetSeoPatternRequest as SetSeoPatternRequestOriginal, type SetSeoPatternResponse as SetSeoPatternResponseOriginal, type Tag as TagOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createSeoPattern, getSeoPattern, listSeoPatternVariables, listSeoPatterns, resetSeoPatternToDefault, setSeoPattern };
|