=begin
#Docusign eSignature REST API

#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.

OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Generated by: https://github.com/swagger-api/swagger-codegen.git

=end

require 'date'

module DocuSign_eSign
  # This request object contains information about the lock that you want to create or update.
  class LockRequest
    # The number of seconds to lock the envelope for editing.  Must be greater than 0 seconds.
    attr_accessor :lock_duration_in_seconds

    # A friendly name of the application used to lock the envelope.  Will be used in error messages to the user when lock conflicts occur.
    attr_accessor :locked_by_app

    # The type of envelope lock.  Currently \"edit\" is the only supported type.
    attr_accessor :lock_type

    # 
    attr_accessor :template_password

    # Reserved for future use.  Indicates whether a scratchpad is used for editing information.  
    attr_accessor :use_scratch_pad

    # Attribute mapping from ruby-style variable name to JSON key.
    def self.attribute_map
      {
        :'lock_duration_in_seconds' => :'lockDurationInSeconds',
        :'locked_by_app' => :'lockedByApp',
        :'lock_type' => :'lockType',
        :'template_password' => :'templatePassword',
        :'use_scratch_pad' => :'useScratchPad'
      }
    end

    # Attribute type mapping.
    def self.swagger_types
      {
        :'lock_duration_in_seconds' => :'String',
        :'locked_by_app' => :'String',
        :'lock_type' => :'String',
        :'template_password' => :'String',
        :'use_scratch_pad' => :'String'
      }
    end

    # Initializes the object
    # @param [Hash] attributes Model attributes in the form of hash
    def initialize(attributes = {})
      return unless attributes.is_a?(Hash)

      # convert string to symbol for hash key
      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

      if attributes.has_key?(:'lockDurationInSeconds')
        self.lock_duration_in_seconds = attributes[:'lockDurationInSeconds']
      end

      if attributes.has_key?(:'lockedByApp')
        self.locked_by_app = attributes[:'lockedByApp']
      end

      if attributes.has_key?(:'lockType')
        self.lock_type = attributes[:'lockType']
      end

      if attributes.has_key?(:'templatePassword')
        self.template_password = attributes[:'templatePassword']
      end

      if attributes.has_key?(:'useScratchPad')
        self.use_scratch_pad = attributes[:'useScratchPad']
      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 &&
          lock_duration_in_seconds == o.lock_duration_in_seconds &&
          locked_by_app == o.locked_by_app &&
          lock_type == o.lock_type &&
          template_password == o.template_password &&
          use_scratch_pad == o.use_scratch_pad
    end

    # @see the `==` method
    # @param [Object] Object to be compared
    def eql?(o)
      self == o
    end

    # Calculates hash code according to all attributes.
    # @return [Fixnum] Hash code
    def hash
      [lock_duration_in_seconds, locked_by_app, lock_type, template_password, use_scratch_pad].hash
    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.swagger_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
        temp_model = DocuSign_eSign.const_get(type).new
        temp_model.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)
        next if value.nil?
        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