Class: Bfwd::PricingComponentValue

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/pricing_component_value.rb

Overview

PricingComponentValue

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PricingComponentValue

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 97

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#applies_from ⇒ Object

{ "description" : "<p>The appliesFrom can be left null. If appliesFrom is set, it indicates when a value came into effect.</p>", "verbs“: }



49
50
51
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 49

def applies_from
  @applies_from
end

#applies_till ⇒ Object

{ "description" : "<p>For <span class=\"label label-default\">setup</span>, <span class=\"label label-default\">subscription</span>, and <span class=\"label label-default\">arrears</span> pricing components if appliesTill is specificed the value will be used whilst the time has not been reached. If appliesTill is null the pricing component value will be used until a new value is added. When a new value is added appliesTill will be set to the time the new value will take effect.</p><p><span class=\"label label-default\">usage</span> pricing applies to the previous billing period as it is charged in-arrears. When adding usage a new pricing component value should be added with appliesTill set to the end of the usages billing period. For example a monthly subscription results in an invoice being generated on the 1<sup>st</sup> of March, the previous months usage period ended on the same date. A usage value should be added to the subscription with the appliesTill set to the invoices periodStart, the 1<sup>st</sup> of March.</p>", "verbs“: }



52
53
54
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 52

def applies_till
  @applies_till
end

#changed_by ⇒ Object

{ "description" : "ID of the user who last updated the entity.", "verbs":[] }



22
23
24
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 22

def changed_by
  @changed_by
end

#created ⇒ Object

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }



19
20
21
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 19

def created
  @created
end

#id ⇒ Object

{ "description" : "", "verbs“: }



28
29
30
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 28

def id
  @id
end

#organization_id ⇒ Object

{ "description" : "", "verbs“: }



43
44
45
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 43

def organization_id
  @organization_id
end

#pending_change ⇒ Object

Returns the value of attribute pending_change.



54
55
56
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 54

def pending_change
  @pending_change
end

#pricing_component_id ⇒ Object

{ "description" : "", "verbs“: }



34
35
36
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 34

def pricing_component_id
  @pricing_component_id
end

#pricing_component_name ⇒ Object

{ "description" : "Name of the pricing-component associated with the pricing-component-value.", "verbs“: }



37
38
39
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 37

def pricing_component_name
  @pricing_component_name
end

#subscription_id ⇒ Object

{ "description" : "Value can be left null if setting the pricing component value on the subscription directly.", "verbs":["GET", "POST"] }



40
41
42
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 40

def subscription_id
  @subscription_id
end

#updated ⇒ Object

{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }



25
26
27
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 25

def updated
  @updated
end

#value ⇒ Object

{ "description" : "Quantity of a particular pricing component the subscription should have. For example if you have a pricing component for widgets, where $5/widget/month and you set the value to 10 then the customer will be charged $50 ($5 x 10) monthly.", "verbs“: }



46
47
48
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 46

def value
  @value
end

#version_id ⇒ Object

{ "description" : "", "verbs“: }



31
32
33
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 31

def version_id
  @version_id
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 58

def self.attribute_map
  {
    :'created' => :'created',
    :'changed_by' => :'changedBy',
    :'updated' => :'updated',
    :'id' => :'id',
    :'version_id' => :'versionID',
    :'pricing_component_id' => :'pricingComponentID',
    :'pricing_component_name' => :'pricingComponentName',
    :'subscription_id' => :'subscriptionID',
    :'organization_id' => :'organizationID',
    :'value' => :'value',
    :'applies_from' => :'appliesFrom',
    :'applies_till' => :'appliesTill',
    :'pending_change' => :'pendingChange'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 77

def self.swagger_types
  {
    :'created' => :'DateTime',
    :'changed_by' => :'String',
    :'updated' => :'DateTime',
    :'id' => :'String',
    :'version_id' => :'String',
    :'pricing_component_id' => :'String',
    :'pricing_component_name' => :'String',
    :'subscription_id' => :'String',
    :'organization_id' => :'String',
    :'value' => :'Integer',
    :'applies_from' => :'DateTime',
    :'applies_till' => :'DateTime',
    :'pending_change' => :'PendingComponentValueChange'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 192

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      changed_by == o.changed_by &&
      updated == o.updated &&
      id == o.id &&
      version_id == o.version_id &&
      pricing_component_id == o.pricing_component_id &&
      pricing_component_name == o.pricing_component_name &&
      subscription_id == o.subscription_id &&
      organization_id == o.organization_id &&
      value == o.value &&
      applies_from == o.applies_from &&
      applies_till == o.applies_till &&
      pending_change == o.pending_change
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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 246

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 312

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 225

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


212
213
214
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 212

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



218
219
220
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 218

def hash
  [created, changed_by, updated, id, version_id, pricing_component_id, pricing_component_name, subscription_id, organization_id, value, applies_from, applies_till, pending_change].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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 159

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

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

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

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



292
293
294
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 292

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



298
299
300
301
302
303
304
305
306
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 298

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



286
287
288
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 286

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



182
183
184
185
186
187
188
 
# File 'lib/bf_ruby2/models/pricing_component_value.rb', line 182

def valid?
  return false if @id.nil?
  return false if @pricing_component_id.nil?
  return false if @subscription_id.nil?
  return false if @value.nil?
  return true
end