Class: DocuSign_eSign::ListCustomField

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

Overview

This object represents a list custom field from which envelope creators and senders can select custom data.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListCustomField

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/docusign_esign/models/list_custom_field.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?(:'configurationType')
    self.configuration_type = attributes[:'configurationType']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#configuration_type ⇒ Object

If merge field’s are being used, specifies the type of the merge field. The only supported value is salesforce.



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

def configuration_type
  @configuration_type
end

#error_details ⇒ Object

Array or errors.



21
22
23
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 21

def error_details
  @error_details
end

#field_id ⇒ Object

An ID used to specify a custom field.



24
25
26
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 24

def field_id
  @field_id
end

#list_items ⇒ Object

Returns the value of attribute list_items.



27
28
29
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 27

def list_items
  @list_items
end

#name ⇒ Object

The name of the custom field.



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

def name
  @name
end

#required ⇒ Object

When set to true, the signer is required to fill out this tab



33
34
35
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 33

def required
  @required
end

#show ⇒ Object

A boolean indicating if the value should be displayed.



36
37
38
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 36

def show
  @show
end

#value ⇒ Object

The value of the custom field. Maximum Length: 100 characters.



39
40
41
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 39

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'configuration_type' => :'configurationType',
    :'error_details' => :'errorDetails',
    :'field_id' => :'fieldId',
    :'list_items' => :'listItems',
    :'name' => :'name',
    :'required' => :'required',
    :'show' => :'show',
    :'value' => :'value'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 56

def self.swagger_types
  {
    :'configuration_type' => :'String',
    :'error_details' => :'ErrorDetails',
    :'field_id' => :'String',
    :'list_items' => :'Array<String>',
    :'name' => :'String',
    :'required' => :'String',
    :'show' => :'String',
    :'value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 127

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      configuration_type == o.configuration_type &&
      error_details == o.error_details &&
      field_id == o.field_id &&
      list_items == o.list_items &&
      name == o.name &&
      required == o.required &&
      show == o.show &&
      value == o.value
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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 176

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



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 242

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 155

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


142
143
144
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 142

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



148
149
150
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 148

def hash
  [configuration_type, error_details, field_id, list_items, name, required, show, value].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



114
115
116
117
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 114

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



222
223
224
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 222

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



228
229
230
231
232
233
234
235
236
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 228

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



216
217
218
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 216

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



121
122
123
 
# File 'lib/docusign_esign/models/list_custom_field.rb', line 121

def valid?
  true
end