@wix/auto_sdk_multilingual_locale-settings 1.0.3 → 1.0.5
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 +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.d.ts +2 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.js +20 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.js.map +1 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.d.ts +20 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.js +143 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.js.map +1 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.d.ts +15 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js +85 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js.map +1 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.d.ts +4 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.js +35 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.js.map +1 -0
- package/build/{internal/multilingual-settings-v2-locale-settings-locale-settings.universal-DWm_DkN7.d.mts → cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts} +195 -116
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.js +148 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.js.map +1 -0
- package/build/{index.d.mts → cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.d.ts} +183 -106
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js +286 -0
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.d.ts +2 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.js +10 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.js.map +1 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.d.ts +20 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.js +137 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.js.map +1 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.d.ts +15 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js +56 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js.map +1 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.d.ts +4 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.js +22 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.js.map +1 -0
- package/build/{internal/multilingual-settings-v2-locale-settings-locale-settings.universal-DWm_DkN7.d.ts → es/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts} +195 -116
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.js +145 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.js.map +1 -0
- package/build/{index.d.ts → es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.d.ts} +183 -106
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js +257 -0
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.d.ts +10 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.js +20 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.js.map +1 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.d.ts +20 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.js +143 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.js.map +1 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.d.ts +15 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js +85 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js.map +1 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.d.ts +48 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.js +35 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.js.map +1 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts +772 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.js +148 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.js.map +1 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.d.ts +824 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js +286 -0
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.d.ts +10 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.js +10 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.js.map +1 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.d.ts +20 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.js +137 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.js.map +1 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.d.ts +15 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js +56 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js.map +1 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.d.ts +48 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.js +22 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.js.map +1 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts +772 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.js +145 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.js.map +1 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.d.ts +824 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js +257 -0
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.js +0 -356
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -323
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -44
- package/build/internal/index.d.ts +0 -44
- package/build/internal/index.js +0 -356
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -323
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -211
- package/build/internal/meta.d.ts +0 -211
- package/build/internal/meta.js +0 -218
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -189
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -211
- package/build/meta.d.ts +0 -211
- package/build/meta.js +0 -218
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -189
- package/build/meta.mjs.map +0 -1
|
@@ -1,204 +1,211 @@
|
|
|
1
|
-
|
|
2
|
-
* Settings is a 'single entity per tenant' entity with META-SITE tenancy.
|
|
3
|
-
* This means that Settings is active for every site, not only sites that have multilingual functionality installed.
|
|
4
|
-
*/
|
|
5
|
-
interface LocaleSettings {
|
|
1
|
+
export interface LocaleSettings {
|
|
6
2
|
/**
|
|
7
|
-
*
|
|
8
|
-
* It's created automatically for each site.
|
|
9
|
-
* Revision number, used for optimistic locking
|
|
3
|
+
* Revision number, which increments by 1 each time the locale settings object is updated. To prevent conflicting changes, the existing revision must be passed when updating the locale settings object.
|
|
10
4
|
* @readonly
|
|
11
5
|
*/
|
|
12
6
|
revision?: string | null;
|
|
13
7
|
/**
|
|
14
|
-
*
|
|
8
|
+
* Date and time the locale settings were created.
|
|
15
9
|
* @readonly
|
|
16
10
|
*/
|
|
17
|
-
|
|
11
|
+
createdDate?: Date | null;
|
|
18
12
|
/**
|
|
19
|
-
*
|
|
13
|
+
* Date and time the locale settings were last updated.
|
|
20
14
|
* @readonly
|
|
21
15
|
*/
|
|
22
|
-
|
|
16
|
+
updatedDate?: Date | null;
|
|
23
17
|
/**
|
|
24
18
|
* Indicates whether multilingual mode is enabled for the site.
|
|
25
|
-
*
|
|
26
|
-
* When true
|
|
27
|
-
* Changing this value may have significant implications for the site's content and structure.
|
|
19
|
+
*
|
|
20
|
+
* When set to `true`, you can create secondary locales.
|
|
28
21
|
* @readonly
|
|
29
22
|
*/
|
|
30
23
|
multilingualModeEnabled?: boolean | null;
|
|
31
24
|
/**
|
|
32
|
-
*
|
|
33
|
-
*
|
|
25
|
+
* Indicates whether the live site will automatically open in a secondary locale if the
|
|
26
|
+
* site visitor's browser is set to that locale.
|
|
27
|
+
*
|
|
28
|
+
* Default: `false`
|
|
29
|
+
*
|
|
30
|
+
* <blockquote class="caution">
|
|
31
|
+
*
|
|
32
|
+
* __Caution:__
|
|
33
|
+
* Auto-switch can harm SEO by causing duplicate content issues and restricting search engine indexing of different language versions, which limits visibility in search results.
|
|
34
|
+
*
|
|
35
|
+
* </blockquote>
|
|
34
36
|
*/
|
|
35
37
|
autoSwitch?: boolean | null;
|
|
36
38
|
/**
|
|
37
|
-
* Defines how secondary languages
|
|
38
|
-
*
|
|
39
|
+
* Defines the default method for how secondary languages appear in the live site's URL.
|
|
40
|
+
* The URL structure can be overridden per locale, using the Locale API.
|
|
41
|
+
*
|
|
42
|
+
* Default: `"SUBDIRECTORY"`
|
|
39
43
|
*/
|
|
40
44
|
urlStructure?: UrlStructure;
|
|
41
45
|
/**
|
|
42
|
-
* The primary locale
|
|
46
|
+
* The site's primary locale.
|
|
43
47
|
* @readonly
|
|
44
48
|
*/
|
|
45
49
|
primaryLocale?: Locale;
|
|
46
50
|
}
|
|
47
51
|
/** Enum representing the method for resolving locales in URLs. */
|
|
48
|
-
declare enum UrlStructure {
|
|
49
|
-
/**
|
|
52
|
+
export declare enum UrlStructure {
|
|
53
|
+
/** Undefined resolution method. */
|
|
50
54
|
UNDEFINED_RESOLUTION_METHOD = "UNDEFINED_RESOLUTION_METHOD",
|
|
51
|
-
/** www.mysite.com/fr */
|
|
55
|
+
/** Subdirectory resolution method for the URL structure. For example, `"www.mysite.com/fr"`. */
|
|
52
56
|
SUBDIRECTORY = "SUBDIRECTORY",
|
|
53
|
-
/** fr.mysite.com */
|
|
57
|
+
/** Subdomain resolution method for the URL structure. For example, `"fr.mysite.com"`. */
|
|
54
58
|
SUBDOMAIN = "SUBDOMAIN",
|
|
55
|
-
/** www.mysite.com?lang=fr */
|
|
59
|
+
/** Query parameter resolution method for the URL structure. For example, `"www.mysite.com?lang=fr"`. */
|
|
56
60
|
QUERY_PARAM = "QUERY_PARAM"
|
|
57
61
|
}
|
|
58
|
-
|
|
59
|
-
interface Locale {
|
|
62
|
+
export interface Locale {
|
|
60
63
|
/**
|
|
61
|
-
* Locale ID. The ID is
|
|
64
|
+
* Locale ID. The ID is made up of the language and region codes. For example, `"en-US"`.
|
|
62
65
|
* @maxLength 20
|
|
63
66
|
* @format LANGUAGE_TAG
|
|
64
67
|
* @readonly
|
|
65
68
|
* @immutable
|
|
66
69
|
*/
|
|
67
|
-
|
|
70
|
+
id?: string | null;
|
|
68
71
|
/**
|
|
69
|
-
* Revision number
|
|
72
|
+
* Revision number, which increments by 1 each time the locale is updated. To prevent conflicting changes, the existing revision must be passed when updating the locale object.
|
|
70
73
|
* @readonly
|
|
71
74
|
*/
|
|
72
75
|
revision?: string | null;
|
|
73
76
|
/**
|
|
74
|
-
* Date and time the
|
|
77
|
+
* Date and time the locale was created.
|
|
75
78
|
* @readonly
|
|
76
79
|
*/
|
|
77
|
-
|
|
80
|
+
createdDate?: Date | null;
|
|
78
81
|
/**
|
|
79
|
-
* Date and time the
|
|
82
|
+
* Date and time the locale was last updated.
|
|
80
83
|
* @readonly
|
|
81
84
|
*/
|
|
82
|
-
|
|
85
|
+
updatedDate?: Date | null;
|
|
83
86
|
/**
|
|
84
|
-
* Language code
|
|
87
|
+
* Language code. For example, `"en"` for English.
|
|
85
88
|
* @immutable
|
|
86
89
|
* @format LANGUAGE
|
|
87
90
|
*/
|
|
88
91
|
languageCode?: string | null;
|
|
89
92
|
/**
|
|
90
|
-
* Region code
|
|
93
|
+
* Region code. For example, `"UK"` for United Kingdom.
|
|
91
94
|
* @immutable
|
|
92
95
|
* @format COUNTRY
|
|
93
96
|
*/
|
|
94
97
|
regionCode?: string | null;
|
|
95
|
-
/**
|
|
96
|
-
* HIDDEN - locale will be available for the user to see it in editor and preview but won't be available for UoU
|
|
97
|
-
* VISIBLE - locale will be available for the user to see it in editor and preview and be available for UoU to view the site in the specific locale, the URL of the page will indicate the locale according to the `effective_resolution_method` (e.g. www.mysite.com/es)
|
|
98
|
-
*/
|
|
98
|
+
/** Locale visibility status. */
|
|
99
99
|
visibility?: LocaleVisibility;
|
|
100
100
|
/**
|
|
101
|
-
* Indicates
|
|
101
|
+
* Indicates whether the locale is the site's primary locale.
|
|
102
102
|
* @readonly
|
|
103
103
|
*/
|
|
104
104
|
primaryLocale?: boolean | null;
|
|
105
105
|
/**
|
|
106
|
-
* Indicates
|
|
106
|
+
* Indicates whether the locale is treated as the default for site visitors when no language is specified in the URL of the site.
|
|
107
107
|
* @readonly
|
|
108
108
|
*/
|
|
109
109
|
visitorPrimaryLocale?: boolean | null;
|
|
110
110
|
/**
|
|
111
|
-
* Flag code
|
|
111
|
+
* Flag as a 3-letter language code based on Wix's supported locales. For example, `"USA"` for the United States flag.
|
|
112
112
|
* @maxLength 3
|
|
113
113
|
*/
|
|
114
114
|
flag?: string | null;
|
|
115
115
|
/**
|
|
116
|
-
*
|
|
116
|
+
* Regional format for determining how to display data types such as dates, times, numbers, and currencies. For example, `"en-US"` for US English formatting.
|
|
117
117
|
* @format LANGUAGE_TAG
|
|
118
118
|
*/
|
|
119
119
|
regionalFormat?: string | null;
|
|
120
120
|
/**
|
|
121
|
-
*
|
|
122
|
-
*
|
|
121
|
+
* Default URL structure for the locale's live site URL,
|
|
122
|
+
* based on the locale's settings, unless overridden.
|
|
123
123
|
* @readonly
|
|
124
124
|
*/
|
|
125
125
|
effectiveUrlStructure?: UrlStructure;
|
|
126
|
-
/**
|
|
126
|
+
/** Optional override for the locale's default URL structure. */
|
|
127
127
|
urlStructureOverride?: UrlStructureOverride;
|
|
128
128
|
/**
|
|
129
|
-
*
|
|
130
|
-
*
|
|
129
|
+
* Language code based on Wix's supported locales, used to specify the target language when
|
|
130
|
+
* translatable content is sent for machine translation. For example, `"ES"` for Spanish
|
|
131
|
+
* or `"ZH_TW"` for Traditional Chinese.
|
|
132
|
+
*
|
|
133
|
+
* Default: The locale's `languageCode` value.
|
|
131
134
|
* @format LANGUAGE_TAG
|
|
132
135
|
*/
|
|
133
136
|
machineTranslationCode?: string | null;
|
|
134
137
|
/**
|
|
135
|
-
*
|
|
138
|
+
* The locale's `displayName`, unless overridden.
|
|
136
139
|
* @readonly
|
|
137
140
|
* @maxLength 30
|
|
138
141
|
*/
|
|
139
142
|
effectiveDisplayName?: string | null;
|
|
140
143
|
/**
|
|
141
|
-
*
|
|
144
|
+
* Default display name for the locale, inferred from the locale ID and region code.
|
|
142
145
|
* @readonly
|
|
143
146
|
* @maxLength 30
|
|
144
147
|
*/
|
|
145
148
|
displayName?: string | null;
|
|
146
149
|
/**
|
|
147
|
-
*
|
|
150
|
+
* Optional override for the locale's display name.
|
|
148
151
|
* @maxLength 30
|
|
149
152
|
*/
|
|
150
153
|
overrideDisplayName?: string | null;
|
|
151
154
|
}
|
|
152
155
|
/** Enum representing the visibility status of a locale. */
|
|
153
|
-
declare enum LocaleVisibility {
|
|
154
|
-
/**
|
|
156
|
+
export declare enum LocaleVisibility {
|
|
157
|
+
/** Undefined visibility status. */
|
|
155
158
|
UNDEFINED_LOCALE_STATUS = "UNDEFINED_LOCALE_STATUS",
|
|
156
|
-
/** Locale
|
|
159
|
+
/** Locale is hidden from site visitors. */
|
|
157
160
|
HIDDEN = "HIDDEN",
|
|
158
|
-
/** Locale
|
|
161
|
+
/** Locale is visible to site visitors. A site can only have up to 100 visible locales. */
|
|
159
162
|
VISIBLE = "VISIBLE"
|
|
160
163
|
}
|
|
161
164
|
/** Message for overriding the default resolution method. */
|
|
162
|
-
interface UrlStructureOverride {
|
|
163
|
-
/**
|
|
165
|
+
export interface UrlStructureOverride {
|
|
166
|
+
/** Resolution method that defines the URL structure to use instead of the default. */
|
|
164
167
|
urlStructure?: UrlStructure;
|
|
165
168
|
}
|
|
166
169
|
/** Payload for the event triggered when the multilingual_mode value changes */
|
|
167
|
-
interface MultilingualModeUpdated {
|
|
168
|
-
/** The primary locale when
|
|
170
|
+
export interface MultilingualModeUpdated {
|
|
171
|
+
/** The primary locale when `multilingualModeEnabled` is updated. */
|
|
169
172
|
primaryLocale?: Locale;
|
|
170
|
-
/** Indicates whether multilingual mode is enabled
|
|
173
|
+
/** Indicates whether the multilingual mode is enabled on the site. */
|
|
171
174
|
multilingualModeEnabled?: boolean;
|
|
172
175
|
}
|
|
173
176
|
/** Request message for retrieving multilingual settings */
|
|
174
|
-
interface GetLocaleSettingsRequest {
|
|
177
|
+
export interface GetLocaleSettingsRequest {
|
|
175
178
|
}
|
|
176
179
|
/** Response message containing the requested multilingual settings */
|
|
177
|
-
interface GetLocaleSettingsResponse {
|
|
178
|
-
/**
|
|
180
|
+
export interface GetLocaleSettingsResponse {
|
|
181
|
+
/** Retrieved locale settings. */
|
|
179
182
|
localeSettings?: LocaleSettings;
|
|
180
183
|
}
|
|
181
184
|
/** Request message for updating multilingual settings */
|
|
182
|
-
interface UpdateLocaleSettingsRequest {
|
|
183
|
-
/**
|
|
185
|
+
export interface UpdateLocaleSettingsRequest {
|
|
186
|
+
/** Locale settings to update. */
|
|
184
187
|
localeSettings: LocaleSettings;
|
|
185
188
|
}
|
|
186
189
|
/** Response message containing the updated multilingual settings */
|
|
187
|
-
interface UpdateLocaleSettingsResponse {
|
|
188
|
-
/**
|
|
190
|
+
export interface UpdateLocaleSettingsResponse {
|
|
191
|
+
/** Updated locale settings. */
|
|
189
192
|
localeSettings?: LocaleSettings;
|
|
190
193
|
}
|
|
191
194
|
/** Request message for setting the multilingual mode */
|
|
192
|
-
interface SetMultilingualModeRequest {
|
|
193
|
-
/**
|
|
195
|
+
export interface SetMultilingualModeRequest {
|
|
196
|
+
/**
|
|
197
|
+
* Whether to enable multilingual mode for the site.
|
|
198
|
+
*
|
|
199
|
+
* Default: `false`
|
|
200
|
+
*/
|
|
194
201
|
multilingualModeEnabled: boolean;
|
|
195
202
|
}
|
|
196
203
|
/** Response message containing the updated settings after changing the multilingual mode */
|
|
197
|
-
interface SetMultilingualModeResponse {
|
|
198
|
-
/**
|
|
204
|
+
export interface SetMultilingualModeResponse {
|
|
205
|
+
/** Updated locale settings. */
|
|
199
206
|
localeSettings?: LocaleSettings;
|
|
200
207
|
}
|
|
201
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
208
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
202
209
|
createdEvent?: EntityCreatedEvent;
|
|
203
210
|
updatedEvent?: EntityUpdatedEvent;
|
|
204
211
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -207,7 +214,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
207
214
|
* Unique event ID.
|
|
208
215
|
* Allows clients to ignore duplicate webhooks.
|
|
209
216
|
*/
|
|
210
|
-
|
|
217
|
+
id?: string;
|
|
211
218
|
/**
|
|
212
219
|
* Assumes actions are also always typed to an entity_type
|
|
213
220
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -241,36 +248,38 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
241
248
|
entityEventSequence?: string | null;
|
|
242
249
|
}
|
|
243
250
|
/** @oneof */
|
|
244
|
-
interface DomainEventBodyOneOf {
|
|
251
|
+
export interface DomainEventBodyOneOf {
|
|
245
252
|
createdEvent?: EntityCreatedEvent;
|
|
246
253
|
updatedEvent?: EntityUpdatedEvent;
|
|
247
254
|
deletedEvent?: EntityDeletedEvent;
|
|
248
255
|
actionEvent?: ActionEvent;
|
|
249
256
|
}
|
|
250
|
-
interface EntityCreatedEvent {
|
|
251
|
-
|
|
257
|
+
export interface EntityCreatedEvent {
|
|
258
|
+
entityAsJson?: string;
|
|
259
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
260
|
+
restoreInfo?: RestoreInfo;
|
|
252
261
|
}
|
|
253
|
-
interface RestoreInfo {
|
|
262
|
+
export interface RestoreInfo {
|
|
254
263
|
deletedDate?: Date | null;
|
|
255
264
|
}
|
|
256
|
-
interface EntityUpdatedEvent {
|
|
265
|
+
export interface EntityUpdatedEvent {
|
|
257
266
|
/**
|
|
258
267
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
259
268
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
260
269
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
261
270
|
*/
|
|
262
|
-
|
|
271
|
+
currentEntityAsJson?: string;
|
|
263
272
|
}
|
|
264
|
-
interface EntityDeletedEvent {
|
|
273
|
+
export interface EntityDeletedEvent {
|
|
265
274
|
/** Entity that was deleted */
|
|
266
|
-
|
|
275
|
+
deletedEntityAsJson?: string | null;
|
|
267
276
|
}
|
|
268
|
-
interface ActionEvent {
|
|
269
|
-
|
|
277
|
+
export interface ActionEvent {
|
|
278
|
+
bodyAsJson?: string;
|
|
270
279
|
}
|
|
271
|
-
interface Empty {
|
|
280
|
+
export interface Empty {
|
|
272
281
|
}
|
|
273
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
282
|
+
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
274
283
|
/** Emitted on a meta site creation. */
|
|
275
284
|
siteCreated?: SiteCreated;
|
|
276
285
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -301,6 +310,16 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
301
310
|
studioAssigned?: StudioAssigned;
|
|
302
311
|
/** Emitted when Studio is detached. */
|
|
303
312
|
studioUnassigned?: StudioUnassigned;
|
|
313
|
+
/**
|
|
314
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
315
|
+
* the actual URL.
|
|
316
|
+
*
|
|
317
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
318
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
319
|
+
*/
|
|
320
|
+
urlChanged?: SiteUrlChanged;
|
|
321
|
+
/** Site is marked as PurgedExternally */
|
|
322
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
304
323
|
/**
|
|
305
324
|
* A meta site id.
|
|
306
325
|
* @format GUID
|
|
@@ -318,7 +337,7 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
318
337
|
assets?: Asset[];
|
|
319
338
|
}
|
|
320
339
|
/** @oneof */
|
|
321
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
340
|
+
export interface MetaSiteSpecialEventPayloadOneOf {
|
|
322
341
|
/** Emitted on a meta site creation. */
|
|
323
342
|
siteCreated?: SiteCreated;
|
|
324
343
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -349,8 +368,18 @@ interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
349
368
|
studioAssigned?: StudioAssigned;
|
|
350
369
|
/** Emitted when Studio is detached. */
|
|
351
370
|
studioUnassigned?: StudioUnassigned;
|
|
371
|
+
/**
|
|
372
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
373
|
+
* the actual URL.
|
|
374
|
+
*
|
|
375
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
376
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
377
|
+
*/
|
|
378
|
+
urlChanged?: SiteUrlChanged;
|
|
379
|
+
/** Site is marked as PurgedExternally */
|
|
380
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
352
381
|
}
|
|
353
|
-
interface Asset {
|
|
382
|
+
export interface Asset {
|
|
354
383
|
/**
|
|
355
384
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
356
385
|
* @maxLength 36
|
|
@@ -364,14 +393,14 @@ interface Asset {
|
|
|
364
393
|
/** An application state. */
|
|
365
394
|
state?: State;
|
|
366
395
|
}
|
|
367
|
-
declare enum State {
|
|
396
|
+
export declare enum State {
|
|
368
397
|
UNKNOWN = "UNKNOWN",
|
|
369
398
|
ENABLED = "ENABLED",
|
|
370
399
|
DISABLED = "DISABLED",
|
|
371
400
|
PENDING = "PENDING",
|
|
372
401
|
DEMO = "DEMO"
|
|
373
402
|
}
|
|
374
|
-
interface SiteCreated {
|
|
403
|
+
export interface SiteCreated {
|
|
375
404
|
/**
|
|
376
405
|
* A template identifier (empty if not created from a template).
|
|
377
406
|
* @maxLength 36
|
|
@@ -400,7 +429,7 @@ interface SiteCreated {
|
|
|
400
429
|
/** A namespace. */
|
|
401
430
|
namespace?: Namespace;
|
|
402
431
|
}
|
|
403
|
-
declare enum SiteCreatedContext {
|
|
432
|
+
export declare enum SiteCreatedContext {
|
|
404
433
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
405
434
|
OTHER = "OTHER",
|
|
406
435
|
/** A meta site was created from template. */
|
|
@@ -414,7 +443,7 @@ declare enum SiteCreatedContext {
|
|
|
414
443
|
/** deprecated A meta site was created for Flash editor. */
|
|
415
444
|
FLASH = "FLASH"
|
|
416
445
|
}
|
|
417
|
-
declare enum Namespace {
|
|
446
|
+
export declare enum Namespace {
|
|
418
447
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
419
448
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
420
449
|
WIX = "WIX",
|
|
@@ -481,10 +510,23 @@ declare enum Namespace {
|
|
|
481
510
|
*/
|
|
482
511
|
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
483
512
|
/** Codux Headless Sites */
|
|
484
|
-
CODUX = "CODUX"
|
|
513
|
+
CODUX = "CODUX",
|
|
514
|
+
/** Bobb - AI Design Creator. */
|
|
515
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
516
|
+
/**
|
|
517
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
518
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
519
|
+
*/
|
|
520
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
521
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
522
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
523
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
524
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
525
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
526
|
+
MIMIR = "MIMIR"
|
|
485
527
|
}
|
|
486
528
|
/** Site transferred to another user. */
|
|
487
|
-
interface SiteTransferred {
|
|
529
|
+
export interface SiteTransferred {
|
|
488
530
|
/**
|
|
489
531
|
* A previous owner id (user that transfers meta site).
|
|
490
532
|
* @format GUID
|
|
@@ -497,11 +539,11 @@ interface SiteTransferred {
|
|
|
497
539
|
newOwnerId?: string;
|
|
498
540
|
}
|
|
499
541
|
/** Soft deletion of the meta site. Could be restored. */
|
|
500
|
-
interface SiteDeleted {
|
|
542
|
+
export interface SiteDeleted {
|
|
501
543
|
/** A deletion context. */
|
|
502
544
|
deleteContext?: DeleteContext;
|
|
503
545
|
}
|
|
504
|
-
interface DeleteContext {
|
|
546
|
+
export interface DeleteContext {
|
|
505
547
|
/** When the meta site was deleted. */
|
|
506
548
|
dateDeleted?: Date | null;
|
|
507
549
|
/** A status. */
|
|
@@ -517,19 +559,20 @@ interface DeleteContext {
|
|
|
517
559
|
*/
|
|
518
560
|
initiatorId?: string | null;
|
|
519
561
|
}
|
|
520
|
-
declare enum DeleteStatus {
|
|
562
|
+
export declare enum DeleteStatus {
|
|
521
563
|
UNKNOWN = "UNKNOWN",
|
|
522
564
|
TRASH = "TRASH",
|
|
523
565
|
DELETED = "DELETED",
|
|
524
|
-
PENDING_PURGE = "PENDING_PURGE"
|
|
566
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
567
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
525
568
|
}
|
|
526
569
|
/** Restoration of the meta site. */
|
|
527
|
-
interface SiteUndeleted {
|
|
570
|
+
export interface SiteUndeleted {
|
|
528
571
|
}
|
|
529
572
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
530
|
-
interface SitePublished {
|
|
573
|
+
export interface SitePublished {
|
|
531
574
|
}
|
|
532
|
-
interface SiteUnpublished {
|
|
575
|
+
export interface SiteUnpublished {
|
|
533
576
|
/**
|
|
534
577
|
* A list of URLs previously associated with the meta site.
|
|
535
578
|
* @maxLength 4000
|
|
@@ -537,11 +580,26 @@ interface SiteUnpublished {
|
|
|
537
580
|
*/
|
|
538
581
|
urls?: string[];
|
|
539
582
|
}
|
|
540
|
-
interface SiteMarkedAsTemplate {
|
|
583
|
+
export interface SiteMarkedAsTemplate {
|
|
541
584
|
}
|
|
542
|
-
interface SiteMarkedAsWixSite {
|
|
585
|
+
export interface SiteMarkedAsWixSite {
|
|
543
586
|
}
|
|
544
|
-
|
|
587
|
+
/**
|
|
588
|
+
* Represents a service provisioned a site.
|
|
589
|
+
*
|
|
590
|
+
* Note on `origin_instance_id`:
|
|
591
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
592
|
+
* This is because of the following scenario:
|
|
593
|
+
*
|
|
594
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
595
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
596
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
597
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
598
|
+
* your site remains consistent with what you initially received and does not include any
|
|
599
|
+
* changes made to the original template afterward.
|
|
600
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
601
|
+
*/
|
|
602
|
+
export interface ServiceProvisioned {
|
|
545
603
|
/**
|
|
546
604
|
* Either UUID or EmbeddedServiceType.
|
|
547
605
|
* @maxLength 36
|
|
@@ -568,7 +626,7 @@ interface ServiceProvisioned {
|
|
|
568
626
|
*/
|
|
569
627
|
originMetaSiteId?: string | null;
|
|
570
628
|
}
|
|
571
|
-
interface ServiceRemoved {
|
|
629
|
+
export interface ServiceRemoved {
|
|
572
630
|
/**
|
|
573
631
|
* Either UUID or EmbeddedServiceType.
|
|
574
632
|
* @maxLength 36
|
|
@@ -586,7 +644,7 @@ interface ServiceRemoved {
|
|
|
586
644
|
version?: string | null;
|
|
587
645
|
}
|
|
588
646
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
589
|
-
interface SiteRenamed {
|
|
647
|
+
export interface SiteRenamed {
|
|
590
648
|
/**
|
|
591
649
|
* A new meta site name (URL slug).
|
|
592
650
|
* @maxLength 20
|
|
@@ -603,23 +661,46 @@ interface SiteRenamed {
|
|
|
603
661
|
*
|
|
604
662
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
605
663
|
*/
|
|
606
|
-
interface SiteHardDeleted {
|
|
664
|
+
export interface SiteHardDeleted {
|
|
607
665
|
/** A deletion context. */
|
|
608
666
|
deleteContext?: DeleteContext;
|
|
609
667
|
}
|
|
610
|
-
interface NamespaceChanged {
|
|
668
|
+
export interface NamespaceChanged {
|
|
611
669
|
/** A previous namespace. */
|
|
612
670
|
oldNamespace?: Namespace;
|
|
613
671
|
/** A new namespace. */
|
|
614
672
|
newNamespace?: Namespace;
|
|
615
673
|
}
|
|
616
674
|
/** Assigned Studio editor */
|
|
617
|
-
interface StudioAssigned {
|
|
675
|
+
export interface StudioAssigned {
|
|
618
676
|
}
|
|
619
677
|
/** Unassigned Studio editor */
|
|
620
|
-
interface StudioUnassigned {
|
|
678
|
+
export interface StudioUnassigned {
|
|
679
|
+
}
|
|
680
|
+
/**
|
|
681
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
682
|
+
*
|
|
683
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
684
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
685
|
+
*
|
|
686
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
687
|
+
*/
|
|
688
|
+
export interface SiteUrlChanged {
|
|
689
|
+
}
|
|
690
|
+
/**
|
|
691
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
692
|
+
* Consumed by other teams to remove relevant data.
|
|
693
|
+
*/
|
|
694
|
+
export interface SitePurgedExternally {
|
|
695
|
+
/**
|
|
696
|
+
* @maxLength 2048
|
|
697
|
+
* @maxSize 100
|
|
698
|
+
* @deprecated
|
|
699
|
+
* @targetRemovalDate 2025-04-15
|
|
700
|
+
*/
|
|
701
|
+
appDefId?: string[];
|
|
621
702
|
}
|
|
622
|
-
interface MessageEnvelope {
|
|
703
|
+
export interface MessageEnvelope {
|
|
623
704
|
/**
|
|
624
705
|
* App instance ID.
|
|
625
706
|
* @format GUID
|
|
@@ -635,7 +716,7 @@ interface MessageEnvelope {
|
|
|
635
716
|
/** Stringify payload. */
|
|
636
717
|
data?: string;
|
|
637
718
|
}
|
|
638
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
719
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
639
720
|
/**
|
|
640
721
|
* ID of a site visitor that has not logged in to the site.
|
|
641
722
|
* @format GUID
|
|
@@ -660,7 +741,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
660
741
|
identityType?: WebhookIdentityType;
|
|
661
742
|
}
|
|
662
743
|
/** @oneof */
|
|
663
|
-
interface IdentificationDataIdOneOf {
|
|
744
|
+
export interface IdentificationDataIdOneOf {
|
|
664
745
|
/**
|
|
665
746
|
* ID of a site visitor that has not logged in to the site.
|
|
666
747
|
* @format GUID
|
|
@@ -682,12 +763,10 @@ interface IdentificationDataIdOneOf {
|
|
|
682
763
|
*/
|
|
683
764
|
appId?: string;
|
|
684
765
|
}
|
|
685
|
-
declare enum WebhookIdentityType {
|
|
766
|
+
export declare enum WebhookIdentityType {
|
|
686
767
|
UNKNOWN = "UNKNOWN",
|
|
687
768
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
688
769
|
MEMBER = "MEMBER",
|
|
689
770
|
WIX_USER = "WIX_USER",
|
|
690
771
|
APP = "APP"
|
|
691
772
|
}
|
|
692
|
-
|
|
693
|
-
export { type ActionEvent as A, type ServiceProvisioned as B, type ServiceRemoved as C, DeleteStatus as D, type EntityCreatedEvent as E, type SiteRenamed as F, type GetLocaleSettingsResponse as G, type SiteHardDeleted as H, type NamespaceChanged as I, type StudioAssigned as J, type StudioUnassigned as K, type LocaleSettings as L, type MultilingualModeUpdated as M, Namespace as N, type MessageEnvelope as O, type IdentificationData as P, type IdentificationDataIdOneOf as Q, type RestoreInfo as R, type SetMultilingualModeResponse as S, type UpdateLocaleSettingsResponse as U, WebhookIdentityType as W, UrlStructure as a, LocaleVisibility as b, State as c, SiteCreatedContext as d, type Locale as e, type UrlStructureOverride as f, type GetLocaleSettingsRequest as g, type UpdateLocaleSettingsRequest as h, type SetMultilingualModeRequest as i, type DomainEvent as j, type DomainEventBodyOneOf as k, type EntityUpdatedEvent as l, type EntityDeletedEvent as m, type Empty as n, type MetaSiteSpecialEvent as o, type MetaSiteSpecialEventPayloadOneOf as p, type Asset as q, type SiteCreated as r, type SiteTransferred as s, type SiteDeleted as t, type DeleteContext as u, type SiteUndeleted as v, type SitePublished as w, type SiteUnpublished as x, type SiteMarkedAsTemplate as y, type SiteMarkedAsWixSite as z };
|