Class: Shortcut::CreateIteration

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateIteration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
81
82
83
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
110
111
112
113
114
115
116
117
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 71

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

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

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

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

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

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

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

Instance Attribute Details

#description ⇒ Object

The description of the Iteration.



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

def description
  @description
end

#end_date ⇒ Object

The date this Iteration ends, e.g. 2019-07-01.



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

def end_date
  @end_date
end

#follower_ids ⇒ Object

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



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

def follower_ids
  @follower_ids
end

#group_ids ⇒ Object

An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI.



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

def group_ids
  @group_ids
end

#labels ⇒ Object

An array of Labels attached to the Iteration.



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

def labels
  @labels
end

#name ⇒ Object

The name of this Iteration.



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

def name
  @name
end

#start_date ⇒ Object

The date this Iteration begins, e.g. 2019-07-01.



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

def start_date
  @start_date
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 38

def self.attribute_map
  {
    :'follower_ids' => :'follower_ids',
    :'group_ids' => :'group_ids',
    :'labels' => :'labels',
    :'description' => :'description',
    :'name' => :'name',
    :'start_date' => :'start_date',
    :'end_date' => :'end_date'
  }
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



176
177
178
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 176

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 51

def self.openapi_types
  {
    :'follower_ids' => :'Object',
    :'group_ids' => :'Object',
    :'labels' => :'Object',
    :'description' => :'Object',
    :'name' => :'Object',
    :'start_date' => :'Object',
    :'end_date' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      follower_ids == o.follower_ids &&
      group_ids == o.group_ids &&
      labels == o.labels &&
      description == o.description &&
      name == o.name &&
      start_date == o.start_date &&
      end_date == o.end_date
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



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

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 275

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 183

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


163
164
165
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 163

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



169
170
171
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 169

def hash
  [follower_ids, group_ids, labels, description, name, start_date, end_date].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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 121

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

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

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



251
252
253
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 251

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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 257

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



245
246
247
 
# File 'lib/shortcut_client_ruby/models/create_iteration.rb', line 245

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



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

def valid?
  return false if @name.nil?
  return false if @start_date.nil?
  return false if @end_date.nil?
  true
end