Class: ThePlaidApi::SandboxPublicTokenCreateRequestOptionsTransactions

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

Overview

An optional set of parameters corresponding to transactions options.

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(start_date: SKIP, end_date: SKIP, days_requested: 90, additional_properties: nil) ⇒ SandboxPublicTokenCreateRequestOptionsTransactions

Returns a new instance of SandboxPublicTokenCreateRequestOptionsTransactions.



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

def initialize(start_date: SKIP, end_date: SKIP, days_requested: 90,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @start_date = start_date unless start_date == SKIP
  @end_date = end_date unless end_date == SKIP
  @days_requested = days_requested unless days_requested == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#days_requested ⇒ Integer

The maximum number of days of transaction history to request for the Transactions product.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_transactions.rb', line 25

def days_requested
  @days_requested
end

#end_date ⇒ Date

The most recent date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD.

Returns:

  • (Date) 


20
21
22
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_transactions.rb', line 20

def end_date
  @end_date
end

#start_date ⇒ Date

The earliest date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD.

Returns:

  • (Date) 


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

def start_date
  @start_date
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
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_transactions.rb', line 62

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
  end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
  days_requested = hash['days_requested'] ||= 90

  # 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.
  SandboxPublicTokenCreateRequestOptionsTransactions.new(start_date: start_date,
                                                         end_date: end_date,
                                                         days_requested: days_requested,
                                                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



28
29
30
31
32
33
34
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_transactions.rb', line 28

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['start_date'] = 'start_date'
  @_hash['end_date'] = 'end_date'
  @_hash['days_requested'] = 'days_requested'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



46
47
48
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_transactions.rb', line 46

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



37
38
39
40
41
42
43
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_transactions.rb', line 37

def self.optionals
  %w[
    start_date
    end_date
    days_requested
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



92
93
94
95
96
97
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_transactions.rb', line 92

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



85
86
87
88
89
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_transactions.rb', line 85

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