Class: PureCloud::FaxStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/fax_status.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FaxStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 93

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  
  if attributes.has_key?(:'direction')
    
    
    self.direction = attributes[:'direction']
    
  
  end

  
  if attributes.has_key?(:'expectedPages')
    
    
    self.expected_pages = attributes[:'expectedPages']
    
  
  end

  
  if attributes.has_key?(:'activePage')
    
    
    self.active_page = attributes[:'activePage']
    
  
  end

  
  if attributes.has_key?(:'linesTransmitted')
    
    
    self.lines_transmitted = attributes[:'linesTransmitted']
    
  
  end

  
  if attributes.has_key?(:'bytesTransmitted')
    
    
    self.bytes_transmitted = attributes[:'bytesTransmitted']
    
  
  end

  
  if attributes.has_key?(:'baudRate')
    
    
    self.baud_rate = attributes[:'baudRate']
    
  
  end

  
  if attributes.has_key?(:'pageErrors')
    
    
    self.page_errors = attributes[:'pageErrors']
    
  
  end

  
  if attributes.has_key?(:'lineErrors')
    
    
    self.line_errors = attributes[:'lineErrors']
    
  
  end

  
end

Instance Attribute Details

#active_page ⇒ Object

Active page of the transmission.



28
29
30
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 28

def active_page
  @active_page
end

#baud_rate ⇒ Object

Current signaling rate of transmission, baud rate.



37
38
39
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 37

def baud_rate
  @baud_rate
end

#bytes_transmitted ⇒ Object

Number of bytes that have competed transmission.



34
35
36
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 34

def bytes_transmitted
  @bytes_transmitted
end

#direction ⇒ Object

The fax direction, either "send" or "receive".



22
23
24
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 22

def direction
  @direction
end

#expected_pages ⇒ Object

Total number of expected pages, if known.



25
26
27
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 25

def expected_pages
  @expected_pages
end

#line_errors ⇒ Object

Number of line errors.



43
44
45
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 43

def line_errors
  @line_errors
end

#lines_transmitted ⇒ Object

Number of lines that have completed transmission.



31
32
33
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 31

def lines_transmitted
  @lines_transmitted
end

#page_errors ⇒ Object

Number of page errors.



40
41
42
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 40

def page_errors
  @page_errors
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 46

def self.attribute_map
  {
    
    :'direction' => :'direction',
    
    :'expected_pages' => :'expectedPages',
    
    :'active_page' => :'activePage',
    
    :'lines_transmitted' => :'linesTransmitted',
    
    :'bytes_transmitted' => :'bytesTransmitted',
    
    :'baud_rate' => :'baudRate',
    
    :'page_errors' => :'pageErrors',
    
    :'line_errors' => :'lineErrors'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 69

def self.swagger_types
  {
    
    :'direction' => :'String',
    
    :'expected_pages' => :'Integer',
    
    :'active_page' => :'Integer',
    
    :'lines_transmitted' => :'Integer',
    
    :'bytes_transmitted' => :'Integer',
    
    :'baud_rate' => :'Integer',
    
    :'page_errors' => :'Integer',
    
    :'line_errors' => :'Integer'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 264

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      direction == o.direction &&
      expected_pages == o.expected_pages &&
      active_page == o.active_page &&
      lines_transmitted == o.lines_transmitted &&
      bytes_transmitted == o.bytes_transmitted &&
      baud_rate == o.baud_rate &&
      page_errors == o.page_errors &&
      line_errors == o.line_errors
end

#_deserialize(type, value) ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 309

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 369

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

build the object from hash



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 290

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


279
280
281
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



285
286
287
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 285

def hash
  [direction, expected_pages, active_page, lines_transmitted, bytes_transmitted, baud_rate, page_errors, line_errors].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



176
177
178
179
180
181
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 176

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



352
353
354
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 352

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



357
358
359
360
361
362
363
364
365
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 357

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



347
348
349
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 347

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
191
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
 
# File 'lib/purecloudclient_v2a/models/fax_status.rb', line 185

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end