Class: Dropbox::Sign::SubSigningOptions

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

Overview

This allows the requester to specify the types allowed for creating a signature. NOTE: If ‘signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubSigningOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



129
130
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
167
168
169
170
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 129

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

  if attributes.key?(:'draw')
    self.draw = attributes[:'draw']
  else
    self.draw = false
  end

  if attributes.key?(:'phone')
    self.phone = attributes[:'phone']
  else
    self.phone = false
  end

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

  if attributes.key?(:'upload')
    self.upload = attributes[:'upload']
  else
    self.upload = false
  end
end

Instance Attribute Details

#default_type ⇒ String

The default type shown (limited to the listed types)

Returns:

  • (String) 


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

def default_type
  @default_type
end

#draw ⇒ Boolean

Allows drawing the signature

Returns:

  • (Boolean) 


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

def draw
  @draw
end

#phone ⇒ Boolean

Allows using a smartphone to email the signature

Returns:

  • (Boolean) 


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

def phone
  @phone
end

#type ⇒ Boolean

Allows typing the signature

Returns:

  • (Boolean) 


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

def type
  @type
end

#upload ⇒ Boolean

Allows uploading the signature

Returns:

  • (Boolean) 


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

def upload
  @upload
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'default_type' => :'default_type',
    :'draw' => :'draw',
    :'phone' => :'phone',
    :'type' => :'type',
    :'upload' => :'upload'
  }
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



229
230
231
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 229

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.init(data) ⇒ SubSigningOptions

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



120
121
122
123
124
125
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 120

def self.init(data)
  ApiClient.default.convert_to_type(
    data,
    "SubSigningOptions"
  ) || SubSigningOptions.new
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



103
104
105
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 103

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



113
114
115
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 113

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



108
109
110
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 108

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 86

def self.openapi_types
  {
    :'default_type' => :'String',
    :'draw' => :'Boolean',
    :'phone' => :'Boolean',
    :'type' => :'Boolean',
    :'upload' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



204
205
206
207
208
209
210
211
212
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_type == o.default_type &&
      draw == o.draw &&
      phone == o.phone &&
      type == o.type &&
      upload == o.upload
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



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

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



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

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



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

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


216
217
218
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



222
223
224
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 222

def hash
  [default_type, draw, phone, type, upload].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



174
175
176
177
178
179
180
181
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 174

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



305
306
307
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 305

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



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

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



299
300
301
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 299

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



185
186
187
188
189
190
 
# File 'lib/dropbox-sign/models/sub_signing_options.rb', line 185

def valid?
  return false if @default_type.nil?
  default_type_validator = EnumAttributeValidator.new('String', ["draw", "phone", "type", "upload"])
  return false unless default_type_validator.valid?(@default_type)
  true
end