Class: Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/financial_accounts/statements/statement_line_items.rb

Defined Under Namespace

Modules: Category, EventType

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(token:, amount:, category:, created:, currency:, effective_date:, event_type:, financial_account_token:, financial_transaction_event_token:, financial_transaction_token:, card_token: nil, descriptor: nil) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data for more details.

Parameters:

  • token (String) —

    Globally unique identifier for a Statement Line Item

  • amount (Integer) —

    Transaction amount in cents

  • category (Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category)
  • created (Time) —

    Timestamp of when the line item was generated

  • currency (String) —

    3-character alphabetic ISO 4217 code for the settling currency of the transactio

  • effective_date (Date) —

    Date that the transaction effected the account balance

  • event_type (Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::EventType)
  • financial_account_token (String) —

    Globally unique identifier for a financial account

  • financial_transaction_event_token (String) —

    Globally unique identifier for a financial transaction event

  • financial_transaction_token (String) —

    Globally unique identifier for a financial transaction

  • card_token (String) (defaults to: nil) —

    Globally unique identifier for a card

  • descriptor (String) (defaults to: nil) 


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
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
100
101
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 23

class Data < Lithic::Internal::Type::BaseModel
  # @!attribute token
  #   Globally unique identifier for a Statement Line Item
  #
  #   @return [String]
  required :token, String

  # @!attribute amount
  #   Transaction amount in cents
  #
  #   @return [Integer]
  required :amount, Integer

  # @!attribute category
  #
  #   @return [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category]
  required :category, enum: -> { Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category }

  # @!attribute created
  #   Timestamp of when the line item was generated
  #
  #   @return [Time]
  required :created, Time

  # @!attribute currency
  #   3-character alphabetic ISO 4217 code for the settling currency of the
  #   transaction
  #
  #   @return [String]
  required :currency, String

  # @!attribute effective_date
  #   Date that the transaction effected the account balance
  #
  #   @return [Date]
  required :effective_date, Date

  # @!attribute event_type
  #
  #   @return [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::EventType]
  required :event_type,
           enum: -> { Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType }

  # @!attribute financial_account_token
  #   Globally unique identifier for a financial account
  #
  #   @return [String]
  required :financial_account_token, String

  # @!attribute financial_transaction_event_token
  #   Globally unique identifier for a financial transaction event
  #
  #   @return [String]
  required :financial_transaction_event_token, String

  # @!attribute financial_transaction_token
  #   Globally unique identifier for a financial transaction
  #
  #   @return [String]
  required :financial_transaction_token, String

  # @!attribute card_token
  #   Globally unique identifier for a card
  #
  #   @return [String, nil]
  optional :card_token, String

  # @!attribute descriptor
  #
  #   @return [String, nil]
  optional :descriptor, String

  # @!method initialize(token:, amount:, category:, created:, currency:, effective_date:, event_type:, financial_account_token:, financial_transaction_event_token:, financial_transaction_token:, card_token: nil, descriptor: nil)
  #   Some parameter documentations has been truncated, see
  #   {Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data} for
  #   more details.
  #
  #   @param token [String] Globally unique identifier for a Statement Line Item
  #
  #   @param amount [Integer] Transaction amount in cents
  #
  #   @param category [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category]
  #
  #   @param created [Time] Timestamp of when the line item was generated
  #
  #   @param currency [String] 3-character alphabetic ISO 4217 code for the settling currency of the transactio
  #
  #   @param effective_date [Date] Date that the transaction effected the account balance
  #
  #   @param event_type [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::EventType]
  #
  #   @param financial_account_token [String] Globally unique identifier for a financial account
  #
  #   @param financial_transaction_event_token [String] Globally unique identifier for a financial transaction event
  #
  #   @param financial_transaction_token [String] Globally unique identifier for a financial transaction
  #
  #   @param card_token [String] Globally unique identifier for a card
  #
  #   @param descriptor [String]

  # @see Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data#category
  module Category
    extend Lithic::Internal::Type::Enum

    ACH = :ACH
    BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
    FEE = :FEE
    REWARD = :REWARD
    ADJUSTMENT = :ADJUSTMENT
    DERECOGNITION = :DERECOGNITION
    DISPUTE = :DISPUTE
    CARD = :CARD
    EXTERNAL_ACH = :EXTERNAL_ACH
    EXTERNAL_CHECK = :EXTERNAL_CHECK
    EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
    EXTERNAL_RTP = :EXTERNAL_RTP
    EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
    EXTERNAL_WIRE = :EXTERNAL_WIRE
    MANAGEMENT_ADJUSTMENT = :MANAGEMENT_ADJUSTMENT
    MANAGEMENT_DISPUTE = :MANAGEMENT_DISPUTE
    MANAGEMENT_FEE = :MANAGEMENT_FEE
    MANAGEMENT_REWARD = :MANAGEMENT_REWARD
    MANAGEMENT_DISBURSEMENT = :MANAGEMENT_DISBURSEMENT
    PROGRAM_FUNDING = :PROGRAM_FUNDING

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data#event_type
  module EventType
    extend Lithic::Internal::Type::Enum

    ACH_ORIGINATION_CANCELLED = :ACH_ORIGINATION_CANCELLED
    ACH_ORIGINATION_INITIATED = :ACH_ORIGINATION_INITIATED
    ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED
    ACH_ORIGINATION_RELEASED = :ACH_ORIGINATION_RELEASED
    ACH_ORIGINATION_REJECTED = :ACH_ORIGINATION_REJECTED
    ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED
    ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED
    ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED
    ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED
    ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED
    ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED
    ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
    ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED
    ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED
    AUTHORIZATION = :AUTHORIZATION
    AUTHORIZATION_ADVICE = :AUTHORIZATION_ADVICE
    AUTHORIZATION_EXPIRY = :AUTHORIZATION_EXPIRY
    AUTHORIZATION_REVERSAL = :AUTHORIZATION_REVERSAL
    BALANCE_INQUIRY = :BALANCE_INQUIRY
    BILLING_ERROR = :BILLING_ERROR
    BILLING_ERROR_REVERSAL = :BILLING_ERROR_REVERSAL
    CARD_TO_CARD = :CARD_TO_CARD
    CASH_BACK = :CASH_BACK
    CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL
    CLEARING = :CLEARING
    COLLECTION = :COLLECTION
    CORRECTION_CREDIT = :CORRECTION_CREDIT
    CORRECTION_DEBIT = :CORRECTION_DEBIT
    CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION
    CREDIT_AUTHORIZATION_ADVICE = :CREDIT_AUTHORIZATION_ADVICE
    CURRENCY_CONVERSION = :CURRENCY_CONVERSION
    CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL
    DISPUTE_WON = :DISPUTE_WON
    EXTERNAL_ACH_CANCELED = :EXTERNAL_ACH_CANCELED
    EXTERNAL_ACH_INITIATED = :EXTERNAL_ACH_INITIATED
    EXTERNAL_ACH_RELEASED = :EXTERNAL_ACH_RELEASED
    EXTERNAL_ACH_REVERSED = :EXTERNAL_ACH_REVERSED
    EXTERNAL_ACH_SETTLED = :EXTERNAL_ACH_SETTLED
    EXTERNAL_CHECK_CANCELED = :EXTERNAL_CHECK_CANCELED
    EXTERNAL_CHECK_INITIATED = :EXTERNAL_CHECK_INITIATED
    EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED
    EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED
    EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED
    EXTERNAL_FEDNOW_CANCELED = :EXTERNAL_FEDNOW_CANCELED
    EXTERNAL_FEDNOW_INITIATED = :EXTERNAL_FEDNOW_INITIATED
    EXTERNAL_FEDNOW_RELEASED = :EXTERNAL_FEDNOW_RELEASED
    EXTERNAL_FEDNOW_REVERSED = :EXTERNAL_FEDNOW_REVERSED
    EXTERNAL_FEDNOW_SETTLED = :EXTERNAL_FEDNOW_SETTLED
    EXTERNAL_RTP_CANCELED = :EXTERNAL_RTP_CANCELED
    EXTERNAL_RTP_INITIATED = :EXTERNAL_RTP_INITIATED
    EXTERNAL_RTP_RELEASED = :EXTERNAL_RTP_RELEASED
    EXTERNAL_RTP_REVERSED = :EXTERNAL_RTP_REVERSED
    EXTERNAL_RTP_SETTLED = :EXTERNAL_RTP_SETTLED
    EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED
    EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED
    EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED
    EXTERNAL_TRANSFER_REVERSED = :EXTERNAL_TRANSFER_REVERSED
    EXTERNAL_TRANSFER_SETTLED = :EXTERNAL_TRANSFER_SETTLED
    EXTERNAL_WIRE_CANCELED = :EXTERNAL_WIRE_CANCELED
    EXTERNAL_WIRE_INITIATED = :EXTERNAL_WIRE_INITIATED
    EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED
    EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED
    EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED
    FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION
    FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION
    INTEREST = :INTEREST
    INTEREST_REVERSAL = :INTEREST_REVERSAL
    INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
    LATE_PAYMENT = :LATE_PAYMENT
    LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
    LOSS_WRITE_OFF = :LOSS_WRITE_OFF
    PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT
    PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL
    SERVICE = :SERVICE
    RETURN = :RETURN
    RETURN_REVERSAL = :RETURN_REVERSAL
    TRANSFER = :TRANSFER
    TRANSFER_INSUFFICIENT_FUNDS = :TRANSFER_INSUFFICIENT_FUNDS
    RETURNED_PAYMENT = :RETURNED_PAYMENT
    RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL
    LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT
    ANNUAL = :ANNUAL
    ANNUAL_REVERSAL = :ANNUAL_REVERSAL
    QUARTERLY = :QUARTERLY
    QUARTERLY_REVERSAL = :QUARTERLY_REVERSAL
    MONTHLY = :MONTHLY
    MONTHLY_REVERSAL = :MONTHLY_REVERSAL

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#amount ⇒ Integer

Transaction amount in cents

Returns:

  • (Integer) 


34
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 34

required :amount, Integer

#card_token ⇒ String?

Globally unique identifier for a card

Returns:

  • (String, nil) 


88
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 88

optional :card_token, String

#category ⇒ Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category

Returns:



39
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 39

required :category, enum: -> { Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category }

#created ⇒ Time

Timestamp of when the line item was generated

Returns:

  • (Time) 


45
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 45

required :created, Time

#currency ⇒ String

3-character alphabetic ISO 4217 code for the settling currency of the transaction

Returns:

  • (String) 


52
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 52

required :currency, String

#descriptor ⇒ String?

Returns:

  • (String, nil) 


93
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 93

optional :descriptor, String

#effective_date ⇒ Date

Date that the transaction effected the account balance

Returns:

  • (Date) 


58
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 58

required :effective_date, Date

#event_type ⇒ Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::EventType

Returns:



63
64
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 63

required :event_type,
enum: -> { Lithic::FinancialAccounts::Statements::StatementLineItems::Data::EventType }

#financial_account_token ⇒ String

Globally unique identifier for a financial account

Returns:

  • (String) 


70
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 70

required :financial_account_token, String

#financial_transaction_event_token ⇒ String

Globally unique identifier for a financial transaction event

Returns:

  • (String) 


76
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 76

required :financial_transaction_event_token, String

#financial_transaction_token ⇒ String

Globally unique identifier for a financial transaction

Returns:

  • (String) 


82
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 82

required :financial_transaction_token, String

#token ⇒ String

Globally unique identifier for a Statement Line Item

Returns:

  • (String) 


28
 
# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 28

required :token, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/financial_accounts/statements/statement_line_items.rb', line 149