class DocuSign_eSign::ConnectLog

Contains information about a Connect log entry.

Attributes

account_id[RW]

The account ID associated with the envelope.

config_url[RW]

The web address of the listener or Retrieving Service end point for Connect.

connect_debug_log[RW]

A complex element containing information about the Connect configuration, error details, date/time, description and payload. This is only included in the response if the query additional_info=true is used.

connect_id[RW]

The identifier for the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post.

created[RW]

The date and time the entry was created.

email[RW]

The email that sent the envelope.

envelope_id[RW]

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

error[RW]

The error that caused the Connect post to fail.

failure_id[RW]

The failure log ID for the failure.

failure_uri[RW]

The URI for the failure.

last_try[RW]

The date and time the last attempt to post.

log_id[RW]

The Connect log ID for the entry.

log_uri[RW]

The URI for the log item.

retry_count[RW]

The number of times the Connect post has been retried.

retry_uri[RW]

The UEI to retry to publish the Connect failure.

status[RW]

The new envelope status for the failed Connect post. The possible values are: Any, Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut, Template, or Processing.

subject[RW]

The envelope subject.

user_name[RW]

The name of the envelope sender.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_esign/models/connect_log.rb, line 72
def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'config_url' => :'configUrl',
    :'connect_debug_log' => :'connectDebugLog',
    :'connect_id' => :'connectId',
    :'created' => :'created',
    :'email' => :'email',
    :'envelope_id' => :'envelopeId',
    :'error' => :'error',
    :'failure_id' => :'failureId',
    :'failure_uri' => :'failureUri',
    :'last_try' => :'lastTry',
    :'log_id' => :'logId',
    :'log_uri' => :'logUri',
    :'retry_count' => :'retryCount',
    :'retry_uri' => :'retryUri',
    :'status' => :'status',
    :'subject' => :'subject',
    :'user_name' => :'userName'
  }
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/connect_log.rb, line 121
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?(:'accountId')
    self.account_id = attributes[:'accountId']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/connect_log.rb, line 96
def self.swagger_types
  {
    :'account_id' => :'String',
    :'config_url' => :'String',
    :'connect_debug_log' => :'Array<ConnectDebugLog>',
    :'connect_id' => :'String',
    :'created' => :'String',
    :'email' => :'String',
    :'envelope_id' => :'String',
    :'error' => :'String',
    :'failure_id' => :'String',
    :'failure_uri' => :'String',
    :'last_try' => :'String',
    :'log_id' => :'String',
    :'log_uri' => :'String',
    :'retry_count' => :'String',
    :'retry_uri' => :'String',
    :'status' => :'String',
    :'subject' => :'String',
    :'user_name' => :'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/connect_log.rb, line 217
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_id == o.account_id &&
      config_url == o.config_url &&
      connect_debug_log == o.connect_debug_log &&
      connect_id == o.connect_id &&
      created == o.created &&
      email == o.email &&
      envelope_id == o.envelope_id &&
      error == o.error &&
      failure_id == o.failure_id &&
      failure_uri == o.failure_uri &&
      last_try == o.last_try &&
      log_id == o.log_id &&
      log_uri == o.log_uri &&
      retry_count == o.retry_count &&
      retry_uri == o.retry_uri &&
      status == o.status &&
      subject == o.subject &&
      user_name == o.user_name
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/connect_log.rb, line 276
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/connect_log.rb, line 342
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/connect_log.rb, line 255
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/connect_log.rb, line 242
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/connect_log.rb, line 248
def hash
  [account_id, config_url, connect_debug_log, connect_id, created, email, envelope_id, error, failure_id, failure_uri, last_try, log_id, log_uri, retry_count, retry_uri, status, subject, user_name].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/connect_log.rb, line 204
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/connect_log.rb, line 322
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/connect_log.rb, line 328
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/connect_log.rb, line 316
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/connect_log.rb, line 211
def valid?
  true
end