Class: DocuSign_eSign::TabMetadata
- Inherits:
-
Object
- Object
- DocuSign_eSign::TabMetadata
- Defined in:
- lib/docusign_esign/models/tab_metadata.rb
Instance Attribute Summary collapse
-
#anchor ⇒ Object
An optional string that is used to auto-match tabs to strings located in the documents of an envelope.
-
#anchor_case_sensitive ⇒ Object
When set to true, the anchor string does not consider case when matching strings in the document.
-
#anchor_horizontal_alignment ⇒ Object
Specifies the alignment of anchor tabs with anchor strings.
-
#anchor_ignore_if_not_present ⇒ Object
When set to true, this tab is ignored if anchorString is not found in the document.
-
#anchor_match_whole_word ⇒ Object
When set to true, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is true.
-
#anchor_units ⇒ Object
Specifies units of the X and Y offset.
-
#anchor_x_offset ⇒ Object
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
-
#anchor_y_offset ⇒ Object
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
-
#bold ⇒ Object
When set to true, the information in the tab is bold.
-
#collaborative ⇒ Object
Returns the value of attribute collaborative.
-
#conceal_value_on_document ⇒ Object
When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.
-
#created_by_display_name ⇒ Object
The user name of the DocuSign user who created this object.
-
#created_by_user_id ⇒ Object
The userId of the DocuSign user who created this object.
-
#custom_tab_id ⇒ Object
The DocuSign generated custom tab ID for the custom tab to be applied.
-
#disable_auto_size ⇒ Object
When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.
-
#editable ⇒ Object
When set to true, the custom tab is editable.
-
#font ⇒ Object
The font to be used for the tab value.
-
#font_color ⇒ Object
The font color used for the information in the tab.
-
#font_size ⇒ Object
The font size used for the information in the tab.
-
#height ⇒ Object
Height of the tab in pixels.
-
#included_in_email ⇒ Object
When set to true, the tab is included in e-mails related to the envelope on which it exists.
-
#initial_value ⇒ Object
The original value of the tab.
-
#italic ⇒ Object
When set to true, the information in the tab is italic.
-
#items ⇒ Object
If the tab is a list, this represents the values that are possible for the tab.
-
#last_modified ⇒ Object
The UTC DateTime this object was last modified.
-
#last_modified_by_display_name ⇒ Object
The User Name of the DocuSign user who last modified this object.
-
#last_modified_by_user_id ⇒ Object
The userId of the DocuSign user who last modified this object.
-
#locale_policy ⇒ Object
Returns the value of attribute locale_policy.
-
#locked ⇒ Object
When set to true, the signer cannot change the data of the custom tab.
-
#max_numerical_value ⇒ Object
Returns the value of attribute max_numerical_value.
-
#maximum_length ⇒ Object
The maximum number of entry characters supported by the custom tab.
-
#merge_field ⇒ Object
Returns the value of attribute merge_field.
-
#min_numerical_value ⇒ Object
Returns the value of attribute min_numerical_value.
-
#name ⇒ Object
Returns the value of attribute name.
-
#numerical_value ⇒ Object
Returns the value of attribute numerical_value.
-
#payment_item_code ⇒ Object
Returns the value of attribute payment_item_code.
-
#payment_item_description ⇒ Object
Returns the value of attribute payment_item_description.
-
#payment_item_name ⇒ Object
Returns the value of attribute payment_item_name.
-
#require_all ⇒ Object
When set to true and shared is true, information must be entered in this field to complete the envelope.
-
#require_initial_on_shared_change ⇒ Object
Optional element for field markup.
-
#required ⇒ Object
When set to true, the signer is required to fill out this tab.
-
#scale_value ⇒ Object
Returns the value of attribute scale_value.
-
#selected ⇒ Object
Returns the value of attribute selected.
-
#shared ⇒ Object
When set to true, this custom tab is shared.
-
#stamp_type ⇒ Object
Returns the value of attribute stamp_type.
-
#stamp_type_metadata ⇒ Object
Returns the value of attribute stamp_type_metadata.
-
#tab_label ⇒ Object
The label string associated with the tab.
-
#type ⇒ Object
The type of this tab.
-
#underline ⇒ Object
When set to true, the information in the tab is underlined.
-
#validation_message ⇒ Object
The message displayed if the custom tab fails input validation (either custom of embedded).
-
#validation_pattern ⇒ Object
A regular expression used to validate input for the tab.
-
#width ⇒ Object
Width of the tab in pixels.
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 = {}) ⇒ TabMetadata
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 = {}) ⇒ TabMetadata
Initializes the object
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 287 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?(:'anchor') self.anchor = attributes[:'anchor'] end if attributes.has_key?(:'anchorCaseSensitive') self.anchor_case_sensitive = attributes[:'anchorCaseSensitive'] end if attributes.has_key?(:'anchorHorizontalAlignment') self.anchor_horizontal_alignment = attributes[:'anchorHorizontalAlignment'] end if attributes.has_key?(:'anchorIgnoreIfNotPresent') self.anchor_ignore_if_not_present = attributes[:'anchorIgnoreIfNotPresent'] end if attributes.has_key?(:'anchorMatchWholeWord') self.anchor_match_whole_word = attributes[:'anchorMatchWholeWord'] end if attributes.has_key?(:'anchorUnits') self.anchor_units = attributes[:'anchorUnits'] end if attributes.has_key?(:'anchorXOffset') self.anchor_x_offset = attributes[:'anchorXOffset'] end if attributes.has_key?(:'anchorYOffset') self.anchor_y_offset = attributes[:'anchorYOffset'] end if attributes.has_key?(:'bold') self.bold = attributes[:'bold'] end if attributes.has_key?(:'collaborative') self.collaborative = attributes[:'collaborative'] end if attributes.has_key?(:'concealValueOnDocument') self.conceal_value_on_document = attributes[:'concealValueOnDocument'] end if attributes.has_key?(:'createdByDisplayName') self.created_by_display_name = attributes[:'createdByDisplayName'] end if attributes.has_key?(:'createdByUserId') self.created_by_user_id = attributes[:'createdByUserId'] end if attributes.has_key?(:'customTabId') self.custom_tab_id = attributes[:'customTabId'] end if attributes.has_key?(:'disableAutoSize') self.disable_auto_size = attributes[:'disableAutoSize'] end if attributes.has_key?(:'editable') self.editable = attributes[:'editable'] end if attributes.has_key?(:'font') self.font = attributes[:'font'] end if attributes.has_key?(:'fontColor') self.font_color = attributes[:'fontColor'] end if attributes.has_key?(:'fontSize') self.font_size = attributes[:'fontSize'] end if attributes.has_key?(:'height') self.height = attributes[:'height'] end if attributes.has_key?(:'includedInEmail') self.included_in_email = attributes[:'includedInEmail'] end if attributes.has_key?(:'initialValue') self.initial_value = attributes[:'initialValue'] end if attributes.has_key?(:'italic') self.italic = attributes[:'italic'] end if attributes.has_key?(:'items') if (value = attributes[:'items']).is_a?(Array) self.items = value end end if attributes.has_key?(:'lastModified') self.last_modified = attributes[:'lastModified'] end if attributes.has_key?(:'lastModifiedByDisplayName') self.last_modified_by_display_name = attributes[:'lastModifiedByDisplayName'] end if attributes.has_key?(:'lastModifiedByUserId') self.last_modified_by_user_id = attributes[:'lastModifiedByUserId'] end if attributes.has_key?(:'localePolicy') self.locale_policy = attributes[:'localePolicy'] end if attributes.has_key?(:'locked') self.locked = attributes[:'locked'] end if attributes.has_key?(:'maximumLength') self.maximum_length = attributes[:'maximumLength'] end if attributes.has_key?(:'maxNumericalValue') self.max_numerical_value = attributes[:'maxNumericalValue'] end if attributes.has_key?(:'mergeField') self.merge_field = attributes[:'mergeField'] end if attributes.has_key?(:'minNumericalValue') self.min_numerical_value = attributes[:'minNumericalValue'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'numericalValue') self.numerical_value = attributes[:'numericalValue'] end if attributes.has_key?(:'paymentItemCode') self.payment_item_code = attributes[:'paymentItemCode'] end if attributes.has_key?(:'paymentItemDescription') self.payment_item_description = attributes[:'paymentItemDescription'] end if attributes.has_key?(:'paymentItemName') self.payment_item_name = attributes[:'paymentItemName'] end if attributes.has_key?(:'requireAll') self.require_all = attributes[:'requireAll'] end if attributes.has_key?(:'required') self.required = attributes[:'required'] end if attributes.has_key?(:'requireInitialOnSharedChange') self.require_initial_on_shared_change = attributes[:'requireInitialOnSharedChange'] end if attributes.has_key?(:'scaleValue') self.scale_value = attributes[:'scaleValue'] end if attributes.has_key?(:'selected') self.selected = attributes[:'selected'] end if attributes.has_key?(:'shared') self.shared = attributes[:'shared'] end if attributes.has_key?(:'stampType') self.stamp_type = attributes[:'stampType'] end if attributes.has_key?(:'stampTypeMetadata') self. = attributes[:'stampTypeMetadata'] end if attributes.has_key?(:'tabLabel') self.tab_label = attributes[:'tabLabel'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'underline') self.underline = attributes[:'underline'] end if attributes.has_key?(:'validationMessage') self. = attributes[:'validationMessage'] end if attributes.has_key?(:'validationPattern') self.validation_pattern = attributes[:'validationPattern'] end if attributes.has_key?(:'width') self.width = attributes[:'width'] end end |
Instance Attribute Details
#anchor ⇒ Object
An optional string that is used to auto-match tabs to strings located in the documents of an envelope.
17 18 19 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 17 def anchor @anchor end |
#anchor_case_sensitive ⇒ Object
When set to true, the anchor string does not consider case when matching strings in the document. The default value is true.
20 21 22 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 20 def anchor_case_sensitive @anchor_case_sensitive end |
#anchor_horizontal_alignment ⇒ Object
Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left.
23 24 25 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 23 def anchor_horizontal_alignment @anchor_horizontal_alignment end |
#anchor_ignore_if_not_present ⇒ Object
When set to true, this tab is ignored if anchorString is not found in the document.
26 27 28 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 26 def anchor_ignore_if_not_present @anchor_ignore_if_not_present end |
#anchor_match_whole_word ⇒ Object
When set to true, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is true.
29 30 31 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 29 def anchor_match_whole_word @anchor_match_whole_word end |
#anchor_units ⇒ Object
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
32 33 34 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 32 def anchor_units @anchor_units end |
#anchor_x_offset ⇒ Object
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
35 36 37 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 35 def anchor_x_offset @anchor_x_offset end |
#anchor_y_offset ⇒ Object
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
38 39 40 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 38 def anchor_y_offset @anchor_y_offset end |
#bold ⇒ Object
When set to true, the information in the tab is bold.
41 42 43 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 41 def bold @bold end |
#collaborative ⇒ Object
Returns the value of attribute collaborative.
44 45 46 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 44 def collaborative @collaborative end |
#conceal_value_on_document ⇒ Object
When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
47 48 49 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 47 def conceal_value_on_document @conceal_value_on_document end |
#created_by_display_name ⇒ Object
The user name of the DocuSign user who created this object.
50 51 52 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 50 def created_by_display_name @created_by_display_name end |
#created_by_user_id ⇒ Object
The userId of the DocuSign user who created this object.
53 54 55 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 53 def created_by_user_id @created_by_user_id end |
#custom_tab_id ⇒ Object
The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
56 57 58 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 56 def custom_tab_id @custom_tab_id end |
#disable_auto_size ⇒ Object
When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
59 60 61 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 59 def disable_auto_size @disable_auto_size end |
#editable ⇒ Object
When set to true, the custom tab is editable. Otherwise the custom tab cannot be modified.
62 63 64 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 62 def editable @editable end |
#font ⇒ Object
The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
65 66 67 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 65 def font @font end |
#font_color ⇒ Object
The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
68 69 70 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 68 def font_color @font_color end |
#font_size ⇒ Object
The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
71 72 73 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 71 def font_size @font_size end |
#height ⇒ Object
Height of the tab in pixels.
74 75 76 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 74 def height @height end |
#included_in_email ⇒ Object
When set to true, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.
77 78 79 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 77 def included_in_email @included_in_email end |
#initial_value ⇒ Object
The original value of the tab.
80 81 82 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 80 def initial_value @initial_value end |
#italic ⇒ Object
When set to true, the information in the tab is italic.
83 84 85 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 83 def italic @italic end |
#items ⇒ Object
If the tab is a list, this represents the values that are possible for the tab.
86 87 88 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 86 def items @items end |
#last_modified ⇒ Object
The UTC DateTime this object was last modified. This is in ISO8601 format.
89 90 91 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 89 def last_modified @last_modified end |
#last_modified_by_display_name ⇒ Object
The User Name of the DocuSign user who last modified this object.
92 93 94 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 92 def last_modified_by_display_name @last_modified_by_display_name end |
#last_modified_by_user_id ⇒ Object
The userId of the DocuSign user who last modified this object.
95 96 97 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 95 def last_modified_by_user_id @last_modified_by_user_id end |
#locale_policy ⇒ Object
Returns the value of attribute locale_policy.
97 98 99 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 97 def locale_policy @locale_policy end |
#locked ⇒ Object
When set to true, the signer cannot change the data of the custom tab.
100 101 102 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 100 def locked @locked end |
#max_numerical_value ⇒ Object
Returns the value of attribute max_numerical_value.
106 107 108 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 106 def max_numerical_value @max_numerical_value end |
#maximum_length ⇒ Object
The maximum number of entry characters supported by the custom tab.
103 104 105 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 103 def maximum_length @maximum_length end |
#merge_field ⇒ Object
Returns the value of attribute merge_field.
108 109 110 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 108 def merge_field @merge_field end |
#min_numerical_value ⇒ Object
Returns the value of attribute min_numerical_value.
111 112 113 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 111 def min_numerical_value @min_numerical_value end |
#name ⇒ Object
Returns the value of attribute name.
114 115 116 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 114 def name @name end |
#numerical_value ⇒ Object
Returns the value of attribute numerical_value.
117 118 119 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 117 def numerical_value @numerical_value end |
#payment_item_code ⇒ Object
Returns the value of attribute payment_item_code.
120 121 122 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 120 def payment_item_code @payment_item_code end |
#payment_item_description ⇒ Object
Returns the value of attribute payment_item_description.
123 124 125 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 123 def payment_item_description @payment_item_description end |
#payment_item_name ⇒ Object
Returns the value of attribute payment_item_name.
126 127 128 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 126 def payment_item_name @payment_item_name end |
#require_all ⇒ Object
When set to true and shared is true, information must be entered in this field to complete the envelope.
129 130 131 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 129 def require_all @require_all end |
#require_initial_on_shared_change ⇒ Object
Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
135 136 137 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 135 def require_initial_on_shared_change @require_initial_on_shared_change end |
#required ⇒ Object
When set to true, the signer is required to fill out this tab
132 133 134 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 132 def required @required end |
#scale_value ⇒ Object
Returns the value of attribute scale_value.
138 139 140 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 138 def scale_value @scale_value end |
#selected ⇒ Object
Returns the value of attribute selected.
141 142 143 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 141 def selected @selected end |
#shared ⇒ Object
When set to true, this custom tab is shared.
144 145 146 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 144 def shared @shared end |
#stamp_type ⇒ Object
Returns the value of attribute stamp_type.
147 148 149 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 147 def stamp_type @stamp_type end |
#stamp_type_metadata ⇒ Object
Returns the value of attribute stamp_type_metadata.
149 150 151 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 149 def @stamp_type_metadata end |
#tab_label ⇒ Object
The label string associated with the tab.
152 153 154 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 152 def tab_label @tab_label end |
#type ⇒ Object
The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4.
155 156 157 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 155 def type @type end |
#underline ⇒ Object
When set to true, the information in the tab is underlined.
158 159 160 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 158 def underline @underline end |
#validation_message ⇒ Object
The message displayed if the custom tab fails input validation (either custom of embedded).
161 162 163 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 161 def @validation_message end |
#validation_pattern ⇒ Object
A regular expression used to validate input for the tab.
164 165 166 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 164 def validation_pattern @validation_pattern end |
#width ⇒ Object
Width of the tab in pixels.
167 168 169 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 167 def width @width end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 170 def self.attribute_map { :'anchor' => :'anchor', :'anchor_case_sensitive' => :'anchorCaseSensitive', :'anchor_horizontal_alignment' => :'anchorHorizontalAlignment', :'anchor_ignore_if_not_present' => :'anchorIgnoreIfNotPresent', :'anchor_match_whole_word' => :'anchorMatchWholeWord', :'anchor_units' => :'anchorUnits', :'anchor_x_offset' => :'anchorXOffset', :'anchor_y_offset' => :'anchorYOffset', :'bold' => :'bold', :'collaborative' => :'collaborative', :'conceal_value_on_document' => :'concealValueOnDocument', :'created_by_display_name' => :'createdByDisplayName', :'created_by_user_id' => :'createdByUserId', :'custom_tab_id' => :'customTabId', :'disable_auto_size' => :'disableAutoSize', :'editable' => :'editable', :'font' => :'font', :'font_color' => :'fontColor', :'font_size' => :'fontSize', :'height' => :'height', :'included_in_email' => :'includedInEmail', :'initial_value' => :'initialValue', :'italic' => :'italic', :'items' => :'items', :'last_modified' => :'lastModified', :'last_modified_by_display_name' => :'lastModifiedByDisplayName', :'last_modified_by_user_id' => :'lastModifiedByUserId', :'locale_policy' => :'localePolicy', :'locked' => :'locked', :'maximum_length' => :'maximumLength', :'max_numerical_value' => :'maxNumericalValue', :'merge_field' => :'mergeField', :'min_numerical_value' => :'minNumericalValue', :'name' => :'name', :'numerical_value' => :'numericalValue', :'payment_item_code' => :'paymentItemCode', :'payment_item_description' => :'paymentItemDescription', :'payment_item_name' => :'paymentItemName', :'require_all' => :'requireAll', :'required' => :'required', :'require_initial_on_shared_change' => :'requireInitialOnSharedChange', :'scale_value' => :'scaleValue', :'selected' => :'selected', :'shared' => :'shared', :'stamp_type' => :'stampType', :'stamp_type_metadata' => :'stampTypeMetadata', :'tab_label' => :'tabLabel', :'type' => :'type', :'underline' => :'underline', :'validation_message' => :'validationMessage', :'validation_pattern' => :'validationPattern', :'width' => :'width' } end |
.swagger_types ⇒ Object
Attribute type mapping.
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 228 def self.swagger_types { :'anchor' => :'String', :'anchor_case_sensitive' => :'String', :'anchor_horizontal_alignment' => :'String', :'anchor_ignore_if_not_present' => :'String', :'anchor_match_whole_word' => :'String', :'anchor_units' => :'String', :'anchor_x_offset' => :'String', :'anchor_y_offset' => :'String', :'bold' => :'String', :'collaborative' => :'String', :'conceal_value_on_document' => :'String', :'created_by_display_name' => :'String', :'created_by_user_id' => :'String', :'custom_tab_id' => :'String', :'disable_auto_size' => :'String', :'editable' => :'String', :'font' => :'String', :'font_color' => :'String', :'font_size' => :'String', :'height' => :'String', :'included_in_email' => :'String', :'initial_value' => :'String', :'italic' => :'String', :'items' => :'Array<String>', :'last_modified' => :'String', :'last_modified_by_display_name' => :'String', :'last_modified_by_user_id' => :'String', :'locale_policy' => :'LocalePolicyTab', :'locked' => :'String', :'maximum_length' => :'String', :'max_numerical_value' => :'String', :'merge_field' => :'MergeField', :'min_numerical_value' => :'String', :'name' => :'String', :'numerical_value' => :'String', :'payment_item_code' => :'String', :'payment_item_description' => :'String', :'payment_item_name' => :'String', :'require_all' => :'String', :'required' => :'String', :'require_initial_on_shared_change' => :'String', :'scale_value' => :'String', :'selected' => :'String', :'shared' => :'String', :'stamp_type' => :'String', :'stamp_type_metadata' => :'PropertyMetadata', :'tab_label' => :'String', :'type' => :'String', :'underline' => :'String', :'validation_message' => :'String', :'validation_pattern' => :'String', :'width' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 519 def ==(o) return true if self.equal?(o) self.class == o.class && anchor == o.anchor && anchor_case_sensitive == o.anchor_case_sensitive && anchor_horizontal_alignment == o.anchor_horizontal_alignment && anchor_ignore_if_not_present == o.anchor_ignore_if_not_present && anchor_match_whole_word == o.anchor_match_whole_word && anchor_units == o.anchor_units && anchor_x_offset == o.anchor_x_offset && anchor_y_offset == o.anchor_y_offset && bold == o.bold && collaborative == o.collaborative && conceal_value_on_document == o.conceal_value_on_document && created_by_display_name == o.created_by_display_name && created_by_user_id == o.created_by_user_id && custom_tab_id == o.custom_tab_id && disable_auto_size == o.disable_auto_size && editable == o.editable && font == o.font && font_color == o.font_color && font_size == o.font_size && height == o.height && included_in_email == o.included_in_email && initial_value == o.initial_value && italic == o.italic && items == o.items && last_modified == o.last_modified && last_modified_by_display_name == o.last_modified_by_display_name && last_modified_by_user_id == o.last_modified_by_user_id && locale_policy == o.locale_policy && locked == o.locked && maximum_length == o.maximum_length && max_numerical_value == o.max_numerical_value && merge_field == o.merge_field && min_numerical_value == o.min_numerical_value && name == o.name && numerical_value == o.numerical_value && payment_item_code == o.payment_item_code && payment_item_description == o.payment_item_description && payment_item_name == o.payment_item_name && require_all == o.require_all && required == o.required && require_initial_on_shared_change == o.require_initial_on_shared_change && scale_value == o.scale_value && selected == o.selected && shared == o.shared && stamp_type == o.stamp_type && == o. && tab_label == o.tab_label && type == o.type && underline == o.underline && == o. && validation_pattern == o.validation_pattern && width == o.width end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 612 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
678 679 680 681 682 683 684 685 686 687 688 689 690 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 678 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
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 591 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
578 579 580 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 578 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
584 585 586 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 584 def hash [anchor, anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_units, anchor_x_offset, anchor_y_offset, bold, collaborative, conceal_value_on_document, created_by_display_name, created_by_user_id, custom_tab_id, disable_auto_size, editable, font, font_color, font_size, height, included_in_email, initial_value, italic, items, last_modified, last_modified_by_display_name, last_modified_by_user_id, locale_policy, locked, maximum_length, max_numerical_value, merge_field, min_numerical_value, name, numerical_value, payment_item_code, payment_item_description, payment_item_name, require_all, required, require_initial_on_shared_change, scale_value, selected, shared, stamp_type, , tab_label, type, underline, , validation_pattern, width].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
506 507 508 509 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 506 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
658 659 660 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 658 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
664 665 666 667 668 669 670 671 672 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 664 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
652 653 654 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 652 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
513 514 515 |
# File 'lib/docusign_esign/models/tab_metadata.rb', line 513 def valid? true end |