Class: Shortcut::History

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

Overview

A history item is a group of actions that represent a transactional change to a Story.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ History

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
162
163
164
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 112

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#actions ⇒ Object

An array of actions that were performed for the change.



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

def actions
  @actions
end

#changed_at ⇒ Object

The date when the change occurred.



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

def changed_at
  @changed_at
end

#external_id ⇒ Object

The ID of the webhook that handled the change.



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

def external_id
  @external_id
end

#id ⇒ Object

The ID representing the change for the story.



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

def id
  @id
end

#member_id ⇒ Object

The ID of the member who performed the change.



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

def member_id
  @member_id
end

#primary_id ⇒ Object

The ID of the primary entity that has changed, if applicable.



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

def primary_id
  @primary_id
end

#references ⇒ Object

An array of objects affected by the change. Reference objects provide basic information for the entities reference in the history actions. Some have specific fields, but they always contain an id, entity_type, and a name.



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

def references
  @references
end

#version ⇒ Object

The version of the change format.



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

def version
  @version
end

#webhook_id ⇒ Object

The ID of the webhook that handled the change.



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

def webhook_id
  @webhook_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 69

def self.attribute_map
  {
    :'changed_at' => :'changed_at',
    :'primary_id' => :'primary_id',
    :'references' => :'references',
    :'actions' => :'actions',
    :'member_id' => :'member_id',
    :'external_id' => :'external_id',
    :'id' => :'id',
    :'version' => :'version',
    :'webhook_id' => :'webhook_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



242
243
244
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 242

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
108
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 104

def self.openapi_nullable
  Set.new([
    :'webhook_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 89

def self.openapi_types
  {
    :'changed_at' => :'String',
    :'primary_id' => :'Integer',
    :'references' => :'Array<Object>',
    :'actions' => :'Array<Object>',
    :'member_id' => :'String',
    :'external_id' => :'String',
    :'id' => :'String',
    :'version' => :'String',
    :'webhook_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      changed_at == o.changed_at &&
      primary_id == o.primary_id &&
      references == o.references &&
      actions == o.actions &&
      member_id == o.member_id &&
      external_id == o.external_id &&
      id == o.id &&
      version == o.version &&
      webhook_id == o.webhook_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



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

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 344

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 249

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


229
230
231
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



235
236
237
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 235

def hash
  [changed_at, primary_id, references, actions, member_id, external_id, id, version, webhook_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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 168

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

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

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

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



320
321
322
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 320

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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 326

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



314
315
316
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 314

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



191
192
193
194
195
196
197
198
199
 
# File 'lib/shortcut_client_ruby/models/history.rb', line 191

def valid?
  return false if @changed_at.nil?
  return false if @actions.nil?
  return false if @id.nil?
  return false if @version.nil?
  version_validator = EnumAttributeValidator.new('String', ["v1"])
  return false unless version_validator.valid?(@version)
  true
end