Class: Shortcut::UpdateEpic

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateEpic

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
235
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 149

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#after_id ⇒ Object

The ID of the Epic we want to move this Epic after.



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

def after_id
  @after_id
end

#archived ⇒ Object

A true/false boolean indicating whether the Epic is in archived state.



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

def archived
  @archived
end

#before_id ⇒ Object

The ID of the Epic we want to move this Epic before.



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

def before_id
  @before_id
end

#completed_at_override ⇒ Object

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



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

def completed_at_override
  @completed_at_override
end

#deadline ⇒ Object

The Epic’s deadline.



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

def deadline
  @deadline
end

#description ⇒ Object

The Epic’s description.



17
18
19
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 17

def description
  @description
end

#epic_state_id ⇒ Object

The ID of the Epic State.



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

def epic_state_id
  @epic_state_id
end

#follower_ids ⇒ Object

An array of UUIDs for any Members you want to add as Followers on this Epic.



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

def follower_ids
  @follower_ids
end

#group_id ⇒ Object

The ID of the group to associate with the epic.



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

def group_id
  @group_id
end

#labels ⇒ Object

An array of Labels attached to the Epic.



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

def labels
  @labels
end

#milestone_id ⇒ Object

The ID of the Milestone this Epic is related to.



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

def milestone_id
  @milestone_id
end

#name ⇒ Object

The Epic’s name.



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

def name
  @name
end

#owner_ids ⇒ Object

An array of UUIDs for any members you want to add as Owners on this Epic.



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

def owner_ids
  @owner_ids
end

#planned_start_date ⇒ Object

The Epic’s planned start date.



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

def planned_start_date
  @planned_start_date
end

#requested_by_id ⇒ Object

The ID of the member that requested the epic.



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

def requested_by_id
  @requested_by_id
end

#started_at_override ⇒ Object

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



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

def started_at_override
  @started_at_override
end

#state ⇒ Object

‘Deprecated` The Epic’s state (to do, in progress, or done); will be ignored when ‘epic_state_id` is set.



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

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 90

def self.attribute_map
  {
    :'description' => :'description',
    :'archived' => :'archived',
    :'labels' => :'labels',
    :'completed_at_override' => :'completed_at_override',
    :'name' => :'name',
    :'planned_start_date' => :'planned_start_date',
    :'state' => :'state',
    :'milestone_id' => :'milestone_id',
    :'requested_by_id' => :'requested_by_id',
    :'epic_state_id' => :'epic_state_id',
    :'started_at_override' => :'started_at_override',
    :'group_id' => :'group_id',
    :'follower_ids' => :'follower_ids',
    :'owner_ids' => :'owner_ids',
    :'before_id' => :'before_id',
    :'after_id' => :'after_id',
    :'deadline' => :'deadline'
  }
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



301
302
303
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 301

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 136

def self.openapi_nullable
  Set.new([
    :'completed_at_override',
    :'planned_start_date',
    :'milestone_id',
    :'started_at_override',
    :'group_id',
    :'deadline'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 113

def self.openapi_types
  {
    :'description' => :'Object',
    :'archived' => :'Object',
    :'labels' => :'Object',
    :'completed_at_override' => :'Object',
    :'name' => :'Object',
    :'planned_start_date' => :'Object',
    :'state' => :'Object',
    :'milestone_id' => :'Object',
    :'requested_by_id' => :'Object',
    :'epic_state_id' => :'Object',
    :'started_at_override' => :'Object',
    :'group_id' => :'Object',
    :'follower_ids' => :'Object',
    :'owner_ids' => :'Object',
    :'before_id' => :'Object',
    :'after_id' => :'Object',
    :'deadline' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 264

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      archived == o.archived &&
      labels == o.labels &&
      completed_at_override == o.completed_at_override &&
      name == o.name &&
      planned_start_date == o.planned_start_date &&
      state == o.state &&
      milestone_id == o.milestone_id &&
      requested_by_id == o.requested_by_id &&
      epic_state_id == o.epic_state_id &&
      started_at_override == o.started_at_override &&
      group_id == o.group_id &&
      follower_ids == o.follower_ids &&
      owner_ids == o.owner_ids &&
      before_id == o.before_id &&
      after_id == o.after_id &&
      deadline == o.deadline
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



331
332
333
334
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
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 331

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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 400

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



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

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


288
289
290
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 288

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



294
295
296
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 294

def hash
  [description, archived, labels, completed_at_override, name, planned_start_date, state, milestone_id, requested_by_id, epic_state_id, started_at_override, group_id, follower_ids, owner_ids, before_id, after_id, deadline].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



239
240
241
242
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 239

def list_invalid_properties
  invalid_properties = Array.new
  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



376
377
378
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 376

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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 382

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



370
371
372
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 370

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



246
247
248
249
250
 
# File 'lib/shortcut_client_ruby/models/update_epic.rb', line 246

def valid?
  state_validator = EnumAttributeValidator.new('Object', ['in progress', 'to do', 'done'])
  return false unless state_validator.valid?(@state)
  true
end