phrase 4.31.0 → 4.33.0

data/lib/phrase/models/job_update_parameters.rb

@@ -5,7 +5,7 @@ module Phrase
     # Job name
     attr_accessor :name
 
-    # Briefing for the translators
+    # Briefing for the translators. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :briefing
 
     # Date the job should be finished
@@ -14,7 +14,7 @@ module Phrase
     # Date the review of the job should be finished. Must not be before `due_date`.
     attr_accessor :review_due_date
 
-    # URL to a ticket for this job (e.g. Jira, Trello)
+    # URL to a ticket for this job (e.g. Jira, Trello) Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :ticket_url
 
     # List of target locales for the job.
@@ -23,6 +23,9 @@ module Phrase
     # Automatically translate the job using machine translation
     attr_accessor :autotranslate
 
+    # Exclude linked child keys from the job. When set to `true`, linked child keys already in the job are removed and none can be added while the option is enabled.
+    attr_accessor :exclude_linked_child_keys
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -32,7 +35,8 @@ module Phrase
         :'review_due_date' => :'review_due_date',
         :'ticket_url' => :'ticket_url',
         :'target_locale_ids' => :'target_locale_ids',
-        :'autotranslate' => :'autotranslate'
+        :'autotranslate' => :'autotranslate',
+        :'exclude_linked_child_keys' => :'exclude_linked_child_keys'
       }
     end
 
@@ -45,14 +49,17 @@ module Phrase
         :'review_due_date' => :'DateTime',
         :'ticket_url' => :'String',
         :'target_locale_ids' => :'Array<String>',
-        :'autotranslate' => :'Boolean'
+        :'autotranslate' => :'Boolean',
+        :'exclude_linked_child_keys' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'briefing',
         :'due_date',
+        :'ticket_url',
       ])
     end
 
@@ -100,6 +107,10 @@ module Phrase
       if attributes.key?(:'autotranslate')
         self.autotranslate = attributes[:'autotranslate']
       end
+
+      if attributes.key?(:'exclude_linked_child_keys')
+        self.exclude_linked_child_keys = attributes[:'exclude_linked_child_keys']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -126,7 +137,8 @@ module Phrase
           review_due_date == o.review_due_date &&
           ticket_url == o.ticket_url &&
           target_locale_ids == o.target_locale_ids &&
-          autotranslate == o.autotranslate
+          autotranslate == o.autotranslate &&
+          exclude_linked_child_keys == o.exclude_linked_child_keys
     end
 
     # @see the `==` method
@@ -138,7 +150,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, briefing, due_date, review_due_date, ticket_url, target_locale_ids, autotranslate].hash
+      [name, briefing, due_date, review_due_date, ticket_url, target_locale_ids, autotranslate, exclude_linked_child_keys].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/key_update_parameters.rb

@@ -8,7 +8,7 @@ module Phrase
     # Key name
     attr_accessor :name
 
-    # Key description (usually includes contextual information for translators)
+    # Key description (usually includes contextual information for translators). Send an empty string or `null` to clear the description; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :description
 
     # Indicates whether key supports pluralization
@@ -17,7 +17,7 @@ module Phrase
     # Indicates whether key uses ordinal rules for pluralization
     attr_accessor :use_ordinal_rules
 
-    # Plural name for the key (used in some file formats, e.g. Gettext)
+    # Plural name for the key (used in some file formats, e.g. Gettext) Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :name_plural
 
     # Type of the key. Can be one of the following: string, number, boolean, array, markdown.
@@ -41,13 +41,13 @@ module Phrase
     # Indicates whether the key should be exported with \"xml:space=preserve\". Supported by several XML-based formats.
     attr_accessor :xml_space_preserve
 
-    # Original file attribute. Used in some formats, e.g. XLIFF.
+    # Original file attribute. Used in some formats, e.g. XLIFF. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :original_file
 
-    # NSStringLocalizedFormatKey attribute. Used in .stringsdict format.
+    # NSStringLocalizedFormatKey attribute. Used in .stringsdict format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :localized_format_string
 
-    # NSStringLocalizedFormatKey attribute. Used in .stringsdict format.
+    # NSStringLocalizedFormatKey attribute. Used in .stringsdict format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :localized_format_key
 
     # Updates/Creates custom metadata property name and value pairs to be associated with key. If you want to delete a custom metadata property, you can set its value to null. If you want to update a custom metadata property, you can set its value to the new value.
@@ -112,6 +112,11 @@ module Phrase
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'description',
+        :'name_plural',
+        :'original_file',
+        :'localized_format_string',
+        :'localized_format_key',
       ])
     end
 

data/lib/phrase/models/locale_update_parameters.rb

@@ -23,7 +23,7 @@ module Phrase
     # Source locale. Can be the name or id of the locale. Preferred is id.
     attr_accessor :source_locale_id
 
-    # Fallback locale for empty translations. Can be a locale name or id.
+    # Fallback locale for empty translations. Can be a locale name or id. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :fallback_locale_id
 
     # Indicates that new translations for this locale should be marked as unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature.
@@ -38,7 +38,7 @@ module Phrase
     # If set, translations for this locale will be fetched automatically, right after creation.
     attr_accessor :autotranslate
 
-    # Identifier of the Language AI profile to use for this locale.
+    # Identifier of the Language AI profile to use for this locale. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :language_ai_profile
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -82,6 +82,8 @@ module Phrase
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'fallback_locale_id',
+        :'language_ai_profile'
       ])
     end
 

data/lib/phrase/models/organization_job_template_create_parameters.rb

@@ -11,6 +11,9 @@ module Phrase
     # Automatically translate the job using machine translation.
     attr_accessor :autotranslate
 
+    # Exclude linked child keys from jobs created from this template. Defaults to `false`.
+    attr_accessor :exclude_linked_child_keys
+
     # Code of the account member to set as the job template owner. When omitted or blank, no owner is pre-set; the user who creates a job from this template is assigned as its owner at job-creation time. 
     attr_accessor :owner_id
 
@@ -20,6 +23,7 @@ module Phrase
         :'name' => :'name',
         :'briefing' => :'briefing',
         :'autotranslate' => :'autotranslate',
+        :'exclude_linked_child_keys' => :'exclude_linked_child_keys',
         :'owner_id' => :'owner_id'
       }
     end
@@ -30,6 +34,7 @@ module Phrase
         :'name' => :'String',
         :'briefing' => :'String',
         :'autotranslate' => :'Boolean',
+        :'exclude_linked_child_keys' => :'Boolean',
         :'owner_id' => :'String'
       }
     end
@@ -67,6 +72,10 @@ module Phrase
         self.autotranslate = attributes[:'autotranslate']
       end
 
+      if attributes.key?(:'exclude_linked_child_keys')
+        self.exclude_linked_child_keys = attributes[:'exclude_linked_child_keys']
+      end
+
       if attributes.key?(:'owner_id')
         self.owner_id = attributes[:'owner_id']
       end
@@ -98,6 +107,7 @@ module Phrase
           name == o.name &&
           briefing == o.briefing &&
           autotranslate == o.autotranslate &&
+          exclude_linked_child_keys == o.exclude_linked_child_keys &&
           owner_id == o.owner_id
     end
 
@@ -110,7 +120,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, briefing, autotranslate, owner_id].hash
+      [name, briefing, autotranslate, exclude_linked_child_keys, owner_id].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/organization_job_template_details.rb

@@ -24,6 +24,9 @@ module Phrase
 
     attr_accessor :locales
 
+    # `true` if jobs created from this template exclude linked child keys. 
+    attr_accessor :exclude_linked_child_keys
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -36,7 +39,8 @@ module Phrase
         :'updated_at' => :'updated_at',
         :'owner' => :'owner',
         :'creator' => :'creator',
-        :'locales' => :'locales'
+        :'locales' => :'locales',
+        :'exclude_linked_child_keys' => :'exclude_linked_child_keys'
       }
     end
 
@@ -52,7 +56,8 @@ module Phrase
         :'updated_at' => :'DateTime',
         :'owner' => :'UserPreview',
         :'creator' => :'UserPreview',
-        :'locales' => :'Array<LocalePreview>'
+        :'locales' => :'Array<LocalePreview>',
+        :'exclude_linked_child_keys' => :'Boolean'
       }
     end
 
@@ -126,6 +131,10 @@ module Phrase
           self.locales = value
         end
       end
+
+      if attributes.key?(:'exclude_linked_child_keys')
+        self.exclude_linked_child_keys = attributes[:'exclude_linked_child_keys']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -155,7 +164,8 @@ module Phrase
           updated_at == o.updated_at &&
           owner == o.owner &&
           creator == o.creator &&
-          locales == o.locales
+          locales == o.locales &&
+          exclude_linked_child_keys == o.exclude_linked_child_keys
     end
 
     # @see the `==` method
@@ -167,7 +177,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, briefing, autotranslate_enabled, source_locale_id, created_at, updated_at, owner, creator, locales].hash
+      [id, name, briefing, autotranslate_enabled, source_locale_id, created_at, updated_at, owner, creator, locales, exclude_linked_child_keys].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/organization_job_template_update_parameters.rb

@@ -5,12 +5,15 @@ module Phrase
     # Job template name
     attr_accessor :name
 
-    # Briefing for the translators
+    # Briefing for the translators. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :briefing
 
     # Automatically translate the job using machine translation.
     attr_accessor :autotranslate
 
+    # Exclude linked child keys from jobs created from this template.
+    attr_accessor :exclude_linked_child_keys
+
     # Code of the account member to set as the job template owner. Pass an empty string to clear a previously set owner; when blank, the owner is set to null and jobs created from this template will default to assigning the job creator as owner. 
     attr_accessor :owner_id
 
@@ -20,6 +23,7 @@ module Phrase
         :'name' => :'name',
         :'briefing' => :'briefing',
         :'autotranslate' => :'autotranslate',
+        :'exclude_linked_child_keys' => :'exclude_linked_child_keys',
         :'owner_id' => :'owner_id'
       }
     end
@@ -30,6 +34,7 @@ module Phrase
         :'name' => :'String',
         :'briefing' => :'String',
         :'autotranslate' => :'Boolean',
+        :'exclude_linked_child_keys' => :'Boolean',
         :'owner_id' => :'String'
       }
     end
@@ -37,6 +42,7 @@ module Phrase
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'briefing',
       ])
     end
 
@@ -67,6 +73,10 @@ module Phrase
         self.autotranslate = attributes[:'autotranslate']
       end
 
+      if attributes.key?(:'exclude_linked_child_keys')
+        self.exclude_linked_child_keys = attributes[:'exclude_linked_child_keys']
+      end
+
       if attributes.key?(:'owner_id')
         self.owner_id = attributes[:'owner_id']
       end
@@ -98,6 +108,7 @@ module Phrase
           name == o.name &&
           briefing == o.briefing &&
           autotranslate == o.autotranslate &&
+          exclude_linked_child_keys == o.exclude_linked_child_keys &&
           owner_id == o.owner_id
     end
 
@@ -110,7 +121,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, briefing, autotranslate, owner_id].hash
+      [name, briefing, autotranslate, exclude_linked_child_keys, owner_id].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/project_update_parameters.rb

@@ -8,7 +8,7 @@ module Phrase
     # (Optional) Name of the project
     attr_accessor :name
 
-    # (Optional) User ID of the point of contact for the project. Pass `null` to unset.
+    # (Optional) User ID of the point of contact for the project. Pass `null` or an empty string to unset. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :point_of_contact
 
     # (Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see [Format Guide](https://support.phrase.com/hc/en-us/sections/6111343326364) or our [Formats API Endpoint](#formats).
@@ -214,6 +214,7 @@ module Phrase
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'point_of_contact',
       ])
     end
 

data/lib/phrase/models/release_update_parameters.rb

@@ -2,16 +2,16 @@ require 'date'
 
 module Phrase
   class ReleaseUpdateParameters
-    # Description of the release
+    # Description of the release. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :description
 
     # List of platforms the release should support.
     attr_accessor :platforms
 
-    # Minimum version of the app that the release supports in semver format
+    # Minimum version of the app that the release supports in semver format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :app_min_version
 
-    # Maximum version of the app that the release supports in semver format
+    # Maximum version of the app that the release supports in semver format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.
     attr_accessor :app_max_version
 
     # Branch used for release
@@ -42,6 +42,9 @@ module Phrase
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'description',
+        :'app_min_version',
+        :'app_max_version',
       ])
     end
 

data/lib/phrase/models/repo_sync_event.rb

@@ -19,6 +19,9 @@ module Phrase
     # List of error messages, in case of failure
     attr_accessor :errors
 
+    # The uploads associated with this import event, or `null` if no upload batch has been created yet. Each entry identifies a single file upload by its public code (`id`) and its current public state (`state`). Present on show responses only; absent from list responses. Possible `state` values: `initialized`, `waiting_for_preview`, `processing`, `success`, `error`. 
+    attr_accessor :uploads
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -50,7 +53,8 @@ module Phrase
         :'status' => :'status',
         :'pull_request_url' => :'pull_request_url',
         :'auto_import' => :'auto_import',
-        :'errors' => :'errors'
+        :'errors' => :'errors',
+        :'uploads' => :'uploads'
       }
     end
 
@@ -63,13 +67,15 @@ module Phrase
         :'status' => :'String',
         :'pull_request_url' => :'String',
         :'auto_import' => :'Boolean',
-        :'errors' => :'Array<String>'
+        :'errors' => :'Array<String>',
+        :'uploads' => :'Array<RepoSyncEventUploadsInner>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'uploads'
       ])
     end
 
@@ -117,6 +123,12 @@ module Phrase
           self.errors = value
         end
       end
+
+      if attributes.key?(:'uploads')
+        if (value = attributes[:'uploads']).is_a?(Array)
+          self.uploads = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -167,7 +179,8 @@ module Phrase
           status == o.status &&
           pull_request_url == o.pull_request_url &&
           auto_import == o.auto_import &&
-          errors == o.errors
+          errors == o.errors &&
+          uploads == o.uploads
     end
 
     # @see the `==` method
@@ -179,7 +192,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, type, created_at, status, pull_request_url, auto_import, errors].hash
+      [id, type, created_at, status, pull_request_url, auto_import, errors, uploads].hash
     end
 
     # Builds the object from hash