Class: Shortcut::StoryContents

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

Overview

A container entity for the attributes this template should populate.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StoryContents

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#deadline ⇒ Object

The due date of the story.



72
73
74
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 72

def deadline
  @deadline
end

#description ⇒ Object

The description of the story.



18
19
20
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 18

def description
  @description
end

#entity_type ⇒ Object

A string description of this resource.



21
22
23
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 21

def entity_type
  @entity_type
end

#epic_id ⇒ Object

The ID of the epic the story belongs to.



36
37
38
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 36

def epic_id
  @epic_id
end

#estimate ⇒ Object

The numeric point estimate of the story. Can also be null, which means unestimated.



63
64
65
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 63

def estimate
  @estimate
end

#external_links ⇒ Object

An array of external links connected to the story.



39
40
41
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 39

def external_links
  @external_links
end

#files ⇒ Object

An array of files attached to the story.



66
67
68
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 66

def files
  @files
end

#follower_ids ⇒ Object

An array of UUIDs for any Members listed as Followers.



57
58
59
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 57

def follower_ids
  @follower_ids
end

#group_id ⇒ Object

The ID of the group to which the story is assigned.



51
52
53
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 51

def group_id
  @group_id
end

#iteration_id ⇒ Object

The ID of the iteration the story belongs to.



42
43
44
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 42

def iteration_id
  @iteration_id
end

#label_ids ⇒ Object

An array of label ids attached to the story.



48
49
50
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 48

def label_ids
  @label_ids
end

#labels ⇒ Object

An array of labels attached to the story.



24
25
26
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 24

def labels
  @labels
end

#linked_files ⇒ Object

An array of linked files attached to the story.



30
31
32
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 30

def linked_files
  @linked_files
end

#name ⇒ Object

The name of the story.



33
34
35
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 33

def name
  @name
end

#owner_ids ⇒ Object

An array of UUIDs of the owners of this story.



60
61
62
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 60

def owner_ids
  @owner_ids
end

#project_id ⇒ Object

The ID of the project the story belongs to.



69
70
71
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 69

def project_id
  @project_id
end

#story_type ⇒ Object

The type of story (feature, bug, chore).



27
28
29
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 27

def story_type
  @story_type
end

#tasks ⇒ Object

An array of tasks connected to the story.



45
46
47
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 45

def tasks
  @tasks
end

#workflow_state_id ⇒ Object

The ID of the workflow state the story is currently in.



54
55
56
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 54

def workflow_state_id
  @workflow_state_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'description' => :'description',
    :'entity_type' => :'entity_type',
    :'labels' => :'labels',
    :'story_type' => :'story_type',
    :'linked_files' => :'linked_files',
    :'name' => :'name',
    :'epic_id' => :'epic_id',
    :'external_links' => :'external_links',
    :'iteration_id' => :'iteration_id',
    :'tasks' => :'tasks',
    :'label_ids' => :'label_ids',
    :'group_id' => :'group_id',
    :'workflow_state_id' => :'workflow_state_id',
    :'follower_ids' => :'follower_ids',
    :'owner_ids' => :'owner_ids',
    :'estimate' => :'estimate',
    :'files' => :'files',
    :'project_id' => :'project_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



292
293
294
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 292

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



125
126
127
128
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 125

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

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 100

def self.openapi_types
  {
    :'description' => :'Object',
    :'entity_type' => :'Object',
    :'labels' => :'Object',
    :'story_type' => :'Object',
    :'linked_files' => :'Object',
    :'name' => :'Object',
    :'epic_id' => :'Object',
    :'external_links' => :'Object',
    :'iteration_id' => :'Object',
    :'tasks' => :'Object',
    :'label_ids' => :'Object',
    :'group_id' => :'Object',
    :'workflow_state_id' => :'Object',
    :'follower_ids' => :'Object',
    :'owner_ids' => :'Object',
    :'estimate' => :'Object',
    :'files' => :'Object',
    :'project_id' => :'Object',
    :'deadline' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      entity_type == o.entity_type &&
      labels == o.labels &&
      story_type == o.story_type &&
      linked_files == o.linked_files &&
      name == o.name &&
      epic_id == o.epic_id &&
      external_links == o.external_links &&
      iteration_id == o.iteration_id &&
      tasks == o.tasks &&
      label_ids == o.label_ids &&
      group_id == o.group_id &&
      workflow_state_id == o.workflow_state_id &&
      follower_ids == o.follower_ids &&
      owner_ids == o.owner_ids &&
      estimate == o.estimate &&
      files == o.files &&
      project_id == o.project_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



322
323
324
325
326
327
328
329
330
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
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 322

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 391

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 299

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


279
280
281
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



285
286
287
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 285

def hash
  [description, entity_type, labels, story_type, linked_files, name, epic_id, external_links, iteration_id, tasks, label_ids, group_id, workflow_state_id, follower_ids, owner_ids, estimate, files, project_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



240
241
242
243
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 240

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



367
368
369
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 367

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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 373

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



361
362
363
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 361

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



247
248
249
 
# File 'lib/shortcut_client_ruby/models/story_contents.rb', line 247

def valid?
  true
end