Class: PaypalServerSdk::Taxes

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/paypal_server_sdk/models/taxes.rb

Overview

The tax details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(percentage:, inclusive: true) ⇒ Taxes

Returns a new instance of Taxes.



41
42
43
44
# File 'lib/paypal_server_sdk/models/taxes.rb', line 41

def initialize(percentage:, inclusive: true)
  @percentage = percentage
  @inclusive = inclusive unless inclusive == SKIP
end

Instance Attribute Details

#inclusiveTrueClass | FalseClass

Indicates whether the tax was already included in the billing amount.

Returns:

  • (TrueClass | FalseClass)


19
20
21
# File 'lib/paypal_server_sdk/models/taxes.rb', line 19

def inclusive
  @inclusive
end

#percentageString

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as ‘19.99`.

Returns:

  • (String)


15
16
17
# File 'lib/paypal_server_sdk/models/taxes.rb', line 15

def percentage
  @percentage
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
# File 'lib/paypal_server_sdk/models/taxes.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  percentage = hash.key?('percentage') ? hash['percentage'] : nil
  inclusive = hash['inclusive'] ||= true

  # Create object from extracted values.

  Taxes.new(percentage: percentage,
            inclusive: inclusive)
end

.namesObject

A mapping from model property names to API property names.



22
23
24
25
26
27
# File 'lib/paypal_server_sdk/models/taxes.rb', line 22

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['percentage'] = 'percentage'
  @_hash['inclusive'] = 'inclusive'
  @_hash
end

.nullablesObject

An array for nullable fields



37
38
39
# File 'lib/paypal_server_sdk/models/taxes.rb', line 37

def self.nullables
  []
end

.optionalsObject

An array for optional fields



30
31
32
33
34
# File 'lib/paypal_server_sdk/models/taxes.rb', line 30

def self.optionals
  %w[
    inclusive
  ]
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



66
67
68
69
# File 'lib/paypal_server_sdk/models/taxes.rb', line 66

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} percentage: #{@percentage.inspect}, inclusive: #{@inclusive.inspect}>"
end

#to_sObject

Provides a human-readable string representation of the object.



60
61
62
63
# File 'lib/paypal_server_sdk/models/taxes.rb', line 60

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} percentage: #{@percentage}, inclusive: #{@inclusive}>"
end