Class: Shortcut::PullRequest

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

Overview

Corresponds to a VCS Pull Request attached to a Shortcut story.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PullRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 150

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#branch_id ⇒ Object

The ID of the branch for the particular pull request.



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

def branch_id
  @branch_id
end

#branch_name ⇒ Object

The name of the branch for the particular pull request.



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

def branch_name
  @branch_name
end

#build_status ⇒ Object

The status of the Continuous Integration workflow for the pull request.



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

def build_status
  @build_status
end

#closed ⇒ Object

True/False boolean indicating whether the VCS pull request has been closed.



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

def closed
  @closed
end

#created_at ⇒ Object

The time/date the pull request was created.



81
82
83
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 81

def created_at
  @created_at
end

#draft ⇒ Object

True/False boolean indicating whether the VCS pull request is in the draft state.



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

def draft
  @draft
end

#entity_type ⇒ Object

A string description of this resource.



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

def entity_type
  @entity_type
end

#id ⇒ Object

The unique ID associated with the pull request in Shortcut.



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

def id
  @id
end

#merged ⇒ Object

True/False boolean indicating whether the VCS pull request has been merged.



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

def merged
  @merged
end

#num_added ⇒ Object

Number of lines added in the pull request, according to VCS.



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

def num_added
  @num_added
end

#num_commits ⇒ Object

The number of commits on the pull request.



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

def num_commits
  @num_commits
end

#num_modified ⇒ Object

Number of lines modified in the pull request, according to VCS.



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

def num_modified
  @num_modified
end

#num_removed ⇒ Object

Number of lines removed in the pull request, according to VCS.



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

def num_removed
  @num_removed
end

#number ⇒ Object

The pull request’s unique number ID in VCS.



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

def number
  @number
end

#repository_id ⇒ Object

The ID of the repository for the particular pull request.



78
79
80
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 78

def repository_id
  @repository_id
end

#review_status ⇒ Object

The status of the review for the pull request.



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

def review_status
  @review_status
end

#target_branch_id ⇒ Object

The ID of the target branch for the particular pull request.



75
76
77
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 75

def target_branch_id
  @target_branch_id
end

#target_branch_name ⇒ Object

The name of the target branch for the particular pull request.



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

def target_branch_name
  @target_branch_name
end

#title ⇒ Object

The title of the pull request.



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

def title
  @title
end

#updated_at ⇒ Object

The time/date the pull request was created.



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

def updated_at
  @updated_at
end

#url ⇒ Object

The URL for the pull request.



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

def url
  @url
end

#vcs_labels ⇒ Object

An array of PullRequestLabels attached to the PullRequest.



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

def vcs_labels
  @vcs_labels
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 84

def self.attribute_map
  {
    :'entity_type' => :'entity_type',
    :'closed' => :'closed',
    :'merged' => :'merged',
    :'num_added' => :'num_added',
    :'branch_id' => :'branch_id',
    :'number' => :'number',
    :'branch_name' => :'branch_name',
    :'target_branch_name' => :'target_branch_name',
    :'num_commits' => :'num_commits',
    :'title' => :'title',
    :'updated_at' => :'updated_at',
    :'draft' => :'draft',
    :'id' => :'id',
    :'vcs_labels' => :'vcs_labels',
    :'url' => :'url',
    :'num_removed' => :'num_removed',
    :'review_status' => :'review_status',
    :'num_modified' => :'num_modified',
    :'build_status' => :'build_status',
    :'target_branch_id' => :'target_branch_id',
    :'repository_id' => :'repository_id',
    :'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



406
407
408
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 406

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



140
141
142
143
144
145
146
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 140

def self.openapi_nullable
  Set.new([
    :'num_commits',
    :'vcs_labels',
    :'num_modified',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'entity_type' => :'Object',
    :'closed' => :'Object',
    :'merged' => :'Object',
    :'num_added' => :'Object',
    :'branch_id' => :'Object',
    :'number' => :'Object',
    :'branch_name' => :'Object',
    :'target_branch_name' => :'Object',
    :'num_commits' => :'Object',
    :'title' => :'Object',
    :'updated_at' => :'Object',
    :'draft' => :'Object',
    :'id' => :'Object',
    :'vcs_labels' => :'Object',
    :'url' => :'Object',
    :'num_removed' => :'Object',
    :'review_status' => :'Object',
    :'num_modified' => :'Object',
    :'build_status' => :'Object',
    :'target_branch_id' => :'Object',
    :'repository_id' => :'Object',
    :'created_at' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 364

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      entity_type == o.entity_type &&
      closed == o.closed &&
      merged == o.merged &&
      num_added == o.num_added &&
      branch_id == o.branch_id &&
      number == o.number &&
      branch_name == o.branch_name &&
      target_branch_name == o.target_branch_name &&
      num_commits == o.num_commits &&
      title == o.title &&
      updated_at == o.updated_at &&
      draft == o.draft &&
      id == o.id &&
      vcs_labels == o.vcs_labels &&
      url == o.url &&
      num_removed == o.num_removed &&
      review_status == o.review_status &&
      num_modified == o.num_modified &&
      build_status == o.build_status &&
      target_branch_id == o.target_branch_id &&
      repository_id == o.repository_id &&
      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



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 436

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



505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 505

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



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 413

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


393
394
395
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 393

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



399
400
401
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 399

def hash
  [entity_type, closed, merged, num_added, branch_id, number, branch_name, target_branch_name, num_commits, title, updated_at, draft, id, vcs_labels, url, num_removed, review_status, num_modified, build_status, target_branch_id, repository_id, 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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



481
482
483
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 481

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



487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 487

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



475
476
477
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 475

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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/shortcut_client_ruby/models/pull_request.rb', line 339

def valid?
  return false if @entity_type.nil?
  return false if @closed.nil?
  return false if @merged.nil?
  return false if @num_added.nil?
  return false if @branch_id.nil?
  return false if @number.nil?
  return false if @branch_name.nil?
  return false if @target_branch_name.nil?
  return false if @num_commits.nil?
  return false if @title.nil?
  return false if @updated_at.nil?
  return false if @draft.nil?
  return false if @id.nil?
  return false if @url.nil?
  return false if @num_removed.nil?
  return false if @num_modified.nil?
  return false if @target_branch_id.nil?
  return false if @repository_id.nil?
  return false if @created_at.nil?
  true
end