lithic 0.23.1 → 0.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (158) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/models/account_activity_list_params.rb +3 -3
  5. data/lib/lithic/models/account_holder_list_params.rb +3 -3
  6. data/lib/lithic/models/account_list_params.rb +3 -3
  7. data/lib/lithic/models/account_update_params.rb +10 -7
  8. data/lib/lithic/models/auth_rules/auth_rule.rb +6 -10
  9. data/lib/lithic/models/auth_rules/auth_rule_version.rb +3 -5
  10. data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +91 -8
  11. data/lib/lithic/models/auth_rules/v2/backtest_results.rb +9 -1
  12. data/lib/lithic/models/auth_rules/v2_create_params.rb +12 -20
  13. data/lib/lithic/models/auth_rules/v2_draft_params.rb +3 -5
  14. data/lib/lithic/models/auth_rules/v2_list_results_params.rb +3 -3
  15. data/lib/lithic/models/book_transfer_list_params.rb +3 -3
  16. data/lib/lithic/models/card_bulk_order_list_params.rb +3 -3
  17. data/lib/lithic/models/card_list_params.rb +3 -3
  18. data/lib/lithic/models/cards/financial_transaction_list_params.rb +3 -3
  19. data/lib/lithic/models/dispute_list_evidences_params.rb +3 -3
  20. data/lib/lithic/models/dispute_list_params.rb +3 -3
  21. data/lib/lithic/models/event_list_attempts_params.rb +3 -3
  22. data/lib/lithic/models/event_list_params.rb +3 -3
  23. data/lib/lithic/models/events/subscription_list_attempts_params.rb +3 -3
  24. data/lib/lithic/models/events/subscription_recover_params.rb +3 -3
  25. data/lib/lithic/models/events/subscription_replay_missing_params.rb +3 -3
  26. data/lib/lithic/models/external_payment_list_params.rb +3 -3
  27. data/lib/lithic/models/financial_accounts/financial_transaction_list_params.rb +3 -3
  28. data/lib/lithic/models/financial_accounts/installment_plan.rb +33 -3
  29. data/lib/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rb +95 -15
  30. data/lib/lithic/models/financial_accounts/installment_plans/statement_list_params.rb +3 -3
  31. data/lib/lithic/models/financial_accounts/loan_tape_list_params.rb +3 -3
  32. data/lib/lithic/models/financial_accounts/statement_list_params.rb +3 -3
  33. data/lib/lithic/models/funding_event_list_params.rb +3 -3
  34. data/lib/lithic/models/hold_list_params.rb +3 -3
  35. data/lib/lithic/models/kyb.rb +2 -0
  36. data/lib/lithic/models/management_operation_create_params.rb +7 -19
  37. data/lib/lithic/models/management_operation_list_params.rb +3 -3
  38. data/lib/lithic/models/network_program_list_params.rb +3 -3
  39. data/lib/lithic/models/payment_list_params.rb +3 -3
  40. data/lib/lithic/models/reports/settlement/network_total_list_params.rb +3 -3
  41. data/lib/lithic/models/three_ds_authentication.rb +12 -1
  42. data/lib/lithic/models/three_ds_authentication_challenge_webhook_event.rb +13 -1
  43. data/lib/lithic/models/tokenization.rb +44 -1
  44. data/lib/lithic/models/tokenization_list_params.rb +3 -2
  45. data/lib/lithic/models/transaction_list_params.rb +3 -3
  46. data/lib/lithic/models/transaction_monitoring/case_list_params.rb +3 -3
  47. data/lib/lithic/resources/account_activity.rb +1 -1
  48. data/lib/lithic/resources/account_holders.rb +1 -1
  49. data/lib/lithic/resources/accounts.rb +1 -1
  50. data/lib/lithic/resources/auth_rules/v2.rb +2 -2
  51. data/lib/lithic/resources/book_transfers.rb +1 -1
  52. data/lib/lithic/resources/card_bulk_orders.rb +1 -1
  53. data/lib/lithic/resources/cards/financial_transactions.rb +1 -1
  54. data/lib/lithic/resources/cards.rb +1 -1
  55. data/lib/lithic/resources/disputes.rb +2 -2
  56. data/lib/lithic/resources/events/subscriptions.rb +7 -7
  57. data/lib/lithic/resources/events.rb +2 -2
  58. data/lib/lithic/resources/external_payments.rb +1 -1
  59. data/lib/lithic/resources/financial_accounts/financial_transactions.rb +1 -1
  60. data/lib/lithic/resources/financial_accounts/installment_plans/statements.rb +1 -1
  61. data/lib/lithic/resources/financial_accounts/loan_tapes.rb +1 -1
  62. data/lib/lithic/resources/financial_accounts/statements.rb +1 -1
  63. data/lib/lithic/resources/funding_events.rb +1 -1
  64. data/lib/lithic/resources/holds.rb +1 -1
  65. data/lib/lithic/resources/management_operations.rb +3 -3
  66. data/lib/lithic/resources/network_programs.rb +1 -1
  67. data/lib/lithic/resources/payments.rb +1 -1
  68. data/lib/lithic/resources/reports/settlement/network_totals.rb +1 -1
  69. data/lib/lithic/resources/tokenizations.rb +1 -1
  70. data/lib/lithic/resources/transaction_monitoring/cases.rb +1 -1
  71. data/lib/lithic/resources/transactions.rb +1 -1
  72. data/lib/lithic/version.rb +1 -1
  73. data/lib/lithic.rb +0 -1
  74. data/rbi/lithic/models/account_activity_list_params.rbi +4 -4
  75. data/rbi/lithic/models/account_holder_list_params.rbi +4 -4
  76. data/rbi/lithic/models/account_list_params.rbi +4 -4
  77. data/rbi/lithic/models/account_update_params.rbi +20 -14
  78. data/rbi/lithic/models/auth_rules/auth_rule.rbi +4 -8
  79. data/rbi/lithic/models/auth_rules/auth_rule_version.rbi +2 -4
  80. data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +200 -20
  81. data/rbi/lithic/models/auth_rules/v2/backtest_results.rbi +8 -0
  82. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +16 -32
  83. data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +4 -8
  84. data/rbi/lithic/models/auth_rules/v2_list_results_params.rbi +4 -4
  85. data/rbi/lithic/models/book_transfer_list_params.rbi +4 -4
  86. data/rbi/lithic/models/card_bulk_order_list_params.rbi +4 -4
  87. data/rbi/lithic/models/card_list_params.rbi +4 -4
  88. data/rbi/lithic/models/cards/financial_transaction_list_params.rbi +4 -4
  89. data/rbi/lithic/models/dispute_list_evidences_params.rbi +4 -4
  90. data/rbi/lithic/models/dispute_list_params.rbi +4 -4
  91. data/rbi/lithic/models/event_list_attempts_params.rbi +4 -4
  92. data/rbi/lithic/models/event_list_params.rbi +4 -4
  93. data/rbi/lithic/models/events/subscription_list_attempts_params.rbi +4 -4
  94. data/rbi/lithic/models/events/subscription_recover_params.rbi +4 -4
  95. data/rbi/lithic/models/events/subscription_replay_missing_params.rbi +4 -4
  96. data/rbi/lithic/models/external_payment_list_params.rbi +4 -4
  97. data/rbi/lithic/models/financial_accounts/financial_transaction_list_params.rbi +4 -4
  98. data/rbi/lithic/models/financial_accounts/installment_plan.rbi +40 -6
  99. data/rbi/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rbi +160 -24
  100. data/rbi/lithic/models/financial_accounts/installment_plans/statement_list_params.rbi +4 -4
  101. data/rbi/lithic/models/financial_accounts/loan_tape_list_params.rbi +4 -4
  102. data/rbi/lithic/models/financial_accounts/statement_list_params.rbi +4 -4
  103. data/rbi/lithic/models/funding_event_list_params.rbi +4 -4
  104. data/rbi/lithic/models/hold_list_params.rbi +4 -4
  105. data/rbi/lithic/models/kyb.rbi +4 -0
  106. data/rbi/lithic/models/management_operation_create_params.rbi +8 -82
  107. data/rbi/lithic/models/management_operation_list_params.rbi +4 -4
  108. data/rbi/lithic/models/network_program_list_params.rbi +4 -4
  109. data/rbi/lithic/models/payment_list_params.rbi +4 -4
  110. data/rbi/lithic/models/reports/settlement/network_total_list_params.rbi +4 -4
  111. data/rbi/lithic/models/three_ds_authentication.rbi +14 -0
  112. data/rbi/lithic/models/three_ds_authentication_challenge_webhook_event.rbi +10 -0
  113. data/rbi/lithic/models/tokenization.rbi +91 -3
  114. data/rbi/lithic/models/tokenization_list_params.rbi +7 -2
  115. data/rbi/lithic/models/transaction_list_params.rbi +4 -4
  116. data/rbi/lithic/models/transaction_monitoring/case_list_params.rbi +4 -4
  117. data/rbi/lithic/resources/account_activity.rbi +2 -2
  118. data/rbi/lithic/resources/account_holders.rbi +2 -2
  119. data/rbi/lithic/resources/accounts.rbi +12 -9
  120. data/rbi/lithic/resources/auth_rules/v2.rbi +3 -4
  121. data/rbi/lithic/resources/book_transfers.rbi +2 -2
  122. data/rbi/lithic/resources/card_bulk_orders.rbi +2 -2
  123. data/rbi/lithic/resources/cards/financial_transactions.rbi +2 -2
  124. data/rbi/lithic/resources/cards.rbi +2 -2
  125. data/rbi/lithic/resources/disputes.rbi +4 -4
  126. data/rbi/lithic/resources/events/subscriptions.rbi +10 -10
  127. data/rbi/lithic/resources/events.rbi +4 -4
  128. data/rbi/lithic/resources/external_payments.rbi +2 -2
  129. data/rbi/lithic/resources/financial_accounts/financial_transactions.rbi +2 -2
  130. data/rbi/lithic/resources/financial_accounts/installment_plans/statements.rbi +2 -2
  131. data/rbi/lithic/resources/financial_accounts/loan_tapes.rbi +2 -2
  132. data/rbi/lithic/resources/financial_accounts/statements.rbi +2 -2
  133. data/rbi/lithic/resources/funding_events.rbi +2 -2
  134. data/rbi/lithic/resources/holds.rbi +2 -2
  135. data/rbi/lithic/resources/management_operations.rbi +5 -3
  136. data/rbi/lithic/resources/network_programs.rbi +2 -2
  137. data/rbi/lithic/resources/payments.rbi +2 -2
  138. data/rbi/lithic/resources/reports/settlement/network_totals.rbi +2 -2
  139. data/rbi/lithic/resources/tokenizations.rbi +1 -1
  140. data/rbi/lithic/resources/transaction_monitoring/cases.rbi +2 -2
  141. data/rbi/lithic/resources/transactions.rbi +2 -2
  142. data/sig/lithic/models/auth_rules/auth_rule.rbs +0 -2
  143. data/sig/lithic/models/auth_rules/auth_rule_version.rbs +0 -1
  144. data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +64 -5
  145. data/sig/lithic/models/auth_rules/v2/backtest_results.rbs +5 -0
  146. data/sig/lithic/models/auth_rules/v2_create_params.rbs +0 -4
  147. data/sig/lithic/models/auth_rules/v2_draft_params.rbs +0 -1
  148. data/sig/lithic/models/financial_accounts/installment_plan.rbs +25 -6
  149. data/sig/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rbs +80 -21
  150. data/sig/lithic/models/management_operation_create_params.rbs +1 -33
  151. data/sig/lithic/models/three_ds_authentication.rbs +5 -0
  152. data/sig/lithic/models/three_ds_authentication_challenge_webhook_event.rbs +5 -0
  153. data/sig/lithic/models/tokenization.rbs +47 -4
  154. data/sig/lithic/models/tokenization_list_params.rbs +3 -1
  155. metadata +1 -4
  156. data/lib/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rb +0 -538
  157. data/rbi/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbi +0 -1161
  158. data/sig/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbs +0 -278
@@ -8,8 +8,8 @@ module Lithic
8
8
  include Lithic::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute begin_
11
- # Date string in RFC 3339 format. Only entries created after the specified time
12
- # will be included. UTC time zone.
11
+ # Date string in RFC 3339 format. Only entries created on or after the specified
12
+ # time will be included. UTC time zone.
13
13
  #
14
14
  # @return [Time, nil]
15
15
  optional :begin_, Time
@@ -45,7 +45,7 @@ module Lithic
45
45
  # Some parameter documentations has been truncated, see
46
46
  # {Lithic::Models::CardBulkOrderListParams} for more details.
47
47
  #
48
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
48
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
49
49
  #
50
50
  # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
51
51
  #
@@ -14,8 +14,8 @@ module Lithic
14
14
  optional :account_token, String
15
15
 
16
16
  # @!attribute begin_
17
- # Date string in RFC 3339 format. Only entries created after the specified time
18
- # will be included. UTC time zone.
17
+ # Date string in RFC 3339 format. Only entries created on or after the specified
18
+ # time will be included. UTC time zone.
19
19
  #
20
20
  # @return [Time, nil]
21
21
  optional :begin_, Time
@@ -65,7 +65,7 @@ module Lithic
65
65
  #
66
66
  # @param account_token [String] Returns cards associated with the specified account.
67
67
  #
68
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
68
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
69
69
  #
70
70
  # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
71
71
  #
@@ -14,8 +14,8 @@ module Lithic
14
14
  required :card_token, String
15
15
 
16
16
  # @!attribute begin_
17
- # Date string in RFC 3339 format. Only entries created after the specified time
18
- # will be included. UTC time zone.
17
+ # Date string in RFC 3339 format. Only entries created on or after the specified
18
+ # time will be included. UTC time zone.
19
19
  #
20
20
  # @return [Time, nil]
21
21
  optional :begin_, Time
@@ -71,7 +71,7 @@ module Lithic
71
71
  #
72
72
  # @param card_token [String]
73
73
  #
74
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
74
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
75
75
  #
76
76
  # @param category [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Category] Financial Transaction category to be returned.
77
77
  #
@@ -13,8 +13,8 @@ module Lithic
13
13
  required :dispute_token, String
14
14
 
15
15
  # @!attribute begin_
16
- # Date string in RFC 3339 format. Only entries created after the specified time
17
- # will be included. UTC time zone.
16
+ # Date string in RFC 3339 format. Only entries created on or after the specified
17
+ # time will be included. UTC time zone.
18
18
  #
19
19
  # @return [Time, nil]
20
20
  optional :begin_, Time
@@ -52,7 +52,7 @@ module Lithic
52
52
  #
53
53
  # @param dispute_token [String]
54
54
  #
55
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
55
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
56
56
  #
57
57
  # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
58
58
  #
@@ -8,8 +8,8 @@ module Lithic
8
8
  include Lithic::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute begin_
11
- # Date string in RFC 3339 format. Only entries created after the specified time
12
- # will be included. UTC time zone.
11
+ # Date string in RFC 3339 format. Only entries created on or after the specified
12
+ # time will be included. UTC time zone.
13
13
  #
14
14
  # @return [Time, nil]
15
15
  optional :begin_, Time
@@ -57,7 +57,7 @@ module Lithic
57
57
  # Some parameter documentations has been truncated, see
58
58
  # {Lithic::Models::DisputeListParams} for more details.
59
59
  #
60
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
60
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
61
61
  #
62
62
  # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
63
63
  #
@@ -13,8 +13,8 @@ module Lithic
13
13
  required :event_token, String
14
14
 
15
15
  # @!attribute begin_
16
- # Date string in RFC 3339 format. Only entries created after the specified time
17
- # will be included. UTC time zone.
16
+ # Date string in RFC 3339 format. Only entries created on or after the specified
17
+ # time will be included. UTC time zone.
18
18
  #
19
19
  # @return [Time, nil]
20
20
  optional :begin_, Time
@@ -57,7 +57,7 @@ module Lithic
57
57
  #
58
58
  # @param event_token [String]
59
59
  #
60
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
60
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
61
61
  #
62
62
  # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
63
63
  #
@@ -8,8 +8,8 @@ module Lithic
8
8
  include Lithic::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute begin_
11
- # Date string in RFC 3339 format. Only entries created after the specified time
12
- # will be included. UTC time zone.
11
+ # Date string in RFC 3339 format. Only entries created on or after the specified
12
+ # time will be included. UTC time zone.
13
13
  #
14
14
  # @return [Time, nil]
15
15
  optional :begin_, Time
@@ -57,7 +57,7 @@ module Lithic
57
57
  # Some parameter documentations has been truncated, see
58
58
  # {Lithic::Models::EventListParams} for more details.
59
59
  #
60
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
60
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
61
61
  #
62
62
  # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
63
63
  #
@@ -14,8 +14,8 @@ module Lithic
14
14
  required :event_subscription_token, String
15
15
 
16
16
  # @!attribute begin_
17
- # Date string in RFC 3339 format. Only entries created after the specified time
18
- # will be included. UTC time zone.
17
+ # Date string in RFC 3339 format. Only entries created on or after the specified
18
+ # time will be included. UTC time zone.
19
19
  #
20
20
  # @return [Time, nil]
21
21
  optional :begin_, Time
@@ -58,7 +58,7 @@ module Lithic
58
58
  #
59
59
  # @param event_subscription_token [String]
60
60
  #
61
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
61
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
62
62
  #
63
63
  # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
64
64
  #
@@ -14,8 +14,8 @@ module Lithic
14
14
  required :event_subscription_token, String
15
15
 
16
16
  # @!attribute begin_
17
- # Date string in RFC 3339 format. Only entries created after the specified time
18
- # will be included. UTC time zone.
17
+ # Date string in RFC 3339 format. Only entries created on or after the specified
18
+ # time will be included. UTC time zone.
19
19
  #
20
20
  # @return [Time, nil]
21
21
  optional :begin_, Time
@@ -33,7 +33,7 @@ module Lithic
33
33
  #
34
34
  # @param event_subscription_token [String]
35
35
  #
36
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
36
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
37
37
  #
38
38
  # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
39
39
  #
@@ -14,8 +14,8 @@ module Lithic
14
14
  required :event_subscription_token, String
15
15
 
16
16
  # @!attribute begin_
17
- # Date string in RFC 3339 format. Only entries created after the specified time
18
- # will be included. UTC time zone.
17
+ # Date string in RFC 3339 format. Only entries created on or after the specified
18
+ # time will be included. UTC time zone.
19
19
  #
20
20
  # @return [Time, nil]
21
21
  optional :begin_, Time
@@ -33,7 +33,7 @@ module Lithic
33
33
  #
34
34
  # @param event_subscription_token [String]
35
35
  #
36
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
36
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
37
37
  #
38
38
  # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
39
39
  #
@@ -8,8 +8,8 @@ module Lithic
8
8
  include Lithic::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute begin_
11
- # Date string in RFC 3339 format. Only entries created after the specified time
12
- # will be included. UTC time zone.
11
+ # Date string in RFC 3339 format. Only entries created on or after the specified
12
+ # time will be included. UTC time zone.
13
13
  #
14
14
  # @return [Time, nil]
15
15
  optional :begin_, Time
@@ -75,7 +75,7 @@ module Lithic
75
75
  # Some parameter documentations has been truncated, see
76
76
  # {Lithic::Models::ExternalPaymentListParams} for more details.
77
77
  #
78
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
78
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
79
79
  #
80
80
  # @param business_account_token [String]
81
81
  #
@@ -14,8 +14,8 @@ module Lithic
14
14
  required :financial_account_token, String
15
15
 
16
16
  # @!attribute begin_
17
- # Date string in RFC 3339 format. Only entries created after the specified time
18
- # will be included. UTC time zone.
17
+ # Date string in RFC 3339 format. Only entries created on or after the specified
18
+ # time will be included. UTC time zone.
19
19
  #
20
20
  # @return [Time, nil]
21
21
  optional :begin_, Time
@@ -72,7 +72,7 @@ module Lithic
72
72
  #
73
73
  # @param financial_account_token [String]
74
74
  #
75
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
75
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
76
76
  #
77
77
  # @param category [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Category] Financial Transaction category to be returned.
78
78
  #
@@ -35,6 +35,13 @@ module Lithic
35
35
  # @return [String]
36
36
  required :financial_account_token, String
37
37
 
38
+ # @!attribute installment_plan_adjustment
39
+ # Amount credited to this plan after the plan was recalculated. The plan amount is
40
+ # not changed, and this credit reduces the amount owed
41
+ #
42
+ # @return [Integer]
43
+ required :installment_plan_adjustment, Integer
44
+
38
45
  # @!attribute installment_plan_total
39
46
  # Total owed on the plan in cents, the principal amount plus the enrollment fee
40
47
  #
@@ -117,7 +124,7 @@ module Lithic
117
124
  # @return [Time]
118
125
  required :updated, Time
119
126
 
120
- # @!method initialize(token:, closed_at:, created:, fee_amount:, financial_account_token:, installment_plan_total:, installments:, installments_outstanding:, installments_paid:, num_installments:, principal_amount:, source_amounts:, source_id:, source_type:, start_date:, state:, total_paid:, updated:)
127
+ # @!method initialize(token:, closed_at:, created:, fee_amount:, financial_account_token:, installment_plan_adjustment:, installment_plan_total:, installments:, installments_outstanding:, installments_paid:, num_installments:, principal_amount:, source_amounts:, source_id:, source_type:, start_date:, state:, total_paid:, updated:)
121
128
  # Some parameter documentations has been truncated, see
122
129
  # {Lithic::Models::FinancialAccounts::InstallmentPlan} for more details.
123
130
  #
@@ -131,6 +138,8 @@ module Lithic
131
138
  #
132
139
  # @param financial_account_token [String] Globally unique identifier for a financial account
133
140
  #
141
+ # @param installment_plan_adjustment [Integer] Amount credited to this plan after the plan was recalculated. The plan amount is
142
+ #
134
143
  # @param installment_plan_total [Integer] Total owed on the plan in cents, the principal amount plus the enrollment fee
135
144
  #
136
145
  # @param installments [Array<Lithic::Models::FinancialAccounts::InstallmentPlan::Installment>] Installments that make up the plan, oldest first
@@ -223,7 +232,13 @@ module Lithic
223
232
  required :payments,
224
233
  -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccounts::InstallmentPlan::Installment::Payment] }
225
234
 
226
- # @!method initialize(amount_due:, amount_due_details:, amount_outstanding:, amount_outstanding_details:, amount_paid:, amount_paid_details:, date_assessed:, due_date:, installment_num:, payment_due_date:, payments:)
235
+ # @!attribute installment_adjustment
236
+ # Amount from installment_plan_adjustment credited to this installment
237
+ #
238
+ # @return [Integer, nil]
239
+ optional :installment_adjustment, Integer
240
+
241
+ # @!method initialize(amount_due:, amount_due_details:, amount_outstanding:, amount_outstanding_details:, amount_paid:, amount_paid_details:, date_assessed:, due_date:, installment_num:, payment_due_date:, payments:, installment_adjustment: nil)
227
242
  # Some parameter documentations has been truncated, see
228
243
  # {Lithic::Models::FinancialAccounts::InstallmentPlan::Installment} for more
229
244
  # details.
@@ -249,6 +264,8 @@ module Lithic
249
264
  # @param payment_due_date [Date] Date the installment must be paid by before it is considered past due
250
265
  #
251
266
  # @param payments [Array<Lithic::Models::FinancialAccounts::InstallmentPlan::Installment::Payment>] Payments applied to this installment, oldest first
267
+ #
268
+ # @param installment_adjustment [Integer] Amount from installment_plan_adjustment credited to this installment
252
269
 
253
270
  class Payment < Lithic::Internal::Type::BaseModel
254
271
  # @!attribute amount
@@ -268,12 +285,25 @@ module Lithic
268
285
  # @return [Date]
269
286
  required :date, Date
270
287
 
271
- # @!method initialize(amount:, amount_details:, date:)
288
+ # @!attribute is_adjustment
289
+ # True when the source of the payment is an adjustment of an underlying account or
290
+ # transaction
291
+ #
292
+ # @return [Boolean, nil]
293
+ optional :is_adjustment, Lithic::Internal::Type::Boolean
294
+
295
+ # @!method initialize(amount:, amount_details:, date:, is_adjustment: nil)
296
+ # Some parameter documentations has been truncated, see
297
+ # {Lithic::Models::FinancialAccounts::InstallmentPlan::Installment::Payment} for
298
+ # more details.
299
+ #
272
300
  # @param amount [Integer] Amount applied to the installment in cents
273
301
  #
274
302
  # @param amount_details [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
275
303
  #
276
304
  # @param date [Date] Date the payment was applied to the installment
305
+ #
306
+ # @param is_adjustment [Boolean] True when the source of the payment is an adjustment of an underlying account or
277
307
  end
278
308
  end
279
309
 
@@ -15,12 +15,33 @@ module Lithic
15
15
  # @return [String]
16
16
  required :token, String
17
17
 
18
+ # @!attribute closed_at
19
+ # Date the plan was paid off or cancelled, or null if it was still open as of this
20
+ # statement
21
+ #
22
+ # @return [Date, nil]
23
+ required :closed_at, Date, nil?: true
24
+
25
+ # @!attribute created
26
+ # Timestamp of when the installment plan was created
27
+ #
28
+ # @return [Time]
29
+ required :created, Time
30
+
18
31
  # @!attribute fee_amount
19
32
  # Enrollment fee charged when the plan was created in cents
20
33
  #
21
34
  # @return [Integer]
22
35
  required :fee_amount, Integer
23
36
 
37
+ # @!attribute installment_plan_adjustment
38
+ # Amount credited to this plan after the plan was recalculated, as of this
39
+ # statement. The plan amount is not changed, and this credit reduces the amount
40
+ # owed
41
+ #
42
+ # @return [Integer]
43
+ required :installment_plan_adjustment, Integer
44
+
24
45
  # @!attribute installment_plan_token
25
46
  # Globally unique identifier for the installment plan this snapshot is of
26
47
  #
@@ -64,6 +85,20 @@ module Lithic
64
85
  # @return [Integer]
65
86
  required :principal_amount, Integer
66
87
 
88
+ # @!attribute source_amounts
89
+ # Balance the plan was opened on, broken out by category, or null if it was not
90
+ # recorded
91
+ #
92
+ # @return [Lithic::Models::FinancialAccounts::TransactionCategoryBalances, nil]
93
+ required :source_amounts, -> { Lithic::FinancialAccounts::TransactionCategoryBalances }, nil?: true
94
+
95
+ # @!attribute source_id
96
+ # Identifier of the record the plan was opened from, such as the closing statement
97
+ # for an unpaid balance
98
+ #
99
+ # @return [String]
100
+ required :source_id, String
101
+
67
102
  # @!attribute source_type
68
103
  #
69
104
  # @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType]
@@ -90,7 +125,13 @@ module Lithic
90
125
  # @return [Integer]
91
126
  required :total_paid, Integer
92
127
 
93
- # @!method initialize(token:, fee_amount:, installment_plan_token:, installment_plan_total:, installments:, installments_outstanding:, installments_paid:, num_installments:, principal_amount:, source_type:, start_date:, state:, total_paid:)
128
+ # @!attribute updated
129
+ # Timestamp of when the installment plan was last updated as of this statement
130
+ #
131
+ # @return [Time]
132
+ required :updated, Time
133
+
134
+ # @!method initialize(token:, closed_at:, created:, fee_amount:, installment_plan_adjustment:, installment_plan_token:, installment_plan_total:, installments:, installments_outstanding:, installments_paid:, num_installments:, principal_amount:, source_amounts:, source_id:, source_type:, start_date:, state:, total_paid:, updated:)
94
135
  # Some parameter documentations has been truncated, see
95
136
  # {Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement}
96
137
  # for more details.
@@ -101,8 +142,14 @@ module Lithic
101
142
  #
102
143
  # @param token [String] Globally unique identifier for this snapshot, which is the token of the statemen
103
144
  #
145
+ # @param closed_at [Date, nil] Date the plan was paid off or cancelled, or null if it was still open as of this
146
+ #
147
+ # @param created [Time] Timestamp of when the installment plan was created
148
+ #
104
149
  # @param fee_amount [Integer] Enrollment fee charged when the plan was created in cents
105
150
  #
151
+ # @param installment_plan_adjustment [Integer] Amount credited to this plan after the plan was recalculated, as of this stateme
152
+ #
106
153
  # @param installment_plan_token [String] Globally unique identifier for the installment plan this snapshot is of
107
154
  #
108
155
  # @param installment_plan_total [Integer] Total owed on the plan in cents, the principal amount plus the enrollment fee
@@ -117,6 +164,10 @@ module Lithic
117
164
  #
118
165
  # @param principal_amount [Integer] Balance the plan was opened on in cents, excluding the enrollment fee
119
166
  #
167
+ # @param source_amounts [Lithic::Models::FinancialAccounts::TransactionCategoryBalances, nil] Balance the plan was opened on, broken out by category, or null if it was not re
168
+ #
169
+ # @param source_id [String] Identifier of the record the plan was opened from, such as the closing statement
170
+ #
120
171
  # @param source_type [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType]
121
172
  #
122
173
  # @param start_date [Date] Date the plan was created
@@ -124,6 +175,8 @@ module Lithic
124
175
  # @param state [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State] State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan tape
125
176
  #
126
177
  # @param total_paid [Integer] Amount paid towards the plan as of this statement in cents
178
+ #
179
+ # @param updated [Time] Timestamp of when the installment plan was last updated as of this statement
127
180
 
128
181
  class Installment < Lithic::Internal::Type::BaseModel
129
182
  # @!attribute amount_due
@@ -134,8 +187,8 @@ module Lithic
134
187
 
135
188
  # @!attribute amount_due_details
136
189
  #
137
- # @return [Lithic::Models::FinancialAccounts::CategoryBalances]
138
- required :amount_due_details, -> { Lithic::FinancialAccounts::CategoryBalances }
190
+ # @return [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
191
+ required :amount_due_details, -> { Lithic::FinancialAccounts::TransactionCategoryBalances }
139
192
 
140
193
  # @!attribute amount_outstanding
141
194
  # Amount still owed on the installment in cents
@@ -145,8 +198,8 @@ module Lithic
145
198
 
146
199
  # @!attribute amount_outstanding_details
147
200
  #
148
- # @return [Lithic::Models::FinancialAccounts::CategoryBalances]
149
- required :amount_outstanding_details, -> { Lithic::FinancialAccounts::CategoryBalances }
201
+ # @return [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
202
+ required :amount_outstanding_details, -> { Lithic::FinancialAccounts::TransactionCategoryBalances }
150
203
 
151
204
  # @!attribute amount_paid
152
205
  # Amount paid towards the installment in cents
@@ -156,8 +209,8 @@ module Lithic
156
209
 
157
210
  # @!attribute amount_paid_details
158
211
  #
159
- # @return [Lithic::Models::FinancialAccounts::CategoryBalances]
160
- required :amount_paid_details, -> { Lithic::FinancialAccounts::CategoryBalances }
212
+ # @return [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
213
+ required :amount_paid_details, -> { Lithic::FinancialAccounts::TransactionCategoryBalances }
161
214
 
162
215
  # @!attribute date_assessed
163
216
  # Date the installment was actually assessed onto the account, or null if it had
@@ -191,26 +244,31 @@ module Lithic
191
244
  required :payments,
192
245
  -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment] }
193
246
 
194
- # @!method initialize(amount_due:, amount_due_details:, amount_outstanding:, amount_outstanding_details:, amount_paid:, amount_paid_details:, date_assessed:, due_date:, installment_num:, payment_due_date:, payments:)
247
+ # @!attribute installment_adjustment
248
+ # Amount from installment_plan_adjustment credited to this installment as of this
249
+ # statement
250
+ #
251
+ # @return [Integer, nil]
252
+ optional :installment_adjustment, Integer
253
+
254
+ # @!method initialize(amount_due:, amount_due_details:, amount_outstanding:, amount_outstanding_details:, amount_paid:, amount_paid_details:, date_assessed:, due_date:, installment_num:, payment_due_date:, payments:, installment_adjustment: nil)
195
255
  # Some parameter documentations has been truncated, see
196
256
  # {Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment}
197
257
  # for more details.
198
258
  #
199
- # One installment of a plan as of the statement. Amounts are totalled across
200
- # transaction categories rather than broken out by them, which the installment
201
- # plan endpoint does
259
+ # One installment of a plan as of the statement
202
260
  #
203
261
  # @param amount_due [Integer] Amount the installment was opened for in cents
204
262
  #
205
- # @param amount_due_details [Lithic::Models::FinancialAccounts::CategoryBalances]
263
+ # @param amount_due_details [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
206
264
  #
207
265
  # @param amount_outstanding [Integer] Amount still owed on the installment in cents
208
266
  #
209
- # @param amount_outstanding_details [Lithic::Models::FinancialAccounts::CategoryBalances]
267
+ # @param amount_outstanding_details [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
210
268
  #
211
269
  # @param amount_paid [Integer] Amount paid towards the installment in cents
212
270
  #
213
- # @param amount_paid_details [Lithic::Models::FinancialAccounts::CategoryBalances]
271
+ # @param amount_paid_details [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
214
272
  #
215
273
  # @param date_assessed [Date, nil] Date the installment was actually assessed onto the account, or null if it had n
216
274
  #
@@ -221,6 +279,8 @@ module Lithic
221
279
  # @param payment_due_date [Date] Date the installment must be paid by before it is considered past due
222
280
  #
223
281
  # @param payments [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment>] Payments applied to this installment, oldest first
282
+ #
283
+ # @param installment_adjustment [Integer] Amount from installment_plan_adjustment credited to this installment as of this
224
284
 
225
285
  class Payment < Lithic::Internal::Type::BaseModel
226
286
  # @!attribute amount
@@ -229,16 +289,36 @@ module Lithic
229
289
  # @return [Integer]
230
290
  required :amount, Integer
231
291
 
292
+ # @!attribute amount_details
293
+ #
294
+ # @return [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
295
+ required :amount_details, -> { Lithic::FinancialAccounts::TransactionCategoryBalances }
296
+
232
297
  # @!attribute date
233
298
  # Date the payment was applied to the installment
234
299
  #
235
300
  # @return [Date]
236
301
  required :date, Date
237
302
 
238
- # @!method initialize(amount:, date:)
303
+ # @!attribute is_adjustment
304
+ # True when the source of the payment is an adjustment of an underlying account or
305
+ # transaction
306
+ #
307
+ # @return [Boolean, nil]
308
+ optional :is_adjustment, Lithic::Internal::Type::Boolean
309
+
310
+ # @!method initialize(amount:, amount_details:, date:, is_adjustment: nil)
311
+ # Some parameter documentations has been truncated, see
312
+ # {Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment}
313
+ # for more details.
314
+ #
239
315
  # @param amount [Integer] Amount applied to the installment in cents
240
316
  #
317
+ # @param amount_details [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
318
+ #
241
319
  # @param date [Date] Date the payment was applied to the installment
320
+ #
321
+ # @param is_adjustment [Boolean] True when the source of the payment is an adjustment of an underlying account or
242
322
  end
243
323
  end
244
324
 
@@ -22,8 +22,8 @@ module Lithic
22
22
  required :installment_plan_token, String
23
23
 
24
24
  # @!attribute begin_
25
- # Date string in RFC 3339 format. Only entries created after the specified date
26
- # will be included.
25
+ # Date string in RFC 3339 format. Only entries created on or after the specified
26
+ # date will be included.
27
27
  #
28
28
  # @return [Date, nil]
29
29
  optional :begin_, Date
@@ -72,7 +72,7 @@ module Lithic
72
72
  #
73
73
  # @param installment_plan_token [String] Globally unique identifier for installment plan.
74
74
  #
75
- # @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
75
+ # @param begin_ [Date] Date string in RFC 3339 format. Only entries created on or after the specified d
76
76
  #
77
77
  # @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w
78
78
  #
@@ -15,8 +15,8 @@ module Lithic
15
15
  required :financial_account_token, String
16
16
 
17
17
  # @!attribute begin_
18
- # Date string in RFC 3339 format. Only entries created after the specified date
19
- # will be included.
18
+ # Date string in RFC 3339 format. Only entries created on or after the specified
19
+ # date will be included.
20
20
  #
21
21
  # @return [Date, nil]
22
22
  optional :begin_, Date
@@ -54,7 +54,7 @@ module Lithic
54
54
  #
55
55
  # @param financial_account_token [String] Globally unique identifier for financial account.
56
56
  #
57
- # @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
57
+ # @param begin_ [Date] Date string in RFC 3339 format. Only entries created on or after the specified d
58
58
  #
59
59
  # @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w
60
60
  #
@@ -15,8 +15,8 @@ module Lithic
15
15
  required :financial_account_token, String
16
16
 
17
17
  # @!attribute begin_
18
- # Date string in RFC 3339 format. Only entries created after the specified date
19
- # will be included.
18
+ # Date string in RFC 3339 format. Only entries created on or after the specified
19
+ # date will be included.
20
20
  #
21
21
  # @return [Date, nil]
22
22
  optional :begin_, Date
@@ -60,7 +60,7 @@ module Lithic
60
60
  #
61
61
  # @param financial_account_token [String] Globally unique identifier for financial account.
62
62
  #
63
- # @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
63
+ # @param begin_ [Date] Date string in RFC 3339 format. Only entries created on or after the specified d
64
64
  #
65
65
  # @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w
66
66
  #
@@ -8,8 +8,8 @@ module Lithic
8
8
  include Lithic::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute begin_
11
- # Date string in RFC 3339 format. Only entries created after the specified time
12
- # will be included. UTC time zone.
11
+ # Date string in RFC 3339 format. Only entries created on or after the specified
12
+ # time will be included. UTC time zone.
13
13
  #
14
14
  # @return [Time, nil]
15
15
  optional :begin_, Time
@@ -52,7 +52,7 @@ module Lithic
52
52
  # Some parameter documentations has been truncated, see
53
53
  # {Lithic::Models::FundingEventListParams} for more details.
54
54
  #
55
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
55
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
56
56
  #
57
57
  # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
58
58
  #
@@ -13,8 +13,8 @@ module Lithic
13
13
  required :financial_account_token, String
14
14
 
15
15
  # @!attribute begin_
16
- # Date string in RFC 3339 format. Only entries created after the specified time
17
- # will be included. UTC time zone.
16
+ # Date string in RFC 3339 format. Only entries created on or after the specified
17
+ # time will be included. UTC time zone.
18
18
  #
19
19
  # @return [Time, nil]
20
20
  optional :begin_, Time
@@ -58,7 +58,7 @@ module Lithic
58
58
  #
59
59
  # @param financial_account_token [String]
60
60
  #
61
- # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
61
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created on or after the specified t
62
62
  #
63
63
  # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
64
64
  #