class DocuSign_eSign::EnvelopeSummary

This object describes an envelope.

Attributes

bulk_envelope_status[RW]

An object that describes the status of the bulk send envelopes.

envelope_id[RW]

The envelope ID of the envelope status that failed to post.

error_details[RW]

Array or errors.

recipient_signing_uri[RW]

recipient_signing_uri_error[RW]

status[RW]

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.

status_date_time[RW]

The DateTime that the envelope changed status (i.e. was created or sent.)

uri[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/docusign_esign/models/envelope_summary.rb, line 42
def self.attribute_map
  {
    :'bulk_envelope_status' => :'bulkEnvelopeStatus',
    :'envelope_id' => :'envelopeId',
    :'error_details' => :'errorDetails',
    :'recipient_signing_uri' => :'recipientSigningUri',
    :'recipient_signing_uri_error' => :'recipientSigningUriError',
    :'status' => :'status',
    :'status_date_time' => :'statusDateTime',
    :'uri' => :'uri'
  }
end

new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/docusign_esign/models/envelope_summary.rb, line 71
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?(:'bulkEnvelopeStatus')
    self.bulk_envelope_status = attributes[:'bulkEnvelopeStatus']
  end

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

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

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

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

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

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

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

swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/envelope_summary.rb, line 56
def self.swagger_types
  {
    :'bulk_envelope_status' => :'BulkEnvelopeStatus',
    :'envelope_id' => :'String',
    :'error_details' => :'ErrorDetails',
    :'recipient_signing_uri' => :'String',
    :'recipient_signing_uri_error' => :'String',
    :'status' => :'String',
    :'status_date_time' => :'String',
    :'uri' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/docusign_esign/models/envelope_summary.rb, line 125
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bulk_envelope_status == o.bulk_envelope_status &&
      envelope_id == o.envelope_id &&
      error_details == o.error_details &&
      recipient_signing_uri == o.recipient_signing_uri &&
      recipient_signing_uri_error == o.recipient_signing_uri_error &&
      status == o.status &&
      status_date_time == o.status_date_time &&
      uri == o.uri
end

_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/docusign_esign/models/envelope_summary.rb, line 174
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

_to_hash(value) click to toggle source

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

# File lib/docusign_esign/models/envelope_summary.rb, line 240
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

build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/docusign_esign/models/envelope_summary.rb, line 153
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

eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/docusign_esign/models/envelope_summary.rb, line 140
def eql?(o)
  self == o
end

hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/docusign_esign/models/envelope_summary.rb, line 146
def hash
  [bulk_envelope_status, envelope_id, error_details, recipient_signing_uri, recipient_signing_uri_error, status, status_date_time, uri].hash
end

list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/docusign_esign/models/envelope_summary.rb, line 112
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/envelope_summary.rb, line 220
def to_body
  to_hash
end

to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/envelope_summary.rb, line 226
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

to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/docusign_esign/models/envelope_summary.rb, line 214
def to_s
  to_hash.to_s
end

valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/docusign_esign/models/envelope_summary.rb, line 119
def valid?
  true
end