Class: ThePlaidApi::ProcessorTransactionsGetRequestOptions

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

Overview

An optional object to be used with the request. If specified, ‘options` must not be `null`.

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(count: 100, offset: 0, include_original_description: false, include_personal_finance_category_beta: false, include_personal_finance_category: false, include_logo_and_counterparty_beta: false, additional_properties: nil) ⇒ ProcessorTransactionsGetRequestOptions

Returns a new instance of ProcessorTransactionsGetRequestOptions.



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
 
# File 'lib/the_plaid_api/models/processor_transactions_get_request_options.rb', line 72

def initialize(count: 100, offset: 0, include_original_description: false,
               include_personal_finance_category_beta: false,
               include_personal_finance_category: false,
               include_logo_and_counterparty_beta: false,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @count = count unless count == SKIP
  @offset = offset unless offset == SKIP
  unless include_original_description == SKIP
    @include_original_description =
      include_original_description
  end
  unless include_personal_finance_category_beta == SKIP
    @include_personal_finance_category_beta =
      include_personal_finance_category_beta
  end
  unless include_personal_finance_category == SKIP
    @include_personal_finance_category =
      include_personal_finance_category
  end
  unless include_logo_and_counterparty_beta == SKIP
    @include_logo_and_counterparty_beta =
      include_logo_and_counterparty_beta
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#count ⇒ Integer

The number of transactions to fetch.

Returns:

  • (Integer) 


15
16
17
 
# File 'lib/the_plaid_api/models/processor_transactions_get_request_options.rb', line 15

def count
  @count
end

#include_logo_and_counterparty_beta ⇒ TrueClass | FalseClass

Counterparties and extra merchant fields are now returned by default.

Returns:

  • (TrueClass | FalseClass) 


36
37
38
 
# File 'lib/the_plaid_api/models/processor_transactions_get_request_options.rb', line 36

def include_logo_and_counterparty_beta
  @include_logo_and_counterparty_beta
end

#include_original_description ⇒ TrueClass | FalseClass

Include the raw unparsed transaction description from the financial institution.

Returns:

  • (TrueClass | FalseClass) 


24
25
26
 
# File 'lib/the_plaid_api/models/processor_transactions_get_request_options.rb', line 24

def include_original_description
  @include_original_description
end

#include_personal_finance_category ⇒ TrueClass | FalseClass

Personal finance categories are now returned by default.

Returns:

  • (TrueClass | FalseClass) 


32
33
34
 
# File 'lib/the_plaid_api/models/processor_transactions_get_request_options.rb', line 32

def include_personal_finance_category
  @include_personal_finance_category
end

#include_personal_finance_category_beta ⇒ TrueClass | FalseClass

Personal finance categories are now returned by default.

Returns:

  • (TrueClass | FalseClass) 


28
29
30
 
# File 'lib/the_plaid_api/models/processor_transactions_get_request_options.rb', line 28

def include_personal_finance_category_beta
  @include_personal_finance_category_beta
end

#offset ⇒ Integer

The number of transactions to skip. The default value is 0.

Returns:

  • (Integer) 


19
20
21
 
# File 'lib/the_plaid_api/models/processor_transactions_get_request_options.rb', line 19

def offset
  @offset
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/the_plaid_api/models/processor_transactions_get_request_options.rb', line 102

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  count = hash['count'] ||= 100
  offset = hash['offset'] ||= 0
  include_original_description =
    hash['include_original_description'] ||= false
  include_personal_finance_category_beta =
    hash['include_personal_finance_category_beta'] ||= false
  include_personal_finance_category =
    hash['include_personal_finance_category'] ||= false
  include_logo_and_counterparty_beta =
    hash['include_logo_and_counterparty_beta'] ||= false

  # 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.
  ProcessorTransactionsGetRequestOptions.new(count: count,
                                             offset: offset,
                                             include_original_description: include_original_description,
                                             include_personal_finance_category_beta: include_personal_finance_category_beta,
                                             include_personal_finance_category: include_personal_finance_category,
                                             include_logo_and_counterparty_beta: include_logo_and_counterparty_beta,
                                             additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/the_plaid_api/models/processor_transactions_get_request_options.rb', line 39

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['count'] = 'count'
  @_hash['offset'] = 'offset'
  @_hash['include_original_description'] = 'include_original_description'
  @_hash['include_personal_finance_category_beta'] =
    'include_personal_finance_category_beta'
  @_hash['include_personal_finance_category'] =
    'include_personal_finance_category'
  @_hash['include_logo_and_counterparty_beta'] =
    'include_logo_and_counterparty_beta'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



66
67
68
69
70
 
# File 'lib/the_plaid_api/models/processor_transactions_get_request_options.rb', line 66

def self.nullables
  %w[
    include_original_description
  ]
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    count
    offset
    include_original_description
    include_personal_finance_category_beta
    include_personal_finance_category
    include_logo_and_counterparty_beta
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



145
146
147
148
149
150
151
152
153
154
 
# File 'lib/the_plaid_api/models/processor_transactions_get_request_options.rb', line 145

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} count: #{@count.inspect}, offset: #{@offset.inspect},"\
  " include_original_description: #{@include_original_description.inspect},"\
  ' include_personal_finance_category_beta:'\
  " #{@include_personal_finance_category_beta.inspect}, include_personal_finance_category:"\
  " #{@include_personal_finance_category.inspect}, include_logo_and_counterparty_beta:"\
  " #{@include_logo_and_counterparty_beta.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



135
136
137
138
139
140
141
142
 
# File 'lib/the_plaid_api/models/processor_transactions_get_request_options.rb', line 135

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} count: #{@count}, offset: #{@offset}, include_original_description:"\
  " #{@include_original_description}, include_personal_finance_category_beta:"\
  " #{@include_personal_finance_category_beta}, include_personal_finance_category:"\
  " #{@include_personal_finance_category}, include_logo_and_counterparty_beta:"\
  " #{@include_logo_and_counterparty_beta}, additional_properties: #{@additional_properties}>"
end