Class: Shortcut::CreateEpic

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateEpic

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
236
237
238
239
240
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 154

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

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

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

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

Instance Attribute Details

#completed_at_override ⇒ Object

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



25
26
27
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 25

def completed_at_override
  @completed_at_override
end

#created_at ⇒ Object

Defaults to the time/date it is created but can be set to reflect another date.



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

def created_at
  @created_at
end

#deadline ⇒ Object

The Epic’s deadline.



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

def deadline
  @deadline
end

#description ⇒ Object

The Epic’s description.



19
20
21
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 19

def description
  @description
end

#epic_state_id ⇒ Object

The ID of the Epic State.



43
44
45
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 43

def epic_state_id
  @epic_state_id
end

#external_id ⇒ Object

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



61
62
63
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 61

def external_id
  @external_id
end

#follower_ids ⇒ Object

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



55
56
57
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 55

def follower_ids
  @follower_ids
end

#group_id ⇒ Object

The ID of the group to associate with the epic.



49
50
51
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 49

def group_id
  @group_id
end

#labels ⇒ Object

An array of Labels attached to the Epic.



22
23
24
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 22

def labels
  @labels
end

#milestone_id ⇒ Object

The ID of the Milestone this Epic is related to.



37
38
39
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 37

def milestone_id
  @milestone_id
end

#name ⇒ Object

The Epic’s name.



28
29
30
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 28

def name
  @name
end

#owner_ids ⇒ Object

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



58
59
60
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 58

def owner_ids
  @owner_ids
end

#planned_start_date ⇒ Object

The Epic’s planned start date.



31
32
33
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 31

def planned_start_date
  @planned_start_date
end

#requested_by_id ⇒ Object

The ID of the member that requested the epic.



40
41
42
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 40

def requested_by_id
  @requested_by_id
end

#started_at_override ⇒ Object

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



46
47
48
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 46

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.



34
35
36
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 34

def state
  @state
end

#updated_at ⇒ Object

Defaults to the time/date it is created but can be set to reflect another date.



52
53
54
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 52

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



115
116
117
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 115

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'description' => :'description',
    :'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',
    :'updated_at' => :'updated_at',
    :'follower_ids' => :'follower_ids',
    :'owner_ids' => :'owner_ids',
    :'external_id' => :'external_id',
    :'deadline' => :'deadline',
    :'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



354
355
356
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 354

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



143
144
145
146
147
148
149
150
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 143

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

.openapi_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 120

def self.openapi_types
  {
    :'description' => :'String',
    :'labels' => :'Array<CreateLabelParams>',
    :'completed_at_override' => :'Time',
    :'name' => :'String',
    :'planned_start_date' => :'Time',
    :'state' => :'String',
    :'milestone_id' => :'Integer',
    :'requested_by_id' => :'String',
    :'epic_state_id' => :'Integer',
    :'started_at_override' => :'Time',
    :'group_id' => :'String',
    :'updated_at' => :'Time',
    :'follower_ids' => :'Array<String>',
    :'owner_ids' => :'Array<String>',
    :'external_id' => :'String',
    :'deadline' => :'Time',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      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 &&
      updated_at == o.updated_at &&
      follower_ids == o.follower_ids &&
      owner_ids == o.owner_ids &&
      external_id == o.external_id &&
      deadline == o.deadline &&
      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



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 385

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



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 456

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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 361

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


341
342
343
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 341

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



347
348
349
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 347

def hash
  [description, labels, completed_at_override, name, planned_start_date, state, milestone_id, requested_by_id, epic_state_id, started_at_override, group_id, updated_at, follower_ids, owner_ids, external_id, deadline, 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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 244

def list_invalid_properties
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 100000
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 100000.')
  end

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

  if @name.to_s.length > 256
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 256.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  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



432
433
434
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 432

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



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 438

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



426
427
428
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 426

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



267
268
269
270
271
272
273
274
275
 
# File 'lib/shortcut_client_ruby/models/create_epic.rb', line 267

def valid?
  return false if !@description.nil? && @description.to_s.length > 100000
  return false if @name.nil?
  return false if @name.to_s.length > 256
  return false if @name.to_s.length < 1
  state_validator = EnumAttributeValidator.new('String', ["in progress", "to do", "done"])
  return false unless state_validator.valid?(@state)
  true
end