phrase 2.21.0 → 2.22.0

data/lib/phrase/api/custom_metadata_api.rb

@@ -164,31 +164,23 @@ module Phrase
     # Create a property
     # Create a new custom metadata property.
     # @param account_id [String] Account ID
-    # @param name [String] name of the property
-    # @param data_type [CustomMetadataDataType] Data Type of Custom Metadata Property
+    # @param custom_metadata_properties_create_parameters [CustomMetadataPropertiesCreateParameters] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
-    # @option opts [String] :description description of property
-    # @option opts [Array<String>] :project_ids ids of projects that the property belongs to
-    # @option opts [Array<String>] :value_options value options of property (only applies to single or multi select properties)
     # @return [CustomMetadataProperty]
-    def custom_metadata_property_create(account_id, name, data_type, opts = {})
-      data, _status_code, _headers = custom_metadata_property_create_with_http_info(account_id, name, data_type, opts)
+    def custom_metadata_property_create(account_id, custom_metadata_properties_create_parameters, opts = {})
+      data, _status_code, _headers = custom_metadata_property_create_with_http_info(account_id, custom_metadata_properties_create_parameters, opts)
       data
     end
 
     # Create a property
     # Create a new custom metadata property.
     # @param account_id [String] Account ID
-    # @param name [String] name of the property
-    # @param data_type [CustomMetadataDataType] Data Type of Custom Metadata Property
+    # @param custom_metadata_properties_create_parameters [CustomMetadataPropertiesCreateParameters] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
-    # @option opts [String] :description description of property
-    # @option opts [Array<String>] :project_ids ids of projects that the property belongs to
-    # @option opts [Array<String>] :value_options value options of property (only applies to single or multi select properties)
     # @return [Array<(Response<(CustomMetadataProperty)>, Integer, Hash)>] Response<(CustomMetadataProperty)> data, response status code and response headers
-    def custom_metadata_property_create_with_http_info(account_id, name, data_type, opts = {})
+    def custom_metadata_property_create_with_http_info(account_id, custom_metadata_properties_create_parameters, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: CustomMetadataApi.custom_metadata_property_create ...'
       end
@@ -196,36 +188,29 @@ module Phrase
       if @api_client.config.client_side_validation && account_id.nil?
         fail ArgumentError, "Missing the required parameter 'account_id' when calling CustomMetadataApi.custom_metadata_property_create"
       end
-      # verify the required parameter 'name' is set
-      if @api_client.config.client_side_validation && name.nil?
-        fail ArgumentError, "Missing the required parameter 'name' when calling CustomMetadataApi.custom_metadata_property_create"
-      end
-      # verify the required parameter 'data_type' is set
-      if @api_client.config.client_side_validation && data_type.nil?
-        fail ArgumentError, "Missing the required parameter 'data_type' when calling CustomMetadataApi.custom_metadata_property_create"
+      # verify the required parameter 'custom_metadata_properties_create_parameters' is set
+      if @api_client.config.client_side_validation && custom_metadata_properties_create_parameters.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_metadata_properties_create_parameters' when calling CustomMetadataApi.custom_metadata_property_create"
       end
       # resource path
       local_var_path = '/accounts/{account_id}/custom_metadata/properties'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'name'] = name
-      query_params[:'data_type'] = data_type
-      query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
-      query_params[:'project_ids'] = @api_client.build_collection_param(opts[:'project_ids'], :multi) if !opts[:'project_ids'].nil?
-      query_params[:'value_options'] = @api_client.build_collection_param(opts[:'value_options'], :multi) if !opts[:'value_options'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:body] || @api_client.object_to_http_body(custom_metadata_properties_create_parameters) 
 
       # return_type
       return_type = opts[:return_type] || 'CustomMetadataProperty' 
@@ -326,15 +311,12 @@ module Phrase
     # Update an existing custom metadata property.
     # @param account_id [String] Account ID
     # @param id [String] ID
+    # @param custom_metadata_properties_update_parameters [CustomMetadataPropertiesUpdateParameters] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
-    # @option opts [String] :name name of the property
-    # @option opts [String] :description description of property
-    # @option opts [Array<String>] :project_ids ids of projects that the property belongs to
-    # @option opts [Array<String>] :value_options value options of property (only applies to single or multi select properties)
     # @return [CustomMetadataProperty]
-    def custom_metadata_property_update(account_id, id, opts = {})
-      data, _status_code, _headers = custom_metadata_property_update_with_http_info(account_id, id, opts)
+    def custom_metadata_property_update(account_id, id, custom_metadata_properties_update_parameters, opts = {})
+      data, _status_code, _headers = custom_metadata_property_update_with_http_info(account_id, id, custom_metadata_properties_update_parameters, opts)
       data
     end
 
@@ -342,14 +324,11 @@ module Phrase
     # Update an existing custom metadata property.
     # @param account_id [String] Account ID
     # @param id [String] ID
+    # @param custom_metadata_properties_update_parameters [CustomMetadataPropertiesUpdateParameters] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
-    # @option opts [String] :name name of the property
-    # @option opts [String] :description description of property
-    # @option opts [Array<String>] :project_ids ids of projects that the property belongs to
-    # @option opts [Array<String>] :value_options value options of property (only applies to single or multi select properties)
     # @return [Array<(Response<(CustomMetadataProperty)>, Integer, Hash)>] Response<(CustomMetadataProperty)> data, response status code and response headers
-    def custom_metadata_property_update_with_http_info(account_id, id, opts = {})
+    def custom_metadata_property_update_with_http_info(account_id, id, custom_metadata_properties_update_parameters, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: CustomMetadataApi.custom_metadata_property_update ...'
       end
@@ -361,27 +340,29 @@ module Phrase
       if @api_client.config.client_side_validation && id.nil?
         fail ArgumentError, "Missing the required parameter 'id' when calling CustomMetadataApi.custom_metadata_property_update"
       end
+      # verify the required parameter 'custom_metadata_properties_update_parameters' is set
+      if @api_client.config.client_side_validation && custom_metadata_properties_update_parameters.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_metadata_properties_update_parameters' when calling CustomMetadataApi.custom_metadata_property_update"
+      end
       # resource path
       local_var_path = '/accounts/{account_id}/custom_metadata/properties/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
-      query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
-      query_params[:'project_ids'] = @api_client.build_collection_param(opts[:'project_ids'], :multi) if !opts[:'project_ids'].nil?
-      query_params[:'value_options'] = @api_client.build_collection_param(opts[:'value_options'], :multi) if !opts[:'value_options'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:body] || @api_client.object_to_http_body(custom_metadata_properties_update_parameters) 
 
       # return_type
       return_type = opts[:return_type] || 'CustomMetadataProperty' 

data/lib/phrase/api/quality_performance_score_api.rb

@@ -0,0 +1,84 @@
+require 'cgi'
+
+module Phrase
+  class QualityPerformanceScoreApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get project's translations' quality performance scores
+    # Get project's translations' quality performance scores
+    # @param id [String] ID
+    # @param projects_quality_performance_score_request [ProjectsQualityPerformanceScoreRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [ProjectsQualityPerformanceScore200Response]
+    def projects_quality_performance_score(id, projects_quality_performance_score_request, opts = {})
+      data, _status_code, _headers = projects_quality_performance_score_with_http_info(id, projects_quality_performance_score_request, opts)
+      data
+    end
+
+    # Get project's translations' quality performance scores
+    # Get project's translations' quality performance scores
+    # @param id [String] ID
+    # @param projects_quality_performance_score_request [ProjectsQualityPerformanceScoreRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [Array<(Response<(ProjectsQualityPerformanceScore200Response)>, Integer, Hash)>] Response<(ProjectsQualityPerformanceScore200Response)> data, response status code and response headers
+    def projects_quality_performance_score_with_http_info(id, projects_quality_performance_score_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: QualityPerformanceScoreApi.projects_quality_performance_score ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling QualityPerformanceScoreApi.projects_quality_performance_score"
+      end
+      # verify the required parameter 'projects_quality_performance_score_request' is set
+      if @api_client.config.client_side_validation && projects_quality_performance_score_request.nil?
+        fail ArgumentError, "Missing the required parameter 'projects_quality_performance_score_request' when calling QualityPerformanceScoreApi.projects_quality_performance_score"
+      end
+      # resource path
+      local_var_path = '/projects/{id}/quality_performance_score'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(projects_quality_performance_score_request) 
+
+      # return_type
+      return_type = opts[:return_type] || 'ProjectsQualityPerformanceScore200Response' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: QualityPerformanceScoreApi#projects_quality_performance_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+  end
+end

data/lib/phrase/models/custom_metadata_properties_create_parameters.rb

@@ -0,0 +1,272 @@
+require 'date'
+
+module Phrase
+  class CustomMetadataPropertiesCreateParameters
+    # name of the property
+    attr_accessor :name
+
+    attr_accessor :data_type
+
+    # ids of projects that the property belongs to
+    attr_accessor :project_ids
+
+    # description of property
+    attr_accessor :description
+
+    # value options of property (only applies to single or multi select properties)
+    attr_accessor :value_options
+
+    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
+      {
+        :'name' => :'name',
+        :'data_type' => :'data_type',
+        :'project_ids' => :'project_ids',
+        :'description' => :'description',
+        :'value_options' => :'value_options'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'data_type' => :'CustomMetadataDataType',
+        :'project_ids' => :'Array<String>',
+        :'description' => :'String',
+        :'value_options' => :'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::CustomMetadataPropertiesCreateParameters` 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::CustomMetadataPropertiesCreateParameters`. 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?(:'data_type')
+        self.data_type = attributes[:'data_type']
+      end
+
+      if attributes.key?(:'project_ids')
+        if (value = attributes[:'project_ids']).is_a?(Array)
+          self.project_ids = value
+        end
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'value_options')
+        if (value = attributes[:'value_options']).is_a?(Array)
+          self.value_options = 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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @data_type.nil?
+        invalid_properties.push('invalid value for "data_type", data_type 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?
+      return false if @data_type.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 &&
+          name == o.name &&
+          data_type == o.data_type &&
+          project_ids == o.project_ids &&
+          description == o.description &&
+          value_options == o.value_options
+    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, data_type, project_ids, description, value_options].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