Class: DocuSign_eSign::TextCustomField

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TextCustomField

Initializes the object

Parameters:

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

    Model attributes in the form of hash


65
66
67
68
69
70
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
# File 'lib/docusign_esign/models/text_custom_field.rb', line 65

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?(:'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_typeObject

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/text_custom_field.rb', line 18

def configuration_type
  @configuration_type
end

#error_detailsObject

Returns the value of attribute error_details


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

def error_details
  @error_details
end

#field_idObject

An ID used to specify a custom field.


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

def field_id
  @field_id
end

#nameObject

The name of the custom field.


26
27
28
# File 'lib/docusign_esign/models/text_custom_field.rb', line 26

def name
  @name
end

#requiredObject

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


29
30
31
# File 'lib/docusign_esign/models/text_custom_field.rb', line 29

def required
  @required
end

#showObject

A boolean indicating if the value should be displayed.


32
33
34
# File 'lib/docusign_esign/models/text_custom_field.rb', line 32

def show
  @show
end

#valueObject

The value of the custom field.


35
36
37
# File 'lib/docusign_esign/models/text_custom_field.rb', line 35

def value
  @value
end

Class Method Details

.attribute_mapObject

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


38
39
40
41
42
43
44
45
46
47
48
# File 'lib/docusign_esign/models/text_custom_field.rb', line 38

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

.swagger_typesObject

Attribute type mapping.


51
52
53
54
55
56
57
58
59
60
61
# File 'lib/docusign_esign/models/text_custom_field.rb', line 51

def self.swagger_types
  {
    :'configuration_type' => :'String',
    :'error_details' => :'ErrorDetails',
    :'field_id' => :'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


115
116
117
118
119
120
121
122
123
124
125
# File 'lib/docusign_esign/models/text_custom_field.rb', line 115

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 &&
      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


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
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/docusign_esign/models/text_custom_field.rb', line 163

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


229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'lib/docusign_esign/models/text_custom_field.rb', line 229

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


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# File 'lib/docusign_esign/models/text_custom_field.rb', line 142

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

129
130
131
# File 'lib/docusign_esign/models/text_custom_field.rb', line 129

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


135
136
137
# File 'lib/docusign_esign/models/text_custom_field.rb', line 135

def hash
  [configuration_type, error_details, field_id, name, required, show, 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


102
103
104
105
# File 'lib/docusign_esign/models/text_custom_field.rb', line 102

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


209
210
211
# File 'lib/docusign_esign/models/text_custom_field.rb', line 209

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


215
216
217
218
219
220
221
222
223
# File 'lib/docusign_esign/models/text_custom_field.rb', line 215

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


203
204
205
# File 'lib/docusign_esign/models/text_custom_field.rb', line 203

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


109
110
111
# File 'lib/docusign_esign/models/text_custom_field.rb', line 109

def valid?
  true
end