Class: Shortcut::LabelStats

Inherits:
Object
  • Object
show all
Defined in:
lib/shortcut_client_ruby/models/label_stats.rb

Overview

A group of calculated values for this Label. This is not included if the slim? flag is set to true for the List Labels endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LabelStats

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 112

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Shortcut::LabelStats` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Shortcut::LabelStats`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'num_related_documents')
    self.num_related_documents = attributes[:'num_related_documents']
  end

  if attributes.key?(:'num_epics')
    self.num_epics = attributes[:'num_epics']
  end

  if attributes.key?(:'num_stories_unstarted')
    self.num_stories_unstarted = attributes[:'num_stories_unstarted']
  end

  if attributes.key?(:'num_stories_total')
    self.num_stories_total = attributes[:'num_stories_total']
  end

  if attributes.key?(:'num_epics_unstarted')
    self.num_epics_unstarted = attributes[:'num_epics_unstarted']
  end

  if attributes.key?(:'num_epics_in_progress')
    self.num_epics_in_progress = attributes[:'num_epics_in_progress']
  end

  if attributes.key?(:'num_points_unstarted')
    self.num_points_unstarted = attributes[:'num_points_unstarted']
  end

  if attributes.key?(:'num_stories_unestimated')
    self.num_stories_unestimated = attributes[:'num_stories_unestimated']
  end

  if attributes.key?(:'num_points_in_progress')
    self.num_points_in_progress = attributes[:'num_points_in_progress']
  end

  if attributes.key?(:'num_epics_total')
    self.num_epics_total = attributes[:'num_epics_total']
  end

  if attributes.key?(:'num_stories_completed')
    self.num_stories_completed = attributes[:'num_stories_completed']
  end

  if attributes.key?(:'num_points_completed')
    self.num_points_completed = attributes[:'num_points_completed']
  end

  if attributes.key?(:'num_points_total')
    self.num_points_total = attributes[:'num_points_total']
  end

  if attributes.key?(:'num_stories_in_progress')
    self.num_stories_in_progress = attributes[:'num_stories_in_progress']
  end

  if attributes.key?(:'num_epics_completed')
    self.num_epics_completed = attributes[:'num_epics_completed']
  end
end

Instance Attribute Details

#num_epics ⇒ Object

The total number of Epics with this Label.



21
22
23
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 21

def num_epics
  @num_epics
end

#num_epics_completed ⇒ Object

The number of completed Epics assoicated with this Label.



60
61
62
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 60

def num_epics_completed
  @num_epics_completed
end

#num_epics_in_progress ⇒ Object

The number of in progress epics assoicated with this label.



33
34
35
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 33

def num_epics_in_progress
  @num_epics_in_progress
end

#num_epics_total ⇒ Object

The total number of Epics assoicated with this Label.



45
46
47
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 45

def num_epics_total
  @num_epics_total
end

#num_epics_unstarted ⇒ Object

The number of unstarted epics assoicated with this label.



30
31
32
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 30

def num_epics_unstarted
  @num_epics_unstarted
end

#num_points_completed ⇒ Object

The total number of completed points with this Label.



51
52
53
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 51

def num_points_completed
  @num_points_completed
end

#num_points_in_progress ⇒ Object

The total number of in-progress points with this Label.



42
43
44
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 42

def num_points_in_progress
  @num_points_in_progress
end

#num_points_total ⇒ Object

The total number of points with this Label.



54
55
56
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 54

def num_points_total
  @num_points_total
end

#num_points_unstarted ⇒ Object

The total number of unstarted points with this Label.



36
37
38
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 36

def num_points_unstarted
  @num_points_unstarted
end

#num_related_documents ⇒ Object

The total number of Documents associated this Label.



18
19
20
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 18

def num_related_documents
  @num_related_documents
end

#num_stories_completed ⇒ Object

The total number of completed Stories with this Label.



48
49
50
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 48

def num_stories_completed
  @num_stories_completed
end

#num_stories_in_progress ⇒ Object

The total number of in-progress Stories with this Label.



57
58
59
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 57

def num_stories_in_progress
  @num_stories_in_progress
end

#num_stories_total ⇒ Object

The total number of Stories with this Label.



27
28
29
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 27

def num_stories_total
  @num_stories_total
end

#num_stories_unestimated ⇒ Object

The total number of Stories with no point estimate with this Label.



39
40
41
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 39

def num_stories_unestimated
  @num_stories_unestimated
end

#num_stories_unstarted ⇒ Object

The total number of stories unstarted Stories with this Label.



24
25
26
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 24

def num_stories_unstarted
  @num_stories_unstarted
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 63

def self.attribute_map
  {
    :'num_related_documents' => :'num_related_documents',
    :'num_epics' => :'num_epics',
    :'num_stories_unstarted' => :'num_stories_unstarted',
    :'num_stories_total' => :'num_stories_total',
    :'num_epics_unstarted' => :'num_epics_unstarted',
    :'num_epics_in_progress' => :'num_epics_in_progress',
    :'num_points_unstarted' => :'num_points_unstarted',
    :'num_stories_unestimated' => :'num_stories_unestimated',
    :'num_points_in_progress' => :'num_points_in_progress',
    :'num_epics_total' => :'num_epics_total',
    :'num_stories_completed' => :'num_stories_completed',
    :'num_points_completed' => :'num_points_completed',
    :'num_points_total' => :'num_points_total',
    :'num_stories_in_progress' => :'num_stories_in_progress',
    :'num_epics_completed' => :'num_epics_completed'
  }
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



311
312
313
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 311

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



105
106
107
108
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 105

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 84

def self.openapi_types
  {
    :'num_related_documents' => :'Object',
    :'num_epics' => :'Object',
    :'num_stories_unstarted' => :'Object',
    :'num_stories_total' => :'Object',
    :'num_epics_unstarted' => :'Object',
    :'num_epics_in_progress' => :'Object',
    :'num_points_unstarted' => :'Object',
    :'num_stories_unestimated' => :'Object',
    :'num_points_in_progress' => :'Object',
    :'num_epics_total' => :'Object',
    :'num_stories_completed' => :'Object',
    :'num_points_completed' => :'Object',
    :'num_points_total' => :'Object',
    :'num_stories_in_progress' => :'Object',
    :'num_epics_completed' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 276

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      num_related_documents == o.num_related_documents &&
      num_epics == o.num_epics &&
      num_stories_unstarted == o.num_stories_unstarted &&
      num_stories_total == o.num_stories_total &&
      num_epics_unstarted == o.num_epics_unstarted &&
      num_epics_in_progress == o.num_epics_in_progress &&
      num_points_unstarted == o.num_points_unstarted &&
      num_stories_unestimated == o.num_stories_unestimated &&
      num_points_in_progress == o.num_points_in_progress &&
      num_epics_total == o.num_epics_total &&
      num_stories_completed == o.num_stories_completed &&
      num_points_completed == o.num_points_completed &&
      num_points_total == o.num_points_total &&
      num_stories_in_progress == o.num_stories_in_progress &&
      num_epics_completed == o.num_epics_completed
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



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
372
373
374
375
376
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 341

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
    Shortcut.const_get(type).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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 410

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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 318

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


298
299
300
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 298

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



304
305
306
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 304

def hash
  [num_related_documents, num_epics, num_stories_unstarted, num_stories_total, num_epics_unstarted, num_epics_in_progress, num_points_unstarted, num_stories_unestimated, num_points_in_progress, num_epics_total, num_stories_completed, num_points_completed, num_points_total, num_stories_in_progress, num_epics_completed].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



188
189
190
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 188

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

  if @num_epics.nil?
    invalid_properties.push('invalid value for "num_epics", num_epics cannot be nil.')
  end

  if @num_stories_unstarted.nil?
    invalid_properties.push('invalid value for "num_stories_unstarted", num_stories_unstarted cannot be nil.')
  end

  if @num_stories_total.nil?
    invalid_properties.push('invalid value for "num_stories_total", num_stories_total cannot be nil.')
  end

  if @num_epics_unstarted.nil?
    invalid_properties.push('invalid value for "num_epics_unstarted", num_epics_unstarted cannot be nil.')
  end

  if @num_epics_in_progress.nil?
    invalid_properties.push('invalid value for "num_epics_in_progress", num_epics_in_progress cannot be nil.')
  end

  if @num_points_unstarted.nil?
    invalid_properties.push('invalid value for "num_points_unstarted", num_points_unstarted cannot be nil.')
  end

  if @num_stories_unestimated.nil?
    invalid_properties.push('invalid value for "num_stories_unestimated", num_stories_unestimated cannot be nil.')
  end

  if @num_points_in_progress.nil?
    invalid_properties.push('invalid value for "num_points_in_progress", num_points_in_progress cannot be nil.')
  end

  if @num_epics_total.nil?
    invalid_properties.push('invalid value for "num_epics_total", num_epics_total cannot be nil.')
  end

  if @num_stories_completed.nil?
    invalid_properties.push('invalid value for "num_stories_completed", num_stories_completed cannot be nil.')
  end

  if @num_points_completed.nil?
    invalid_properties.push('invalid value for "num_points_completed", num_points_completed cannot be nil.')
  end

  if @num_points_total.nil?
    invalid_properties.push('invalid value for "num_points_total", num_points_total cannot be nil.')
  end

  if @num_stories_in_progress.nil?
    invalid_properties.push('invalid value for "num_stories_in_progress", num_stories_in_progress cannot be nil.')
  end

  if @num_epics_completed.nil?
    invalid_properties.push('invalid value for "num_epics_completed", num_epics_completed cannot be nil.')
  end

  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



386
387
388
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 386

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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 392

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



380
381
382
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 380

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/shortcut_client_ruby/models/label_stats.rb', line 255

def valid?
  return false if @num_related_documents.nil?
  return false if @num_epics.nil?
  return false if @num_stories_unstarted.nil?
  return false if @num_stories_total.nil?
  return false if @num_epics_unstarted.nil?
  return false if @num_epics_in_progress.nil?
  return false if @num_points_unstarted.nil?
  return false if @num_stories_unestimated.nil?
  return false if @num_points_in_progress.nil?
  return false if @num_epics_total.nil?
  return false if @num_stories_completed.nil?
  return false if @num_points_completed.nil?
  return false if @num_points_total.nil?
  return false if @num_stories_in_progress.nil?
  return false if @num_epics_completed.nil?
  true
end