class Telstra_Messaging::SendSMSRequest

Attributes

body[RW]

The text body of the message. Messages longer than 160 characters will be counted as multiple messages. This field contains the message text, this can be up to 1900 (for a single recipient) or 500 (for multiple recipients) UTF-8 characters. As mobile devices rarely support the full range of UTF-8 characters, it is possible that some characters may not be translated correctly by the mobile device

from[RW]

The Alphanumeric sender ID of up to 11 characters or phone number the SMS was sent from. If not present, the service will use the mobile number associated with the application (in E.164 format). This feature is only available on paid plans.

notify_url[RW]

Contains a URL that will be called once your message has been processed. The status may be delivered, expired, deleted, etc. It is possible for the network to make a call to a URL when the message has been delivered (or has expired), different URLs can be set per message. Please refer to the Delivery Notification section.

priority[RW]

When messages are queued up for a number, then it is possible to set where a new message will be placed in the queue. If the priority is set to true then the new message will be placed ahead of all messages with a normal priority. If there are no messages queued for the number, then this parameter has no effect.

reply_request[RW]

If set to true, the reply message functionality will be implemented and the to address will be ignored if present. If false or not present, then normal message handling is implemented. When set to true, network will use a temporary number to deliver this message. All messages sent by mobile to this temporary number will be stored against the same `messageId`. If a `notifyURL` is provided then user response will be delivered to the URL where `messageId` will be same as `messageId` in reponse to original API request. This field contains the message text, this can be up to 500 UTF-8 characters. As mobile devices rarely support the full range of UTF-8 characters, it is possible that some characters may not be translated correctly by the mobile device.

scheduled_delivery[RW]

How long the platform should wait before attempting to send the message - specified in minutes. e.g.: If `"scheduledDelivery": 120` is included, then the network will not attempt to start message delivery for two hours after the message has been submitted

to[RW]

Phone number (in E.164 format) to send the SMS to. This number can be in international format `"to": "+61412345678"` or in national format. Can be an array of strings if sending to multiple numbers: `"to":["+61412345678", "+61418765432"]`

validity[RW]

How long the platform should attempt to deliver the message for. This period is specified in minutes from the message. Normally if the message cannot be delivered immediately, it will be stored and delivery will be periodically reattempted. The network will attempt to send the message for up to seven days. It is possible to define a period smaller than 7 days by including this parameter and specifying the number of minutes that delivery should be attempted. eg: including `"validity": 60` will specify that if a message can't be delivered within the first 60 minutes them the network should stop.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/Telstra_Messaging/models/send_sms_request.rb, line 42
def self.attribute_map
  {
    :'to' => :'to',
    :'body' => :'body',
    :'from' => :'from',
    :'validity' => :'validity',
    :'scheduled_delivery' => :'scheduledDelivery',
    :'notify_url' => :'notifyURL',
    :'reply_request' => :'replyRequest',
    :'priority' => :'priority'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/Telstra_Messaging/models/send_sms_request.rb, line 71
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?(:'to')
    self.to = attributes[:'to']
  end

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

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

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

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

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

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

  if attributes.has_key?(:'priority')
    self.priority = attributes[:'priority']
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/Telstra_Messaging/models/send_sms_request.rb, line 56
def self.openapi_types
  {
    :'to' => :'String',
    :'body' => :'String',
    :'from' => :'String',
    :'validity' => :'Integer',
    :'scheduled_delivery' => :'Integer',
    :'notify_url' => :'String',
    :'reply_request' => :'BOOLEAN',
    :'priority' => :'BOOLEAN'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/Telstra_Messaging/models/send_sms_request.rb, line 135
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      to == o.to &&
      body == o.body &&
      from == o.from &&
      validity == o.validity &&
      scheduled_delivery == o.scheduled_delivery &&
      notify_url == o.notify_url &&
      reply_request == o.reply_request &&
      priority == o.priority
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/Telstra_Messaging/models/send_sms_request.rb, line 184
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 = Telstra_Messaging.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/Telstra_Messaging/models/send_sms_request.rb, line 250
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/Telstra_Messaging/models/send_sms_request.rb, line 163
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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/Telstra_Messaging/models/send_sms_request.rb, line 150
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/Telstra_Messaging/models/send_sms_request.rb, line 156
def hash
  [to, body, from, validity, scheduled_delivery, notify_url, reply_request, priority].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/Telstra_Messaging/models/send_sms_request.rb, line 112
def list_invalid_properties
  invalid_properties = Array.new
  if @to.nil?
    invalid_properties.push('invalid value for "to", to cannot be nil.')
  end

  if @body.nil?
    invalid_properties.push('invalid value for "body", body 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/Telstra_Messaging/models/send_sms_request.rb, line 230
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/Telstra_Messaging/models/send_sms_request.rb, line 236
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/Telstra_Messaging/models/send_sms_request.rb, line 224
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/Telstra_Messaging/models/send_sms_request.rb, line 127
def valid?
  return false if @to.nil?
  return false if @body.nil?
  true
end