@wix/auto_sdk_multilingual_locale-settings 1.0.2 → 1.0.3

package/build/{es/src/multilingual-settings-v2-locale-settings-locale-settings.types.d.ts → internal/multilingual-settings-v2-locale-settings-locale-settings.universal-DWm_DkN7.d.ts}

@@ -2,7 +2,7 @@
  * 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.
  */
-export interface LocaleSettings {
+interface LocaleSettings {
     /**
      * Settings lifecycle begins at site creation and cannot be manually created or deleted.
      * It's created automatically for each site.
@@ -14,12 +14,12 @@ export interface LocaleSettings {
      * Timestamp of when the Settings entity was created
      * @readonly
      */
-    createdDate?: Date | null;
+    _createdDate?: Date | null;
     /**
      * Timestamp of the last update to the Settings entity
      * @readonly
      */
-    updatedDate?: Date | null;
+    _updatedDate?: Date | null;
     /**
      * Indicates whether multilingual mode is enabled for the site.
      * When false, the user can change the main language.
@@ -45,7 +45,7 @@ export interface LocaleSettings {
     primaryLocale?: Locale;
 }
 /** Enum representing the method for resolving locales in URLs. */
-export declare enum UrlStructure {
+declare enum UrlStructure {
     /** Value not specified */
     UNDEFINED_RESOLUTION_METHOD = "UNDEFINED_RESOLUTION_METHOD",
     /** www.mysite.com/fr */
@@ -56,7 +56,7 @@ export declare enum UrlStructure {
     QUERY_PARAM = "QUERY_PARAM"
 }
 /** Every locale created will be validated using the IETF BCP 47 standard using framework validation. */
-export interface Locale {
+interface Locale {
     /**
      * Locale ID. The ID is calculated from the language + region (+ script for future use).
      * @maxLength 20
@@ -64,7 +64,7 @@ export interface Locale {
      * @readonly
      * @immutable
      */
-    id?: string | null;
+    _id?: string | null;
     /**
      * Revision number for optimistic locking.
      * @readonly
@@ -74,12 +74,12 @@ export interface Locale {
      * Date and time the Locale was created.
      * @readonly
      */
-    createdDate?: Date | null;
+    _createdDate?: Date | null;
     /**
      * Date and time the Locale was last updated.
      * @readonly
      */
-    updatedDate?: Date | null;
+    _updatedDate?: Date | null;
     /**
      * Language code (e.g., "en" for English).
      * @immutable
@@ -150,7 +150,7 @@ export interface Locale {
     overrideDisplayName?: string | null;
 }
 /** Enum representing the visibility status of a locale. */
-export declare enum LocaleVisibility {
+declare enum LocaleVisibility {
     /** Value not specified */
     UNDEFINED_LOCALE_STATUS = "UNDEFINED_LOCALE_STATUS",
     /** Locale was added to site but was not activated */
@@ -159,46 +159,46 @@ export declare enum LocaleVisibility {
     VISIBLE = "VISIBLE"
 }
 /** Message for overriding the default resolution method. */
-export interface UrlStructureOverride {
+interface UrlStructureOverride {
     /** The specific resolution method to use instead of the default. */
     urlStructure?: UrlStructure;
 }
 /** Payload for the event triggered when the multilingual_mode value changes */
-export interface MultilingualModeUpdated {
+interface MultilingualModeUpdated {
     /** The primary locale when multilingual mode is enabled or disabled */
     primaryLocale?: Locale;
     /** Indicates whether multilingual mode is enabled or disabled */
     multilingualModeEnabled?: boolean;
 }
 /** Request message for retrieving multilingual settings */
-export interface GetLocaleSettingsRequest {
+interface GetLocaleSettingsRequest {
 }
 /** Response message containing the requested multilingual settings */
-export interface GetLocaleSettingsResponse {
+interface GetLocaleSettingsResponse {
     /** The requested Settings entity */
     localeSettings?: LocaleSettings;
 }
 /** Request message for updating multilingual settings */
-export interface UpdateLocaleSettingsRequest {
+interface UpdateLocaleSettingsRequest {
     /** Settings to be updated, may be partial */
     localeSettings: LocaleSettings;
 }
 /** Response message containing the updated multilingual settings */
-export interface UpdateLocaleSettingsResponse {
+interface UpdateLocaleSettingsResponse {
     /** The updated Settings entity */
     localeSettings?: LocaleSettings;
 }
 /** Request message for setting the multilingual mode */
-export interface SetMultilingualModeRequest {
+interface SetMultilingualModeRequest {
     /** The new value of multilingual_mode to be set */
     multilingualModeEnabled: boolean;
 }
 /** Response message containing the updated settings after changing the multilingual mode */
-export interface SetMultilingualModeResponse {
+interface SetMultilingualModeResponse {
     /** The current Settings entity after the change */
     localeSettings?: LocaleSettings;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -207,7 +207,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
      * Unique event ID.
      * Allows clients to ignore duplicate webhooks.
      */
-    id?: string;
+    _id?: string;
     /**
      * Assumes actions are also always typed to an entity_type
      * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
@@ -241,38 +241,36 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
+interface EntityCreatedEvent {
+    entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+interface EntityUpdatedEvent {
     /**
      * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
      * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
      */
-    currentEntityAsJson?: string;
+    currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted */
-    deletedEntityAsJson?: string | null;
+    deletedEntity?: string | null;
 }
-export interface ActionEvent {
-    bodyAsJson?: string;
+interface ActionEvent {
+    body?: string;
 }
-export interface Empty {
+interface Empty {
 }
-export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
+interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
     /** Emitted on a meta site creation. */
     siteCreated?: SiteCreated;
     /** Emitted on a meta site transfer completion. */
@@ -320,7 +318,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
     assets?: Asset[];
 }
 /** @oneof */
-export interface MetaSiteSpecialEventPayloadOneOf {
+interface MetaSiteSpecialEventPayloadOneOf {
     /** Emitted on a meta site creation. */
     siteCreated?: SiteCreated;
     /** Emitted on a meta site transfer completion. */
@@ -352,7 +350,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
     /** Emitted when Studio is detached. */
     studioUnassigned?: StudioUnassigned;
 }
-export interface Asset {
+interface Asset {
     /**
      * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
      * @maxLength 36
@@ -366,14 +364,14 @@ export interface Asset {
     /** An application state. */
     state?: State;
 }
-export declare enum State {
+declare enum State {
     UNKNOWN = "UNKNOWN",
     ENABLED = "ENABLED",
     DISABLED = "DISABLED",
     PENDING = "PENDING",
     DEMO = "DEMO"
 }
-export interface SiteCreated {
+interface SiteCreated {
     /**
      * A template identifier (empty if not created from a template).
      * @maxLength 36
@@ -402,7 +400,7 @@ export interface SiteCreated {
     /** A namespace. */
     namespace?: Namespace;
 }
-export declare enum SiteCreatedContext {
+declare enum SiteCreatedContext {
     /** A valid option, we don't expose all reasons why site might be created. */
     OTHER = "OTHER",
     /** A meta site was created from template. */
@@ -416,7 +414,7 @@ export declare enum SiteCreatedContext {
     /** deprecated A meta site was created for Flash editor. */
     FLASH = "FLASH"
 }
-export declare enum Namespace {
+declare enum Namespace {
     UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
     /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
     WIX = "WIX",
@@ -486,7 +484,7 @@ export declare enum Namespace {
     CODUX = "CODUX"
 }
 /** Site transferred to another user. */
-export interface SiteTransferred {
+interface SiteTransferred {
     /**
      * A previous owner id (user that transfers meta site).
      * @format GUID
@@ -499,11 +497,11 @@ export interface SiteTransferred {
     newOwnerId?: string;
 }
 /** Soft deletion of the meta site. Could be restored. */
-export interface SiteDeleted {
+interface SiteDeleted {
     /** A deletion context. */
     deleteContext?: DeleteContext;
 }
-export interface DeleteContext {
+interface DeleteContext {
     /** When the meta site was deleted. */
     dateDeleted?: Date | null;
     /** A status. */
@@ -519,19 +517,19 @@ export interface DeleteContext {
      */
     initiatorId?: string | null;
 }
-export declare enum DeleteStatus {
+declare enum DeleteStatus {
     UNKNOWN = "UNKNOWN",
     TRASH = "TRASH",
     DELETED = "DELETED",
     PENDING_PURGE = "PENDING_PURGE"
 }
 /** Restoration of the meta site. */
-export interface SiteUndeleted {
+interface SiteUndeleted {
 }
 /** First publish of a meta site. Or subsequent publish after unpublish. */
-export interface SitePublished {
+interface SitePublished {
 }
-export interface SiteUnpublished {
+interface SiteUnpublished {
     /**
      * A list of URLs previously associated with the meta site.
      * @maxLength 4000
@@ -539,11 +537,11 @@ export interface SiteUnpublished {
      */
     urls?: string[];
 }
-export interface SiteMarkedAsTemplate {
+interface SiteMarkedAsTemplate {
 }
-export interface SiteMarkedAsWixSite {
+interface SiteMarkedAsWixSite {
 }
-export interface ServiceProvisioned {
+interface ServiceProvisioned {
     /**
      * Either UUID or EmbeddedServiceType.
      * @maxLength 36
@@ -570,7 +568,7 @@ export interface ServiceProvisioned {
      */
     originMetaSiteId?: string | null;
 }
-export interface ServiceRemoved {
+interface ServiceRemoved {
     /**
      * Either UUID or EmbeddedServiceType.
      * @maxLength 36
@@ -588,7 +586,7 @@ export interface ServiceRemoved {
     version?: string | null;
 }
 /** Rename of the site. Meaning, free public url has been changed as well. */
-export interface SiteRenamed {
+interface SiteRenamed {
     /**
      * A new meta site name (URL slug).
      * @maxLength 20
@@ -605,23 +603,23 @@ export interface SiteRenamed {
  *
  * Could not be restored. Therefore it's desirable to cleanup data.
  */
-export interface SiteHardDeleted {
+interface SiteHardDeleted {
     /** A deletion context. */
     deleteContext?: DeleteContext;
 }
-export interface NamespaceChanged {
+interface NamespaceChanged {
     /** A previous namespace. */
     oldNamespace?: Namespace;
     /** A new namespace. */
     newNamespace?: Namespace;
 }
 /** Assigned Studio editor */
-export interface StudioAssigned {
+interface StudioAssigned {
 }
 /** Unassigned Studio editor */
-export interface StudioUnassigned {
+interface StudioUnassigned {
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -637,7 +635,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -662,7 +660,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -684,32 +682,12 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface UrlStructureOverrideNonNullableFields {
-    urlStructure: UrlStructure;
-}
-interface LocaleNonNullableFields {
-    visibility: LocaleVisibility;
-    effectiveUrlStructure: UrlStructure;
-    urlStructureOverride?: UrlStructureOverrideNonNullableFields;
-}
-interface LocaleSettingsNonNullableFields {
-    urlStructure: UrlStructure;
-    primaryLocale?: LocaleNonNullableFields;
-}
-export interface GetLocaleSettingsResponseNonNullableFields {
-    localeSettings?: LocaleSettingsNonNullableFields;
-}
-export interface UpdateLocaleSettingsResponseNonNullableFields {
-    localeSettings?: LocaleSettingsNonNullableFields;
-}
-export interface SetMultilingualModeResponseNonNullableFields {
-    localeSettings?: LocaleSettingsNonNullableFields;
-}
-export {};
+
+export { type ActionEvent as A, type ServiceProvisioned as B, type ServiceRemoved as C, DeleteStatus as D, type EntityCreatedEvent as E, type SiteRenamed as F, type GetLocaleSettingsResponse as G, type SiteHardDeleted as H, type NamespaceChanged as I, type StudioAssigned as J, type StudioUnassigned as K, type LocaleSettings as L, type MultilingualModeUpdated as M, Namespace as N, type MessageEnvelope as O, type IdentificationData as P, type IdentificationDataIdOneOf as Q, type RestoreInfo as R, type SetMultilingualModeResponse as S, type UpdateLocaleSettingsResponse as U, WebhookIdentityType as W, UrlStructure as a, LocaleVisibility as b, State as c, SiteCreatedContext as d, type Locale as e, type UrlStructureOverride as f, type GetLocaleSettingsRequest as g, type UpdateLocaleSettingsRequest as h, type SetMultilingualModeRequest as i, type DomainEvent as j, type DomainEventBodyOneOf as k, type EntityUpdatedEvent as l, type EntityDeletedEvent as m, type Empty as n, type MetaSiteSpecialEvent as o, type MetaSiteSpecialEventPayloadOneOf as p, type Asset as q, type SiteCreated as r, type SiteTransferred as s, type SiteDeleted as t, type DeleteContext as u, type SiteUndeleted as v, type SitePublished as w, type SiteUnpublished as x, type SiteMarkedAsTemplate as y, type SiteMarkedAsWixSite as z };

package/build/meta.d.mts

@@ -0,0 +1,211 @@
+import { GetLocaleSettingsRequest as GetLocaleSettingsRequest$1, GetLocaleSettingsResponse as GetLocaleSettingsResponse$1, UpdateLocaleSettingsRequest as UpdateLocaleSettingsRequest$1, UpdateLocaleSettingsResponse as UpdateLocaleSettingsResponse$1, SetMultilingualModeRequest as SetMultilingualModeRequest$1, SetMultilingualModeResponse as SetMultilingualModeResponse$1 } from './index.mjs';
+
+/**
+ * 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
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Timestamp of when the Settings entity was created
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Timestamp of the last update to the Settings entity
+     * @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.
+     * @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.
+     */
+    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.
+     */
+    urlStructure?: UrlStructure;
+    /**
+     * The primary locale of the site, materialized from the locales service.
+     * @readonly
+     */
+    primaryLocale?: Locale;
+}
+/** Enum representing the method for resolving locales in URLs. */
+declare enum UrlStructure {
+    /** Value not specified */
+    UNDEFINED_RESOLUTION_METHOD = "UNDEFINED_RESOLUTION_METHOD",
+    /** www.mysite.com/fr */
+    SUBDIRECTORY = "SUBDIRECTORY",
+    /** fr.mysite.com */
+    SUBDOMAIN = "SUBDOMAIN",
+    /** 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).
+     * @maxLength 20
+     * @format LANGUAGE_TAG
+     * @readonly
+     * @immutable
+     */
+    id?: string | null;
+    /**
+     * Revision number for optimistic locking.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Locale was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the Locale was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Language code (e.g., "en" for English).
+     * @immutable
+     * @format LANGUAGE
+     */
+    languageCode?: string | null;
+    /**
+     * Region code (e.g., "US" for United States).
+     * @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)
+     */
+    visibility?: LocaleVisibility;
+    /**
+     * Indicates if the language is the primary user-facing language in the Business Manager.
+     * @readonly
+     */
+    primaryLocale?: boolean | null;
+    /**
+     * Indicates if the language is the primary visitor-facing language in the live site.
+     * @readonly
+     */
+    visitorPrimaryLocale?: boolean | null;
+    /**
+     * Flag code (e.g., "US" for United States flag).
+     * @maxLength 3
+     */
+    flag?: string | null;
+    /**
+     * Date and number format (e.g., "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.
+     * @readonly
+     */
+    effectiveUrlStructure?: UrlStructure;
+    /** Override for the default resolution method, if needed. */
+    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)
+     * @format LANGUAGE_TAG
+     */
+    machineTranslationCode?: string | null;
+    /**
+     * Calculated display name. This will equal override_name if it exists, or localized_name as default.
+     * @readonly
+     * @maxLength 30
+     */
+    effectiveDisplayName?: string | null;
+    /**
+     * Localized name inferred from the ID using the locale data set.
+     * @readonly
+     * @maxLength 30
+     */
+    displayName?: string | null;
+    /**
+     * User-defined override name for the locale.
+     * @maxLength 30
+     */
+    overrideDisplayName?: string | null;
+}
+/** Enum representing the visibility status of a locale. */
+declare enum LocaleVisibility {
+    /** Value not specified */
+    UNDEFINED_LOCALE_STATUS = "UNDEFINED_LOCALE_STATUS",
+    /** Locale was added to site but was not activated */
+    HIDDEN = "HIDDEN",
+    /** Locale was added to site and activated */
+    VISIBLE = "VISIBLE"
+}
+/** Message for overriding the default resolution method. */
+interface UrlStructureOverride {
+    /** The specific resolution method to use instead of the default. */
+    urlStructure?: UrlStructure;
+}
+/** Request message for retrieving multilingual settings */
+interface GetLocaleSettingsRequest {
+}
+/** Response message containing the requested multilingual settings */
+interface GetLocaleSettingsResponse {
+    /** The requested Settings entity */
+    localeSettings?: LocaleSettings;
+}
+/** Request message for updating multilingual settings */
+interface UpdateLocaleSettingsRequest {
+    /** Settings to be updated, may be partial */
+    localeSettings: LocaleSettings;
+}
+/** Response message containing the updated multilingual settings */
+interface UpdateLocaleSettingsResponse {
+    /** The updated Settings entity */
+    localeSettings?: LocaleSettings;
+}
+/** Request message for setting the multilingual mode */
+interface SetMultilingualModeRequest {
+    /** The new value of multilingual_mode to be set */
+    multilingualModeEnabled: boolean;
+}
+/** Response message containing the updated settings after changing the multilingual mode */
+interface SetMultilingualModeResponse {
+    /** The current Settings entity after the change */
+    localeSettings?: LocaleSettings;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function getLocaleSettings(): __PublicMethodMetaInfo<'GET', {}, GetLocaleSettingsRequest$1, GetLocaleSettingsRequest, GetLocaleSettingsResponse$1, GetLocaleSettingsResponse>;
+declare function updateLocaleSettings(): __PublicMethodMetaInfo<'PATCH', {}, UpdateLocaleSettingsRequest$1, UpdateLocaleSettingsRequest, UpdateLocaleSettingsResponse$1, UpdateLocaleSettingsResponse>;
+declare function setMultilingualMode(): __PublicMethodMetaInfo<'PATCH', {}, SetMultilingualModeRequest$1, SetMultilingualModeRequest, SetMultilingualModeResponse$1, SetMultilingualModeResponse>;
+
+export { type __PublicMethodMetaInfo, getLocaleSettings, setMultilingualMode, updateLocaleSettings };