Class: Shortcut::Project

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

Overview

Projects typically map to teams (such as Frontend, Backend, Mobile, Devops, etc) but can represent any open-ended product, component, or initiative.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Project

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 144

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'abbreviation')
    self.abbreviation = attributes[:'abbreviation']
  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

#abbreviation ⇒ Object

The Project abbreviation used in Story summaries. Should be kept to 3 characters at most.



68
69
70
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 68

def abbreviation
  @abbreviation
end

#app_url ⇒ Object

The Shortcut application url for the Project.



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

def app_url
  @app_url
end

#archived ⇒ Object

True/false boolean indicating whether the Project is in an Archived state.



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

def archived
  @archived
end

#color ⇒ Object

The color associated with the Project in the Shortcut member interface.



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

def color
  @color
end

#created_at ⇒ Object

The time/date that the Project was created.



73
74
75
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 73

def created_at
  @created_at
end

#days_to_thermometer ⇒ Object

The number of days before the thermometer appears in the Story summary.



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

def days_to_thermometer
  @days_to_thermometer
end

#description ⇒ Object

The description of the Project.



23
24
25
 
# File 'lib/shortcut_client_ruby/models/project.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/project.rb', line 29

def entity_type
  @entity_type
end

#external_id ⇒ Object

This field can be set to another unique ID. In the case that the Project has been imported from another tool, the ID in the other tool can be indicated here.



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

def external_id
  @external_id
end

#follower_ids ⇒ Object

An array of UUIDs for any Members listed as Followers.



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

def follower_ids
  @follower_ids
end

#id ⇒ Object

The unique ID of the Project.



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

def id
  @id
end

#iteration_length ⇒ Object

The number of weeks per iteration in this Project.



65
66
67
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 65

def iteration_length
  @iteration_length
end

#name ⇒ Object

The name of the Project



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

def name
  @name
end

#show_thermometer ⇒ Object

Configuration to enable or disable thermometers in the Story summary.



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

def show_thermometer
  @show_thermometer
end

#start_time ⇒ Object

The date at which the Project was started.



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

def start_time
  @start_time
end

#stats ⇒ Object

Returns the value of attribute stats.



70
71
72
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 70

def stats
  @stats
end

#team_id ⇒ Object

The ID of the team the project belongs to.



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

def team_id
  @team_id
end

#updated_at ⇒ Object

The time/date that the Project was last updated.



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

def updated_at
  @updated_at
end

#workflow_id ⇒ Object

The ID of the workflow the project belongs to.



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

def workflow_id
  @workflow_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



101
102
103
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 101

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 76

def self.attribute_map
  {
    :'app_url' => :'app_url',
    :'description' => :'description',
    :'archived' => :'archived',
    :'entity_type' => :'entity_type',
    :'days_to_thermometer' => :'days_to_thermometer',
    :'color' => :'color',
    :'workflow_id' => :'workflow_id',
    :'name' => :'name',
    :'start_time' => :'start_time',
    :'updated_at' => :'updated_at',
    :'follower_ids' => :'follower_ids',
    :'external_id' => :'external_id',
    :'id' => :'id',
    :'show_thermometer' => :'show_thermometer',
    :'team_id' => :'team_id',
    :'iteration_length' => :'iteration_length',
    :'abbreviation' => :'abbreviation',
    :'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



381
382
383
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 381

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



131
132
133
134
135
136
137
138
139
140
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 131

def self.openapi_nullable
  Set.new([
    :'description',
    :'color',
    :'updated_at',
    :'external_id',
    :'abbreviation',
    :'created_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 106

def self.openapi_types
  {
    :'app_url' => :'String',
    :'description' => :'String',
    :'archived' => :'Boolean',
    :'entity_type' => :'String',
    :'days_to_thermometer' => :'Integer',
    :'color' => :'String',
    :'workflow_id' => :'Integer',
    :'name' => :'String',
    :'start_time' => :'Time',
    :'updated_at' => :'Time',
    :'follower_ids' => :'Array<String>',
    :'external_id' => :'String',
    :'id' => :'Integer',
    :'show_thermometer' => :'Boolean',
    :'team_id' => :'Integer',
    :'iteration_length' => :'Integer',
    :'abbreviation' => :'String',
    :'stats' => :'ProjectStats',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 342

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app_url == o.app_url &&
      description == o.description &&
      archived == o.archived &&
      entity_type == o.entity_type &&
      days_to_thermometer == o.days_to_thermometer &&
      color == o.color &&
      workflow_id == o.workflow_id &&
      name == o.name &&
      start_time == o.start_time &&
      updated_at == o.updated_at &&
      follower_ids == o.follower_ids &&
      external_id == o.external_id &&
      id == o.id &&
      show_thermometer == o.show_thermometer &&
      team_id == o.team_id &&
      iteration_length == o.iteration_length &&
      abbreviation == o.abbreviation &&
      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



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 412

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



483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 483

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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 388

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


368
369
370
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 368

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



374
375
376
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 374

def hash
  [app_url, description, archived, entity_type, days_to_thermometer, color, workflow_id, name, start_time, updated_at, follower_ids, external_id, id, show_thermometer, team_id, iteration_length, abbreviation, 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



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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 238

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 @archived.nil?
    invalid_properties.push('invalid value for "archived", archived cannot be nil.')
  end

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

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

  if @color.to_s.length < 1
    invalid_properties.push('invalid value for "color", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/^#[a-fA-F0-9]{6}$/)
  if @color !~ pattern
    invalid_properties.push("invalid value for \"color\", must conform to the pattern #{pattern}.")
  end

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

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

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

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

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

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

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

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

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



459
460
461
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 459

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



465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 465

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



453
454
455
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 453

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/shortcut_client_ruby/models/project.rb', line 306

def valid?
  return false if @app_url.nil?
  return false if @archived.nil?
  return false if @entity_type.nil?
  return false if @days_to_thermometer.nil?
  return false if @color.to_s.length < 1
  return false if @color !~ Regexp.new(/^#[a-fA-F0-9]{6}$/)
  return false if @workflow_id.nil?
  return false if @name.nil?
  return false if @start_time.nil?
  return false if @follower_ids.nil?
  return false if @id.nil?
  return false if @show_thermometer.nil?
  return false if @team_id.nil?
  return false if @iteration_length.nil?
  return false if @stats.nil?
  true
end