@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.
Files changed (132) hide show
  1. package/build/{internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.d.ts → index.d.mts} +185 -160
  2. package/build/{internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.d.ts → index.d.ts} +185 -160
  3. package/build/index.js +362 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +329 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/internal/index.d.mts +55 -0
  8. package/build/internal/index.d.ts +55 -0
  9. package/build/internal/index.js +362 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +329 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/build/internal/meta.d.mts +218 -0
  14. package/build/internal/meta.d.ts +218 -0
  15. package/build/internal/meta.js +218 -0
  16. package/build/internal/meta.js.map +1 -0
  17. package/build/internal/meta.mjs +189 -0
  18. package/build/internal/meta.mjs.map +1 -0
  19. 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
  20. 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
  21. package/build/meta.d.mts +218 -0
  22. package/build/meta.d.ts +218 -0
  23. package/build/meta.js +218 -0
  24. package/build/meta.js.map +1 -0
  25. package/build/meta.mjs +189 -0
  26. package/build/meta.mjs.map +1 -0
  27. package/package.json +13 -12
  28. package/build/cjs/index.d.ts +0 -1
  29. package/build/cjs/index.js +0 -18
  30. package/build/cjs/index.js.map +0 -1
  31. package/build/cjs/index.typings.d.ts +0 -1
  32. package/build/cjs/index.typings.js +0 -18
  33. package/build/cjs/index.typings.js.map +0 -1
  34. package/build/cjs/meta.d.ts +0 -1
  35. package/build/cjs/meta.js +0 -18
  36. package/build/cjs/meta.js.map +0 -1
  37. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.d.ts +0 -2
  38. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.js +0 -20
  39. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.js.map +0 -1
  40. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.d.ts +0 -11
  41. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.js +0 -134
  42. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.js.map +0 -1
  43. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.d.ts +0 -15
  44. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js +0 -85
  45. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js.map +0 -1
  46. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.d.ts +0 -4
  47. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.js +0 -35
  48. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.js.map +0 -1
  49. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts +0 -715
  50. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.js +0 -134
  51. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.js.map +0 -1
  52. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js +0 -261
  53. package/build/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js.map +0 -1
  54. package/build/es/index.d.ts +0 -1
  55. package/build/es/index.js +0 -2
  56. package/build/es/index.js.map +0 -1
  57. package/build/es/index.typings.d.ts +0 -1
  58. package/build/es/index.typings.js +0 -2
  59. package/build/es/index.typings.js.map +0 -1
  60. package/build/es/meta.d.ts +0 -1
  61. package/build/es/meta.js +0 -2
  62. package/build/es/meta.js.map +0 -1
  63. package/build/es/package.json +0 -3
  64. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.d.ts +0 -2
  65. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.js +0 -10
  66. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.js.map +0 -1
  67. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.d.ts +0 -11
  68. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.js +0 -128
  69. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.js.map +0 -1
  70. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.d.ts +0 -15
  71. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js +0 -56
  72. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js.map +0 -1
  73. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.d.ts +0 -4
  74. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.js +0 -22
  75. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.js.map +0 -1
  76. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts +0 -715
  77. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.js +0 -131
  78. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.js.map +0 -1
  79. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js +0 -232
  80. package/build/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.d.ts +0 -10
  91. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.js +0 -20
  92. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.context.js.map +0 -1
  93. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.d.ts +0 -11
  94. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.js +0 -134
  95. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.http.js.map +0 -1
  96. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.d.ts +0 -15
  97. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js +0 -85
  98. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js.map +0 -1
  99. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.d.ts +0 -37
  100. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.js +0 -35
  101. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.public.js.map +0 -1
  102. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts +0 -715
  103. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.js +0 -134
  104. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.types.js.map +0 -1
  105. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js +0 -261
  106. package/build/internal/cjs/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js.map +0 -1
  107. package/build/internal/es/index.d.ts +0 -1
  108. package/build/internal/es/index.js +0 -2
  109. package/build/internal/es/index.js.map +0 -1
  110. package/build/internal/es/index.typings.d.ts +0 -1
  111. package/build/internal/es/index.typings.js +0 -2
  112. package/build/internal/es/index.typings.js.map +0 -1
  113. package/build/internal/es/meta.d.ts +0 -1
  114. package/build/internal/es/meta.js +0 -2
  115. package/build/internal/es/meta.js.map +0 -1
  116. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.d.ts +0 -10
  117. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.js +0 -10
  118. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.context.js.map +0 -1
  119. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.d.ts +0 -11
  120. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.js +0 -128
  121. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.http.js.map +0 -1
  122. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.d.ts +0 -15
  123. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js +0 -56
  124. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.meta.js.map +0 -1
  125. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.d.ts +0 -37
  126. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.js +0 -22
  127. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.public.js.map +0 -1
  128. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts +0 -715
  129. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.js +0 -131
  130. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.types.js.map +0 -1
  131. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js +0 -232
  132. package/build/internal/es/src/multilingual-settings-v2-locale-settings-locale-settings.universal.js.map +0 -1
@@ -1,715 +0,0 @@
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 {
6
- /**
7
- * Settings lifecycle begins at site creation and cannot be manually created or deleted.
8
- * It's created automatically for each site.
9
- * Revision number, used for optimistic locking
10
- * @readonly
11
- */
12
- revision?: string | null;
13
- /**
14
- * Timestamp of when the Settings entity was created
15
- * @readonly
16
- */
17
- createdDate?: Date | null;
18
- /**
19
- * Timestamp of the last update to the Settings entity
20
- * @readonly
21
- */
22
- updatedDate?: Date | null;
23
- /**
24
- * Indicates whether multilingual mode is enabled for the site.
25
- * When false, the user can change the main language.
26
- * When true, the main language cannot be changed.
27
- * Changing this value may have significant implications for the site's content and structure.
28
- * @readonly
29
- */
30
- multilingualModeEnabled?: boolean | null;
31
- /**
32
- * When true, the live site will automatically open in a secondary language
33
- * if it detects that the user's browser is set to that language.
34
- */
35
- autoSwitch?: boolean | null;
36
- /**
37
- * Defines how secondary languages will be resolved in the URL of the live site by default.
38
- * This can be overridden per locale.
39
- */
40
- urlStructure?: UrlStructure;
41
- /**
42
- * The primary locale of the site, materialized from the locales service.
43
- * @readonly
44
- */
45
- primaryLocale?: Locale;
46
- }
47
- /** Enum representing the method for resolving locales in URLs. */
48
- export declare enum UrlStructure {
49
- /** Value not specified */
50
- UNDEFINED_RESOLUTION_METHOD = "UNDEFINED_RESOLUTION_METHOD",
51
- /** www.mysite.com/fr */
52
- SUBDIRECTORY = "SUBDIRECTORY",
53
- /** fr.mysite.com */
54
- SUBDOMAIN = "SUBDOMAIN",
55
- /** www.mysite.com?lang=fr */
56
- QUERY_PARAM = "QUERY_PARAM"
57
- }
58
- /** Every locale created will be validated using the IETF BCP 47 standard using framework validation. */
59
- export interface Locale {
60
- /**
61
- * Locale ID. The ID is calculated from the language + region (+ script for future use).
62
- * @maxLength 20
63
- * @format LANGUAGE_TAG
64
- * @readonly
65
- * @immutable
66
- */
67
- id?: string | null;
68
- /**
69
- * Revision number for optimistic locking.
70
- * @readonly
71
- */
72
- revision?: string | null;
73
- /**
74
- * Date and time the Locale was created.
75
- * @readonly
76
- */
77
- createdDate?: Date | null;
78
- /**
79
- * Date and time the Locale was last updated.
80
- * @readonly
81
- */
82
- updatedDate?: Date | null;
83
- /**
84
- * Language code (e.g., "en" for English).
85
- * @immutable
86
- * @format LANGUAGE
87
- */
88
- languageCode?: string | null;
89
- /**
90
- * Region code (e.g., "US" for United States).
91
- * @immutable
92
- * @format COUNTRY
93
- */
94
- 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
- */
99
- visibility?: LocaleVisibility;
100
- /**
101
- * Indicates if the language is the primary user-facing language in the Business Manager.
102
- * @readonly
103
- */
104
- primaryLocale?: boolean | null;
105
- /**
106
- * Indicates if the language is the primary visitor-facing language in the live site.
107
- * @readonly
108
- */
109
- visitorPrimaryLocale?: boolean | null;
110
- /**
111
- * Flag code (e.g., "US" for United States flag).
112
- * @maxLength 3
113
- */
114
- flag?: string | null;
115
- /**
116
- * Date and number format (e.g., "en-US" for US English formatting).
117
- * @format LANGUAGE_TAG
118
- */
119
- regionalFormat?: string | null;
120
- /**
121
- * The final and calculated specific locale resolution method.
122
- * This is taken by default from the settings unless there is an active override.
123
- * @readonly
124
- */
125
- effectiveUrlStructure?: UrlStructure;
126
- /** Override for the default resolution method, if needed. */
127
- urlStructureOverride?: UrlStructureOverride;
128
- /**
129
- * Machine translation code, can be overridden. By default, it has the value of language_code.
130
- * Add example for override needs (ZH_TW | ZH_CN)
131
- * @format LANGUAGE_TAG
132
- */
133
- machineTranslationCode?: string | null;
134
- /**
135
- * Calculated display name. This will equal override_name if it exists, or localized_name as default.
136
- * @readonly
137
- * @maxLength 30
138
- */
139
- effectiveDisplayName?: string | null;
140
- /**
141
- * Localized name inferred from the ID using the locale data set.
142
- * @readonly
143
- * @maxLength 30
144
- */
145
- displayName?: string | null;
146
- /**
147
- * User-defined override name for the locale.
148
- * @maxLength 30
149
- */
150
- overrideDisplayName?: string | null;
151
- }
152
- /** Enum representing the visibility status of a locale. */
153
- export declare enum LocaleVisibility {
154
- /** Value not specified */
155
- UNDEFINED_LOCALE_STATUS = "UNDEFINED_LOCALE_STATUS",
156
- /** Locale was added to site but was not activated */
157
- HIDDEN = "HIDDEN",
158
- /** Locale was added to site and activated */
159
- VISIBLE = "VISIBLE"
160
- }
161
- /** Message for overriding the default resolution method. */
162
- export interface UrlStructureOverride {
163
- /** The specific resolution method to use instead of the default. */
164
- urlStructure?: UrlStructure;
165
- }
166
- /** Payload for the event triggered when the multilingual_mode value changes */
167
- export interface MultilingualModeUpdated {
168
- /** The primary locale when multilingual mode is enabled or disabled */
169
- primaryLocale?: Locale;
170
- /** Indicates whether multilingual mode is enabled or disabled */
171
- multilingualModeEnabled?: boolean;
172
- }
173
- /** Request message for retrieving multilingual settings */
174
- export interface GetLocaleSettingsRequest {
175
- }
176
- /** Response message containing the requested multilingual settings */
177
- export interface GetLocaleSettingsResponse {
178
- /** The requested Settings entity */
179
- localeSettings?: LocaleSettings;
180
- }
181
- /** Request message for updating multilingual settings */
182
- export interface UpdateLocaleSettingsRequest {
183
- /** Settings to be updated, may be partial */
184
- localeSettings: LocaleSettings;
185
- }
186
- /** Response message containing the updated multilingual settings */
187
- export interface UpdateLocaleSettingsResponse {
188
- /** The updated Settings entity */
189
- localeSettings?: LocaleSettings;
190
- }
191
- /** Request message for setting the multilingual mode */
192
- export interface SetMultilingualModeRequest {
193
- /** The new value of multilingual_mode to be set */
194
- multilingualModeEnabled: boolean;
195
- }
196
- /** Response message containing the updated settings after changing the multilingual mode */
197
- export interface SetMultilingualModeResponse {
198
- /** The current Settings entity after the change */
199
- localeSettings?: LocaleSettings;
200
- }
201
- export interface DomainEvent extends DomainEventBodyOneOf {
202
- createdEvent?: EntityCreatedEvent;
203
- updatedEvent?: EntityUpdatedEvent;
204
- deletedEvent?: EntityDeletedEvent;
205
- actionEvent?: ActionEvent;
206
- /**
207
- * Unique event ID.
208
- * Allows clients to ignore duplicate webhooks.
209
- */
210
- id?: string;
211
- /**
212
- * Assumes actions are also always typed to an entity_type
213
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
214
- */
215
- entityFqdn?: string;
216
- /**
217
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
218
- * This is although the created/updated/deleted notion is duplication of the oneof types
219
- * Example: created/updated/deleted/started/completed/email_opened
220
- */
221
- slug?: string;
222
- /** ID of the entity associated with the event. */
223
- entityId?: string;
224
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
225
- eventTime?: Date | null;
226
- /**
227
- * Whether the event was triggered as a result of a privacy regulation application
228
- * (for example, GDPR).
229
- */
230
- triggeredByAnonymizeRequest?: boolean | null;
231
- /** If present, indicates the action that triggered the event. */
232
- originatedFrom?: string | null;
233
- /**
234
- * A sequence number defining the order of updates to the underlying entity.
235
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
236
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
237
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
238
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
239
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
240
- */
241
- entityEventSequence?: string | null;
242
- }
243
- /** @oneof */
244
- export interface DomainEventBodyOneOf {
245
- createdEvent?: EntityCreatedEvent;
246
- updatedEvent?: EntityUpdatedEvent;
247
- deletedEvent?: EntityDeletedEvent;
248
- actionEvent?: ActionEvent;
249
- }
250
- export interface EntityCreatedEvent {
251
- entityAsJson?: string;
252
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
253
- restoreInfo?: RestoreInfo;
254
- }
255
- export interface RestoreInfo {
256
- deletedDate?: Date | null;
257
- }
258
- export interface EntityUpdatedEvent {
259
- /**
260
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
261
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
262
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
263
- */
264
- currentEntityAsJson?: string;
265
- }
266
- export interface EntityDeletedEvent {
267
- /** Entity that was deleted */
268
- deletedEntityAsJson?: string | null;
269
- }
270
- export interface ActionEvent {
271
- bodyAsJson?: string;
272
- }
273
- export interface Empty {
274
- }
275
- export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
276
- /** Emitted on a meta site creation. */
277
- siteCreated?: SiteCreated;
278
- /** Emitted on a meta site transfer completion. */
279
- siteTransferred?: SiteTransferred;
280
- /** Emitted on a meta site deletion. */
281
- siteDeleted?: SiteDeleted;
282
- /** Emitted on a meta site restoration. */
283
- siteUndeleted?: SiteUndeleted;
284
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
285
- sitePublished?: SitePublished;
286
- /** Emitted on a meta site unpublish. */
287
- siteUnpublished?: SiteUnpublished;
288
- /** Emitted when meta site is marked as template. */
289
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
290
- /** Emitted when meta site is marked as a WixSite. */
291
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
292
- /** Emitted when an application is provisioned (installed). */
293
- serviceProvisioned?: ServiceProvisioned;
294
- /** Emitted when an application is removed (uninstalled). */
295
- serviceRemoved?: ServiceRemoved;
296
- /** Emitted when meta site name (URL slug) is changed. */
297
- siteRenamedPayload?: SiteRenamed;
298
- /** Emitted when meta site was permanently deleted. */
299
- hardDeleted?: SiteHardDeleted;
300
- /** Emitted on a namespace change. */
301
- namespaceChanged?: NamespaceChanged;
302
- /** Emitted when Studio is attached. */
303
- studioAssigned?: StudioAssigned;
304
- /** Emitted when Studio is detached. */
305
- studioUnassigned?: StudioUnassigned;
306
- /**
307
- * A meta site id.
308
- * @format GUID
309
- */
310
- metaSiteId?: string;
311
- /** A meta site version. Monotonically increasing. */
312
- version?: string;
313
- /** A timestamp of the event. */
314
- timestamp?: string;
315
- /**
316
- * TODO(meta-site): Change validation once validations are disabled for consumers
317
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
318
- * @maxSize 4000
319
- */
320
- assets?: Asset[];
321
- }
322
- /** @oneof */
323
- export interface MetaSiteSpecialEventPayloadOneOf {
324
- /** Emitted on a meta site creation. */
325
- siteCreated?: SiteCreated;
326
- /** Emitted on a meta site transfer completion. */
327
- siteTransferred?: SiteTransferred;
328
- /** Emitted on a meta site deletion. */
329
- siteDeleted?: SiteDeleted;
330
- /** Emitted on a meta site restoration. */
331
- siteUndeleted?: SiteUndeleted;
332
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
333
- sitePublished?: SitePublished;
334
- /** Emitted on a meta site unpublish. */
335
- siteUnpublished?: SiteUnpublished;
336
- /** Emitted when meta site is marked as template. */
337
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
338
- /** Emitted when meta site is marked as a WixSite. */
339
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
340
- /** Emitted when an application is provisioned (installed). */
341
- serviceProvisioned?: ServiceProvisioned;
342
- /** Emitted when an application is removed (uninstalled). */
343
- serviceRemoved?: ServiceRemoved;
344
- /** Emitted when meta site name (URL slug) is changed. */
345
- siteRenamedPayload?: SiteRenamed;
346
- /** Emitted when meta site was permanently deleted. */
347
- hardDeleted?: SiteHardDeleted;
348
- /** Emitted on a namespace change. */
349
- namespaceChanged?: NamespaceChanged;
350
- /** Emitted when Studio is attached. */
351
- studioAssigned?: StudioAssigned;
352
- /** Emitted when Studio is detached. */
353
- studioUnassigned?: StudioUnassigned;
354
- }
355
- export interface Asset {
356
- /**
357
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
358
- * @maxLength 36
359
- */
360
- appDefId?: string;
361
- /**
362
- * An instance id. For legacy reasons may be UUID or a string.
363
- * @maxLength 200
364
- */
365
- instanceId?: string;
366
- /** An application state. */
367
- state?: State;
368
- }
369
- export declare enum State {
370
- UNKNOWN = "UNKNOWN",
371
- ENABLED = "ENABLED",
372
- DISABLED = "DISABLED",
373
- PENDING = "PENDING",
374
- DEMO = "DEMO"
375
- }
376
- export interface SiteCreated {
377
- /**
378
- * A template identifier (empty if not created from a template).
379
- * @maxLength 36
380
- */
381
- originTemplateId?: string;
382
- /**
383
- * An account id of the owner.
384
- * @format GUID
385
- */
386
- ownerId?: string;
387
- /** A context in which meta site was created. */
388
- context?: SiteCreatedContext;
389
- /**
390
- * A meta site id from which this site was created.
391
- *
392
- * In case of a creation from a template it's a template id.
393
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
394
- * @format GUID
395
- */
396
- originMetaSiteId?: string | null;
397
- /**
398
- * A meta site name (URL slug).
399
- * @maxLength 20
400
- */
401
- siteName?: string;
402
- /** A namespace. */
403
- namespace?: Namespace;
404
- }
405
- export declare enum SiteCreatedContext {
406
- /** A valid option, we don't expose all reasons why site might be created. */
407
- OTHER = "OTHER",
408
- /** A meta site was created from template. */
409
- FROM_TEMPLATE = "FROM_TEMPLATE",
410
- /** A meta site was created by copying of the transfferred meta site. */
411
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
412
- /** A copy of existing meta site. */
413
- DUPLICATE = "DUPLICATE",
414
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
415
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
416
- /** deprecated A meta site was created for Flash editor. */
417
- FLASH = "FLASH"
418
- }
419
- export declare enum Namespace {
420
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
421
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
422
- WIX = "WIX",
423
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
424
- SHOUT_OUT = "SHOUT_OUT",
425
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
426
- ALBUMS = "ALBUMS",
427
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
428
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
429
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
430
- HOTELS = "HOTELS",
431
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
432
- CLUBS = "CLUBS",
433
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
434
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
435
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
436
- DEV_SITE = "DEV_SITE",
437
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
438
- LOGOS = "LOGOS",
439
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
440
- VIDEO_MAKER = "VIDEO_MAKER",
441
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
442
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
443
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
444
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
445
- /**
446
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
447
- *
448
- * Meta site with this namespace will *not* be shown in a user's site list by default.
449
- */
450
- HTML_DRAFT = "HTML_DRAFT",
451
- /**
452
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
453
- * Will be accessible from Site List and will not have a website app.
454
- * Once the user attaches a site, the site will become a regular wixsite.
455
- */
456
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
457
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
458
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
459
- /** It is to be used in the Business First efforts. */
460
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
461
- /** Bookings business flow with no site. */
462
- ANYWHERE = "ANYWHERE",
463
- /** Namespace for Headless Backoffice with no editor */
464
- HEADLESS = "HEADLESS",
465
- /**
466
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
467
- * The site will be used for account level CSM feature for enterprise
468
- */
469
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
470
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
471
- RISE = "RISE",
472
- /**
473
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
474
- * There's a blank site behind the scene but it's blank).
475
- * The Mobile company will be the owner of this namespace.
476
- */
477
- BRANDED_FIRST = "BRANDED_FIRST",
478
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
479
- NOWNIA = "NOWNIA",
480
- /**
481
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
482
- * The Partners company owns this namespace.
483
- */
484
- UGC_TEMPLATE = "UGC_TEMPLATE",
485
- /** Codux Headless Sites */
486
- CODUX = "CODUX"
487
- }
488
- /** Site transferred to another user. */
489
- export interface SiteTransferred {
490
- /**
491
- * A previous owner id (user that transfers meta site).
492
- * @format GUID
493
- */
494
- oldOwnerId?: string;
495
- /**
496
- * A new owner id (user that accepts meta site).
497
- * @format GUID
498
- */
499
- newOwnerId?: string;
500
- }
501
- /** Soft deletion of the meta site. Could be restored. */
502
- export interface SiteDeleted {
503
- /** A deletion context. */
504
- deleteContext?: DeleteContext;
505
- }
506
- export interface DeleteContext {
507
- /** When the meta site was deleted. */
508
- dateDeleted?: Date | null;
509
- /** A status. */
510
- deleteStatus?: DeleteStatus;
511
- /**
512
- * A reason (flow).
513
- * @maxLength 255
514
- */
515
- deleteOrigin?: string;
516
- /**
517
- * A service that deleted it.
518
- * @maxLength 255
519
- */
520
- initiatorId?: string | null;
521
- }
522
- export declare enum DeleteStatus {
523
- UNKNOWN = "UNKNOWN",
524
- TRASH = "TRASH",
525
- DELETED = "DELETED",
526
- PENDING_PURGE = "PENDING_PURGE"
527
- }
528
- /** Restoration of the meta site. */
529
- export interface SiteUndeleted {
530
- }
531
- /** First publish of a meta site. Or subsequent publish after unpublish. */
532
- export interface SitePublished {
533
- }
534
- export interface SiteUnpublished {
535
- /**
536
- * A list of URLs previously associated with the meta site.
537
- * @maxLength 4000
538
- * @maxSize 10000
539
- */
540
- urls?: string[];
541
- }
542
- export interface SiteMarkedAsTemplate {
543
- }
544
- export interface SiteMarkedAsWixSite {
545
- }
546
- export interface ServiceProvisioned {
547
- /**
548
- * Either UUID or EmbeddedServiceType.
549
- * @maxLength 36
550
- */
551
- appDefId?: string;
552
- /**
553
- * Not only UUID. Something here could be something weird.
554
- * @maxLength 36
555
- */
556
- instanceId?: string;
557
- /**
558
- * An instance id from which this instance is originated.
559
- * @maxLength 36
560
- */
561
- originInstanceId?: string;
562
- /**
563
- * A version.
564
- * @maxLength 500
565
- */
566
- version?: string | null;
567
- /**
568
- * The origin meta site id
569
- * @format GUID
570
- */
571
- originMetaSiteId?: string | null;
572
- }
573
- export interface ServiceRemoved {
574
- /**
575
- * Either UUID or EmbeddedServiceType.
576
- * @maxLength 36
577
- */
578
- appDefId?: string;
579
- /**
580
- * Not only UUID. Something here could be something weird.
581
- * @maxLength 36
582
- */
583
- instanceId?: string;
584
- /**
585
- * A version.
586
- * @maxLength 500
587
- */
588
- version?: string | null;
589
- }
590
- /** Rename of the site. Meaning, free public url has been changed as well. */
591
- export interface SiteRenamed {
592
- /**
593
- * A new meta site name (URL slug).
594
- * @maxLength 20
595
- */
596
- newSiteName?: string;
597
- /**
598
- * A previous meta site name (URL slug).
599
- * @maxLength 255
600
- */
601
- oldSiteName?: string;
602
- }
603
- /**
604
- * Hard deletion of the meta site.
605
- *
606
- * Could not be restored. Therefore it's desirable to cleanup data.
607
- */
608
- export interface SiteHardDeleted {
609
- /** A deletion context. */
610
- deleteContext?: DeleteContext;
611
- }
612
- export interface NamespaceChanged {
613
- /** A previous namespace. */
614
- oldNamespace?: Namespace;
615
- /** A new namespace. */
616
- newNamespace?: Namespace;
617
- }
618
- /** Assigned Studio editor */
619
- export interface StudioAssigned {
620
- }
621
- /** Unassigned Studio editor */
622
- export interface StudioUnassigned {
623
- }
624
- export interface MessageEnvelope {
625
- /**
626
- * App instance ID.
627
- * @format GUID
628
- */
629
- instanceId?: string | null;
630
- /**
631
- * Event type.
632
- * @maxLength 150
633
- */
634
- eventType?: string;
635
- /** The identification type and identity data. */
636
- identity?: IdentificationData;
637
- /** Stringify payload. */
638
- data?: string;
639
- }
640
- export interface IdentificationData extends IdentificationDataIdOneOf {
641
- /**
642
- * ID of a site visitor that has not logged in to the site.
643
- * @format GUID
644
- */
645
- anonymousVisitorId?: string;
646
- /**
647
- * ID of a site visitor that has logged in to the site.
648
- * @format GUID
649
- */
650
- memberId?: string;
651
- /**
652
- * ID of a Wix user (site owner, contributor, etc.).
653
- * @format GUID
654
- */
655
- wixUserId?: string;
656
- /**
657
- * ID of an app.
658
- * @format GUID
659
- */
660
- appId?: string;
661
- /** @readonly */
662
- identityType?: WebhookIdentityType;
663
- }
664
- /** @oneof */
665
- export interface IdentificationDataIdOneOf {
666
- /**
667
- * ID of a site visitor that has not logged in to the site.
668
- * @format GUID
669
- */
670
- anonymousVisitorId?: string;
671
- /**
672
- * ID of a site visitor that has logged in to the site.
673
- * @format GUID
674
- */
675
- memberId?: string;
676
- /**
677
- * ID of a Wix user (site owner, contributor, etc.).
678
- * @format GUID
679
- */
680
- wixUserId?: string;
681
- /**
682
- * ID of an app.
683
- * @format GUID
684
- */
685
- appId?: string;
686
- }
687
- export declare enum WebhookIdentityType {
688
- UNKNOWN = "UNKNOWN",
689
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
690
- MEMBER = "MEMBER",
691
- WIX_USER = "WIX_USER",
692
- APP = "APP"
693
- }
694
- interface UrlStructureOverrideNonNullableFields {
695
- urlStructure: UrlStructure;
696
- }
697
- interface LocaleNonNullableFields {
698
- visibility: LocaleVisibility;
699
- effectiveUrlStructure: UrlStructure;
700
- urlStructureOverride?: UrlStructureOverrideNonNullableFields;
701
- }
702
- interface LocaleSettingsNonNullableFields {
703
- urlStructure: UrlStructure;
704
- primaryLocale?: LocaleNonNullableFields;
705
- }
706
- export interface GetLocaleSettingsResponseNonNullableFields {
707
- localeSettings?: LocaleSettingsNonNullableFields;
708
- }
709
- export interface UpdateLocaleSettingsResponseNonNullableFields {
710
- localeSettings?: LocaleSettingsNonNullableFields;
711
- }
712
- export interface SetMultilingualModeResponseNonNullableFields {
713
- localeSettings?: LocaleSettingsNonNullableFields;
714
- }
715
- export {};