@wix/auto_sdk_multilingual_locale-settings 1.0.3 → 1.0.4

package/build/index.d.mts

@@ -1,64 +1,67 @@
-/**
- * Settings is a 'single entity per tenant' entity with META-SITE tenancy.
- * This means that Settings is active for every site, not only sites that have multilingual functionality installed.
- */
 interface LocaleSettings {
     /**
-     * Settings lifecycle begins at site creation and cannot be manually created or deleted.
-     * It's created automatically for each site.
-     * Revision number, used for optimistic locking
+     * 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.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Timestamp of when the Settings entity was created
+     * Date and time the locale settings were created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Timestamp of the last update to the Settings entity
+     * Date and time the locale settings were last updated.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
      * Indicates whether multilingual mode is enabled for the site.
-     * When false, the user can change the main language.
-     * When true, the main language cannot be changed.
-     * Changing this value may have significant implications for the site's content and structure.
+     *
+     * When set to `true`, you can create secondary locales.
      * @readonly
      */
     multilingualModeEnabled?: boolean | null;
     /**
-     * When true, the live site will automatically open in a secondary language
-     * if it detects that the user's browser is set to that language.
+     * Indicates whether the live site will automatically open in a secondary locale if the
+     * site visitor's browser is set to that locale.
+     *
+     * Default: `false`
+     *
+     * <blockquote class="caution">
+     *
+     * __Caution:__
+     * 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.
+     *
+     * </blockquote>
      */
     autoSwitch?: boolean | null;
     /**
-     * Defines how secondary languages will be resolved in the URL of the live site by default.
-     * This can be overridden per locale.
+     * Defines the default method for how secondary languages appear in the live site's URL.
+     * The URL structure can be overridden per locale, using the Locale API.
+     *
+     * Default: `"SUBDIRECTORY"`
      */
     urlStructure?: UrlStructure;
     /**
-     * The primary locale of the site, materialized from the locales service.
+     * The site's primary locale.
      * @readonly
      */
     primaryLocale?: Locale;
 }
 /** Enum representing the method for resolving locales in URLs. */
 declare enum UrlStructure {
-    /** Value not specified */
+    /** Undefined resolution method. */
     UNDEFINED_RESOLUTION_METHOD = "UNDEFINED_RESOLUTION_METHOD",
-    /** www.mysite.com/fr */
+    /** Subdirectory resolution method for the URL structure. For example, `"www.mysite.com/fr"`. */
     SUBDIRECTORY = "SUBDIRECTORY",
-    /** fr.mysite.com */
+    /** Subdomain resolution method for the URL structure. For example, `"fr.mysite.com"`. */
     SUBDOMAIN = "SUBDOMAIN",
-    /** www.mysite.com?lang=fr */
+    /** Query parameter resolution method for the URL structure. For example, `"www.mysite.com?lang=fr"`. */
     QUERY_PARAM = "QUERY_PARAM"
 }
-/** Every locale created will be validated using the IETF BCP 47 standard using framework validation. */
 interface Locale {
     /**
-     * Locale ID. The ID is calculated from the language + region (+ script for future use).
+     * Locale ID. The ID is made up of the language and region codes. For example, `"en-US"`.
      * @maxLength 20
      * @format LANGUAGE_TAG
      * @readonly
@@ -66,108 +69,108 @@ interface Locale {
      */
     _id?: string | null;
     /**
-     * Revision number for optimistic locking.
+     * 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.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Date and time the Locale was created.
+     * Date and time the locale was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time the Locale was last updated.
+     * Date and time the locale was last updated.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
-     * Language code (e.g., "en" for English).
+     * Language code. For example, `"en"` for English.
      * @immutable
      * @format LANGUAGE
      */
     languageCode?: string | null;
     /**
-     * Region code (e.g., "US" for United States).
+     * Region code. For example, `"UK"` for United Kingdom.
      * @immutable
      * @format COUNTRY
      */
     regionCode?: string | null;
-    /**
-     * HIDDEN - locale will be available for the user to see it in editor and preview but won't be available for UoU
-     * 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)
-     */
+    /** Locale visibility status. */
     visibility?: LocaleVisibility;
     /**
-     * Indicates if the language is the primary user-facing language in the Business Manager.
+     * Indicates whether the locale is the site's primary locale.
      * @readonly
      */
     primaryLocale?: boolean | null;
     /**
-     * Indicates if the language is the primary visitor-facing language in the live site.
+     * Indicates whether the locale is treated as the default for site visitors when no language is specified in the URL of the site.
      * @readonly
      */
     visitorPrimaryLocale?: boolean | null;
     /**
-     * Flag code (e.g., "US" for United States flag).
+     * Flag as a 3-letter language code based on Wix's supported locales. For example, `"USA"` for the United States flag.
      * @maxLength 3
      */
     flag?: string | null;
     /**
-     * Date and number format (e.g., "en-US" for US English formatting).
+     * Regional format for determining how to display data types such as dates, times, numbers, and currencies. For example, `"en-US"` for US English formatting.
      * @format LANGUAGE_TAG
      */
     regionalFormat?: string | null;
     /**
-     * The final and calculated specific locale resolution method.
-     * This is taken by default from the settings unless there is an active override.
+     * Default URL structure for the locale's live site URL,
+     * based on the locale's settings, unless overridden.
      * @readonly
      */
     effectiveUrlStructure?: UrlStructure;
-    /** Override for the default resolution method, if needed. */
+    /** Optional override for the locale's default URL structure. */
     urlStructureOverride?: UrlStructureOverride;
     /**
-     * Machine translation code, can be overridden. By default, it has the value of language_code.
-     * Add example for override needs (ZH_TW | ZH_CN)
+     * Language code based on Wix's supported locales, used to specify the target language when
+     * translatable content is sent for machine translation. For example, `"ES"` for Spanish
+     * or `"ZH_TW"` for Traditional Chinese.
+     *
+     * Default: The locale's `languageCode` value.
      * @format LANGUAGE_TAG
      */
     machineTranslationCode?: string | null;
     /**
-     * Calculated display name. This will equal override_name if it exists, or localized_name as default.
+     * The locale's `displayName`, unless overridden.
      * @readonly
      * @maxLength 30
      */
     effectiveDisplayName?: string | null;
     /**
-     * Localized name inferred from the ID using the locale data set.
+     * Default display name for the locale, inferred from the locale ID and region code.
      * @readonly
      * @maxLength 30
      */
     displayName?: string | null;
     /**
-     * User-defined override name for the locale.
+     * Optional override for the locale's display name.
      * @maxLength 30
      */
     overrideDisplayName?: string | null;
 }
 /** Enum representing the visibility status of a locale. */
 declare enum LocaleVisibility {
-    /** Value not specified */
+    /** Undefined visibility status. */
     UNDEFINED_LOCALE_STATUS = "UNDEFINED_LOCALE_STATUS",
-    /** Locale was added to site but was not activated */
+    /** Locale is hidden from site visitors. */
     HIDDEN = "HIDDEN",
-    /** Locale was added to site and activated */
+    /** Locale is visible to site visitors. A site can only have up to 100 visible locales. */
     VISIBLE = "VISIBLE"
 }
 /** Message for overriding the default resolution method. */
 interface UrlStructureOverride {
-    /** The specific resolution method to use instead of the default. */
+    /** Resolution method that defines the URL structure to use instead of the default. */
     urlStructure?: UrlStructure;
 }
 /** Payload for the event triggered when the multilingual_mode value changes */
 interface MultilingualModeUpdated {
-    /** The primary locale when multilingual mode is enabled or disabled */
+    /** The primary locale when `multilingualModeEnabled` is updated. */
     primaryLocale?: Locale;
-    /** Indicates whether multilingual mode is enabled or disabled */
+    /** Indicates whether the multilingual mode is enabled on the site. */
     multilingualModeEnabled?: boolean;
 }
 /** Request message for retrieving multilingual settings */
@@ -175,27 +178,31 @@ interface GetLocaleSettingsRequest {
 }
 /** Response message containing the requested multilingual settings */
 interface GetLocaleSettingsResponse {
-    /** The requested Settings entity */
+    /** Retrieved locale settings. */
     localeSettings?: LocaleSettings;
 }
 /** Request message for updating multilingual settings */
 interface UpdateLocaleSettingsRequest {
-    /** Settings to be updated, may be partial */
+    /** Locale settings to update. */
     localeSettings: LocaleSettings;
 }
 /** Response message containing the updated multilingual settings */
 interface UpdateLocaleSettingsResponse {
-    /** The updated Settings entity */
+    /** Updated locale settings. */
     localeSettings?: LocaleSettings;
 }
 /** Request message for setting the multilingual mode */
 interface SetMultilingualModeRequest {
-    /** The new value of multilingual_mode to be set */
+    /**
+     * Whether to enable multilingual mode for the site.
+     *
+     * Default: `false`
+     */
     multilingualModeEnabled: boolean;
 }
 /** Response message containing the updated settings after changing the multilingual mode */
 interface SetMultilingualModeResponse {
-    /** The current Settings entity after the change */
+    /** Updated locale settings. */
     localeSettings?: LocaleSettings;
 }
 interface DomainEvent extends DomainEventBodyOneOf {
@@ -301,6 +308,16 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
     studioAssigned?: StudioAssigned;
     /** Emitted when Studio is detached. */
     studioUnassigned?: StudioUnassigned;
+    /**
+     * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
+     * the actual URL.
+     *
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
+     */
+    urlChanged?: SiteUrlChanged;
+    /** Site is marked as PurgedExternally */
+    sitePurgedExternally?: SitePurgedExternally;
     /**
      * A meta site id.
      * @format GUID
@@ -349,6 +366,16 @@ interface MetaSiteSpecialEventPayloadOneOf {
     studioAssigned?: StudioAssigned;
     /** Emitted when Studio is detached. */
     studioUnassigned?: StudioUnassigned;
+    /**
+     * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
+     * the actual URL.
+     *
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
+     */
+    urlChanged?: SiteUrlChanged;
+    /** Site is marked as PurgedExternally */
+    sitePurgedExternally?: SitePurgedExternally;
 }
 interface Asset {
     /**
@@ -481,7 +508,20 @@ declare enum Namespace {
      */
     UGC_TEMPLATE = "UGC_TEMPLATE",
     /** Codux Headless Sites */
-    CODUX = "CODUX"
+    CODUX = "CODUX",
+    /** Bobb - AI Design Creator. */
+    MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
+    /**
+     * Shared Blog Site is a unique single site across Enterprise account,
+     * This site will hold all Blog posts related to the Marketing product.
+     */
+    SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
+    /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    STANDALONE_FORMS = "STANDALONE_FORMS",
+    /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    STANDALONE_EVENTS = "STANDALONE_EVENTS",
+    /** MIMIR - Siteless account for MIMIR Ai Job runner. */
+    MIMIR = "MIMIR"
 }
 /** Site transferred to another user. */
 interface SiteTransferred {
@@ -521,7 +561,8 @@ declare enum DeleteStatus {
     UNKNOWN = "UNKNOWN",
     TRASH = "TRASH",
     DELETED = "DELETED",
-    PENDING_PURGE = "PENDING_PURGE"
+    PENDING_PURGE = "PENDING_PURGE",
+    PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
 }
 /** Restoration of the meta site. */
 interface SiteUndeleted {
@@ -541,6 +582,21 @@ interface SiteMarkedAsTemplate {
 }
 interface SiteMarkedAsWixSite {
 }
+/**
+ * Represents a service provisioned a site.
+ *
+ * Note on `origin_instance_id`:
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
+ * This is because of the following scenario:
+ *
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
+ * such as a product catalog. When you create a site from this template, you inherit this
+ * default product catalog. However, if the template's product catalog is modified,
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
+ * your site remains consistent with what you initially received and does not include any
+ * changes made to the original template afterward.
+ * To ensure this, the TPA on the template gets a new instance_id.
+ */
 interface ServiceProvisioned {
     /**
      * Either UUID or EmbeddedServiceType.
@@ -619,6 +675,29 @@ interface StudioAssigned {
 /** Unassigned Studio editor */
 interface StudioUnassigned {
 }
+/**
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
+ *
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
+ *
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
+ */
+interface SiteUrlChanged {
+}
+/**
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
+ * Consumed by other teams to remove relevant data.
+ */
+interface SitePurgedExternally {
+    /**
+     * @maxLength 2048
+     * @maxSize 100
+     * @deprecated
+     * @targetRemovalDate 2025-04-15
+     */
+    appDefId?: string[];
+}
 interface MessageEnvelope {
     /**
      * App instance ID.
@@ -690,4 +769,4 @@ declare enum WebhookIdentityType {
     APP = "APP"
 }
 
-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 SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, State, type StudioAssigned, type StudioUnassigned, type UpdateLocaleSettingsRequest, type UpdateLocaleSettingsResponse, UrlStructure, type UrlStructureOverride, WebhookIdentityType };
+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 };