phrase 1.0.7 → 2.0.0

data/lib/phrase/models/variable_update_parameters.rb

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

@@ -12,6 +12,8 @@ module Phrase
 
     attr_accessor :active
 
+    attr_accessor :include_branches
+
     attr_accessor :created_at
 
     attr_accessor :updated_at
@@ -24,6 +26,7 @@ module Phrase
         :'description' => :'description',
         :'events' => :'events',
         :'active' => :'active',
+        :'include_branches' => :'include_branches',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at'
       }
@@ -37,6 +40,7 @@ module Phrase
         :'description' => :'String',
         :'events' => :'Array<String>',
         :'active' => :'Boolean',
+        :'include_branches' => :'Boolean',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime'
       }
@@ -85,6 +89,10 @@ module Phrase
         self.active = attributes[:'active']
       end
 
+      if attributes.key?(:'include_branches')
+        self.include_branches = attributes[:'include_branches']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -117,6 +125,7 @@ module Phrase
           description == o.description &&
           events == o.events &&
           active == o.active &&
+          include_branches == o.include_branches &&
           created_at == o.created_at &&
           updated_at == o.updated_at
     end
@@ -130,7 +139,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, callback_url, description, events, active, created_at, updated_at].hash
+      [id, callback_url, description, events, active, include_branches, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/webhook_create_parameters.rb

@@ -17,6 +17,9 @@ module Phrase
     # Whether webhook is active or inactive
     attr_accessor :active
 
+    # If enabled, webhook will also be triggered for events from branches of the project specified.
+    attr_accessor :include_branches
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -24,7 +27,8 @@ module Phrase
         :'secret' => :'secret',
         :'description' => :'description',
         :'events' => :'events',
-        :'active' => :'active'
+        :'active' => :'active',
+        :'include_branches' => :'include_branches'
       }
     end
 
@@ -35,7 +39,8 @@ module Phrase
         :'secret' => :'String',
         :'description' => :'String',
         :'events' => :'String',
-        :'active' => :'Boolean'
+        :'active' => :'Boolean',
+        :'include_branches' => :'Boolean'
       }
     end
 
@@ -79,6 +84,10 @@ module Phrase
       if attributes.key?(:'active')
         self.active = attributes[:'active']
       end
+
+      if attributes.key?(:'include_branches')
+        self.include_branches = attributes[:'include_branches']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -103,7 +112,8 @@ module Phrase
           secret == o.secret &&
           description == o.description &&
           events == o.events &&
-          active == o.active
+          active == o.active &&
+          include_branches == o.include_branches
     end
 
     # @see the `==` method
@@ -115,7 +125,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [callback_url, secret, description, events, active].hash
+      [callback_url, secret, description, events, active, include_branches].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/webhook_update_parameters.rb

@@ -17,6 +17,9 @@ module Phrase
     # Whether webhook is active or inactive
     attr_accessor :active
 
+    # If enabled, webhook will also be triggered for events from branches of the project specified.
+    attr_accessor :include_branches
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -24,7 +27,8 @@ module Phrase
         :'secret' => :'secret',
         :'description' => :'description',
         :'events' => :'events',
-        :'active' => :'active'
+        :'active' => :'active',
+        :'include_branches' => :'include_branches'
       }
     end
 
@@ -35,7 +39,8 @@ module Phrase
         :'secret' => :'String',
         :'description' => :'String',
         :'events' => :'String',
-        :'active' => :'Boolean'
+        :'active' => :'Boolean',
+        :'include_branches' => :'Boolean'
       }
     end
 
@@ -79,6 +84,10 @@ module Phrase
       if attributes.key?(:'active')
         self.active = attributes[:'active']
       end
+
+      if attributes.key?(:'include_branches')
+        self.include_branches = attributes[:'include_branches']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -103,7 +112,8 @@ module Phrase
           secret == o.secret &&
           description == o.description &&
           events == o.events &&
-          active == o.active
+          active == o.active &&
+          include_branches == o.include_branches
     end
 
     # @see the `==` method
@@ -115,7 +125,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [callback_url, secret, description, events, active].hash
+      [callback_url, secret, description, events, active, include_branches].hash
     end
 
     # Builds the object from hash

data/lib/phrase/version.rb

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

data/spec/api/invitations_api_spec.rb

@@ -91,6 +91,21 @@ describe 'InvitationsApi' do
     end
   end
 
+  # unit tests for invitation_update_settings
+  # Update a member's invitation access
+  # Update member's settings in the invitations. Access token scope must include <code>team.manage</code>.
+  # @param project_id Project ID
+  # @param id ID
+  # @param invitation_update_settings_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [Invitation]
+  describe 'invitation_update_settings 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 invitations_list
   # List invitations
   # List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include <code>team.manage</code>.

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

@@ -61,6 +61,7 @@ describe 'LocalesApi' do
   # @option opts [String] :tags Limit results to keys tagged with a list of comma separated tag names.
   # @option opts [String] :tag Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
   # @option opts [Boolean] :include_empty_translations Indicates whether keys without translations should be included in the output as well.
+  # @option opts [Boolean] :exclude_empty_zero_forms Indicates whether zero forms should be included when empty in pluralized keys.
   # @option opts [Boolean] :include_translated_keys Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
   # @option opts [Boolean] :keep_notranslate_tags Indicates whether [NOTRANSLATE] tags should be kept.
   # @option opts [Boolean] :convert_emoji This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
@@ -70,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/members_api_spec.rb

@@ -63,6 +63,21 @@ describe 'MembersApi' do
     end
   end
 
+  # unit tests for member_update_settings
+  # Update a member's project settings
+  # Update user settings in the project. Access token scope must include <code>team.manage</code>.
+  # @param project_id Project ID
+  # @param id ID
+  # @param member_update_settings_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [MemberProjectDetail]
+  describe 'member_update_settings 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 members_list
   # List members
   # Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include <code>team.manage</code>.