Class: BombBomb::JerichoConfiguration

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JerichoConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 116

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#client_group_id ⇒ Object

Returns the value of attribute client_group_id.



20
21
22
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 20

def client_group_id
  @client_group_id
end

#custom_initial_email_subject_line ⇒ Object

The custom subject line for the prompt initial email



65
66
67
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 65

def custom_initial_email_subject_line
  @custom_initial_email_subject_line
end

#email_body ⇒ Object

Video Prompt: The HTML body of the final sent email.



53
54
55
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 53

def email_body
  @email_body
end

#email_id ⇒ Object

Static send: The Email to send on behalf of the group members.



32
33
34
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 32

def email_id
  @email_id
end

#email_subject ⇒ Object

Video Prompt: The subject line of the final sent email



50
51
52
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 50

def email_subject
  @email_subject
end

#example_video_id ⇒ Object

Video Prompt: The Video to include as an example for prompted users.



35
36
37
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 35

def example_video_id
  @example_video_id
end

#follow_up_video_id ⇒ Object

The Video to include in the tracking follow up.



38
39
40
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 38

def follow_up_video_id
  @follow_up_video_id
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 18

def id
  @id
end

#is_prompt ⇒ Object

Video Prompt: Determines whether this is a static or prompted send.



26
27
28
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 26

def is_prompt
  @is_prompt
end

#media_type ⇒ Object

The type of media used for a social send



62
63
64
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 62

def media_type
  @media_type
end

#print_to_template ⇒ Object

Controls whether or not the content is printed into a template.



29
30
31
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 29

def print_to_template
  @print_to_template
end

#prompt_body ⇒ Object

Video Prompt: The HTML body of the email prompting the user to record a video.



47
48
49
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 47

def prompt_body
  @prompt_body
end

#prompt_intro ⇒ Object

Video Prompt: The intro text directed toward prompted users.



41
42
43
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 41

def prompt_intro
  @prompt_intro
end

#prompt_subject ⇒ Object

Video Prompt: The subject line prompting the user to record a video.



44
45
46
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 44

def prompt_subject
  @prompt_subject
end

#send_date ⇒ Object

When the email should be sent.



23
24
25
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 23

def send_date
  @send_date
end

#send_without_video ⇒ Object

Video Prompt: Whether to send the final email if no video was recorded.



56
57
58
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 56

def send_without_video
  @send_without_video
end

#status ⇒ Object

The state of the send.



59
60
61
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 59

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 69

def self.attribute_map
  {
    :'id' => :'id',
    :'client_group_id' => :'clientGroupId',
    :'send_date' => :'sendDate',
    :'is_prompt' => :'isPrompt',
    :'print_to_template' => :'printToTemplate',
    :'email_id' => :'emailId',
    :'example_video_id' => :'exampleVideoId',
    :'follow_up_video_id' => :'followUpVideoId',
    :'prompt_intro' => :'promptIntro',
    :'prompt_subject' => :'promptSubject',
    :'prompt_body' => :'promptBody',
    :'email_subject' => :'emailSubject',
    :'email_body' => :'emailBody',
    :'send_without_video' => :'sendWithoutVideo',
    :'status' => :'status',
    :'media_type' => :'mediaType',
    :'custom_initial_email_subject_line' => :'customInitialEmailSubjectLine'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 92

def self.swagger_types
  {
    :'id' => :'String',
    :'client_group_id' => :'String',
    :'send_date' => :'DateTime',
    :'is_prompt' => :'BOOLEAN',
    :'print_to_template' => :'BOOLEAN',
    :'email_id' => :'String',
    :'example_video_id' => :'String',
    :'follow_up_video_id' => :'String',
    :'prompt_intro' => :'String',
    :'prompt_subject' => :'String',
    :'prompt_body' => :'String',
    :'email_subject' => :'String',
    :'email_body' => :'String',
    :'send_without_video' => :'BOOLEAN',
    :'status' => :'String',
    :'media_type' => :'String',
    :'custom_initial_email_subject_line' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      client_group_id == o.client_group_id &&
      send_date == o.send_date &&
      is_prompt == o.is_prompt &&
      print_to_template == o.print_to_template &&
      email_id == o.email_id &&
      example_video_id == o.example_video_id &&
      follow_up_video_id == o.follow_up_video_id &&
      prompt_intro == o.prompt_intro &&
      prompt_subject == o.prompt_subject &&
      prompt_body == o.prompt_body &&
      email_subject == o.email_subject &&
      email_body == o.email_body &&
      send_without_video == o.send_without_video &&
      status == o.status &&
      media_type == o.media_type &&
      custom_initial_email_subject_line == o.custom_initial_email_subject_line
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



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
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 270

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 = 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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 336

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 249

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


236
237
238
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 236

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



242
243
244
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 242

def hash
  [id, client_group_id, send_date, is_prompt, print_to_template, email_id, example_video_id, follow_up_video_id, prompt_intro, prompt_subject, prompt_body, email_subject, email_body, send_without_video, status, media_type, custom_initial_email_subject_line].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



194
195
196
197
198
199
200
201
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 194

def list_invalid_properties
  invalid_properties = Array.new
  if @is_prompt.nil?
    invalid_properties.push("invalid value for 'is_prompt', is_prompt cannot be nil.")
  end

  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



316
317
318
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 316

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



322
323
324
325
326
327
328
329
330
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 322

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



310
311
312
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 310

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



205
206
207
208
 
# File 'lib/bombbomb/models/jericho_configuration.rb', line 205

def valid?
  return false if @is_prompt.nil?
  return true
end