lithic 0.1.0.pre.alpha.40 → 0.1.0.pre.alpha.41

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 (127) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/client.rb +4 -0
  5. data/lib/lithic/internal/transport/base_client.rb +1 -1
  6. data/lib/lithic/internal/transport/pooled_net_requester.rb +1 -9
  7. data/lib/lithic/internal/type/array_of.rb +1 -0
  8. data/lib/lithic/internal/type/base_model.rb +3 -1
  9. data/lib/lithic/internal/type/converter.rb +27 -0
  10. data/lib/lithic/internal/type/hash_of.rb +1 -0
  11. data/lib/lithic/internal/type/union.rb +9 -7
  12. data/lib/lithic/internal/util.rb +1 -1
  13. data/lib/lithic/models/account_activity_list_params.rb +156 -0
  14. data/lib/lithic/models/account_activity_list_response.rb +1435 -0
  15. data/lib/lithic/models/account_activity_retrieve_transaction_params.rb +14 -0
  16. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +1451 -0
  17. data/lib/lithic/models/account_holder.rb +16 -19
  18. data/lib/lithic/models/account_holder_create_params.rb +41 -47
  19. data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb +1 -3
  20. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +25 -20
  21. data/lib/lithic/models/account_holder_update_params.rb +2 -6
  22. data/lib/lithic/models/account_holder_update_response.rb +25 -20
  23. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +5 -1
  24. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +8 -12
  25. data/lib/lithic/models/auth_rules/v2_list_params.rb +1 -0
  26. data/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rb +4 -16
  27. data/lib/lithic/models/book_transfer_create_params.rb +34 -6
  28. data/lib/lithic/models/book_transfer_response.rb +124 -28
  29. data/lib/lithic/models/document.rb +1 -3
  30. data/lib/lithic/models/events/subscription_create_params.rb +1 -3
  31. data/lib/lithic/models/events/subscription_update_params.rb +1 -3
  32. data/lib/lithic/models/external_bank_account_list_params.rb +2 -6
  33. data/lib/lithic/models/external_payment.rb +89 -48
  34. data/lib/lithic/models/financial_account.rb +1 -0
  35. data/lib/lithic/models/financial_accounts/loan_tape.rb +5 -18
  36. data/lib/lithic/models/financial_accounts/statement.rb +3 -10
  37. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +2 -7
  38. data/lib/lithic/models/financial_transaction.rb +2 -0
  39. data/lib/lithic/models/instance_financial_account_type.rb +1 -0
  40. data/lib/lithic/models/kyb.rb +2 -2
  41. data/lib/lithic/models/management_operation_transaction.rb +90 -63
  42. data/lib/lithic/models/payment.rb +60 -1
  43. data/lib/lithic/models/reports/settlement_list_details_params.rb +2 -2
  44. data/lib/lithic/models/settlement_detail.rb +1 -0
  45. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +145 -12
  46. data/lib/lithic/models/three_ds/authentication_simulate_params.rb +1 -4
  47. data/lib/lithic/models/tokenization.rb +1 -1
  48. data/lib/lithic/models/transactions/events/enhanced_data.rb +3 -11
  49. data/lib/lithic/models/transfer.rb +2 -0
  50. data/lib/lithic/models/wire_party_details.rb +40 -0
  51. data/lib/lithic/models.rb +6 -0
  52. data/lib/lithic/resources/account_activity.rb +80 -0
  53. data/lib/lithic/resources/account_holders.rb +9 -9
  54. data/lib/lithic/resources/book_transfers.rb +7 -3
  55. data/lib/lithic/resources/reports/settlement.rb +1 -1
  56. data/lib/lithic/resources/tokenizations.rb +2 -2
  57. data/lib/lithic/version.rb +1 -1
  58. data/lib/lithic.rb +7 -2
  59. data/rbi/lithic/client.rbi +3 -0
  60. data/rbi/lithic/errors.rbi +2 -2
  61. data/rbi/lithic/internal/transport/base_client.rbi +1 -1
  62. data/rbi/lithic/internal/type/converter.rbi +46 -0
  63. data/rbi/lithic/internal/type/union.rbi +7 -2
  64. data/rbi/lithic/models/account_activity_list_params.rbi +359 -0
  65. data/rbi/lithic/models/account_activity_list_response.rbi +3367 -0
  66. data/rbi/lithic/models/account_activity_retrieve_transaction_params.rbi +30 -0
  67. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +3369 -0
  68. data/rbi/lithic/models/account_holder.rbi +21 -23
  69. data/rbi/lithic/models/account_holder_create_params.rbi +87 -65
  70. data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +36 -30
  71. data/rbi/lithic/models/account_holder_update_response.rbi +36 -30
  72. data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +20 -0
  73. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +20 -0
  74. data/rbi/lithic/models/auth_rules/v2_list_params.rbi +2 -0
  75. data/rbi/lithic/models/book_transfer_create_params.rbi +75 -5
  76. data/rbi/lithic/models/book_transfer_response.rbi +320 -38
  77. data/rbi/lithic/models/external_payment.rbi +147 -60
  78. data/rbi/lithic/models/financial_account.rbi +5 -0
  79. data/rbi/lithic/models/financial_transaction.rbi +1 -0
  80. data/rbi/lithic/models/instance_financial_account_type.rbi +5 -0
  81. data/rbi/lithic/models/kyb.rbi +2 -2
  82. data/rbi/lithic/models/management_operation_transaction.rbi +226 -95
  83. data/rbi/lithic/models/payment.rbi +103 -3
  84. data/rbi/lithic/models/reports/settlement_list_details_params.rbi +2 -2
  85. data/rbi/lithic/models/settlement_detail.rbi +2 -0
  86. data/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi +222 -19
  87. data/rbi/lithic/models/transfer.rbi +1 -0
  88. data/rbi/lithic/models/wire_party_details.rbi +61 -0
  89. data/rbi/lithic/models.rbi +7 -0
  90. data/rbi/lithic/resources/account_activity.rbi +80 -0
  91. data/rbi/lithic/resources/account_holders.rbi +28 -29
  92. data/rbi/lithic/resources/book_transfers.rbi +9 -2
  93. data/rbi/lithic/resources/reports/settlement.rbi +1 -1
  94. data/rbi/lithic/resources/tokenizations.rbi +1 -1
  95. data/sig/lithic/client.rbs +2 -0
  96. data/sig/lithic/internal/transport/base_client.rbs +1 -1
  97. data/sig/lithic/internal/type/converter.rbs +17 -0
  98. data/sig/lithic/internal/type/union.rbs +2 -2
  99. data/sig/lithic/models/account_activity_list_params.rbs +173 -0
  100. data/sig/lithic/models/account_activity_list_response.rbs +1353 -0
  101. data/sig/lithic/models/account_activity_retrieve_transaction_params.rbs +15 -0
  102. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +1353 -0
  103. data/sig/lithic/models/account_holder_create_params.rbs +33 -19
  104. data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +10 -3
  105. data/sig/lithic/models/account_holder_update_response.rbs +10 -3
  106. data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +8 -0
  107. data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +8 -0
  108. data/sig/lithic/models/auth_rules/v2_list_params.rbs +2 -1
  109. data/sig/lithic/models/book_transfer_create_params.rbs +30 -1
  110. data/sig/lithic/models/book_transfer_response.rbs +134 -15
  111. data/sig/lithic/models/external_payment.rbs +91 -40
  112. data/sig/lithic/models/financial_account.rbs +2 -0
  113. data/sig/lithic/models/instance_financial_account_type.rbs +2 -0
  114. data/sig/lithic/models/management_operation_transaction.rbs +95 -44
  115. data/sig/lithic/models/payment.rbs +61 -3
  116. data/sig/lithic/models/settlement_detail.rbs +2 -0
  117. data/sig/lithic/models/three_ds/authentication_retrieve_response.rbs +90 -3
  118. data/sig/lithic/models/wire_party_details.rbs +35 -0
  119. data/sig/lithic/models.rbs +6 -0
  120. data/sig/lithic/resources/account_activity.rbs +27 -0
  121. data/sig/lithic/resources/account_holders.rbs +3 -3
  122. data/sig/lithic/resources/book_transfers.rbs +2 -0
  123. data/sig/lithic/resources/tokenizations.rbs +1 -1
  124. metadata +20 -5
  125. data/lib/lithic/models/tokenization_retrieve_response.rb +0 -16
  126. data/rbi/lithic/models/tokenization_retrieve_response.rbi +0 -31
  127. data/sig/lithic/models/tokenization_retrieve_response.rbs +0 -15
@@ -92,10 +92,7 @@ module Lithic
92
92
  # @!attribute type
93
93
  #
94
94
  # @return [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowDay::Type, nil]
95
- optional :type,
96
- enum: -> {
97
- Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowDay::Type
98
- }
95
+ optional :type, enum: -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowDay::Type }
99
96
 
100
97
  # @!method initialize(type: nil)
101
98
  # Velocity over the current day since 00:00 / 12 AM in Eastern Time
@@ -124,10 +121,7 @@ module Lithic
124
121
  # @!attribute type
125
122
  #
126
123
  # @return [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowWeek::Type, nil]
127
- optional :type,
128
- enum: -> {
129
- Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowWeek::Type
130
- }
124
+ optional :type, enum: -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowWeek::Type }
131
125
 
132
126
  # @!method initialize(day_of_week: nil, type: nil)
133
127
  # Some parameter documentations has been truncated, see
@@ -164,10 +158,7 @@ module Lithic
164
158
  # @!attribute type
165
159
  #
166
160
  # @return [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowMonth::Type, nil]
167
- optional :type,
168
- enum: -> {
169
- Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowMonth::Type
170
- }
161
+ optional :type, enum: -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowMonth::Type }
171
162
 
172
163
  # @!method initialize(day_of_month: nil, type: nil)
173
164
  # Some parameter documentations has been truncated, see
@@ -210,10 +201,7 @@ module Lithic
210
201
  # @!attribute type
211
202
  #
212
203
  # @return [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowYear::Type, nil]
213
- optional :type,
214
- enum: -> {
215
- Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowYear::Type
216
- }
204
+ optional :type, enum: -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowYear::Type }
217
205
 
218
206
  # @!method initialize(day_of_month: nil, month: nil, type: nil)
219
207
  # Some parameter documentations has been truncated, see
@@ -8,7 +8,7 @@ module Lithic
8
8
  include Lithic::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute amount
11
- # Amount to be transferred in the currencys smallest unit (e.g., cents for USD).
11
+ # Amount to be transferred in the currency's smallest unit (e.g., cents for USD).
12
12
  # This should always be a positive value.
13
13
  #
14
14
  # @return [Integer]
@@ -41,7 +41,7 @@ module Lithic
41
41
  required :to_financial_account_token, String
42
42
 
43
43
  # @!attribute type
44
- # Type of book_transfer
44
+ # Type of the book transfer
45
45
  #
46
46
  # @return [Symbol, Lithic::Models::BookTransferCreateParams::Type]
47
47
  required :type, enum: -> { Lithic::BookTransferCreateParams::Type }
@@ -53,17 +53,29 @@ module Lithic
53
53
  # @return [String, nil]
54
54
  optional :token, String
55
55
 
56
+ # @!attribute external_id
57
+ # External ID defined by the customer
58
+ #
59
+ # @return [String, nil]
60
+ optional :external_id, String
61
+
56
62
  # @!attribute memo
57
63
  # Optional descriptor for the transfer.
58
64
  #
59
65
  # @return [String, nil]
60
66
  optional :memo, String
61
67
 
62
- # @!method initialize(amount:, category:, from_financial_account_token:, subtype:, to_financial_account_token:, type:, token: nil, memo: nil, request_options: {})
68
+ # @!attribute on_closed_account
69
+ # What to do if the financial account is closed when posting an operation
70
+ #
71
+ # @return [Symbol, Lithic::Models::BookTransferCreateParams::OnClosedAccount, nil]
72
+ optional :on_closed_account, enum: -> { Lithic::BookTransferCreateParams::OnClosedAccount }
73
+
74
+ # @!method initialize(amount:, category:, from_financial_account_token:, subtype:, to_financial_account_token:, type:, token: nil, external_id: nil, memo: nil, on_closed_account: nil, request_options: {})
63
75
  # Some parameter documentations has been truncated, see
64
76
  # {Lithic::Models::BookTransferCreateParams} for more details.
65
77
  #
66
- # @param amount [Integer] Amount to be transferred in the currencys smallest unit (e.g., cents for USD).
78
+ # @param amount [Integer] Amount to be transferred in the currency's smallest unit (e.g., cents for USD).
67
79
  #
68
80
  # @param category [Symbol, Lithic::Models::BookTransferCreateParams::Category] Category of the book transfer
69
81
  #
@@ -73,12 +85,16 @@ module Lithic
73
85
  #
74
86
  # @param to_financial_account_token [String] Globally unique identifier for the financial account or card that will receive t
75
87
  #
76
- # @param type [Symbol, Lithic::Models::BookTransferCreateParams::Type] Type of book_transfer
88
+ # @param type [Symbol, Lithic::Models::BookTransferCreateParams::Type] Type of the book transfer
77
89
  #
78
90
  # @param token [String] Customer-provided token that will serve as an idempotency token. This token will
79
91
  #
92
+ # @param external_id [String] External ID defined by the customer
93
+ #
80
94
  # @param memo [String] Optional descriptor for the transfer.
81
95
  #
96
+ # @param on_closed_account [Symbol, Lithic::Models::BookTransferCreateParams::OnClosedAccount] What to do if the financial account is closed when posting an operation
97
+ #
82
98
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
83
99
 
84
100
  # Category of the book transfer
@@ -97,7 +113,7 @@ module Lithic
97
113
  # @return [Array<Symbol>]
98
114
  end
99
115
 
100
- # Type of book_transfer
116
+ # Type of the book transfer
101
117
  module Type
102
118
  extend Lithic::Internal::Type::Enum
103
119
 
@@ -134,6 +150,18 @@ module Lithic
134
150
  DISPUTE_WON = :DISPUTE_WON
135
151
  SERVICE = :SERVICE
136
152
  TRANSFER = :TRANSFER
153
+ COLLECTION = :COLLECTION
154
+
155
+ # @!method self.values
156
+ # @return [Array<Symbol>]
157
+ end
158
+
159
+ # What to do if the financial account is closed when posting an operation
160
+ module OnClosedAccount
161
+ extend Lithic::Internal::Type::Enum
162
+
163
+ FAIL = :FAIL
164
+ USE_SUSPENSE = :USE_SUSPENSE
137
165
 
138
166
  # @!method self.values
139
167
  # @return [Array<Symbol>]
@@ -36,6 +36,18 @@ module Lithic
36
36
  # @return [Array<Lithic::Models::BookTransferResponse::Event>]
37
37
  required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::BookTransferResponse::Event] }
38
38
 
39
+ # @!attribute external_id
40
+ # External ID defined by the customer
41
+ #
42
+ # @return [String, nil]
43
+ required :external_id, String, nil?: true
44
+
45
+ # @!attribute external_resource
46
+ # External resource associated with the management operation
47
+ #
48
+ # @return [Lithic::Models::ExternalResource, nil]
49
+ required :external_resource, -> { Lithic::ExternalResource }, nil?: true
50
+
39
51
  # @!attribute from_financial_account_token
40
52
  # Globally unique identifier for the financial account or card that will send the
41
53
  # funds. Accepted type dependent on the program's use case.
@@ -45,15 +57,15 @@ module Lithic
45
57
 
46
58
  # @!attribute pending_amount
47
59
  # Pending amount of the transaction in the currency's smallest unit (e.g., cents),
48
- # including any acquirer fees. The value of this field will go to zero over time
49
- # once the financial transaction is settled.
60
+ # including any acquirer fees.
61
+ #
62
+ # The value of this field will go to zero over time once the financial transaction
63
+ # is settled.
50
64
  #
51
65
  # @return [Integer]
52
66
  required :pending_amount, Integer
53
67
 
54
68
  # @!attribute result
55
- # APPROVED transactions were successful while DECLINED transactions were declined
56
- # by user, Lithic, or the network.
57
69
  #
58
70
  # @return [Symbol, Lithic::Models::BookTransferResponse::Result]
59
71
  required :result, enum: -> { Lithic::BookTransferResponse::Result }
@@ -66,8 +78,11 @@ module Lithic
66
78
  required :settled_amount, Integer
67
79
 
68
80
  # @!attribute status
69
- # Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The
70
- # transfer was reversed \* `SETTLED` - The transfer is completed.
81
+ # Status types:
82
+ #
83
+ # - `DECLINED` - The transfer was declined.
84
+ # - `REVERSED` - The transfer was reversed
85
+ # - `SETTLED` - The transfer is completed.
71
86
  #
72
87
  # @return [Symbol, Lithic::Models::BookTransferResponse::Status]
73
88
  required :status, enum: -> { Lithic::BookTransferResponse::Status }
@@ -76,8 +91,14 @@ module Lithic
76
91
  # Globally unique identifier for the financial account or card that will receive
77
92
  # the funds. Accepted type dependent on the program's use case.
78
93
  #
79
- # @return [Object]
80
- required :to_financial_account_token, Lithic::Internal::Type::Unknown
94
+ # @return [String]
95
+ required :to_financial_account_token, String
96
+
97
+ # @!attribute transaction_series
98
+ # A series of transactions that are grouped together.
99
+ #
100
+ # @return [Lithic::Models::BookTransferResponse::TransactionSeries, nil]
101
+ required :transaction_series, -> { Lithic::BookTransferResponse::TransactionSeries }, nil?: true
81
102
 
82
103
  # @!attribute updated
83
104
  # Date and time when the financial transaction was last updated. UTC time zone.
@@ -85,7 +106,7 @@ module Lithic
85
106
  # @return [Time]
86
107
  required :updated, Time
87
108
 
88
- # @!method initialize(token:, category:, created:, currency:, events:, from_financial_account_token:, pending_amount:, result:, settled_amount:, status:, to_financial_account_token:, updated:)
109
+ # @!method initialize(token:, category:, created:, currency:, events:, external_id:, external_resource:, from_financial_account_token:, pending_amount:, result:, settled_amount:, status:, to_financial_account_token:, transaction_series:, updated:)
89
110
  # Some parameter documentations has been truncated, see
90
111
  # {Lithic::Models::BookTransferResponse} for more details.
91
112
  #
@@ -99,17 +120,23 @@ module Lithic
99
120
  #
100
121
  # @param events [Array<Lithic::Models::BookTransferResponse::Event>] A list of all financial events that have modified this transfer.
101
122
  #
123
+ # @param external_id [String, nil] External ID defined by the customer
124
+ #
125
+ # @param external_resource [Lithic::Models::ExternalResource, nil] External resource associated with the management operation
126
+ #
102
127
  # @param from_financial_account_token [String] Globally unique identifier for the financial account or card that will send the
103
128
  #
104
129
  # @param pending_amount [Integer] Pending amount of the transaction in the currency's smallest unit (e.g., cents),
105
130
  #
106
- # @param result [Symbol, Lithic::Models::BookTransferResponse::Result] APPROVED transactions were successful while DECLINED transactions were declined
131
+ # @param result [Symbol, Lithic::Models::BookTransferResponse::Result]
107
132
  #
108
133
  # @param settled_amount [Integer] Amount of the transaction that has been settled in the currency's smallest unit
109
134
  #
110
- # @param status [Symbol, Lithic::Models::BookTransferResponse::Status] Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The trans
135
+ # @param status [Symbol, Lithic::Models::BookTransferResponse::Status] Status types:
136
+ #
137
+ # @param to_financial_account_token [String] Globally unique identifier for the financial account or card that will receive t
111
138
  #
112
- # @param to_financial_account_token [Object] Globally unique identifier for the financial account or card that will receive t
139
+ # @param transaction_series [Lithic::Models::BookTransferResponse::TransactionSeries, nil] A series of transactions that are grouped together.
113
140
  #
114
141
  # @param updated [Time] Date and time when the financial transaction was last updated. UTC time zone.
115
142
 
@@ -152,13 +179,9 @@ module Lithic
152
179
  required :created, Time
153
180
 
154
181
  # @!attribute detailed_results
155
- # Detailed Results
156
182
  #
157
- # @return [Array<Symbol, Lithic::Models::BookTransferResponse::Event::DetailedResult>]
158
- required :detailed_results,
159
- -> {
160
- Lithic::Internal::Type::ArrayOf[enum: Lithic::BookTransferResponse::Event::DetailedResult]
161
- }
183
+ # @return [Symbol, Lithic::Models::BookTransferResponse::Event::DetailedResults]
184
+ required :detailed_results, enum: -> { Lithic::BookTransferResponse::Event::DetailedResults }
162
185
 
163
186
  # @!attribute memo
164
187
  # Memo for the transfer.
@@ -182,20 +205,22 @@ module Lithic
182
205
  # @!attribute type
183
206
  # Type of the book transfer
184
207
  #
185
- # @return [String]
186
- required :type, String
208
+ # @return [Symbol, Lithic::Models::BookTransferResponse::Event::Type]
209
+ required :type, enum: -> { Lithic::BookTransferResponse::Event::Type }
187
210
 
188
211
  # @!method initialize(token:, amount:, created:, detailed_results:, memo:, result:, subtype:, type:)
189
212
  # Some parameter documentations has been truncated, see
190
213
  # {Lithic::Models::BookTransferResponse::Event} for more details.
191
214
  #
215
+ # Book transfer Event
216
+ #
192
217
  # @param token [String] Globally unique identifier.
193
218
  #
194
219
  # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u
195
220
  #
196
221
  # @param created [Time] Date and time when the financial event occurred. UTC time zone.
197
222
  #
198
- # @param detailed_results [Array<Symbol, Lithic::Models::BookTransferResponse::Event::DetailedResult>] Detailed Results
223
+ # @param detailed_results [Symbol, Lithic::Models::BookTransferResponse::Event::DetailedResults]
199
224
  #
200
225
  # @param memo [String] Memo for the transfer.
201
226
  #
@@ -203,9 +228,10 @@ module Lithic
203
228
  #
204
229
  # @param subtype [String] The program specific subtype code for the specified category/type.
205
230
  #
206
- # @param type [String] Type of the book transfer
231
+ # @param type [Symbol, Lithic::Models::BookTransferResponse::Event::Type] Type of the book transfer
207
232
 
208
- module DetailedResult
233
+ # @see Lithic::Models::BookTransferResponse::Event#detailed_results
234
+ module DetailedResults
209
235
  extend Lithic::Internal::Type::Enum
210
236
 
211
237
  APPROVED = :APPROVED
@@ -228,11 +254,53 @@ module Lithic
228
254
  # @!method self.values
229
255
  # @return [Array<Symbol>]
230
256
  end
257
+
258
+ # Type of the book transfer
259
+ #
260
+ # @see Lithic::Models::BookTransferResponse::Event#type
261
+ module Type
262
+ extend Lithic::Internal::Type::Enum
263
+
264
+ ATM_WITHDRAWAL = :ATM_WITHDRAWAL
265
+ ATM_DECLINE = :ATM_DECLINE
266
+ INTERNATIONAL_ATM_WITHDRAWAL = :INTERNATIONAL_ATM_WITHDRAWAL
267
+ INACTIVITY = :INACTIVITY
268
+ STATEMENT = :STATEMENT
269
+ MONTHLY = :MONTHLY
270
+ QUARTERLY = :QUARTERLY
271
+ ANNUAL = :ANNUAL
272
+ CUSTOMER_SERVICE = :CUSTOMER_SERVICE
273
+ ACCOUNT_MAINTENANCE = :ACCOUNT_MAINTENANCE
274
+ ACCOUNT_ACTIVATION = :ACCOUNT_ACTIVATION
275
+ ACCOUNT_CLOSURE = :ACCOUNT_CLOSURE
276
+ CARD_REPLACEMENT = :CARD_REPLACEMENT
277
+ CARD_DELIVERY = :CARD_DELIVERY
278
+ CARD_CREATE = :CARD_CREATE
279
+ CURRENCY_CONVERSION = :CURRENCY_CONVERSION
280
+ INTEREST = :INTEREST
281
+ LATE_PAYMENT = :LATE_PAYMENT
282
+ BILL_PAYMENT = :BILL_PAYMENT
283
+ CASH_BACK = :CASH_BACK
284
+ ACCOUNT_TO_ACCOUNT = :ACCOUNT_TO_ACCOUNT
285
+ CARD_TO_CARD = :CARD_TO_CARD
286
+ DISBURSE = :DISBURSE
287
+ BILLING_ERROR = :BILLING_ERROR
288
+ LOSS_WRITE_OFF = :LOSS_WRITE_OFF
289
+ EXPIRED_CARD = :EXPIRED_CARD
290
+ EARLY_DERECOGNITION = :EARLY_DERECOGNITION
291
+ ESCHEATMENT = :ESCHEATMENT
292
+ INACTIVITY_FEE_DOWN = :INACTIVITY_FEE_DOWN
293
+ PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT
294
+ DISPUTE_WON = :DISPUTE_WON
295
+ SERVICE = :SERVICE
296
+ TRANSFER = :TRANSFER
297
+ COLLECTION = :COLLECTION
298
+
299
+ # @!method self.values
300
+ # @return [Array<Symbol>]
301
+ end
231
302
  end
232
303
 
233
- # APPROVED transactions were successful while DECLINED transactions were declined
234
- # by user, Lithic, or the network.
235
- #
236
304
  # @see Lithic::Models::BookTransferResponse#result
237
305
  module Result
238
306
  extend Lithic::Internal::Type::Enum
@@ -244,8 +312,11 @@ module Lithic
244
312
  # @return [Array<Symbol>]
245
313
  end
246
314
 
247
- # Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The
248
- # transfer was reversed \* `SETTLED` - The transfer is completed.
315
+ # Status types:
316
+ #
317
+ # - `DECLINED` - The transfer was declined.
318
+ # - `REVERSED` - The transfer was reversed
319
+ # - `SETTLED` - The transfer is completed.
249
320
  #
250
321
  # @see Lithic::Models::BookTransferResponse#status
251
322
  module Status
@@ -258,6 +329,31 @@ module Lithic
258
329
  # @!method self.values
259
330
  # @return [Array<Symbol>]
260
331
  end
332
+
333
+ # @see Lithic::Models::BookTransferResponse#transaction_series
334
+ class TransactionSeries < Lithic::Internal::Type::BaseModel
335
+ # @!attribute related_transaction_event_token
336
+ #
337
+ # @return [String, nil]
338
+ required :related_transaction_event_token, String, nil?: true
339
+
340
+ # @!attribute related_transaction_token
341
+ #
342
+ # @return [String, nil]
343
+ required :related_transaction_token, String, nil?: true
344
+
345
+ # @!attribute type
346
+ #
347
+ # @return [String]
348
+ required :type, String
349
+
350
+ # @!method initialize(related_transaction_event_token:, related_transaction_token:, type:)
351
+ # A series of transactions that are grouped together.
352
+ #
353
+ # @param related_transaction_event_token [String, nil]
354
+ # @param related_transaction_token [String, nil]
355
+ # @param type [String]
356
+ end
261
357
  end
262
358
  end
263
359
  end
@@ -122,9 +122,7 @@ module Lithic
122
122
  #
123
123
  # @return [Array<Symbol, Lithic::Models::Document::RequiredDocumentUpload::StatusReason>]
124
124
  required :status_reasons,
125
- -> {
126
- Lithic::Internal::Type::ArrayOf[enum: Lithic::Document::RequiredDocumentUpload::StatusReason]
127
- }
125
+ -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Document::RequiredDocumentUpload::StatusReason] }
128
126
 
129
127
  # @!attribute updated
130
128
  # When the document upload was last updated
@@ -32,9 +32,7 @@ module Lithic
32
32
  #
33
33
  # @return [Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>, nil]
34
34
  optional :event_types,
35
- -> {
36
- Lithic::Internal::Type::ArrayOf[enum: Lithic::Events::SubscriptionCreateParams::EventType]
37
- }
35
+ -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Events::SubscriptionCreateParams::EventType] }
38
36
 
39
37
  # @!method initialize(url:, description: nil, disabled: nil, event_types: nil, request_options: {})
40
38
  # Some parameter documentations has been truncated, see
@@ -32,9 +32,7 @@ module Lithic
32
32
  #
33
33
  # @return [Array<Symbol, Lithic::Models::Events::SubscriptionUpdateParams::EventType>, nil]
34
34
  optional :event_types,
35
- -> {
36
- Lithic::Internal::Type::ArrayOf[enum: Lithic::Events::SubscriptionUpdateParams::EventType]
37
- }
35
+ -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Events::SubscriptionUpdateParams::EventType] }
38
36
 
39
37
  # @!method initialize(url:, description: nil, disabled: nil, event_types: nil, request_options: {})
40
38
  # Some parameter documentations has been truncated, see
@@ -16,9 +16,7 @@ module Lithic
16
16
  #
17
17
  # @return [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::AccountType>, nil]
18
18
  optional :account_types,
19
- -> {
20
- Lithic::Internal::Type::ArrayOf[enum: Lithic::ExternalBankAccountListParams::AccountType]
21
- }
19
+ -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::ExternalBankAccountListParams::AccountType] }
22
20
 
23
21
  # @!attribute countries
24
22
  #
@@ -60,9 +58,7 @@ module Lithic
60
58
  #
61
59
  # @return [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::VerificationState>, nil]
62
60
  optional :verification_states,
63
- -> {
64
- Lithic::Internal::Type::ArrayOf[enum: Lithic::ExternalBankAccountListParams::VerificationState]
65
- }
61
+ -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::ExternalBankAccountListParams::VerificationState] }
66
62
 
67
63
  # @!method initialize(account_token: nil, account_types: nil, countries: nil, ending_before: nil, owner_types: nil, page_size: nil, starting_after: nil, states: nil, verification_states: nil, request_options: {})
68
64
  # Some parameter documentations has been truncated, see
@@ -5,85 +5,139 @@ module Lithic
5
5
  # @see Lithic::Resources::ExternalPayments#create
6
6
  class ExternalPayment < Lithic::Internal::Type::BaseModel
7
7
  # @!attribute token
8
+ # Unique identifier for the transaction
8
9
  #
9
10
  # @return [String]
10
11
  required :token, String
11
12
 
12
- # @!attribute category
13
- #
14
- # @return [Symbol, Lithic::Models::ExternalPayment::Category]
15
- required :category, enum: -> { Lithic::ExternalPayment::Category }
16
-
17
13
  # @!attribute created
14
+ # ISO 8601 timestamp of when the transaction was created
18
15
  #
19
16
  # @return [Time]
20
17
  required :created, Time
21
18
 
19
+ # @!attribute family
20
+ #
21
+ # @return [Symbol, Lithic::Models::ExternalPayment::Family]
22
+ required :family, enum: -> { Lithic::ExternalPayment::Family }
23
+
24
+ # @!attribute status
25
+ # The status of the transaction
26
+ #
27
+ # @return [Symbol, Lithic::Models::ExternalPayment::Status]
28
+ required :status, enum: -> { Lithic::ExternalPayment::Status }
29
+
30
+ # @!attribute updated
31
+ # ISO 8601 timestamp of when the transaction was last updated
32
+ #
33
+ # @return [Time]
34
+ required :updated, Time
35
+
36
+ # @!attribute category
37
+ #
38
+ # @return [Symbol, Lithic::Models::ExternalPayment::Category, nil]
39
+ optional :category, enum: -> { Lithic::ExternalPayment::Category }
40
+
22
41
  # @!attribute currency
23
42
  #
24
- # @return [String]
25
- required :currency, String
43
+ # @return [String, nil]
44
+ optional :currency, String
26
45
 
27
46
  # @!attribute events
28
47
  #
29
- # @return [Array<Lithic::Models::ExternalPayment::Event>]
30
- required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::ExternalPayment::Event] }
48
+ # @return [Array<Lithic::Models::ExternalPayment::Event>, nil]
49
+ optional :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::ExternalPayment::Event] }
31
50
 
32
51
  # @!attribute financial_account_token
33
52
  #
34
- # @return [String]
35
- required :financial_account_token, String
53
+ # @return [String, nil]
54
+ optional :financial_account_token, String
36
55
 
37
56
  # @!attribute payment_type
38
57
  #
39
- # @return [Symbol, Lithic::Models::ExternalPayment::PaymentType]
40
- required :payment_type, enum: -> { Lithic::ExternalPayment::PaymentType }
58
+ # @return [Symbol, Lithic::Models::ExternalPayment::PaymentType, nil]
59
+ optional :payment_type, enum: -> { Lithic::ExternalPayment::PaymentType }
41
60
 
42
61
  # @!attribute pending_amount
43
62
  #
44
- # @return [Integer]
45
- required :pending_amount, Integer
63
+ # @return [Integer, nil]
64
+ optional :pending_amount, Integer
46
65
 
47
66
  # @!attribute result
48
67
  #
49
- # @return [Symbol, Lithic::Models::ExternalPayment::Result]
50
- required :result, enum: -> { Lithic::ExternalPayment::Result }
68
+ # @return [Symbol, Lithic::Models::ExternalPayment::Result, nil]
69
+ optional :result, enum: -> { Lithic::ExternalPayment::Result }
51
70
 
52
71
  # @!attribute settled_amount
53
72
  #
54
- # @return [Integer]
55
- required :settled_amount, Integer
56
-
57
- # @!attribute status
58
- #
59
- # @return [Symbol, Lithic::Models::ExternalPayment::Status]
60
- required :status, enum: -> { Lithic::ExternalPayment::Status }
61
-
62
- # @!attribute updated
63
- #
64
- # @return [Time]
65
- required :updated, Time
73
+ # @return [Integer, nil]
74
+ optional :settled_amount, Integer
66
75
 
67
76
  # @!attribute user_defined_id
68
77
  #
69
78
  # @return [String, nil]
70
79
  optional :user_defined_id, String
71
80
 
72
- # @!method initialize(token:, category:, created:, currency:, events:, financial_account_token:, payment_type:, pending_amount:, result:, settled_amount:, status:, updated:, user_defined_id: nil)
73
- # @param token [String]
81
+ # @!method initialize(token:, created:, family:, status:, updated:, category: nil, currency: nil, events: nil, financial_account_token: nil, payment_type: nil, pending_amount: nil, result: nil, settled_amount: nil, user_defined_id: nil)
82
+ # @param token [String] Unique identifier for the transaction
83
+ #
84
+ # @param created [Time] ISO 8601 timestamp of when the transaction was created
85
+ #
86
+ # @param family [Symbol, Lithic::Models::ExternalPayment::Family]
87
+ #
88
+ # @param status [Symbol, Lithic::Models::ExternalPayment::Status] The status of the transaction
89
+ #
90
+ # @param updated [Time] ISO 8601 timestamp of when the transaction was last updated
91
+ #
74
92
  # @param category [Symbol, Lithic::Models::ExternalPayment::Category]
75
- # @param created [Time]
93
+ #
76
94
  # @param currency [String]
95
+ #
77
96
  # @param events [Array<Lithic::Models::ExternalPayment::Event>]
97
+ #
78
98
  # @param financial_account_token [String]
99
+ #
79
100
  # @param payment_type [Symbol, Lithic::Models::ExternalPayment::PaymentType]
101
+ #
80
102
  # @param pending_amount [Integer]
103
+ #
81
104
  # @param result [Symbol, Lithic::Models::ExternalPayment::Result]
105
+ #
82
106
  # @param settled_amount [Integer]
83
- # @param status [Symbol, Lithic::Models::ExternalPayment::Status]
84
- # @param updated [Time]
107
+ #
85
108
  # @param user_defined_id [String]
86
109
 
110
+ # @see Lithic::Models::ExternalPayment#family
111
+ module Family
112
+ extend Lithic::Internal::Type::Enum
113
+
114
+ CARD = :CARD
115
+ PAYMENT = :PAYMENT
116
+ TRANSFER = :TRANSFER
117
+ INTERNAL = :INTERNAL
118
+ EXTERNAL_PAYMENT = :EXTERNAL_PAYMENT
119
+ MANAGEMENT_OPERATION = :MANAGEMENT_OPERATION
120
+
121
+ # @!method self.values
122
+ # @return [Array<Symbol>]
123
+ end
124
+
125
+ # The status of the transaction
126
+ #
127
+ # @see Lithic::Models::ExternalPayment#status
128
+ module Status
129
+ extend Lithic::Internal::Type::Enum
130
+
131
+ PENDING = :PENDING
132
+ SETTLED = :SETTLED
133
+ DECLINED = :DECLINED
134
+ REVERSED = :REVERSED
135
+ CANCELED = :CANCELED
136
+
137
+ # @!method self.values
138
+ # @return [Array<Symbol>]
139
+ end
140
+
87
141
  # @see Lithic::Models::ExternalPayment#category
88
142
  module Category
89
143
  extend Lithic::Internal::Type::Enum
@@ -153,6 +207,7 @@ module Lithic
153
207
  extend Lithic::Internal::Type::Enum
154
208
 
155
209
  APPROVED = :APPROVED
210
+ INSUFFICIENT_FUNDS = :INSUFFICIENT_FUNDS
156
211
 
157
212
  # @!method self.values
158
213
  # @return [Array<Symbol>]
@@ -220,20 +275,6 @@ module Lithic
220
275
  # @!method self.values
221
276
  # @return [Array<Symbol>]
222
277
  end
223
-
224
- # @see Lithic::Models::ExternalPayment#status
225
- module Status
226
- extend Lithic::Internal::Type::Enum
227
-
228
- PENDING = :PENDING
229
- SETTLED = :SETTLED
230
- DECLINED = :DECLINED
231
- REVERSED = :REVERSED
232
- CANCELED = :CANCELED
233
-
234
- # @!method self.values
235
- # @return [Array<Symbol>]
236
- end
237
278
  end
238
279
  end
239
280
  end
@@ -210,6 +210,7 @@ module Lithic
210
210
  SECURITY = :SECURITY
211
211
  PROGRAM_RECEIVABLES = :PROGRAM_RECEIVABLES
212
212
  COLLECTION = :COLLECTION
213
+ PROGRAM_BANK_ACCOUNTS_PAYABLE = :PROGRAM_BANK_ACCOUNTS_PAYABLE
213
214
 
214
215
  # @!method self.values
215
216
  # @return [Array<Symbol>]