Class: IntegrationApi::CustomerRevenue

Inherits:
Object
  • Object
show all
Defined in:
lib/integration_api/models/customer_revenue.rb

Overview

Customer Revenue Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerRevenue

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
118
119
120
121
122
123
124
125
 
# File 'lib/integration_api/models/customer_revenue.rb', line 78

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accounting_method ⇒ Object

accounting_method



19
20
21
 
# File 'lib/integration_api/models/customer_revenue.rb', line 19

def accounting_method
  @accounting_method
end

#contact_id ⇒ Object

contactId



22
23
24
 
# File 'lib/integration_api/models/customer_revenue.rb', line 22

def contact_id
  @contact_id
end

#create_date ⇒ Object

Returns the value of attribute create_date.



24
25
26
 
# File 'lib/integration_api/models/customer_revenue.rb', line 24

def create_date
  @create_date
end

#currency_code ⇒ Object

currency_code



27
28
29
 
# File 'lib/integration_api/models/customer_revenue.rb', line 27

def currency_code
  @currency_code
end

#date ⇒ Object

date



30
31
32
 
# File 'lib/integration_api/models/customer_revenue.rb', line 30

def date
  @date
end

#id ⇒ Object

Returns the value of attribute id.



32
33
34
 
# File 'lib/integration_api/models/customer_revenue.rb', line 32

def id
  @id
end

#metadata ⇒ Object

metadata



35
36
37
 
# File 'lib/integration_api/models/customer_revenue.rb', line 35

def metadata
  @metadata
end

#revenue ⇒ Object

revenue



38
39
40
 
# File 'lib/integration_api/models/customer_revenue.rb', line 38

def revenue
  @revenue
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



40
41
42
 
# File 'lib/integration_api/models/customer_revenue.rb', line 40

def secondary_id
  @secondary_id
end

#update_date ⇒ Object

Returns the value of attribute update_date.



42
43
44
 
# File 'lib/integration_api/models/customer_revenue.rb', line 42

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/integration_api/models/customer_revenue.rb', line 45

def self.attribute_map
  {
    :'accounting_method' => :'accounting_method',
    :'contact_id' => :'contact_id',
    :'create_date' => :'create_date',
    :'currency_code' => :'currency_code',
    :'date' => :'date',
    :'id' => :'id',
    :'metadata' => :'metadata',
    :'revenue' => :'revenue',
    :'secondary_id' => :'secondary_id',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/integration_api/models/customer_revenue.rb', line 61

def self.swagger_types
  {
    :'accounting_method' => :'String',
    :'contact_id' => :'String',
    :'create_date' => :'DateTime',
    :'currency_code' => :'String',
    :'date' => :'Date',
    :'id' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'revenue' => :'Float',
    :'secondary_id' => :'String',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/integration_api/models/customer_revenue.rb', line 167

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accounting_method == o.accounting_method &&
      contact_id == o.contact_id &&
      create_date == o.create_date &&
      currency_code == o.currency_code &&
      date == o.date &&
      id == o.id &&
      metadata == o.metadata &&
      revenue == o.revenue &&
      secondary_id == o.secondary_id &&
      update_date == o.update_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



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
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/integration_api/models/customer_revenue.rb', line 217

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    value
  when :Date
    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 = IntegrationApi.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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/integration_api/models/customer_revenue.rb', line 281

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/integration_api/models/customer_revenue.rb', line 197

def build_from_hash(attributes)
  self.class.swagger_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]]))
    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


184
185
186
 
# File 'lib/integration_api/models/customer_revenue.rb', line 184

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/integration_api/models/customer_revenue.rb', line 190

def hash
  [accounting_method, contact_id, create_date, currency_code, date, id, metadata, revenue, secondary_id, update_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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/integration_api/models/customer_revenue.rb', line 129

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

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

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

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

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



262
263
264
 
# File 'lib/integration_api/models/customer_revenue.rb', line 262

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



268
269
270
271
272
273
274
275
 
# File 'lib/integration_api/models/customer_revenue.rb', line 268

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



256
257
258
 
# File 'lib/integration_api/models/customer_revenue.rb', line 256

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



156
157
158
159
160
161
162
163
 
# File 'lib/integration_api/models/customer_revenue.rb', line 156

def valid?
  return false if @accounting_method.nil?
  return false if @contact_id.nil?
  return false if @currency_code.nil?
  return false if @date.nil?
  return false if @revenue.nil?
  true
end