Class: PureCloud::CampaignSequence

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/campaign_sequence.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignSequence

Returns a new instance of CampaignSequence.



100
101
102
103
104
105
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
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 100

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'version']
    self.version = attributes[:'version']
  end
  
  if attributes[:'campaigns']
    if (value = attributes[:'campaigns']).is_a?(Array)
      self.campaigns = value
    end
  end
  
  if attributes[:'currentCampaign']
    self.current_campaign = attributes[:'currentCampaign']
  end
  
  if attributes[:'status']
    self.status = attributes[:'status']
  end
  
  if attributes[:'stopMessage']
    self.stop_message = attributes[:'stopMessage']
  end
  
  if attributes[:'repeat']
    self.repeat = attributes[:'repeat']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#campaigns ⇒ Object

the ordered list of campaign identifiers



36
37
38
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 36

def campaigns
  @campaigns
end

#current_campaign ⇒ Object

the zero-based index of the current campaign in the campaigns list



39
40
41
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 39

def current_campaign
  @current_campaign
end

#date_created ⇒ Object

Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



27
28
29
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 27

def date_created
  @date_created
end

#date_modified ⇒ Object

Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



30
31
32
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 30

def date_modified
  @date_modified
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 22

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 24

def name
  @name
end

#repeat ⇒ Object

indicates if a sequence is to repeat from the beginning after the last campaign completes; default is false



48
49
50
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 48

def repeat
  @repeat
end

#self_uri ⇒ Object

The URI for this object



51
52
53
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 51

def self_uri
  @self_uri
end

#status ⇒ Object

status of the sequence



42
43
44
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 42

def status
  @status
end

#stop_message ⇒ Object

if a sequence has unexpectedly stopped, this message provides the reason



45
46
47
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 45

def stop_message
  @stop_message
end

#version ⇒ Object

Required for updates, must match the version number of the most recent update



33
34
35
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 33

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 54

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'version' => :'version',
    
    :'campaigns' => :'campaigns',
    
    :'current_campaign' => :'currentCampaign',
    
    :'status' => :'status',
    
    :'stop_message' => :'stopMessage',
    
    :'repeat' => :'repeat',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 83

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'version' => :'Integer',
    :'campaigns' => :'Array<UriReference>',
    :'current_campaign' => :'Integer',
    :'status' => :'String',
    :'stop_message' => :'String',
    :'repeat' => :'BOOLEAN',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      version == o.version &&
      campaigns == o.campaigns &&
      current_campaign == o.current_campaign &&
      status == o.status &&
      stop_message == o.stop_message &&
      repeat == o.repeat &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 211

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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 271

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

build the object from hash



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 192

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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


182
183
184
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



187
188
189
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 187

def hash
  [id, name, date_created, date_modified, version, campaigns, current_campaign, status, stop_message, repeat, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



254
255
256
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 254

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



259
260
261
262
263
264
265
266
267
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 259

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



249
250
251
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 249

def to_s
  to_hash.to_s
end