Class: DocuSign_eSign::EnvelopeId

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnvelopeId

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
226
227
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
284
285
286
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
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 185

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?(:'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?(:'anchorString')
    self.anchor_string = attributes[:'anchorString']
  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?(:'conditionalParentLabel')
    self.conditional_parent_label = attributes[:'conditionalParentLabel']
  end

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

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

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

  if attributes.has_key?(:'errorDetails')
    self.error_details = attributes[:'errorDetails']
  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?(:'italic')
    self.italic = attributes[:'italic']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#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.



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

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.



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

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.



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

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.



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

def anchor_match_whole_word
  @anchor_match_whole_word
end

#anchor_string ⇒ Object

Anchor text information for a radio button.



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

def anchor_string
  @anchor_string
end

#anchor_units ⇒ Object

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.



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

def anchor_units
  @anchor_units
end

#anchor_x_offset ⇒ Object

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.



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

def anchor_x_offset
  @anchor_x_offset
end

#anchor_y_offset ⇒ Object

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.



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

def anchor_y_offset
  @anchor_y_offset
end

#bold ⇒ Object

When set to true, the information in the tab is bold.



42
43
44
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 42

def bold
  @bold
end

#conditional_parent_label ⇒ Object

For conditional fields this is the TabLabel of the parent tab that controls this tab’s visibility.



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

def conditional_parent_label
  @conditional_parent_label
end

#conditional_parent_value ⇒ Object

For conditional fields, this is the value of the parent tab that controls the tab’s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.



48
49
50
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 48

def conditional_parent_value
  @conditional_parent_value
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.



51
52
53
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 51

def custom_tab_id
  @custom_tab_id
end

#document_id ⇒ Object

Specifies the document ID number that the tab is placed on. This must refer to an existing Document’s ID attribute.



54
55
56
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 54

def document_id
  @document_id
end

#error_details ⇒ Object

Returns the value of attribute error_details.



56
57
58
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 56

def error_details
  @error_details
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.



59
60
61
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 59

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.



62
63
64
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 62

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.



65
66
67
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 65

def font_size
  @font_size
end

#italic ⇒ Object

When set to true, the information in the tab is italic.



68
69
70
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 68

def italic
  @italic
end

#merge_field ⇒ Object

Returns the value of attribute merge_field.



70
71
72
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 70

def merge_field
  @merge_field
end

#name ⇒ Object

Returns the value of attribute name.



73
74
75
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 73

def name
  @name
end

#page_number ⇒ Object

Specifies the page number on which the tab is located.



76
77
78
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 76

def page_number
  @page_number
end

#recipient_id ⇒ Object

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.



79
80
81
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 79

def recipient_id
  @recipient_id
end

#status ⇒ Object

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.



82
83
84
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 82

def status
  @status
end

#tab_id ⇒ Object

The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].



85
86
87
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 85

def tab_id
  @tab_id
end

#tab_label ⇒ Object

The label string associated with the tab.



88
89
90
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 88

def tab_label
  @tab_label
end

#tab_order ⇒ Object

Returns the value of attribute tab_order.



91
92
93
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 91

def tab_order
  @tab_order
end

#template_locked ⇒ Object

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.



94
95
96
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 94

def template_locked
  @template_locked
end

#template_required ⇒ Object

When set to true, the sender may not remove the recipient. Used only when working with template recipients.



97
98
99
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 97

def template_required
  @template_required
end

#underline ⇒ Object

When set to true, the information in the tab is underlined.



100
101
102
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 100

def underline
  @underline
end

#x_position ⇒ Object

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.



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

def x_position
  @x_position
end

#y_position ⇒ Object

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.



106
107
108
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 106

def y_position
  @y_position
end

Class Method Details

.attribute_map ⇒ Object

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



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
142
143
144
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 110

def self.attribute_map
  {
    :'anchor_case_sensitive' => :'anchorCaseSensitive',
    :'anchor_horizontal_alignment' => :'anchorHorizontalAlignment',
    :'anchor_ignore_if_not_present' => :'anchorIgnoreIfNotPresent',
    :'anchor_match_whole_word' => :'anchorMatchWholeWord',
    :'anchor_string' => :'anchorString',
    :'anchor_units' => :'anchorUnits',
    :'anchor_x_offset' => :'anchorXOffset',
    :'anchor_y_offset' => :'anchorYOffset',
    :'bold' => :'bold',
    :'conditional_parent_label' => :'conditionalParentLabel',
    :'conditional_parent_value' => :'conditionalParentValue',
    :'custom_tab_id' => :'customTabId',
    :'document_id' => :'documentId',
    :'error_details' => :'errorDetails',
    :'font' => :'font',
    :'font_color' => :'fontColor',
    :'font_size' => :'fontSize',
    :'italic' => :'italic',
    :'merge_field' => :'mergeField',
    :'name' => :'name',
    :'page_number' => :'pageNumber',
    :'recipient_id' => :'recipientId',
    :'status' => :'status',
    :'tab_id' => :'tabId',
    :'tab_label' => :'tabLabel',
    :'tab_order' => :'tabOrder',
    :'template_locked' => :'templateLocked',
    :'template_required' => :'templateRequired',
    :'underline' => :'underline',
    :'x_position' => :'xPosition',
    :'y_position' => :'yPosition'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 147

def self.swagger_types
  {
    :'anchor_case_sensitive' => :'String',
    :'anchor_horizontal_alignment' => :'String',
    :'anchor_ignore_if_not_present' => :'String',
    :'anchor_match_whole_word' => :'String',
    :'anchor_string' => :'String',
    :'anchor_units' => :'String',
    :'anchor_x_offset' => :'String',
    :'anchor_y_offset' => :'String',
    :'bold' => :'String',
    :'conditional_parent_label' => :'String',
    :'conditional_parent_value' => :'String',
    :'custom_tab_id' => :'String',
    :'document_id' => :'String',
    :'error_details' => :'ErrorDetails',
    :'font' => :'String',
    :'font_color' => :'String',
    :'font_size' => :'String',
    :'italic' => :'String',
    :'merge_field' => :'MergeField',
    :'name' => :'String',
    :'page_number' => :'String',
    :'recipient_id' => :'String',
    :'status' => :'String',
    :'tab_id' => :'String',
    :'tab_label' => :'String',
    :'tab_order' => :'String',
    :'template_locked' => :'String',
    :'template_required' => :'String',
    :'underline' => :'String',
    :'x_position' => :'String',
    :'y_position' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 332

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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_string == o.anchor_string &&
      anchor_units == o.anchor_units &&
      anchor_x_offset == o.anchor_x_offset &&
      anchor_y_offset == o.anchor_y_offset &&
      bold == o.bold &&
      conditional_parent_label == o.conditional_parent_label &&
      conditional_parent_value == o.conditional_parent_value &&
      custom_tab_id == o.custom_tab_id &&
      document_id == o.document_id &&
      error_details == o.error_details &&
      font == o.font &&
      font_color == o.font_color &&
      font_size == o.font_size &&
      italic == o.italic &&
      merge_field == o.merge_field &&
      name == o.name &&
      page_number == o.page_number &&
      recipient_id == o.recipient_id &&
      status == o.status &&
      tab_id == o.tab_id &&
      tab_label == o.tab_label &&
      tab_order == o.tab_order &&
      template_locked == o.template_locked &&
      template_required == o.template_required &&
      underline == o.underline &&
      x_position == o.x_position &&
      y_position == o.y_position
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



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
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 404

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



470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 470

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



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 383

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


370
371
372
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 370

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



376
377
378
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 376

def hash
  [anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_string, anchor_units, anchor_x_offset, anchor_y_offset, bold, conditional_parent_label, conditional_parent_value, custom_tab_id, document_id, error_details, font, font_color, font_size, italic, merge_field, name, page_number, recipient_id, status, tab_id, tab_label, tab_order, template_locked, template_required, underline, x_position, y_position].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



319
320
321
322
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 319

def list_invalid_properties
  invalid_properties = Array.new
  return 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



450
451
452
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 450

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



456
457
458
459
460
461
462
463
464
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 456

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



444
445
446
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 444

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



326
327
328
 
# File 'lib/docusign_esign/models/envelope_id.rb', line 326

def valid?
  return true
end