Class: SubskribeDevClient::RecognitionRule

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_dev/models/recognition_rule.rb,
lib/subskribe_dev2/models/recognition_rule.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecognitionRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
163
164
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 105

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?(:'entityIds')
    if (value = attributes[:'entityIds']).is_a?(Array)
      self.entity_ids = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#catchup_required ⇒ Object

Returns the value of attribute catchup_required.



39
40
41
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 39

def catchup_required
  @catchup_required
end

#deferred_revenue_account_id ⇒ Object

Returns the value of attribute deferred_revenue_account_id.



33
34
35
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 33

def 
  @deferred_revenue_account_id
end

#distribution_method ⇒ Object

Returns the value of attribute distribution_method.



25
26
27
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 25

def distribution_method
  @distribution_method
end

#entity_ids ⇒ Object

Returns the value of attribute entity_ids.



17
18
19
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 17

def entity_ids
  @entity_ids
end

#id ⇒ Object

Returns the value of attribute id.



41
42
43
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 41

def id
  @id
end

#in_use ⇒ Object

Returns the value of attribute in_use.



37
38
39
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 37

def in_use
  @in_use
end

#is_catchup_required ⇒ Object

Returns the value of attribute is_catchup_required.



29
30
31
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 29

def is_catchup_required
  @is_catchup_required
end

#name ⇒ Object

Returns the value of attribute name.



19
20
21
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 19

def name
  @name
end

#recognition_date_alignment ⇒ Object

Returns the value of attribute recognition_date_alignment.



27
28
29
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 27

def recognition_date_alignment
  @recognition_date_alignment
end

#recognition_event_type ⇒ Object

Returns the value of attribute recognition_event_type.



31
32
33
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 31

def recognition_event_type
  @recognition_event_type
end

#recognition_type ⇒ Object

Returns the value of attribute recognition_type.



23
24
25
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 23

def recognition_type
  @recognition_type
end

#recognized_revenue_account_id ⇒ Object

Returns the value of attribute recognized_revenue_account_id.



35
36
37
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 35

def 
  @recognized_revenue_account_id
end

#source ⇒ Object

Returns the value of attribute source.



21
22
23
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 21

def source
  @source
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 66

def self.attribute_map
  {
    :'entity_ids' => :'entityIds',
    :'name' => :'name',
    :'source' => :'source',
    :'recognition_type' => :'recognitionType',
    :'distribution_method' => :'distributionMethod',
    :'recognition_date_alignment' => :'recognitionDateAlignment',
    :'is_catchup_required' => :'isCatchupRequired',
    :'recognition_event_type' => :'recognitionEventType',
    :'deferred_revenue_account_id' => :'deferredRevenueAccountId',
    :'recognized_revenue_account_id' => :'recognizedRevenueAccountId',
    :'in_use' => :'inUse',
    :'catchup_required' => :'catchupRequired',
    :'id' => :'id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 85

def self.swagger_types
  {
    :'entity_ids' => :'Array<String>',
    :'name' => :'String',
    :'source' => :'String',
    :'recognition_type' => :'String',
    :'distribution_method' => :'String',
    :'recognition_date_alignment' => :'String',
    :'is_catchup_required' => :'BOOLEAN',
    :'recognition_event_type' => :'String',
    :'deferred_revenue_account_id' => :'String',
    :'recognized_revenue_account_id' => :'String',
    :'in_use' => :'BOOLEAN',
    :'catchup_required' => :'BOOLEAN',
    :'id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 241

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      entity_ids == o.entity_ids &&
      name == o.name &&
      source == o.source &&
      recognition_type == o.recognition_type &&
      distribution_method == o.distribution_method &&
      recognition_date_alignment == o.recognition_date_alignment &&
      is_catchup_required == o.is_catchup_required &&
      recognition_event_type == o.recognition_event_type &&
       == o. &&
       == o. &&
      in_use == o.in_use &&
      catchup_required == o.catchup_required &&
      id == o.id
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



295
296
297
298
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
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 295

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 361

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 274

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 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


261
262
263
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 261

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



267
268
269
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 267

def hash
  [entity_ids, name, source, recognition_type, distribution_method, recognition_date_alignment, is_catchup_required, recognition_event_type, , , in_use, catchup_required, id].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



168
169
170
171
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 168

def list_invalid_properties
  invalid_properties = Array.new
  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



341
342
343
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 341

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



347
348
349
350
351
352
353
354
355
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 347

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



335
336
337
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 335

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



175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/subskribe_dev/models/recognition_rule.rb', line 175

def valid?
  source_validator = EnumAttributeValidator.new('String', ['ORDER', 'INVOICE'])
  return false unless source_validator.valid?(@source)
  recognition_type_validator = EnumAttributeValidator.new('String', ['OVER_TIME', 'POINT_IN_TIME', 'EVENT'])
  return false unless recognition_type_validator.valid?(@recognition_type)
  distribution_method_validator = EnumAttributeValidator.new('String', ['DAYS', 'MONTHS_EVEN', 'MONTHS_PARTIAL_PRORATED'])
  return false unless distribution_method_validator.valid?(@distribution_method)
  recognition_date_alignment_validator = EnumAttributeValidator.new('String', ['INVOICE_START_DATE', 'INVOICE_END_DATE'])
  return false unless recognition_date_alignment_validator.valid?(@recognition_date_alignment)
  recognition_event_type_validator = EnumAttributeValidator.new('String', ['PERCENTAGE_OF_COMPLETION', 'AMOUNT'])
  return false unless recognition_event_type_validator.valid?(@recognition_event_type)
  true
end