phrase 2.3.1 → 2.6.0

data/lib/phrase/api/icu_api.rb

@@ -0,0 +1,78 @@
+require 'cgi'
+
+module Phrase
+  class ICUApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Build icu skeletons
+    # Returns icu skeletons for multiple locale codes based on a source content.
+    # @param icu_skeleton_parameters [IcuSkeletonParameters] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [Icu]
+    def icu_skeleton(icu_skeleton_parameters, opts = {})
+      data, _status_code, _headers = icu_skeleton_with_http_info(icu_skeleton_parameters, opts)
+      data
+    end
+
+    # Build icu skeletons
+    # Returns icu skeletons for multiple locale codes based on a source content.
+    # @param icu_skeleton_parameters [IcuSkeletonParameters] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [Array<(Response<(Icu)>, Integer, Hash)>] Response<(Icu)> data, response status code and response headers
+    def icu_skeleton_with_http_info(icu_skeleton_parameters, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ICUApi.icu_skeleton ...'
+      end
+      # verify the required parameter 'icu_skeleton_parameters' is set
+      if @api_client.config.client_side_validation && icu_skeleton_parameters.nil?
+        fail ArgumentError, "Missing the required parameter 'icu_skeleton_parameters' when calling ICUApi.icu_skeleton"
+      end
+      # resource path
+      local_var_path = '/icu/skeleton'
+
+      # 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(icu_skeleton_parameters) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Icu' 
+
+      # 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: ICUApi#icu_skeleton\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/api/job_locales_api.rb

@@ -93,6 +93,92 @@ module Phrase
       return response, status_code, headers
     end
 
+    # Review a job locale
+    # Mark job locale as reviewed.
+    # @param project_id [String] Project ID
+    # @param job_id [String] Job ID
+    # @param id [String] ID
+    # @param job_locale_complete_review_parameters [JobLocaleCompleteReviewParameters] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [JobLocale]
+    def job_locale_complete_review(project_id, job_id, id, job_locale_complete_review_parameters, opts = {})
+      data, _status_code, _headers = job_locale_complete_review_with_http_info(project_id, job_id, id, job_locale_complete_review_parameters, opts)
+      data
+    end
+
+    # Review a job locale
+    # Mark job locale as reviewed.
+    # @param project_id [String] Project ID
+    # @param job_id [String] Job ID
+    # @param id [String] ID
+    # @param job_locale_complete_review_parameters [JobLocaleCompleteReviewParameters] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [Array<(Response<(JobLocale)>, Integer, Hash)>] Response<(JobLocale)> data, response status code and response headers
+    def job_locale_complete_review_with_http_info(project_id, job_id, id, job_locale_complete_review_parameters, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locale_complete_review ...'
+      end
+      # verify the required parameter 'project_id' is set
+      if @api_client.config.client_side_validation && project_id.nil?
+        fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locale_complete_review"
+      end
+      # verify the required parameter 'job_id' is set
+      if @api_client.config.client_side_validation && job_id.nil?
+        fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locale_complete_review"
+      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 JobLocalesApi.job_locale_complete_review"
+      end
+      # verify the required parameter 'job_locale_complete_review_parameters' is set
+      if @api_client.config.client_side_validation && job_locale_complete_review_parameters.nil?
+        fail ArgumentError, "Missing the required parameter 'job_locale_complete_review_parameters' when calling JobLocalesApi.job_locale_complete_review"
+      end
+      # resource path
+      local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{id}/complete_review'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).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(job_locale_complete_review_parameters) 
+
+      # return_type
+      return_type = opts[:return_type] || 'JobLocale' 
+
+      # 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: JobLocalesApi#job_locale_complete_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+
     # Delete a job locale
     # Delete an existing job locale.
     # @param project_id [String] Project ID

data/lib/phrase/models/distribution.rb

@@ -10,6 +10,8 @@ module Phrase
 
     attr_accessor :platforms
 
+    attr_accessor :locales
+
     attr_accessor :releases
 
     attr_accessor :created_at
@@ -23,6 +25,7 @@ module Phrase
         :'name' => :'name',
         :'project' => :'project',
         :'platforms' => :'platforms',
+        :'locales' => :'locales',
         :'releases' => :'releases',
         :'created_at' => :'created_at',
         :'deleted_at' => :'deleted_at'
@@ -36,6 +39,7 @@ module Phrase
         :'name' => :'String',
         :'project' => :'ProjectShort',
         :'platforms' => :'Array<String>',
+        :'locales' => :'Array<LocalePreview>',
         :'releases' => :'Array<ReleasePreview>',
         :'created_at' => :'DateTime',
         :'deleted_at' => :'DateTime'
@@ -81,6 +85,12 @@ module Phrase
         end
       end
 
+      if attributes.key?(:'locales')
+        if (value = attributes[:'locales']).is_a?(Array)
+          self.locales = value
+        end
+      end
+
       if attributes.key?(:'releases')
         if (value = attributes[:'releases']).is_a?(Array)
           self.releases = value
@@ -118,6 +128,7 @@ module Phrase
           name == o.name &&
           project == o.project &&
           platforms == o.platforms &&
+          locales == o.locales &&
           releases == o.releases &&
           created_at == o.created_at &&
           deleted_at == o.deleted_at
@@ -132,7 +143,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, project, platforms, releases, created_at, deleted_at].hash
+      [id, name, project, platforms, locales, releases, created_at, deleted_at].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/distribution_create_parameters.rb

@@ -11,6 +11,9 @@ module Phrase
     # List of platforms the distribution should support.
     attr_accessor :platforms
 
+    # List of locale ids that will be part of distribution releases
+    attr_accessor :locale_ids
+
     # Additional formatting and render options. Only <code>enclose_in_cdata</code> is available for platform <code>android</code>.
     attr_accessor :format_options
 
@@ -29,6 +32,7 @@ module Phrase
         :'name' => :'name',
         :'project_id' => :'project_id',
         :'platforms' => :'platforms',
+        :'locale_ids' => :'locale_ids',
         :'format_options' => :'format_options',
         :'fallback_to_non_regional_locale' => :'fallback_to_non_regional_locale',
         :'fallback_to_default_locale' => :'fallback_to_default_locale',
@@ -42,6 +46,7 @@ module Phrase
         :'name' => :'String',
         :'project_id' => :'String',
         :'platforms' => :'Array<String>',
+        :'locale_ids' => :'Array<String>',
         :'format_options' => :'Hash<String, String>',
         :'fallback_to_non_regional_locale' => :'Boolean',
         :'fallback_to_default_locale' => :'Boolean',
@@ -84,6 +89,12 @@ module Phrase
         end
       end
 
+      if attributes.key?(:'locale_ids')
+        if (value = attributes[:'locale_ids']).is_a?(Array)
+          self.locale_ids = value
+        end
+      end
+
       if attributes.key?(:'format_options')
         if (value = attributes[:'format_options']).is_a?(Hash)
           self.format_options = value
@@ -124,6 +135,7 @@ module Phrase
           name == o.name &&
           project_id == o.project_id &&
           platforms == o.platforms &&
+          locale_ids == o.locale_ids &&
           format_options == o.format_options &&
           fallback_to_non_regional_locale == o.fallback_to_non_regional_locale &&
           fallback_to_default_locale == o.fallback_to_default_locale &&
@@ -139,7 +151,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, project_id, platforms, format_options, fallback_to_non_regional_locale, fallback_to_default_locale, use_last_reviewed_version].hash
+      [name, project_id, platforms, locale_ids, format_options, fallback_to_non_regional_locale, fallback_to_default_locale, use_last_reviewed_version].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/distribution_update_parameters.rb

@@ -11,6 +11,9 @@ module Phrase
     # List of platforms the distribution should support.
     attr_accessor :platforms
 
+    # List of locale ids that will be part of distribution releases
+    attr_accessor :locale_ids
+
     # Additional formatting and render options. Only <code>enclose_in_cdata</code> is available for platform <code>android</code>.
     attr_accessor :format_options
 
@@ -29,6 +32,7 @@ module Phrase
         :'name' => :'name',
         :'project_id' => :'project_id',
         :'platforms' => :'platforms',
+        :'locale_ids' => :'locale_ids',
         :'format_options' => :'format_options',
         :'fallback_to_non_regional_locale' => :'fallback_to_non_regional_locale',
         :'fallback_to_default_locale' => :'fallback_to_default_locale',
@@ -42,6 +46,7 @@ module Phrase
         :'name' => :'String',
         :'project_id' => :'String',
         :'platforms' => :'Array<String>',
+        :'locale_ids' => :'Array<String>',
         :'format_options' => :'Hash<String, String>',
         :'fallback_to_non_regional_locale' => :'Boolean',
         :'fallback_to_default_locale' => :'Boolean',
@@ -84,6 +89,12 @@ module Phrase
         end
       end
 
+      if attributes.key?(:'locale_ids')
+        if (value = attributes[:'locale_ids']).is_a?(Array)
+          self.locale_ids = value
+        end
+      end
+
       if attributes.key?(:'format_options')
         if (value = attributes[:'format_options']).is_a?(Hash)
           self.format_options = value
@@ -124,6 +135,7 @@ module Phrase
           name == o.name &&
           project_id == o.project_id &&
           platforms == o.platforms &&
+          locale_ids == o.locale_ids &&
           format_options == o.format_options &&
           fallback_to_non_regional_locale == o.fallback_to_non_regional_locale &&
           fallback_to_default_locale == o.fallback_to_default_locale &&
@@ -139,7 +151,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, project_id, platforms, format_options, fallback_to_non_regional_locale, fallback_to_default_locale, use_last_reviewed_version].hash
+      [name, project_id, platforms, locale_ids, format_options, fallback_to_non_regional_locale, fallback_to_default_locale, use_last_reviewed_version].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/icu.rb

@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+  class Icu
+    # Object keys are dynamic and based on requested locale codes, see example.
+    attr_accessor :locale_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'locale_code' => :'locale_code'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'locale_code' => :'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::Icu` 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::Icu`. 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?(:'locale_code')
+        self.locale_code = attributes[:'locale_code']
+      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 &&
+          locale_code == o.locale_code
+    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
+      [locale_code].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