Class: Dropbox::Sign::SubFormFieldsPerDocumentBase

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox-sign/models/sub_form_fields_per_document_base.rb

Overview

The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use ‘SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubFormFieldsPerDocumentBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
226
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 170

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SubFormFieldsPerDocumentBase` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.merged_attributes.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentBase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'document_index')
    self.document_index = attributes[:'document_index']
  end

  if attributes.key?(:'api_id')
    self.api_id = attributes[:'api_id']
  end

  if attributes.key?(:'height')
    self.height = attributes[:'height']
  end

  if attributes.key?(:'required')
    self.required = attributes[:'required']
  end

  if attributes.key?(:'signer')
    self.signer = attributes[:'signer']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'width')
    self.width = attributes[:'width']
  end

  if attributes.key?(:'x')
    self.x = attributes[:'x']
  end

  if attributes.key?(:'y')
    self.y = attributes[:'y']
  end

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

  if attributes.key?(:'page')
    self.page = attributes[:'page']
  end
end

Instance Attribute Details

#api_id ⇒ String

An identifier for the field that is unique across all documents in the request.

Returns:

  • (String) 


28
29
30
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 28

def api_id
  @api_id
end

#document_index ⇒ Integer

Represents the integer index of the ‘file` or `file_url` document the field should be attached to.

Returns:

  • (Integer) 


24
25
26
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 24

def document_index
  @document_index
end

#height ⇒ Integer

Size of the field in pixels.

Returns:

  • (Integer) 


32
33
34
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 32

def height
  @height
end

#name ⇒ String

Display name for the field.

Returns:

  • (String) 


59
60
61
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 59

def name
  @name
end

#page ⇒ Integer?

Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.

Returns:

  • (Integer, nil) 


63
64
65
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 63

def page
  @page
end

#required ⇒ Boolean

Whether this field is required.

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 36

def required
  @required
end

#signer ⇒ Integer, String

Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. NOTE: To set the value of the field as the preparer you must set this to ‘me_now` NOTE: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.

Returns:

  • (Integer, String) 


40
41
42
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 40

def signer
  @signer
end

#type ⇒ String

Returns:

  • (String) 


43
44
45
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 43

def type
  @type
end

#width ⇒ Integer

Size of the field in pixels.

Returns:

  • (Integer) 


47
48
49
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 47

def width
  @width
end

#x ⇒ Integer

Location coordinates of the field in pixels.

Returns:

  • (Integer) 


51
52
53
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 51

def x
  @x
end

#y ⇒ Integer

Location coordinates of the field in pixels.

Returns:

  • (Integer) 


55
56
57
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 55

def y
  @y
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 83

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 66

def self.attribute_map
  {
    :'document_index' => :'document_index',
    :'api_id' => :'api_id',
    :'height' => :'height',
    :'required' => :'required',
    :'signer' => :'signer',
    :'type' => :'type',
    :'width' => :'width',
    :'x' => :'x',
    :'y' => :'y',
    :'name' => :'name',
    :'page' => :'page'
  }
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



319
320
321
322
323
324
325
326
327
328
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 319

def self.build_from_hash(attributes)
  if !attributes[self.openapi_discriminator_name].nil?
    klass = self.discriminator_class_name(attributes[self.openapi_discriminator_name])
    if klass != new.class.to_s
      obj = Object.const_get(klass).new.build_from_hash(attributes)
      return obj
    end
  end
  new.build_from_hash(attributes)
end

.discriminator_class_name(value) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 131

def self.discriminator_class_name(value)
  return nil unless value.is_a?(String)

  if value == 'checkbox'
    return "Dropbox::Sign::SubFormFieldsPerDocumentCheckbox"
  end
  if value == 'checkbox-merge'
    return "Dropbox::Sign::SubFormFieldsPerDocumentCheckboxMerge"
  end
  if value == 'date_signed'
    return "Dropbox::Sign::SubFormFieldsPerDocumentDateSigned"
  end
  if value == 'dropdown'
    return "Dropbox::Sign::SubFormFieldsPerDocumentDropdown"
  end
  if value == 'hyperlink'
    return "Dropbox::Sign::SubFormFieldsPerDocumentHyperlink"
  end
  if value == 'initials'
    return "Dropbox::Sign::SubFormFieldsPerDocumentInitials"
  end
  if value == 'radio'
    return "Dropbox::Sign::SubFormFieldsPerDocumentRadio"
  end
  if value == 'signature'
    return "Dropbox::Sign::SubFormFieldsPerDocumentSignature"
  end
  if value == 'text'
    return "Dropbox::Sign::SubFormFieldsPerDocumentText"
  end
  if value == 'text-merge'
    return "Dropbox::Sign::SubFormFieldsPerDocumentTextMerge"
  end

  nil
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



112
113
114
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 112

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

Returns list of attributes with nullable: true of this model + parent



122
123
124
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 122

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



117
118
119
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 117

def self.merged_types
  self.openapi_types
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



127
128
129
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 127

def self.openapi_discriminator_name
  :'type'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



105
106
107
108
109
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 105

def self.openapi_nullable
  Set.new([
    :'page'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 88

def self.openapi_types
  {
    :'document_index' => :'Integer',
    :'api_id' => :'String',
    :'height' => :'Integer',
    :'required' => :'Boolean',
    :'signer' => :'String',
    :'type' => :'String',
    :'width' => :'Integer',
    :'x' => :'Integer',
    :'y' => :'Integer',
    :'name' => :'String',
    :'page' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 288

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      document_index == o.document_index &&
      api_id == o.api_id &&
      height == o.height &&
      required == o.required &&
      signer == o.signer &&
      type == o.type &&
      width == o.width &&
      x == o.x &&
      y == o.y &&
      name == o.name &&
      page == o.page
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



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
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 356

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    klass = Dropbox::Sign.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value, include_nil = true) ⇒ 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



427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 427

def _to_hash(value, include_nil = true)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v, include_nil) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(include_nil)
  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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 333

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attribute_map = self.class.merged_attributes

  self.class.merged_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


306
307
308
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 306

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



312
313
314
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 312

def hash
  [document_index, api_id, height, required, signer, type, width, x, y, name, page].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



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
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 230

def list_invalid_properties
  invalid_properties = Array.new
  if @document_index.nil?
    invalid_properties.push('invalid value for "document_index", document_index cannot be nil.')
  end

  if @api_id.nil?
    invalid_properties.push('invalid value for "api_id", api_id cannot be nil.')
  end

  if @height.nil?
    invalid_properties.push('invalid value for "height", height cannot be nil.')
  end

  if @required.nil?
    invalid_properties.push('invalid value for "required", required cannot be nil.')
  end

  if @signer.nil?
    invalid_properties.push('invalid value for "signer", signer cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @width.nil?
    invalid_properties.push('invalid value for "width", width cannot be nil.')
  end

  if @x.nil?
    invalid_properties.push('invalid value for "x", x cannot be nil.')
  end

  if @y.nil?
    invalid_properties.push('invalid value for "y", y cannot be nil.')
  end

  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



402
403
404
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 402

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 408

def to_hash(include_nil = true)
  hash = {}
  self.class.merged_attributes.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      next unless include_nil
      is_nullable = self.class.merged_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value, include_nil)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



396
397
398
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 396

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



273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_base.rb', line 273

def valid?
  return false if @document_index.nil?
  return false if @api_id.nil?
  return false if @height.nil?
  return false if @required.nil?
  return false if @signer.nil?
  return false if @type.nil?
  return false if @width.nil?
  return false if @x.nil?
  return false if @y.nil?
  true
end