=begin
#Dropbox Sign API

#Dropbox Sign v3 API

The version of the OpenAPI document: 3.0.0
Contact: apisupport@hellosign.com
Generated by: https://openapi-generator.tech
Generator version: 7.8.0

=end

require 'date'
require 'time'

module Dropbox
end

module Dropbox::Sign
  # Contains information about the templates you and your team have created.
  class TemplateResponse
    # The id of the Template.
    # @return [String]
    attr_accessor :template_id

    # The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.
    # @return [String]
    attr_accessor :title

    # The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.
    # @return [String]
    attr_accessor :message

    # Time the template was last updated.
    # @return [Integer]
    attr_accessor :updated_at

    # `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.
    # @return [Boolean, nil]
    attr_accessor :is_embedded

    # `true` if you are the owner of this template, `false` if it's been shared with you by a team member.
    # @return [Boolean]
    attr_accessor :is_creator

    # Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).
    # @return [Boolean]
    attr_accessor :can_edit

    # Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.
    # @return [Boolean]
    attr_accessor :is_locked

    # The metadata attached to the template.
    # @return [Hash<String, Object>]
    attr_accessor :metadata

    # An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
    # @return [Array<TemplateResponseSignerRole>]
    attr_accessor :signer_roles

    # An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
    # @return [Array<TemplateResponseCCRole>]
    attr_accessor :cc_roles

    # An array describing each document associated with this Template. Includes form field data for each document.
    # @return [Array<TemplateResponseDocument>]
    attr_accessor :documents

    # Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
    # @return [Array<TemplateResponseDocumentCustomFieldBase>, nil]
    attr_accessor :custom_fields

    # Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
    # @return [Array<TemplateResponseDocumentFormFieldBase>, nil]
    attr_accessor :named_form_fields

    # An array of the Accounts that can use this Template.
    # @return [Array<TemplateResponseAccount>]
    attr_accessor :accounts

    # Signer attachments.
    # @return [Array<SignatureRequestResponseAttachment>]
    attr_accessor :attachments

    # Attribute mapping from ruby-style variable name to JSON key.
    def self.attribute_map
      {
        :'template_id' => :'template_id',
        :'title' => :'title',
        :'message' => :'message',
        :'updated_at' => :'updated_at',
        :'is_embedded' => :'is_embedded',
        :'is_creator' => :'is_creator',
        :'can_edit' => :'can_edit',
        :'is_locked' => :'is_locked',
        :'metadata' => :'metadata',
        :'signer_roles' => :'signer_roles',
        :'cc_roles' => :'cc_roles',
        :'documents' => :'documents',
        :'custom_fields' => :'custom_fields',
        :'named_form_fields' => :'named_form_fields',
        :'accounts' => :'accounts',
        :'attachments' => :'attachments'
      }
    end

    # Returns all the JSON keys this model knows about
    def self.acceptable_attributes
      attribute_map.values
    end

    # Attribute type mapping.
    def self.openapi_types
      {
        :'template_id' => :'String',
        :'title' => :'String',
        :'message' => :'String',
        :'updated_at' => :'Integer',
        :'is_embedded' => :'Boolean',
        :'is_creator' => :'Boolean',
        :'can_edit' => :'Boolean',
        :'is_locked' => :'Boolean',
        :'metadata' => :'Hash<String, Object>',
        :'signer_roles' => :'Array<TemplateResponseSignerRole>',
        :'cc_roles' => :'Array<TemplateResponseCCRole>',
        :'documents' => :'Array<TemplateResponseDocument>',
        :'custom_fields' => :'Array<TemplateResponseDocumentCustomFieldBase>',
        :'named_form_fields' => :'Array<TemplateResponseDocumentFormFieldBase>',
        :'accounts' => :'Array<TemplateResponseAccount>',
        :'attachments' => :'Array<SignatureRequestResponseAttachment>'
      }
    end

    # List of attributes with nullable: true
    def self.openapi_nullable
      Set.new([
        :'is_embedded',
        :'custom_fields',
        :'named_form_fields',
      ])
    end

    # Returns attribute map of this model + parent
    def self.merged_attributes
      self.attribute_map
    end

    # Attribute type mapping of this model + parent
    def self.merged_types
      self.openapi_types
    end

    # Returns list of attributes with nullable: true of this model + parent
    def self.merged_nullable
      self.openapi_nullable
    end

    # Attempt to instantiate and hydrate a new instance of this class
    # @param [Object] data Data to be converted
    # @return [TemplateResponse]
    def self.init(data)
      ApiClient.default.convert_to_type(
        data,
        "TemplateResponse"
      ) || TemplateResponse.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 `Dropbox::Sign::TemplateResponse` 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.merged_attributes.key?(k.to_sym))
          fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponse`. 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?(:'template_id')
        self.template_id = attributes[:'template_id']
      end

      if attributes.key?(:'title')
        self.title = attributes[:'title']
      end

      if attributes.key?(:'message')
        self.message = attributes[:'message']
      end

      if attributes.key?(:'updated_at')
        self.updated_at = attributes[:'updated_at']
      end

      if attributes.key?(:'is_embedded')
        self.is_embedded = attributes[:'is_embedded']
      end

      if attributes.key?(:'is_creator')
        self.is_creator = attributes[:'is_creator']
      end

      if attributes.key?(:'can_edit')
        self.can_edit = attributes[:'can_edit']
      end

      if attributes.key?(:'is_locked')
        self.is_locked = attributes[:'is_locked']
      end

      if attributes.key?(:'metadata')
        if (value = attributes[:'metadata']).is_a?(Hash)
          self.metadata = value
        end
      end

      if attributes.key?(:'signer_roles')
        if (value = attributes[:'signer_roles']).is_a?(Array)
          self.signer_roles = value
        end
      end

      if attributes.key?(:'cc_roles')
        if (value = attributes[:'cc_roles']).is_a?(Array)
          self.cc_roles = value
        end
      end

      if attributes.key?(:'documents')
        if (value = attributes[:'documents']).is_a?(Array)
          self.documents = value
        end
      end

      if attributes.key?(:'custom_fields')
        if (value = attributes[:'custom_fields']).is_a?(Array)
          self.custom_fields = value
        end
      end

      if attributes.key?(:'named_form_fields')
        if (value = attributes[:'named_form_fields']).is_a?(Array)
          self.named_form_fields = value
        end
      end

      if attributes.key?(:'accounts')
        if (value = attributes[:'accounts']).is_a?(Array)
          self.accounts = value
        end
      end

      if attributes.key?(:'attachments')
        if (value = attributes[:'attachments']).is_a?(Array)
          self.attachments = 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 &&
          template_id == o.template_id &&
          title == o.title &&
          message == o.message &&
          updated_at == o.updated_at &&
          is_embedded == o.is_embedded &&
          is_creator == o.is_creator &&
          can_edit == o.can_edit &&
          is_locked == o.is_locked &&
          metadata == o.metadata &&
          signer_roles == o.signer_roles &&
          cc_roles == o.cc_roles &&
          documents == o.documents &&
          custom_fields == o.custom_fields &&
          named_form_fields == o.named_form_fields &&
          accounts == o.accounts &&
          attachments == o.attachments
    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
      [template_id, title, message, updated_at, is_embedded, is_creator, can_edit, is_locked, metadata, signer_roles, cc_roles, documents, custom_fields, named_form_fields, accounts, attachments].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)
      attribute_map = self.class.merged_attributes

      self.class.merged_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[attribute_map[key]].is_a?(Array)
            self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
          end
        elsif !attributes[attribute_map[key]].nil?
          self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
        end
      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 :Time
        Time.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
        klass = Dropbox::Sign.const_get(type)
        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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(include_nil = true)
      hash = {}
      self.class.merged_attributes.each_pair do |attr, param|
        value = self.send(attr)
        if value.nil?
          next unless include_nil
          is_nullable = self.class.merged_nullable.include?(attr)
          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
        end

        hash[param] = _to_hash(value, include_nil)
      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, include_nil = true)
      if value.is_a?(Array)
        value.compact.map { |v| _to_hash(v, include_nil) }
      elsif value.is_a?(Hash)
        {}.tap do |hash|
          value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
        end
      elsif value.respond_to? :to_hash
        value.to_hash(include_nil)
      else
        value
      end
    end
  end
end