phrase 2.8.2 → 2.8.7

data/lib/phrase/api/versions_history_api.rb

@@ -95,7 +95,7 @@ module Phrase
     # @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 allows you to specify a page size up to 100 items, 25 by default
+    # @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
     # @return [Array<TranslationVersion>]
     def versions_list(project_id, translation_id, opts = {})
@@ -110,7 +110,7 @@ module Phrase
     # @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 allows you to specify a page size up to 100 items, 25 by default
+    # @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
     # @return [Array<(Response<(Array<TranslationVersion>)>, Integer, Hash)>] Response<(Array<TranslationVersion>)> data, response status code and response headers
     def versions_list_with_http_info(project_id, translation_id, opts = {})

data/lib/phrase/api/webhooks_api.rb

@@ -379,7 +379,7 @@ module Phrase
     # @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 allows you to specify a page size up to 100 items, 25 by default
+    # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
     # @return [Array<Webhook>]
     def webhooks_list(project_id, opts = {})
       data, _status_code, _headers = webhooks_list_with_http_info(project_id, opts)
@@ -392,7 +392,7 @@ module Phrase
     # @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 allows you to specify a page size up to 100 items, 25 by default
+    # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
     # @return [Array<(Response<(Array<Webhook>)>, Integer, Hash)>] Response<(Array<Webhook>)> data, response status code and response headers
     def webhooks_list_with_http_info(project_id, opts = {})
       if @api_client.config.debugging

data/lib/phrase/models/job_locale.rb

@@ -10,6 +10,8 @@ module Phrase
 
     attr_accessor :users
 
+    attr_accessor :teams
+
     attr_accessor :completed
 
     attr_accessor :translation_completed_at
@@ -23,6 +25,7 @@ module Phrase
         :'job' => :'job',
         :'locale' => :'locale',
         :'users' => :'users',
+        :'teams' => :'teams',
         :'completed' => :'completed',
         :'translation_completed_at' => :'translation_completed_at',
         :'review_completed_at' => :'review_completed_at'
@@ -35,7 +38,8 @@ module Phrase
         :'id' => :'String',
         :'job' => :'JobPreview',
         :'locale' => :'LocalePreview',
-        :'users' => :'Array<UserPreview>',
+        :'users' => :'Array<LocaleUserPreview>',
+        :'teams' => :'Array<LocaleTeamPreview>',
         :'completed' => :'Boolean',
         :'translation_completed_at' => :'DateTime',
         :'review_completed_at' => :'DateTime'
@@ -81,6 +85,12 @@ module Phrase
         end
       end
 
+      if attributes.key?(:'teams')
+        if (value = attributes[:'teams']).is_a?(Array)
+          self.teams = value
+        end
+      end
+
       if attributes.key?(:'completed')
         self.completed = attributes[:'completed']
       end
@@ -116,6 +126,7 @@ module Phrase
           job == o.job &&
           locale == o.locale &&
           users == o.users &&
+          teams == o.teams &&
           completed == o.completed &&
           translation_completed_at == o.translation_completed_at &&
           review_completed_at == o.review_completed_at
@@ -130,7 +141,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, job, locale, users, completed, translation_completed_at, review_completed_at].hash
+      [id, job, locale, users, teams, completed, translation_completed_at, review_completed_at].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/job_locale_update_parameters.rb

@@ -14,13 +14,21 @@ module Phrase
     # Array of reviewer ids to be assigned to the job locale as reviewers
     attr_accessor :reviewer_ids
 
+    # Array of team ids to be assigned to the job locale as translators
+    attr_accessor :translator_team_ids
+
+    # Array of team ids to be assigned to the job locale as reviewers
+    attr_accessor :reviewer_team_ids
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'branch' => :'branch',
         :'locale_id' => :'locale_id',
         :'user_ids' => :'user_ids',
-        :'reviewer_ids' => :'reviewer_ids'
+        :'reviewer_ids' => :'reviewer_ids',
+        :'translator_team_ids' => :'translator_team_ids',
+        :'reviewer_team_ids' => :'reviewer_team_ids'
       }
     end
 
@@ -30,7 +38,9 @@ module Phrase
         :'branch' => :'String',
         :'locale_id' => :'String',
         :'user_ids' => :'Array<String>',
-        :'reviewer_ids' => :'Array<String>'
+        :'reviewer_ids' => :'Array<String>',
+        :'translator_team_ids' => :'Array<String>',
+        :'reviewer_team_ids' => :'Array<String>'
       }
     end
 
@@ -74,6 +84,18 @@ module Phrase
           self.reviewer_ids = value
         end
       end
+
+      if attributes.key?(:'translator_team_ids')
+        if (value = attributes[:'translator_team_ids']).is_a?(Array)
+          self.translator_team_ids = value
+        end
+      end
+
+      if attributes.key?(:'reviewer_team_ids')
+        if (value = attributes[:'reviewer_team_ids']).is_a?(Array)
+          self.reviewer_team_ids = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -97,7 +119,9 @@ module Phrase
           branch == o.branch &&
           locale_id == o.locale_id &&
           user_ids == o.user_ids &&
-          reviewer_ids == o.reviewer_ids
+          reviewer_ids == o.reviewer_ids &&
+          translator_team_ids == o.translator_team_ids &&
+          reviewer_team_ids == o.reviewer_team_ids
     end
 
     # @see the `==` method
@@ -109,7 +133,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, locale_id, user_ids, reviewer_ids].hash
+      [branch, locale_id, user_ids, reviewer_ids, translator_team_ids, reviewer_team_ids].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/job_locales_create_parameters.rb

@@ -14,13 +14,21 @@ module Phrase
     # Array of reviewer ids to be assigned to the job locale as reviewers
     attr_accessor :reviewer_ids
 
+    # Array of team ids to be assigned to the job locale as translators
+    attr_accessor :translator_team_ids
+
+    # Array of team ids to be assigned to the job locale as reviewers
+    attr_accessor :reviewer_team_ids
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'branch' => :'branch',
         :'locale_id' => :'locale_id',
         :'user_ids' => :'user_ids',
-        :'reviewer_ids' => :'reviewer_ids'
+        :'reviewer_ids' => :'reviewer_ids',
+        :'translator_team_ids' => :'translator_team_ids',
+        :'reviewer_team_ids' => :'reviewer_team_ids'
       }
     end
 
@@ -30,7 +38,9 @@ module Phrase
         :'branch' => :'String',
         :'locale_id' => :'String',
         :'user_ids' => :'Array<String>',
-        :'reviewer_ids' => :'Array<String>'
+        :'reviewer_ids' => :'Array<String>',
+        :'translator_team_ids' => :'Array<String>',
+        :'reviewer_team_ids' => :'Array<String>'
       }
     end
 
@@ -74,18 +84,35 @@ module Phrase
           self.reviewer_ids = value
         end
       end
+
+      if attributes.key?(:'translator_team_ids')
+        if (value = attributes[:'translator_team_ids']).is_a?(Array)
+          self.translator_team_ids = value
+        end
+      end
+
+      if attributes.key?(:'reviewer_team_ids')
+        if (value = attributes[:'reviewer_team_ids']).is_a?(Array)
+          self.reviewer_team_ids = 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
+      if @locale_id.nil?
+        invalid_properties.push('invalid value for "locale_id", locale_id 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 @locale_id.nil?
       true
     end
 
@@ -97,7 +124,9 @@ module Phrase
           branch == o.branch &&
           locale_id == o.locale_id &&
           user_ids == o.user_ids &&
-          reviewer_ids == o.reviewer_ids
+          reviewer_ids == o.reviewer_ids &&
+          translator_team_ids == o.translator_team_ids &&
+          reviewer_team_ids == o.reviewer_team_ids
     end
 
     # @see the `==` method
@@ -109,7 +138,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, locale_id, user_ids, reviewer_ids].hash
+      [branch, locale_id, user_ids, reviewer_ids, translator_team_ids, reviewer_team_ids].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/job_template_details.rb

@@ -0,0 +1,285 @@
+require 'date'
+
+module Phrase
+  class JobTemplateDetails
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :briefing
+
+    attr_accessor :project
+
+    attr_accessor :branch
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    attr_accessor :owner
+
+    attr_accessor :creator
+
+    attr_accessor :locales
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'briefing' => :'briefing',
+        :'project' => :'project',
+        :'branch' => :'branch',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at',
+        :'owner' => :'owner',
+        :'creator' => :'creator',
+        :'locales' => :'locales'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'briefing' => :'String',
+        :'project' => :'ProjectShort',
+        :'branch' => :'Branch',
+        :'created_at' => :'DateTime',
+        :'updated_at' => :'DateTime',
+        :'owner' => :'UserPreview',
+        :'creator' => :'UserPreview',
+        :'locales' => :'Array<LocalePreview>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'JobTemplate',
+      :'JobTemplateDetails1'
+      ]
+    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::JobTemplateDetails` 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::JobTemplateDetails`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'briefing')
+        self.briefing = attributes[:'briefing']
+      end
+
+      if attributes.key?(:'project')
+        self.project = attributes[:'project']
+      end
+
+      if attributes.key?(:'branch')
+        self.branch = attributes[:'branch']
+      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
+
+      if attributes.key?(:'owner')
+        self.owner = attributes[:'owner']
+      end
+
+      if attributes.key?(:'creator')
+        self.creator = attributes[:'creator']
+      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?
+    # @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 &&
+          name == o.name &&
+          briefing == o.briefing &&
+          project == o.project &&
+          branch == o.branch &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          owner == o.owner &&
+          creator == o.creator &&
+          locales == o.locales
+    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, name, briefing, project, branch, created_at, updated_at, owner, creator, locales].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