Class: Shortcut::Workflow

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

Overview

Workflow is the array of defined Workflow States. Workflow can be queried using the API but must be updated in the Shortcut UI.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Workflow

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auto_assign_owner ⇒ Object

Indicates if an owner is automatically assigned when an unowned story is started.



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

def auto_assign_owner
  @auto_assign_owner
end

#created_at ⇒ Object

The date the Workflow was created.



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

def created_at
  @created_at
end

#default_state_id ⇒ Object

The unique ID of the default state that new Stories are entered into.



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

def default_state_id
  @default_state_id
end

#description ⇒ Object

A description of the workflow.



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

def description
  @description
end

#entity_type ⇒ Object

A string description of this resource.



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

def entity_type
  @entity_type
end

#id ⇒ Object

The unique ID of the Workflow.



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

def id
  @id
end

#name ⇒ Object

The name of the workflow.



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

def name
  @name
end

#project_ids ⇒ Object

An array of IDs of projects within the Workflow.



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

def project_ids
  @project_ids
end

#states ⇒ Object

A map of the states in this Workflow.



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

def states
  @states
end

#team_id ⇒ Object

The ID of the team the workflow belongs to.



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

def team_id
  @team_id
end

#updated_at ⇒ Object

The date the Workflow was updated.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 53

def self.attribute_map
  {
    :'description' => :'description',
    :'entity_type' => :'entity_type',
    :'project_ids' => :'project_ids',
    :'states' => :'states',
    :'name' => :'name',
    :'updated_at' => :'updated_at',
    :'auto_assign_owner' => :'auto_assign_owner',
    :'id' => :'id',
    :'team_id' => :'team_id',
    :'created_at' => :'created_at',
    :'default_state_id' => :'default_state_id'
  }
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



262
263
264
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 262

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 75

def self.openapi_types
  {
    :'description' => :'String',
    :'entity_type' => :'String',
    :'project_ids' => :'Array<Float>',
    :'states' => :'Array<WorkflowState>',
    :'name' => :'String',
    :'updated_at' => :'Time',
    :'auto_assign_owner' => :'Boolean',
    :'id' => :'Integer',
    :'team_id' => :'Integer',
    :'created_at' => :'Time',
    :'default_state_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      entity_type == o.entity_type &&
      project_ids == o.project_ids &&
      states == o.states &&
      name == o.name &&
      updated_at == o.updated_at &&
      auto_assign_owner == o.auto_assign_owner &&
      id == o.id &&
      team_id == o.team_id &&
      created_at == o.created_at &&
      default_state_id == o.default_state_id
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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 293

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 364

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



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

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


249
250
251
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



255
256
257
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 255

def hash
  [description, entity_type, project_ids, states, name, updated_at, auto_assign_owner, id, team_id, created_at, default_state_id].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



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

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

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

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

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

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

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

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

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

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

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

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



340
341
342
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 340

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 346

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



334
335
336
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 334

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/shortcut_client_ruby/models/workflow.rb', line 214

def valid?
  return false if @description.nil?
  return false if @entity_type.nil?
  return false if @project_ids.nil?
  return false if @states.nil?
  return false if @name.nil?
  return false if @updated_at.nil?
  return false if @auto_assign_owner.nil?
  return false if @id.nil?
  return false if @team_id.nil?
  return false if @created_at.nil?
  return false if @default_state_id.nil?
  true
end