Class: ThePlaidApi::TransferMetricsGetAuthorizationUsage

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/transfer_metrics_get_authorization_usage.rb

Overview

Details regarding authorization usage.

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(daily_credit_utilization: SKIP, daily_debit_utilization: SKIP, monthly_credit_utilization: SKIP, monthly_debit_utilization: SKIP, additional_properties: nil) ⇒ TransferMetricsGetAuthorizationUsage

Returns a new instance of TransferMetricsGetAuthorizationUsage.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_authorization_usage.rb', line 53

def initialize(daily_credit_utilization: SKIP,
               daily_debit_utilization: SKIP,
               monthly_credit_utilization: SKIP,
               monthly_debit_utilization: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @daily_credit_utilization = daily_credit_utilization unless daily_credit_utilization == SKIP
  @daily_debit_utilization = daily_debit_utilization unless daily_debit_utilization == SKIP
  unless monthly_credit_utilization == SKIP
    @monthly_credit_utilization =
      monthly_credit_utilization
  end
  unless monthly_debit_utilization == SKIP
    @monthly_debit_utilization =
      monthly_debit_utilization
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#daily_credit_utilization ⇒ String

The daily credit utilization formatted as a decimal.

Returns:

  • (String) 


14
15
16
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_authorization_usage.rb', line 14

def daily_credit_utilization
  @daily_credit_utilization
end

#daily_debit_utilization ⇒ String

The daily debit utilization formatted as a decimal.

Returns:

  • (String) 


18
19
20
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_authorization_usage.rb', line 18

def daily_debit_utilization
  @daily_debit_utilization
end

#monthly_credit_utilization ⇒ String

The monthly credit utilization formatted as a decimal.

Returns:

  • (String) 


22
23
24
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_authorization_usage.rb', line 22

def monthly_credit_utilization
  @monthly_credit_utilization
end

#monthly_debit_utilization ⇒ String

The monthly debit utilization formatted as a decimal.

Returns:

  • (String) 


26
27
28
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_authorization_usage.rb', line 26

def monthly_debit_utilization
  @monthly_debit_utilization
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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/the_plaid_api/models/transfer_metrics_get_authorization_usage.rb', line 74

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  daily_credit_utilization =
    hash.key?('daily_credit_utilization') ? hash['daily_credit_utilization'] : SKIP
  daily_debit_utilization =
    hash.key?('daily_debit_utilization') ? hash['daily_debit_utilization'] : SKIP
  monthly_credit_utilization =
    hash.key?('monthly_credit_utilization') ? hash['monthly_credit_utilization'] : SKIP
  monthly_debit_utilization =
    hash.key?('monthly_debit_utilization') ? hash['monthly_debit_utilization'] : 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.
  TransferMetricsGetAuthorizationUsage.new(daily_credit_utilization: daily_credit_utilization,
                                           daily_debit_utilization: daily_debit_utilization,
                                           monthly_credit_utilization: monthly_credit_utilization,
                                           monthly_debit_utilization: monthly_debit_utilization,
                                           additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



29
30
31
32
33
34
35
36
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_authorization_usage.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['daily_credit_utilization'] = 'daily_credit_utilization'
  @_hash['daily_debit_utilization'] = 'daily_debit_utilization'
  @_hash['monthly_credit_utilization'] = 'monthly_credit_utilization'
  @_hash['monthly_debit_utilization'] = 'monthly_debit_utilization'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_authorization_usage.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
45
46
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_authorization_usage.rb', line 39

def self.optionals
  %w[
    daily_credit_utilization
    daily_debit_utilization
    monthly_credit_utilization
    monthly_debit_utilization
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



112
113
114
115
116
117
118
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_authorization_usage.rb', line 112

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} daily_credit_utilization: #{@daily_credit_utilization.inspect},"\
  " daily_debit_utilization: #{@daily_debit_utilization.inspect}, monthly_credit_utilization:"\
  " #{@monthly_credit_utilization.inspect}, monthly_debit_utilization:"\
  " #{@monthly_debit_utilization.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



103
104
105
106
107
108
109
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_authorization_usage.rb', line 103

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} daily_credit_utilization: #{@daily_credit_utilization},"\
  " daily_debit_utilization: #{@daily_debit_utilization}, monthly_credit_utilization:"\
  " #{@monthly_credit_utilization}, monthly_debit_utilization: #{@monthly_debit_utilization},"\
  " additional_properties: #{@additional_properties}>"
end