phrase 4.16.0 → 4.17.0

data/lib/phrase/models/upload_batch.rb

@@ -0,0 +1,288 @@
+require 'date'
+
+module Phrase
+  class UploadBatch
+    # Processing state of the upload batch
+    attr_accessor :state
+
+    # Indicates whether unmentioned keys will be deleted after processing all uploads in the batch
+    attr_accessor :delete_unmentioned_keys
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    attr_accessor :project
+
+    attr_accessor :user
+
+    attr_accessor :uploads
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'state' => :'state',
+        :'delete_unmentioned_keys' => :'delete_unmentioned_keys',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at',
+        :'project' => :'project',
+        :'user' => :'user',
+        :'uploads' => :'uploads'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'state' => :'String',
+        :'delete_unmentioned_keys' => :'Boolean',
+        :'created_at' => :'DateTime',
+        :'updated_at' => :'DateTime',
+        :'project' => :'ProjectShort',
+        :'user' => :'UserPreview',
+        :'uploads' => :'Array<Upload>'
+      }
+    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::UploadBatch` 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::UploadBatch`. 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?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'delete_unmentioned_keys')
+        self.delete_unmentioned_keys = attributes[:'delete_unmentioned_keys']
+      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?(:'project')
+        self.project = attributes[:'project']
+      end
+
+      if attributes.key?(:'user')
+        self.user = attributes[:'user']
+      end
+
+      if attributes.key?(:'uploads')
+        if (value = attributes[:'uploads']).is_a?(Array)
+          self.uploads = 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?
+      state_validator = EnumAttributeValidator.new('String', ["started", "done"])
+      return false unless state_validator.valid?(@state)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["started", "done"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    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 &&
+          state == o.state &&
+          delete_unmentioned_keys == o.delete_unmentioned_keys &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          project == o.project &&
+          user == o.user &&
+          uploads == o.uploads
+    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
+      [state, delete_unmentioned_keys, created_at, updated_at, project, user, uploads].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/upload_batches_create_parameters.rb

@@ -0,0 +1,224 @@
+require 'date'
+
+module Phrase
+  class UploadBatchesCreateParameters
+    # specify the branch to use
+    attr_accessor :branch
+
+    # If set to true, after all uploads in the batch are completed, translation keys that were not mentioned in any of the uploaded files will be deleted.
+    attr_accessor :delete_unmentioned_keys
+
+    # Array of upload IDs to include in the batch
+    attr_accessor :upload_ids
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'branch' => :'branch',
+        :'delete_unmentioned_keys' => :'delete_unmentioned_keys',
+        :'upload_ids' => :'upload_ids'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'branch' => :'String',
+        :'delete_unmentioned_keys' => :'Boolean',
+        :'upload_ids' => :'Array<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::UploadBatchesCreateParameters` 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::UploadBatchesCreateParameters`. 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?(:'branch')
+        self.branch = attributes[:'branch']
+      end
+
+      if attributes.key?(:'delete_unmentioned_keys')
+        self.delete_unmentioned_keys = attributes[:'delete_unmentioned_keys']
+      end
+
+      if attributes.key?(:'upload_ids')
+        if (value = attributes[:'upload_ids']).is_a?(Array)
+          self.upload_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 @upload_ids.nil?
+        invalid_properties.push('invalid value for "upload_ids", upload_ids 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 @upload_ids.nil?
+      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 &&
+          branch == o.branch &&
+          delete_unmentioned_keys == o.delete_unmentioned_keys &&
+          upload_ids == o.upload_ids
+    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
+      [branch, delete_unmentioned_keys, upload_ids].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/version.rb

@@ -1,3 +1,3 @@
 module Phrase
-  VERSION = '4.16.0'
+  VERSION = '4.17.0'
 end

data/lib/phrase.rb

@@ -164,6 +164,8 @@ require 'phrase/models/release_update_parameters'
 require 'phrase/models/release_update_parameters1'
 require 'phrase/models/repo_sync'
 require 'phrase/models/repo_sync_event'
+require 'phrase/models/repo_sync_export_parameters'
+require 'phrase/models/repo_sync_import_parameters'
 require 'phrase/models/screenshot'
 require 'phrase/models/screenshot_marker'
 require 'phrase/models/screenshot_marker_create_parameters'
@@ -218,6 +220,8 @@ require 'phrase/models/translations_unreview_parameters'
 require 'phrase/models/translations_unverify_parameters'
 require 'phrase/models/translations_verify_parameters'
 require 'phrase/models/upload'
+require 'phrase/models/upload_batch'
+require 'phrase/models/upload_batches_create_parameters'
 require 'phrase/models/upload_summary'
 require 'phrase/models/user'
 require 'phrase/models/user_preview'
@@ -280,6 +284,7 @@ require 'phrase/api/style_guides_api'
 require 'phrase/api/tags_api'
 require 'phrase/api/teams_api'
 require 'phrase/api/translations_api'
+require 'phrase/api/upload_batches_api'
 require 'phrase/api/uploads_api'
 require 'phrase/api/users_api'
 require 'phrase/api/variables_api'

data/spec/api/repo_syncs_api_spec.rb

@@ -55,6 +55,7 @@ describe 'RepoSyncsApi' do
   # @param id ID
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @option opts [RepoSyncExportParameters] :repo_sync_export_parameters 
   # @return [RepoSyncEvent]
   describe 'repo_sync_export test' do
     it 'should work' do
@@ -69,6 +70,8 @@ describe 'RepoSyncsApi' do
   # @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 Branch to use
+  # @option opts [RepoSyncImportParameters] :repo_sync_import_parameters 
   # @return [RepoSyncEvent]
   describe 'repo_sync_import test' do
     it 'should work' do

data/spec/api/upload_batches_api_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Phrase::UploadBatchesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UploadBatchesApi' do
+  before do
+    # run before each test
+    @api_instance = Phrase::UploadBatchesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UploadBatchesApi' do
+    it 'should create an instance of UploadBatchesApi' do
+      expect(@api_instance).to be_instance_of(Phrase::UploadBatchesApi)
+    end
+  end
+
+  # unit tests for upload_batches_create
+  # Create upload batch
+  # Groups multiple file uploads into a single batch. Optionally, launches the deletion of unmentioned translation keys after all uploads in the batch are completed. 
+  # @param project_id Project ID
+  # @param upload_batches_create_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [UploadBatch]
+  describe 'upload_batches_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/versions_history_api_spec.rb

@@ -46,7 +46,8 @@ describe 'VersionsHistoryApi' do
   # @option opts [Integer] :page Page number
   # @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>]
+  # @option opts [Boolean] :only_content_updates Indicates whether only content updates should be returned
+  # @return [Array<TranslationVersionWithUser>]
   describe 'versions_list test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/locale_preview1_spec.rb

@@ -32,10 +32,4 @@ describe 'LocalePreview1' do
     end
   end
 
-  describe 'test attribute "project"' 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/repo_sync_export_parameters_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Phrase::RepoSyncExportParameters
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RepoSyncExportParameters' do
+  before do
+    # run before each test
+    @instance = Phrase::RepoSyncExportParameters.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RepoSyncExportParameters' do
+    it 'should create an instance of RepoSyncExportParameters' do
+      expect(@instance).to be_instance_of(Phrase::RepoSyncExportParameters)
+    end
+  end
+  describe 'test attribute "pr_branch"' 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/repo_sync_import_parameters_spec.rb

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