Class: DocuSign_eSign::MergeField

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

Overview

Contains information for transfering values between Salesforce data fields and DocuSign Tabs.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MergeField

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
111
112
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
 
# File 'lib/docusign_esign/models/merge_field.rb', line 85

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allow_sender_to_edit ⇒ Object

When set to true, the sender can modify the value of the custom tab during the sending process.



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

def allow_sender_to_edit
  @allow_sender_to_edit
end

#allow_sender_to_edit_metadata ⇒ Object

Returns the value of attribute allow_sender_to_edit_metadata.



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

def allow_sender_to_edit_metadata
  @allow_sender_to_edit_metadata
end

#configuration_type ⇒ Object

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



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

def configuration_type
  @configuration_type
end

#configuration_type_metadata ⇒ Object

Returns the value of attribute configuration_type_metadata.



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

def configuration_type_metadata
  @configuration_type_metadata
end

#path ⇒ Object

Sets the object associated with the custom tab. Currently this is the Salesforce Object.



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

def path
  @path
end

#path_extended ⇒ Object

Returns the value of attribute path_extended.



31
32
33
 
# File 'lib/docusign_esign/models/merge_field.rb', line 31

def path_extended
  @path_extended
end

#path_extended_metadata ⇒ Object

Returns the value of attribute path_extended_metadata.



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

def path_extended_metadata
  @path_extended_metadata
end

#path_metadata ⇒ Object

Returns the value of attribute path_metadata.



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

def path_metadata
  @path_metadata
end

#row ⇒ Object

Specifies the row number in a Salesforce table that the merge field value corresponds to.



38
39
40
 
# File 'lib/docusign_esign/models/merge_field.rb', line 38

def row
  @row
end

#row_metadata ⇒ Object

Returns the value of attribute row_metadata.



40
41
42
 
# File 'lib/docusign_esign/models/merge_field.rb', line 40

def row_metadata
  @row_metadata
end

#write_back ⇒ Object

When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed.



43
44
45
 
# File 'lib/docusign_esign/models/merge_field.rb', line 43

def write_back
  @write_back
end

#write_back_metadata ⇒ Object

Returns the value of attribute write_back_metadata.



45
46
47
 
# File 'lib/docusign_esign/models/merge_field.rb', line 45

def write_back_metadata
  @write_back_metadata
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/docusign_esign/models/merge_field.rb', line 48

def self.attribute_map
  {
    :'allow_sender_to_edit' => :'allowSenderToEdit',
    :'allow_sender_to_edit_metadata' => :'allowSenderToEditMetadata',
    :'configuration_type' => :'configurationType',
    :'configuration_type_metadata' => :'configurationTypeMetadata',
    :'path' => :'path',
    :'path_extended' => :'pathExtended',
    :'path_extended_metadata' => :'pathExtendedMetadata',
    :'path_metadata' => :'pathMetadata',
    :'row' => :'row',
    :'row_metadata' => :'rowMetadata',
    :'write_back' => :'writeBack',
    :'write_back_metadata' => :'writeBackMetadata'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/docusign_esign/models/merge_field.rb', line 66

def self.swagger_types
  {
    :'allow_sender_to_edit' => :'String',
    :'allow_sender_to_edit_metadata' => :'PropertyMetadata',
    :'configuration_type' => :'String',
    :'configuration_type_metadata' => :'PropertyMetadata',
    :'path' => :'String',
    :'path_extended' => :'Array<PathExtendedElement>',
    :'path_extended_metadata' => :'PropertyMetadata',
    :'path_metadata' => :'PropertyMetadata',
    :'row' => :'String',
    :'row_metadata' => :'PropertyMetadata',
    :'write_back' => :'String',
    :'write_back_metadata' => :'PropertyMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_sender_to_edit == o.allow_sender_to_edit &&
      allow_sender_to_edit_metadata == o.allow_sender_to_edit_metadata &&
      configuration_type == o.configuration_type &&
      configuration_type_metadata == o.configuration_type_metadata &&
      path == o.path &&
      path_extended == o.path_extended &&
      path_extended_metadata == o.path_extended_metadata &&
      path_metadata == o.path_metadata &&
      row == o.row &&
      row_metadata == o.row_metadata &&
      write_back == o.write_back &&
      write_back_metadata == o.write_back_metadata
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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/docusign_esign/models/merge_field.rb', line 210

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/docusign_esign/models/merge_field.rb', line 276

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/docusign_esign/models/merge_field.rb', line 189

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


176
177
178
 
# File 'lib/docusign_esign/models/merge_field.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/docusign_esign/models/merge_field.rb', line 182

def hash
  [allow_sender_to_edit, allow_sender_to_edit_metadata, configuration_type, configuration_type_metadata, path, path_extended, path_extended_metadata, path_metadata, row, row_metadata, write_back, write_back_metadata].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



144
145
146
147
 
# File 'lib/docusign_esign/models/merge_field.rb', line 144

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



256
257
258
 
# File 'lib/docusign_esign/models/merge_field.rb', line 256

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



262
263
264
265
266
267
268
269
270
 
# File 'lib/docusign_esign/models/merge_field.rb', line 262

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



250
251
252
 
# File 'lib/docusign_esign/models/merge_field.rb', line 250

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



151
152
153
 
# File 'lib/docusign_esign/models/merge_field.rb', line 151

def valid?
  true
end