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.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 78

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']
  else
    self.repeat = false
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#campaigns ⇒ Object

Returns the value of attribute campaigns.



18
19
20
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 18

def campaigns
  @campaigns
end

#current_campaign ⇒ Object

Returns the value of attribute current_campaign.



20
21
22
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 20

def current_campaign
  @current_campaign
end

#date_created ⇒ Object

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



11
12
13
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 11

def date_created
  @date_created
end

#date_modified ⇒ Object

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



14
15
16
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 14

def date_modified
  @date_modified
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 6

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 8

def name
  @name
end

#repeat ⇒ Object

Returns the value of attribute repeat.



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

def repeat
  @repeat
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#stop_message ⇒ Object

Returns the value of attribute stop_message.



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

def stop_message
  @stop_message
end

#version ⇒ Object

Returns the value of attribute version.



16
17
18
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 16

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 32

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.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 61

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.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 145

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 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 191

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 248

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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 172

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


162
163
164
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



167
168
169
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 167

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



231
232
233
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 231

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



236
237
238
239
240
241
242
243
244
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 236

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 



226
227
228
 
# File 'lib/purecloud/models/campaign_sequence.rb', line 226

def to_s
  to_hash.to_s
end