Class: Bfwd::NestedChargeRequest

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

Overview

Partial request, which – when accompanied by additional context – describes some request concerning charges.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NestedChargeRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
167
168
 
# File 'lib/bf_ruby2/models/nested_charge_request.rb', line 114

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#amount ⇒ Object

amount for which to charge. Used only for ad-hoc charges i.e charges not associated with any pricing component. Applicable if pricingComponent is NOT defined“,”verbs“:



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

def amount
  @amount
end

#charge_type ⇒ Object

class=\"label label-default\">Debit</span>","description":"Whether this charge represents an increase or decrease in invoice cost
<span class=\"label label-default\">Credit</span> &mdash; This results in a reduction to the invoice cost
<span class=\"label label-default\">Debit</span> &mdash; This will increase the invoice cost“,”verbs“:



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

def charge_type
  @charge_type
end

#description ⇒ Object

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



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

def description
  @description
end

#name ⇒ Object

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



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

def name
  @name
end

#period_end ⇒ Object

of current period)","description":"(Applicable only if ‘pricingComponent` is defined)
End of the interval to which the charge applies. Used in pro-rata calculation“,”verbs“:



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

def period_end
  @period_end
end

#period_start ⇒ Object

of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods. Pro-rating the price of pricingComponents purchased“,”verbs“:



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

def period_start
  @period_start
end

#pricing_component ⇒ Object

that this charge is for consumption of some quantity of this pricing component (whose name or ID can be provided).
If left blank:
The charge will be created as ‘ad-hoc’. That is: a monetary lump sum, associated with no pricing component“,”verbs“:



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

def pricing_component
  @pricing_component
end

#pricing_component_value ⇒ Object

if pricingComponent is defined]. The value consumed of the pricing component which this charge concerns.“,”verbs“:



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

def pricing_component_value
  @pricing_component_value
end

#product ⇒ Object

only if the ‘productRatePlan` field is populated with a name (as opposed to an ID)]. The ID or name of the product rate plan to which the referenced rate plan belongs.“,”verbs“:



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

def product
  @product
end

#product_rate_plan ⇒ Object

only if the ‘pricingComponent` field is populated with a name (as opposed to an ID)]. The ID or name of the rate plan to which the referenced PricingComponent belongs.“,”verbs“:



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

def product_rate_plan
  @product_rate_plan
end

#tax_amount ⇒ Object

if amount is specified and indicates whether or not to apply tax in addition to the value specified.
<span class=\"label label-default\">true</span> &mdash; Tax will be added on top of the nominal price specified in amount &mdash; in accordance with any taxation strategies you have defined.
<span class=\"label label-default\">false</span> &mdash; No tax will be applied on top of the price specified in amount.“,”verbs“:



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

def tax_amount
  @tax_amount
end

#trial ⇒ Object

the charge is meant in the context of a trial.
<span class=\"label label-default\">false</span> &mdash; This is a non-trial charge, so funds will be sought from the customer.
<span class=\"label label-default\">true</span> &mdash; This is a trial charge, soThe charge can be considered ‘Paid’ without taking any funds from the customer.“,”verbs“:



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

def trial
  @trial
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'amount' => :'amount',
    :'tax_amount' => :'taxAmount',
    :'period_start' => :'periodStart',
    :'period_end' => :'periodEnd',
    :'charge_type' => :'chargeType',
    :'trial' => :'trial',
    :'product' => :'product',
    :'product_rate_plan' => :'productRatePlan',
    :'pricing_component' => :'pricingComponent',
    :'pricing_component_value' => :'pricingComponentValue'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/bf_ruby2/models/nested_charge_request.rb', line 95

def self.swagger_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'amount' => :'Float',
    :'tax_amount' => :'BOOLEAN',
    :'period_start' => :'DateTime',
    :'period_end' => :'DateTime',
    :'charge_type' => :'String',
    :'trial' => :'BOOLEAN',
    :'product' => :'String',
    :'product_rate_plan' => :'String',
    :'pricing_component' => :'String',
    :'pricing_component_value' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      amount == o.amount &&
      tax_amount == o.tax_amount &&
      period_start == o.period_start &&
      period_end == o.period_end &&
      charge_type == o.charge_type &&
      trial == o.trial &&
      product == o.product &&
      product_rate_plan == o.product_rate_plan &&
      pricing_component == o.pricing_component &&
      pricing_component_value == o.pricing_component_value
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



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
283
284
285
286
 
# File 'lib/bf_ruby2/models/nested_charge_request.rb', line 250

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/bf_ruby2/models/nested_charge_request.rb', line 316

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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/bf_ruby2/models/nested_charge_request.rb', line 229

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


216
217
218
 
# File 'lib/bf_ruby2/models/nested_charge_request.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



222
223
224
 
# File 'lib/bf_ruby2/models/nested_charge_request.rb', line 222

def hash
  [name, description, amount, tax_amount, period_start, period_end, charge_type, trial, product, product_rate_plan, pricing_component, pricing_component_value].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



172
173
174
175
 
# File 'lib/bf_ruby2/models/nested_charge_request.rb', line 172

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



296
297
298
 
# File 'lib/bf_ruby2/models/nested_charge_request.rb', line 296

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



302
303
304
305
306
307
308
309
310
 
# File 'lib/bf_ruby2/models/nested_charge_request.rb', line 302

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



290
291
292
 
# File 'lib/bf_ruby2/models/nested_charge_request.rb', line 290

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



179
180
181
182
183
 
# File 'lib/bf_ruby2/models/nested_charge_request.rb', line 179

def valid?
  charge_type_validator = EnumAttributeValidator.new('String', ["Credit", "Debit"])
  return false unless charge_type_validator.valid?(@charge_type)
  return true
end