Class: PureCloud::BuScheduleListItem

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BuScheduleListItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#description ⇒ Object

The description of this schedule



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 31

def description
  @description
end

#generation_results ⇒ Object

Generation result summary for this schedule, if applicable



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 40

def generation_results
  @generation_results
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#metadata ⇒ Object

Version metadata for this schedule



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 43

def metadata
  @metadata
end

#published ⇒ Object

Whether this schedule is published



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 34

def published
  @published
end

#self_uri ⇒ Object

The URI for this object



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 46

def self_uri
  @self_uri
end

#short_term_forecast ⇒ Object

The forecast used for this schedule, if applicable



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 37

def short_term_forecast
  @short_term_forecast
end

#week_count ⇒ Object

The number of weeks spanned by this schedule



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 28

def week_count
  @week_count
end

#week_date ⇒ Object

The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 25

def week_date
  @week_date
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 49

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'week_date' => :'weekDate',
    
    :'week_count' => :'weekCount',
    
    :'description' => :'description',
    
    :'published' => :'published',
    
    :'short_term_forecast' => :'shortTermForecast',
    
    :'generation_results' => :'generationResults',
    
    :'metadata' => :'metadata',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 74

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'week_date' => :'Date',
    
    :'week_count' => :'Integer',
    
    :'description' => :'String',
    
    :'published' => :'BOOLEAN',
    
    :'short_term_forecast' => :'BuShortTermForecastReference',
    
    :'generation_results' => :'ScheduleGenerationResultSummary',
    
    :'metadata' => :'WfmVersionedEntityMetadata',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 289

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      week_date == o.week_date &&
      week_count == o.week_count &&
      description == o.description &&
      published == o.published &&
      short_term_forecast == o.short_term_forecast &&
      generation_results == o.generation_results &&
      metadata == o.metadata &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 335

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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 395

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 316

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


305
306
307
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 305

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



311
312
313
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 311

def hash
  [id, week_date, week_count, description, published, short_term_forecast, generation_results, metadata, self_uri].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



192
193
194
195
196
197
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 192

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



378
379
380
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 378

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



383
384
385
386
387
388
389
390
391
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 383

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 



373
374
375
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 373

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



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
234
235
236
237
238
239
 
# File 'lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb', line 201

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end