Class: ThePlaidApi::TransferMetricsGetReturnRatesOverInterval

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

Overview

Details regarding return rates.

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(overall_return_rate: SKIP, unauthorized_return_rate: SKIP, administrative_return_rate: SKIP, additional_properties: nil) ⇒ TransferMetricsGetReturnRatesOverInterval

Returns a new instance of TransferMetricsGetReturnRatesOverInterval.



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_return_rates_over_interval.rb', line 47

def initialize(overall_return_rate: SKIP, unauthorized_return_rate: SKIP,
               administrative_return_rate: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @overall_return_rate = overall_return_rate unless overall_return_rate == SKIP
  @unauthorized_return_rate = unauthorized_return_rate unless unauthorized_return_rate == SKIP
  unless administrative_return_rate == SKIP
    @administrative_return_rate =
      administrative_return_rate
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#administrative_return_rate ⇒ String

The administrative return rate.

Returns:

  • (String) 


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

def administrative_return_rate
  @administrative_return_rate
end

#overall_return_rate ⇒ String

The overall return rate.

Returns:

  • (String) 


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

def overall_return_rate
  @overall_return_rate
end

#unauthorized_return_rate ⇒ String

The unauthorized return rate.

Returns:

  • (String) 


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

def unauthorized_return_rate
  @unauthorized_return_rate
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_return_rates_over_interval.rb', line 62

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  overall_return_rate =
    hash.key?('overall_return_rate') ? hash['overall_return_rate'] : SKIP
  unauthorized_return_rate =
    hash.key?('unauthorized_return_rate') ? hash['unauthorized_return_rate'] : SKIP
  administrative_return_rate =
    hash.key?('administrative_return_rate') ? hash['administrative_return_rate'] : 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.
  TransferMetricsGetReturnRatesOverInterval.new(overall_return_rate: overall_return_rate,
                                                unauthorized_return_rate: unauthorized_return_rate,
                                                administrative_return_rate: administrative_return_rate,
                                                additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_return_rates_over_interval.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['overall_return_rate'] = 'overall_return_rate'
  @_hash['unauthorized_return_rate'] = 'unauthorized_return_rate'
  @_hash['administrative_return_rate'] = 'administrative_return_rate'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_return_rates_over_interval.rb', line 43

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
39
40
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_return_rates_over_interval.rb', line 34

def self.optionals
  %w[
    overall_return_rate
    unauthorized_return_rate
    administrative_return_rate
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



96
97
98
99
100
101
102
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_return_rates_over_interval.rb', line 96

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} overall_return_rate: #{@overall_return_rate.inspect},"\
  " unauthorized_return_rate: #{@unauthorized_return_rate.inspect},"\
  " administrative_return_rate: #{@administrative_return_rate.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



88
89
90
91
92
93
 
# File 'lib/the_plaid_api/models/transfer_metrics_get_return_rates_over_interval.rb', line 88

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} overall_return_rate: #{@overall_return_rate}, unauthorized_return_rate:"\
  " #{@unauthorized_return_rate}, administrative_return_rate: #{@administrative_return_rate},"\
  " additional_properties: #{@additional_properties}>"
end