phrase 4.27.0 → 4.29.0

data/lib/phrase/api/supported_languages_api.rb

@@ -0,0 +1,67 @@
+require 'cgi'
+
+module Phrase
+  class SupportedLanguagesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List supported languages
+    # Returns all languages/locale codes that Phrase Strings recognizes, mapped to their human-readable display name. This endpoint does not require authentication. 
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, String>]
+    def languages_list(opts = {})
+      data, _status_code, _headers = languages_list_with_http_info(opts)
+      data
+    end
+
+    # List supported languages
+    # Returns all languages/locale codes that Phrase Strings recognizes, mapped to their human-readable display name. This endpoint does not require authentication. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Response<(Hash<String, String>)>, Integer, Hash)>] Response<(Hash<String, String>)> data, response status code and response headers
+    def languages_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SupportedLanguagesApi.languages_list ...'
+      end
+      # resource path
+      local_var_path = '/languages'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Hash<String, String>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SupportedLanguagesApi#languages_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+  end
+end

data/lib/phrase/models/job_template_create_parameters.rb

@@ -17,6 +17,9 @@ module Phrase
     # The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used.
     attr_accessor :source_locale_id
 
+    # Code of the account member to set as the job template owner. The referenced user must also be a member of the project; passing the code of an account member who is not a project member returns a 404. When omitted or blank, no owner is pre-set; the user who creates a job from this template is assigned as owner at job-creation time. 
+    attr_accessor :owner_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -24,7 +27,8 @@ module Phrase
         :'name' => :'name',
         :'briefing' => :'briefing',
         :'autotranslate' => :'autotranslate',
-        :'source_locale_id' => :'source_locale_id'
+        :'source_locale_id' => :'source_locale_id',
+        :'owner_id' => :'owner_id'
       }
     end
 
@@ -35,7 +39,8 @@ module Phrase
         :'name' => :'String',
         :'briefing' => :'String',
         :'autotranslate' => :'Boolean',
-        :'source_locale_id' => :'String'
+        :'source_locale_id' => :'String',
+        :'owner_id' => :'String'
       }
     end
 
@@ -79,6 +84,10 @@ module Phrase
       if attributes.key?(:'source_locale_id')
         self.source_locale_id = attributes[:'source_locale_id']
       end
+
+      if attributes.key?(:'owner_id')
+        self.owner_id = attributes[:'owner_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -108,7 +117,8 @@ module Phrase
           name == o.name &&
           briefing == o.briefing &&
           autotranslate == o.autotranslate &&
-          source_locale_id == o.source_locale_id
+          source_locale_id == o.source_locale_id &&
+          owner_id == o.owner_id
     end
 
     # @see the `==` method
@@ -120,7 +130,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, name, briefing, autotranslate, source_locale_id].hash
+      [branch, name, briefing, autotranslate, source_locale_id, owner_id].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/job_template_update_parameters.rb

@@ -17,6 +17,9 @@ module Phrase
     # The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used.
     attr_accessor :source_locale_id
 
+    # Code of the account member to set as the job template owner. The referenced user must also be a member of the project; passing the code of an account member who is not a project member returns a 404. Pass an empty string to clear a previously set owner; when blank, jobs created from this template will default to assigning the job creator as owner. 
+    attr_accessor :owner_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -24,7 +27,8 @@ module Phrase
         :'name' => :'name',
         :'briefing' => :'briefing',
         :'autotranslate' => :'autotranslate',
-        :'source_locale_id' => :'source_locale_id'
+        :'source_locale_id' => :'source_locale_id',
+        :'owner_id' => :'owner_id'
       }
     end
 
@@ -35,7 +39,8 @@ module Phrase
         :'name' => :'String',
         :'briefing' => :'String',
         :'autotranslate' => :'Boolean',
-        :'source_locale_id' => :'String'
+        :'source_locale_id' => :'String',
+        :'owner_id' => :'String'
       }
     end
 
@@ -79,6 +84,10 @@ module Phrase
       if attributes.key?(:'source_locale_id')
         self.source_locale_id = attributes[:'source_locale_id']
       end
+
+      if attributes.key?(:'owner_id')
+        self.owner_id = attributes[:'owner_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -108,7 +117,8 @@ module Phrase
           name == o.name &&
           briefing == o.briefing &&
           autotranslate == o.autotranslate &&
-          source_locale_id == o.source_locale_id
+          source_locale_id == o.source_locale_id &&
+          owner_id == o.owner_id
     end
 
     # @see the `==` method
@@ -120,7 +130,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, name, briefing, autotranslate, source_locale_id].hash
+      [branch, name, briefing, autotranslate, source_locale_id, owner_id].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/machine_translation_settings_update_parameters.rb

@@ -2,7 +2,7 @@ require 'date'
 
 module Phrase
   class MachineTranslationSettingsUpdateParameters
-    # The machine translation engine to use as the account default. Supported values: language_ai_translate, aita_translate, microsoft_translate, google_translate, amazon_translate, intento_translate, gpt_translate. Pass null or an empty string to reset to the plan default. 
+    # The machine translation engine to use as the account default. Supported values: language_ai_translate, aita_translate, microsoft_translate, google_translate, amazon_translate. Pass null or an empty string to reset to the plan default. 
     attr_accessor :default_service
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/phrase/models/member_update_parameters.rb

@@ -11,10 +11,10 @@ module Phrase
     # List of project ids the user has access to. 
     attr_accessor :project_ids
 
-    # List of locale ids the user has access to.
+    # List of locale ids the user has access to. This is project-scoped and must be paired with `project_ids` (and `strategy`) to take effect; it does not grant account-wide language access.
     attr_accessor :locale_ids
 
-    # List of default locales for the user.
+    # List of default locales for the user, applied across all of the user's projects. This is the account-level field corresponding to \"Language access\" in the translator profile UI.
     attr_accessor :default_locale_codes
 
     # List of spaces the user is assigned to.

data/lib/phrase/models/organization_job_template_create_parameters.rb

@@ -11,12 +11,16 @@ module Phrase
     # Automatically translate the job using machine translation.
     attr_accessor :autotranslate
 
+    # 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'briefing' => :'briefing',
-        :'autotranslate' => :'autotranslate'
+        :'autotranslate' => :'autotranslate',
+        :'owner_id' => :'owner_id'
       }
     end
 
@@ -25,7 +29,8 @@ module Phrase
       {
         :'name' => :'String',
         :'briefing' => :'String',
-        :'autotranslate' => :'Boolean'
+        :'autotranslate' => :'Boolean',
+        :'owner_id' => :'String'
       }
     end
 
@@ -61,6 +66,10 @@ module Phrase
       if attributes.key?(:'autotranslate')
         self.autotranslate = attributes[:'autotranslate']
       end
+
+      if attributes.key?(:'owner_id')
+        self.owner_id = attributes[:'owner_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -88,7 +97,8 @@ module Phrase
       self.class == o.class &&
           name == o.name &&
           briefing == o.briefing &&
-          autotranslate == o.autotranslate
+          autotranslate == o.autotranslate &&
+          owner_id == o.owner_id
     end
 
     # @see the `==` method
@@ -100,7 +110,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, briefing, autotranslate].hash
+      [name, briefing, autotranslate, owner_id].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/organization_job_template_update_parameters.rb

@@ -11,12 +11,16 @@ module Phrase
     # Automatically translate the job using machine translation.
     attr_accessor :autotranslate
 
+    # 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'briefing' => :'briefing',
-        :'autotranslate' => :'autotranslate'
+        :'autotranslate' => :'autotranslate',
+        :'owner_id' => :'owner_id'
       }
     end
 
@@ -25,7 +29,8 @@ module Phrase
       {
         :'name' => :'String',
         :'briefing' => :'String',
-        :'autotranslate' => :'Boolean'
+        :'autotranslate' => :'Boolean',
+        :'owner_id' => :'String'
       }
     end
 
@@ -61,6 +66,10 @@ module Phrase
       if attributes.key?(:'autotranslate')
         self.autotranslate = attributes[:'autotranslate']
       end
+
+      if attributes.key?(:'owner_id')
+        self.owner_id = attributes[:'owner_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -88,7 +97,8 @@ module Phrase
       self.class == o.class &&
           name == o.name &&
           briefing == o.briefing &&
-          autotranslate == o.autotranslate
+          autotranslate == o.autotranslate &&
+          owner_id == o.owner_id
     end
 
     # @see the `==` method
@@ -100,7 +110,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, briefing, autotranslate].hash
+      [name, briefing, autotranslate, owner_id].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/project_create_parameters.rb

@@ -104,7 +104,7 @@ module Phrase
     # (Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the [`file_encoding`](/en/api/strings/uploads/upload-a-new-file) parameter for Uploads.
     attr_accessor :default_encoding
 
-    # (Optional) CLDR plural-rule version used by the project.
+    # (Optional) CLDR plural-rule version used by the project. Pass `legacy` for pre-CLDR pluralization behaviour, or a CLDR version string such as `cldr48`. Also used as the default version for the ICU skeleton endpoint (`POST /icu/skeleton`) when its own `cldr_version` parameter is omitted.
     attr_accessor :cldr_version
 
     # (Optional) List of placeholder styles enabled for the project.
@@ -403,11 +403,23 @@ module Phrase
     # @return true if the model is valid
     def valid?
       return false if @name.nil?
+      translation_keys_sort_collation_validator = EnumAttributeValidator.new('String', ["general_ci", "unicode_ci"])
+      return false unless translation_keys_sort_collation_validator.valid?(@translation_keys_sort_collation)
       default_encoding_validator = EnumAttributeValidator.new('String', ["UTF-8", "UTF-16", "UTF-16BE", "UTF-16LE", "ISO-8859-1"])
       return false unless default_encoding_validator.valid?(@default_encoding)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] translation_keys_sort_collation Object to be assigned
+    def translation_keys_sort_collation=(translation_keys_sort_collation)
+      validator = EnumAttributeValidator.new('String', ["general_ci", "unicode_ci"])
+      unless validator.valid?(translation_keys_sort_collation)
+        fail ArgumentError, "invalid value for \"translation_keys_sort_collation\", must be one of #{validator.allowable_values}."
+      end
+      @translation_keys_sort_collation = translation_keys_sort_collation
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] default_encoding Object to be assigned
     def default_encoding=(default_encoding)

data/lib/phrase/models/project_details.rb

@@ -62,12 +62,36 @@ module Phrase
 
     attr_accessor :cldr_version
 
+    attr_accessor :translation_keys_sort_collation
+
     attr_accessor :job_locking_enabled
 
     attr_accessor :placeholder_styles
 
     attr_accessor :branch
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -101,6 +125,7 @@ module Phrase
         :'autocomplete_job_enabled' => :'autocomplete_job_enabled',
         :'default_encoding' => :'default_encoding',
         :'cldr_version' => :'cldr_version',
+        :'translation_keys_sort_collation' => :'translation_keys_sort_collation',
         :'job_locking_enabled' => :'job_locking_enabled',
         :'placeholder_styles' => :'placeholder_styles',
         :'branch' => :'branch'
@@ -140,6 +165,7 @@ module Phrase
         :'autocomplete_job_enabled' => :'Boolean',
         :'default_encoding' => :'String',
         :'cldr_version' => :'String',
+        :'translation_keys_sort_collation' => :'String',
         :'job_locking_enabled' => :'Boolean',
         :'placeholder_styles' => :'Array<String>',
         :'branch' => :'Branch'
@@ -294,6 +320,10 @@ module Phrase
         self.cldr_version = attributes[:'cldr_version']
       end
 
+      if attributes.key?(:'translation_keys_sort_collation')
+        self.translation_keys_sort_collation = attributes[:'translation_keys_sort_collation']
+      end
+
       if attributes.key?(:'job_locking_enabled')
         self.job_locking_enabled = attributes[:'job_locking_enabled']
       end
@@ -319,9 +349,21 @@ module Phrase
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      translation_keys_sort_collation_validator = EnumAttributeValidator.new('String', ["general_ci", "unicode_ci"])
+      return false unless translation_keys_sort_collation_validator.valid?(@translation_keys_sort_collation)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] translation_keys_sort_collation Object to be assigned
+    def translation_keys_sort_collation=(translation_keys_sort_collation)
+      validator = EnumAttributeValidator.new('String', ["general_ci", "unicode_ci"])
+      unless validator.valid?(translation_keys_sort_collation)
+        fail ArgumentError, "invalid value for \"translation_keys_sort_collation\", must be one of #{validator.allowable_values}."
+      end
+      @translation_keys_sort_collation = translation_keys_sort_collation
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -357,6 +399,7 @@ module Phrase
           autocomplete_job_enabled == o.autocomplete_job_enabled &&
           default_encoding == o.default_encoding &&
           cldr_version == o.cldr_version &&
+          translation_keys_sort_collation == o.translation_keys_sort_collation &&
           job_locking_enabled == o.job_locking_enabled &&
           placeholder_styles == o.placeholder_styles &&
           branch == o.branch
@@ -371,7 +414,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, slug, main_format, project_image_url, media, account, space, point_of_contact, created_at, updated_at, shares_translation_memory, machine_translation_enabled, zero_plural_form_enabled, enable_all_data_type_translation_keys_for_translators, enable_icu_message_format, enable_branching, protect_master_branch, autotranslate_enabled, autotranslate_check_new_translation_keys, autotranslate_check_new_uploads, autotranslate_check_new_locales, autotranslate_mark_as_unverified, autotranslate_use_machine_translation, autotranslate_use_translation_memory, autotranslate_overwrite_unverified_translations, fallback_for_unverified_translations, autocomplete_job_enabled, default_encoding, cldr_version, job_locking_enabled, placeholder_styles, branch].hash
+      [id, name, slug, main_format, project_image_url, media, account, space, point_of_contact, created_at, updated_at, shares_translation_memory, machine_translation_enabled, zero_plural_form_enabled, enable_all_data_type_translation_keys_for_translators, enable_icu_message_format, enable_branching, protect_master_branch, autotranslate_enabled, autotranslate_check_new_translation_keys, autotranslate_check_new_uploads, autotranslate_check_new_locales, autotranslate_mark_as_unverified, autotranslate_use_machine_translation, autotranslate_use_translation_memory, autotranslate_overwrite_unverified_translations, fallback_for_unverified_translations, autocomplete_job_enabled, default_encoding, cldr_version, translation_keys_sort_collation, job_locking_enabled, placeholder_styles, branch].hash
     end
 
     # Builds the object from hash