phrase 4.22.0 → 4.23.0

data/lib/phrase/models/glossary_term_glossary.rb

@@ -0,0 +1,206 @@
+require 'date'
+
+module Phrase
+  # The glossary this term belongs to.
+  class GlossaryTermGlossary
+    attr_accessor :id
+
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::GlossaryTermGlossary` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::GlossaryTermGlossary`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          name == o.name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :Time
+        Time.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Phrase.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/phrase/models/icu_skeleton_parameters.rb

@@ -2,9 +2,12 @@ require 'date'
 
 module Phrase
   class IcuSkeletonParameters
-    # Source content
+    # Source content to derive skeletons from. Mutually exclusive with `id`; exactly one of the two must be provided. 
     attr_accessor :content
 
+    # Translation code to source content from. Mutually exclusive with `content`; exactly one of the two must be provided. 
+    attr_accessor :id
+
     # Locale codes
     attr_accessor :locale_codes
 
@@ -21,6 +24,7 @@ module Phrase
     def self.attribute_map
       {
         :'content' => :'content',
+        :'id' => :'id',
         :'locale_codes' => :'locale_codes',
         :'keep_content' => :'keep_content',
         :'zero_form_enabled' => :'zero_form_enabled',
@@ -32,6 +36,7 @@ module Phrase
     def self.openapi_types
       {
         :'content' => :'String',
+        :'id' => :'String',
         :'locale_codes' => :'Array<String>',
         :'keep_content' => :'Boolean',
         :'zero_form_enabled' => :'Boolean',
@@ -64,6 +69,10 @@ module Phrase
         self.content = attributes[:'content']
       end
 
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.key?(:'locale_codes')
         if (value = attributes[:'locale_codes']).is_a?(Array)
           self.locale_codes = value
@@ -102,6 +111,7 @@ module Phrase
       return true if self.equal?(o)
       self.class == o.class &&
           content == o.content &&
+          id == o.id &&
           locale_codes == o.locale_codes &&
           keep_content == o.keep_content &&
           zero_form_enabled == o.zero_form_enabled &&
@@ -117,7 +127,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content, locale_codes, keep_content, zero_form_enabled, cldr_version].hash
+      [content, id, locale_codes, keep_content, zero_form_enabled, cldr_version].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/invitation.rb

@@ -30,7 +30,8 @@ module Phrase
 
     attr_accessor :spaces
 
-    attr_accessor :project_role
+    # Per-project roles assigned to the invitee. 
+    attr_accessor :project_roles
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -49,7 +50,7 @@ module Phrase
         :'updated_at' => :'updated_at',
         :'accepted_at' => :'accepted_at',
         :'spaces' => :'spaces',
-        :'project_role' => :'project_role'
+        :'project_roles' => :'project_roles'
       }
     end
 
@@ -70,7 +71,7 @@ module Phrase
         :'updated_at' => :'DateTime',
         :'accepted_at' => :'DateTime',
         :'spaces' => :'Array<Space>',
-        :'project_role' => :'Array<MemberProjectDetailProjectRolesInner>'
+        :'project_roles' => :'Array<MemberProjectDetailProjectRolesInner>'
       }
     end
 
@@ -163,9 +164,9 @@ module Phrase
         end
       end
 
-      if attributes.key?(:'project_role')
-        if (value = attributes[:'project_role']).is_a?(Array)
-          self.project_role = value
+      if attributes.key?(:'project_roles')
+        if (value = attributes[:'project_roles']).is_a?(Array)
+          self.project_roles = value
         end
       end
     end
@@ -202,7 +203,7 @@ module Phrase
           updated_at == o.updated_at &&
           accepted_at == o.accepted_at &&
           spaces == o.spaces &&
-          project_role == o.project_role
+          project_roles == o.project_roles
     end
 
     # @see the `==` method
@@ -214,7 +215,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, email, role, state, projects, locales, teams, default_locale_codes, permissions, locale_ids, created_at, updated_at, accepted_at, spaces, project_role].hash
+      [id, email, role, state, projects, locales, teams, default_locale_codes, permissions, locale_ids, created_at, updated_at, accepted_at, spaces, project_roles].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/job.rb

@@ -22,6 +22,12 @@ module Phrase
 
     attr_accessor :updated_at
 
+    # The ID of the automation that created this job, or null if the job was created manually.
+    attr_accessor :automation_id
+
+    # The ID of the job template this job was created from, or null if no template was used.
+    attr_accessor :job_template_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -34,7 +40,9 @@ module Phrase
         :'project' => :'project',
         :'branch' => :'branch',
         :'created_at' => :'created_at',
-        :'updated_at' => :'updated_at'
+        :'updated_at' => :'updated_at',
+        :'automation_id' => :'automation_id',
+        :'job_template_id' => :'job_template_id'
       }
     end
 
@@ -50,7 +58,9 @@ module Phrase
         :'project' => :'ProjectShort',
         :'branch' => :'BranchName',
         :'created_at' => :'DateTime',
-        :'updated_at' => :'DateTime'
+        :'updated_at' => :'DateTime',
+        :'automation_id' => :'String',
+        :'job_template_id' => :'String'
       }
     end
 
@@ -58,6 +68,8 @@ module Phrase
     def self.openapi_nullable
       Set.new([
         :'due_date',
+        :'automation_id',
+        :'job_template_id'
       ])
     end
 
@@ -115,6 +127,14 @@ module Phrase
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
+
+      if attributes.key?(:'automation_id')
+        self.automation_id = attributes[:'automation_id']
+      end
+
+      if attributes.key?(:'job_template_id')
+        self.job_template_id = attributes[:'job_template_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -144,7 +164,9 @@ module Phrase
           project == o.project &&
           branch == o.branch &&
           created_at == o.created_at &&
-          updated_at == o.updated_at
+          updated_at == o.updated_at &&
+          automation_id == o.automation_id &&
+          job_template_id == o.job_template_id
     end
 
     # @see the `==` method
@@ -156,7 +178,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, briefing, due_date, state, ticket_url, project, branch, created_at, updated_at].hash
+      [id, name, briefing, due_date, state, ticket_url, project, branch, created_at, updated_at, automation_id, job_template_id].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/job_details.rb

@@ -22,6 +22,12 @@ module Phrase
 
     attr_accessor :updated_at
 
+    # The ID of the automation that created this job, or null if the job was created manually.
+    attr_accessor :automation_id
+
+    # The ID of the job template this job was created from, or null if no template was used.
+    attr_accessor :job_template_id
+
     attr_accessor :owner
 
     attr_accessor :job_tag_name
@@ -34,8 +40,12 @@ module Phrase
 
     attr_accessor :keys
 
+    # Returned only when `include_annotations=true` is supplied on the request.
     attr_accessor :annotations
 
+    # `true` if the job has been locked by the project's job-locking workflow (translations attached to the job are read-only until the job advances). 
+    attr_accessor :locked
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -49,13 +59,16 @@ module Phrase
         :'branch' => :'branch',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
+        :'automation_id' => :'automation_id',
+        :'job_template_id' => :'job_template_id',
         :'owner' => :'owner',
         :'job_tag_name' => :'job_tag_name',
         :'source_translations_updated_at' => :'source_translations_updated_at',
         :'source_locale' => :'source_locale',
         :'locales' => :'locales',
         :'keys' => :'keys',
-        :'annotations' => :'annotations'
+        :'annotations' => :'annotations',
+        :'locked' => :'locked'
       }
     end
 
@@ -72,13 +85,16 @@ module Phrase
         :'branch' => :'BranchName',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
+        :'automation_id' => :'String',
+        :'job_template_id' => :'String',
         :'owner' => :'UserPreview',
         :'job_tag_name' => :'String',
         :'source_translations_updated_at' => :'DateTime',
         :'source_locale' => :'LocalePreview',
         :'locales' => :'Array<LocalePreview>',
         :'keys' => :'Array<KeyPreview>',
-        :'annotations' => :'Array<JobAnnotationShort>'
+        :'annotations' => :'Array<JobAnnotationShort>',
+        :'locked' => :'Boolean'
       }
     end
 
@@ -86,6 +102,8 @@ module Phrase
     def self.openapi_nullable
       Set.new([
         :'due_date',
+        :'automation_id',
+        :'job_template_id',
       ])
     end
 
@@ -151,6 +169,14 @@ module Phrase
         self.updated_at = attributes[:'updated_at']
       end
 
+      if attributes.key?(:'automation_id')
+        self.automation_id = attributes[:'automation_id']
+      end
+
+      if attributes.key?(:'job_template_id')
+        self.job_template_id = attributes[:'job_template_id']
+      end
+
       if attributes.key?(:'owner')
         self.owner = attributes[:'owner']
       end
@@ -184,6 +210,10 @@ module Phrase
           self.annotations = value
         end
       end
+
+      if attributes.key?(:'locked')
+        self.locked = attributes[:'locked']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -214,13 +244,16 @@ module Phrase
           branch == o.branch &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
+          automation_id == o.automation_id &&
+          job_template_id == o.job_template_id &&
           owner == o.owner &&
           job_tag_name == o.job_tag_name &&
           source_translations_updated_at == o.source_translations_updated_at &&
           source_locale == o.source_locale &&
           locales == o.locales &&
           keys == o.keys &&
-          annotations == o.annotations
+          annotations == o.annotations &&
+          locked == o.locked
     end
 
     # @see the `==` method
@@ -232,7 +265,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, briefing, due_date, state, ticket_url, project, branch, created_at, updated_at, owner, job_tag_name, source_translations_updated_at, source_locale, locales, keys, annotations].hash
+      [id, name, briefing, due_date, state, ticket_url, project, branch, created_at, updated_at, automation_id, job_template_id, owner, job_tag_name, source_translations_updated_at, source_locale, locales, keys, annotations, locked].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/job_template.rb

@@ -12,6 +12,9 @@ module Phrase
 
     attr_accessor :branch
 
+    # When `true`, jobs created from this template are auto-translated on creation. 
+    attr_accessor :autotranslate_enabled
+
     attr_accessor :created_at
 
     attr_accessor :updated_at
@@ -24,6 +27,7 @@ module Phrase
         :'briefing' => :'briefing',
         :'project' => :'project',
         :'branch' => :'branch',
+        :'autotranslate_enabled' => :'autotranslate_enabled',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at'
       }
@@ -37,6 +41,7 @@ module Phrase
         :'briefing' => :'String',
         :'project' => :'ProjectShort',
         :'branch' => :'Branch',
+        :'autotranslate_enabled' => :'Boolean',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime'
       }
@@ -83,6 +88,10 @@ module Phrase
         self.branch = attributes[:'branch']
       end
 
+      if attributes.key?(:'autotranslate_enabled')
+        self.autotranslate_enabled = attributes[:'autotranslate_enabled']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -115,6 +124,7 @@ module Phrase
           briefing == o.briefing &&
           project == o.project &&
           branch == o.branch &&
+          autotranslate_enabled == o.autotranslate_enabled &&
           created_at == o.created_at &&
           updated_at == o.updated_at
     end
@@ -128,7 +138,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, briefing, project, branch, created_at, updated_at].hash
+      [id, name, briefing, project, branch, autotranslate_enabled, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/job_template_details.rb

@@ -12,6 +12,9 @@ module Phrase
 
     attr_accessor :branch
 
+    # When `true`, jobs created from this template are auto-translated on creation. 
+    attr_accessor :autotranslate_enabled
+
     attr_accessor :created_at
 
     attr_accessor :updated_at
@@ -30,6 +33,7 @@ module Phrase
         :'briefing' => :'briefing',
         :'project' => :'project',
         :'branch' => :'branch',
+        :'autotranslate_enabled' => :'autotranslate_enabled',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
         :'owner' => :'owner',
@@ -46,6 +50,7 @@ module Phrase
         :'briefing' => :'String',
         :'project' => :'ProjectShort',
         :'branch' => :'Branch',
+        :'autotranslate_enabled' => :'Boolean',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
         :'owner' => :'UserPreview',
@@ -102,6 +107,10 @@ module Phrase
         self.branch = attributes[:'branch']
       end
 
+      if attributes.key?(:'autotranslate_enabled')
+        self.autotranslate_enabled = attributes[:'autotranslate_enabled']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -148,6 +157,7 @@ module Phrase
           briefing == o.briefing &&
           project == o.project &&
           branch == o.branch &&
+          autotranslate_enabled == o.autotranslate_enabled &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
           owner == o.owner &&
@@ -164,7 +174,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, briefing, project, branch, created_at, updated_at, owner, creator, locales].hash
+      [id, name, briefing, project, branch, autotranslate_enabled, created_at, updated_at, owner, creator, locales].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/key_create_parameters.rb

@@ -59,6 +59,12 @@ module Phrase
     # Custom metadata property name and value pairs to be associated with key.
     attr_accessor :custom_metadata
 
+    # Locales for which translations of this key are excluded from exports. Pass an empty array to clear exclusions. 
+    attr_accessor :excluded_in_locales
+
+    # Override of the value type for the key in the export. Most useful for formats like Android XML that distinguish string vs. plural resources. 
+    attr_accessor :format_value_type
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -80,7 +86,9 @@ module Phrase
         :'original_file' => :'original_file',
         :'localized_format_string' => :'localized_format_string',
         :'localized_format_key' => :'localized_format_key',
-        :'custom_metadata' => :'custom_metadata'
+        :'custom_metadata' => :'custom_metadata',
+        :'excluded_in_locales' => :'excluded_in_locales',
+        :'format_value_type' => :'format_value_type'
       }
     end
 
@@ -105,7 +113,9 @@ module Phrase
         :'original_file' => :'String',
         :'localized_format_string' => :'String',
         :'localized_format_key' => :'String',
-        :'custom_metadata' => :'Object'
+        :'custom_metadata' => :'Object',
+        :'excluded_in_locales' => :'Array<String>',
+        :'format_value_type' => :'String'
       }
     end
 
@@ -205,6 +215,16 @@ module Phrase
       if attributes.key?(:'custom_metadata')
         self.custom_metadata = attributes[:'custom_metadata']
       end
+
+      if attributes.key?(:'excluded_in_locales')
+        if (value = attributes[:'excluded_in_locales']).is_a?(Array)
+          self.excluded_in_locales = value
+        end
+      end
+
+      if attributes.key?(:'format_value_type')
+        self.format_value_type = attributes[:'format_value_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -248,7 +268,9 @@ module Phrase
           original_file == o.original_file &&
           localized_format_string == o.localized_format_string &&
           localized_format_key == o.localized_format_key &&
-          custom_metadata == o.custom_metadata
+          custom_metadata == o.custom_metadata &&
+          excluded_in_locales == o.excluded_in_locales &&
+          format_value_type == o.format_value_type
     end
 
     # @see the `==` method
@@ -260,7 +282,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, name, description, plural, use_ordinal_rules, name_plural, data_type, tags, max_characters_allowed, screenshot, remove_screenshot, unformatted, default_translation_content, autotranslate, xml_space_preserve, original_file, localized_format_string, localized_format_key, custom_metadata].hash
+      [branch, name, description, plural, use_ordinal_rules, name_plural, data_type, tags, max_characters_allowed, screenshot, remove_screenshot, unformatted, default_translation_content, autotranslate, xml_space_preserve, original_file, localized_format_string, localized_format_key, custom_metadata, excluded_in_locales, format_value_type].hash
     end
 
     # Builds the object from hash