phrase 2.12.0 → 2.13.0

data/lib/phrase/api/spaces_api.rb

@@ -375,7 +375,7 @@ module Phrase
       return response, status_code, headers
     end
 
-    # Add Project
+    # Add Project to Space
     # Adds an existing project to the space.
     # @param account_id [String] Account ID
     # @param space_id [String] Space ID
@@ -388,7 +388,7 @@ module Phrase
       data
     end
 
-    # Add Project
+    # Add Project to Space
     # Adds an existing project to the space.
     # @param account_id [String] Account ID
     # @param space_id [String] Space ID
@@ -453,7 +453,7 @@ module Phrase
       return response, status_code, headers
     end
 
-    # Remove Project
+    # Remove Project from Space
     # Removes a specified project from the specified space.
     # @param account_id [String] Account ID
     # @param space_id [String] Space ID
@@ -466,7 +466,7 @@ module Phrase
       data
     end
 
-    # Remove Project
+    # Remove Project from Space
     # Removes a specified project from the specified space.
     # @param account_id [String] Account ID
     # @param space_id [String] Space ID
@@ -529,7 +529,7 @@ module Phrase
       return response, status_code, headers
     end
 
-    # List Projects
+    # List Projects in Space
     # List all projects for the specified Space.
     # @param account_id [String] Account ID
     # @param space_id [String] Space ID
@@ -543,7 +543,7 @@ module Phrase
       data
     end
 
-    # List Projects
+    # List Projects in Space
     # List all projects for the specified Space.
     # @param account_id [String] Account ID
     # @param space_id [String] Space ID

data/lib/phrase/api/teams_api.rb

@@ -375,7 +375,7 @@ module Phrase
       return response, status_code, headers
     end
 
-    # Add Project
+    # Add Project to Team
     # Adds an existing project to the team.
     # @param account_id [String] Account ID
     # @param team_id [String] Team ID
@@ -388,7 +388,7 @@ module Phrase
       data
     end
 
-    # Add Project
+    # Add Project to Team
     # Adds an existing project to the team.
     # @param account_id [String] Account ID
     # @param team_id [String] Team ID
@@ -453,7 +453,7 @@ module Phrase
       return response, status_code, headers
     end
 
-    # Remove Project
+    # Remove Project from Team
     # Removes a specified project from the specified team.
     # @param account_id [String] Account ID
     # @param team_id [String] Team ID
@@ -466,7 +466,7 @@ module Phrase
       data
     end
 
-    # Remove Project
+    # Remove Project from Team
     # Removes a specified project from the specified team.
     # @param account_id [String] Account ID
     # @param team_id [String] Team ID

data/lib/phrase/api/uploads_api.rb

@@ -26,7 +26,7 @@ module Phrase
     # @option opts [Object] :locale_mapping Optional, format specific mapping between locale names and the columns the translations to those locales are contained in.
     # @option opts [Object] :format_options Additional options available for specific formats. See our format guide for complete list.
     # @option opts [Boolean] :autotranslate If set, translations for the uploaded language will be fetched automatically.
-    # @option opts [Boolean] :mark_reviewed Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project.
+    # @option opts [Boolean] :mark_reviewed Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
     # @return [Upload]
     def upload_create(project_id, opts = {})
       data, _status_code, _headers = upload_create_with_http_info(project_id, opts)
@@ -52,7 +52,7 @@ module Phrase
     # @option opts [Object] :locale_mapping Optional, format specific mapping between locale names and the columns the translations to those locales are contained in.
     # @option opts [Object] :format_options Additional options available for specific formats. See our format guide for complete list.
     # @option opts [Boolean] :autotranslate If set, translations for the uploaded language will be fetched automatically.
-    # @option opts [Boolean] :mark_reviewed Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project.
+    # @option opts [Boolean] :mark_reviewed Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
     # @return [Array<(Response<(Upload)>, Integer, Hash)>] Response<(Upload)> data, response status code and response headers
     def upload_create_with_http_info(project_id, opts = {})
       if @api_client.config.debugging

data/lib/phrase/models/comment_reaction.rb

@@ -0,0 +1,239 @@
+require 'date'
+
+module Phrase
+  class CommentReaction
+    attr_accessor :id
+
+    attr_accessor :emoji
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    attr_accessor :comment
+
+    attr_accessor :user
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'emoji' => :'emoji',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at',
+        :'comment' => :'comment',
+        :'user' => :'user'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'emoji' => :'String',
+        :'created_at' => :'DateTime',
+        :'updated_at' => :'DateTime',
+        :'comment' => :'Comment',
+        :'user' => :'UserPreview'
+      }
+    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::CommentReaction` 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::CommentReaction`. 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?(:'emoji')
+        self.emoji = attributes[:'emoji']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'comment')
+        self.comment = attributes[:'comment']
+      end
+
+      if attributes.key?(:'user')
+        self.user = attributes[:'user']
+      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 &&
+          emoji == o.emoji &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          comment == o.comment &&
+          user == o.user
+    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, emoji, created_at, updated_at, comment, user].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 :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/distribution_create_parameters.rb

@@ -8,7 +8,7 @@ module Phrase
     # Project id the distribution should be assigned to.
     attr_accessor :project_id
 
-    # List of platforms the distribution should support.
+    # List of platforms the distribution should support. Valid values are: * `android` * `ios` * `flutter` * `i18next`
     attr_accessor :platforms
 
     # List of locale ids that will be part of distribution releases

data/lib/phrase/models/gitlab_sync_history.rb

@@ -26,9 +26,9 @@ module Phrase
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'status' => :'Integer',
+        :'status' => :'String',
         :'action' => :'String',
-        :'errors' => :'Array<String>',
+        :'errors' => :'Array<GitlabSyncHistoryErrors>',
         :'date' => :'DateTime',
         :'details' => :'Object'
       }

data/lib/phrase/models/gitlab_sync_history_errors.rb

@@ -0,0 +1,203 @@
+require 'date'
+
+module Phrase
+  class GitlabSyncHistoryErrors
+    attr_accessor :error
+
+    attr_accessor :message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'message' => :'message'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'error' => :'String',
+        :'message' => :'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::GitlabSyncHistoryErrors` 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::GitlabSyncHistoryErrors`. 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?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      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 &&
+          error == o.error &&
+          message == o.message
+    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
+      [error, message].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 :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/job_locale_update_parameters.rb

@@ -5,7 +5,7 @@ module Phrase
     # specify the branch to use
     attr_accessor :branch
 
-    # locale id
+    # ID of a target locale to update
     attr_accessor :locale_id
 
     # Array of user ids to be assigned to the job locale

data/lib/phrase/models/job_locales_create_parameters.rb

@@ -5,7 +5,7 @@ module Phrase
     # specify the branch to use
     attr_accessor :branch
 
-    # locale id
+    # ID of a locale to be added
     attr_accessor :locale_id
 
     # Array of user ids to be assigned to the job locale as translators

data/lib/phrase/models/upload_create_parameters.rb

@@ -44,7 +44,7 @@ module Phrase
     # If set, translations for the uploaded language will be fetched automatically.
     attr_accessor :autotranslate
 
-    # Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project.
+    # Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
     attr_accessor :mark_reviewed
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/phrase/version.rb

@@ -1,3 +1,3 @@
 module Phrase
-  VERSION = '2.12.0'
+  VERSION = '2.13.0'
 end

data/lib/phrase.rb

@@ -34,6 +34,7 @@ require 'phrase/models/branch_update_parameters'
 require 'phrase/models/comment'
 require 'phrase/models/comment_create_parameters'
 require 'phrase/models/comment_mark_read_parameters'
+require 'phrase/models/comment_reaction'
 require 'phrase/models/comment_update_parameters'
 require 'phrase/models/current_user'
 require 'phrase/models/distribution'
@@ -48,6 +49,7 @@ require 'phrase/models/gitlab_sync'
 require 'phrase/models/gitlab_sync_export'
 require 'phrase/models/gitlab_sync_export_parameters'
 require 'phrase/models/gitlab_sync_history'
+require 'phrase/models/gitlab_sync_history_errors'
 require 'phrase/models/gitlab_sync_import_parameters'
 require 'phrase/models/glossary'
 require 'phrase/models/glossary_create_parameters'
@@ -217,6 +219,7 @@ require 'phrase/api/authorizations_api'
 require 'phrase/api/bitbucket_sync_api'
 require 'phrase/api/blacklisted_keys_api'
 require 'phrase/api/branches_api'
+require 'phrase/api/comment_reactions_api'
 require 'phrase/api/comments_api'
 require 'phrase/api/distributions_api'
 require 'phrase/api/documents_api'