class SibApiV3Sdk::UpdateSmsCampaign
Attributes
Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS
Name of the campaign
UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sib-api-v3-sdk/models/update_sms_campaign.rb, line 32 def self.attribute_map { :'name' => :'name', :'sender' => :'sender', :'content' => :'content', :'recipients' => :'recipients', :'scheduled_at' => :'scheduledAt' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/sib-api-v3-sdk/models/update_sms_campaign.rb, line 55 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'sender') self.sender = attributes[:'sender'] end if attributes.has_key?(:'content') self.content = attributes[:'content'] end if attributes.has_key?(:'recipients') self.recipients = attributes[:'recipients'] end if attributes.has_key?(:'scheduledAt') self.scheduled_at = attributes[:'scheduledAt'] end end
Attribute type mapping.
# File lib/sib-api-v3-sdk/models/update_sms_campaign.rb, line 43 def self.swagger_types { :'name' => :'String', :'sender' => :'String', :'content' => :'String', :'recipients' => :'CreateSmsCampaignRecipients', :'scheduled_at' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/sib-api-v3-sdk/models/update_sms_campaign.rb, line 112 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && sender == o.sender && content == o.content && recipients == o.recipients && scheduled_at == o.scheduled_at 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/sib-api-v3-sdk/models/update_sms_campaign.rb, line 158 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 = SibApiV3Sdk.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/sib-api-v3-sdk/models/update_sms_campaign.rb, line 224 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/sib-api-v3-sdk/models/update_sms_campaign.rb, line 137 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that 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/sib-api-v3-sdk/models/update_sms_campaign.rb, line 124 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/sib-api-v3-sdk/models/update_sms_campaign.rb, line 130 def hash [name, sender, content, recipients, scheduled_at].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/sib-api-v3-sdk/models/update_sms_campaign.rb, line 84 def list_invalid_properties invalid_properties = Array.new if !@sender.nil? && @sender.to_s.length > 15 invalid_properties.push('invalid value for "sender", the character length must be smaller than or equal to 15.') end invalid_properties end
Custom attribute writer method with validation @param [Object] sender Value to be assigned
# File lib/sib-api-v3-sdk/models/update_sms_campaign.rb, line 102 def sender=(sender) if !sender.nil? && sender.to_s.length > 15 fail ArgumentError, 'invalid value for "sender", the character length must be smaller than or equal to 15.' end @sender = sender end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/sib-api-v3-sdk/models/update_sms_campaign.rb, line 210 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/sib-api-v3-sdk/models/update_sms_campaign.rb, line 198 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/sib-api-v3-sdk/models/update_sms_campaign.rb, line 95 def valid? return false if !@sender.nil? && @sender.to_s.length > 15 true end