Class: Bandwidth::MultiChannelActionCalendarEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MultiChannelActionCalendarEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 106

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

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::MultiChannelActionCalendarEvent`. Please check the name to make sure it's valid. List of attributes: " + self.class.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?(:'text')
    self.text = attributes[:'text']
  else
    self.text = nil
  end

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

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

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

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

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

Instance Attribute Details

#description ⇒ Object

The description of the event.



36
37
38
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 36

def description
  @description
end

#end_time ⇒ Object

The end time of the event.



33
34
35
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 33

def end_time
  @end_time
end

#postback_data ⇒ Object

Base64 payload the customer receives when the reply is clicked.



24
25
26
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 24

def postback_data
  @postback_data
end

#start_time ⇒ Object

The start time of the event.



30
31
32
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 30

def start_time
  @start_time
end

#text ⇒ Object

Displayed text for user to click



21
22
23
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 21

def text
  @text
end

#title ⇒ Object

The title of the event.



27
28
29
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 27

def title
  @title
end

#type ⇒ Object

Returns the value of attribute type.



18
19
20
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 18

def type
  @type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 334

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Bandwidth.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 61

def self.attribute_map
  {
    :'type' => :'type',
    :'text' => :'text',
    :'postback_data' => :'postbackData',
    :'title' => :'title',
    :'start_time' => :'startTime',
    :'end_time' => :'endTime',
    :'description' => :'description'
  }
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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 310

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



98
99
100
101
102
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 98

def self.openapi_all_of
  [
  :'RbmActionBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 79

def self.openapi_types
  {
    :'type' => :'RbmActionTypeEnum',
    :'text' => :'String',
    :'postback_data' => :'String',
    :'title' => :'String',
    :'start_time' => :'Time',
    :'end_time' => :'Time',
    :'description' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 283

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      text == o.text &&
      postback_data == o.postback_data &&
      title == o.title &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      description == o.description
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 405

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


297
298
299
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 303

def hash
  [type, text, postback_data, title, start_time, end_time, description].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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 162

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

  if @text.to_s.length > 25
    invalid_properties.push('invalid value for "text", the character length must be smaller than or equal to 25.')
  end

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

  if @postback_data.to_s.length > 2048
    invalid_properties.push('invalid value for "postback_data", the character length must be smaller than or equal to 2048.')
  end

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

  if @title.to_s.length > 100
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 100.')
  end

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

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

  if !@description.nil? && @description.to_s.length > 500
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 500.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



381
382
383
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 381

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 387

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



375
376
377
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 375

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 210

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  return false if @text.nil?
  return false if @text.to_s.length > 25
  return false if @postback_data.nil?
  return false if @postback_data.to_s.length > 2048
  return false if @title.nil?
  return false if @title.to_s.length > 100
  return false if @start_time.nil?
  return false if @end_time.nil?
  return false if !@description.nil? && @description.to_s.length > 500
  true
end