Class: Zernio::UsageMeteringTax

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/usage_metering_tax.rb

Overview

Estimated tax on the window's net totals.total, computed with Stripe Tax against the billing address (the same engine the real invoice uses; invoices apply exclusive tax, so the card is charged total + tax). Null when the account has no billing address on file, the total is zero or negative, or the estimate failed.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ UsageMeteringTax

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 71

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::UsageMeteringTax` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::UsageMeteringTax`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'tax_usd')
    self.tax_usd = attributes[:'tax_usd']
  end

  if attributes.key?(:'rate_percent')
    self.rate_percent = attributes[:'rate_percent']
  end

  if attributes.key?(:'jurisdiction_label')
    self.jurisdiction_label = attributes[:'jurisdiction_label']
  end

  if attributes.key?(:'reverse_charge')
    self.reverse_charge = attributes[:'reverse_charge']
  end
end

Instance Attribute Details

#jurisdiction_label ⇒ Object

Human jurisdiction label, e.g. "ES VAT" or "WA sales tax".



26
27
28
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 26

def jurisdiction_label
  @jurisdiction_label
end

#rate_percent ⇒ Object

Combined rate percentage, e.g. 21.



23
24
25
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 23

def rate_percent
  @rate_percent
end

#reverse_charge ⇒ Object

True for EU/UK B2B reverse charge (0 tax added by design).



29
30
31
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 29

def reverse_charge
  @reverse_charge
end

#tax_usd ⇒ Object

Estimated tax in USD, added on top of totals.total.



20
21
22
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 20

def tax_usd
  @tax_usd
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



42
43
44
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 47

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 32

def self.attribute_map
  {
    :'tax_usd' => :'taxUsd',
    :'rate_percent' => :'ratePercent',
    :'jurisdiction_label' => :'jurisdictionLabel',
    :'reverse_charge' => :'reverseCharge'
  }
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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 143

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
66
67
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 62

def self.openapi_nullable
  Set.new([
    :'rate_percent',
    :'jurisdiction_label',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 52

def self.openapi_types
  {
    :'tax_usd' => :'Float',
    :'rate_percent' => :'Float',
    :'jurisdiction_label' => :'String',
    :'reverse_charge' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



119
120
121
122
123
124
125
126
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 119

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tax_usd == o.tax_usd &&
      rate_percent == o.rate_percent &&
      jurisdiction_label == o.jurisdiction_label &&
      reverse_charge == o.reverse_charge
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


130
131
132
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 130

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



136
137
138
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 136

def hash
  [tax_usd, rate_percent, jurisdiction_label, reverse_charge].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



104
105
106
107
108
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 104

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 165

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



112
113
114
115
 
# File 'lib/zernio-sdk/models/usage_metering_tax.rb', line 112

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end