class ClickSendClient::InboundSMSRule

Model for Inbound SMS Rules

Attributes

action[RW]

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[RW]

Action address.

dedicated_number[RW]

Dedicated Number. Can be '*' to apply to all numbers.

enabled[RW]

Enabled: Disabled=0 or Enabled=1.

message_search_term[RW]

Message search term.

message_search_type[RW]

Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain.

rule_name[RW]

Rule Name.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/clicksend_client/models/inbound_sms_rule.rb, line 40
def self.attribute_map
  {
    :'dedicated_number' => :'dedicated_number',
    :'rule_name' => :'rule_name',
    :'message_search_type' => :'message_search_type',
    :'message_search_term' => :'message_search_term',
    :'action' => :'action',
    :'action_address' => :'action_address',
    :'enabled' => :'enabled'
  }
end
clicksend_types() click to toggle source

Attribute type mapping.

# File lib/clicksend_client/models/inbound_sms_rule.rb, line 53
def self.clicksend_types
  {
    :'dedicated_number' => :'String',
    :'rule_name' => :'String',
    :'message_search_type' => :'Float',
    :'message_search_term' => :'String',
    :'action' => :'String',
    :'action_address' => :'String',
    :'enabled' => :'Float'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/clicksend_client/models/inbound_sms_rule.rb, line 67
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?(:'message_search_type')
    self.message_search_type = attributes[:'message_search_type']
  end

  if attributes.has_key?(:'message_search_term')
    self.message_search_term = attributes[:'message_search_term']
  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

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/clicksend_client/models/inbound_sms_rule.rb, line 152
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      dedicated_number == o.dedicated_number &&
      rule_name == o.rule_name &&
      message_search_type == o.message_search_type &&
      message_search_term == o.message_search_term &&
      action == o.action &&
      action_address == o.action_address &&
      enabled == o.enabled
end
_deserialize(type, value) click to toggle source

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_sms_rule.rb, line 200
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
_to_hash(value) click to toggle source

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_sms_rule.rb, line 266
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) click to toggle source

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_sms_rule.rb, line 179
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/clicksend_client/models/inbound_sms_rule.rb, line 166
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/clicksend_client/models/inbound_sms_rule.rb, line 172
def hash
  [dedicated_number, rule_name, message_search_type, message_search_term, action, action_address, enabled].hash
end
list_invalid_properties() click to toggle source

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_sms_rule.rb, line 104
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 @message_search_type.nil?
    invalid_properties.push('invalid value for "message_search_type", message_search_type cannot be nil.')
  end

  if @message_search_term.nil?
    invalid_properties.push('invalid value for "message_search_term", message_search_term 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
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/clicksend_client/models/inbound_sms_rule.rb, line 246
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/clicksend_client/models/inbound_sms_rule.rb, line 252
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/clicksend_client/models/inbound_sms_rule.rb, line 240
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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_sms_rule.rb, line 139
def valid?
  return false if @dedicated_number.nil?
  return false if @rule_name.nil?
  return false if @message_search_type.nil?
  return false if @message_search_term.nil?
  return false if @action.nil?
  return false if @action_address.nil?
  return false if @enabled.nil?
  true
end