Class: Bandwidth::MultiChannelActionCalendarEvent

Inherits:
ApiModelBase
  • 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

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ MultiChannelActionCalendarEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
159
160
161
162
163
164
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 111

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
  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 `Bandwidth::MultiChannelActionCalendarEvent`. 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?(:'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

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 79

def self.acceptable_attributes
  acceptable_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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 346

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)



103
104
105
106
107
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 103

def self.openapi_all_of
  [
  :'RbmActionBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 84

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



319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 319

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


333
334
335
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 333

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



339
340
341
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 339

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



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
207
208
209
210
211
212
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 168

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_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 368

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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb', line 216

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