class PureCloud::FaxSendRequest
Attributes
A list of outbound fax dialing addresses. E.g. +13175555555 or 3175555555
The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored
Data for coversheet generation.
DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null
The globally unique identifier for the object.
The URI for this object
Time zone offset minutes from GMT
Workspace
in which the document should be stored. If Content Management document is used for faxing, workspace will be ignored
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/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
# File lib/purecloud/models/fax_send_request.rb, line 88 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[:'id'] self.id = attributes[:'id'] end if attributes[:'name'] self.name = attributes[:'name'] end if attributes[:'addresses'] if (value = attributes[:'addresses']).is_a?(Array) self.addresses = value end end if attributes[:'documentId'] self.document_id = attributes[:'documentId'] end if attributes[:'contentType'] self.content_type = attributes[:'contentType'] end if attributes[:'workspace'] self.workspace = attributes[:'workspace'] end if attributes[:'coverSheet'] self.cover_sheet = attributes[:'coverSheet'] end if attributes[:'timeZoneOffsetMinutes'] self.time_zone_offset_minutes = attributes[:'timeZoneOffsetMinutes'] end if attributes[:'selfUri'] self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloud/models/fax_send_request.rb, line 73 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
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/fax_send_request.rb, line 145 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
# File lib/purecloud/models/fax_send_request.rb, line 189 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
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloud/models/fax_send_request.rb, line 249 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 the object from hash
# File lib/purecloud/models/fax_send_request.rb, line 170 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
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/fax_send_request.rb, line 136 def content_type=(content_type) 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) fail "invalid value for 'content_type', must be one of #{allowed_values}" end @content_type = content_type end
@see the `==` method
# File lib/purecloud/models/fax_send_request.rb, line 160 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/fax_send_request.rb, line 165 def hash [id, name, addresses, document_id, content_type, workspace, cover_sheet, time_zone_offset_minutes, self_uri].hash end
return the object in the form of hash
# File lib/purecloud/models/fax_send_request.rb, line 237 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
# File lib/purecloud/models/fax_send_request.rb, line 227 def to_s to_hash.to_s end