phrase 2.25.0 → 3.0.0

data/lib/phrase/models/translation_parent.rb

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

@@ -58,12 +58,17 @@ module Phrase
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
       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?
+      return false if @name.nil?
       true
     end
 

data/lib/phrase/models/webhook_create_parameters.rb

@@ -94,12 +94,17 @@ module Phrase
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @callback_url.nil?
+        invalid_properties.push('invalid value for "callback_url", callback_url cannot be nil.')
+      end
+
       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?
+      return false if @callback_url.nil?
       true
     end
 

data/lib/phrase/version.rb

@@ -1,3 +1,3 @@
 module Phrase
-  VERSION = '2.25.0'
+  VERSION = '3.0.0'
 end

data/lib/phrase.rb

@@ -202,6 +202,7 @@ require 'phrase/models/translation_include_parameters'
 require 'phrase/models/translation_key'
 require 'phrase/models/translation_key_details'
 require 'phrase/models/translation_order'
+require 'phrase/models/translation_parent'
 require 'phrase/models/translation_review_parameters'
 require 'phrase/models/translation_unverify_parameters'
 require 'phrase/models/translation_update_parameters'

data/spec/api/icu_api_spec.rb

@@ -21,8 +21,8 @@ describe 'ICUApi' do
   end
 
   # unit tests for icu_skeleton
-  # Build icu skeletons
-  # Returns icu skeletons for multiple locale codes based on a source content.
+  # Build ICU skeletons
+  # Returns ICU skeletons for multiple locale codes based on a source content.
   # @param icu_skeleton_parameters 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)

data/spec/api/linked_keys_api_spec.rb

@@ -28,7 +28,6 @@ describe 'LinkedKeysApi' do
   # @param key_links_batch_destroy_parameters 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
-  # @option opts [Boolean] :unlink_parent Whether to unlink the parent key as well and unmark it as linked-key.
   # @return [nil]
   describe 'key_links_batch_destroy test' do
     it 'should work' do
@@ -67,7 +66,7 @@ describe 'LinkedKeysApi' do
   end
 
   # unit tests for key_links_index
-  # Retrieve all child keys linked to a specific parent key
+  # List child keys of a parent key
   # Returns detailed information about a parent key, including its linked child keys.
   # @param project_id Project ID
   # @param id Parent Translation Key ID

data/spec/api/locales_api_spec.rb

@@ -87,7 +87,7 @@ describe 'LocalesApi' do
   # @option opts [Boolean] :skip_unverified_translations Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>.
   # @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 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>.
+  # @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 ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>.
   # @option opts [String] :source_locale_id Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a <code>tag</code> parameter indicating a specific job.
   # @return [File]
   describe 'locale_download test' do

data/spec/api/uploads_api_spec.rb

@@ -29,7 +29,7 @@ describe 'UploadsApi' do
   # @option opts [String] :branch specify the branch to use
   # @option opts [File] :file File to be imported
   # @option opts [String] :file_format File format. Auto-detected when possible and not specified.
-  # @option opts [String] :locale_id Locale of the file's content. Can be the name or public id of the locale. Preferred is the public id.
+  # @option opts [String] :locale_id Locale of the file's content. Can be the name or id of the locale. Preferred is id.
   # @option opts [String] :tags List of tags separated by comma to be associated with the new keys contained in the upload.
   # @option opts [Boolean] :update_translations Indicates whether existing translations should be updated with the file content.
   # @option opts [Boolean] :update_descriptions Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions.
@@ -53,7 +53,7 @@ describe 'UploadsApi' do
     end
 
     it 'should work' do
-      @api_instance.upload_create('project_id', file: File.new('Gemfile'))
+      @api_instance.upload_create('project_id', File.new('Gemfile'), "yml", "en")
 
       expect(a_request(:post, 'https://api.phrase.com/v2/projects/project_id/uploads')
         .with { |req|

data/spec/models/key_links_batch_destroy_parameters_spec.rb

@@ -26,4 +26,10 @@ describe 'KeyLinksBatchDestroyParameters' do
     end
   end
 
+  describe 'test attribute "unlink_parent"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/translation_details_spec.rb

@@ -98,4 +98,10 @@ describe 'TranslationDetails' do
     end
   end
 
+  describe 'test attribute "linked_translation"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/translation_parent_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Phrase::TranslationParent
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TranslationParent' do
+  before do
+    # run before each test
+    @instance = Phrase::TranslationParent.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TranslationParent' do
+    it 'should create an instance of TranslationParent' do
+      expect(@instance).to be_instance_of(Phrase::TranslationParent)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "content"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end