lithic 0.1.0.pre.alpha.39 → 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 (207) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/client.rb +8 -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.rb +88 -1
  14. data/lib/lithic/models/account_activity_list_params.rb +156 -0
  15. data/lib/lithic/models/account_activity_list_response.rb +1435 -0
  16. data/lib/lithic/models/account_activity_retrieve_transaction_params.rb +14 -0
  17. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +1451 -0
  18. data/lib/lithic/models/account_holder.rb +16 -19
  19. data/lib/lithic/models/account_holder_create_params.rb +41 -47
  20. data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb +1 -3
  21. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +25 -20
  22. data/lib/lithic/models/account_holder_update_params.rb +2 -6
  23. data/lib/lithic/models/account_holder_update_response.rb +25 -20
  24. data/lib/lithic/models/account_update_params.rb +86 -1
  25. data/lib/lithic/models/aggregate_balance.rb +1 -0
  26. data/lib/lithic/models/aggregate_balance_list_params.rb +1 -0
  27. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +5 -1
  28. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +12 -22
  29. data/lib/lithic/models/auth_rules/v2_list_params.rb +1 -0
  30. data/lib/lithic/models/auth_rules/velocity_limit_params.rb +3 -25
  31. data/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rb +226 -16
  32. data/lib/lithic/models/balance.rb +1 -0
  33. data/lib/lithic/models/balance_list_params.rb +1 -0
  34. data/lib/lithic/models/book_transfer_create_params.rb +34 -6
  35. data/lib/lithic/models/book_transfer_response.rb +124 -28
  36. data/lib/lithic/models/card_create_params.rb +90 -1
  37. data/lib/lithic/models/card_program.rb +10 -1
  38. data/lib/lithic/models/card_update_params.rb +98 -1
  39. data/lib/lithic/models/cards/balance_list_response.rb +1 -0
  40. data/lib/lithic/models/document.rb +1 -3
  41. data/lib/lithic/models/events/subscription_create_params.rb +1 -3
  42. data/lib/lithic/models/events/subscription_update_params.rb +1 -3
  43. data/lib/lithic/models/external_bank_account_list_params.rb +2 -6
  44. data/lib/lithic/models/external_payment.rb +89 -48
  45. data/lib/lithic/models/external_resource.rb +34 -0
  46. data/lib/lithic/models/external_resource_type.rb +18 -0
  47. data/lib/lithic/models/financial_account.rb +1 -0
  48. data/lib/lithic/models/financial_account_list_params.rb +1 -0
  49. data/lib/lithic/models/financial_accounts/balance_list_response.rb +1 -0
  50. data/lib/lithic/models/financial_accounts/loan_tape.rb +5 -18
  51. data/lib/lithic/models/financial_accounts/statement.rb +3 -10
  52. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +2 -7
  53. data/lib/lithic/models/financial_transaction.rb +2 -0
  54. data/lib/lithic/models/instance_financial_account_type.rb +1 -0
  55. data/lib/lithic/models/kyb.rb +2 -2
  56. data/lib/lithic/models/management_operation_create_params.rb +30 -1
  57. data/lib/lithic/models/management_operation_transaction.rb +100 -52
  58. data/lib/lithic/models/network_program.rb +41 -0
  59. data/lib/lithic/models/network_program_list_params.rb +43 -0
  60. data/lib/lithic/models/network_program_retrieve_params.rb +14 -0
  61. data/lib/lithic/models/non_pci_card.rb +88 -1
  62. data/lib/lithic/models/payment.rb +60 -1
  63. data/lib/lithic/models/payment_simulate_action_params.rb +1 -0
  64. data/lib/lithic/models/reports/settlement_list_details_params.rb +2 -2
  65. data/lib/lithic/models/settlement_detail.rb +1 -0
  66. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +145 -12
  67. data/lib/lithic/models/three_ds/authentication_simulate_params.rb +1 -4
  68. data/lib/lithic/models/tokenization.rb +1 -1
  69. data/lib/lithic/models/transaction.rb +31 -20
  70. data/lib/lithic/models/transactions/events/enhanced_data.rb +3 -11
  71. data/lib/lithic/models/transfer.rb +2 -0
  72. data/lib/lithic/models/wire_party_details.rb +40 -0
  73. data/lib/lithic/models.rb +16 -0
  74. data/lib/lithic/resources/account_activity.rb +80 -0
  75. data/lib/lithic/resources/account_holders.rb +9 -9
  76. data/lib/lithic/resources/accounts.rb +5 -1
  77. data/lib/lithic/resources/book_transfers.rb +7 -3
  78. data/lib/lithic/resources/cards.rb +12 -2
  79. data/lib/lithic/resources/management_operations.rb +13 -1
  80. data/lib/lithic/resources/network_programs.rb +64 -0
  81. data/lib/lithic/resources/reports/settlement.rb +1 -1
  82. data/lib/lithic/resources/tokenizations.rb +2 -2
  83. data/lib/lithic/version.rb +1 -1
  84. data/lib/lithic.rb +13 -2
  85. data/rbi/lithic/client.rbi +6 -0
  86. data/rbi/lithic/errors.rbi +2 -2
  87. data/rbi/lithic/internal/transport/base_client.rbi +1 -1
  88. data/rbi/lithic/internal/type/converter.rbi +46 -0
  89. data/rbi/lithic/internal/type/union.rbi +7 -2
  90. data/rbi/lithic/models/account.rbi +131 -0
  91. data/rbi/lithic/models/account_activity_list_params.rbi +359 -0
  92. data/rbi/lithic/models/account_activity_list_response.rbi +3367 -0
  93. data/rbi/lithic/models/account_activity_retrieve_transaction_params.rbi +30 -0
  94. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +3369 -0
  95. data/rbi/lithic/models/account_holder.rbi +21 -23
  96. data/rbi/lithic/models/account_holder_create_params.rbi +87 -65
  97. data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +36 -30
  98. data/rbi/lithic/models/account_holder_update_response.rbi +36 -30
  99. data/rbi/lithic/models/account_update_params.rbi +159 -0
  100. data/rbi/lithic/models/aggregate_balance.rbi +5 -0
  101. data/rbi/lithic/models/aggregate_balance_list_params.rbi +5 -0
  102. data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +20 -0
  103. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +26 -15
  104. data/rbi/lithic/models/auth_rules/v2_list_params.rbi +2 -0
  105. data/rbi/lithic/models/auth_rules/velocity_limit_params.rbi +18 -25
  106. data/rbi/lithic/models/auth_rules/velocity_limit_params_period_window.rbi +527 -31
  107. data/rbi/lithic/models/balance.rbi +2 -0
  108. data/rbi/lithic/models/balance_list_params.rbi +5 -0
  109. data/rbi/lithic/models/book_transfer_create_params.rbi +75 -5
  110. data/rbi/lithic/models/book_transfer_response.rbi +320 -38
  111. data/rbi/lithic/models/card_create_params.rbi +190 -0
  112. data/rbi/lithic/models/card_program.rbi +13 -0
  113. data/rbi/lithic/models/card_update_params.rbi +168 -0
  114. data/rbi/lithic/models/cards/balance_list_response.rbi +5 -0
  115. data/rbi/lithic/models/external_payment.rbi +147 -60
  116. data/rbi/lithic/models/external_resource.rbi +57 -0
  117. data/rbi/lithic/models/external_resource_type.rbi +26 -0
  118. data/rbi/lithic/models/financial_account.rbi +5 -0
  119. data/rbi/lithic/models/financial_account_list_params.rbi +5 -0
  120. data/rbi/lithic/models/financial_accounts/balance_list_response.rbi +5 -0
  121. data/rbi/lithic/models/financial_transaction.rbi +1 -0
  122. data/rbi/lithic/models/instance_financial_account_type.rbi +5 -0
  123. data/rbi/lithic/models/kyb.rbi +2 -2
  124. data/rbi/lithic/models/management_operation_create_params.rbi +59 -0
  125. data/rbi/lithic/models/management_operation_transaction.rbi +230 -84
  126. data/rbi/lithic/models/network_program.rbi +61 -0
  127. data/rbi/lithic/models/network_program_list_params.rbi +72 -0
  128. data/rbi/lithic/models/network_program_retrieve_params.rbi +27 -0
  129. data/rbi/lithic/models/non_pci_card.rbi +133 -3
  130. data/rbi/lithic/models/payment.rbi +103 -3
  131. data/rbi/lithic/models/payment_simulate_action_params.rbi +5 -0
  132. data/rbi/lithic/models/reports/settlement_list_details_params.rbi +2 -2
  133. data/rbi/lithic/models/settlement_detail.rbi +2 -0
  134. data/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi +222 -19
  135. data/rbi/lithic/models/transaction.rbi +23 -31
  136. data/rbi/lithic/models/transfer.rbi +1 -0
  137. data/rbi/lithic/models/wire_party_details.rbi +61 -0
  138. data/rbi/lithic/models.rbi +17 -0
  139. data/rbi/lithic/resources/account_activity.rbi +80 -0
  140. data/rbi/lithic/resources/account_holders.rbi +28 -29
  141. data/rbi/lithic/resources/accounts.rbi +32 -0
  142. data/rbi/lithic/resources/book_transfers.rbi +9 -2
  143. data/rbi/lithic/resources/cards.rbi +70 -0
  144. data/rbi/lithic/resources/management_operations.rbi +4 -0
  145. data/rbi/lithic/resources/network_programs.rbi +48 -0
  146. data/rbi/lithic/resources/reports/settlement.rbi +1 -1
  147. data/rbi/lithic/resources/tokenizations.rbi +1 -1
  148. data/sig/lithic/client.rbs +4 -0
  149. data/sig/lithic/internal/transport/base_client.rbs +1 -1
  150. data/sig/lithic/internal/type/converter.rbs +17 -0
  151. data/sig/lithic/internal/type/union.rbs +2 -2
  152. data/sig/lithic/models/account.rbs +41 -0
  153. data/sig/lithic/models/account_activity_list_params.rbs +173 -0
  154. data/sig/lithic/models/account_activity_list_response.rbs +1353 -0
  155. data/sig/lithic/models/account_activity_retrieve_transaction_params.rbs +15 -0
  156. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +1353 -0
  157. data/sig/lithic/models/account_holder_create_params.rbs +33 -19
  158. data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +10 -3
  159. data/sig/lithic/models/account_holder_update_response.rbs +10 -3
  160. data/sig/lithic/models/account_update_params.rbs +41 -0
  161. data/sig/lithic/models/aggregate_balance.rbs +2 -1
  162. data/sig/lithic/models/aggregate_balance_list_params.rbs +2 -1
  163. data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +8 -0
  164. data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +8 -0
  165. data/sig/lithic/models/auth_rules/v2_list_params.rbs +2 -1
  166. data/sig/lithic/models/auth_rules/velocity_limit_params.rbs +4 -14
  167. data/sig/lithic/models/auth_rules/velocity_limit_params_period_window.rbs +212 -7
  168. data/sig/lithic/models/balance.rbs +2 -1
  169. data/sig/lithic/models/balance_list_params.rbs +2 -1
  170. data/sig/lithic/models/book_transfer_create_params.rbs +30 -1
  171. data/sig/lithic/models/book_transfer_response.rbs +134 -15
  172. data/sig/lithic/models/card_create_params.rbs +47 -0
  173. data/sig/lithic/models/card_program.rbs +7 -0
  174. data/sig/lithic/models/card_update_params.rbs +55 -1
  175. data/sig/lithic/models/cards/balance_list_response.rbs +2 -1
  176. data/sig/lithic/models/external_payment.rbs +91 -40
  177. data/sig/lithic/models/external_resource.rbs +32 -0
  178. data/sig/lithic/models/external_resource_type.rbs +16 -0
  179. data/sig/lithic/models/financial_account.rbs +2 -0
  180. data/sig/lithic/models/financial_account_list_params.rbs +2 -1
  181. data/sig/lithic/models/financial_accounts/balance_list_response.rbs +2 -1
  182. data/sig/lithic/models/instance_financial_account_type.rbs +2 -0
  183. data/sig/lithic/models/management_operation_create_params.rbs +20 -0
  184. data/sig/lithic/models/management_operation_transaction.rbs +98 -42
  185. data/sig/lithic/models/network_program.rbs +35 -0
  186. data/sig/lithic/models/network_program_list_params.rbs +38 -0
  187. data/sig/lithic/models/network_program_retrieve_params.rbs +15 -0
  188. data/sig/lithic/models/non_pci_card.rbs +55 -3
  189. data/sig/lithic/models/payment.rbs +61 -3
  190. data/sig/lithic/models/payment_simulate_action_params.rbs +2 -0
  191. data/sig/lithic/models/settlement_detail.rbs +2 -0
  192. data/sig/lithic/models/three_ds/authentication_retrieve_response.rbs +90 -3
  193. data/sig/lithic/models/transaction.rbs +2 -6
  194. data/sig/lithic/models/wire_party_details.rbs +35 -0
  195. data/sig/lithic/models.rbs +16 -0
  196. data/sig/lithic/resources/account_activity.rbs +27 -0
  197. data/sig/lithic/resources/account_holders.rbs +3 -3
  198. data/sig/lithic/resources/accounts.rbs +2 -0
  199. data/sig/lithic/resources/book_transfers.rbs +2 -0
  200. data/sig/lithic/resources/cards.rbs +5 -0
  201. data/sig/lithic/resources/management_operations.rbs +1 -0
  202. data/sig/lithic/resources/network_programs.rbs +19 -0
  203. data/sig/lithic/resources/tokenizations.rbs +1 -1
  204. metadata +38 -5
  205. data/lib/lithic/models/tokenization_retrieve_response.rb +0 -16
  206. data/rbi/lithic/models/tokenization_retrieve_response.rbi +0 -31
  207. data/sig/lithic/models/tokenization_retrieve_response.rbs +0 -15
@@ -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
@@ -108,6 +108,13 @@ module Lithic
108
108
  # @return [String, nil]
109
109
  optional :replacement_account_token, String
110
110
 
111
+ # @!attribute replacement_comment
112
+ # Additional context or information related to the card that this card will
113
+ # replace.
114
+ #
115
+ # @return [String, nil]
116
+ optional :replacement_comment, String
117
+
111
118
  # @!attribute replacement_for
112
119
  # Globally unique identifier for the card that this card will replace. If the card
113
120
  # type is `PHYSICAL` it will be replaced by a `PHYSICAL` card. If the card type is
@@ -116,6 +123,38 @@ module Lithic
116
123
  # @return [String, nil]
117
124
  optional :replacement_for, String
118
125
 
126
+ # @!attribute replacement_substatus
127
+ # Card state substatus values for the card that this card will replace:
128
+ #
129
+ # - `LOST` - The physical card is no longer in the cardholder's possession due to
130
+ # being lost or never received by the cardholder.
131
+ # - `COMPROMISED` - Card information has been exposed, potentially leading to
132
+ # unauthorized access. This may involve physical card theft, cloning, or online
133
+ # data breaches.
134
+ # - `DAMAGED` - The physical card is not functioning properly, such as having chip
135
+ # failures or a demagnetized magnetic stripe.
136
+ # - `END_USER_REQUEST` - The cardholder requested the closure of the card for
137
+ # reasons unrelated to fraud or damage, such as switching to a different product
138
+ # or closing the account.
139
+ # - `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud
140
+ # or damage, such as account inactivity, product or policy changes, or
141
+ # technology upgrades.
142
+ # - `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified
143
+ # period, applicable to statuses like `PAUSED` or `CLOSED`.
144
+ # - `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or
145
+ # activities that require review. This can involve prompting the cardholder to
146
+ # confirm legitimate use or report confirmed fraud.
147
+ # - `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
148
+ # review.
149
+ # - `EXPIRED` - The card has expired and has been closed without being reissued.
150
+ # - `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been
151
+ # returned.
152
+ # - `OTHER` - The reason for the status does not fall into any of the above
153
+ # categories. A comment should be provided to specify the reason.
154
+ #
155
+ # @return [Symbol, Lithic::Models::CardCreateParams::ReplacementSubstatus, nil]
156
+ optional :replacement_substatus, enum: -> { Lithic::CardCreateParams::ReplacementSubstatus }
157
+
119
158
  # @!attribute shipping_address
120
159
  #
121
160
  # @return [Lithic::Models::ShippingAddress, nil]
@@ -178,7 +217,7 @@ module Lithic
178
217
  # @return [Symbol, Lithic::Models::CardCreateParams::State, nil]
179
218
  optional :state, enum: -> { Lithic::CardCreateParams::State }
180
219
 
181
- # @!method initialize(type:, account_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_for: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
220
+ # @!method initialize(type:, account_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_comment: nil, replacement_for: nil, replacement_substatus: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
182
221
  # Some parameter documentations has been truncated, see
183
222
  # {Lithic::Models::CardCreateParams} for more details.
184
223
  #
@@ -204,8 +243,12 @@ module Lithic
204
243
  #
205
244
  # @param replacement_account_token [String] Restricted field limited to select use cases. Lithic will reach out directly if
206
245
  #
246
+ # @param replacement_comment [String] Additional context or information related to the card that this card will replac
247
+ #
207
248
  # @param replacement_for [String] Globally unique identifier for the card that this card will replace. If the card
208
249
  #
250
+ # @param replacement_substatus [Symbol, Lithic::Models::CardCreateParams::ReplacementSubstatus] Card state substatus values for the card that this card will replace:
251
+ #
209
252
  # @param shipping_address [Lithic::Models::ShippingAddress]
210
253
  #
211
254
  # @param shipping_method [Symbol, Lithic::Models::CardCreateParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL.
@@ -248,6 +291,52 @@ module Lithic
248
291
  # @return [Array<Symbol>]
249
292
  end
250
293
 
294
+ # Card state substatus values for the card that this card will replace:
295
+ #
296
+ # - `LOST` - The physical card is no longer in the cardholder's possession due to
297
+ # being lost or never received by the cardholder.
298
+ # - `COMPROMISED` - Card information has been exposed, potentially leading to
299
+ # unauthorized access. This may involve physical card theft, cloning, or online
300
+ # data breaches.
301
+ # - `DAMAGED` - The physical card is not functioning properly, such as having chip
302
+ # failures or a demagnetized magnetic stripe.
303
+ # - `END_USER_REQUEST` - The cardholder requested the closure of the card for
304
+ # reasons unrelated to fraud or damage, such as switching to a different product
305
+ # or closing the account.
306
+ # - `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud
307
+ # or damage, such as account inactivity, product or policy changes, or
308
+ # technology upgrades.
309
+ # - `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified
310
+ # period, applicable to statuses like `PAUSED` or `CLOSED`.
311
+ # - `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or
312
+ # activities that require review. This can involve prompting the cardholder to
313
+ # confirm legitimate use or report confirmed fraud.
314
+ # - `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
315
+ # review.
316
+ # - `EXPIRED` - The card has expired and has been closed without being reissued.
317
+ # - `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been
318
+ # returned.
319
+ # - `OTHER` - The reason for the status does not fall into any of the above
320
+ # categories. A comment should be provided to specify the reason.
321
+ module ReplacementSubstatus
322
+ extend Lithic::Internal::Type::Enum
323
+
324
+ LOST = :LOST
325
+ COMPROMISED = :COMPROMISED
326
+ DAMAGED = :DAMAGED
327
+ END_USER_REQUEST = :END_USER_REQUEST
328
+ ISSUER_REQUEST = :ISSUER_REQUEST
329
+ NOT_ACTIVE = :NOT_ACTIVE
330
+ SUSPICIOUS_ACTIVITY = :SUSPICIOUS_ACTIVITY
331
+ INTERNAL_REVIEW = :INTERNAL_REVIEW
332
+ EXPIRED = :EXPIRED
333
+ UNDELIVERABLE = :UNDELIVERABLE
334
+ OTHER = :OTHER
335
+
336
+ # @!method self.values
337
+ # @return [Array<Symbol>]
338
+ end
339
+
251
340
  # Shipping method for the card. Only applies to cards of type PHYSICAL. Use of
252
341
  # options besides `STANDARD` require additional permissions.
253
342
  #
@@ -34,6 +34,13 @@ module Lithic
34
34
  # @return [String]
35
35
  required :pan_range_start, String
36
36
 
37
+ # @!attribute account_level_management_enabled
38
+ # Whether the card program is participating in Account Level Management. Currently
39
+ # applicable to Visa card programs only.
40
+ #
41
+ # @return [Boolean, nil]
42
+ optional :account_level_management_enabled, Lithic::Internal::Type::Boolean
43
+
37
44
  # @!attribute cardholder_currency
38
45
  # 3-character alphabetic ISO 4217 code for the currency of the cardholder.
39
46
  #
@@ -47,7 +54,7 @@ module Lithic
47
54
  # @return [Array<String>, nil]
48
55
  optional :settlement_currencies, Lithic::Internal::Type::ArrayOf[String]
49
56
 
50
- # @!method initialize(token:, created:, name:, pan_range_end:, pan_range_start:, cardholder_currency: nil, settlement_currencies: nil)
57
+ # @!method initialize(token:, created:, name:, pan_range_end:, pan_range_start:, account_level_management_enabled: nil, cardholder_currency: nil, settlement_currencies: nil)
51
58
  # Some parameter documentations has been truncated, see
52
59
  # {Lithic::Models::CardProgram} for more details.
53
60
  #
@@ -61,6 +68,8 @@ module Lithic
61
68
  #
62
69
  # @param pan_range_start [String] The first digits of the card number that this card program starts with.
63
70
  #
71
+ # @param account_level_management_enabled [Boolean] Whether the card program is participating in Account Level Management. Currently
72
+ #
64
73
  # @param cardholder_currency [String] 3-character alphabetic ISO 4217 code for the currency of the cardholder.
65
74
  #
66
75
  # @param settlement_currencies [Array<String>] List of 3-character alphabetic ISO 4217 codes for the currencies that the card p
@@ -7,6 +7,12 @@ module Lithic
7
7
  extend Lithic::Internal::Type::RequestParameters::Converter
8
8
  include Lithic::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute comment
11
+ # Additional context or information related to the card.
12
+ #
13
+ # @return [String, nil]
14
+ optional :comment, String
15
+
10
16
  # @!attribute digital_card_art_token
11
17
  # Specifies the digital card art to be displayed in the user’s digital wallet
12
18
  # after tokenization. This artwork must be approved by Mastercard and configured
@@ -22,6 +28,13 @@ module Lithic
22
28
  # @return [String, nil]
23
29
  optional :memo, String
24
30
 
31
+ # @!attribute network_program_token
32
+ # Globally unique identifier for the card's network program. Currently applicable
33
+ # to Visa cards participating in Account Level Management only.
34
+ #
35
+ # @return [String, nil]
36
+ optional :network_program_token, String
37
+
25
38
  # @!attribute pin
26
39
  # Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and
27
40
  # `VIRTUAL`. Changing PIN also resets PIN status to `OK`. See
@@ -77,14 +90,50 @@ module Lithic
77
90
  # @return [Symbol, Lithic::Models::CardUpdateParams::State, nil]
78
91
  optional :state, enum: -> { Lithic::CardUpdateParams::State }
79
92
 
80
- # @!method initialize(digital_card_art_token: nil, memo: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
93
+ # @!attribute substatus
94
+ # Card state substatus values:
95
+ #
96
+ # - `LOST` - The physical card is no longer in the cardholder's possession due to
97
+ # being lost or never received by the cardholder.
98
+ # - `COMPROMISED` - Card information has been exposed, potentially leading to
99
+ # unauthorized access. This may involve physical card theft, cloning, or online
100
+ # data breaches.
101
+ # - `DAMAGED` - The physical card is not functioning properly, such as having chip
102
+ # failures or a demagnetized magnetic stripe.
103
+ # - `END_USER_REQUEST` - The cardholder requested the closure of the card for
104
+ # reasons unrelated to fraud or damage, such as switching to a different product
105
+ # or closing the account.
106
+ # - `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud
107
+ # or damage, such as account inactivity, product or policy changes, or
108
+ # technology upgrades.
109
+ # - `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified
110
+ # period, applicable to statuses like `PAUSED` or `CLOSED`.
111
+ # - `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or
112
+ # activities that require review. This can involve prompting the cardholder to
113
+ # confirm legitimate use or report confirmed fraud.
114
+ # - `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
115
+ # review.
116
+ # - `EXPIRED` - The card has expired and has been closed without being reissued.
117
+ # - `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been
118
+ # returned.
119
+ # - `OTHER` - The reason for the status does not fall into any of the above
120
+ # categories. A comment should be provided to specify the reason.
121
+ #
122
+ # @return [Symbol, Lithic::Models::CardUpdateParams::Substatus, nil]
123
+ optional :substatus, enum: -> { Lithic::CardUpdateParams::Substatus }
124
+
125
+ # @!method initialize(comment: nil, digital_card_art_token: nil, memo: nil, network_program_token: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, substatus: nil, request_options: {})
81
126
  # Some parameter documentations has been truncated, see
82
127
  # {Lithic::Models::CardUpdateParams} for more details.
83
128
  #
129
+ # @param comment [String] Additional context or information related to the card.
130
+ #
84
131
  # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet afte
85
132
  #
86
133
  # @param memo [String] Friendly name to identify the card.
87
134
  #
135
+ # @param network_program_token [String] Globally unique identifier for the card's network program. Currently applicable
136
+ #
88
137
  # @param pin [String] Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and `V
89
138
  #
90
139
  # @param pin_status [Symbol, Lithic::Models::CardUpdateParams::PinStatus] Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
@@ -95,6 +144,8 @@ module Lithic
95
144
  #
96
145
  # @param state [Symbol, Lithic::Models::CardUpdateParams::State] Card state values:
97
146
  #
147
+ # @param substatus [Symbol, Lithic::Models::CardUpdateParams::Substatus] Card state substatus values:
148
+ #
98
149
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
99
150
 
100
151
  # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
@@ -126,6 +177,52 @@ module Lithic
126
177
  # @!method self.values
127
178
  # @return [Array<Symbol>]
128
179
  end
180
+
181
+ # Card state substatus values:
182
+ #
183
+ # - `LOST` - The physical card is no longer in the cardholder's possession due to
184
+ # being lost or never received by the cardholder.
185
+ # - `COMPROMISED` - Card information has been exposed, potentially leading to
186
+ # unauthorized access. This may involve physical card theft, cloning, or online
187
+ # data breaches.
188
+ # - `DAMAGED` - The physical card is not functioning properly, such as having chip
189
+ # failures or a demagnetized magnetic stripe.
190
+ # - `END_USER_REQUEST` - The cardholder requested the closure of the card for
191
+ # reasons unrelated to fraud or damage, such as switching to a different product
192
+ # or closing the account.
193
+ # - `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud
194
+ # or damage, such as account inactivity, product or policy changes, or
195
+ # technology upgrades.
196
+ # - `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified
197
+ # period, applicable to statuses like `PAUSED` or `CLOSED`.
198
+ # - `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or
199
+ # activities that require review. This can involve prompting the cardholder to
200
+ # confirm legitimate use or report confirmed fraud.
201
+ # - `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
202
+ # review.
203
+ # - `EXPIRED` - The card has expired and has been closed without being reissued.
204
+ # - `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been
205
+ # returned.
206
+ # - `OTHER` - The reason for the status does not fall into any of the above
207
+ # categories. A comment should be provided to specify the reason.
208
+ module Substatus
209
+ extend Lithic::Internal::Type::Enum
210
+
211
+ LOST = :LOST
212
+ COMPROMISED = :COMPROMISED
213
+ DAMAGED = :DAMAGED
214
+ END_USER_REQUEST = :END_USER_REQUEST
215
+ ISSUER_REQUEST = :ISSUER_REQUEST
216
+ NOT_ACTIVE = :NOT_ACTIVE
217
+ SUSPICIOUS_ACTIVITY = :SUSPICIOUS_ACTIVITY
218
+ INTERNAL_REVIEW = :INTERNAL_REVIEW
219
+ EXPIRED = :EXPIRED
220
+ UNDELIVERABLE = :UNDELIVERABLE
221
+ OTHER = :OTHER
222
+
223
+ # @!method self.values
224
+ # @return [Array<Symbol>]
225
+ end
129
226
  end
130
227
  end
131
228
  end
@@ -104,6 +104,7 @@ module Lithic
104
104
  ISSUING = :ISSUING
105
105
  OPERATING = :OPERATING
106
106
  RESERVE = :RESERVE
107
+ SECURITY = :SECURITY
107
108
 
108
109
  # @!method self.values
109
110
  # @return [Array<Symbol>]
@@ -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