=begin
#DocuSign REST API

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

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

=end

require 'date'

module DocuSign_eSign

  class Envelope
    # When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this
    attr_accessor :allow_markup

    # When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.
    attr_accessor :allow_reassign

    # 
    attr_accessor :allow_view_history

    # When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.
    attr_accessor :asynchronous

    # 
    attr_accessor :attachments_uri

    # Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
    attr_accessor :authoritative_copy

    # 
    attr_accessor :authoritative_copy_default

    # 
    attr_accessor :auto_navigation

    # 
    attr_accessor :brand_id

    # 
    attr_accessor :brand_lock

    # Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
    attr_accessor :certificate_uri

    # Specifies the date and time this item was completed.
    attr_accessor :completed_date_time

    # Indicates the date and time the item was created.
    attr_accessor :created_date_time

    attr_accessor :custom_fields

    # Contains a URI for an endpoint that you can use to retrieve the custom fields.
    attr_accessor :custom_fields_uri

    # The date and time the recipient declined the document.
    attr_accessor :declined_date_time

    # Specifies the data and time the item was deleted.
    attr_accessor :deleted_date_time

    # Reserved: For DocuSign use only.
    attr_accessor :delivered_date_time

    # 
    attr_accessor :documents_combined_uri

    # Contains a URI for an endpoint that you can use to retrieve the documents.
    attr_accessor :documents_uri

    # This is the same as the email body. If specified it is included in email body for all envelope recipients.
    attr_accessor :email_blurb

    attr_accessor :email_settings

    # Specifies the subject of the email that is sent to all recipients.  See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
    attr_accessor :email_subject

    # When set to **true**, the signer is allowed to print the document and sign it on paper.
    attr_accessor :enable_wet_sign

    # When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.  Your account must have Document Visibility enabled to use this.
    attr_accessor :enforce_signer_visibility

    # The envelope ID of the envelope status that failed to post.
    attr_accessor :envelope_id

    # When set to **true**, Envelope ID Stamping is enabled.
    attr_accessor :envelope_id_stamping

    # Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
    attr_accessor :envelope_uri

    # 
    attr_accessor :initial_sent_date_time

    # When set to **true**, indicates that this module is enabled on the account.
    attr_accessor :is21_cfr_part11

    # 
    attr_accessor :is_signature_provider_envelope

    # The date and time the item was last modified.
    attr_accessor :last_modified_date_time

    attr_accessor :lock_information

    # When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.   Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes.   However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.
    attr_accessor :message_lock

    attr_accessor :notification

    # Contains a URI for an endpoint that you can use to retrieve the notifications.
    attr_accessor :notification_uri

    # 
    attr_accessor :purge_state

    attr_accessor :recipients

    # When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
    attr_accessor :recipients_lock

    # Contains a URI for an endpoint that you can use to retrieve the recipients.
    attr_accessor :recipients_uri

    # The date and time the envelope was sent.
    attr_accessor :sent_date_time

    # 
    attr_accessor :signer_can_sign_on_mobile

    # Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
    attr_accessor :signing_location

    # Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  *created - The envelope is saved as a draft and can be modified and sent later.
    attr_accessor :status

    # The data and time the status changed.
    attr_accessor :status_changed_date_time

    # Contains a URI for an endpoint which you can use to retrieve the templates.
    attr_accessor :templates_uri

    #  Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.
    attr_accessor :transaction_id

    # When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients.   If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.
    attr_accessor :use_disclosure

    # The date and time the envelope or template was voided.
    attr_accessor :voided_date_time

    # The reason the envelope or template was voided.
    attr_accessor :voided_reason


    # Attribute mapping from ruby-style variable name to JSON key.
    def self.attribute_map
      {
        :'allow_markup' => :'allowMarkup',
        :'allow_reassign' => :'allowReassign',
        :'allow_view_history' => :'allowViewHistory',
        :'asynchronous' => :'asynchronous',
        :'attachments_uri' => :'attachmentsUri',
        :'authoritative_copy' => :'authoritativeCopy',
        :'authoritative_copy_default' => :'authoritativeCopyDefault',
        :'auto_navigation' => :'autoNavigation',
        :'brand_id' => :'brandId',
        :'brand_lock' => :'brandLock',
        :'certificate_uri' => :'certificateUri',
        :'completed_date_time' => :'completedDateTime',
        :'created_date_time' => :'createdDateTime',
        :'custom_fields' => :'customFields',
        :'custom_fields_uri' => :'customFieldsUri',
        :'declined_date_time' => :'declinedDateTime',
        :'deleted_date_time' => :'deletedDateTime',
        :'delivered_date_time' => :'deliveredDateTime',
        :'documents_combined_uri' => :'documentsCombinedUri',
        :'documents_uri' => :'documentsUri',
        :'email_blurb' => :'emailBlurb',
        :'email_settings' => :'emailSettings',
        :'email_subject' => :'emailSubject',
        :'enable_wet_sign' => :'enableWetSign',
        :'enforce_signer_visibility' => :'enforceSignerVisibility',
        :'envelope_id' => :'envelopeId',
        :'envelope_id_stamping' => :'envelopeIdStamping',
        :'envelope_uri' => :'envelopeUri',
        :'initial_sent_date_time' => :'initialSentDateTime',
        :'is21_cfr_part11' => :'is21CFRPart11',
        :'is_signature_provider_envelope' => :'isSignatureProviderEnvelope',
        :'last_modified_date_time' => :'lastModifiedDateTime',
        :'lock_information' => :'lockInformation',
        :'message_lock' => :'messageLock',
        :'notification' => :'notification',
        :'notification_uri' => :'notificationUri',
        :'purge_state' => :'purgeState',
        :'recipients' => :'recipients',
        :'recipients_lock' => :'recipientsLock',
        :'recipients_uri' => :'recipientsUri',
        :'sent_date_time' => :'sentDateTime',
        :'signer_can_sign_on_mobile' => :'signerCanSignOnMobile',
        :'signing_location' => :'signingLocation',
        :'status' => :'status',
        :'status_changed_date_time' => :'statusChangedDateTime',
        :'templates_uri' => :'templatesUri',
        :'transaction_id' => :'transactionId',
        :'use_disclosure' => :'useDisclosure',
        :'voided_date_time' => :'voidedDateTime',
        :'voided_reason' => :'voidedReason'
      }
    end

    # Attribute type mapping.
    def self.swagger_types
      {
        :'allow_markup' => :'String',
        :'allow_reassign' => :'String',
        :'allow_view_history' => :'String',
        :'asynchronous' => :'String',
        :'attachments_uri' => :'String',
        :'authoritative_copy' => :'String',
        :'authoritative_copy_default' => :'String',
        :'auto_navigation' => :'String',
        :'brand_id' => :'String',
        :'brand_lock' => :'String',
        :'certificate_uri' => :'String',
        :'completed_date_time' => :'String',
        :'created_date_time' => :'String',
        :'custom_fields' => :'CustomFields',
        :'custom_fields_uri' => :'String',
        :'declined_date_time' => :'String',
        :'deleted_date_time' => :'String',
        :'delivered_date_time' => :'String',
        :'documents_combined_uri' => :'String',
        :'documents_uri' => :'String',
        :'email_blurb' => :'String',
        :'email_settings' => :'EmailSettings',
        :'email_subject' => :'String',
        :'enable_wet_sign' => :'String',
        :'enforce_signer_visibility' => :'String',
        :'envelope_id' => :'String',
        :'envelope_id_stamping' => :'String',
        :'envelope_uri' => :'String',
        :'initial_sent_date_time' => :'String',
        :'is21_cfr_part11' => :'String',
        :'is_signature_provider_envelope' => :'String',
        :'last_modified_date_time' => :'String',
        :'lock_information' => :'LockInformation',
        :'message_lock' => :'String',
        :'notification' => :'Notification',
        :'notification_uri' => :'String',
        :'purge_state' => :'String',
        :'recipients' => :'Recipients',
        :'recipients_lock' => :'String',
        :'recipients_uri' => :'String',
        :'sent_date_time' => :'String',
        :'signer_can_sign_on_mobile' => :'String',
        :'signing_location' => :'String',
        :'status' => :'String',
        :'status_changed_date_time' => :'String',
        :'templates_uri' => :'String',
        :'transaction_id' => :'String',
        :'use_disclosure' => :'String',
        :'voided_date_time' => :'String',
        :'voided_reason' => :'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?(:'allowMarkup')
        self.allow_markup = attributes[:'allowMarkup']
      end

      if attributes.has_key?(:'allowReassign')
        self.allow_reassign = attributes[:'allowReassign']
      end

      if attributes.has_key?(:'allowViewHistory')
        self.allow_view_history = attributes[:'allowViewHistory']
      end

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

      if attributes.has_key?(:'attachmentsUri')
        self.attachments_uri = attributes[:'attachmentsUri']
      end

      if attributes.has_key?(:'authoritativeCopy')
        self.authoritative_copy = attributes[:'authoritativeCopy']
      end

      if attributes.has_key?(:'authoritativeCopyDefault')
        self.authoritative_copy_default = attributes[:'authoritativeCopyDefault']
      end

      if attributes.has_key?(:'autoNavigation')
        self.auto_navigation = attributes[:'autoNavigation']
      end

      if attributes.has_key?(:'brandId')
        self.brand_id = attributes[:'brandId']
      end

      if attributes.has_key?(:'brandLock')
        self.brand_lock = attributes[:'brandLock']
      end

      if attributes.has_key?(:'certificateUri')
        self.certificate_uri = attributes[:'certificateUri']
      end

      if attributes.has_key?(:'completedDateTime')
        self.completed_date_time = attributes[:'completedDateTime']
      end

      if attributes.has_key?(:'createdDateTime')
        self.created_date_time = attributes[:'createdDateTime']
      end

      if attributes.has_key?(:'customFields')
        self.custom_fields = attributes[:'customFields']
      end

      if attributes.has_key?(:'customFieldsUri')
        self.custom_fields_uri = attributes[:'customFieldsUri']
      end

      if attributes.has_key?(:'declinedDateTime')
        self.declined_date_time = attributes[:'declinedDateTime']
      end

      if attributes.has_key?(:'deletedDateTime')
        self.deleted_date_time = attributes[:'deletedDateTime']
      end

      if attributes.has_key?(:'deliveredDateTime')
        self.delivered_date_time = attributes[:'deliveredDateTime']
      end

      if attributes.has_key?(:'documentsCombinedUri')
        self.documents_combined_uri = attributes[:'documentsCombinedUri']
      end

      if attributes.has_key?(:'documentsUri')
        self.documents_uri = attributes[:'documentsUri']
      end

      if attributes.has_key?(:'emailBlurb')
        self.email_blurb = attributes[:'emailBlurb']
      end

      if attributes.has_key?(:'emailSettings')
        self.email_settings = attributes[:'emailSettings']
      end

      if attributes.has_key?(:'emailSubject')
        self.email_subject = attributes[:'emailSubject']
      end

      if attributes.has_key?(:'enableWetSign')
        self.enable_wet_sign = attributes[:'enableWetSign']
      end

      if attributes.has_key?(:'enforceSignerVisibility')
        self.enforce_signer_visibility = attributes[:'enforceSignerVisibility']
      end

      if attributes.has_key?(:'envelopeId')
        self.envelope_id = attributes[:'envelopeId']
      end

      if attributes.has_key?(:'envelopeIdStamping')
        self.envelope_id_stamping = attributes[:'envelopeIdStamping']
      end

      if attributes.has_key?(:'envelopeUri')
        self.envelope_uri = attributes[:'envelopeUri']
      end

      if attributes.has_key?(:'initialSentDateTime')
        self.initial_sent_date_time = attributes[:'initialSentDateTime']
      end

      if attributes.has_key?(:'is21CFRPart11')
        self.is21_cfr_part11 = attributes[:'is21CFRPart11']
      end

      if attributes.has_key?(:'isSignatureProviderEnvelope')
        self.is_signature_provider_envelope = attributes[:'isSignatureProviderEnvelope']
      end

      if attributes.has_key?(:'lastModifiedDateTime')
        self.last_modified_date_time = attributes[:'lastModifiedDateTime']
      end

      if attributes.has_key?(:'lockInformation')
        self.lock_information = attributes[:'lockInformation']
      end

      if attributes.has_key?(:'messageLock')
        self.message_lock = attributes[:'messageLock']
      end

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

      if attributes.has_key?(:'notificationUri')
        self.notification_uri = attributes[:'notificationUri']
      end

      if attributes.has_key?(:'purgeState')
        self.purge_state = attributes[:'purgeState']
      end

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

      if attributes.has_key?(:'recipientsLock')
        self.recipients_lock = attributes[:'recipientsLock']
      end

      if attributes.has_key?(:'recipientsUri')
        self.recipients_uri = attributes[:'recipientsUri']
      end

      if attributes.has_key?(:'sentDateTime')
        self.sent_date_time = attributes[:'sentDateTime']
      end

      if attributes.has_key?(:'signerCanSignOnMobile')
        self.signer_can_sign_on_mobile = attributes[:'signerCanSignOnMobile']
      end

      if attributes.has_key?(:'signingLocation')
        self.signing_location = attributes[:'signingLocation']
      end

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

      if attributes.has_key?(:'statusChangedDateTime')
        self.status_changed_date_time = attributes[:'statusChangedDateTime']
      end

      if attributes.has_key?(:'templatesUri')
        self.templates_uri = attributes[:'templatesUri']
      end

      if attributes.has_key?(:'transactionId')
        self.transaction_id = attributes[:'transactionId']
      end

      if attributes.has_key?(:'useDisclosure')
        self.use_disclosure = attributes[:'useDisclosure']
      end

      if attributes.has_key?(:'voidedDateTime')
        self.voided_date_time = attributes[:'voidedDateTime']
      end

      if attributes.has_key?(:'voidedReason')
        self.voided_reason = attributes[:'voidedReason']
      end

    end

    # Show invalid properties with the reasons. Usually used together with valid?
    # @return Array for valid properies with the reasons
    def list_invalid_properties
      invalid_properties = Array.new
      return 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 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 &&
          allow_markup == o.allow_markup &&
          allow_reassign == o.allow_reassign &&
          allow_view_history == o.allow_view_history &&
          asynchronous == o.asynchronous &&
          attachments_uri == o.attachments_uri &&
          authoritative_copy == o.authoritative_copy &&
          authoritative_copy_default == o.authoritative_copy_default &&
          auto_navigation == o.auto_navigation &&
          brand_id == o.brand_id &&
          brand_lock == o.brand_lock &&
          certificate_uri == o.certificate_uri &&
          completed_date_time == o.completed_date_time &&
          created_date_time == o.created_date_time &&
          custom_fields == o.custom_fields &&
          custom_fields_uri == o.custom_fields_uri &&
          declined_date_time == o.declined_date_time &&
          deleted_date_time == o.deleted_date_time &&
          delivered_date_time == o.delivered_date_time &&
          documents_combined_uri == o.documents_combined_uri &&
          documents_uri == o.documents_uri &&
          email_blurb == o.email_blurb &&
          email_settings == o.email_settings &&
          email_subject == o.email_subject &&
          enable_wet_sign == o.enable_wet_sign &&
          enforce_signer_visibility == o.enforce_signer_visibility &&
          envelope_id == o.envelope_id &&
          envelope_id_stamping == o.envelope_id_stamping &&
          envelope_uri == o.envelope_uri &&
          initial_sent_date_time == o.initial_sent_date_time &&
          is21_cfr_part11 == o.is21_cfr_part11 &&
          is_signature_provider_envelope == o.is_signature_provider_envelope &&
          last_modified_date_time == o.last_modified_date_time &&
          lock_information == o.lock_information &&
          message_lock == o.message_lock &&
          notification == o.notification &&
          notification_uri == o.notification_uri &&
          purge_state == o.purge_state &&
          recipients == o.recipients &&
          recipients_lock == o.recipients_lock &&
          recipients_uri == o.recipients_uri &&
          sent_date_time == o.sent_date_time &&
          signer_can_sign_on_mobile == o.signer_can_sign_on_mobile &&
          signing_location == o.signing_location &&
          status == o.status &&
          status_changed_date_time == o.status_changed_date_time &&
          templates_uri == o.templates_uri &&
          transaction_id == o.transaction_id &&
          use_disclosure == o.use_disclosure &&
          voided_date_time == o.voided_date_time &&
          voided_reason == o.voided_reason
    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
      [allow_markup, allow_reassign, allow_view_history, asynchronous, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_id, envelope_id_stamping, envelope_uri, initial_sent_date_time, is21_cfr_part11, is_signature_provider_envelope, last_modified_date_time, lock_information, message_lock, notification, notification_uri, purge_state, recipients, recipients_lock, recipients_uri, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason].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 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