Deploying from phrase/strings-openapi@9266c680

Author: Phrase

api/openapi.yaml

@@ -4465,17 +4465,29 @@ paths:
         schema:
           type: boolean
         style: form
-      - description: If a key has no translation in the locale being downloaded the
-          translation in the fallback locale will be used. Provide the ID of the locale
-          that should be used as the fallback. Requires include_empty_translations
-          to be set to `true`.
+      - description: |
+          If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used.
+          Provide the ID of the locale that should be used as the fallback.
+          Requires `include_empty_translations` to be set to `true`. Mutually exclusive with `use_locale_fallback`.
         explode: true
         in: query
         name: fallback_locale_id
         required: false
         schema:
           type: string
         style: form
+      - description: |
+          If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used.
+          Fallback locale is defined in [locale's settings](/en/api/strings/locales/update-a-locale#body-fallback-locale-id).
+          Requires `include_empty_translations` to be set to `true`. Mutually exclusive with `fallback_locale_id`.
+        example: true
+        explode: true
+        in: query
+        name: use_locale_fallback
+        required: false
+        schema:
+          type: boolean
+        style: form
       - description: Provides the source language of a corresponding job as the source
           language of the generated locale file. This parameter will be ignored unless
           used in combination with a `tag` parameter indicating a specific job.
@@ -32320,12 +32332,19 @@ components:
             type: string
           type: array
         fallback_locale_id:
-          description: If a key has no translation in the locale being downloaded
-            the translation in the fallback locale will be used. Provide the ID of
-            the locale that should be used as the fallback. Requires include_empty_translations
-            to be set to `true`.
+          description: |
+            If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used.
+            Provide the ID of the locale that should be used as the fallback.
+            Requires `include_empty_translations` to be set to `true`. Mutually exclusive with `use_locale_fallback`.
           example: abcd1234abcd1234abcd1234abcd1234
           type: string
+        use_locale_fallback:
+          description: |
+            If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used.
+            Fallback locale is defined in [locale's settings](/en/api/strings/locales/update-a-locale#body-fallback-locale-id).
+            Requires `include_empty_translations` to be set to `true`. Mutually exclusive with `fallback_locale_id`.
+          example: false
+          type: boolean
         source_locale_id:
           description: Provides the source language of a corresponding job as the
             source language of the generated locale file. This parameter will be ignored

api_locales.go

@@ -353,6 +353,7 @@ type LocaleDownloadOpts struct {
 	IncludeUnverifiedTranslations optional.Bool      `json:"include_unverified_translations,omitempty"`
 	UseLastReviewedVersion        optional.Bool      `json:"use_last_reviewed_version,omitempty"`
 	FallbackLocaleId              optional.String    `json:"fallback_locale_id,omitempty"`
+	UseLocaleFallback             optional.Bool      `json:"use_locale_fallback,omitempty"`
 	SourceLocaleId                optional.String    `json:"source_locale_id,omitempty"`
 	TranslationKeyPrefix          optional.String    `json:"translation_key_prefix,omitempty"`
 	FilterByPrefix                optional.Bool      `json:"filter_by_prefix,omitempty"`
@@ -385,7 +386,8 @@ Download a locale in a specific file format.
   - @param "SkipUnverifiedTranslations" (optional.Bool) -  Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with `include_unverified_translations`.
   - @param "IncludeUnverifiedTranslations" (optional.Bool) -  if set to false unverified translations are excluded
   - @param "UseLastReviewedVersion" (optional.Bool) -  If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.
-  - @param "FallbackLocaleId" (optional.String) -  If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to `true`.
+  - @param "FallbackLocaleId" (optional.String) -  If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires `include_empty_translations` to be set to `true`. Mutually exclusive with `use_locale_fallback`.
+  - @param "UseLocaleFallback" (optional.Bool) -  If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Fallback locale is defined in [locale's settings](/en/api/strings/locales/update-a-locale#body-fallback-locale-id). Requires `include_empty_translations` to be set to `true`. Mutually exclusive with `fallback_locale_id`.
   - @param "SourceLocaleId" (optional.String) -  Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a `tag` parameter indicating a specific job.
   - @param "TranslationKeyPrefix" (optional.String) -  Download all translation keys, and remove the specified prefix where possible. Warning: this may create duplicate key names if other keys share the same name after the prefix is removed.
   - @param "FilterByPrefix" (optional.Bool) -  Only download translation keys containing the specified prefix, and remove the prefix from the generated file.
@@ -462,6 +464,9 @@ func (a *LocalesApiService) LocaleDownload(ctx _context.Context, projectId strin
 	if localVarOptionals != nil && localVarOptionals.FallbackLocaleId.IsSet() {
 		localVarQueryParams.Add("fallback_locale_id", parameterToString(localVarOptionals.FallbackLocaleId.Value(), ""))
 	}
+	if localVarOptionals != nil && localVarOptionals.UseLocaleFallback.IsSet() {
+		localVarQueryParams.Add("use_locale_fallback", parameterToString(localVarOptionals.UseLocaleFallback.Value(), ""))
+	}
 	if localVarOptionals != nil && localVarOptionals.SourceLocaleId.IsSet() {
 		localVarQueryParams.Add("source_locale_id", parameterToString(localVarOptionals.SourceLocaleId.Value(), ""))
 	}

docs/LocaleDownloadCreateParameters.md

@@ -16,7 +16,8 @@ Name | Type | Description | Notes
 **IncludeUnverifiedTranslations** | **bool** | if set to false unverified translations are excluded | [optional] 
 **UseLastReviewedVersion** | **bool** | If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. | [optional] 
 **LocaleIds** | **[]string** | Locale IDs or locale names | [optional] 
-**FallbackLocaleId** | **string** | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to `true`. | [optional] 
+**FallbackLocaleId** | **string** | If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires `include_empty_translations` to be set to `true`. Mutually exclusive with `use_locale_fallback`.  | [optional] 
+**UseLocaleFallback** | **bool** | If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Fallback locale is defined in [locale's settings](/en/api/strings/locales/update-a-locale#body-fallback-locale-id). Requires `include_empty_translations` to be set to `true`. Mutually exclusive with `fallback_locale_id`.  | [optional] 
 **SourceLocaleId** | **string** | Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a `tag` parameter indicating a specific job. | [optional] 
 **CustomMetadataFilters** | **map[string]interface{}** | Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download.  | [optional] 
 **UpdatedSince** | **string** | Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).  | [optional] 

docs/LocalesApi.md

@@ -193,7 +193,8 @@ Name | Type | Description  | Notes
 **skipUnverifiedTranslations** | **optional.Bool**| Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with `include_unverified_translations`. | 
 **includeUnverifiedTranslations** | **optional.Bool**| if set to false unverified translations are excluded | 
 **useLastReviewedVersion** | **optional.Bool**| If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. | 
-**fallbackLocaleId** | **optional.String**| If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to `true`. | 
+**fallbackLocaleId** | **optional.String**| If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires `include_empty_translations` to be set to `true`. Mutually exclusive with `use_locale_fallback`.  | 
+**useLocaleFallback** | **optional.Bool**| If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Fallback locale is defined in [locale's settings](/en/api/strings/locales/update-a-locale#body-fallback-locale-id). Requires `include_empty_translations` to be set to `true`. Mutually exclusive with `fallback_locale_id`.  | 
 **sourceLocaleId** | **optional.String**| Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a `tag` parameter indicating a specific job. | 
 **translationKeyPrefix** | **optional.String**| Download all translation keys, and remove the specified prefix where possible. Warning: this may create duplicate key names if other keys share the same name after the prefix is removed. | 
 **filterByPrefix** | **optional.Bool**| Only download translation keys containing the specified prefix, and remove the prefix from the generated file. | 

model_locale_download_create_parameters.go

@@ -26,8 +26,10 @@ type LocaleDownloadCreateParameters struct {
 	UseLastReviewedVersion *bool `json:"use_last_reviewed_version,omitempty"`
 	// Locale IDs or locale names
 	LocaleIds []string `json:"locale_ids,omitempty"`
-	// If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to `true`.
+	// If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires `include_empty_translations` to be set to `true`. Mutually exclusive with `use_locale_fallback`.
 	FallbackLocaleId string `json:"fallback_locale_id,omitempty"`
+	// If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Fallback locale is defined in [locale's settings](/en/api/strings/locales/update-a-locale#body-fallback-locale-id). Requires `include_empty_translations` to be set to `true`. Mutually exclusive with `fallback_locale_id`.
+	UseLocaleFallback *bool `json:"use_locale_fallback,omitempty"`
 	// Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a `tag` parameter indicating a specific job.
 	SourceLocaleId string `json:"source_locale_id,omitempty"`
 	// Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download.