Class: PureCloud::SequenceSchedule

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/sequence_schedule.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SequenceSchedule

Initializes the object



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
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 79

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

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

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

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

  if attributes.has_key?(:'intervals')
    if (value = attributes[:'intervals']).is_a?(Array)
      self.intervals = value
    end
  end

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

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

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

end

Instance Attribute Details

#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/purecloudplatformclientv2/models/sequence_schedule.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/purecloudplatformclientv2/models/sequence_schedule.rb', line 30

def date_modified
  @date_modified
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 22

def id
  @id
end

#intervals ⇒ Object

a list of start and end times



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 36

def intervals
  @intervals
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 24

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 45

def self_uri
  @self_uri
end

#sequence ⇒ Object

identifier of the sequence to be scheduled



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 42

def sequence
  @sequence
end

#time_zone ⇒ Object

time zone identifier to be applied to the intervals; for example Africa/Abidjan



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 39

def time_zone
  @time_zone
end

#version ⇒ Object

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



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 33

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 48

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'date_created' => :'dateCreated',
    :'date_modified' => :'dateModified',
    :'version' => :'version',
    :'intervals' => :'intervals',
    :'time_zone' => :'timeZone',
    :'sequence' => :'sequence',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 63

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'version' => :'Integer',
    :'intervals' => :'Array<ScheduleInterval>',
    :'time_zone' => :'String',
    :'sequence' => :'UriReference',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 151

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 &&
      intervals == o.intervals &&
      time_zone == o.time_zone &&
      sequence == o.sequence &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
225
226
227
228
229
230
231
232
233
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 197

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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 257

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 178

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

See Also:

  • `==` method


167
168
169
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 167

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



173
174
175
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 173

def hash
  [id, name, date_created, date_modified, version, intervals, time_zone, sequence, self_uri].hash
end

#list_invalid_properties ⇒ Object

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



127
128
129
130
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 127

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



240
241
242
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 240

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



245
246
247
248
249
250
251
252
253
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 245

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 



235
236
237
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 235

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/purecloudplatformclientv2/models/sequence_schedule.rb', line 134

def valid?
  if @intervals.nil?
    return false
  end

  if @time_zone.nil?
    return false
  end

  if @sequence.nil?
    return false
  end

end