Class: Dropbox::Sign::FaxResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FaxResponse

Initializes the object



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
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 145

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Integer

Fax Created At Timestamp



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

def created_at
  @created_at
end

#fax_id ⇒ String

Fax ID



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

def fax_id
  @fax_id
end

#files_url ⇒ String

Fax Files URL



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

def files_url
  @files_url
end

#final_copy_uri ⇒ String?

The path where the completed document can be downloaded



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

def final_copy_uri
  @final_copy_uri
end

#message ⇒ String?

Fax Message



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

def message
  @message
end

#metadata ⇒ Hash<String, Object>

Fax Metadata



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

def metadata
  @metadata
end

#original_title ⇒ String

Fax Original Title



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

def original_title
  @original_title
end

#sender ⇒ String

Fax Sender Email



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

def sender
  @sender
end

#subject ⇒ String?

Fax Subject



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

def subject
  @subject
end

#title ⇒ String

Fax Title



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

def title
  @title
end

#transmissions ⇒ Array<FaxResponseTransmission>

Fax Transmissions List



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

def transmissions
  @transmissions
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



83
84
85
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 83

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 88

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 66

def self.attribute_map
  {
    :'fax_id' => :'fax_id',
    :'title' => :'title',
    :'original_title' => :'original_title',
    :'metadata' => :'metadata',
    :'created_at' => :'created_at',
    :'sender' => :'sender',
    :'files_url' => :'files_url',
    :'transmissions' => :'transmissions',
    :'subject' => :'subject',
    :'message' => :'message',
    :'final_copy_uri' => :'final_copy_uri'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



374
375
376
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 374

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

.init(data) ⇒ FaxResponse

Attempt to instantiate and hydrate a new instance of this class



136
137
138
139
140
141
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 136

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



119
120
121
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 119

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



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

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



124
125
126
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 124

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



110
111
112
113
114
115
116
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 110

def self.openapi_nullable
  Set.new([
    :'subject',
    :'message',
    :'final_copy_uri'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 93

def self.openapi_types
  {
    :'fax_id' => :'String',
    :'title' => :'String',
    :'original_title' => :'String',
    :'metadata' => :'Hash<String, Object>',
    :'created_at' => :'Integer',
    :'sender' => :'String',
    :'files_url' => :'String',
    :'transmissions' => :'Array<FaxResponseTransmission>',
    :'subject' => :'String',
    :'message' => :'String',
    :'final_copy_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 343

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      fax_id == o.fax_id &&
      title == o.title &&
      original_title == o.original_title &&
      metadata == o.metadata &&
      created_at == o.created_at &&
      sender == o.sender &&
      files_url == o.files_url &&
      transmissions == o.transmissions &&
      subject == o.subject &&
      message == o.message &&
      final_copy_uri == o.final_copy_uri
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 404

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



475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 475

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



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 381

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

See Also:

  • `==` method


361
362
363
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 361

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



367
368
369
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 367

def hash
  [fax_id, title, original_title, metadata, created_at, sender, files_url, transmissions, subject, message, final_copy_uri].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



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/fax_response.rb', line 210

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

  if @title.nil?
    invalid_properties.push('invalid value for "title", title cannot be nil.')
  end

  if @original_title.nil?
    invalid_properties.push('invalid value for "original_title", original_title cannot be nil.')
  end

  if @metadata.nil?
    invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @sender.nil?
    invalid_properties.push('invalid value for "sender", sender cannot be nil.')
  end

  if @files_url.nil?
    invalid_properties.push('invalid value for "files_url", files_url cannot be nil.')
  end

  if @transmissions.nil?
    invalid_properties.push('invalid value for "transmissions", transmissions cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



450
451
452
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 450

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash



456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 456

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



444
445
446
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 444

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/dropbox-sign/models/fax_response.rb', line 249

def valid?
  return false if @fax_id.nil?
  return false if @title.nil?
  return false if @original_title.nil?
  return false if @metadata.nil?
  return false if @created_at.nil?
  return false if @sender.nil?
  return false if @files_url.nil?
  return false if @transmissions.nil?
  true
end