Class: Dropbox::Sign::SignatureRequestResponseCustomFieldBase

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

Overview

An array of Custom Field objects containing the name and type of each custom field. * Text Field uses ‘SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignatureRequestResponseCustomFieldBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
145
146
147
148
149
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 116

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

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  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::SignatureRequestResponseCustomFieldBase`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

Instance Attribute Details

#api_id ⇒ String

The unique ID for this field.

Returns:

  • (String) 


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

def api_id
  @api_id
end

#editor ⇒ String?

The name of the Role that is able to edit this field.

Returns:

  • (String, nil) 


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

def editor
  @editor
end

#name ⇒ String

The name of the Custom Field.

Returns:

  • (String) 


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

def name
  @name
end

#required ⇒ Boolean

A boolean value denoting if this field is required.

Returns:

  • (Boolean) 


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

def required
  @required
end

#type ⇒ String

The type of this Custom Field. Only ‘text’ and ‘checkbox’ are currently supported.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



54
55
56
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 54

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 43

def self.attribute_map
  {
    :'type' => :'type',
    :'name' => :'name',
    :'required' => :'required',
    :'api_id' => :'api_id',
    :'editor' => :'editor'
  }
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



221
222
223
224
225
226
227
228
229
230
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 221

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 



101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 101

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

  if value == 'checkbox'
    return "Dropbox::Sign::SignatureRequestResponseCustomFieldCheckbox"
  end
  if value == 'text'
    return "Dropbox::Sign::SignatureRequestResponseCustomFieldText"
  end

  nil
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



82
83
84
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 82

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



92
93
94
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 92

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



87
88
89
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 87

def self.merged_types
  self.openapi_types
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



97
98
99
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 97

def self.openapi_discriminator_name
  :'type'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
79
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 75

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

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 64

def self.openapi_types
  {
    :'type' => :'String',
    :'name' => :'String',
    :'required' => :'Boolean',
    :'api_id' => :'String',
    :'editor' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      name == o.name &&
      required == o.required &&
      api_id == o.api_id &&
      editor == o.editor
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



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

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 329

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 235

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



214
215
216
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 214

def hash
  [type, name, required, api_id, editor].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



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 153

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

  if @name.nil?
    invalid_properties.push('invalid value for "name", name 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



304
305
306
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 304

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 310

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



298
299
300
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 298

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



168
169
170
171
172
 
# File 'lib/dropbox-sign/models/signature_request_response_custom_field_base.rb', line 168

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