class ClickSendClient::InboundFaxRule
Model for Inbound FAX Rules
Attributes
Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE).
Action address.
Dedicated Number. Can be '*' to apply to all numbers.
Enabled: Disabled=0 or Enabled=1.
Rule Name.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/clicksend_client/models/inbound_fax_rule.rb, line 34 def self.attribute_map { :'dedicated_number' => :'dedicated_number', :'rule_name' => :'rule_name', :'action' => :'action', :'action_address' => :'action_address', :'enabled' => :'enabled' } end
Attribute type mapping.
# File lib/clicksend_client/models/inbound_fax_rule.rb, line 45 def self.clicksend_types { :'dedicated_number' => :'String', :'rule_name' => :'String', :'action' => :'String', :'action_address' => :'String', :'enabled' => :'Float' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/clicksend_client/models/inbound_fax_rule.rb, line 57 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?(:'dedicated_number') self.dedicated_number = attributes[:'dedicated_number'] end if attributes.has_key?(:'rule_name') self.rule_name = attributes[:'rule_name'] end if attributes.has_key?(:'action') self.action = attributes[:'action'] end if attributes.has_key?(:'action_address') self.action_address = attributes[:'action_address'] end if attributes.has_key?(:'enabled') self.enabled = attributes[:'enabled'] end end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/clicksend_client/models/inbound_fax_rule.rb, line 124 def ==(o) return true if self.equal?(o) self.class == o.class && dedicated_number == o.dedicated_number && rule_name == o.rule_name && action == o.action && action_address == o.action_address && enabled == o.enabled 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/inbound_fax_rule.rb, line 170 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/inbound_fax_rule.rb, line 236 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/inbound_fax_rule.rb, line 149 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/inbound_fax_rule.rb, line 136 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/clicksend_client/models/inbound_fax_rule.rb, line 142 def hash [dedicated_number, rule_name, action, action_address, enabled].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/inbound_fax_rule.rb, line 86 def list_invalid_properties invalid_properties = Array.new if @dedicated_number.nil? invalid_properties.push('invalid value for "dedicated_number", dedicated_number cannot be nil.') end if @rule_name.nil? invalid_properties.push('invalid value for "rule_name", rule_name cannot be nil.') end if @action.nil? invalid_properties.push('invalid value for "action", action cannot be nil.') end if @action_address.nil? invalid_properties.push('invalid value for "action_address", action_address cannot be nil.') end if @enabled.nil? invalid_properties.push('invalid value for "enabled", enabled 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/inbound_fax_rule.rb, line 222 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/inbound_fax_rule.rb, line 210 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/inbound_fax_rule.rb, line 113 def valid? return false if @dedicated_number.nil? return false if @rule_name.nil? return false if @action.nil? return false if @action_address.nil? return false if @enabled.nil? true end