class DocuSign_eSign::EnvelopePublishTransaction

Attributes

apply_connect_settings[RW]
envelope_count[RW]
envelope_level_error_rollups[RW]
envelope_publish_transaction_id[RW]
error_count[RW]
file_level_errors[RW]
no_action_required_envelope_count[RW]
processed_envelope_count[RW]
processing_status[RW]
results_uri[RW]
submission_date[RW]
submitted_by_user_info[RW]
submitted_for_publishing_envelope_count[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_publish_transaction.rb, line 55
def self.attribute_map
  {
    :'apply_connect_settings' => :'applyConnectSettings',
    :'envelope_count' => :'envelopeCount',
    :'envelope_level_error_rollups' => :'envelopeLevelErrorRollups',
    :'envelope_publish_transaction_id' => :'envelopePublishTransactionId',
    :'error_count' => :'errorCount',
    :'file_level_errors' => :'fileLevelErrors',
    :'no_action_required_envelope_count' => :'noActionRequiredEnvelopeCount',
    :'processed_envelope_count' => :'processedEnvelopeCount',
    :'processing_status' => :'processingStatus',
    :'results_uri' => :'resultsUri',
    :'submission_date' => :'submissionDate',
    :'submitted_by_user_info' => :'submittedByUserInfo',
    :'submitted_for_publishing_envelope_count' => :'submittedForPublishingEnvelopeCount'
  }
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_publish_transaction.rb, line 94
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?(:'applyConnectSettings')
    self.apply_connect_settings = attributes[:'applyConnectSettings']
  end

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

  if attributes.has_key?(:'envelopeLevelErrorRollups')
    if (value = attributes[:'envelopeLevelErrorRollups']).is_a?(Array)
      self.envelope_level_error_rollups = value
    end
  end

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

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

  if attributes.has_key?(:'fileLevelErrors')
    if (value = attributes[:'fileLevelErrors']).is_a?(Array)
      self.file_level_errors = value
    end
  end

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

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

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

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

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

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

  if attributes.has_key?(:'submittedForPublishingEnvelopeCount')
    self.submitted_for_publishing_envelope_count = attributes[:'submittedForPublishingEnvelopeCount']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/envelope_publish_transaction.rb, line 74
def self.swagger_types
  {
    :'apply_connect_settings' => :'String',
    :'envelope_count' => :'String',
    :'envelope_level_error_rollups' => :'Array<EnvelopePublishTransactionErrorRollup>',
    :'envelope_publish_transaction_id' => :'String',
    :'error_count' => :'String',
    :'file_level_errors' => :'Array<String>',
    :'no_action_required_envelope_count' => :'String',
    :'processed_envelope_count' => :'String',
    :'processing_status' => :'String',
    :'results_uri' => :'String',
    :'submission_date' => :'String',
    :'submitted_by_user_info' => :'UserInfo',
    :'submitted_for_publishing_envelope_count' => :'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_publish_transaction.rb, line 172
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      apply_connect_settings == o.apply_connect_settings &&
      envelope_count == o.envelope_count &&
      envelope_level_error_rollups == o.envelope_level_error_rollups &&
      envelope_publish_transaction_id == o.envelope_publish_transaction_id &&
      error_count == o.error_count &&
      file_level_errors == o.file_level_errors &&
      no_action_required_envelope_count == o.no_action_required_envelope_count &&
      processed_envelope_count == o.processed_envelope_count &&
      processing_status == o.processing_status &&
      results_uri == o.results_uri &&
      submission_date == o.submission_date &&
      submitted_by_user_info == o.submitted_by_user_info &&
      submitted_for_publishing_envelope_count == o.submitted_for_publishing_envelope_count
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_publish_transaction.rb, line 226
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_publish_transaction.rb, line 292
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_publish_transaction.rb, line 205
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_publish_transaction.rb, line 192
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_publish_transaction.rb, line 198
def hash
  [apply_connect_settings, envelope_count, envelope_level_error_rollups, envelope_publish_transaction_id, error_count, file_level_errors, no_action_required_envelope_count, processed_envelope_count, processing_status, results_uri, submission_date, submitted_by_user_info, submitted_for_publishing_envelope_count].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_publish_transaction.rb, line 159
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_publish_transaction.rb, line 272
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_publish_transaction.rb, line 278
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_publish_transaction.rb, line 266
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_publish_transaction.rb, line 166
def valid?
  true
end