Class: UnivapayClientSdk::CardLimit

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/univapay_client_sdk/models/card_limit.rb

Overview

Per-card spending limit enforced on card payments, evaluated over a rolling duration.

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(amount: SKIP, currency: SKIP, amount_formatted: SKIP, duration: SKIP, additional_properties: nil) ⇒ CardLimit

Returns a new instance of CardLimit.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/univapay_client_sdk/models/card_limit.rb', line 54

def initialize(amount: SKIP, currency: SKIP, amount_formatted: SKIP,
               duration: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @amount = amount unless amount == SKIP
  @currency = currency unless currency == SKIP
  @amount_formatted = amount_formatted unless amount_formatted == SKIP
  @duration = duration unless duration == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#amount ⇒ Integer

Maximum amount a single card may charge within duration.

Returns:

  • (Integer) 


15
16
17
 
# File 'lib/univapay_client_sdk/models/card_limit.rb', line 15

def amount
  @amount
end

#amount_formatted ⇒ Float

Limit amount formatted for display.

Returns:

  • (Float) 


23
24
25
 
# File 'lib/univapay_client_sdk/models/card_limit.rb', line 23

def amount_formatted
  @amount_formatted
end

#currency ⇒ String

ISO-4217 currency code.

Returns:

  • (String) 


19
20
21
 
# File 'lib/univapay_client_sdk/models/card_limit.rb', line 19

def currency
  @currency
end

#duration ⇒ String

ISO-8601 period over which the limit is evaluated (e.g. P1M).

Returns:

  • (String) 


27
28
29
 
# File 'lib/univapay_client_sdk/models/card_limit.rb', line 27

def duration
  @duration
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/univapay_client_sdk/models/card_limit.rb', line 67

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  amount = hash.key?('amount') ? hash['amount'] : SKIP
  currency = hash.key?('currency') ? hash['currency'] : SKIP
  amount_formatted =
    hash.key?('amount_formatted') ? hash['amount_formatted'] : SKIP
  duration = hash.key?('duration') ? hash['duration'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  CardLimit.new(amount: amount,
                currency: currency,
                amount_formatted: amount_formatted,
                duration: duration,
                additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



30
31
32
33
34
35
36
37
 
# File 'lib/univapay_client_sdk/models/card_limit.rb', line 30

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['amount'] = 'amount'
  @_hash['currency'] = 'currency'
  @_hash['amount_formatted'] = 'amount_formatted'
  @_hash['duration'] = 'duration'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



50
51
52
 
# File 'lib/univapay_client_sdk/models/card_limit.rb', line 50

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



40
41
42
43
44
45
46
47
 
# File 'lib/univapay_client_sdk/models/card_limit.rb', line 40

def self.optionals
  %w[
    amount
    currency
    amount_formatted
    duration
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



101
102
103
104
105
106
 
# File 'lib/univapay_client_sdk/models/card_limit.rb', line 101

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} amount: #{@amount.inspect}, currency: #{@currency.inspect},"\
  " amount_formatted: #{@amount_formatted.inspect}, duration: #{@duration.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



93
94
95
96
97
98
 
# File 'lib/univapay_client_sdk/models/card_limit.rb', line 93

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} amount: #{@amount}, currency: #{@currency}, amount_formatted:"\
  " #{@amount_formatted}, duration: #{@duration}, additional_properties:"\
  " #{@additional_properties}>"
end