phrase 2.5.1 → 2.7.1

data/lib/phrase/models/job_comment_create_parameters.rb

@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+  class JobCommentCreateParameters
+    # Job comment message
+    attr_accessor :message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'message' => :'message'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'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::JobCommentCreateParameters` 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::JobCommentCreateParameters`. 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?(:'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 &&
+          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
+      [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_comment_update_parameters.rb

@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+  class JobCommentUpdateParameters
+    # Comment message
+    attr_accessor :message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'message' => :'message'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'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::JobCommentUpdateParameters` 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::JobCommentUpdateParameters`. 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?(:'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 &&
+          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
+      [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_create_parameters.rb

@@ -26,6 +26,9 @@ module Phrase
     # ids of keys that should be included within the job
     attr_accessor :translation_key_ids
 
+    # id of a job template you would like to model the created job after. Any manually added parameters will take preference over template attributes.
+    attr_accessor :job_template_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -36,7 +39,8 @@ module Phrase
         :'due_date' => :'due_date',
         :'ticket_url' => :'ticket_url',
         :'tags' => :'tags',
-        :'translation_key_ids' => :'translation_key_ids'
+        :'translation_key_ids' => :'translation_key_ids',
+        :'job_template_id' => :'job_template_id'
       }
     end
 
@@ -50,7 +54,8 @@ module Phrase
         :'due_date' => :'DateTime',
         :'ticket_url' => :'String',
         :'tags' => :'Array<String>',
-        :'translation_key_ids' => :'Array<String>'
+        :'translation_key_ids' => :'Array<String>',
+        :'job_template_id' => :'String'
       }
     end
 
@@ -110,6 +115,10 @@ module Phrase
           self.translation_key_ids = value
         end
       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?
@@ -137,7 +146,8 @@ module Phrase
           due_date == o.due_date &&
           ticket_url == o.ticket_url &&
           tags == o.tags &&
-          translation_key_ids == o.translation_key_ids
+          translation_key_ids == o.translation_key_ids &&
+          job_template_id == o.job_template_id
     end
 
     # @see the `==` method
@@ -149,7 +159,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, name, source_locale_id, briefing, due_date, ticket_url, tags, translation_key_ids].hash
+      [branch, name, source_locale_id, briefing, due_date, ticket_url, tags, translation_key_ids, job_template_id].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/key_create_parameters.rb

@@ -35,6 +35,9 @@ module Phrase
     # Indicates whether the key should be exported as \"unformatted\". Supported by Android XML and other formats.
     attr_accessor :unformatted
 
+    # Creates a translation in the default locale with the specified content
+    attr_accessor :default_translation_content
+
     # Indicates whether the key should be exported with \"xml:space=preserve\". Supported by several XML-based formats.
     attr_accessor :xml_space_preserve
 
@@ -61,6 +64,7 @@ module Phrase
         :'screenshot' => :'screenshot',
         :'remove_screenshot' => :'remove_screenshot',
         :'unformatted' => :'unformatted',
+        :'default_translation_content' => :'default_translation_content',
         :'xml_space_preserve' => :'xml_space_preserve',
         :'original_file' => :'original_file',
         :'localized_format_string' => :'localized_format_string',
@@ -82,6 +86,7 @@ module Phrase
         :'screenshot' => :'File',
         :'remove_screenshot' => :'Boolean',
         :'unformatted' => :'Boolean',
+        :'default_translation_content' => :'String',
         :'xml_space_preserve' => :'Boolean',
         :'original_file' => :'String',
         :'localized_format_string' => :'String',
@@ -154,6 +159,10 @@ module Phrase
         self.unformatted = attributes[:'unformatted']
       end
 
+      if attributes.key?(:'default_translation_content')
+        self.default_translation_content = attributes[:'default_translation_content']
+      end
+
       if attributes.key?(:'xml_space_preserve')
         self.xml_space_preserve = attributes[:'xml_space_preserve']
       end
@@ -200,6 +209,7 @@ module Phrase
           screenshot == o.screenshot &&
           remove_screenshot == o.remove_screenshot &&
           unformatted == o.unformatted &&
+          default_translation_content == o.default_translation_content &&
           xml_space_preserve == o.xml_space_preserve &&
           original_file == o.original_file &&
           localized_format_string == o.localized_format_string &&
@@ -215,7 +225,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, name, description, plural, name_plural, data_type, tags, max_characters_allowed, screenshot, remove_screenshot, unformatted, xml_space_preserve, original_file, localized_format_string, localized_format_key].hash
+      [branch, name, description, plural, name_plural, data_type, tags, max_characters_allowed, screenshot, remove_screenshot, unformatted, default_translation_content, xml_space_preserve, original_file, localized_format_string, localized_format_key].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/member.rb

@@ -53,7 +53,7 @@ module Phrase
         :'projects' => :'Array<ProjectLocales>',
         :'permissions' => :'Object',
         :'default_locale_codes' => :'Array<String>',
-        :'teams' => :'Array<Team1>',
+        :'teams' => :'Array<TeamShort>',
         :'spaces' => :'Array<MemberSpaces>'
       }
     end

data/lib/phrase/models/{team1.rb → team_short.rb}

@@ -1,7 +1,7 @@
 require 'date'
 
 module Phrase
-  class Team1
+  class TeamShort
     attr_accessor :id
 
     attr_accessor :name
@@ -40,13 +40,13 @@ module Phrase
     # @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::Team1` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::TeamShort` 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::Team1`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::TeamShort`. 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
       }

data/lib/phrase/version.rb

@@ -1,3 +1,3 @@
 module Phrase
-  VERSION = '2.5.1'
+  VERSION = '2.7.1'
 end

data/lib/phrase.rb

@@ -67,6 +67,9 @@ require 'phrase/models/invitation_create_parameters'
 require 'phrase/models/invitation_update_parameters'
 require 'phrase/models/invitation_update_settings_parameters'
 require 'phrase/models/job'
+require 'phrase/models/job_comment'
+require 'phrase/models/job_comment_create_parameters'
+require 'phrase/models/job_comment_update_parameters'
 require 'phrase/models/job_complete_parameters'
 require 'phrase/models/job_create_parameters'
 require 'phrase/models/job_details'
@@ -156,9 +159,9 @@ require 'phrase/models/tag_with_stats1'
 require 'phrase/models/tag_with_stats1_statistics'
 require 'phrase/models/tag_with_stats1_statistics1'
 require 'phrase/models/team'
-require 'phrase/models/team1'
 require 'phrase/models/team_create_parameters'
 require 'phrase/models/team_detail'
+require 'phrase/models/team_short'
 require 'phrase/models/team_update_parameters'
 require 'phrase/models/teams_projects_create_parameters'
 require 'phrase/models/teams_spaces_create_parameters'
@@ -215,6 +218,7 @@ require 'phrase/api/glossary_term_translations_api'
 require 'phrase/api/glossary_terms_api'
 require 'phrase/api/icu_api'
 require 'phrase/api/invitations_api'
+require 'phrase/api/job_comments_api'
 require 'phrase/api/job_locales_api'
 require 'phrase/api/job_template_locales_api'
 require 'phrase/api/job_templates_api'

data/spec/api/job_comments_api_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Phrase::JobCommentsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'JobCommentsApi' do
+  before do
+    # run before each test
+    @api_instance = Phrase::JobCommentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of JobCommentsApi' do
+    it 'should create an instance of JobCommentsApi' do
+      expect(@api_instance).to be_instance_of(Phrase::JobCommentsApi)
+    end
+  end
+
+  # unit tests for job_comment_create
+  # Create a job comment
+  # Create a new comment for a job.
+  # @param project_id Project ID
+  # @param job_id Job ID
+  # @param job_comment_create_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [JobComment]
+  describe 'job_comment_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 job_comment_delete
+  # Delete a job comment
+  # Delete an existing job comment.
+  # @param project_id Project ID
+  # @param job_id Job 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 'job_comment_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 job_comment_show
+  # Get a single job comment
+  # Get details on a single job comment.
+  # @param project_id Project ID
+  # @param job_id Job 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 [Object]
+  describe 'job_comment_show 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 job_comment_update
+  # Update a job comment
+  # Update an existing job comment.
+  # @param project_id Project ID
+  # @param key_id Translation Key ID
+  # @param id ID
+  # @param job_comment_update_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [Object]
+  describe 'job_comment_update 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 job_comments_list
+  # List job comments
+  # List all comments for a job.
+  # @param project_id Project ID
+  # @param job_id Job 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 [Array<Object>]
+  describe 'job_comments_list test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end