Class: DocuSign_eSign::ListItem

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/docusign_esign/models/list_item.rb', line 58

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

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

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

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

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

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

Instance Attribute Details

#selectedObject

When set to *true*, indicates that this item is the default selection shown to a signer. Only one selection can be set as the default.


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

def selected
  @selected
end

#selected_metadataObject

Returns the value of attribute selected_metadata


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

def 
  @selected_metadata
end

#textObject

Specifies the text that is shown in the dropdown list.


23
24
25
# File 'lib/docusign_esign/models/list_item.rb', line 23

def text
  @text
end

#text_metadataObject

Returns the value of attribute text_metadata


25
26
27
# File 'lib/docusign_esign/models/list_item.rb', line 25

def 
  @text_metadata
end

#valueObject

Specifies the value that is used when the list item is selected.


28
29
30
# File 'lib/docusign_esign/models/list_item.rb', line 28

def value
  @value
end

#value_metadataObject

Returns the value of attribute value_metadata


30
31
32
# File 'lib/docusign_esign/models/list_item.rb', line 30

def 
  @value_metadata
end

Class Method Details

.attribute_mapObject

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


33
34
35
36
37
38
39
40
41
42
# File 'lib/docusign_esign/models/list_item.rb', line 33

def self.attribute_map
  {
    :'selected' => :'selected',
    :'selected_metadata' => :'selectedMetadata',
    :'text' => :'text',
    :'text_metadata' => :'textMetadata',
    :'value' => :'value',
    :'value_metadata' => :'valueMetadata'
  }
end

.swagger_typesObject

Attribute type mapping.


45
46
47
48
49
50
51
52
53
54
# File 'lib/docusign_esign/models/list_item.rb', line 45

def self.swagger_types
  {
    :'selected' => :'String',
    :'selected_metadata' => :'PropertyMetadata',
    :'text' => :'String',
    :'text_metadata' => :'PropertyMetadata',
    :'value' => :'String',
    :'value_metadata' => :'PropertyMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


104
105
106
107
108
109
110
111
112
113
# File 'lib/docusign_esign/models/list_item.rb', line 104

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      selected == o.selected &&
       == o. &&
      text == o.text &&
       == o. &&
      value == o.value &&
       == o.
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


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/docusign_esign/models/list_item.rb', line 151

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


217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/docusign_esign/models/list_item.rb', line 217

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


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/docusign_esign/models/list_item.rb', line 130

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

117
118
119
# File 'lib/docusign_esign/models/list_item.rb', line 117

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


123
124
125
# File 'lib/docusign_esign/models/list_item.rb', line 123

def hash
  [selected, , text, , value, ].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


91
92
93
94
# File 'lib/docusign_esign/models/list_item.rb', line 91

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


197
198
199
# File 'lib/docusign_esign/models/list_item.rb', line 197

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


203
204
205
206
207
208
209
210
211
# File 'lib/docusign_esign/models/list_item.rb', line 203

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


191
192
193
# File 'lib/docusign_esign/models/list_item.rb', line 191

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


98
99
100
# File 'lib/docusign_esign/models/list_item.rb', line 98

def valid?
  true
end