Class: Dropbox::Sign::WarningResponse

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

Overview

A list of warnings.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WarningResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 89

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

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

Instance Attribute Details

#warning_msg ⇒ String

Warning message

Returns:

  • (String) 


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

def warning_msg
  @warning_msg
end

#warning_name ⇒ String

Warning name

Returns:

  • (String) 


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

def warning_name
  @warning_name
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



44
45
46
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 44

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 31

def self.attribute_map
  {
    :'warning_msg' => :'warning_msg',
    :'warning_name' => :'warning_name'
  }
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



179
180
181
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 179

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

.init(data) ⇒ WarningResponse

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



80
81
82
83
84
85
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 80

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



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

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



73
74
75
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 73

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



68
69
70
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 68

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
60
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 49

def self.openapi_types
  {
    :'warning_msg' => :'String',
    :'warning_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      warning_msg == o.warning_msg &&
      warning_name == o.warning_name
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



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

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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 280

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 186

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


166
167
168
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 166

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



172
173
174
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 172

def hash
  [warning_msg, warning_name].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



114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 114

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

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



255
256
257
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 255

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



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

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



249
250
251
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 249

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



129
130
131
132
133
 
# File 'lib/dropbox-sign/models/warning_response.rb', line 129

def valid?
  return false if @warning_msg.nil?
  return false if @warning_name.nil?
  true
end