Class: ConnectWise::Forecast

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/models/forecast.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Forecast

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
157
158
159
160
161
162
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 100

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

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

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

  if attributes.has_key?(:'revenue')
    self.revenue = attributes[:'revenue']
  end

  if attributes.has_key?(:'cost')
    self.cost = attributes[:'cost']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'includedFlag')
    self.included_flag = attributes[:'includedFlag']
  end

  if attributes.has_key?(:'recurring')
    self.recurring = attributes[:'recurring']
  end

  if attributes.has_key?(:'percent')
    self.percent = attributes[:'percent']
  end

  if attributes.has_key?(:'margin')
    self.margin = attributes[:'margin']
  end

  if attributes.has_key?(:'opportunityId')
    self.opportunity_id = attributes[:'opportunityId']
  end

  if attributes.has_key?(:'QuoteNumber')
    self.quote_number = attributes[:'QuoteNumber']
  end

  if attributes.has_key?(:'QuoteName')
    self.quote_name = attributes[:'QuoteName']
  end

  if attributes.has_key?(:'_info')
    self._info = attributes[:'_info']
  end

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



34
35
36
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 34

def _info
  @_info
end

#cost ⇒ Object

Returns the value of attribute cost.



13
14
15
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 13

def cost
  @cost
end

#id ⇒ Object

Returns the value of attribute id.



7
8
9
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 7

def id
  @id
end

#included_flag ⇒ Object

Returns the value of attribute included_flag.



19
20
21
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 19

def included_flag
  @included_flag
end

#margin ⇒ Object

Returns the value of attribute margin.



25
26
27
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 25

def margin
  @margin
end

#name ⇒ Object

Returns the value of attribute name.



9
10
11
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 9

def name
  @name
end

#opportunity_id ⇒ Object

Returns the value of attribute opportunity_id.



27
28
29
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 27

def opportunity_id
  @opportunity_id
end

#percent ⇒ Object

Returns the value of attribute percent.



23
24
25
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 23

def percent
  @percent
end

#quote_name ⇒ Object

Returns the value of attribute quote_name.



31
32
33
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 31

def quote_name
  @quote_name
end

#quote_number ⇒ Object

Returns the value of attribute quote_number.



29
30
31
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 29

def quote_number
  @quote_number
end

#recurring ⇒ Object

Returns the value of attribute recurring.



21
22
23
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 21

def recurring
  @recurring
end

#revenue ⇒ Object

Returns the value of attribute revenue.



11
12
13
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 11

def revenue
  @revenue
end

#status ⇒ Object

Returns the value of attribute status.



17
18
19
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 17

def status
  @status
end

#type ⇒ Object

Returns the value of attribute type.



15
16
17
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 15

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 59

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'revenue' => :'revenue',
    :'cost' => :'cost',
    :'type' => :'type',
    :'status' => :'status',
    :'included_flag' => :'includedFlag',
    :'recurring' => :'recurring',
    :'percent' => :'percent',
    :'margin' => :'margin',
    :'opportunity_id' => :'opportunityId',
    :'quote_number' => :'QuoteNumber',
    :'quote_name' => :'QuoteName',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 79

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'revenue' => :'Float',
    :'cost' => :'Float',
    :'type' => :'String',
    :'status' => :'OpportunityStatusReference',
    :'included_flag' => :'BOOLEAN',
    :'recurring' => :'ProductRecurring',
    :'percent' => :'Float',
    :'margin' => :'Float',
    :'opportunity_id' => :'Integer',
    :'quote_number' => :'String',
    :'quote_name' => :'String',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      revenue == o.revenue &&
      cost == o.cost &&
      type == o.type &&
      status == o.status &&
      included_flag == o.included_flag &&
      recurring == o.recurring &&
      percent == o.percent &&
      margin == o.margin &&
      opportunity_id == o.opportunity_id &&
      quote_number == o.quote_number &&
      quote_name == o.quote_name &&
      _info == o._info
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



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/connectwise-ruby-sdk/models/forecast.rb', line 299

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
    temp_model = ConnectWise.const_get(type).new
    temp_model.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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 365

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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 278

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


265
266
267
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 265

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



271
272
273
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 271

def hash
  [id, name, revenue, cost, type, status, included_flag, recurring, percent, margin, opportunity_id, quote_number, quote_name, _info].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 166

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 50
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 50.")
  end

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

  if !@quote_number.nil? && @quote_number.to_s.length > 20
    invalid_properties.push("invalid value for 'quote_number', the character length must be smaller than or equal to 20.")
  end

  if !@quote_name.nil? && @quote_name.to_s.length > 255
    invalid_properties.push("invalid value for 'quote_name', the character length must be smaller than or equal to 255.")
  end

  return 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



345
346
347
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 345

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



351
352
353
354
355
356
357
358
359
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 351

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



339
340
341
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 339

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



189
190
191
192
193
194
195
196
197
 
# File 'lib/connectwise-ruby-sdk/models/forecast.rb', line 189

def valid?
  return false if !@name.nil? && @name.to_s.length > 50
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["Product", "Service", "Agreement", "Other1", "Other2"])
  return false unless type_validator.valid?(@type)
  return false if !@quote_number.nil? && @quote_number.to_s.length > 20
  return false if !@quote_name.nil? && @quote_name.to_s.length > 255
  return true
end