phrase 1.0.14 → 2.0.0

data/lib/phrase/api/users_api.rb

@@ -11,7 +11,7 @@ module Phrase
     # Show details for current User.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
-    # @return [User]
+    # @return [CurrentUser]
     def show_user(opts = {})
       data, _status_code, _headers = show_user_with_http_info(opts)
       data
@@ -21,7 +21,7 @@ module Phrase
     # Show details for current User.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
-    # @return [Array<(Response<(User)>, Integer, Hash)>] Response<(User)> data, response status code and response headers
+    # @return [Array<(Response<(CurrentUser)>, Integer, Hash)>] Response<(CurrentUser)> data, response status code and response headers
     def show_user_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: UsersApi.show_user ...'
@@ -45,7 +45,7 @@ module Phrase
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'User' 
+      return_type = opts[:return_type] || 'CurrentUser' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['Basic', 'Token']

data/lib/phrase/models/current_user.rb

@@ -0,0 +1,257 @@
+require 'date'
+
+module Phrase
+  class CurrentUser
+    attr_accessor :id
+
+    attr_accessor :username
+
+    attr_accessor :name
+
+    attr_accessor :email
+
+    attr_accessor :position
+
+    attr_accessor :language
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'username' => :'username',
+        :'name' => :'name',
+        :'email' => :'email',
+        :'position' => :'position',
+        :'language' => :'language',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'username' => :'String',
+        :'name' => :'String',
+        :'email' => :'String',
+        :'position' => :'String',
+        :'language' => :'String',
+        :'created_at' => :'DateTime',
+        :'updated_at' => :'DateTime'
+      }
+    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::CurrentUser` 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::CurrentUser`. 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?(:'username')
+        self.username = attributes[:'username']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'position')
+        self.position = attributes[:'position']
+      end
+
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
+      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
+    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 &&
+          username == o.username &&
+          name == o.name &&
+          email == o.email &&
+          position == o.position &&
+          language == o.language &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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, username, name, email, position, language, created_at, updated_at].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.rb

@@ -12,6 +12,10 @@ module Phrase
 
     attr_accessor :completed
 
+    attr_accessor :translation_completed_at
+
+    attr_accessor :review_completed_at
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -19,7 +23,9 @@ module Phrase
         :'job' => :'job',
         :'locale' => :'locale',
         :'users' => :'users',
-        :'completed' => :'completed'
+        :'completed' => :'completed',
+        :'translation_completed_at' => :'translation_completed_at',
+        :'review_completed_at' => :'review_completed_at'
       }
     end
 
@@ -30,7 +36,9 @@ module Phrase
         :'job' => :'JobPreview',
         :'locale' => :'LocalePreview',
         :'users' => :'Array<UserPreview>',
-        :'completed' => :'Boolean'
+        :'completed' => :'Boolean',
+        :'translation_completed_at' => :'DateTime',
+        :'review_completed_at' => :'DateTime'
       }
     end
 
@@ -76,6 +84,14 @@ module Phrase
       if attributes.key?(:'completed')
         self.completed = attributes[:'completed']
       end
+
+      if attributes.key?(:'translation_completed_at')
+        self.translation_completed_at = attributes[:'translation_completed_at']
+      end
+
+      if attributes.key?(:'review_completed_at')
+        self.review_completed_at = attributes[:'review_completed_at']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -100,7 +116,9 @@ module Phrase
           job == o.job &&
           locale == o.locale &&
           users == o.users &&
-          completed == o.completed
+          completed == o.completed &&
+          translation_completed_at == o.translation_completed_at &&
+          review_completed_at == o.review_completed_at
     end
 
     # @see the `==` method
@@ -112,7 +130,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, job, locale, users, completed].hash
+      [id, job, locale, users, completed, translation_completed_at, review_completed_at].hash
     end
 
     # Builds the object from hash

data/lib/phrase/version.rb

@@ -1,3 +1,3 @@
 module Phrase
-  VERSION = '1.0.14'
+  VERSION = '2.0.0'
 end

data/spec/api/keys_api_spec.rb

@@ -79,7 +79,7 @@ describe 'KeysApi' do
     end
   end
 
-  # unit tests for keys_delete
+  # unit tests for keys_delete_collection
   # Delete collection of keys
   # Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.
   # @param project_id Project ID
@@ -89,7 +89,7 @@ describe 'KeysApi' do
   # @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. 
   # @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
   # @return [AffectedResources]
-  describe 'keys_delete test' do
+  describe 'keys_delete_collection test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/api/locales_api_spec.rb

@@ -71,7 +71,7 @@ describe 'LocalesApi' do
   # @option opts [Boolean] :include_unverified_translations if set to false unverified translations are excluded
   # @option opts [Boolean] :use_last_reviewed_version If set to true the last reviewed version of a translation is used. This is only available if the review workflow (currently in beta) is enabled for the project.
   # @option opts [String] :fallback_locale_id If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>.
-  # @return [nil]
+  # @return [File]
   describe 'locale_download test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/api/translations_api_spec.rb

@@ -179,7 +179,7 @@ describe 'TranslationsApi' do
     end
   end
 
-  # unit tests for translations_exclude
+  # unit tests for translations_exclude_collection
   # Set exclude from export flag on translations selected by query
   # Exclude translations matching query from locale export.
   # @param project_id Project ID
@@ -187,13 +187,13 @@ describe 'TranslationsApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @return [AffectedCount]
-  describe 'translations_exclude test' do
+  describe 'translations_exclude_collection 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 translations_include
+  # unit tests for translations_include_collection
   # Remove exlude from import flag from translations selected by query
   # Include translations matching query in locale export.
   # @param project_id Project ID
@@ -201,7 +201,7 @@ describe 'TranslationsApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @return [AffectedCount]
-  describe 'translations_include test' do
+  describe 'translations_include_collection test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -226,7 +226,7 @@ describe 'TranslationsApi' do
     end
   end
 
-  # unit tests for translations_review
+  # unit tests for translations_review_collection
   # Review translations selected by query
   # Review translations matching query.
   # @param project_id Project ID
@@ -234,7 +234,7 @@ describe 'TranslationsApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @return [AffectedCount]
-  describe 'translations_review test' do
+  describe 'translations_review_collection test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -256,7 +256,7 @@ describe 'TranslationsApi' do
     end
   end
 
-  # unit tests for translations_unverify
+  # unit tests for translations_unverify_collection
   # Mark translations selected by query as unverified
   # Mark translations matching query as unverified.
   # @param project_id Project ID
@@ -264,13 +264,13 @@ describe 'TranslationsApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @return [AffectedCount]
-  describe 'translations_unverify test' do
+  describe 'translations_unverify_collection 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 translations_verify
+  # unit tests for translations_verify_collection
   # Verify translations selected by query
   # Verify translations matching query.
   # @param project_id Project ID
@@ -278,7 +278,7 @@ describe 'TranslationsApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @return [AffectedCount]
-  describe 'translations_verify test' do
+  describe 'translations_verify_collection test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end