Class: TripletexApi::Prospect

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/models/prospect.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Prospect

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/tripletex_api/models/prospect.rb', line 124

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'isClosed')
    self.is_closed = attributes[:'isClosed']
  else
    self.is_closed = false
  end

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#changes ⇒ Object

Returns the value of attribute changes.



22
23
24
 
# File 'lib/tripletex_api/models/prospect.rb', line 22

def changes
  @changes
end

#closed_date ⇒ Object

Returns the value of attribute closed_date.



40
41
42
 
# File 'lib/tripletex_api/models/prospect.rb', line 40

def closed_date
  @closed_date
end

#closed_reason ⇒ Object

Returns the value of attribute closed_reason.



38
39
40
 
# File 'lib/tripletex_api/models/prospect.rb', line 38

def closed_reason
  @closed_reason
end

#competitor ⇒ Object

Returns the value of attribute competitor.



42
43
44
 
# File 'lib/tripletex_api/models/prospect.rb', line 42

def competitor
  @competitor
end

#created_date ⇒ Object

Returns the value of attribute created_date.



30
31
32
 
# File 'lib/tripletex_api/models/prospect.rb', line 30

def created_date
  @created_date
end

#customer ⇒ Object

Returns the value of attribute customer.



32
33
34
 
# File 'lib/tripletex_api/models/prospect.rb', line 32

def customer
  @customer
end

#description ⇒ Object

Returns the value of attribute description.



28
29
30
 
# File 'lib/tripletex_api/models/prospect.rb', line 28

def description
  @description
end

#final_additional_services_value ⇒ Object

Tripletex specific.



62
63
64
 
# File 'lib/tripletex_api/models/prospect.rb', line 62

def final_additional_services_value
  @final_additional_services_value
end

#final_income_date ⇒ Object

The estimated start date for income on the prospect.



53
54
55
 
# File 'lib/tripletex_api/models/prospect.rb', line 53

def final_income_date
  @final_income_date
end

#final_initial_value ⇒ Object

The estimated startup fee on this prospect.



56
57
58
 
# File 'lib/tripletex_api/models/prospect.rb', line 56

def final_initial_value
  @final_initial_value
end

#final_monthly_value ⇒ Object

The estimated monthly fee on this prospect.



59
60
61
 
# File 'lib/tripletex_api/models/prospect.rb', line 59

def final_monthly_value
  @final_monthly_value
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/tripletex_api/models/prospect.rb', line 18

def id
  @id
end

#is_closed ⇒ Object

Returns the value of attribute is_closed.



36
37
38
 
# File 'lib/tripletex_api/models/prospect.rb', line 36

def is_closed
  @is_closed
end

#name ⇒ Object

Returns the value of attribute name.



26
27
28
 
# File 'lib/tripletex_api/models/prospect.rb', line 26

def name
  @name
end

#project ⇒ Object

The project connected to this prospect.



47
48
49
 
# File 'lib/tripletex_api/models/prospect.rb', line 47

def project
  @project
end

#project_offer ⇒ Object

The project offer connected to this prospect.



50
51
52
 
# File 'lib/tripletex_api/models/prospect.rb', line 50

def project_offer
  @project_offer
end

#prospect_type ⇒ Object

Returns the value of attribute prospect_type.



44
45
46
 
# File 'lib/tripletex_api/models/prospect.rb', line 44

def prospect_type
  @prospect_type
end

#sales_employee ⇒ Object

Returns the value of attribute sales_employee.



34
35
36
 
# File 'lib/tripletex_api/models/prospect.rb', line 34

def sales_employee
  @sales_employee
end

#total_value ⇒ Object

The estimated total fee on this prospect.



65
66
67
 
# File 'lib/tripletex_api/models/prospect.rb', line 65

def total_value
  @total_value
end

#url ⇒ Object

Returns the value of attribute url.



24
25
26
 
# File 'lib/tripletex_api/models/prospect.rb', line 24

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



20
21
22
 
# File 'lib/tripletex_api/models/prospect.rb', line 20

def version
  @version
end

Class Method Details

.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
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/tripletex_api/models/prospect.rb', line 69

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'name' => :'name',
    :'description' => :'description',
    :'created_date' => :'createdDate',
    :'customer' => :'customer',
    :'sales_employee' => :'salesEmployee',
    :'is_closed' => :'isClosed',
    :'closed_reason' => :'closedReason',
    :'closed_date' => :'closedDate',
    :'competitor' => :'competitor',
    :'prospect_type' => :'prospectType',
    :'project' => :'project',
    :'project_offer' => :'projectOffer',
    :'final_income_date' => :'finalIncomeDate',
    :'final_initial_value' => :'finalInitialValue',
    :'final_monthly_value' => :'finalMonthlyValue',
    :'final_additional_services_value' => :'finalAdditionalServicesValue',
    :'total_value' => :'totalValue'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/tripletex_api/models/prospect.rb', line 96

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'created_date' => :'String',
    :'customer' => :'Customer',
    :'sales_employee' => :'Employee',
    :'is_closed' => :'BOOLEAN',
    :'closed_reason' => :'Integer',
    :'closed_date' => :'String',
    :'competitor' => :'String',
    :'prospect_type' => :'Integer',
    :'project' => :'Project',
    :'project_offer' => :'Project',
    :'final_income_date' => :'String',
    :'final_initial_value' => :'Float',
    :'final_monthly_value' => :'Float',
    :'final_additional_services_value' => :'Float',
    :'total_value' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/tripletex_api/models/prospect.rb', line 304

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      name == o.name &&
      description == o.description &&
      created_date == o.created_date &&
      customer == o.customer &&
      sales_employee == o.sales_employee &&
      is_closed == o.is_closed &&
      closed_reason == o.closed_reason &&
      closed_date == o.closed_date &&
      competitor == o.competitor &&
      prospect_type == o.prospect_type &&
      project == o.project &&
      project_offer == o.project_offer &&
      final_income_date == o.final_income_date &&
      final_initial_value == o.final_initial_value &&
      final_monthly_value == o.final_monthly_value &&
      final_additional_services_value == o.final_additional_services_value &&
      total_value == o.total_value
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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/tripletex_api/models/prospect.rb', line 366

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 = TripletexApi.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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/tripletex_api/models/prospect.rb', line 432

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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/tripletex_api/models/prospect.rb', line 345

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


332
333
334
 
# File 'lib/tripletex_api/models/prospect.rb', line 332

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



338
339
340
 
# File 'lib/tripletex_api/models/prospect.rb', line 338

def hash
  [id, version, changes, url, name, description, created_date, customer, sales_employee, is_closed, closed_reason, closed_date, competitor, prospect_type, project, project_offer, final_income_date, final_initial_value, final_monthly_value, final_additional_services_value, total_value].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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/tripletex_api/models/prospect.rb', line 222

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

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

  if !@closed_reason.nil? && @closed_reason < 0
    invalid_properties.push("invalid value for 'closed_reason', must be greater than or equal to 0.")
  end

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

  if !@prospect_type.nil? && @prospect_type < 1
    invalid_properties.push("invalid value for 'prospect_type', must be greater than or equal to 1.")
  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



412
413
414
 
# File 'lib/tripletex_api/models/prospect.rb', line 412

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



418
419
420
421
422
423
424
425
426
 
# File 'lib/tripletex_api/models/prospect.rb', line 418

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



406
407
408
 
# File 'lib/tripletex_api/models/prospect.rb', line 406

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



249
250
251
252
253
254
255
256
 
# File 'lib/tripletex_api/models/prospect.rb', line 249

def valid?
  return false if !@name.nil? && @name.to_s.length > 255
  return false if @created_date.nil?
  return false if !@closed_reason.nil? && @closed_reason < 0
  return false if !@competitor.nil? && @competitor.to_s.length > 255
  return false if !@prospect_type.nil? && @prospect_type < 1
  return true
end