Class: Bfwd::SingleRecalculateChargeRequest

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

Overview

Request object for recalculating a charge raised against a subscription or invoice.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SingleRecalculateChargeRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 94

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

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

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

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

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

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

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

end

Instance Attribute Details

#amount ⇒ Object

only if the existing charge has none of [‘pricingComponentName`, `pricingComponentID`] defined)
New monetary amount for which to charge. Used only for ad-hoc charges (i.e charges not associated with any pricing component).
This amount excludes tax.“,”verbs“:



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

def amount
  @amount
end

#description ⇒ Object

description given to the charge.“,”verbs“:



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

def description
  @description
end

#id ⇒ Object

unique id of the charge to be recalculated.“,”verbs“:



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

def id
  @id
end

#invoicing_type ⇒ Object

class=\"label label-default\">Aggregated</span>","description":"The strategy for how to raise invoices describing the charges produced by this charge recalculation.
<span class=\"label label-default\">Immediate</span> &mdash; Generate straight-away an invoice containing these charges.
<span class=\"label label-default\">Aggregated</span> &mdash; Add these charges to the next invoice which is generated naturally &mdash; i.e. the invoice raised at the current period’s end.“,”verbs“:



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

def invoicing_type
  @invoicing_type
end

#name ⇒ Object

friendly name given to the charge to help identify it.“,”verbs“:



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

def name
  @name
end

#organization_id ⇒ Object

using your authentication credentials) ID of the organization actioning this request.","description":"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.“,”verbs“:



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

def organization_id
  @organization_id
end

#pricing_component_value ⇒ Object

only if the existing charge has any of [‘pricingComponentName`, `pricingComponentID`] defined)
The updated value consumed of the pricing component which this charge concerns.“,”verbs“:



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

def pricing_component_value
  @pricing_component_value
end

#recalculation_behaviour ⇒ Object

href="\"POST\",\"GET\"">default“:”RecalculateWithLatestPricing“,”verbs“:



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

def recalculation_behaviour
  @recalculation_behaviour
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'description' => :'description',
    :'amount' => :'amount',
    :'invoicing_type' => :'invoicingType',
    :'pricing_component_value' => :'pricingComponentValue',
    :'recalculation_behaviour' => :'recalculationBehaviour',
    :'organization_id' => :'organizationID'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 79

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'amount' => :'Float',
    :'invoicing_type' => :'String',
    :'pricing_component_value' => :'Integer',
    :'recalculation_behaviour' => :'String',
    :'organization_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      amount == o.amount &&
      invoicing_type == o.invoicing_type &&
      pricing_component_value == o.pricing_component_value &&
      recalculation_behaviour == o.recalculation_behaviour &&
      organization_id == o.organization_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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 232

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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 298

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 211

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


198
199
200
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 204

def hash
  [id, name, description, amount, invoicing_type, pricing_component_value, recalculation_behaviour, organization_id].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



136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 136

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

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



278
279
280
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 278

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



284
285
286
287
288
289
290
291
292
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 284

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



272
273
274
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 272

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



151
152
153
154
155
156
157
158
159
 
# File 'lib/bf_ruby2/models/single_recalculate_charge_request.rb', line 151

def valid?
  return false if @id.nil?
  invoicing_type_validator = EnumAttributeValidator.new('String', ["Immediate", "Aggregated"])
  return false unless invoicing_type_validator.valid?(@invoicing_type)
  return false if @recalculation_behaviour.nil?
  recalculation_behaviour_validator = EnumAttributeValidator.new('String', ["RecalculateWithLatestPricing", "RecalculateWithCurrentPricing"])
  return false unless recalculation_behaviour_validator.valid?(@recalculation_behaviour)
  return true
end