class ClickSendClient::FaxMessage
Base model for Fax Messages
Attributes
Recipient country.
Your reference. Will be passed back with all replies and delivery reports.
Your sender id. Must be a valid fax number.
An email address where the reply should be emailed to.
Your list ID if sending to a whole list. Can be used instead of 'to'.
Leave blank for immediate delivery. Your schedule time in unix format help.clicksend.com/what-is-a-unix-timestamp
Your method of sending e.g. 'wordpress', 'php', 'c#'.
Recipient fax number in E.164 format.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/clicksend_client/models/fax_message.rb, line 43 def self.attribute_map { :'source' => :'source', :'to' => :'to', :'list_id' => :'list_id', :'from' => :'from', :'schedule' => :'schedule', :'custom_string' => :'custom_string', :'country' => :'country', :'from_email' => :'from_email' } end
Attribute type mapping.
# File lib/clicksend_client/models/fax_message.rb, line 57 def self.clicksend_types { :'source' => :'String', :'to' => :'String', :'list_id' => :'Integer', :'from' => :'String', :'schedule' => :'Integer', :'custom_string' => :'String', :'country' => :'String', :'from_email' => :'String' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/clicksend_client/models/fax_message.rb, line 72 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?(:'source') self.source = attributes[:'source'] else self.source = 'sdk' end if attributes.has_key?(:'to') self.to = attributes[:'to'] end if attributes.has_key?(:'list_id') self.list_id = attributes[:'list_id'] end if attributes.has_key?(:'from') self.from = attributes[:'from'] end if attributes.has_key?(:'schedule') self.schedule = attributes[:'schedule'] end if attributes.has_key?(:'custom_string') self.custom_string = attributes[:'custom_string'] end if attributes.has_key?(:'country') self.country = attributes[:'country'] end if attributes.has_key?(:'from_email') self.from_email = attributes[:'from_email'] end end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/clicksend_client/models/fax_message.rb, line 133 def ==(o) return true if self.equal?(o) self.class == o.class && source == o.source && to == o.to && list_id == o.list_id && from == o.from && schedule == o.schedule && custom_string == o.custom_string && country == o.country && from_email == o.from_email end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/clicksend_client/models/fax_message.rb, line 182 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 =~ /\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 temp_model = ClickSendClient.const_get(type).new temp_model.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/clicksend_client/models/fax_message.rb, line 248 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/clicksend_client/models/fax_message.rb, line 161 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.clicksend_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/clicksend_client/models/fax_message.rb, line 148 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/clicksend_client/models/fax_message.rb, line 154 def hash [source, to, list_id, from, schedule, custom_string, country, from_email].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/clicksend_client/models/fax_message.rb, line 115 def list_invalid_properties invalid_properties = Array.new if @to.nil? invalid_properties.push('invalid value for "to", to cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/clicksend_client/models/fax_message.rb, line 234 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/clicksend_client/models/fax_message.rb, line 222 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/clicksend_client/models/fax_message.rb, line 126 def valid? return false if @to.nil? true end