@wix/auto_sdk_multilingual_locale-settings 1.0.2 → 1.0.4
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/{internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.d.ts → index.d.mts} +185 -160
- package/build/{internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.d.ts → index.d.ts} +185 -160
- package/build/index.js +362 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +329 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/index.d.mts +55 -0
- package/build/internal/index.d.ts +55 -0
- package/build/internal/index.js +362 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +329 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +218 -0
- package/build/internal/meta.d.ts +218 -0
- package/build/internal/meta.js +218 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +189 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.d.ts → internal/multilingual-settings-v2-locale-settings-locale-settings.universal-CEiXVHN_.d.mts} +185 -126
- package/build/{es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.d.ts → internal/multilingual-settings-v2-locale-settings-locale-settings.universal-CEiXVHN_.d.ts} +185 -126
- package/build/meta.d.mts +218 -0
- package/build/meta.d.ts +218 -0
- package/build/meta.js +218 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +189 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.d.ts +0 -2
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.js +0 -20
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.js.map +0 -1
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.d.ts +0 -11
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.js +0 -134
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.js.map +0 -1
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.d.ts +0 -15
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js +0 -85
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js.map +0 -1
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.d.ts +0 -4
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.js +0 -35
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.js.map +0 -1
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts +0 -715
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.js +0 -134
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.js.map +0 -1
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js +0 -261
- package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.d.ts +0 -2
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.js +0 -10
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.js.map +0 -1
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.d.ts +0 -11
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.js +0 -128
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.js.map +0 -1
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.d.ts +0 -15
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js +0 -56
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js.map +0 -1
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.d.ts +0 -4
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.js +0 -22
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.js.map +0 -1
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts +0 -715
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.js +0 -131
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.js.map +0 -1
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js +0 -232
- package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.d.ts +0 -10
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.js +0 -20
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.js.map +0 -1
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.d.ts +0 -11
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.js +0 -134
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.js.map +0 -1
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.d.ts +0 -15
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js +0 -85
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js.map +0 -1
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.d.ts +0 -37
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.js +0 -35
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.js.map +0 -1
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts +0 -715
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.js +0 -134
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.js.map +0 -1
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js +0 -261
- package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.d.ts +0 -10
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.js +0 -10
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.js.map +0 -1
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.d.ts +0 -11
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.js +0 -128
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.js.map +0 -1
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.d.ts +0 -15
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js +0 -56
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js.map +0 -1
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.d.ts +0 -37
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.js +0 -22
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.js.map +0 -1
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts +0 -715
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.js +0 -131
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.js.map +0 -1
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js +0 -232
- package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js.map +0 -1
|
@@ -1,64 +1,67 @@
|
|
|
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
|
-
export interface LocaleSettings {
|
|
1
|
+
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
|
-
|
|
49
|
-
/**
|
|
52
|
+
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
|
-
export interface Locale {
|
|
62
|
+
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
|
|
@@ -66,139 +69,143 @@ export interface Locale {
|
|
|
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
|
-
|
|
154
|
-
/**
|
|
156
|
+
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
|
-
|
|
163
|
-
/**
|
|
165
|
+
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
|
-
|
|
168
|
-
/** The primary locale when
|
|
170
|
+
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
|
-
|
|
177
|
+
interface GetLocaleSettingsRequest {
|
|
175
178
|
}
|
|
176
179
|
/** Response message containing the requested multilingual settings */
|
|
177
|
-
|
|
178
|
-
/**
|
|
180
|
+
interface GetLocaleSettingsResponse {
|
|
181
|
+
/** Retrieved locale settings. */
|
|
179
182
|
localeSettings?: LocaleSettings;
|
|
180
183
|
}
|
|
181
184
|
/** Request message for updating multilingual settings */
|
|
182
|
-
|
|
183
|
-
/**
|
|
185
|
+
interface UpdateLocaleSettingsRequest {
|
|
186
|
+
/** Locale settings to update. */
|
|
184
187
|
localeSettings: LocaleSettings;
|
|
185
188
|
}
|
|
186
189
|
/** Response message containing the updated multilingual settings */
|
|
187
|
-
|
|
188
|
-
/**
|
|
190
|
+
interface UpdateLocaleSettingsResponse {
|
|
191
|
+
/** Updated locale settings. */
|
|
189
192
|
localeSettings?: LocaleSettings;
|
|
190
193
|
}
|
|
191
194
|
/** Request message for setting the multilingual mode */
|
|
192
|
-
|
|
193
|
-
/**
|
|
195
|
+
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
|
-
|
|
198
|
-
/**
|
|
204
|
+
interface SetMultilingualModeResponse {
|
|
205
|
+
/** Updated locale settings. */
|
|
199
206
|
localeSettings?: LocaleSettings;
|
|
200
207
|
}
|
|
201
|
-
|
|
208
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
202
209
|
createdEvent?: EntityCreatedEvent;
|
|
203
210
|
updatedEvent?: EntityUpdatedEvent;
|
|
204
211
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -241,19 +248,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
241
248
|
entityEventSequence?: string | null;
|
|
242
249
|
}
|
|
243
250
|
/** @oneof */
|
|
244
|
-
|
|
251
|
+
interface DomainEventBodyOneOf {
|
|
245
252
|
createdEvent?: EntityCreatedEvent;
|
|
246
253
|
updatedEvent?: EntityUpdatedEvent;
|
|
247
254
|
deletedEvent?: EntityDeletedEvent;
|
|
248
255
|
actionEvent?: ActionEvent;
|
|
249
256
|
}
|
|
250
|
-
|
|
257
|
+
interface EntityCreatedEvent {
|
|
251
258
|
entity?: string;
|
|
252
259
|
}
|
|
253
|
-
|
|
260
|
+
interface RestoreInfo {
|
|
254
261
|
deletedDate?: Date | null;
|
|
255
262
|
}
|
|
256
|
-
|
|
263
|
+
interface EntityUpdatedEvent {
|
|
257
264
|
/**
|
|
258
265
|
* 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
266
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -261,16 +268,16 @@ export interface EntityUpdatedEvent {
|
|
|
261
268
|
*/
|
|
262
269
|
currentEntity?: string;
|
|
263
270
|
}
|
|
264
|
-
|
|
271
|
+
interface EntityDeletedEvent {
|
|
265
272
|
/** Entity that was deleted */
|
|
266
273
|
deletedEntity?: string | null;
|
|
267
274
|
}
|
|
268
|
-
|
|
275
|
+
interface ActionEvent {
|
|
269
276
|
body?: string;
|
|
270
277
|
}
|
|
271
|
-
|
|
278
|
+
interface Empty {
|
|
272
279
|
}
|
|
273
|
-
|
|
280
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
274
281
|
/** Emitted on a meta site creation. */
|
|
275
282
|
siteCreated?: SiteCreated;
|
|
276
283
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -301,6 +308,16 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
301
308
|
studioAssigned?: StudioAssigned;
|
|
302
309
|
/** Emitted when Studio is detached. */
|
|
303
310
|
studioUnassigned?: StudioUnassigned;
|
|
311
|
+
/**
|
|
312
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
313
|
+
* the actual URL.
|
|
314
|
+
*
|
|
315
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
316
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
317
|
+
*/
|
|
318
|
+
urlChanged?: SiteUrlChanged;
|
|
319
|
+
/** Site is marked as PurgedExternally */
|
|
320
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
304
321
|
/**
|
|
305
322
|
* A meta site id.
|
|
306
323
|
* @format GUID
|
|
@@ -318,7 +335,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
318
335
|
assets?: Asset[];
|
|
319
336
|
}
|
|
320
337
|
/** @oneof */
|
|
321
|
-
|
|
338
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
322
339
|
/** Emitted on a meta site creation. */
|
|
323
340
|
siteCreated?: SiteCreated;
|
|
324
341
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -349,8 +366,18 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
349
366
|
studioAssigned?: StudioAssigned;
|
|
350
367
|
/** Emitted when Studio is detached. */
|
|
351
368
|
studioUnassigned?: StudioUnassigned;
|
|
369
|
+
/**
|
|
370
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
371
|
+
* the actual URL.
|
|
372
|
+
*
|
|
373
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
374
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
375
|
+
*/
|
|
376
|
+
urlChanged?: SiteUrlChanged;
|
|
377
|
+
/** Site is marked as PurgedExternally */
|
|
378
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
352
379
|
}
|
|
353
|
-
|
|
380
|
+
interface Asset {
|
|
354
381
|
/**
|
|
355
382
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
356
383
|
* @maxLength 36
|
|
@@ -364,14 +391,14 @@ export interface Asset {
|
|
|
364
391
|
/** An application state. */
|
|
365
392
|
state?: State;
|
|
366
393
|
}
|
|
367
|
-
|
|
394
|
+
declare enum State {
|
|
368
395
|
UNKNOWN = "UNKNOWN",
|
|
369
396
|
ENABLED = "ENABLED",
|
|
370
397
|
DISABLED = "DISABLED",
|
|
371
398
|
PENDING = "PENDING",
|
|
372
399
|
DEMO = "DEMO"
|
|
373
400
|
}
|
|
374
|
-
|
|
401
|
+
interface SiteCreated {
|
|
375
402
|
/**
|
|
376
403
|
* A template identifier (empty if not created from a template).
|
|
377
404
|
* @maxLength 36
|
|
@@ -400,7 +427,7 @@ export interface SiteCreated {
|
|
|
400
427
|
/** A namespace. */
|
|
401
428
|
namespace?: Namespace;
|
|
402
429
|
}
|
|
403
|
-
|
|
430
|
+
declare enum SiteCreatedContext {
|
|
404
431
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
405
432
|
OTHER = "OTHER",
|
|
406
433
|
/** A meta site was created from template. */
|
|
@@ -414,7 +441,7 @@ export declare enum SiteCreatedContext {
|
|
|
414
441
|
/** deprecated A meta site was created for Flash editor. */
|
|
415
442
|
FLASH = "FLASH"
|
|
416
443
|
}
|
|
417
|
-
|
|
444
|
+
declare enum Namespace {
|
|
418
445
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
419
446
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
420
447
|
WIX = "WIX",
|
|
@@ -481,10 +508,23 @@ export declare enum Namespace {
|
|
|
481
508
|
*/
|
|
482
509
|
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
483
510
|
/** Codux Headless Sites */
|
|
484
|
-
CODUX = "CODUX"
|
|
511
|
+
CODUX = "CODUX",
|
|
512
|
+
/** Bobb - AI Design Creator. */
|
|
513
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
514
|
+
/**
|
|
515
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
516
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
517
|
+
*/
|
|
518
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
519
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
520
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
521
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
522
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
523
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
524
|
+
MIMIR = "MIMIR"
|
|
485
525
|
}
|
|
486
526
|
/** Site transferred to another user. */
|
|
487
|
-
|
|
527
|
+
interface SiteTransferred {
|
|
488
528
|
/**
|
|
489
529
|
* A previous owner id (user that transfers meta site).
|
|
490
530
|
* @format GUID
|
|
@@ -497,11 +537,11 @@ export interface SiteTransferred {
|
|
|
497
537
|
newOwnerId?: string;
|
|
498
538
|
}
|
|
499
539
|
/** Soft deletion of the meta site. Could be restored. */
|
|
500
|
-
|
|
540
|
+
interface SiteDeleted {
|
|
501
541
|
/** A deletion context. */
|
|
502
542
|
deleteContext?: DeleteContext;
|
|
503
543
|
}
|
|
504
|
-
|
|
544
|
+
interface DeleteContext {
|
|
505
545
|
/** When the meta site was deleted. */
|
|
506
546
|
dateDeleted?: Date | null;
|
|
507
547
|
/** A status. */
|
|
@@ -517,19 +557,20 @@ export interface DeleteContext {
|
|
|
517
557
|
*/
|
|
518
558
|
initiatorId?: string | null;
|
|
519
559
|
}
|
|
520
|
-
|
|
560
|
+
declare enum DeleteStatus {
|
|
521
561
|
UNKNOWN = "UNKNOWN",
|
|
522
562
|
TRASH = "TRASH",
|
|
523
563
|
DELETED = "DELETED",
|
|
524
|
-
PENDING_PURGE = "PENDING_PURGE"
|
|
564
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
565
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
525
566
|
}
|
|
526
567
|
/** Restoration of the meta site. */
|
|
527
|
-
|
|
568
|
+
interface SiteUndeleted {
|
|
528
569
|
}
|
|
529
570
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
530
|
-
|
|
571
|
+
interface SitePublished {
|
|
531
572
|
}
|
|
532
|
-
|
|
573
|
+
interface SiteUnpublished {
|
|
533
574
|
/**
|
|
534
575
|
* A list of URLs previously associated with the meta site.
|
|
535
576
|
* @maxLength 4000
|
|
@@ -537,11 +578,26 @@ export interface SiteUnpublished {
|
|
|
537
578
|
*/
|
|
538
579
|
urls?: string[];
|
|
539
580
|
}
|
|
540
|
-
|
|
581
|
+
interface SiteMarkedAsTemplate {
|
|
541
582
|
}
|
|
542
|
-
|
|
583
|
+
interface SiteMarkedAsWixSite {
|
|
543
584
|
}
|
|
544
|
-
|
|
585
|
+
/**
|
|
586
|
+
* Represents a service provisioned a site.
|
|
587
|
+
*
|
|
588
|
+
* Note on `origin_instance_id`:
|
|
589
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
590
|
+
* This is because of the following scenario:
|
|
591
|
+
*
|
|
592
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
593
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
594
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
595
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
596
|
+
* your site remains consistent with what you initially received and does not include any
|
|
597
|
+
* changes made to the original template afterward.
|
|
598
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
599
|
+
*/
|
|
600
|
+
interface ServiceProvisioned {
|
|
545
601
|
/**
|
|
546
602
|
* Either UUID or EmbeddedServiceType.
|
|
547
603
|
* @maxLength 36
|
|
@@ -568,7 +624,7 @@ export interface ServiceProvisioned {
|
|
|
568
624
|
*/
|
|
569
625
|
originMetaSiteId?: string | null;
|
|
570
626
|
}
|
|
571
|
-
|
|
627
|
+
interface ServiceRemoved {
|
|
572
628
|
/**
|
|
573
629
|
* Either UUID or EmbeddedServiceType.
|
|
574
630
|
* @maxLength 36
|
|
@@ -586,7 +642,7 @@ export interface ServiceRemoved {
|
|
|
586
642
|
version?: string | null;
|
|
587
643
|
}
|
|
588
644
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
589
|
-
|
|
645
|
+
interface SiteRenamed {
|
|
590
646
|
/**
|
|
591
647
|
* A new meta site name (URL slug).
|
|
592
648
|
* @maxLength 20
|
|
@@ -603,23 +659,46 @@ export interface SiteRenamed {
|
|
|
603
659
|
*
|
|
604
660
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
605
661
|
*/
|
|
606
|
-
|
|
662
|
+
interface SiteHardDeleted {
|
|
607
663
|
/** A deletion context. */
|
|
608
664
|
deleteContext?: DeleteContext;
|
|
609
665
|
}
|
|
610
|
-
|
|
666
|
+
interface NamespaceChanged {
|
|
611
667
|
/** A previous namespace. */
|
|
612
668
|
oldNamespace?: Namespace;
|
|
613
669
|
/** A new namespace. */
|
|
614
670
|
newNamespace?: Namespace;
|
|
615
671
|
}
|
|
616
672
|
/** Assigned Studio editor */
|
|
617
|
-
|
|
673
|
+
interface StudioAssigned {
|
|
618
674
|
}
|
|
619
675
|
/** Unassigned Studio editor */
|
|
620
|
-
|
|
676
|
+
interface StudioUnassigned {
|
|
677
|
+
}
|
|
678
|
+
/**
|
|
679
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
680
|
+
*
|
|
681
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
682
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
683
|
+
*
|
|
684
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
685
|
+
*/
|
|
686
|
+
interface SiteUrlChanged {
|
|
687
|
+
}
|
|
688
|
+
/**
|
|
689
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
690
|
+
* Consumed by other teams to remove relevant data.
|
|
691
|
+
*/
|
|
692
|
+
interface SitePurgedExternally {
|
|
693
|
+
/**
|
|
694
|
+
* @maxLength 2048
|
|
695
|
+
* @maxSize 100
|
|
696
|
+
* @deprecated
|
|
697
|
+
* @targetRemovalDate 2025-04-15
|
|
698
|
+
*/
|
|
699
|
+
appDefId?: string[];
|
|
621
700
|
}
|
|
622
|
-
|
|
701
|
+
interface MessageEnvelope {
|
|
623
702
|
/**
|
|
624
703
|
* App instance ID.
|
|
625
704
|
* @format GUID
|
|
@@ -635,7 +714,7 @@ export interface MessageEnvelope {
|
|
|
635
714
|
/** Stringify payload. */
|
|
636
715
|
data?: string;
|
|
637
716
|
}
|
|
638
|
-
|
|
717
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
639
718
|
/**
|
|
640
719
|
* ID of a site visitor that has not logged in to the site.
|
|
641
720
|
* @format GUID
|
|
@@ -660,7 +739,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
660
739
|
identityType?: WebhookIdentityType;
|
|
661
740
|
}
|
|
662
741
|
/** @oneof */
|
|
663
|
-
|
|
742
|
+
interface IdentificationDataIdOneOf {
|
|
664
743
|
/**
|
|
665
744
|
* ID of a site visitor that has not logged in to the site.
|
|
666
745
|
* @format GUID
|
|
@@ -682,66 +761,12 @@ export interface IdentificationDataIdOneOf {
|
|
|
682
761
|
*/
|
|
683
762
|
appId?: string;
|
|
684
763
|
}
|
|
685
|
-
|
|
764
|
+
declare enum WebhookIdentityType {
|
|
686
765
|
UNKNOWN = "UNKNOWN",
|
|
687
766
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
688
767
|
MEMBER = "MEMBER",
|
|
689
768
|
WIX_USER = "WIX_USER",
|
|
690
769
|
APP = "APP"
|
|
691
770
|
}
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
}
|
|
695
|
-
interface LocaleNonNullableFields {
|
|
696
|
-
visibility: LocaleVisibility;
|
|
697
|
-
effectiveUrlStructure: UrlStructure;
|
|
698
|
-
urlStructureOverride?: UrlStructureOverrideNonNullableFields;
|
|
699
|
-
}
|
|
700
|
-
interface LocaleSettingsNonNullableFields {
|
|
701
|
-
urlStructure: UrlStructure;
|
|
702
|
-
primaryLocale?: LocaleNonNullableFields;
|
|
703
|
-
}
|
|
704
|
-
export interface GetLocaleSettingsResponseNonNullableFields {
|
|
705
|
-
localeSettings?: LocaleSettingsNonNullableFields;
|
|
706
|
-
}
|
|
707
|
-
export interface UpdateLocaleSettingsResponseNonNullableFields {
|
|
708
|
-
localeSettings?: LocaleSettingsNonNullableFields;
|
|
709
|
-
}
|
|
710
|
-
export interface SetMultilingualModeResponseNonNullableFields {
|
|
711
|
-
localeSettings?: LocaleSettingsNonNullableFields;
|
|
712
|
-
}
|
|
713
|
-
/**
|
|
714
|
-
* Retrieves the current multilingual settings for a site.
|
|
715
|
-
* @internal
|
|
716
|
-
* @documentationMaturity preview
|
|
717
|
-
* @permissionId WIX_MULTILINGUAL.SETTINGS_READ
|
|
718
|
-
* @returns Response message containing the requested multilingual settings
|
|
719
|
-
* @fqn wix.multilingual.settings.v2.SettingsService.GetLocaleSettings
|
|
720
|
-
*/
|
|
721
|
-
export declare function getLocaleSettings(): Promise<GetLocaleSettingsResponse & GetLocaleSettingsResponseNonNullableFields>;
|
|
722
|
-
/**
|
|
723
|
-
* Updates the multilingual settings for a site.
|
|
724
|
-
* @param localeSettings - Settings to be updated, may be partial
|
|
725
|
-
* @internal
|
|
726
|
-
* @documentationMaturity preview
|
|
727
|
-
* @requiredField localeSettings
|
|
728
|
-
* @requiredField localeSettings.revision
|
|
729
|
-
* @permissionId WIX_MULTILINGUAL.SETTINGS_UPDATE
|
|
730
|
-
* @returns Response message containing the updated multilingual settings
|
|
731
|
-
* @fqn wix.multilingual.settings.v2.SettingsService.UpdateLocaleSettings
|
|
732
|
-
*/
|
|
733
|
-
export declare function updateLocaleSettings(localeSettings: LocaleSettings): Promise<UpdateLocaleSettingsResponse & UpdateLocaleSettingsResponseNonNullableFields>;
|
|
734
|
-
/**
|
|
735
|
-
* Custom action to update the multilingual mode with strict validation on the state.
|
|
736
|
-
* Once the value is set to true, the user can add more secondary languages and change the default settings.
|
|
737
|
-
* To change the value to false, the site must not have any secondary languages, and the settings value will be restored to default.
|
|
738
|
-
* @param multilingualModeEnabled - The new value of multilingual_mode to be set
|
|
739
|
-
* @internal
|
|
740
|
-
* @documentationMaturity preview
|
|
741
|
-
* @requiredField multilingualModeEnabled
|
|
742
|
-
* @permissionId WIX_MULTILINGUAL.SETTINGS_SET_MODE
|
|
743
|
-
* @returns Response message containing the updated settings after changing the multilingual mode
|
|
744
|
-
* @fqn wix.multilingual.settings.v2.SettingsService.SetMultilingualMode
|
|
745
|
-
*/
|
|
746
|
-
export declare function setMultilingualMode(multilingualModeEnabled: boolean): Promise<SetMultilingualModeResponse & SetMultilingualModeResponseNonNullableFields>;
|
|
747
|
-
export {};
|
|
771
|
+
|
|
772
|
+
export { type ActionEvent, type Asset, type DeleteContext, DeleteStatus, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetLocaleSettingsRequest, type GetLocaleSettingsResponse, type IdentificationData, type IdentificationDataIdOneOf, type Locale, type LocaleSettings, LocaleVisibility, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type MultilingualModeUpdated, Namespace, type NamespaceChanged, type RestoreInfo, type ServiceProvisioned, type ServiceRemoved, type SetMultilingualModeRequest, type SetMultilingualModeResponse, type SiteCreated, SiteCreatedContext, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, State, type StudioAssigned, type StudioUnassigned, type UpdateLocaleSettingsRequest, type UpdateLocaleSettingsResponse, UrlStructure, type UrlStructureOverride, WebhookIdentityType };
|