Class: PureCloud::FaxSendRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/fax_send_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FaxSendRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
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
123
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 79

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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#addresses ⇒ Object

A list of outbound fax dialing addresses. E.g. +13175555555 or 3175555555



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 27

def addresses
  @addresses
end

#content_type ⇒ Object

The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 33

def content_type
  @content_type
end

#cover_sheet ⇒ Object

Data for coversheet generation.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 39

def cover_sheet
  @cover_sheet
end

#document_id ⇒ Object

DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 30

def document_id
  @document_id
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 22

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 24

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 45

def self_uri
  @self_uri
end

#time_zone_offset_minutes ⇒ Object

Time zone offset minutes from GMT



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 42

def time_zone_offset_minutes
  @time_zone_offset_minutes
end

#workspace ⇒ Object

Workspace in which the document should be stored. If Content Management document is used for faxing, workspace will be ignored



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 36

def workspace
  @workspace
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 48

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'addresses' => :'addresses',
    :'document_id' => :'documentId',
    :'content_type' => :'contentType',
    :'workspace' => :'workspace',
    :'cover_sheet' => :'coverSheet',
    :'time_zone_offset_minutes' => :'timeZoneOffsetMinutes',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 63

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'addresses' => :'Array<String>',
    :'document_id' => :'String',
    :'content_type' => :'String',
    :'workspace' => :'Workspace',
    :'cover_sheet' => :'CoverSheet',
    :'time_zone_offset_minutes' => :'Integer',
    :'self_uri' => :'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
163
164
165
166
167
168
169
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      addresses == o.addresses &&
      document_id == o.document_id &&
      content_type == o.content_type &&
      workspace == o.workspace &&
      cover_sheet == o.cover_sheet &&
      time_zone_offset_minutes == o.time_zone_offset_minutes &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 203

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



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

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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 184

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


173
174
175
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



179
180
181
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 179

def hash
  [id, name, addresses, document_id, content_type, workspace, cover_sheet, time_zone_offset_minutes, self_uri].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



127
128
129
130
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 127

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))



246
247
248
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 246

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



251
252
253
254
255
256
257
258
259
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 251

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 



241
242
243
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 241

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



134
135
136
137
138
139
140
141
142
143
 
# File 'lib/purecloudplatformclientv2/models/fax_send_request.rb', line 134

def valid?
  if @addresses.nil?
    return false
  end

  allowed_values = ["application/pdf", "image/tiff", "application/msword", "application/vnd.oasis.opendocument.text", "application/vnd.openxmlformats-officedocument.wordprocessingml.document"]
  if @content_type && !allowed_values.include?(@content_type)
    return false
  end
end