Class: Bfwd::PricingComponentValueRequest

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

Overview

Request object for recalculating an invoice.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PricingComponentValueRequest

Initializes the object



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

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

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

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

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

end

Instance Attribute Details

#change_mode ⇒ Object

class=\"label label-default\">as on pricing component</span>","description":"Default behaviour when a value is changed by default the change mode from the pricing component is used.
<span class=\"label label-default\">immediate</span> &mdash; Change will apply at the time the request is made.
<span class=\"label label-default\">delayed</span> &mdash; Change will apply at the end of the current billing cycle.“,”verbs“:



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

def change_mode
  @change_mode
end

#created ⇒ Object

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



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

def created
  @created
end

#invoicing_type ⇒ Object

class=\"label label-default\">Aggregated</span>","description":"If the change results in a charge should it be invoiced straight away or on the next invoice.
<span class=\"label label-default\">Immediate</span> &mdash; If the change has a cost associated with it , for example a pro-rated upgrade charge, an invoice will be raised at the time the request is made. If the invoice fails to be paid the upgrade will fail and the invoice will be voided. No credit or refund is issued for immediate downgrades.
<span class=\"label label-default\">Aggregated</span> &mdash; If the change has a cost associated with it , for example a pro-rated upgrade charge, the charge will be added to the next invoice raised for this subscription. As no payment is required when the change is request the change always succeeds.“,”verbs“:



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

def invoicing_type
  @invoicing_type
end

#no_charge ⇒ Object

class=\"label label-default\">false</span>","description":"If specified the change will have no cost associated with it. This is useful for immediately changing a value without creating any upgrade charge.“,”verbs“:



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

def no_charge
  @no_charge
end

#value ⇒ Object

class=\"label label-default\"></span>","description":"Modifies the current value used to calculate the recurring costs of the subscription. This can effectively be thought of as an upsert.Note: altering costs on invoices are made be editing charges.
<span class=\"label label-default\">Setup Pricing</span> &mdash; Value changed if initial invoice has not been issued.
<span class=\"label label-default\">In-Advance/Subscription Pricing</span> &mdash; Value changed and a charge added. If the change is delayed the current value on the subscription will show the delayed change.
<span class=\"label label-default\">Arrears Pricing</span> &mdash; Value updated, and a pro-rated charge added to the subscription if required.
<span class=\"label label-default\">Usage Pricing</span> &mdash; Usage created or updated for the current billing cycle.which is generated naturally &mdash; i.e. the invoice raised at the current period’s end.“,”verbs“:



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

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 56

def self.attribute_map
  {
    :'created' => :'created',
    :'value' => :'value',
    :'change_mode' => :'changeMode',
    :'invoicing_type' => :'invoicingType',
    :'no_charge' => :'noCharge'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 67

def self.swagger_types
  {
    :'created' => :'DateTime',
    :'value' => :'Integer',
    :'change_mode' => :'String',
    :'invoicing_type' => :'String',
    :'no_charge' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



153
154
155
156
157
158
159
160
161
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      value == o.value &&
      change_mode == o.change_mode &&
      invoicing_type == o.invoicing_type &&
      no_charge == o.no_charge
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 199

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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 265

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 178

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

See Also:

  • `==` method


165
166
167
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 165

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



171
172
173
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 171

def hash
  [created, value, change_mode, invoicing_type, no_charge].hash
end

#list_invalid_properties ⇒ Object

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



111
112
113
114
115
116
117
118
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 111

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



245
246
247
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 245

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 251

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



239
240
241
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 239

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



122
123
124
125
126
127
128
129
 
# File 'lib/bf_ruby2/models/pricing_component_value_request.rb', line 122

def valid?
  return false if @value.nil?
  change_mode_validator = EnumAttributeValidator.new('String', ["immediate", "delayed"])
  return false unless change_mode_validator.valid?(@change_mode)
  invoicing_type_validator = EnumAttributeValidator.new('String', ["Immediate", "Aggregated"])
  return false unless invoicing_type_validator.valid?(@invoicing_type)
  return true
end