Class: Dropbox::Sign::TemplateResponseDocumentCustomFieldBase

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

Overview

An array of Form Field objects containing the name and type of each named field.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateResponseDocumentCustomFieldBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 141

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::TemplateResponseDocumentCustomFieldBase` 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::TemplateResponseDocumentCustomFieldBase`. 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?(:'type')
    self.type = attributes[:'type']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_id ⇒ String

The unique ID for this field.

Returns:

  • (String) 


27
28
29
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 27

def api_id
  @api_id
end

#group ⇒ String?

The name of the group this field is in. If this field is not a group, this defaults to ‘null`.

Returns:

  • (String, nil) 


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

def group
  @group
end

#height ⇒ Integer

The height in pixels of this form field.

Returns:

  • (Integer) 


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

def height
  @height
end

#name ⇒ String

The name of the Custom Field.

Returns:

  • (String) 


31
32
33
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 31

def name
  @name
end

#required ⇒ Boolean

Boolean showing whether or not this field is required.

Returns:

  • (Boolean) 


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

def required
  @required
end

#signer ⇒ Integer, ...

The signer of the Custom Field. Can be ‘null` if field is a merge field (assigned to Sender).

Returns:

  • (Integer, String, nil) 


35
36
37
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 35

def signer
  @signer
end

#type ⇒ String

Returns:

  • (String) 


23
24
25
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 23

def type
  @type
end

#width ⇒ Integer

The width in pixels of this form field.

Returns:

  • (Integer) 


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

def width
  @width
end

#x ⇒ Integer

The horizontal offset in pixels for this form field.

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 39

def x
  @x
end

#y ⇒ Integer

The vertical offset in pixels for this form field.

Returns:

  • (Integer) 


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

def y
  @y
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 62

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



245
246
247
248
249
250
251
252
253
254
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 245

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 



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 126

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

  if value == 'checkbox'
    return "Dropbox::Sign::TemplateResponseDocumentCustomFieldCheckbox"
  end
  if value == 'text'
    return "Dropbox::Sign::TemplateResponseDocumentCustomFieldText"
  end

  nil
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



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

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



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

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



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

def self.merged_types
  self.openapi_types
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



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

def self.openapi_discriminator_name
  :'type'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
103
104
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 99

def self.openapi_nullable
  Set.new([
    :'signer',
    :'group'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 83

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 215

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



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
316
317
318
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 282

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 353

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 259

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


232
233
234
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 232

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



238
239
240
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 238

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



197
198
199
200
201
202
203
204
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 197

def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type 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



328
329
330
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 328

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



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

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



322
323
324
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 322

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



208
209
210
211
 
# File 'lib/dropbox-sign/models/template_response_document_custom_field_base.rb', line 208

def valid?
  return false if @type.nil?
  true
end