Class: Dropbox::Sign::FaxLineListResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FaxLineListResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'fax_lines')
    if (value = attributes[:'fax_lines']).is_a?(Array)
      self.fax_lines = value
    end
  end

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

Instance Attribute Details

#fax_lines ⇒ Array<FaxLineResponseFaxLine>

Returns:



25
26
27
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 25

def fax_lines
  @fax_lines
end

#list_info ⇒ ListInfoResponse

Returns:



22
23
24
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 22

def list_info
  @list_info
end

#warnings ⇒ WarningResponse

Returns:



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

def warnings
  @warnings
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'list_info' => :'list_info',
    :'fax_lines' => :'fax_lines',
    :'warnings' => :'warnings'
  }
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



162
163
164
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 162

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

.init(data) ⇒ FaxLineListResponse

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



77
78
79
80
81
82
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 77

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



60
61
62
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 60

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



70
71
72
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 70

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



65
66
67
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 65

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'list_info' => :'ListInfoResponse',
    :'fax_lines' => :'Array<FaxLineResponseFaxLine>',
    :'warnings' => :'WarningResponse'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 139

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



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
227
228
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 192

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



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

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 169

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


149
150
151
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



155
156
157
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 155

def hash
  [list_info, fax_lines, warnings].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



116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 116

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

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



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

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 244

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



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

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



131
132
133
134
135
 
# File 'lib/dropbox-sign/models/fax_line_list_response.rb', line 131

def valid?
  return false if @list_info.nil?
  return false if @fax_lines.nil?
  true
end