{"id":"c531fc3f-0c03-442b-b871-eeede26a8907","createdDate":"2025-07-03T10:05:24.233Z","updatedDate":"2025-07-03T10:05:24.233Z","resourceId":"fbdca2d9-dade-4000-a414-5f7926804b57","sdk":{"schema":{"name":"multilingual_locales","fqn":"","slug":"multilingual-locales","typesMap":{"V2Locale":{"name":"V2Locale","fqn":"V2Locale","slug":"v2locale","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the locale was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 20","format LANGUAGE_TAG","immutable"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Locale ID. The ID is made up of the language and region codes supported by Wix. For example, `\"en-US\"`."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the locale was last updated."},{"name":"displayName","slug":"display-name","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 30"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Default display name for the locale, inferred from the locale ID and region code."},{"name":"effectiveDisplayName","slug":"effective-display-name","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 30"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"The locale's `displayName`, unless overridden."},{"name":"effectiveUrlStructure","slug":"effective-url-structure","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UrlStructure","referenceFqn":"UrlStructure"},"description":"Default URL structure for the locale's live site URL,\nbased on the locale's settings, unless overridden."},{"name":"flag","slug":"flag","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 3"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Flag icon as a 3-letter language code based on Wix's supported locales. For example, `\"USA\"` for the United States flag icon."},{"name":"languageCode","slug":"language-code","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["immutable","format LANGUAGE"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Language code. For example, `\"en\"` for English."},{"name":"machineTranslationCode","slug":"machine-translation-code","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format LANGUAGE_TAG"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Language code based on Wix's supported locales, used to specify the target language when\ntranslatable content is sent for machine translation. For example, `\"ES\"` for Spanish\nor `\"ZH_TW\"` for Traditional Chinese.\n\nDefault: The locale's `languageCode` value."},{"name":"overrideDisplayName","slug":"override-display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 30"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional override for the locale's display name."},{"name":"primaryLocale","slug":"primary-locale","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates whether the locale is the site's primary locale."},{"name":"regionCode","slug":"region-code","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["immutable","format COUNTRY"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Region code. For example, `\"UK\"` for United Kingdom."},{"name":"regionalFormat","slug":"regional-format","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format LANGUAGE_TAG"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Regional format for determining how to display data types such as dates, times, numbers, and currencies. For example, `\"en-US\"` to format dates like this: `MM-DD-YYYY`."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"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."},{"name":"urlStructureOverride","slug":"url-structure-override","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UrlStructureOverride","referenceFqn":"UrlStructureOverride"},"description":"Optional override for the locale's default URL structure."},{"name":"visibility","slug":"visibility","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocaleVisibility","referenceFqn":"LocaleVisibility"},"description":"Locale visibility status."},{"name":"visitorPrimaryLocale","slug":"visitor-primary-locale","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates whether the locale is treated as the default for site visitors when no language is specified in the URL of the site."}]},"UrlStructure":{"name":"UrlStructure","fqn":"UrlStructure","slug":"url-structure","actions":[],"enumValues":[{"value":"QUERY_PARAM","description":"URL structure as a query parameter. For example, `\"www.mysite.com?lang=fr\"`."},{"value":"SUBDIRECTORY","description":"URL structure as a subdirectory. For example, `\"www.mysite.com/fr\"`."},{"value":"SUBDOMAIN","description":"URL structure as a subdomain. For example, `\"fr.mysite.com\"`."},{"value":"UNDEFINED_RESOLUTION_METHOD","description":"Undefined URL structure."}],"properties":[]},"UrlStructureOverride":{"name":"UrlStructureOverride","fqn":"UrlStructureOverride","slug":"url-structure-override","actions":[],"properties":[{"name":"urlStructure","slug":"url-structure","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UrlStructure","referenceFqn":"UrlStructure"},"description":"URL structure to use instead of the default."}]},"LocaleVisibility":{"name":"LocaleVisibility","fqn":"LocaleVisibility","slug":"locale-visibility","actions":[],"enumValues":[{"value":"HIDDEN","description":"Locale is hidden from site visitors. A site's locale should be hidden when a translation is not ready to be exposed to visitors."},{"value":"UNDEFINED_LOCALE_STATUS","description":"Undefined visibility status."},{"value":"VISIBLE","description":"Locale is visible to site visitors. A site can only have up to 100 visible locales."}],"properties":[]},"BulkCreateLocalesOptions":{"name":"BulkCreateLocalesOptions","fqn":"BulkCreateLocalesOptions","slug":"bulk-create-locales-options","actions":[],"properties":[{"name":"returnEntity","slug":"return-entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to receive the created locales in the response."}]},"BulkCreateLocalesResponse":{"name":"BulkCreateLocalesResponse","fqn":"BulkCreateLocalesResponse","slug":"bulk-create-locales-response","actions":[],"properties":[{"name":"bulkActionMetadata","slug":"bulk-action-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkActionMetadata","referenceFqn":"BulkActionMetadata"},"description":"Bulk metadata."},{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minSize 1","maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BulkLocaleResult","referenceFqn":"BulkLocaleResult"}},"description":"Information about the created locales."}]},"BulkActionMetadata":{"name":"BulkActionMetadata","fqn":"BulkActionMetadata","slug":"bulk-action-metadata","actions":[],"properties":[{"name":"totalFailures","slug":"total-failures","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items that couldn't be processed."},{"name":"totalSuccesses","slug":"total-successes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items that were successfully processed."},{"name":"undetailedFailures","slug":"undetailed-failures","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of failures without details because detailed failure threshold was exceeded."}]},"BulkLocaleResult":{"name":"BulkLocaleResult","fqn":"BulkLocaleResult","slug":"bulk-locale-result","actions":[],"properties":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V2Locale","referenceFqn":"V2Locale"},"description":"Created locale. Returned when `returnEntity` is set to `true`."},{"name":"itemMetadata","slug":"item-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemMetadata","referenceFqn":"ItemMetadata"},"description":"Item metadata."}]},"ItemMetadata":{"name":"ItemMetadata","fqn":"ItemMetadata","slug":"item-metadata","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."},{"name":"error","slug":"error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"ApplicationError"},"description":"Details about the error in case of failure."},{"name":"originalIndex","slug":"original-index","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Index of the item within the request array. Allows for correlation between request and response items."},{"name":"success","slug":"success","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated."}]},"ApplicationError":{"name":"ApplicationError","fqn":"ApplicationError","slug":"application-error","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Error code."},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Data related to the error."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description of the error."}]},"BulkDeleteLocalesResponse":{"name":"BulkDeleteLocalesResponse","fqn":"BulkDeleteLocalesResponse","slug":"bulk-delete-locales-response","actions":[],"properties":[{"name":"bulkActionMetadata","slug":"bulk-action-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkActionMetadata","referenceFqn":"BulkActionMetadata"},"description":"Bulk metadata."},{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minSize 1","maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BulkDeleteLocalesResponseBulkLocaleResult","referenceFqn":"BulkDeleteLocalesResponseBulkLocaleResult"}},"description":"Information about the deleted locales."}]},"BulkDeleteLocalesResponseBulkLocaleResult":{"name":"BulkDeleteLocalesResponseBulkLocaleResult","fqn":"BulkDeleteLocalesResponseBulkLocaleResult","slug":"bulk-delete-locales-response-bulk-locale-result","actions":[],"properties":[{"name":"itemMetadata","slug":"item-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemMetadata","referenceFqn":"ItemMetadata"},"description":"Item metadata."}]},"MaskedLocale":{"name":"MaskedLocale","fqn":"MaskedLocale","slug":"masked-locale","actions":[],"properties":[{"name":"locale","slug":"locale","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V2Locale","referenceFqn":"V2Locale"},"description":"Locales to update, may be partial."}]},"BulkUpdateLocalesOptions":{"name":"BulkUpdateLocalesOptions","fqn":"BulkUpdateLocalesOptions","slug":"bulk-update-locales-options","actions":[],"properties":[{"name":"returnEntity","slug":"return-entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to receive the updated locales in the response."}]},"BulkUpdateLocalesResponse":{"name":"BulkUpdateLocalesResponse","fqn":"BulkUpdateLocalesResponse","slug":"bulk-update-locales-response","actions":[],"properties":[{"name":"bulkActionMetadata","slug":"bulk-action-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkActionMetadata","referenceFqn":"BulkActionMetadata"},"description":"Bulk metadata."},{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minSize 1","maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BulkUpdateLocalesResponseBulkLocaleResult","referenceFqn":"BulkUpdateLocalesResponseBulkLocaleResult"}},"description":"Information about the updated locales."}]},"BulkUpdateLocalesResponseBulkLocaleResult":{"name":"BulkUpdateLocalesResponseBulkLocaleResult","fqn":"BulkUpdateLocalesResponseBulkLocaleResult","slug":"bulk-update-locales-response-bulk-locale-result","actions":[],"properties":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V2Locale","referenceFqn":"V2Locale"},"description":"Updated locale. Returned when `returnEntity` is set to `true`."},{"name":"itemMetadata","slug":"item-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemMetadata","referenceFqn":"ItemMetadata"},"description":"Item metadata."}]},"CreateNewPrimaryLocaleResponse":{"name":"CreateNewPrimaryLocaleResponse","fqn":"CreateNewPrimaryLocaleResponse","slug":"create-new-primary-locale-response","actions":[],"properties":[{"name":"token","slug":"token","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"}}]},"GetNewPrimaryLocaleStatusResponse":{"name":"GetNewPrimaryLocaleStatusResponse","fqn":"GetNewPrimaryLocaleStatusResponse","slug":"get-new-primary-locale-status-response","actions":[],"oneofProperties":{"data":[{"name":"finishSuccessfulData","slug":"finish-successful-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FinishSuccessfulData","referenceFqn":"FinishSuccessfulData"},"description":"New primary locale data when the process successfully completes."},{"name":"finishWithErrorData","slug":"finish-with-error-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FinishWithErrorData","referenceFqn":"FinishWithErrorData"},"description":"Error details when the process fails."}]},"properties":[{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Status","referenceFqn":"Status"},"description":"The current status of the Create New Primary Locale method."}]},"FinishSuccessfulData":{"name":"FinishSuccessfulData","fqn":"FinishSuccessfulData","slug":"finish-successful-data","actions":[],"properties":[{"name":"newPrimaryLocale","slug":"new-primary-locale","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V2Locale","referenceFqn":"V2Locale"},"description":"The new primary locale."}]},"FinishWithErrorData":{"name":"FinishWithErrorData","fqn":"FinishWithErrorData","slug":"finish-with-error-data","actions":[],"properties":[{"name":"error","slug":"error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"ApplicationError"},"description":"Error details."}]},"Status":{"name":"Status","fqn":"Status","slug":"status","actions":[],"enumValues":[{"value":"FINISH_SUCCESSFUL","description":"Indicates the process of creating a new primary locale was successful and all content under the previous primary locale is now tagged under the new locale. New primary locale data is available in the `finishSuccessfulData` object."},{"value":"FINISH_WITH_ERROR","description":"Indicates the process of creating a new primary locale failed. Additional error details are available in the `finishWithErrorData` object."},{"value":"IN_PROGRESS","description":"Indicates the process of creating a new primary locale is in progress."},{"value":"UNKNOWN","description":"Unknown status."}],"properties":[]},"ListSupportedLocalesOptions":{"name":"ListSupportedLocalesOptions","fqn":"ListSupportedLocalesOptions","slug":"list-supported-locales-options","actions":[],"properties":[{"name":"includeAllLocales","slug":"include-all-locales","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to include all possible regional variants for each language code in the response. When `false`, only the default locale, such as `\"en-US\"`, is returned and regional variants like `\"en-GB\"` and `\"en-AU\"` are excluded."},{"name":"includeRegionOptions","slug":"include-region-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to include region-specific options such as flags and regional codes for each locale in the response."},{"name":"languageCode","slug":"language-code","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format LANGUAGE"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Language to filter by. For example, `\"en\"` for all English locales."}]},"ListSupportedLocalesResponse":{"name":"ListSupportedLocalesResponse","fqn":"ListSupportedLocalesResponse","slug":"list-supported-locales-response","actions":[],"properties":[{"name":"supportedLocales","slug":"supported-locales","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"SupportedLocale","referenceFqn":"SupportedLocale"}},"description":"A list of all the locales that can be added to a site."}]},"SupportedLocale":{"name":"SupportedLocale","fqn":"SupportedLocale","slug":"supported-locale","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format LANGUAGE_TAG"],"type":{"kind":"PRIMITIVE","name":"string"}},{"name":"defaultFlag","slug":"default-flag","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 3"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Default flag code for the locale."},{"name":"defaultRegionalFormat","slug":"default-regional-format","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format LANGUAGE_TAG"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Default format for how to display data types such as dates, times, numbers, and currencies."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 30"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Display name of the locale."},{"name":"languageCode","slug":"language-code","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format LANGUAGE"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Language code."},{"name":"machineTranslationCode","slug":"machine-translation-code","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format LANGUAGE_TAG"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Language code used when content is sent for machine translation."},{"name":"regionCode","slug":"region-code","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COUNTRY"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Region code."},{"name":"regionOptions","slug":"region-options","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"RegionOptions","referenceFqn":"RegionOptions"}},"description":"All flags and their regional formats per locale."}]},"RegionOptions":{"name":"RegionOptions","fqn":"RegionOptions","slug":"region-options","actions":[],"properties":[{"name":"flag","slug":"flag","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 3"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Flag code of the region."},{"name":"regionalFormat","slug":"regional-format","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format LANGUAGE_TAG"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Format for how to display data types such as dates, times, numbers, and currencies."}]},"LocalesQueryBuilder":{"name":"LocalesQueryBuilder","fqn":"LocalesQueryBuilder","slug":"locales-query-builder","actions":[{"name":"ascending","fqn":"LocalesQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query = locales.queryLocales().ascending('_id');\n"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().ascending('_id').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\n\nThe `ascending()` function refines a `LocalesQueryBuilder` to sort by the value of `propertyName` in ascending order.\nYou can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.","sdkErrors":[],"kind":"GENERAL"},{"name":"descending","fqn":"LocalesQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add a `descending` sort to a query","content":"const query = locales.queryLocales().descending('_id');\n"},{"title":"Create a query, add a `descending` sort, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().descending('_id').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\n\nThe `descending()` function refines a `LocalesQueryBuilder` to sort by the value of `propertyName` in descending order.\nYou can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.","sdkErrors":[],"kind":"GENERAL"},{"name":"eq","fqn":"LocalesQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add an `eq` filter to a query","content":"const query = locales.queryLocales().eq('_id', 'some-id');\n"},{"title":"Create a query, add an `eq` filter, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales\n .queryLocales()\n .eq('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property equals the specified value.\n\nThe `eq()` function refines a `LocalesQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`.\n`eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`.","sdkErrors":[],"kind":"GENERAL"},{"name":"exists","fqn":"LocalesQueryBuilder.exists","slug":"exists","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add an `exists` filter to a query","content":"const query = locales.queryLocales().exists('description', true);\n"},{"title":"Create a query, add an `exists` filter, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales\n .queryLocales()\n .exists('description', true)\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}}],"description":"Refines a query to match items where the specified property contains a value.\n\nThe `exists()` function refines a `LocalesQueryBuilder` to only match items where the value of the specified `propertyName` doesn't equal null or undefined.\n `exists()` checks for either existence or non-existence based on the boolean parameter. Note that `exists()` does match items where the value of the specified `propertyName` is an empty string or an invalid value. `exists()` is only useful for properties which don't contain default values and therefore their values may be unassigned.","sdkErrors":[],"kind":"GENERAL"},{"name":"find","fqn":"LocalesQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"LocalesQueryResult","referenceFqn":"LocalesQueryResult"}},"examples":[{"title":"Run a query with no filters","content":"const query = locales.queryLocales().find();\n"},{"title":"Perform a `find` on a query","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"description":"Returns the query results.\n\nThe `find()` function returns a Promise that resolves to the query results and metadata.\nThe Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid.","sdkErrors":[],"kind":"GENERAL"},{"name":"ge","fqn":"LocalesQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add a `ge` filter to a query","content":"const query = locales.queryLocales().ge('_id', 'some-id');\n"},{"title":"Create a query, add a `ge` filter, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().ge('_id', 'some-id').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is greater than or equal to the specified value.\n\nThe `ge()` function refines a `LocalesQueryBuilder` to match only items where the value of the specified `propertyName` is greater than or equal to the specified `value`.\n`ge()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`.","sdkErrors":[],"kind":"GENERAL"},{"name":"gt","fqn":"LocalesQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add a `gt` filter to a query","content":"const query = locales.queryLocales().gt('_id', 'some-id');\n"},{"title":"Create a query, add a `gt` filter, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().gt('_id', 'some-id').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is greater than the specified value.\n\nThe `gt()` function refines a `LocalesQueryBuilder` to match only items where the value of the specified `propertyName` is greater than the specified `value`.\n`gt()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`.","sdkErrors":[],"kind":"GENERAL"},{"name":"hasSome","fqn":"LocalesQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add a `hasSome` filter to a query","content":"const query = locales\n .queryLocales()\n .hasSome('labelIds', ['red', 'blue', 'purple']);\n"},{"title":"Create a query, add a `hasSome` filter, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales\n .queryLocales()\n .hasSome('labelIds', ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `values`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}}}],"description":"Refines a query to match items whose specified property contains any of the specified values.\n\nThe `hasSome()` function refines a `LocalesQueryBuilder` to match only items where the value of the specified `propertyName` equals any of the specified `values`.\nMatching strings with `hasSome()` is case-sensitive, so `'text'` isn't equal to `'Text'`.\nIf the specified property is an array, `hasSome()` matches if any of that array's elements equal any of the specified values.","sdkErrors":[],"kind":"GENERAL"},{"name":"in","fqn":"LocalesQueryBuilder.in","slug":"in","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add an `in` filter to a query","content":"const query = locales\n .queryLocales()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple']);\n"},{"title":"Create a query, add an `in` filter, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales\n .queryLocales()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"}}],"description":"Refines a query to only match items where the specified property contains any of the values in the provided array of values.\n\nThe `in()` function refines a `LocalesQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array.\nMatching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`.","sdkErrors":[],"kind":"GENERAL"},{"name":"le","fqn":"LocalesQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add an `le` filter to a query","content":"const query = locales.queryLocales().le('_id', 'some-id');\n"},{"title":"Create a query, add an `le` filter, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().le('_id', 'some-id').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is less than or equal to the specified value.\n\nThe `le()` function refines a `LocalesQueryBuilder` to match only items where the value of the specified `propertyName` is less than or equal to the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`.","sdkErrors":[],"kind":"GENERAL"},{"name":"limit","fqn":"LocalesQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add a `limit` to a query","content":"const query = locales.queryLocales().limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Add a `limit` to a query","content":"const query = locales.queryLocales().limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to return, which is also the `pageSize` of the results object."}],"description":"Limits the number of items the query returns.\n\nThe `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.\nYou can use the `next()` and `prev()` functions to navigate the pages of a query result.","sdkErrors":[],"kind":"GENERAL"},{"name":"lt","fqn":"LocalesQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add an `lt` filter to a query","content":"const query = locales.queryLocales().lt('_id', 'some-id');\n"},{"title":"Create a query, add an `lt` filter, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().lt('_id', 'some-id').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is less than the specified value.\n\nThe `le()` function refines a `LocalesQueryBuilder` to match only items where the value of the specified `propertyName` is less than the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`.","sdkErrors":[],"kind":"GENERAL"},{"name":"ne","fqn":"LocalesQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add an `ne` filter to a query","content":"const query = locales\n .queryLocales()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da');\n"},{"title":"Create a query, add an `ne` filter, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales\n .queryLocales()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property doesn't equal the specified value.\n\nThe `ne()` function refines a `LocalesQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`.\n`ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`.","sdkErrors":[],"kind":"GENERAL"},{"name":"skipTo","fqn":"LocalesQueryBuilder.skipTo","slug":"skip-to","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Perform a query and skip to the next cursor","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().find();\n\n const nextCursor = results.cursors.next;\n return locales.queryLocales().skipTo(nextCursor).find();\n}\n"},{"title":"Perform a query and skip to the previous cursor","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().find();\n\n const prevCursor = results.cursors.prev;\n return locales.queryLocales().skipTo(prevCursor).find();\n}\n"}],"actionParams":[{"name":"cursor","slug":"cursor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A pointer to specific record"}],"description":"Refines a query that skips to a specific record.\n\nThe `skipTo()` function refines a `LocalesQueryBuilder` to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the `cursors` object in previous call's response. Then you can skip to `cursors.prev` to return items before the cursor, or `cursors.next` to return items after the cursor.\n \nWhen using `skipTo()`, the filters and the sorting order of the original query can't be changed. Only the `limit()` property of the query can be changed.","sdkErrors":[],"kind":"GENERAL"},{"name":"startsWith","fqn":"LocalesQueryBuilder.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"Add a `startsWith` filter to a query","content":"const query = locales.queryLocales().startsWith('_id', 'L');\n"},{"title":"Create a query, add a `startsWith` filter, and run it","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales();\n startsWith('_id', 'L').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `string`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}],"description":"Refines a query to match items where the specified property starts with the specified value.\n\nThe `startsWith()` function refines a `LocalesQueryBuilder` to match only items where the value of the specified `propertyName` starts with the specified `string`.\nMatching with `startsWith()` is case-sensitive, so `'TEXT'` doesn't start with `'text'`.\nYou can only use `startsWith()` with a property whose value is a string.","sdkErrors":[],"kind":"GENERAL"}],"properties":[],"articles":[],"webhooks":[]},"LocalesQueryResult":{"name":"LocalesQueryResult","fqn":"LocalesQueryResult","slug":"locales-query-result","actions":[{"name":"hasNext","fqn":"LocalesQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has more results","content":"const hasNext = results.hasNext();\n"},{"title":"Perform a query and get `hasNext` from the result","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().find();\n\n return results.hasNext();\n}\n"}],"description":"Indicates whether the query has more results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `locales` to navigate the pages of a query result.","sdkErrors":[],"kind":"GENERAL"},{"name":"hasPrev","fqn":"LocalesQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has previous results","content":"const hasPrev = results.hasPrev();\n"},{"title":"Perform a query and get `hasPrev` from the result","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().find();\n\n return results.hasPrev();\n}\n"}],"description":"Indicates whether the query has previous results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `locales` to navigate the pages of a query result.","sdkErrors":[],"kind":"GENERAL"},{"name":"next","fqn":"LocalesQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"LocalesQueryResult","referenceFqn":"LocalesQueryResult"}},"examples":[{"title":"Get `next` from a query result","content":"const nextPage = results.next();\n"},{"title":"Perform a query and get `next` from the result","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().find();\n\n return results.next();\n}\n"},{"title":"Iterate through all pages of query results","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n let allItems = [];\n\n const results = await locales.queryLocales().limit(1000).find();\n allItems.push(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\n\nThe `next()` function retrieves the next page of query results.\nThe page size is defined by the [`limit()`](/locales-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `locales` to navigate the pages of a query result.\nIf items are added or removed between calls to `next()`, the values returned by `LocalesQueryBuilder` may change.","sdkErrors":[],"kind":"GENERAL"},{"name":"prev","fqn":"LocalesQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"LocalesQueryResult","referenceFqn":"LocalesQueryResult"}},"examples":[{"title":"Get `prev` from a query result","content":"const previousPage = results.prev();\n"},{"title":"Perform a query and get `prev` from the result","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().find();\n\n return results.prev();\n}\n"}],"description":"Retrieves the previous page of query results.\n\nThe `prev()` function retrieves the previous page of query results.\nThe page size is defined by the [`limit()`](/locales-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `locales` to navigate the pages of a query result.\nIf items are added or removed between calls to `prev()`, the values returned may change.","sdkErrors":[],"kind":"GENERAL"}],"properties":[{"name":"cursors","slug":"cursors","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query's cursors","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().find();\n\n const cursors = results.cursors;\n}\n"}],"type":{"kind":"REFERENCE","name":"Cursors","referenceFqn":"Cursors"},"description":"Returns the query cursors.\n\n`cursors` returns the query's `next` and `prev` cursors."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `items` from a query result","content":"const returnedItems = results.items;\n"},{"title":"Perform a query and get `items` from the result","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().find();\n\n const returnedItems = results.items;\n\n if (returnedItems.length > 0) {\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"V2Locale","referenceFqn":"V2Locale"}},"description":"Returns an array of `locales` items that match the query.\n\n`items` contains the current page of results retrieved by the query.\nIf no results match the query, `items` is an empty array.\nThe page size is defined by the [`limit()`](/locales-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `locales` to navigate the pages of a query result."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `length` from a query result","content":"const resultLength = results.length;\n"},{"title":"Perform a query and get `length` from the result","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().find();\n\n return results.length;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current page of results.\n\n`length` returns just the number of items in the current page, not the total number of items that match the query.\nThe page size is defined by the [`limit()`](/locales-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `locales` to navigate the pages of a query result."},{"name":"pageSize","slug":"page-size","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query's page size","content":"const requestedPageSize = results.pageSize;\n"},{"title":"Perform a query and get `pageSize` from the result","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().find();\n\n return results.pageSize;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the requested page size.\n\n`pageSize` returns the page size set in [`limit()`](/locales-query-builder/limit) in `LocalesQueryBuilder`."},{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `query` that produced the current result","content":"const originalQuery = results.query;\n"},{"title":"Perform a query and get `query` from the result","content":"import { locales } from '@wix/multilingual';\n\nexport async function myQueryFunction() {\n const results = await locales.queryLocales().find();\n\n return results.query;\n}\n"}],"type":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"description":"Returns the `LocalesQueryBuilder` object used to get the current results.\n\nUse `query` to create and run a new query by chaining additional `LocalesQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `LocalesQueryBuilder`."}],"articles":[],"webhooks":[]},"Cursors":{"name":"Cursors","fqn":"Cursors","slug":"cursors","actions":[],"properties":[{"name":"next","slug":"next","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 16000"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor string pointing to the next page in the list of results."},{"name":"prev","slug":"prev","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 16000"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor pointing to the previous page in the list of results."}]},"UpdateLocale":{"name":"UpdateLocale","fqn":"UpdateLocale","slug":"update-locale","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the locale was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 20","format LANGUAGE_TAG","immutable"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Locale ID. The ID is made up of the language and region codes supported by Wix. For example, `\"en-US\"`."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the locale was last updated."},{"name":"displayName","slug":"display-name","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 30"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Default display name for the locale, inferred from the locale ID and region code."},{"name":"effectiveDisplayName","slug":"effective-display-name","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 30"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"The locale's `displayName`, unless overridden."},{"name":"effectiveUrlStructure","slug":"effective-url-structure","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UrlStructure","referenceFqn":"UrlStructure"},"description":"Default URL structure for the locale's live site URL,\nbased on the locale's settings, unless overridden."},{"name":"flag","slug":"flag","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 3"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Flag icon as a 3-letter language code based on Wix's supported locales. For example, `\"USA\"` for the United States flag icon."},{"name":"languageCode","slug":"language-code","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["immutable","format LANGUAGE"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Language code. For example, `\"en\"` for English."},{"name":"machineTranslationCode","slug":"machine-translation-code","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format LANGUAGE_TAG"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Language code based on Wix's supported locales, used to specify the target language when\ntranslatable content is sent for machine translation. For example, `\"ES\"` for Spanish\nor `\"ZH_TW\"` for Traditional Chinese.\n\nDefault: The locale's `languageCode` value."},{"name":"overrideDisplayName","slug":"override-display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 30"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional override for the locale's display name."},{"name":"primaryLocale","slug":"primary-locale","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates whether the locale is the site's primary locale."},{"name":"regionCode","slug":"region-code","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["immutable","format COUNTRY"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Region code. For example, `\"UK\"` for United Kingdom."},{"name":"regionalFormat","slug":"regional-format","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format LANGUAGE_TAG"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Regional format for determining how to display data types such as dates, times, numbers, and currencies. For example, `\"en-US\"` to format dates like this: `MM-DD-YYYY`."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"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."},{"name":"urlStructureOverride","slug":"url-structure-override","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UrlStructureOverride","referenceFqn":"UrlStructureOverride"},"description":"Optional override for the locale's default URL structure."},{"name":"visibility","slug":"visibility","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocaleVisibility","referenceFqn":"LocaleVisibility"},"description":"Locale visibility status."},{"name":"visitorPrimaryLocale","slug":"visitor-primary-locale","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates whether the locale is treated as the default for site visitors when no language is specified in the URL of the site."}]},"CreateNewPrimaryLocaleApplicationErrors":{"name":"CreateNewPrimaryLocaleApplicationErrors","fqn":"CreateNewPrimaryLocaleApplicationErrors","slug":"create-new-primary-locale-application-errors","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"OnLocaleCreatedHandler":{"name":"OnLocaleCreatedHandler","fqn":"OnLocaleCreatedHandler","slug":"on-locale-created-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocaleCreatedEnvelope","referenceFqn":"LocaleCreatedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"LocaleCreatedEnvelope":{"name":"LocaleCreatedEnvelope","fqn":"LocaleCreatedEnvelope","slug":"locale-created-envelope","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V2Locale","referenceFqn":"V2Locale"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]},"EventMetadata":{"name":"EventMetadata","fqn":"EventMetadata","slug":"event-metadata","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID. With this ID you can easily spot duplicated events and ignore them."},{"name":"entityEventSequence","slug":"entity-event-sequence","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.\nYou can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it."},{"name":"entityFqdn","slug":"entity-fqdn","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\nFor example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`."},{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`."},{"name":"eventType","slug":"event-type","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 150"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Event type."},{"name":"identity","slug":"identity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"IdentificationData","referenceFqn":"IdentificationData"},"description":"The identification type and identity data."},{"name":"instanceId","slug":"instance-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"App instance ID."},{"name":"originatedFrom","slug":"originated-from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"If present, indicates the action that triggered the event."},{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event action name, placed at the top level to make it easier for users to dispatch messages.\nFor example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR)."}]},"IdentificationData":{"name":"IdentificationData","fqn":"IdentificationData","slug":"identification-data","actions":[],"oneofProperties":{"id":[{"name":"anonymousVisitorId","slug":"anonymous-visitor-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of a site visitor that has not logged in to the site."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of an app."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of a site visitor that has logged in to the site."},{"name":"wixUserId","slug":"wix-user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of a Wix user (site owner, contributor, etc.)."}]},"properties":[{"name":"identityType","slug":"identity-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WebhookIdentityType","referenceFqn":"WebhookIdentityType"}}]},"WebhookIdentityType":{"name":"WebhookIdentityType","fqn":"WebhookIdentityType","slug":"webhook-identity-type","actions":[],"enumValues":[{"value":"ANONYMOUS_VISITOR"},{"value":"APP"},{"value":"MEMBER"},{"value":"UNKNOWN"},{"value":"WIX_USER"}],"properties":[]},"OnLocaleDeletedHandler":{"name":"OnLocaleDeletedHandler","fqn":"OnLocaleDeletedHandler","slug":"on-locale-deleted-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocaleDeletedEnvelope","referenceFqn":"LocaleDeletedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"LocaleDeletedEnvelope":{"name":"LocaleDeletedEnvelope","fqn":"LocaleDeletedEnvelope","slug":"locale-deleted-envelope","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V2Locale","referenceFqn":"V2Locale"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]},"OnLocaleMultilingualPrimaryLocaleChangedHandler":{"name":"OnLocaleMultilingualPrimaryLocaleChangedHandler","fqn":"OnLocaleMultilingualPrimaryLocaleChangedHandler","slug":"on-locale-multilingual-primary-locale-changed-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocaleMultilingualPrimaryLocaleChangedEnvelope","referenceFqn":"LocaleMultilingualPrimaryLocaleChangedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"LocaleMultilingualPrimaryLocaleChangedEnvelope":{"name":"LocaleMultilingualPrimaryLocaleChangedEnvelope","fqn":"LocaleMultilingualPrimaryLocaleChangedEnvelope","slug":"locale-multilingual-primary-locale-changed-envelope","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreateNewPrimaryLocalePayload","referenceFqn":"CreateNewPrimaryLocalePayload"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]},"CreateNewPrimaryLocalePayload":{"name":"CreateNewPrimaryLocalePayload","fqn":"CreateNewPrimaryLocalePayload","slug":"create-new-primary-locale-payload","actions":[],"properties":[{"name":"primaryLocale","slug":"primary-locale","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V2Locale","referenceFqn":"V2Locale"},"description":"The new primary locale after the Create New Primary Locale endpoint is finished."}]},"OnLocaleUpdatedHandler":{"name":"OnLocaleUpdatedHandler","fqn":"OnLocaleUpdatedHandler","slug":"on-locale-updated-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocaleUpdatedEnvelope","referenceFqn":"LocaleUpdatedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"LocaleUpdatedEnvelope":{"name":"LocaleUpdatedEnvelope","fqn":"LocaleUpdatedEnvelope","slug":"locale-updated-envelope","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V2Locale","referenceFqn":"V2Locale"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]}},"standaloneTypes":[],"metadata":{"fqdn":"wix.multilingual.locales.v2.locale"},"actions":[{"name":"bulkCreateLocales","fqn":"bulkCreateLocales","fullFqn":"wix.multilingual.locales.v2.LocalesService.BulkCreateLocales","slug":"bulk-create-locales","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["locales","locales.languageCode"],"permissionIds":["WIX_MULTILINGUAL.LOCALE_CREATE"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BulkCreateLocalesResponse","referenceFqn":"BulkCreateLocalesResponse"},"description":"Response message for bulk creating Locales."},"examples":[{"title":"bulkCreateLocales","content":"import { locales } from '@wix/multilingual';\n\nasync function bulkCreateLocales(locales, options) {\n const response = await locales.bulkCreateLocales(locales, options);\n};"},{"title":"bulkCreateLocales (with elevated permissions)","content":"import { locales } from '@wix/multilingual';\nimport { auth } from '@wix/essentials';\n\nasync function myBulkCreateLocalesMethod(locales, options) {\n const elevatedBulkCreateLocales = auth.elevate(locales.bulkCreateLocales);\n const response = await elevatedBulkCreateLocales(locales, options);\n}"},{"title":"bulkCreateLocales (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { locales } from '@wix/multilingual';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { locales },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkCreateLocales(locales, options) {\n const response = await myWixClient.locales.bulkCreateLocales(locales, options);\n};"}],"actionParams":[{"name":"locales","slug":"locales","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"V2Locale","referenceFqn":"V2Locale"}},"description":"Locales to create."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkCreateLocalesOptions","referenceFqn":"BulkCreateLocalesOptions"}}],"description":"Creates multiple secondary locales.\n\n

\nImportant:\n\n- This method can only be called on sites where multilingual mode is enabled.\n\n

\nWarning:\n\nThis method permanently deletes multiple secondary locales and their data from the site.\n

\nImportant:\n\n- This method can only be called on sites where multilingual mode is enabled.\n- This method creates only secondary locales. To create and set a new primary locale, call Create New Primary Locale.\n\n

\nImportant:\n\n- The desired new primary locale can't already exist as a secondary locale on the site. If the locale is already a secondary locale on the site, you must first remove it from the site by calling Delete Locale before changing the primary locale.\n- This method automatically deletes the original primary locale and transfers its data to the new primary locale.\n\n

","sdkErrors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"NEW_MAIN_LOCALE_EXIST_ON_SITE","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NEW_MAIN_LOCALE_EXIST_ON_SITE"}}],"kind":"GENERAL","permissionScopes":[{"name":"Wix Multilingual","scopeId":"SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"}],"isAdminMethod":true},{"name":"deleteLocale","fqn":"deleteLocale","fullFqn":"wix.multilingual.locales.v2.LocalesService.DeleteLocale","slug":"delete-locale","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["localeId"],"permissionIds":["WIX_MULTILINGUAL.LOCALE_DELETE"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Response message for deleting a Locale."},"examples":[{"title":"deleteLocale","content":"import { locales } from '@wix/multilingual';\n\nasync function deleteLocale(localeId) {\n const response = await locales.deleteLocale(localeId);\n};"},{"title":"deleteLocale (with elevated permissions)","content":"import { locales } from '@wix/multilingual';\nimport { auth } from '@wix/essentials';\n\nasync function myDeleteLocaleMethod(localeId) {\n const elevatedDeleteLocale = auth.elevate(locales.deleteLocale);\n const response = await elevatedDeleteLocale(localeId);\n}"},{"title":"deleteLocale (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { locales } from '@wix/multilingual';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { locales },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function deleteLocale(localeId) {\n const response = await myWixClient.locales.deleteLocale(localeId);\n};"}],"actionParams":[{"name":"localeId","slug":"locale-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the locale to delete."}],"description":"Deletes a locale by ID.\n\nThis method removes only secondary locales from a site. You can't call this method to delete a primary locale directly.\n\n

\nWarning:\n\nThis method permanently deletes the specified locale and all its associated data from a site.\n\n

\n\n

\nTip:\n\nYou can change the primary locale by calling Create New Primary Locale. This automatically deletes the original primary locale and transfers its data to the new primary locale.\n\n

","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Wix Multilingual","scopeId":"SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"}],"isAdminMethod":true},{"name":"getLocale","fqn":"getLocale","fullFqn":"wix.multilingual.locales.v2.LocalesService.GetLocale","slug":"get-locale","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["localeId"],"permissionIds":["WIX_MULTILINGUAL.LOCALE_READ"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"V2Locale","referenceFqn":"V2Locale"},"description":"The requested locale."},"examples":[{"title":"getLocale","content":"import { locales } from '@wix/multilingual';\n\nasync function getLocale(localeId) {\n const response = await locales.getLocale(localeId);\n};"},{"title":"getLocale (with elevated permissions)","content":"import { locales } from '@wix/multilingual';\nimport { auth } from '@wix/essentials';\n\nasync function myGetLocaleMethod(localeId) {\n const elevatedGetLocale = auth.elevate(locales.getLocale);\n const response = await elevatedGetLocale(localeId);\n}"},{"title":"getLocale (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { locales } from '@wix/multilingual';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { locales },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function getLocale(localeId) {\n const response = await myWixClient.locales.getLocale(localeId);\n};"}],"actionParams":[{"name":"localeId","slug":"locale-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the locale to retrieve."}],"description":"Retrieves a locale by ID.","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Wix Multilingual","scopeId":"SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"}],"isAdminMethod":true},{"name":"getNewPrimaryLocaleStatus","fqn":"getNewPrimaryLocaleStatus","fullFqn":"wix.multilingual.locales.v2.LocalesService.GetNewPrimaryLocaleStatus","slug":"get-new-primary-locale-status","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["token"],"permissionIds":["WIX_MULTILINGUAL.LOCALE_CHANGE_MAIN"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GetNewPrimaryLocaleStatusResponse","referenceFqn":"GetNewPrimaryLocaleStatusResponse"},"description":"Response message for getting the status of the change main locale process."},"examples":[{"title":"getNewPrimaryLocaleStatus","content":"import { locales } from '@wix/multilingual';\n\nasync function getNewPrimaryLocaleStatus(token) {\n const response = await locales.getNewPrimaryLocaleStatus(token);\n};"},{"title":"getNewPrimaryLocaleStatus (with elevated permissions)","content":"import { locales } from '@wix/multilingual';\nimport { auth } from '@wix/essentials';\n\nasync function myGetNewPrimaryLocaleStatusMethod(token) {\n const elevatedGetNewPrimaryLocaleStatus = auth.elevate(locales.getNewPrimaryLocaleStatus);\n const response = await elevatedGetNewPrimaryLocaleStatus(token);\n}"},{"title":"getNewPrimaryLocaleStatus (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { locales } from '@wix/multilingual';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { locales },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function getNewPrimaryLocaleStatus(token) {\n const response = await myWixClient.locales.getNewPrimaryLocaleStatus(token);\n};"}],"actionParams":[{"name":"token","slug":"token","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Token to retrieve the process status. Returned in the response of Create New Primary Locale."}],"description":"Retrieves the status of the Create New Primary Locale method.\n\nCall this method to see if your primary locale was successfully changed. Specify the token returned by Create New Primary Locale. If the token specified is invalid, a 404 error is returned.","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Wix Multilingual","scopeId":"SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"}],"isAdminMethod":true},{"name":"listSupportedLocales","fqn":"listSupportedLocales","fullFqn":"wix.multilingual.locales.v2.SupportedLocalesService.ListSupportedLocales","slug":"list-supported-locales","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","permissionIds":["WIX_MULTILINGUAL.READ_SUPPORTED_LOCALES"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListSupportedLocalesResponse","referenceFqn":"ListSupportedLocalesResponse"},"description":"Response message for listing supported locales"},"examples":[{"title":"listSupportedLocales","content":"import { locales } from '@wix/multilingual';\n\nasync function listSupportedLocales(options) {\n const response = await locales.listSupportedLocales(options);\n};"},{"title":"listSupportedLocales (with elevated permissions)","content":"import { locales } from '@wix/multilingual';\nimport { auth } from '@wix/essentials';\n\nasync function myListSupportedLocalesMethod(options) {\n const elevatedListSupportedLocales = auth.elevate(locales.listSupportedLocales);\n const response = await elevatedListSupportedLocales(options);\n}"},{"title":"listSupportedLocales (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { locales } from '@wix/multilingual';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { locales },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function listSupportedLocales(options) {\n const response = await myWixClient.locales.listSupportedLocales(options);\n};"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListSupportedLocalesOptions","referenceFqn":"ListSupportedLocalesOptions"}}],"description":"Retrieves a list of all Wix-supported locales that can be added to a site.\n\nCall this method to display supported language details when creating or updating a locale.","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Wix Multilingual","scopeId":"SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"}],"isAdminMethod":true},{"name":"queryLocales","fqn":"queryLocales","fullFqn":"wix.multilingual.locales.v2.LocalesService.QueryLocales","slug":"query-locales","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","permissionIds":["WIX_MULTILINGUAL.LOCALE_READ"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},"examples":[{"title":"queryLocales","content":"import { locales } from '@wix/multilingual';\n\nasync function queryLocales() {\n const { items } = await locales.queryLocales().find();\n};"},{"title":"queryLocales (with elevated permissions)","content":"import { locales } from '@wix/multilingual';\nimport { auth } from '@wix/essentials';\n\nasync function myQueryLocalesMethod(options) {\n const elevatedQueryLocales = auth.elevate(locales.queryLocales);\n const response = await elevatedQueryLocales(options);\n}"},{"title":"queryLocales (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { locales } from '@wix/multilingual';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { locales },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function queryLocales() {\n const { items } = await myWixClient.locales.queryLocales().find();\n};"}],"description":"Retrieves a list of the site's locales, given the provided paging, filtering, and sorting. Up to 200 locales can be returned per request.\n\nThe default `sort` is `locale.id` in `ASC`.\n\nFor a detailed list of supported operations, see \"Locale: Supported Filters and Sorting\" ([REST](https://dev.wix.com/docs/rest/business-management/multilingual/locales/locale/sort-and-filter) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-schema/query-schemas)).\nTo learn how to query projects, see API Query Language ([REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) | [SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language)).\n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`_id`|[`eq()`](/locales-query-builder/eq),[`ne()`](/locales-query-builder/ne),[`exists()`](/locales-query-builder/exists),[`in()`](/locales-query-builder/in),[`hasSome()`](/locales-query-builder/has-some),[`startsWith()`](/locales-query-builder/starts-with),[`gt()`](/locales-query-builder/gt),[`lt()`](/locales-query-builder/lt),[`le()`](/locales-query-builder/le),[`ge()`](/locales-query-builder/ge),[`ascending()`](/locales-query-builder/ascending),[`descending()`](/locales-query-builder/descending)|\n|`languageCode`|[`eq()`](/locales-query-builder/eq),[`ne()`](/locales-query-builder/ne),[`exists()`](/locales-query-builder/exists),[`in()`](/locales-query-builder/in),[`hasSome()`](/locales-query-builder/has-some),[`startsWith()`](/locales-query-builder/starts-with),[`gt()`](/locales-query-builder/gt),[`lt()`](/locales-query-builder/lt),[`le()`](/locales-query-builder/le),[`ge()`](/locales-query-builder/ge),[`ascending()`](/locales-query-builder/ascending),[`descending()`](/locales-query-builder/descending)|\n|`regionCode`|[`eq()`](/locales-query-builder/eq),[`ne()`](/locales-query-builder/ne),[`exists()`](/locales-query-builder/exists),[`in()`](/locales-query-builder/in),[`hasSome()`](/locales-query-builder/has-some),[`startsWith()`](/locales-query-builder/starts-with),[`gt()`](/locales-query-builder/gt),[`lt()`](/locales-query-builder/lt),[`le()`](/locales-query-builder/le),[`ge()`](/locales-query-builder/ge),[`ascending()`](/locales-query-builder/ascending),[`descending()`](/locales-query-builder/descending)|\n|`visibility`|[`eq()`](/locales-query-builder/eq),[`ne()`](/locales-query-builder/ne),[`exists()`](/locales-query-builder/exists),[`in()`](/locales-query-builder/in),[`hasSome()`](/locales-query-builder/has-some),[`ascending()`](/locales-query-builder/ascending),[`descending()`](/locales-query-builder/descending)|\n|`primaryLocale`|[`eq()`](/locales-query-builder/eq),[`ne()`](/locales-query-builder/ne),[`exists()`](/locales-query-builder/exists),[`in()`](/locales-query-builder/in),[`hasSome()`](/locales-query-builder/has-some),[`ascending()`](/locales-query-builder/ascending),[`descending()`](/locales-query-builder/descending)|\n|`flag`|[`eq()`](/locales-query-builder/eq),[`ne()`](/locales-query-builder/ne),[`exists()`](/locales-query-builder/exists),[`in()`](/locales-query-builder/in),[`hasSome()`](/locales-query-builder/has-some),[`startsWith()`](/locales-query-builder/starts-with),[`gt()`](/locales-query-builder/gt),[`lt()`](/locales-query-builder/lt),[`le()`](/locales-query-builder/le),[`ge()`](/locales-query-builder/ge),[`ascending()`](/locales-query-builder/ascending),[`descending()`](/locales-query-builder/descending)|\n|`regionalFormat`|[`eq()`](/locales-query-builder/eq),[`ne()`](/locales-query-builder/ne),[`exists()`](/locales-query-builder/exists),[`in()`](/locales-query-builder/in),[`hasSome()`](/locales-query-builder/has-some),[`startsWith()`](/locales-query-builder/starts-with),[`gt()`](/locales-query-builder/gt),[`lt()`](/locales-query-builder/lt),[`le()`](/locales-query-builder/le),[`ge()`](/locales-query-builder/ge),[`ascending()`](/locales-query-builder/ascending),[`descending()`](/locales-query-builder/descending)|\n|`effectiveUrlStructure`|[`eq()`](/locales-query-builder/eq),[`ne()`](/locales-query-builder/ne),[`exists()`](/locales-query-builder/exists),[`in()`](/locales-query-builder/in),[`hasSome()`](/locales-query-builder/has-some),[`ascending()`](/locales-query-builder/ascending),[`descending()`](/locales-query-builder/descending)|","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Wix Multilingual","scopeId":"SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"}],"isAdminMethod":true},{"name":"updateLocale","fqn":"updateLocale","fullFqn":"wix.multilingual.locales.v2.LocalesService.UpdateLocale","slug":"update-locale","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["_id","locale","locale.revision"],"permissionIds":["WIX_MULTILINGUAL.LOCALE_UPDATE"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"V2Locale","referenceFqn":"V2Locale"},"description":"The updated locale."},"examples":[{"title":"updateLocale","content":"import { locales } from '@wix/multilingual';\n\nasync function updateLocale(id, locale) {\n const response = await locales.updateLocale(id, locale);\n};"},{"title":"updateLocale (with elevated permissions)","content":"import { locales } from '@wix/multilingual';\nimport { auth } from '@wix/essentials';\n\nasync function myUpdateLocaleMethod(id, locale) {\n const elevatedUpdateLocale = auth.elevate(locales.updateLocale);\n const response = await elevatedUpdateLocale(id, locale);\n}"},{"title":"updateLocale (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { locales } from '@wix/multilingual';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { locales },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function updateLocale(id, locale) {\n const response = await myWixClient.locales.updateLocale(id, locale);\n};"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Locale ID. The ID is made up of the language and region codes supported by Wix. For example, `\"en-US\"`."},{"name":"locale","slug":"locale","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateLocale","referenceFqn":"UpdateLocale"}}],"description":"Updates a locale by ID.","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Wix Multilingual","scopeId":"SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"}],"isAdminMethod":true}],"webhooks":[{"name":"onLocaleCreated","fqn":"onLocaleCreated","eventSlug":"created","slug":"on-locale-created","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnLocaleCreatedHandler","referenceFqn":"OnLocaleCreatedHandler","isFunction":true}}],"isDeveloperPreview":true,"maturity":"GA","description":"Triggered when a secondary locale is created.","examples":[{"title":"onLocaleCreated","content":"import { locales } from '@wix/multilingual';\n\nlocales.onLocaleCreated((event) => {\n // handle your event here\n});"},{"title":"onLocaleCreated (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { locales } from '@wix/multilingual';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n locales,\n },\n});\n\nwixClient.locales.onLocaleCreated((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["WIX_MULTILINGUAL.LOCALE_DOMAIN_EVENTS_READ"],"permissions":["Wix Multilingual"],"permissionsScopesIds":["SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"],"eventType":"wix.multilingual.locales.v2.locale_created","permissionScopes":[{"name":"Wix Multilingual","scopeId":"SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"}]},{"name":"onLocaleDeleted","fqn":"onLocaleDeleted","eventSlug":"deleted","slug":"on-locale-deleted","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnLocaleDeletedHandler","referenceFqn":"OnLocaleDeletedHandler","isFunction":true}}],"isDeveloperPreview":true,"maturity":"GA","description":"Triggered when a locale is deleted.","examples":[{"title":"onLocaleDeleted","content":"import { locales } from '@wix/multilingual';\n\nlocales.onLocaleDeleted((event) => {\n // handle your event here\n});"},{"title":"onLocaleDeleted (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { locales } from '@wix/multilingual';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n locales,\n },\n});\n\nwixClient.locales.onLocaleDeleted((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["WIX_MULTILINGUAL.LOCALE_DOMAIN_EVENTS_READ"],"permissions":["Wix Multilingual"],"permissionsScopesIds":["SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"],"eventType":"wix.multilingual.locales.v2.locale_deleted","permissionScopes":[{"name":"Wix Multilingual","scopeId":"SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"}]},{"name":"onLocaleMultilingualPrimaryLocaleChanged","fqn":"onLocaleMultilingualPrimaryLocaleChanged","eventSlug":"multilingual_primary_locale_changed","slug":"on-locale-multilingual-primary-locale-changed","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnLocaleMultilingualPrimaryLocaleChangedHandler","referenceFqn":"OnLocaleMultilingualPrimaryLocaleChangedHandler","isFunction":true}}],"isDeveloperPreview":true,"maturity":"GA","description":"Triggered when a new primary locale is created.","examples":[{"title":"onLocaleMultilingualPrimaryLocaleChanged","content":"import { locales } from '@wix/multilingual';\n\nlocales.onLocaleMultilingualPrimaryLocaleChanged((event) => {\n // handle your event here\n});"},{"title":"onLocaleMultilingualPrimaryLocaleChanged (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { locales } from '@wix/multilingual';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n locales,\n },\n});\n\nwixClient.locales.onLocaleMultilingualPrimaryLocaleChanged((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["WIX_MULTILINGUAL.LOCALE_DOMAIN_EVENTS_READ"],"permissions":["Wix Multilingual"],"permissionsScopesIds":["SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"],"eventType":"wix.multilingual.locales.v2.locale_multilingual_primary_locale_changed","permissionScopes":[{"name":"Wix Multilingual","scopeId":"SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"}]},{"name":"onLocaleUpdated","fqn":"onLocaleUpdated","eventSlug":"updated","slug":"on-locale-updated","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnLocaleUpdatedHandler","referenceFqn":"OnLocaleUpdatedHandler","isFunction":true}}],"isDeveloperPreview":true,"maturity":"GA","description":"Triggered when a locale is updated.","examples":[{"title":"onLocaleUpdated","content":"import { locales } from '@wix/multilingual';\n\nlocales.onLocaleUpdated((event) => {\n // handle your event here\n});"},{"title":"onLocaleUpdated (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { locales } from '@wix/multilingual';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n locales,\n },\n});\n\nwixClient.locales.onLocaleUpdated((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["WIX_MULTILINGUAL.LOCALE_DOMAIN_EVENTS_READ"],"permissions":["Wix Multilingual"],"permissionsScopesIds":["SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"],"eventType":"wix.multilingual.locales.v2.locale_updated","permissionScopes":[{"name":"Wix Multilingual","scopeId":"SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS"}]}],"articles":[{"content":"# About the Locales API\n\nThe Multilingual Locales API allows you to manage a site's locales. By supporting multiple locales, a site can cater to different languages and regions, helping Wix users reach a global audience.\n\nWith the Locales API, you can:\n\n- Create, update, and delete locales for a site.\n- Retrieve and query locales.\n- Change a site's primary locale. \n- Retrieve a list of locales supported by Wix.\n\nTo retrieve or update a site's locale settings, or enable multilingual mode, refer to the [Locale Settings API](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locales/introduction). \n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n- The Wix user must install the [Wix Multilingual app](https://www.wix.com/app-market/wix-multilingual?searchLocation=home) on their site. \n- Create, update and delete methods can only be called on sites where [multilingual mode](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locale-settings/set-multilingual-mode) is enabled. \n- You can't change a primary locale to a secondary locale that already exists on a site. You must first delete the secondary locale and then call Create New Primary Locale. \n- A site can have up to 200 locales and up to 100 visible locales.\n\n## Use cases\n\n- [Implement a custom language switcher](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locales/sample-flows#implement-a-custom-language-switcher).\n- [Change the primary locale of a site](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locales/sample-flows#change-primary-locale).\n\n## Terminology\n\n- **Locale**: A combination of the language and optional region code that defines how content should be displayed for a specific audience.\n- **Primary locale**: The locale in which the site is created, serving as the default language and regional settings. This locale serves as the base for translating to other locales. \n- **Secondary locale**: A locale on your site that is used to display translated content or localized versions on the site based on visitor preferences. \n- **Visibility**: The status of a locale. \n - **Visible**: Visible locales are visible to site visitors, meaning visitors can view the site in that locale. \n - **Hidden**: Hidden locales can't be accessed by site visitors, but are available to Wix users for translating content in that locale. \n\n\n","displayName":"Introduction","slugifyName":"introduction"},{"content":"@package_metadata:@wix/multilingual\n\nTo use the Locales API, install the `@wix/multilingual` package.\n\n#### Install the package\n\nFollow the installation instructions for your development environment.\n\n| Development environment | Installation method |\n|--|--|\n| Wix sites (editor or IDE) | Use the [package manager](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |\n| Wix sites (local IDE) | Run `wix install @wix/multilingual` using the [Wix CLI](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|\n| Blocks apps | Use the same installation method as Wix sites. |\n| CLI and self-hosted apps | Run `npm install @wix/multilingual` or `yarn add @wix/multilingual`. |\n| Headless sites and apps | Run `npm install @wix/multilingual` or `yarn add @wix/multilingual`. |\n\n#### Import the package\n\nTo import the package in your code:\n\n```js\nimport { locales } from '@wix/multilingual'\n```\n ","displayName":"Setup","slugifyName":"setup"},{"content":"# Locale API: Errors\n\nThis table outlines errors that might be issued when calling the Locale API. The list includes error codes,\nand troubleshooting guidance to help you resolve these issues.\n\n|

HTTP STATUS

ERROR NAME

RULE NAME

DESCRIPTION & TROUBLESHOOTING

|\n| :----------------------------------------- | :---------------------------------------- | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------- |\n| `BAD_REQUEST (400)` | `InvalidArgumentException` | `MaxLocaleCountRule` | Exceeded 200 locale per site limit. Delete unused locales. |\n| `BAD_REQUEST (400)` | `InvalidArgumentException` | `MaxVisibleLocaleCountRule` | A site can only have up to 100 visible locales. Hide or remove locales. |\n| `BAD_REQUEST (400)` | `InvalidArgumentException` | `MultilingualModeMustBeEnabledRule` | Multilingual mode must be enabled. Enable multilingual mode in site settings. |\n| `BAD_REQUEST (400)` | `InvalidArgumentException` | `NoPrimaryLocaleRule` | A site can only have one primary locale. Remove primary locale flag from additional locales. |\n| `BAD_REQUEST (400)` | `InvalidArgumentException` | `NoVisitorPrimaryLocaleRule` | A site can only have one visitor primary locale. Remove visitor primary locale flag from additional locales. |\n| `BAD_REQUEST (400)` | `InvalidArgumentException` | `ValidFlagCodeRule` | Unrecognized flag code. Use a valid country code for the flag. |\n| `BAD_REQUEST (400)` | `InvalidArgumentException` | `ValidLanguageAndRegionRule` | Unrecognized language and region combination. Use a valid language-region code combination. |\n| `BAD_REQUEST (400)` | `InvalidArgumentException` | `ValidMachineTranslationCode` | Unsupported machine translation code. Use a supported machine translation language code. |\n| `BAD_REQUEST (400)` | `InvalidArgumentException` | `VisitorPrimaryLocaleMustBeVisibleRule` | The visibility status of a locale with `visitorPrimaryLocal` set to `true` must be `VISIBLE`. Update the `visibility` field to VISIBLE for the visitor primary locale. |\n| `BAD_REQUEST (400)` | `InvalidArgumentException` | `PrimaryLocaleIsVisitorPrimaryLocaleRule` | The primary locale must also be set as the visitor primary locale. Ensure the primary locale's `visitorPrimaryLocale` is set to `true`. |\n| `BAD_REQUEST (400)` | `UnexpectedValueException` | | Unexpected value occurred. Check the provided value matches expected format. |\n","displayName":"Errors","slugifyName":"errors"},{"content":"# Sample Use Cases and Flows\n\nThis article presents some possible use cases you can support using the Locale API. This can be a helpful jumping off point as you plan your implementation.\n\n\n## Implement a custom language switcher\n\nYou can create a custom language switcher presented as a dropdown of available languages or regions for site visitors to select from.\n\n1. Call [Query Locales](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locales/query-locales) with `{ \"visibility\": \"VISIBLE\" }` to retrieve a list of all visible locales for the site.\n\n1. Display the retrieved locales in your custom language switcher, showing each locale's `displayName` and `flag`.\n\n1. When a site visitor selects a different language, use the locale's `id` and `effectiveUrlStructure` to construct the appropriate URL for the newly selected language version of the current page, and then redirect the visitor to that URL.\n\n## Change primary locale \n\nYou can change the site's primary locale, for example if headquarters relocates to a different country.\n\n1. Call [List Supported Locales](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locales/list-supported-locales) to see a list of all locales supported by Wix.\n\n1. Choose a locale from the list and call [Get Locale](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locales/get-locale) to ensure the locale doesn't already exist on the site as a secondary locale. \n\n If the locale already exists on the site, call [Delete Locale](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locales/delete-locale) to remove it and its data. \n\n1. Call [Create New Primary Locale](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locales/create-new-primary-locale) to create and set the new primary locale. \n\n1. Call [Get New Primary Locale Status](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locales/get-new-primary-locale-status) with the token returned from the Create New Primary Locale method and monitor the progress of the change, and continue checking the status until the it returns either `FINISH_SUCCESSFUL` or\n `FINISH_WITH_ERROR`.\n\n1. If the change is successful, update your app's UI to reflect the new primary locale. If there's an error, inform the Wix user and provide options for troubleshooting or retrying the operation.","displayName":"Sample Flows","slugifyName":"sample-flows"},{"content":"# Locale: Supported Filters and Sorting\n\nThis article covers field support for filtering and sorting in the Locale API.\n\n## Query Contents\n\nThe following table shows field support for filters and sorting for the locale object when using [Query Locales](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locales/query-locales):\n\n| Field | Supported Filters | Sortable |\n| --------------------| ------------------------------------------------------------------------------ | ---------- |\n| `id` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `languageCode` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `regionCode` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `visibility` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `primaryLocale` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `flag` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `regionalFormat` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `effectiveUrlStructure` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |","displayName":"Sort and Filter","slugifyName":"sort-and-filter"}],"builderTypes":[{"kind":"REFERENCE","name":"LocalesQueryBuilder","referenceFqn":"LocalesQueryBuilder"},{"kind":"REFERENCE","name":"LocalesQueryResult","referenceFqn":"LocalesQueryResult"}],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.0","gitCommitHash":""},"resourceMetadata":{"lastModifiedBy":"","sourcePath":"","yamlPath":"","name":"Locales","yamlTitle":"Locales 1 0 0","kind":"PUBLIC_SDK","fqdn":"wix.multilingual.locales.v2.locale"}}