Class: Pingram::SendSmsRequest

Inherits:
ApiModelBase show all
Defined in:
lib/pingram/models/send_sms_request.rb

Overview

Request body for ‘POST /sms` (send SMS without a template).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SendSmsRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/pingram/models/send_sms_request.rb', line 74

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::SendSmsRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::SendSmsRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

  if attributes.key?(:'to')
    self.to = attributes[:'to']
  else
    self.to = nil
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  else
    self.message = nil
  end

  if attributes.key?(:'schedule')
    self.schedule = attributes[:'schedule']
  end

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

Instance Attribute Details

#from ⇒ Object

Override the sender phone number. Must be a dedicated number on your Pingram account.



32
33
34
 
# File 'lib/pingram/models/send_sms_request.rb', line 32

def from
  @from
end

#message ⇒ Object

The message of the SMS notification.



26
27
28
 
# File 'lib/pingram/models/send_sms_request.rb', line 26

def message
  @message
end

#schedule ⇒ Object

The ISO 8601 datetime to schedule the SMS notification.



29
30
31
 
# File 'lib/pingram/models/send_sms_request.rb', line 29

def schedule
  @schedule
end

#to ⇒ Object

The phone number of the recipient.



23
24
25
 
# File 'lib/pingram/models/send_sms_request.rb', line 23

def to
  @to
end

#type ⇒ Object

The notification type to send.



20
21
22
 
# File 'lib/pingram/models/send_sms_request.rb', line 20

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



46
47
48
 
# File 'lib/pingram/models/send_sms_request.rb', line 46

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/pingram/models/send_sms_request.rb', line 51

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/pingram/models/send_sms_request.rb', line 35

def self.attribute_map
  {
    :'type' => :'type',
    :'to' => :'to',
    :'message' => :'message',
    :'schedule' => :'schedule',
    :'from' => :'from'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/pingram/models/send_sms_request.rb', line 202

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
 
# File 'lib/pingram/models/send_sms_request.rb', line 67

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
 
# File 'lib/pingram/models/send_sms_request.rb', line 56

def self.openapi_types
  {
    :'type' => :'String',
    :'to' => :'String',
    :'message' => :'String',
    :'schedule' => :'String',
    :'from' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
 
# File 'lib/pingram/models/send_sms_request.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      to == o.to &&
      message == o.message &&
      schedule == o.schedule &&
      from == o.from
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


189
190
191
 
# File 'lib/pingram/models/send_sms_request.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



195
196
197
 
# File 'lib/pingram/models/send_sms_request.rb', line 195

def hash
  [type, to, message, schedule, from].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/pingram/models/send_sms_request.rb', line 117

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @to.nil?
    invalid_properties.push('invalid value for "to", to cannot be nil.')
  end

  if @message.nil?
    invalid_properties.push('invalid value for "message", message cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/pingram/models/send_sms_request.rb', line 224

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



137
138
139
140
141
142
143
 
# File 'lib/pingram/models/send_sms_request.rb', line 137

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  return false if @to.nil?
  return false if @message.nil?
  true
end