phrase 2.13.0 → 2.15.0

data/lib/phrase/models/comment.rb

@@ -6,6 +6,8 @@ module Phrase
 
     attr_accessor :message
 
+    attr_accessor :has_replies
+
     attr_accessor :user
 
     attr_accessor :created_at
@@ -14,15 +16,19 @@ module Phrase
 
     attr_accessor :mentioned_users
 
+    attr_accessor :locales
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
         :'message' => :'message',
+        :'has_replies' => :'has_replies',
         :'user' => :'user',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
-        :'mentioned_users' => :'mentioned_users'
+        :'mentioned_users' => :'mentioned_users',
+        :'locales' => :'locales'
       }
     end
 
@@ -31,10 +37,12 @@ module Phrase
       {
         :'id' => :'String',
         :'message' => :'String',
+        :'has_replies' => :'Boolean',
         :'user' => :'UserPreview',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
-        :'mentioned_users' => :'Array<UserPreview>'
+        :'mentioned_users' => :'Array<UserPreview>',
+        :'locales' => :'Array<LocalePreview>'
       }
     end
 
@@ -67,6 +75,10 @@ module Phrase
         self.message = attributes[:'message']
       end
 
+      if attributes.key?(:'has_replies')
+        self.has_replies = attributes[:'has_replies']
+      end
+
       if attributes.key?(:'user')
         self.user = attributes[:'user']
       end
@@ -84,6 +96,12 @@ module Phrase
           self.mentioned_users = value
         end
       end
+
+      if attributes.key?(:'locales')
+        if (value = attributes[:'locales']).is_a?(Array)
+          self.locales = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -106,10 +124,12 @@ module Phrase
       self.class == o.class &&
           id == o.id &&
           message == o.message &&
+          has_replies == o.has_replies &&
           user == o.user &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
-          mentioned_users == o.mentioned_users
+          mentioned_users == o.mentioned_users &&
+          locales == o.locales
     end
 
     # @see the `==` method
@@ -121,7 +141,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, message, user, created_at, updated_at, mentioned_users].hash
+      [id, message, has_replies, user, created_at, updated_at, mentioned_users, locales].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/comments_list_parameters.rb

@@ -0,0 +1,229 @@
+require 'date'
+
+module Phrase
+  class CommentsListParameters
+    # Specify the branch to use
+    attr_accessor :branch
+
+    # Search query for comment messages
+    attr_accessor :query
+
+    # Search comments by their assigned locales
+    attr_accessor :locale_ids
+
+    # Specify filters to find comments by
+    attr_accessor :filters
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'branch' => :'branch',
+        :'query' => :'query',
+        :'locale_ids' => :'locale_ids',
+        :'filters' => :'filters'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'branch' => :'String',
+        :'query' => :'String',
+        :'locale_ids' => :'Array<String>',
+        :'filters' => :'Array<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::CommentsListParameters` 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::CommentsListParameters`. 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?(:'branch')
+        self.branch = attributes[:'branch']
+      end
+
+      if attributes.key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.key?(:'locale_ids')
+        if (value = attributes[:'locale_ids']).is_a?(Array)
+          self.locale_ids = value
+        end
+      end
+
+      if attributes.key?(:'filters')
+        if (value = attributes[:'filters']).is_a?(Array)
+          self.filters = value
+        end
+      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 &&
+          branch == o.branch &&
+          query == o.query &&
+          locale_ids == o.locale_ids &&
+          filters == o.filters
+    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
+      [branch, query, locale_ids, filters].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/replies_list_parameters.rb

@@ -0,0 +1,217 @@
+require 'date'
+
+module Phrase
+  class RepliesListParameters
+    # Specify the branch to use
+    attr_accessor :branch
+
+    # Search query for comment messages
+    attr_accessor :query
+
+    # Specify filters to find comments by
+    attr_accessor :filters
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'branch' => :'branch',
+        :'query' => :'query',
+        :'filters' => :'filters'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'branch' => :'String',
+        :'query' => :'String',
+        :'filters' => :'Array<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::RepliesListParameters` 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::RepliesListParameters`. 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?(:'branch')
+        self.branch = attributes[:'branch']
+      end
+
+      if attributes.key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.key?(:'filters')
+        if (value = attributes[:'filters']).is_a?(Array)
+          self.filters = value
+        end
+      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 &&
+          branch == o.branch &&
+          query == o.query &&
+          filters == o.filters
+    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
+      [branch, query, filters].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/version.rb

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

data/lib/phrase.rb

@@ -36,6 +36,7 @@ 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/comments_list_parameters'
 require 'phrase/models/current_user'
 require 'phrase/models/distribution'
 require 'phrase/models/distribution_create_parameters'
@@ -144,6 +145,7 @@ require 'phrase/models/release'
 require 'phrase/models/release_create_parameters'
 require 'phrase/models/release_preview'
 require 'phrase/models/release_update_parameters'
+require 'phrase/models/replies_list_parameters'
 require 'phrase/models/screenshot'
 require 'phrase/models/screenshot_create_parameters'
 require 'phrase/models/screenshot_marker'
@@ -220,6 +222,7 @@ 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/comment_replies_api'
 require 'phrase/api/comments_api'
 require 'phrase/api/distributions_api'
 require 'phrase/api/documents_api'

data/spec/api/comment_reactions_api_spec.rb

@@ -29,6 +29,7 @@ describe 'CommentReactionsApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @option opts [String] :branch specify the branch to use
+  # @option opts [String] :emoji specify the emoji for the reaction
   # @return [CommentReaction]
   describe 'reaction_create test' do
     it 'should work' do

data/spec/api/comment_replies_api_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Phrase::CommentRepliesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CommentRepliesApi' do
+  before do
+    # run before each test
+    @api_instance = Phrase::CommentRepliesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CommentRepliesApi' do
+    it 'should create an instance of CommentRepliesApi' do
+      expect(@api_instance).to be_instance_of(Phrase::CommentRepliesApi)
+    end
+  end
+
+  # unit tests for replies_list
+  # List replies
+  # List all replies for a comment.
+  # @param project_id Project ID
+  # @param key_id Translation Key ID
+  # @param comment_id Comment ID
+  # @param replies_list_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @option opts [Integer] :page Page number
+  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
+  # @option opts [String] :branch specify the branch to use
+  # @option opts [String] :query Search query for comment messages
+  # @option opts [Array<String>] :filters Specify the filter for the comments
+  # @return [Array<Comment>]
+  describe 'replies_list test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for reply_create
+  # Create a reply
+  # Create a new reply for a comment.
+  # @param project_id Project ID
+  # @param key_id Translation Key ID
+  # @param comment_id Comment ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @option opts [String] :branch specify the branch to use
+  # @option opts [String] :message specify the message for the comment
+  # @return [Comment]
+  describe 'reply_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for reply_delete
+  # Delete a reply
+  # Delete an existing reply.
+  # @param project_id Project ID
+  # @param key_id Translation Key ID
+  # @param comment_id Comment ID
+  # @param id ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @option opts [String] :branch specify the branch to use
+  # @return [nil]
+  describe 'reply_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for reply_mark_as_read
+  # Mark a reply as read
+  # Mark a reply as read.
+  # @param project_id Project ID
+  # @param key_id Translation Key ID
+  # @param comment_id Comment ID
+  # @param id ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @option opts [String] :branch specify the branch to use
+  # @return [nil]
+  describe 'reply_mark_as_read test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for reply_mark_as_unread
+  # Mark a reply as unread
+  # Mark a reply as unread.
+  # @param project_id Project ID
+  # @param key_id Translation Key ID
+  # @param comment_id Comment ID
+  # @param id ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @option opts [String] :branch specify the branch to use
+  # @return [nil]
+  describe 'reply_mark_as_unread test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for reply_show
+  # Get a single reply
+  # Get details on a single reply.
+  # @param project_id Project ID
+  # @param key_id Translation Key ID
+  # @param comment_id Comment ID
+  # @param id ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @option opts [String] :branch specify the branch to use
+  # @return [Comment]
+  describe 'reply_show test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end