Class: DocuSign_eSign::MergeField
- Inherits:
-
Object
- Object
- DocuSign_eSign::MergeField
- 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
-
#allow_sender_to_edit ⇒ Object
When set to true, the sender can modify the value of the custom tab during the sending process.
-
#allow_sender_to_edit_metadata ⇒ Object
Returns the value of attribute allow_sender_to_edit_metadata.
-
#configuration_type ⇒ Object
If merge field’s are being used, specifies the type of the merge field.
-
#configuration_type_metadata ⇒ Object
Returns the value of attribute configuration_type_metadata.
-
#path ⇒ Object
Sets the object associated with the custom tab.
-
#path_extended ⇒ Object
Returns the value of attribute path_extended.
-
#path_extended_metadata ⇒ Object
Returns the value of attribute path_extended_metadata.
-
#path_metadata ⇒ Object
Returns the value of attribute path_metadata.
-
#row ⇒ Object
Specifies the row number in a Salesforce table that the merge field value corresponds to.
-
#row_metadata ⇒ Object
Returns the value of attribute row_metadata.
-
#write_back ⇒ Object
When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed.
-
#write_back_metadata ⇒ Object
Returns the value of attribute write_back_metadata.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ MergeField
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ MergeField
Initializes the object
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 141 |
# File 'lib/docusign_esign/models/merge_field.rb', line 86 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. = attributes[:'allowSenderToEditMetadata'] end if attributes.has_key?(:'configurationType') self.configuration_type = attributes[:'configurationType'] end if attributes.has_key?(:'configurationTypeMetadata') self. = 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. = attributes[:'pathExtendedMetadata'] end if attributes.has_key?(:'pathMetadata') self. = attributes[:'pathMetadata'] end if attributes.has_key?(:'row') self.row = attributes[:'row'] end if attributes.has_key?(:'rowMetadata') self. = attributes[:'rowMetadata'] end if attributes.has_key?(:'writeBack') self.write_back = attributes[:'writeBack'] end if attributes.has_key?(:'writeBackMetadata') self. = 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.
19 20 21 |
# File 'lib/docusign_esign/models/merge_field.rb', line 19 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.
21 22 23 |
# File 'lib/docusign_esign/models/merge_field.rb', line 21 def @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.
24 25 26 |
# File 'lib/docusign_esign/models/merge_field.rb', line 24 def configuration_type @configuration_type end |
#configuration_type_metadata ⇒ Object
Returns the value of attribute configuration_type_metadata.
26 27 28 |
# File 'lib/docusign_esign/models/merge_field.rb', line 26 def @configuration_type_metadata end |
#path ⇒ Object
Sets the object associated with the custom tab. Currently this is the Salesforce Object.
29 30 31 |
# File 'lib/docusign_esign/models/merge_field.rb', line 29 def path @path end |
#path_extended ⇒ Object
Returns the value of attribute path_extended.
32 33 34 |
# File 'lib/docusign_esign/models/merge_field.rb', line 32 def path_extended @path_extended end |
#path_extended_metadata ⇒ Object
Returns the value of attribute path_extended_metadata.
34 35 36 |
# File 'lib/docusign_esign/models/merge_field.rb', line 34 def @path_extended_metadata end |
#path_metadata ⇒ Object
Returns the value of attribute path_metadata.
36 37 38 |
# File 'lib/docusign_esign/models/merge_field.rb', line 36 def @path_metadata end |
#row ⇒ Object
Specifies the row number in a Salesforce table that the merge field value corresponds to.
39 40 41 |
# File 'lib/docusign_esign/models/merge_field.rb', line 39 def row @row end |
#row_metadata ⇒ Object
Returns the value of attribute row_metadata.
41 42 43 |
# File 'lib/docusign_esign/models/merge_field.rb', line 41 def @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.
44 45 46 |
# File 'lib/docusign_esign/models/merge_field.rb', line 44 def write_back @write_back end |
#write_back_metadata ⇒ Object
Returns the value of attribute write_back_metadata.
46 47 48 |
# File 'lib/docusign_esign/models/merge_field.rb', line 46 def @write_back_metadata end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/docusign_esign/models/merge_field.rb', line 49 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.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/docusign_esign/models/merge_field.rb', line 67 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.
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/docusign_esign/models/merge_field.rb', line 158 def ==(o) return true if self.equal?(o) self.class == o.class && allow_sender_to_edit == o.allow_sender_to_edit && == o. && configuration_type == o.configuration_type && == o. && path == o.path && path_extended == o.path_extended && == o. && == o. && row == o.row && == o. && write_back == o.write_back && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 247 |
# File 'lib/docusign_esign/models/merge_field.rb', line 211 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
277 278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'lib/docusign_esign/models/merge_field.rb', line 277 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
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/docusign_esign/models/merge_field.rb', line 190 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
177 178 179 |
# File 'lib/docusign_esign/models/merge_field.rb', line 177 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
183 184 185 |
# File 'lib/docusign_esign/models/merge_field.rb', line 183 def hash [allow_sender_to_edit, , configuration_type, , path, path_extended, , , row, , write_back, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
145 146 147 148 |
# File 'lib/docusign_esign/models/merge_field.rb', line 145 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
257 258 259 |
# File 'lib/docusign_esign/models/merge_field.rb', line 257 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
263 264 265 266 267 268 269 270 271 |
# File 'lib/docusign_esign/models/merge_field.rb', line 263 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
251 252 253 |
# File 'lib/docusign_esign/models/merge_field.rb', line 251 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
152 153 154 |
# File 'lib/docusign_esign/models/merge_field.rb', line 152 def valid? true end |