Class: DocuSign_eSign::ReportInProductRunResponseRow

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/report_in_product_run_response_row.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportInProductRunResponseRow

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 40

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?(:'envelopeId')
    self.envelope_id = attributes[:'envelopeId']
  end

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

Instance Attribute Details

#envelope_idObject

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


18
19
20
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 18

def envelope_id
  @envelope_id
end

#fieldsObject

Returns the value of attribute fields


20
21
22
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 20

def fields
  @fields
end

Class Method Details

.attribute_mapObject

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


23
24
25
26
27
28
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 23

def self.attribute_map
  {
    :'envelope_id' => :'envelopeId',
    :'fields' => :'fields'
  }
end

.swagger_typesObject

Attribute type mapping.


31
32
33
34
35
36
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 31

def self.swagger_types
  {
    :'envelope_id' => :'String',
    :'fields' => :'ReportInProductRunResponseRowFields'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


70
71
72
73
74
75
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 70

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      envelope_id == o.envelope_id &&
      fields == o.fields
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 113

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 179

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 92

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) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

79
80
81
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 79

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


85
86
87
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 85

def hash
  [envelope_id, fields].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


57
58
59
60
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 57

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


159
160
161
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 159

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


165
166
167
168
169
170
171
172
173
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 165

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


153
154
155
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 153

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


64
65
66
# File 'lib/docusign_esign/models/report_in_product_run_response_row.rb', line 64

def valid?
  true
end