phrase 2.5.1 → 2.7.1

data/lib/phrase/api/jobs_api.rb

@@ -390,6 +390,79 @@ module Phrase
       return response, status_code, headers
     end
 
+    # Lock a job
+    # If you are the job owner, you may lock a job using this API request.
+    # @param project_id [String] Project ID
+    # @param id [String] ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [String] :branch specify the branch to use
+    # @return [nil]
+    def job_lock(project_id, id, opts = {})
+      data, _status_code, _headers = job_lock_with_http_info(project_id, id, opts)
+      data
+    end
+
+    # Lock a job
+    # If you are the job owner, you may lock a job using this API request.
+    # @param project_id [String] Project ID
+    # @param id [String] ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [String] :branch specify the branch to use
+    # @return [Array<(Response, Integer, Hash)>] Response<(nil, response status code and response headers
+    def job_lock_with_http_info(project_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.job_lock ...'
+      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 JobsApi.job_lock"
+      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 JobsApi.job_lock"
+      end
+      # resource path
+      local_var_path = '/projects/{project_id}/jobs/{id}/lock'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      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] 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # 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: JobsApi#job_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+
     # Reopen a job
     # Mark a job as uncompleted.
     # @param project_id [String] Project ID
@@ -625,6 +698,79 @@ module Phrase
       return response, status_code, headers
     end
 
+    # Unlock a job
+    # If you are the job owner, you may unlock a locked job using this API request.
+    # @param project_id [String] Project ID
+    # @param id [String] ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [String] :branch specify the branch to use
+    # @return [nil]
+    def job_unlock(project_id, id, opts = {})
+      data, _status_code, _headers = job_unlock_with_http_info(project_id, id, opts)
+      data
+    end
+
+    # Unlock a job
+    # If you are the job owner, you may unlock a locked job using this API request.
+    # @param project_id [String] Project ID
+    # @param id [String] ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [String] :branch specify the branch to use
+    # @return [Array<(Response, Integer, Hash)>] Response<(nil, response status code and response headers
+    def job_unlock_with_http_info(project_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.job_unlock ...'
+      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 JobsApi.job_unlock"
+      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 JobsApi.job_unlock"
+      end
+      # resource path
+      local_var_path = '/projects/{project_id}/jobs/{id}/unlock'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      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] 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # 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: JobsApi#job_unlock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+
     # Update a job
     # Update an existing job.
     # @param project_id [String] Project ID

data/lib/phrase/api/screenshots_api.rb

@@ -10,23 +10,29 @@ module Phrase
     # Create a screenshot
     # Create a new screenshot.
     # @param project_id [String] Project ID
-    # @param screenshot_create_parameters [ScreenshotCreateParameters] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [String] :branch specify the branch to use
+    # @option opts [String] :name Name of the screenshot
+    # @option opts [String] :description Description of the screenshot
+    # @option opts [File] :filename Screenshot file
     # @return [Screenshot]
-    def screenshot_create(project_id, screenshot_create_parameters, opts = {})
-      data, _status_code, _headers = screenshot_create_with_http_info(project_id, screenshot_create_parameters, opts)
+    def screenshot_create(project_id, opts = {})
+      data, _status_code, _headers = screenshot_create_with_http_info(project_id, opts)
       data
     end
 
     # Create a screenshot
     # Create a new screenshot.
     # @param project_id [String] Project ID
-    # @param screenshot_create_parameters [ScreenshotCreateParameters] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [String] :branch specify the branch to use
+    # @option opts [String] :name Name of the screenshot
+    # @option opts [String] :description Description of the screenshot
+    # @option opts [File] :filename Screenshot file
     # @return [Array<(Response<(Screenshot)>, Integer, Hash)>] Response<(Screenshot)> data, response status code and response headers
-    def screenshot_create_with_http_info(project_id, screenshot_create_parameters, opts = {})
+    def screenshot_create_with_http_info(project_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ScreenshotsApi.screenshot_create ...'
       end
@@ -34,10 +40,6 @@ module Phrase
       if @api_client.config.client_side_validation && project_id.nil?
         fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotsApi.screenshot_create"
       end
-      # verify the required parameter 'screenshot_create_parameters' is set
-      if @api_client.config.client_side_validation && screenshot_create_parameters.nil?
-        fail ArgumentError, "Missing the required parameter 'screenshot_create_parameters' when calling ScreenshotsApi.screenshot_create"
-      end
       # resource path
       local_var_path = '/projects/{project_id}/screenshots'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
 
@@ -49,14 +51,18 @@ module Phrase
       # 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['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
       header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
+      form_params['branch'] = opts[:'branch'] if !opts[:'branch'].nil?
+      form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
+      form_params['description'] = opts[:'description'] if !opts[:'description'].nil?
+      form_params['filename'] = opts[:'filename'] if !opts[:'filename'].nil?
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(screenshot_create_parameters) 
+      post_body = opts[:body] 
 
       # return_type
       return_type = opts[:return_type] || 'Screenshot' 

data/lib/phrase/models/icu_skeleton_parameters.rb

@@ -8,6 +8,9 @@ module Phrase
     # Locale codes
     attr_accessor :locale_codes
 
+    # Keep the content and add missing plural forms for each locale
+    attr_accessor :keep_content
+
     # Indicates whether the zero form should be included or excluded in the returned skeletons
     attr_accessor :zero_form_enabled
 
@@ -16,6 +19,7 @@ module Phrase
       {
         :'content' => :'content',
         :'locale_codes' => :'locale_codes',
+        :'keep_content' => :'keep_content',
         :'zero_form_enabled' => :'zero_form_enabled'
       }
     end
@@ -25,6 +29,7 @@ module Phrase
       {
         :'content' => :'String',
         :'locale_codes' => :'Array<String>',
+        :'keep_content' => :'Boolean',
         :'zero_form_enabled' => :'Boolean'
       }
     end
@@ -60,6 +65,10 @@ module Phrase
         end
       end
 
+      if attributes.key?(:'keep_content')
+        self.keep_content = attributes[:'keep_content']
+      end
+
       if attributes.key?(:'zero_form_enabled')
         self.zero_form_enabled = attributes[:'zero_form_enabled']
       end
@@ -85,6 +94,7 @@ module Phrase
       self.class == o.class &&
           content == o.content &&
           locale_codes == o.locale_codes &&
+          keep_content == o.keep_content &&
           zero_form_enabled == o.zero_form_enabled
     end
 
@@ -97,7 +107,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content, locale_codes, zero_form_enabled].hash
+      [content, locale_codes, keep_content, zero_form_enabled].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/invitation.rb

@@ -14,6 +14,8 @@ module Phrase
 
     attr_accessor :locales
 
+    attr_accessor :teams
+
     attr_accessor :default_locale_codes
 
     attr_accessor :permissions
@@ -28,8 +30,6 @@ module Phrase
 
     attr_accessor :spaces
 
-    attr_accessor :teams
-
     attr_accessor :project_role
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -41,6 +41,7 @@ module Phrase
         :'state' => :'state',
         :'projects' => :'projects',
         :'locales' => :'locales',
+        :'teams' => :'teams',
         :'default_locale_codes' => :'default_locale_codes',
         :'permissions' => :'permissions',
         :'locale_ids' => :'locale_ids',
@@ -48,7 +49,6 @@ module Phrase
         :'updated_at' => :'updated_at',
         :'accepted_at' => :'accepted_at',
         :'spaces' => :'spaces',
-        :'teams' => :'teams',
         :'project_role' => :'project_role'
       }
     end
@@ -62,14 +62,14 @@ module Phrase
         :'state' => :'String',
         :'projects' => :'Array<ProjectShort>',
         :'locales' => :'Array<LocalePreview>',
+        :'teams' => :'Array<TeamShort>',
         :'default_locale_codes' => :'Array<String>',
         :'permissions' => :'Object',
         :'locale_ids' => :'Array<String>',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
         :'accepted_at' => :'DateTime',
-        :'spaces' => :'Array<MemberSpaces>',
-        :'teams' => :'Array<Items>',
+        :'spaces' => :'Array<Space>',
         :'project_role' => :'Array<MemberProjectDetailProjectRoles>'
       }
     end
@@ -123,6 +123,12 @@ module Phrase
         end
       end
 
+      if attributes.key?(:'teams')
+        if (value = attributes[:'teams']).is_a?(Array)
+          self.teams = value
+        end
+      end
+
       if attributes.key?(:'default_locale_codes')
         if (value = attributes[:'default_locale_codes']).is_a?(Array)
           self.default_locale_codes = value
@@ -157,12 +163,6 @@ module Phrase
         end
       end
 
-      if attributes.key?(:'teams')
-        if (value = attributes[:'teams']).is_a?(Array)
-          self.teams = value
-        end
-      end
-
       if attributes.key?(:'project_role')
         if (value = attributes[:'project_role']).is_a?(Array)
           self.project_role = value
@@ -194,6 +194,7 @@ module Phrase
           state == o.state &&
           projects == o.projects &&
           locales == o.locales &&
+          teams == o.teams &&
           default_locale_codes == o.default_locale_codes &&
           permissions == o.permissions &&
           locale_ids == o.locale_ids &&
@@ -201,7 +202,6 @@ module Phrase
           updated_at == o.updated_at &&
           accepted_at == o.accepted_at &&
           spaces == o.spaces &&
-          teams == o.teams &&
           project_role == o.project_role
     end
 
@@ -214,7 +214,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, email, role, state, projects, locales, default_locale_codes, permissions, locale_ids, created_at, updated_at, accepted_at, spaces, teams, project_role].hash
+      [id, email, role, state, projects, locales, teams, default_locale_codes, permissions, locale_ids, created_at, updated_at, accepted_at, spaces, project_role].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/job_comment.rb

@@ -0,0 +1,250 @@
+require 'date'
+
+module Phrase
+  class JobComment
+    attr_accessor :id
+
+    attr_accessor :message
+
+    attr_accessor :job_id
+
+    attr_accessor :user
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    attr_accessor :mentioned_users
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'message' => :'message',
+        :'job_id' => :'job_id',
+        :'user' => :'user',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at',
+        :'mentioned_users' => :'mentioned_users'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'message' => :'String',
+        :'job_id' => :'String',
+        :'user' => :'UserPreview',
+        :'created_at' => :'DateTime',
+        :'updated_at' => :'DateTime',
+        :'mentioned_users' => :'Array<UserPreview>'
+      }
+    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::JobComment` 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::JobComment`. 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?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'job_id')
+        self.job_id = attributes[:'job_id']
+      end
+
+      if attributes.key?(:'user')
+        self.user = attributes[:'user']
+      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?(:'mentioned_users')
+        if (value = attributes[:'mentioned_users']).is_a?(Array)
+          self.mentioned_users = 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 &&
+          message == o.message &&
+          job_id == o.job_id &&
+          user == o.user &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          mentioned_users == o.mentioned_users
+    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, message, job_id, user, created_at, updated_at, mentioned_users].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