Class: BombBomb::PromptBot

Inherits:
Object
  • Object
show all
Defined in:
lib/bombbomb/models/prompt_bot.rb

Overview

The Prompt\Bot class

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PromptBot

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 119

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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#bot_type_id ⇒ Object

The type of bot.



57
58
59
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 57

def bot_type_id
  @bot_type_id
end

#contact_field_value_column ⇒ Object

The custom contact field value column used for this bot.



45
46
47
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 45

def contact_field_value_column
  @contact_field_value_column
end

#content ⇒ Object

The content to use in the email.



66
67
68
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 66

def content
  @content
end

#email_id ⇒ Object

The default email being sent to contacts in the prompt bot list.



36
37
38
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 36

def email_id
  @email_id
end

#end_date ⇒ Object

when the bot should finish



54
55
56
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 54

def end_date
  @end_date
end

#generated_by ⇒ Object

Set when generated as a default by a bot.



72
73
74
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 72

def generated_by
  @generated_by
end

#id ⇒ Object

The identifier of the prompt bot. Read Only.



30
31
32
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 30

def id
  @id
end

#list_id ⇒ Object

The list to attach the Prompt Bot to.



39
40
41
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 39

def list_id
  @list_id
end

#name ⇒ Object

The name of the bot.



42
43
44
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 42

def name
  @name
end

#start_date ⇒ Object

when the bot started



51
52
53
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 51

def start_date
  @start_date
end

#status ⇒ Object

The status of the prompt bot. Read Only.



48
49
50
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 48

def status
  @status
end

#subject ⇒ Object

The subject of the default email.



69
70
71
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 69

def subject
  @subject
end

#template_id ⇒ Object

The template id used to generate the default email.



60
61
62
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 60

def template_id
  @template_id
end

#user_id ⇒ Object

The prompt bot’s owner. Read Only.



33
34
35
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 33

def user_id
  @user_id
end

#video_id ⇒ Object

The video that was added to the prompt.



63
64
65
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 63

def video_id
  @video_id
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 76

def self.attribute_map
  {
    :'id' => :'id',
    :'user_id' => :'userId',
    :'email_id' => :'emailId',
    :'list_id' => :'listId',
    :'name' => :'name',
    :'contact_field_value_column' => :'contactFieldValueColumn',
    :'status' => :'status',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'bot_type_id' => :'botTypeId',
    :'template_id' => :'templateId',
    :'video_id' => :'videoId',
    :'content' => :'content',
    :'subject' => :'subject',
    :'generated_by' => :'generatedBy'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 97

def self.swagger_types
  {
    :'id' => :'String',
    :'user_id' => :'String',
    :'email_id' => :'String',
    :'list_id' => :'String',
    :'name' => :'String',
    :'contact_field_value_column' => :'String',
    :'status' => :'Integer',
    :'start_date' => :'DateTime',
    :'end_date' => :'DateTime',
    :'bot_type_id' => :'String',
    :'template_id' => :'String',
    :'video_id' => :'String',
    :'content' => :'String',
    :'subject' => :'String',
    :'generated_by' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user_id == o.user_id &&
      email_id == o.email_id &&
      list_id == o.list_id &&
      name == o.name &&
      contact_field_value_column == o.contact_field_value_column &&
      status == o.status &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      bot_type_id == o.bot_type_id &&
      template_id == o.template_id &&
      video_id == o.video_id &&
      content == o.content &&
      subject == o.subject &&
      generated_by == o.generated_by
end

#_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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 258

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 =~ /^(true|t|yes|y|1)$/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 = BombBomb.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 324

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 237

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


224
225
226
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



230
231
232
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 230

def hash
  [id, user_id, email_id, list_id, name, contact_field_value_column, status, start_date, end_date, bot_type_id, template_id, video_id, content, subject, generated_by].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



189
190
191
192
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 189

def list_invalid_properties
  invalid_properties = Array.new
  return 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



304
305
306
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 304

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



310
311
312
313
314
315
316
317
318
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 310

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



298
299
300
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 298

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



196
197
198
 
# File 'lib/bombbomb/models/prompt_bot.rb', line 196

def valid?
  return true
end