Class: PureCloud::FaxStatus

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FaxStatus

Returns a new instance of FaxStatus.



83
84
85
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
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/purecloud/models/fax_status.rb', line 83

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

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

  
  if attributes[:'direction']
    self.direction = attributes[:'direction']
  end
  
  if attributes[:'expectedPages']
    self.expected_pages = attributes[:'expectedPages']
  end
  
  if attributes[:'activePage']
    self.active_page = attributes[:'activePage']
  end
  
  if attributes[:'linesTransmitted']
    self.lines_transmitted = attributes[:'linesTransmitted']
  end
  
  if attributes[:'bytesTransmitted']
    self.bytes_transmitted = attributes[:'bytesTransmitted']
  end
  
  if attributes[:'baudRate']
    self.baud_rate = attributes[:'baudRate']
  end
  
  if attributes[:'pageErrors']
    self.page_errors = attributes[:'pageErrors']
  end
  
  if attributes[:'lineErrors']
    self.line_errors = attributes[:'lineErrors']
  end
  
end

Instance Attribute Details

#active_page ⇒ Object

Active page of the transmission.



28
29
30
 
# File 'lib/purecloud/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/purecloud/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/purecloud/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/purecloud/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/purecloud/models/fax_status.rb', line 25

def expected_pages
  @expected_pages
end

#line_errors ⇒ Object

Number of line errors.



43
44
45
 
# File 'lib/purecloud/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/purecloud/models/fax_status.rb', line 31

def lines_transmitted
  @lines_transmitted
end

#page_errors ⇒ Object

Number of page errors.



40
41
42
 
# File 'lib/purecloud/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/purecloud/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
 
# File 'lib/purecloud/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

Check equality by comparing each attribute.



125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/purecloud/models/fax_status.rb', line 125

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 



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
 
# File 'lib/purecloud/models/fax_status.rb', line 168

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



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/purecloud/models/fax_status.rb', line 228

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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/purecloud/models/fax_status.rb', line 149

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

Returns:

  • (Boolean)

See Also:

  • `==` method


139
140
141
 
# File 'lib/purecloud/models/fax_status.rb', line 139

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



144
145
146
 
# File 'lib/purecloud/models/fax_status.rb', line 144

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

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



211
212
213
 
# File 'lib/purecloud/models/fax_status.rb', line 211

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



216
217
218
219
220
221
222
223
224
 
# File 'lib/purecloud/models/fax_status.rb', line 216

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 



206
207
208
 
# File 'lib/purecloud/models/fax_status.rb', line 206

def to_s
  to_hash.to_s
end