Class: Shortcut::CreateProject

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateProject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 98

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

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

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

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

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

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

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

Instance Attribute Details

#abbreviation ⇒ Object

The Project abbreviation used in Story summaries. Should be kept to 3 characters at most.



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

def abbreviation
  @abbreviation
end

#color ⇒ Object

The color you wish to use for the Project in the system.



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

def color
  @color
end

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#description ⇒ Object

The Project description.



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

def description
  @description
end

#external_id ⇒ Object

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



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

def external_id
  @external_id
end

#follower_ids ⇒ Object

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



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

def follower_ids
  @follower_ids
end

#iteration_length ⇒ Object

The number of weeks per iteration in this Project.



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

def iteration_length
  @iteration_length
end

#name ⇒ Object

The name of the Project.



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

def name
  @name
end

#start_time ⇒ Object

The date at which the Project was started.



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

def start_time
  @start_time
end

#team_id ⇒ Object

The ID of the team the project belongs to.



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

def team_id
  @team_id
end

#updated_at ⇒ Object

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



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 52

def self.attribute_map
  {
    :'description' => :'description',
    :'color' => :'color',
    :'name' => :'name',
    :'start_time' => :'start_time',
    :'updated_at' => :'updated_at',
    :'follower_ids' => :'follower_ids',
    :'external_id' => :'external_id',
    :'team_id' => :'team_id',
    :'iteration_length' => :'iteration_length',
    :'abbreviation' => :'abbreviation',
    :'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



283
284
285
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 283

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 91

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

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 74

def self.openapi_types
  {
    :'description' => :'String',
    :'color' => :'String',
    :'name' => :'String',
    :'start_time' => :'Time',
    :'updated_at' => :'Time',
    :'follower_ids' => :'Array<String>',
    :'external_id' => :'String',
    :'team_id' => :'Integer',
    :'iteration_length' => :'Integer',
    :'abbreviation' => :'String',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      color == o.color &&
      name == o.name &&
      start_time == o.start_time &&
      updated_at == o.updated_at &&
      follower_ids == o.follower_ids &&
      external_id == o.external_id &&
      team_id == o.team_id &&
      iteration_length == o.iteration_length &&
      abbreviation == o.abbreviation &&
      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



314
315
316
317
318
319
320
321
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
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 314

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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 385

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 290

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


270
271
272
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



276
277
278
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 276

def hash
  [description, color, name, start_time, updated_at, follower_ids, external_id, team_id, iteration_length, abbreviation, 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



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

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

  pattern = Regexp.new(/^#[a-fA-F0-9]{6}$/)
  if !@color.nil? && @color !~ pattern
    invalid_properties.push("invalid value for \"color\", must conform to the pattern #{pattern}.")
  end

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

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

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



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

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 367

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



355
356
357
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 355

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



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/shortcut_client_ruby/models/create_project.rb', line 196

def valid?
  return false if !@description.nil? && @description.to_s.length > 100000
  return false if !@color.nil? && @color.to_s.length < 1
  return false if !@color.nil? && @color !~ Regexp.new(/^#[a-fA-F0-9]{6}$/)
  return false if @name.nil?
  return false if @name.to_s.length > 128
  return false if @name.to_s.length < 1
  return false if @team_id.nil?
  true
end