Class: Shortcut::Milestone

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

Overview

A Milestone is a collection of Epics that represent a release or some other large initiative that your organization is working on.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Milestone

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Shortcut::Milestone` 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::Milestone`. 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?(:'app_url')
    self.app_url = attributes[:'app_url']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#app_url ⇒ Object

The Shortcut application url for the Milestone.



20
21
22
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 20

def app_url
  @app_url
end

#categories ⇒ Object

An array of Categories attached to the Milestone.



56
57
58
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 56

def categories
  @categories
end

#completed ⇒ Object

A true/false boolean indicating if the Milestone has been completed.



44
45
46
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 44

def completed
  @completed
end

#completed_at ⇒ Object

The time/date the Milestone was completed.



38
39
40
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 38

def completed_at
  @completed_at
end

#completed_at_override ⇒ Object

A manual override for the time/date the Milestone was completed.



32
33
34
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 32

def completed_at_override
  @completed_at_override
end

#created_at ⇒ Object

The time/date the Milestone was created.



67
68
69
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 67

def created_at
  @created_at
end

#description ⇒ Object

The Milestone’s description.



23
24
25
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 23

def description
  @description
end

#entity_type ⇒ Object

A string description of this resource.



29
30
31
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 29

def entity_type
  @entity_type
end

#id ⇒ Object

The unique ID of the Milestone.



59
60
61
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 59

def id
  @id
end

#name ⇒ Object

The name of the Milestone.



41
42
43
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 41

def name
  @name
end

#position ⇒ Object

A number representing the position of the Milestone in relation to every other Milestone within the Organization.



62
63
64
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 62

def position
  @position
end

#started ⇒ Object

A true/false boolean indicating if the Milestone has been started.



26
27
28
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 26

def started
  @started
end

#started_at ⇒ Object

The time/date the Milestone was started.



35
36
37
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 35

def started_at
  @started_at
end

#started_at_override ⇒ Object

A manual override for the time/date the Milestone was started.



50
51
52
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 50

def started_at_override
  @started_at_override
end

#state ⇒ Object

The workflow state that the Milestone is in.



47
48
49
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 47

def state
  @state
end

#stats ⇒ Object

Returns the value of attribute stats.



64
65
66
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 64

def stats
  @stats
end

#updated_at ⇒ Object

The time/date the Milestone was updated.



53
54
55
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 53

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 70

def self.attribute_map
  {
    :'app_url' => :'app_url',
    :'description' => :'description',
    :'started' => :'started',
    :'entity_type' => :'entity_type',
    :'completed_at_override' => :'completed_at_override',
    :'started_at' => :'started_at',
    :'completed_at' => :'completed_at',
    :'name' => :'name',
    :'completed' => :'completed',
    :'state' => :'state',
    :'started_at_override' => :'started_at_override',
    :'updated_at' => :'updated_at',
    :'categories' => :'categories',
    :'id' => :'id',
    :'position' => :'position',
    :'stats' => :'stats',
    :'created_at' => :'created_at'
  }
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



328
329
330
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 328

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



121
122
123
124
125
126
127
128
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 121

def self.openapi_nullable
  Set.new([
    :'completed_at_override',
    :'started_at',
    :'completed_at',
    :'started_at_override',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 98

def self.openapi_types
  {
    :'app_url' => :'String',
    :'description' => :'String',
    :'started' => :'Boolean',
    :'entity_type' => :'String',
    :'completed_at_override' => :'Time',
    :'started_at' => :'Time',
    :'completed_at' => :'Time',
    :'name' => :'String',
    :'completed' => :'Boolean',
    :'state' => :'String',
    :'started_at_override' => :'Time',
    :'updated_at' => :'Time',
    :'categories' => :'Array<Category>',
    :'id' => :'Integer',
    :'position' => :'Integer',
    :'stats' => :'MilestoneStats',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 291

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app_url == o.app_url &&
      description == o.description &&
      started == o.started &&
      entity_type == o.entity_type &&
      completed_at_override == o.completed_at_override &&
      started_at == o.started_at &&
      completed_at == o.completed_at &&
      name == o.name &&
      completed == o.completed &&
      state == o.state &&
      started_at_override == o.started_at_override &&
      updated_at == o.updated_at &&
      categories == o.categories &&
      id == o.id &&
      position == o.position &&
      stats == o.stats &&
      created_at == o.created_at
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



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 359

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Shortcut.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 430

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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 335

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


315
316
317
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 315

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



321
322
323
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 321

def hash
  [app_url, description, started, entity_type, completed_at_override, started_at, completed_at, name, completed, state, started_at_override, updated_at, categories, id, position, stats, created_at].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



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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 218

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

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

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

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

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

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

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

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

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

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

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

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at 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



406
407
408
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 406

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



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 412

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



400
401
402
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 400

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/shortcut_client_ruby/models/milestone.rb', line 273

def valid?
  return false if @app_url.nil?
  return false if @description.nil?
  return false if @started.nil?
  return false if @entity_type.nil?
  return false if @name.nil?
  return false if @completed.nil?
  return false if @state.nil?
  return false if @updated_at.nil?
  return false if @categories.nil?
  return false if @id.nil?
  return false if @position.nil?
  return false if @created_at.nil?
  true
end