lithic 0.1.0.pre.alpha.14 → 0.1.0.pre.alpha.16

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 (466) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +36 -0
  3. data/README.md +61 -52
  4. data/lib/lithic/client.rb +4 -4
  5. data/lib/lithic/internal/transport/pooled_net_requester.rb +1 -5
  6. data/lib/lithic/internal/type/array_of.rb +9 -0
  7. data/lib/lithic/internal/type/base_model.rb +62 -28
  8. data/lib/lithic/internal/type/base_page.rb +8 -0
  9. data/lib/lithic/internal/type/boolean.rb +4 -0
  10. data/lib/lithic/internal/type/enum.rb +9 -5
  11. data/lib/lithic/internal/type/hash_of.rb +9 -0
  12. data/lib/lithic/internal/type/io_like.rb +4 -0
  13. data/lib/lithic/internal/type/request_parameters.rb +1 -2
  14. data/lib/lithic/internal/type/union.rb +10 -1
  15. data/lib/lithic/internal/type/unknown.rb +4 -0
  16. data/lib/lithic/internal.rb +0 -1
  17. data/lib/lithic/models/account.rb +42 -91
  18. data/lib/lithic/models/account_financial_account_type.rb +2 -5
  19. data/lib/lithic/models/account_holder.rb +127 -312
  20. data/lib/lithic/models/account_holder_create_params.rb +99 -219
  21. data/lib/lithic/models/account_holder_create_response.rb +15 -48
  22. data/lib/lithic/models/account_holder_list_documents_params.rb +3 -8
  23. data/lib/lithic/models/account_holder_list_documents_response.rb +3 -11
  24. data/lib/lithic/models/account_holder_list_params.rb +25 -90
  25. data/lib/lithic/models/account_holder_retrieve_document_params.rb +4 -9
  26. data/lib/lithic/models/account_holder_retrieve_params.rb +3 -8
  27. data/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rb +13 -41
  28. data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb +13 -36
  29. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +151 -388
  30. data/lib/lithic/models/account_holder_update_params.rb +132 -424
  31. data/lib/lithic/models/account_holder_update_response.rb +180 -474
  32. data/lib/lithic/models/account_holder_upload_document_params.rb +7 -15
  33. data/lib/lithic/models/account_list_params.rb +13 -38
  34. data/lib/lithic/models/account_retrieve_params.rb +3 -8
  35. data/lib/lithic/models/account_retrieve_spend_limits_params.rb +3 -8
  36. data/lib/lithic/models/account_spend_limits.rb +27 -87
  37. data/lib/lithic/models/account_update_params.rb +35 -99
  38. data/lib/lithic/models/address.rb +8 -16
  39. data/lib/lithic/models/address_update.rb +13 -41
  40. data/lib/lithic/models/aggregate_balance.rb +15 -36
  41. data/lib/lithic/models/aggregate_balance_list_params.rb +7 -19
  42. data/lib/lithic/models/api_status.rb +3 -11
  43. data/lib/lithic/models/auth_rules/auth_rule.rb +19 -67
  44. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +11 -31
  45. data/lib/lithic/models/auth_rules/conditional_attribute.rb +2 -5
  46. data/lib/lithic/models/auth_rules/conditional_block_parameters.rb +2 -6
  47. data/lib/lithic/models/auth_rules/v2/backtest_create_params.rb +7 -20
  48. data/lib/lithic/models/auth_rules/v2/backtest_create_response.rb +3 -11
  49. data/lib/lithic/models/auth_rules/v2/backtest_results.rb +46 -142
  50. data/lib/lithic/models/auth_rules/v2/backtest_retrieve_params.rb +4 -9
  51. data/lib/lithic/models/auth_rules/v2_apply_params.rb +8 -17
  52. data/lib/lithic/models/auth_rules/v2_apply_response.rb +26 -64
  53. data/lib/lithic/models/auth_rules/v2_create_params.rb +17 -50
  54. data/lib/lithic/models/auth_rules/v2_create_response.rb +26 -64
  55. data/lib/lithic/models/auth_rules/v2_delete_params.rb +3 -8
  56. data/lib/lithic/models/auth_rules/v2_draft_params.rb +6 -12
  57. data/lib/lithic/models/auth_rules/v2_draft_response.rb +26 -64
  58. data/lib/lithic/models/auth_rules/v2_list_params.rb +13 -48
  59. data/lib/lithic/models/auth_rules/v2_list_response.rb +26 -64
  60. data/lib/lithic/models/auth_rules/v2_promote_params.rb +3 -8
  61. data/lib/lithic/models/auth_rules/v2_promote_response.rb +26 -64
  62. data/lib/lithic/models/auth_rules/v2_report_params.rb +3 -8
  63. data/lib/lithic/models/auth_rules/v2_report_response.rb +3 -11
  64. data/lib/lithic/models/auth_rules/v2_retrieve_params.rb +3 -8
  65. data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +26 -64
  66. data/lib/lithic/models/auth_rules/v2_update_params.rb +16 -55
  67. data/lib/lithic/models/auth_rules/v2_update_response.rb +26 -64
  68. data/lib/lithic/models/auth_rules/velocity_limit_params.rb +15 -27
  69. data/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rb +2 -5
  70. data/lib/lithic/models/auth_stream_enrollment_retrieve_secret_params.rb +3 -8
  71. data/lib/lithic/models/auth_stream_enrollment_rotate_secret_params.rb +3 -8
  72. data/lib/lithic/models/auth_stream_secret.rb +3 -11
  73. data/lib/lithic/models/balance.rb +15 -36
  74. data/lib/lithic/models/balance_list_params.rb +13 -46
  75. data/lib/lithic/models/book_transfer_create_params.rb +17 -49
  76. data/lib/lithic/models/book_transfer_list_params.rb +31 -105
  77. data/lib/lithic/models/book_transfer_response.rb +32 -71
  78. data/lib/lithic/models/book_transfer_retrieve_params.rb +3 -8
  79. data/lib/lithic/models/book_transfer_reverse_params.rb +5 -14
  80. data/lib/lithic/models/card_convert_physical_params.rb +12 -32
  81. data/lib/lithic/models/card_convert_physical_response.rb +393 -0
  82. data/lib/lithic/models/card_create_params.rb +42 -142
  83. data/lib/lithic/models/card_create_response.rb +392 -0
  84. data/lib/lithic/models/card_embed_params.rb +5 -10
  85. data/lib/lithic/models/card_list_params.rb +19 -67
  86. data/lib/lithic/models/card_list_response.rb +376 -0
  87. data/lib/lithic/models/card_program.rb +10 -33
  88. data/lib/lithic/models/card_program_list_params.rb +9 -26
  89. data/lib/lithic/models/card_program_retrieve_params.rb +3 -8
  90. data/lib/lithic/models/card_provision_params.rb +17 -60
  91. data/lib/lithic/models/card_provision_response.rb +3 -11
  92. data/lib/lithic/models/card_reissue_params.rb +13 -37
  93. data/lib/lithic/models/card_reissue_response.rb +392 -0
  94. data/lib/lithic/models/card_renew_params.rb +16 -55
  95. data/lib/lithic/models/card_renew_response.rb +392 -0
  96. data/lib/lithic/models/card_retrieve_params.rb +3 -8
  97. data/lib/lithic/models/card_retrieve_response.rb +392 -0
  98. data/lib/lithic/models/card_retrieve_spend_limits_params.rb +3 -8
  99. data/lib/lithic/models/card_search_by_pan_params.rb +4 -9
  100. data/lib/lithic/models/card_search_by_pan_response.rb +392 -0
  101. data/lib/lithic/models/card_spend_limits.rb +27 -87
  102. data/lib/lithic/models/card_update_params.rb +21 -72
  103. data/lib/lithic/models/card_update_response.rb +392 -0
  104. data/lib/lithic/models/cards/aggregate_balance_list_params.rb +7 -20
  105. data/lib/lithic/models/cards/aggregate_balance_list_response.rb +12 -29
  106. data/lib/lithic/models/cards/balance_list_params.rb +7 -20
  107. data/lib/lithic/models/cards/balance_list_response.rb +15 -36
  108. data/lib/lithic/models/cards/financial_transaction_list_params.rb +23 -77
  109. data/lib/lithic/models/cards/financial_transaction_retrieve_params.rb +4 -9
  110. data/lib/lithic/models/carrier.rb +3 -11
  111. data/lib/lithic/models/client_api_status_params.rb +3 -8
  112. data/lib/lithic/models/credit_products/extended_credit.rb +2 -6
  113. data/lib/lithic/models/credit_products/extended_credit_retrieve_params.rb +3 -8
  114. data/lib/lithic/models/credit_products/prime_rate_create_params.rb +5 -10
  115. data/lib/lithic/models/credit_products/prime_rate_retrieve_params.rb +7 -20
  116. data/lib/lithic/models/credit_products/prime_rate_retrieve_response.rb +6 -14
  117. data/lib/lithic/models/digital_card_art.rb +11 -33
  118. data/lib/lithic/models/digital_card_art_list_params.rb +9 -26
  119. data/lib/lithic/models/digital_card_art_retrieve_params.rb +3 -8
  120. data/lib/lithic/models/dispute.rb +27 -70
  121. data/lib/lithic/models/dispute_create_params.rb +12 -38
  122. data/lib/lithic/models/dispute_delete_evidence_params.rb +4 -9
  123. data/lib/lithic/models/dispute_delete_params.rb +3 -8
  124. data/lib/lithic/models/dispute_evidence.rb +15 -34
  125. data/lib/lithic/models/dispute_initiate_evidence_upload_params.rb +5 -14
  126. data/lib/lithic/models/dispute_list_evidences_params.rb +13 -38
  127. data/lib/lithic/models/dispute_list_params.rb +19 -67
  128. data/lib/lithic/models/dispute_retrieve_evidence_params.rb +4 -9
  129. data/lib/lithic/models/dispute_retrieve_params.rb +3 -8
  130. data/lib/lithic/models/dispute_update_params.rb +13 -37
  131. data/lib/lithic/models/document.rb +29 -62
  132. data/lib/lithic/models/event.rb +9 -16
  133. data/lib/lithic/models/event_list_attempts_params.rb +17 -60
  134. data/lib/lithic/models/event_list_params.rb +19 -67
  135. data/lib/lithic/models/event_retrieve_params.rb +3 -8
  136. data/lib/lithic/models/event_subscription.rb +10 -17
  137. data/lib/lithic/models/events/event_subscription_resend_params.rb +4 -9
  138. data/lib/lithic/models/events/subscription_create_params.rb +12 -32
  139. data/lib/lithic/models/events/subscription_delete_params.rb +3 -8
  140. data/lib/lithic/models/events/subscription_list_attempts_params.rb +17 -60
  141. data/lib/lithic/models/events/subscription_list_params.rb +9 -26
  142. data/lib/lithic/models/events/subscription_recover_params.rb +7 -20
  143. data/lib/lithic/models/events/subscription_replay_missing_params.rb +7 -20
  144. data/lib/lithic/models/events/subscription_retrieve_params.rb +3 -8
  145. data/lib/lithic/models/events/subscription_retrieve_secret_params.rb +3 -8
  146. data/lib/lithic/models/events/subscription_retrieve_secret_response.rb +3 -11
  147. data/lib/lithic/models/events/subscription_rotate_secret_params.rb +3 -8
  148. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +7 -19
  149. data/lib/lithic/models/events/subscription_update_params.rb +12 -32
  150. data/lib/lithic/models/external_bank_account_address.rb +8 -16
  151. data/lib/lithic/models/external_bank_account_create_params.rb +33 -99
  152. data/lib/lithic/models/external_bank_account_create_response.rb +42 -123
  153. data/lib/lithic/models/external_bank_account_list_params.rb +27 -91
  154. data/lib/lithic/models/external_bank_account_list_response.rb +42 -123
  155. data/lib/lithic/models/external_bank_account_retrieve_params.rb +3 -8
  156. data/lib/lithic/models/external_bank_account_retrieve_response.rb +42 -123
  157. data/lib/lithic/models/external_bank_account_retry_micro_deposits_params.rb +5 -14
  158. data/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +42 -123
  159. data/lib/lithic/models/external_bank_account_retry_prenote_params.rb +5 -14
  160. data/lib/lithic/models/external_bank_account_retry_prenote_response.rb +38 -113
  161. data/lib/lithic/models/external_bank_account_update_params.rb +23 -81
  162. data/lib/lithic/models/external_bank_account_update_response.rb +42 -123
  163. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_params.rb +4 -9
  164. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +42 -123
  165. data/lib/lithic/models/external_payment.rb +38 -88
  166. data/lib/lithic/models/external_payment_cancel_params.rb +6 -15
  167. data/lib/lithic/models/external_payment_create_params.rb +22 -66
  168. data/lib/lithic/models/external_payment_list_params.rb +29 -98
  169. data/lib/lithic/models/external_payment_release_params.rb +6 -15
  170. data/lib/lithic/models/external_payment_retrieve_params.rb +3 -8
  171. data/lib/lithic/models/external_payment_reverse_params.rb +6 -15
  172. data/lib/lithic/models/external_payment_settle_params.rb +10 -26
  173. data/lib/lithic/models/financial_account.rb +33 -81
  174. data/lib/lithic/models/financial_account_create_params.rb +13 -43
  175. data/lib/lithic/models/financial_account_list_params.rb +11 -31
  176. data/lib/lithic/models/financial_account_retrieve_params.rb +3 -8
  177. data/lib/lithic/models/financial_account_update_params.rb +5 -14
  178. data/lib/lithic/models/financial_account_update_status_params.rb +9 -20
  179. data/lib/lithic/models/financial_accounts/balance_list_params.rb +7 -20
  180. data/lib/lithic/models/financial_accounts/balance_list_response.rb +15 -36
  181. data/lib/lithic/models/financial_accounts/credit_configuration_retrieve_params.rb +3 -8
  182. data/lib/lithic/models/financial_accounts/credit_configuration_update_params.rb +11 -41
  183. data/lib/lithic/models/financial_accounts/financial_account_credit_config.rb +13 -35
  184. data/lib/lithic/models/financial_accounts/financial_transaction_list_params.rb +23 -77
  185. data/lib/lithic/models/financial_accounts/financial_transaction_retrieve_params.rb +4 -9
  186. data/lib/lithic/models/financial_accounts/loan_tape.rb +132 -269
  187. data/lib/lithic/models/financial_accounts/loan_tape_list_params.rb +13 -38
  188. data/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rb +4 -9
  189. data/lib/lithic/models/financial_accounts/statement.rb +87 -198
  190. data/lib/lithic/models/financial_accounts/statement_list_params.rb +15 -55
  191. data/lib/lithic/models/financial_accounts/statement_retrieve_params.rb +4 -9
  192. data/lib/lithic/models/financial_accounts/statements/line_item_list_params.rb +10 -27
  193. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +24 -60
  194. data/lib/lithic/models/financial_accounts/statements.rb +3 -7
  195. data/lib/lithic/models/financial_transaction.rb +34 -91
  196. data/lib/lithic/models/instance_financial_account_type.rb +4 -5
  197. data/lib/lithic/models/kyb.rb +73 -167
  198. data/lib/lithic/models/kyb_business_entity.rb +20 -50
  199. data/lib/lithic/models/kyc.rb +21 -40
  200. data/lib/lithic/models/kyc_exempt.rb +16 -47
  201. data/lib/lithic/models/management_operation_create_params.rb +34 -74
  202. data/lib/lithic/models/management_operation_list_params.rb +26 -86
  203. data/lib/lithic/models/management_operation_retrieve_params.rb +3 -8
  204. data/lib/lithic/models/management_operation_reverse_params.rb +6 -15
  205. data/lib/lithic/models/management_operation_transaction.rb +56 -110
  206. data/lib/lithic/models/message_attempt.rb +13 -32
  207. data/lib/lithic/models/owner_type.rb +2 -5
  208. data/lib/lithic/models/payment.rb +56 -129
  209. data/lib/lithic/models/payment_create_params.rb +23 -67
  210. data/lib/lithic/models/payment_create_response.rb +3 -11
  211. data/lib/lithic/models/payment_list_params.rb +31 -105
  212. data/lib/lithic/models/payment_retrieve_params.rb +3 -8
  213. data/lib/lithic/models/payment_retry_params.rb +3 -8
  214. data/lib/lithic/models/payment_retry_response.rb +3 -11
  215. data/lib/lithic/models/payment_simulate_action_params.rb +12 -31
  216. data/lib/lithic/models/payment_simulate_action_response.rb +6 -13
  217. data/lib/lithic/models/payment_simulate_receipt_params.rb +12 -24
  218. data/lib/lithic/models/payment_simulate_receipt_response.rb +6 -13
  219. data/lib/lithic/models/payment_simulate_release_params.rb +4 -9
  220. data/lib/lithic/models/payment_simulate_release_response.rb +6 -13
  221. data/lib/lithic/models/payment_simulate_return_params.rb +6 -15
  222. data/lib/lithic/models/payment_simulate_return_response.rb +6 -13
  223. data/lib/lithic/models/reports/settlement/network_total_list_params.rb +27 -95
  224. data/lib/lithic/models/reports/settlement/network_total_list_response.rb +21 -55
  225. data/lib/lithic/models/reports/settlement/network_total_retrieve_params.rb +3 -8
  226. data/lib/lithic/models/reports/settlement/network_total_retrieve_response.rb +21 -55
  227. data/lib/lithic/models/reports/settlement_list_details_params.rb +9 -26
  228. data/lib/lithic/models/reports/settlement_summary_params.rb +3 -8
  229. data/lib/lithic/models/required_document.rb +4 -8
  230. data/lib/lithic/models/responder_endpoint_check_status_params.rb +6 -14
  231. data/lib/lithic/models/responder_endpoint_create_params.rb +9 -25
  232. data/lib/lithic/models/responder_endpoint_create_response.rb +3 -11
  233. data/lib/lithic/models/responder_endpoint_delete_params.rb +6 -14
  234. data/lib/lithic/models/responder_endpoint_status.rb +4 -12
  235. data/lib/lithic/models/settlement_detail.rb +32 -79
  236. data/lib/lithic/models/settlement_report.rb +24 -31
  237. data/lib/lithic/models/settlement_summary_details.rb +19 -70
  238. data/lib/lithic/models/shipping_address.rb +16 -51
  239. data/lib/lithic/models/spend_limit_duration.rb +2 -5
  240. data/lib/lithic/models/three_ds/authentication_retrieve_params.rb +3 -8
  241. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +148 -312
  242. data/lib/lithic/models/three_ds/authentication_simulate_otp_entry_params.rb +5 -10
  243. data/lib/lithic/models/three_ds/authentication_simulate_params.rb +18 -38
  244. data/lib/lithic/models/three_ds/authentication_simulate_response.rb +3 -11
  245. data/lib/lithic/models/three_ds/challenge_response.rb +3 -7
  246. data/lib/lithic/models/three_ds/challenge_result.rb +2 -5
  247. data/lib/lithic/models/three_ds/decisioning_challenge_response_params.rb +3 -8
  248. data/lib/lithic/models/three_ds/decisioning_retrieve_secret_params.rb +3 -8
  249. data/lib/lithic/models/three_ds/decisioning_retrieve_secret_response.rb +3 -11
  250. data/lib/lithic/models/three_ds/decisioning_rotate_secret_params.rb +3 -8
  251. data/lib/lithic/models/tokenization.rb +35 -99
  252. data/lib/lithic/models/tokenization_activate_params.rb +3 -8
  253. data/lib/lithic/models/tokenization_deactivate_params.rb +3 -8
  254. data/lib/lithic/models/tokenization_decisioning_retrieve_secret_params.rb +3 -8
  255. data/lib/lithic/models/tokenization_decisioning_rotate_secret_params.rb +3 -8
  256. data/lib/lithic/models/tokenization_decisioning_rotate_secret_response.rb +3 -11
  257. data/lib/lithic/models/tokenization_list_params.rb +21 -74
  258. data/lib/lithic/models/tokenization_pause_params.rb +3 -8
  259. data/lib/lithic/models/tokenization_resend_activation_code_params.rb +7 -19
  260. data/lib/lithic/models/tokenization_retrieve_params.rb +3 -8
  261. data/lib/lithic/models/tokenization_retrieve_response.rb +3 -11
  262. data/lib/lithic/models/tokenization_secret.rb +3 -11
  263. data/lib/lithic/models/tokenization_simulate_params.rb +19 -59
  264. data/lib/lithic/models/tokenization_simulate_response.rb +3 -11
  265. data/lib/lithic/models/tokenization_unpause_params.rb +3 -8
  266. data/lib/lithic/models/tokenization_update_digital_card_art_params.rb +5 -14
  267. data/lib/lithic/models/tokenization_update_digital_card_art_response.rb +3 -11
  268. data/lib/lithic/models/transaction.rb +295 -413
  269. data/lib/lithic/models/transaction_expire_authorization_params.rb +3 -8
  270. data/lib/lithic/models/transaction_list_params.rb +25 -86
  271. data/lib/lithic/models/transaction_retrieve_params.rb +3 -8
  272. data/lib/lithic/models/transaction_simulate_authorization_advice_params.rb +5 -10
  273. data/lib/lithic/models/transaction_simulate_authorization_advice_response.rb +5 -17
  274. data/lib/lithic/models/transaction_simulate_authorization_params.rb +22 -73
  275. data/lib/lithic/models/transaction_simulate_authorization_response.rb +5 -17
  276. data/lib/lithic/models/transaction_simulate_clearing_params.rb +6 -15
  277. data/lib/lithic/models/transaction_simulate_clearing_response.rb +3 -11
  278. data/lib/lithic/models/transaction_simulate_credit_authorization_params.rb +10 -23
  279. data/lib/lithic/models/transaction_simulate_credit_authorization_response.rb +5 -17
  280. data/lib/lithic/models/transaction_simulate_return_params.rb +6 -11
  281. data/lib/lithic/models/transaction_simulate_return_response.rb +5 -17
  282. data/lib/lithic/models/transaction_simulate_return_reversal_params.rb +4 -9
  283. data/lib/lithic/models/transaction_simulate_return_reversal_response.rb +3 -11
  284. data/lib/lithic/models/transaction_simulate_void_params.rb +10 -26
  285. data/lib/lithic/models/transaction_simulate_void_response.rb +3 -11
  286. data/lib/lithic/models/transactions/enhanced_commercial_data_retrieve_params.rb +3 -8
  287. data/lib/lithic/models/transactions/enhanced_commercial_data_retrieve_response.rb +2 -6
  288. data/lib/lithic/models/transactions/events/enhanced_commercial_data_retrieve_params.rb +3 -8
  289. data/lib/lithic/models/transactions/events/enhanced_data.rb +68 -192
  290. data/lib/lithic/models/transfer.rb +49 -160
  291. data/lib/lithic/models/transfer_create_params.rb +10 -23
  292. data/lib/lithic/models/verification_method.rb +2 -5
  293. data/lib/lithic/request_options.rb +3 -4
  294. data/lib/lithic/resources/account_holders.rb +10 -8
  295. data/lib/lithic/resources/cards.rb +16 -16
  296. data/lib/lithic/version.rb +1 -1
  297. data/lib/lithic.rb +8 -10
  298. data/rbi/lib/lithic/client.rbi +4 -4
  299. data/rbi/lib/lithic/internal/type/array_of.rbi +3 -0
  300. data/rbi/lib/lithic/internal/type/base_model.rbi +15 -0
  301. data/rbi/lib/lithic/internal/type/base_page.rbi +2 -0
  302. data/rbi/lib/lithic/internal/type/enum.rbi +3 -6
  303. data/rbi/lib/lithic/internal/type/hash_of.rbi +3 -0
  304. data/rbi/lib/lithic/internal/type/union.rbi +3 -0
  305. data/rbi/lib/lithic/internal.rbi +0 -1
  306. data/rbi/lib/lithic/models/account.rbi +2 -3
  307. data/rbi/lib/lithic/models/account_financial_account_type.rbi +1 -2
  308. data/rbi/lib/lithic/models/account_holder.rbi +10 -13
  309. data/rbi/lib/lithic/models/account_holder_create_params.rbi +6 -7
  310. data/rbi/lib/lithic/models/account_holder_create_response.rbi +2 -4
  311. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rbi +2 -16
  312. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_params.rbi +2 -10
  313. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_response.rbi +10 -45
  314. data/rbi/lib/lithic/models/account_holder_update_params.rbi +4 -3
  315. data/rbi/lib/lithic/models/account_holder_update_response.rbi +10 -51
  316. data/rbi/lib/lithic/models/account_holder_upload_document_params.rbi +1 -2
  317. data/rbi/lib/lithic/models/account_update_params.rbi +1 -2
  318. data/rbi/lib/lithic/models/aggregate_balance.rbi +1 -2
  319. data/rbi/lib/lithic/models/aggregate_balance_list_params.rbi +1 -2
  320. data/rbi/lib/lithic/models/auth_rules/auth_rule.rbi +1 -2
  321. data/rbi/lib/lithic/models/auth_rules/auth_rule_condition.rbi +1 -2
  322. data/rbi/lib/lithic/models/auth_rules/conditional_attribute.rbi +1 -2
  323. data/rbi/lib/lithic/models/auth_rules/v2_apply_response.rbi +2 -4
  324. data/rbi/lib/lithic/models/auth_rules/v2_create_params.rbi +1 -2
  325. data/rbi/lib/lithic/models/auth_rules/v2_create_response.rbi +2 -4
  326. data/rbi/lib/lithic/models/auth_rules/v2_draft_response.rbi +2 -4
  327. data/rbi/lib/lithic/models/auth_rules/v2_list_response.rbi +2 -4
  328. data/rbi/lib/lithic/models/auth_rules/v2_promote_response.rbi +2 -4
  329. data/rbi/lib/lithic/models/auth_rules/v2_retrieve_response.rbi +2 -4
  330. data/rbi/lib/lithic/models/auth_rules/v2_update_params.rbi +1 -2
  331. data/rbi/lib/lithic/models/auth_rules/v2_update_response.rbi +2 -4
  332. data/rbi/lib/lithic/models/auth_rules/velocity_limit_params.rbi +2 -3
  333. data/rbi/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rbi +1 -2
  334. data/rbi/lib/lithic/models/balance.rbi +1 -2
  335. data/rbi/lib/lithic/models/balance_list_params.rbi +1 -2
  336. data/rbi/lib/lithic/models/book_transfer_create_params.rbi +2 -4
  337. data/rbi/lib/lithic/models/book_transfer_list_params.rbi +3 -6
  338. data/rbi/lib/lithic/models/book_transfer_response.rbi +5 -10
  339. data/rbi/lib/lithic/models/card_convert_physical_params.rbi +1 -2
  340. data/rbi/lib/lithic/models/card_convert_physical_response.rbi +467 -0
  341. data/rbi/lib/lithic/models/card_create_params.rbi +3 -4
  342. data/rbi/lib/lithic/models/card_create_response.rbi +458 -0
  343. data/rbi/lib/lithic/models/card_list_params.rbi +1 -1
  344. data/rbi/lib/lithic/models/card_list_response.rbi +435 -0
  345. data/rbi/lib/lithic/models/card_provision_params.rbi +1 -2
  346. data/rbi/lib/lithic/models/card_reissue_params.rbi +1 -2
  347. data/rbi/lib/lithic/models/card_reissue_response.rbi +458 -0
  348. data/rbi/lib/lithic/models/card_renew_params.rbi +1 -2
  349. data/rbi/lib/lithic/models/card_renew_response.rbi +457 -0
  350. data/rbi/lib/lithic/models/card_retrieve_response.rbi +459 -0
  351. data/rbi/lib/lithic/models/card_search_by_pan_response.rbi +461 -0
  352. data/rbi/lib/lithic/models/card_update_params.rbi +2 -3
  353. data/rbi/lib/lithic/models/card_update_response.rbi +458 -0
  354. data/rbi/lib/lithic/models/cards/balance_list_response.rbi +1 -2
  355. data/rbi/lib/lithic/models/cards/financial_transaction_list_params.rbi +3 -6
  356. data/rbi/lib/lithic/models/digital_card_art.rbi +1 -2
  357. data/rbi/lib/lithic/models/dispute.rbi +3 -11
  358. data/rbi/lib/lithic/models/dispute_create_params.rbi +1 -2
  359. data/rbi/lib/lithic/models/dispute_evidence.rbi +1 -2
  360. data/rbi/lib/lithic/models/dispute_list_params.rbi +1 -2
  361. data/rbi/lib/lithic/models/dispute_update_params.rbi +1 -2
  362. data/rbi/lib/lithic/models/document.rbi +4 -7
  363. data/rbi/lib/lithic/models/event.rbi +1 -1
  364. data/rbi/lib/lithic/models/event_list_attempts_params.rbi +1 -2
  365. data/rbi/lib/lithic/models/event_list_params.rbi +1 -2
  366. data/rbi/lib/lithic/models/event_subscription.rbi +1 -2
  367. data/rbi/lib/lithic/models/events/subscription_create_params.rbi +1 -2
  368. data/rbi/lib/lithic/models/events/subscription_list_attempts_params.rbi +1 -2
  369. data/rbi/lib/lithic/models/events/subscription_send_simulated_example_params.rbi +1 -8
  370. data/rbi/lib/lithic/models/events/subscription_update_params.rbi +1 -2
  371. data/rbi/lib/lithic/models/external_bank_account_create_params.rbi +2 -4
  372. data/rbi/lib/lithic/models/external_bank_account_create_response.rbi +5 -10
  373. data/rbi/lib/lithic/models/external_bank_account_list_params.rbi +3 -6
  374. data/rbi/lib/lithic/models/external_bank_account_list_response.rbi +5 -10
  375. data/rbi/lib/lithic/models/external_bank_account_retrieve_response.rbi +5 -22
  376. data/rbi/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +5 -28
  377. data/rbi/lib/lithic/models/external_bank_account_retry_prenote_response.rbi +3 -12
  378. data/rbi/lib/lithic/models/external_bank_account_update_params.rbi +1 -2
  379. data/rbi/lib/lithic/models/external_bank_account_update_response.rbi +5 -10
  380. data/rbi/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +5 -40
  381. data/rbi/lib/lithic/models/external_payment.rbi +7 -12
  382. data/rbi/lib/lithic/models/external_payment_create_params.rbi +3 -6
  383. data/rbi/lib/lithic/models/external_payment_list_params.rbi +3 -6
  384. data/rbi/lib/lithic/models/external_payment_settle_params.rbi +1 -2
  385. data/rbi/lib/lithic/models/financial_account.rbi +7 -20
  386. data/rbi/lib/lithic/models/financial_account_create_params.rbi +1 -2
  387. data/rbi/lib/lithic/models/financial_account_list_params.rbi +1 -2
  388. data/rbi/lib/lithic/models/financial_account_update_status_params.rbi +2 -4
  389. data/rbi/lib/lithic/models/financial_accounts/balance_list_response.rbi +1 -2
  390. data/rbi/lib/lithic/models/financial_accounts/financial_account_credit_config.rbi +2 -16
  391. data/rbi/lib/lithic/models/financial_accounts/financial_transaction_list_params.rbi +3 -24
  392. data/rbi/lib/lithic/models/financial_accounts/loan_tape.rbi +4 -32
  393. data/rbi/lib/lithic/models/financial_accounts/statement.rbi +5 -34
  394. data/rbi/lib/lithic/models/financial_accounts/statements/statement_line_items.rbi +12 -16
  395. data/rbi/lib/lithic/models/financial_transaction.rbi +7 -10
  396. data/rbi/lib/lithic/models/instance_financial_account_type.rbi +4 -2
  397. data/rbi/lib/lithic/models/kyb.rbi +5 -4
  398. data/rbi/lib/lithic/models/kyc.rbi +1 -1
  399. data/rbi/lib/lithic/models/kyc_exempt.rbi +2 -3
  400. data/rbi/lib/lithic/models/management_operation_create_params.rbi +22 -16
  401. data/rbi/lib/lithic/models/management_operation_list_params.rbi +4 -4
  402. data/rbi/lib/lithic/models/management_operation_transaction.rbi +26 -24
  403. data/rbi/lib/lithic/models/message_attempt.rbi +1 -1
  404. data/rbi/lib/lithic/models/owner_type.rbi +1 -1
  405. data/rbi/lib/lithic/models/payment.rbi +10 -12
  406. data/rbi/lib/lithic/models/payment_create_params.rbi +3 -6
  407. data/rbi/lib/lithic/models/payment_list_params.rbi +3 -6
  408. data/rbi/lib/lithic/models/payment_simulate_action_params.rbi +2 -4
  409. data/rbi/lib/lithic/models/payment_simulate_action_response.rbi +1 -2
  410. data/rbi/lib/lithic/models/payment_simulate_receipt_params.rbi +2 -3
  411. data/rbi/lib/lithic/models/payment_simulate_receipt_response.rbi +1 -2
  412. data/rbi/lib/lithic/models/payment_simulate_release_response.rbi +1 -2
  413. data/rbi/lib/lithic/models/payment_simulate_return_response.rbi +1 -2
  414. data/rbi/lib/lithic/models/reports/settlement/network_total_list_params.rbi +1 -2
  415. data/rbi/lib/lithic/models/reports/settlement/network_total_list_response.rbi +1 -8
  416. data/rbi/lib/lithic/models/reports/settlement/network_total_retrieve_response.rbi +1 -8
  417. data/rbi/lib/lithic/models/responder_endpoint_check_status_params.rbi +1 -2
  418. data/rbi/lib/lithic/models/responder_endpoint_create_params.rbi +1 -2
  419. data/rbi/lib/lithic/models/responder_endpoint_delete_params.rbi +1 -2
  420. data/rbi/lib/lithic/models/settlement_detail.rbi +2 -3
  421. data/rbi/lib/lithic/models/settlement_summary_details.rbi +1 -2
  422. data/rbi/lib/lithic/models/spend_limit_duration.rbi +1 -1
  423. data/rbi/lib/lithic/models/three_ds/authentication_retrieve_response.rbi +17 -124
  424. data/rbi/lib/lithic/models/three_ds/authentication_simulate_params.rbi +1 -8
  425. data/rbi/lib/lithic/models/three_ds/challenge_result.rbi +1 -1
  426. data/rbi/lib/lithic/models/tokenization.rbi +5 -9
  427. data/rbi/lib/lithic/models/tokenization_list_params.rbi +1 -2
  428. data/rbi/lib/lithic/models/tokenization_resend_activation_code_params.rbi +1 -8
  429. data/rbi/lib/lithic/models/tokenization_simulate_params.rbi +2 -4
  430. data/rbi/lib/lithic/models/transaction.rbi +184 -68
  431. data/rbi/lib/lithic/models/transaction_list_params.rbi +2 -4
  432. data/rbi/lib/lithic/models/transaction_simulate_authorization_params.rbi +1 -2
  433. data/rbi/lib/lithic/models/transaction_simulate_void_params.rbi +1 -2
  434. data/rbi/lib/lithic/models/transactions/events/enhanced_data.rbi +4 -26
  435. data/rbi/lib/lithic/models/transfer.rbi +7 -5
  436. data/rbi/lib/lithic/models/verification_method.rbi +1 -1
  437. data/rbi/lib/lithic/resources/account_holders.rbi +18 -14
  438. data/rbi/lib/lithic/resources/cards.rbi +8 -8
  439. data/rbi/lib/lithic/resources/payments.rbi +1 -1
  440. data/sig/lithic/internal/type/array_of.rbs +2 -0
  441. data/sig/lithic/internal/type/base_model.rbs +10 -0
  442. data/sig/lithic/internal/type/enum.rbs +2 -2
  443. data/sig/lithic/internal/type/hash_of.rbs +2 -0
  444. data/sig/lithic/internal/type/union.rbs +2 -0
  445. data/sig/lithic/models/card_convert_physical_response.rbs +257 -0
  446. data/sig/lithic/models/card_create_response.rbs +257 -0
  447. data/sig/lithic/models/card_list_response.rbs +245 -0
  448. data/sig/lithic/models/card_reissue_response.rbs +257 -0
  449. data/sig/lithic/models/{card.rbs → card_renew_response.rbs} +45 -30
  450. data/sig/lithic/models/card_retrieve_response.rbs +257 -0
  451. data/sig/lithic/models/card_search_by_pan_response.rbs +257 -0
  452. data/sig/lithic/models/card_update_response.rbs +257 -0
  453. data/sig/lithic/models/dispute.rbs +0 -4
  454. data/sig/lithic/models/financial_account.rbs +4 -0
  455. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +4 -0
  456. data/sig/lithic/models/financial_transaction.rbs +2 -0
  457. data/sig/lithic/models/instance_financial_account_type.rbs +4 -0
  458. data/sig/lithic/models/management_operation_create_params.rbs +23 -13
  459. data/sig/lithic/models/management_operation_list_params.rbs +2 -0
  460. data/sig/lithic/models/management_operation_transaction.rbs +23 -13
  461. data/sig/lithic/models/transaction.rbs +87 -4
  462. data/sig/lithic/models/transfer.rbs +2 -0
  463. data/sig/lithic/resources/cards.rbs +8 -8
  464. metadata +26 -5
  465. data/lib/lithic/models/card.rb +0 -524
  466. data/rbi/lib/lithic/models/card.rbi +0 -487
@@ -0,0 +1,376 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ # @see Lithic::Resources::Cards#list
6
+ class CardListResponse < Lithic::Internal::Type::BaseModel
7
+ # @!attribute token
8
+ # Globally unique identifier.
9
+ #
10
+ # @return [String]
11
+ required :token, String
12
+
13
+ # @!attribute account_token
14
+ # Globally unique identifier for the account to which the card belongs.
15
+ #
16
+ # @return [String]
17
+ required :account_token, String
18
+
19
+ # @!attribute card_program_token
20
+ # Globally unique identifier for the card program on which the card exists.
21
+ #
22
+ # @return [String]
23
+ required :card_program_token, String
24
+
25
+ # @!attribute created
26
+ # An RFC 3339 timestamp for when the card was created. UTC time zone.
27
+ #
28
+ # @return [Time]
29
+ required :created, Time
30
+
31
+ # @!attribute funding
32
+ # Deprecated: Funding account for the card.
33
+ #
34
+ # @return [Lithic::Models::CardListResponse::Funding]
35
+ required :funding, -> { Lithic::Models::CardListResponse::Funding }
36
+
37
+ # @!attribute last_four
38
+ # Last four digits of the card number.
39
+ #
40
+ # @return [String]
41
+ required :last_four, String
42
+
43
+ # @!attribute pin_status
44
+ # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
45
+ # attempts).
46
+ #
47
+ # @return [Symbol, Lithic::Models::CardListResponse::PinStatus]
48
+ required :pin_status, enum: -> { Lithic::Models::CardListResponse::PinStatus }
49
+
50
+ # @!attribute spend_limit
51
+ # Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
52
+ # $1,000 limit). Transaction requests above the spend limit will be declined.
53
+ #
54
+ # @return [Integer]
55
+ required :spend_limit, Integer
56
+
57
+ # @!attribute spend_limit_duration
58
+ # Spend limit duration
59
+ #
60
+ # @return [Symbol, Lithic::Models::CardListResponse::SpendLimitDuration]
61
+ required :spend_limit_duration, enum: -> { Lithic::Models::CardListResponse::SpendLimitDuration }
62
+
63
+ # @!attribute state
64
+ # Card state values: _ `CLOSED` - Card will no longer approve authorizations.
65
+ # Closing a card cannot be undone. _ `OPEN` - Card will approve authorizations (if
66
+ # they match card and account parameters). _ `PAUSED` - Card will decline
67
+ # authorizations, but can be resumed at a later time. _ `PENDING_FULFILLMENT` -
68
+ # The initial state for cards of type `PHYSICAL`. The card is provisioned pending
69
+ # manufacturing and fulfillment. Cards in this state can accept authorizations for
70
+ # e-commerce purchases, but not for "Card Present" purchases where the physical
71
+ # card itself is present. \* `PENDING_ACTIVATION` - At regular intervals, cards of
72
+ # type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card production
73
+ # warehouse and updated to state `PENDING_ACTIVATION`. Similar to
74
+ # `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce
75
+ # transactions or can be added to mobile wallets. API clients should update the
76
+ # card's state to `OPEN` only after the cardholder confirms receipt of the card.
77
+ # In sandbox, the same daily batch fulfillment occurs, but no cards are actually
78
+ # manufactured.
79
+ #
80
+ # @return [Symbol, Lithic::Models::CardListResponse::State]
81
+ required :state, enum: -> { Lithic::Models::CardListResponse::State }
82
+
83
+ # @!attribute type
84
+ # Card types: _ `VIRTUAL` - Card will authorize at any merchant and can be added
85
+ # to a digital wallet like Apple Pay or Google Pay (if the card program is digital
86
+ # wallet-enabled). _ `PHYSICAL` - Manufactured and sent to the cardholder. We
87
+ # offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe
88
+ # functionality. _ `SINGLE_USE` - Card is closed upon first successful
89
+ # authorization. _ `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first
90
+ # merchant that successfully authorizes the card. _ `UNLOCKED` - _[Deprecated]_
91
+ # Similar behavior to VIRTUAL cards, please use VIRTUAL instead. _
92
+ # `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use
93
+ # VIRTUAL instead.
94
+ #
95
+ # @return [Symbol, Lithic::Models::CardListResponse::Type]
96
+ required :type, enum: -> { Lithic::Models::CardListResponse::Type }
97
+
98
+ # @!attribute auth_rule_tokens
99
+ # @deprecated
100
+ #
101
+ # List of identifiers for the Auth Rule(s) that are applied on the card. This
102
+ # field is deprecated and will no longer be populated in the `Card` object. The
103
+ # key will be removed from the schema in a future release. Use the `/auth_rules`
104
+ # endpoints to fetch Auth Rule information instead.
105
+ #
106
+ # @return [Array<String>, nil]
107
+ optional :auth_rule_tokens, Lithic::Internal::Type::ArrayOf[String]
108
+
109
+ # @!attribute cardholder_currency
110
+ # 3-character alphabetic ISO 4217 code for the currency of the cardholder.
111
+ #
112
+ # @return [String, nil]
113
+ optional :cardholder_currency, String
114
+
115
+ # @!attribute digital_card_art_token
116
+ # Specifies the digital card art to be displayed in the user's digital wallet
117
+ # after tokenization. This artwork must be approved by Mastercard and configured
118
+ # by Lithic to use.
119
+ #
120
+ # @return [String, nil]
121
+ optional :digital_card_art_token, String
122
+
123
+ # @!attribute exp_month
124
+ # Two digit (MM) expiry month.
125
+ #
126
+ # @return [String, nil]
127
+ optional :exp_month, String
128
+
129
+ # @!attribute exp_year
130
+ # Four digit (yyyy) expiry year.
131
+ #
132
+ # @return [String, nil]
133
+ optional :exp_year, String
134
+
135
+ # @!attribute hostname
136
+ # Hostname of card's locked merchant (will be empty if not applicable).
137
+ #
138
+ # @return [String, nil]
139
+ optional :hostname, String
140
+
141
+ # @!attribute memo
142
+ # Friendly name to identify the card.
143
+ #
144
+ # @return [String, nil]
145
+ optional :memo, String
146
+
147
+ # @!attribute pending_commands
148
+ # Indicates if there are offline PIN changes pending card interaction with an
149
+ # offline PIN terminal. Possible commands are: CHANGE_PIN, UNBLOCK_PIN. Applicable
150
+ # only to cards issued in markets supporting offline PINs.
151
+ #
152
+ # @return [Array<String>, nil]
153
+ optional :pending_commands, Lithic::Internal::Type::ArrayOf[String]
154
+
155
+ # @!attribute product_id
156
+ # Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic
157
+ # before use. Specifies the configuration (i.e., physical card art) that the card
158
+ # should be manufactured with.
159
+ #
160
+ # @return [String, nil]
161
+ optional :product_id, String
162
+
163
+ # @!attribute replacement_for
164
+ # If the card is a replacement for another card, the globally unique identifier
165
+ # for the card that was replaced.
166
+ #
167
+ # @return [String, nil]
168
+ optional :replacement_for, String, nil?: true
169
+
170
+ # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, cardholder_currency: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, pending_commands: nil, product_id: nil, replacement_for: nil)
171
+ # Card details without PCI information
172
+ #
173
+ # @param token [String]
174
+ # @param account_token [String]
175
+ # @param card_program_token [String]
176
+ # @param created [Time]
177
+ # @param funding [Lithic::Models::CardListResponse::Funding]
178
+ # @param last_four [String]
179
+ # @param pin_status [Symbol, Lithic::Models::CardListResponse::PinStatus]
180
+ # @param spend_limit [Integer]
181
+ # @param spend_limit_duration [Symbol, Lithic::Models::CardListResponse::SpendLimitDuration]
182
+ # @param state [Symbol, Lithic::Models::CardListResponse::State]
183
+ # @param type [Symbol, Lithic::Models::CardListResponse::Type]
184
+ # @param auth_rule_tokens [Array<String>]
185
+ # @param cardholder_currency [String]
186
+ # @param digital_card_art_token [String]
187
+ # @param exp_month [String]
188
+ # @param exp_year [String]
189
+ # @param hostname [String]
190
+ # @param memo [String]
191
+ # @param pending_commands [Array<String>]
192
+ # @param product_id [String]
193
+ # @param replacement_for [String, nil]
194
+
195
+ # @see Lithic::Models::CardListResponse#funding
196
+ class Funding < Lithic::Internal::Type::BaseModel
197
+ # @!attribute token
198
+ # A globally unique identifier for this FundingAccount.
199
+ #
200
+ # @return [String]
201
+ required :token, String
202
+
203
+ # @!attribute created
204
+ # An RFC 3339 string representing when this funding source was added to the Lithic
205
+ # account. This may be `null`. UTC time zone.
206
+ #
207
+ # @return [Time]
208
+ required :created, Time
209
+
210
+ # @!attribute last_four
211
+ # The last 4 digits of the account (e.g. bank account, debit card) associated with
212
+ # this FundingAccount. This may be null.
213
+ #
214
+ # @return [String]
215
+ required :last_four, String
216
+
217
+ # @!attribute state
218
+ # State of funding source. Funding source states: _ `ENABLED` - The funding
219
+ # account is available to use for card creation and transactions. _ `PENDING` -
220
+ # The funding account is still being verified e.g. bank micro-deposits
221
+ # verification. \* `DELETED` - The founding account has been deleted.
222
+ #
223
+ # @return [Symbol, Lithic::Models::CardListResponse::Funding::State]
224
+ required :state, enum: -> { Lithic::Models::CardListResponse::Funding::State }
225
+
226
+ # @!attribute type
227
+ # Types of funding source: _ `DEPOSITORY_CHECKING` - Bank checking account. _
228
+ # `DEPOSITORY_SAVINGS` - Bank savings account.
229
+ #
230
+ # @return [Symbol, Lithic::Models::CardListResponse::Funding::Type]
231
+ required :type, enum: -> { Lithic::Models::CardListResponse::Funding::Type }
232
+
233
+ # @!attribute account_name
234
+ # Account name identifying the funding source. This may be `null`.
235
+ #
236
+ # @return [String, nil]
237
+ optional :account_name, String
238
+
239
+ # @!attribute nickname
240
+ # The nickname given to the `FundingAccount` or `null` if it has no nickname.
241
+ #
242
+ # @return [String, nil]
243
+ optional :nickname, String
244
+
245
+ # @!method initialize(token:, created:, last_four:, state:, type:, account_name: nil, nickname: nil)
246
+ # Deprecated: Funding account for the card.
247
+ #
248
+ # @param token [String]
249
+ # @param created [Time]
250
+ # @param last_four [String]
251
+ # @param state [Symbol, Lithic::Models::CardListResponse::Funding::State]
252
+ # @param type [Symbol, Lithic::Models::CardListResponse::Funding::Type]
253
+ # @param account_name [String]
254
+ # @param nickname [String]
255
+
256
+ # State of funding source. Funding source states: _ `ENABLED` - The funding
257
+ # account is available to use for card creation and transactions. _ `PENDING` -
258
+ # The funding account is still being verified e.g. bank micro-deposits
259
+ # verification. \* `DELETED` - The founding account has been deleted.
260
+ #
261
+ # @see Lithic::Models::CardListResponse::Funding#state
262
+ module State
263
+ extend Lithic::Internal::Type::Enum
264
+
265
+ DELETED = :DELETED
266
+ ENABLED = :ENABLED
267
+ PENDING = :PENDING
268
+
269
+ # @!method self.values
270
+ # @return [Array<Symbol>]
271
+ end
272
+
273
+ # Types of funding source: _ `DEPOSITORY_CHECKING` - Bank checking account. _
274
+ # `DEPOSITORY_SAVINGS` - Bank savings account.
275
+ #
276
+ # @see Lithic::Models::CardListResponse::Funding#type
277
+ module Type
278
+ extend Lithic::Internal::Type::Enum
279
+
280
+ DEPOSITORY_CHECKING = :DEPOSITORY_CHECKING
281
+ DEPOSITORY_SAVINGS = :DEPOSITORY_SAVINGS
282
+
283
+ # @!method self.values
284
+ # @return [Array<Symbol>]
285
+ end
286
+ end
287
+
288
+ # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
289
+ # attempts).
290
+ #
291
+ # @see Lithic::Models::CardListResponse#pin_status
292
+ module PinStatus
293
+ extend Lithic::Internal::Type::Enum
294
+
295
+ OK = :OK
296
+ BLOCKED = :BLOCKED
297
+ NOT_SET = :NOT_SET
298
+
299
+ # @!method self.values
300
+ # @return [Array<Symbol>]
301
+ end
302
+
303
+ # Spend limit duration
304
+ #
305
+ # @see Lithic::Models::CardListResponse#spend_limit_duration
306
+ module SpendLimitDuration
307
+ extend Lithic::Internal::Type::Enum
308
+
309
+ ANNUALLY = :ANNUALLY
310
+ FOREVER = :FOREVER
311
+ MONTHLY = :MONTHLY
312
+ TRANSACTION = :TRANSACTION
313
+ DAILY = :DAILY
314
+
315
+ # @!method self.values
316
+ # @return [Array<Symbol>]
317
+ end
318
+
319
+ # Card state values: _ `CLOSED` - Card will no longer approve authorizations.
320
+ # Closing a card cannot be undone. _ `OPEN` - Card will approve authorizations (if
321
+ # they match card and account parameters). _ `PAUSED` - Card will decline
322
+ # authorizations, but can be resumed at a later time. _ `PENDING_FULFILLMENT` -
323
+ # The initial state for cards of type `PHYSICAL`. The card is provisioned pending
324
+ # manufacturing and fulfillment. Cards in this state can accept authorizations for
325
+ # e-commerce purchases, but not for "Card Present" purchases where the physical
326
+ # card itself is present. \* `PENDING_ACTIVATION` - At regular intervals, cards of
327
+ # type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card production
328
+ # warehouse and updated to state `PENDING_ACTIVATION`. Similar to
329
+ # `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce
330
+ # transactions or can be added to mobile wallets. API clients should update the
331
+ # card's state to `OPEN` only after the cardholder confirms receipt of the card.
332
+ # In sandbox, the same daily batch fulfillment occurs, but no cards are actually
333
+ # manufactured.
334
+ #
335
+ # @see Lithic::Models::CardListResponse#state
336
+ module State
337
+ extend Lithic::Internal::Type::Enum
338
+
339
+ CLOSED = :CLOSED
340
+ OPEN = :OPEN
341
+ PAUSED = :PAUSED
342
+ PENDING_ACTIVATION = :PENDING_ACTIVATION
343
+ PENDING_FULFILLMENT = :PENDING_FULFILLMENT
344
+
345
+ # @!method self.values
346
+ # @return [Array<Symbol>]
347
+ end
348
+
349
+ # Card types: _ `VIRTUAL` - Card will authorize at any merchant and can be added
350
+ # to a digital wallet like Apple Pay or Google Pay (if the card program is digital
351
+ # wallet-enabled). _ `PHYSICAL` - Manufactured and sent to the cardholder. We
352
+ # offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe
353
+ # functionality. _ `SINGLE_USE` - Card is closed upon first successful
354
+ # authorization. _ `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first
355
+ # merchant that successfully authorizes the card. _ `UNLOCKED` - _[Deprecated]_
356
+ # Similar behavior to VIRTUAL cards, please use VIRTUAL instead. _
357
+ # `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use
358
+ # VIRTUAL instead.
359
+ #
360
+ # @see Lithic::Models::CardListResponse#type
361
+ module Type
362
+ extend Lithic::Internal::Type::Enum
363
+
364
+ MERCHANT_LOCKED = :MERCHANT_LOCKED
365
+ PHYSICAL = :PHYSICAL
366
+ SINGLE_USE = :SINGLE_USE
367
+ VIRTUAL = :VIRTUAL
368
+ UNLOCKED = :UNLOCKED
369
+ DIGITAL_WALLET = :DIGITAL_WALLET
370
+
371
+ # @!method self.values
372
+ # @return [Array<Symbol>]
373
+ end
374
+ end
375
+ end
376
+ end
@@ -34,50 +34,27 @@ module Lithic
34
34
  # @return [String]
35
35
  required :pan_range_start, String
36
36
 
37
- # @!attribute [r] cardholder_currency
37
+ # @!attribute cardholder_currency
38
38
  # 3-character alphabetic ISO 4217 code for the currency of the cardholder.
39
39
  #
40
40
  # @return [String, nil]
41
41
  optional :cardholder_currency, String
42
42
 
43
- # @!parse
44
- # # @return [String]
45
- # attr_writer :cardholder_currency
46
-
47
- # @!attribute [r] settlement_currencies
43
+ # @!attribute settlement_currencies
48
44
  # List of 3-character alphabetic ISO 4217 codes for the currencies that the card
49
45
  # program supports for settlement.
50
46
  #
51
47
  # @return [Array<String>, nil]
52
48
  optional :settlement_currencies, Lithic::Internal::Type::ArrayOf[String]
53
49
 
54
- # @!parse
55
- # # @return [Array<String>]
56
- # attr_writer :settlement_currencies
57
-
58
- # @!parse
59
- # # @param token [String]
60
- # # @param created [Time]
61
- # # @param name [String]
62
- # # @param pan_range_end [String]
63
- # # @param pan_range_start [String]
64
- # # @param cardholder_currency [String]
65
- # # @param settlement_currencies [Array<String>]
66
- # #
67
- # def initialize(
68
- # token:,
69
- # created:,
70
- # name:,
71
- # pan_range_end:,
72
- # pan_range_start:,
73
- # cardholder_currency: nil,
74
- # settlement_currencies: nil,
75
- # **
76
- # )
77
- # super
78
- # end
79
-
80
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
50
+ # @!method initialize(token:, created:, name:, pan_range_end:, pan_range_start:, cardholder_currency: nil, settlement_currencies: nil)
51
+ # @param token [String]
52
+ # @param created [Time]
53
+ # @param name [String]
54
+ # @param pan_range_end [String]
55
+ # @param pan_range_start [String]
56
+ # @param cardholder_currency [String]
57
+ # @param settlement_currencies [Array<String>]
81
58
  end
82
59
  end
83
60
  end
@@ -4,51 +4,34 @@ module Lithic
4
4
  module Models
5
5
  # @see Lithic::Resources::CardPrograms#list
6
6
  class CardProgramListParams < Lithic::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Lithic::Internal::Type::RequestParameters::Converter
7
+ extend Lithic::Internal::Type::RequestParameters::Converter
9
8
  include Lithic::Internal::Type::RequestParameters
10
9
 
11
- # @!attribute [r] ending_before
10
+ # @!attribute ending_before
12
11
  # A cursor representing an item's token before which a page of results should end.
13
12
  # Used to retrieve the previous page of results before this item.
14
13
  #
15
14
  # @return [String, nil]
16
15
  optional :ending_before, String
17
16
 
18
- # @!parse
19
- # # @return [String]
20
- # attr_writer :ending_before
21
-
22
- # @!attribute [r] page_size
17
+ # @!attribute page_size
23
18
  # Page size (for pagination).
24
19
  #
25
20
  # @return [Integer, nil]
26
21
  optional :page_size, Integer
27
22
 
28
- # @!parse
29
- # # @return [Integer]
30
- # attr_writer :page_size
31
-
32
- # @!attribute [r] starting_after
23
+ # @!attribute starting_after
33
24
  # A cursor representing an item's token after which a page of results should
34
25
  # begin. Used to retrieve the next page of results after this item.
35
26
  #
36
27
  # @return [String, nil]
37
28
  optional :starting_after, String
38
29
 
39
- # @!parse
40
- # # @return [String]
41
- # attr_writer :starting_after
42
-
43
- # @!parse
44
- # # @param ending_before [String]
45
- # # @param page_size [Integer]
46
- # # @param starting_after [String]
47
- # # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
48
- # #
49
- # def initialize(ending_before: nil, page_size: nil, starting_after: nil, request_options: {}, **) = super
50
-
51
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
30
+ # @!method initialize(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
31
+ # @param ending_before [String]
32
+ # @param page_size [Integer]
33
+ # @param starting_after [String]
34
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
52
35
  end
53
36
  end
54
37
  end
@@ -4,16 +4,11 @@ module Lithic
4
4
  module Models
5
5
  # @see Lithic::Resources::CardPrograms#retrieve
6
6
  class CardProgramRetrieveParams < Lithic::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Lithic::Internal::Type::RequestParameters::Converter
7
+ extend Lithic::Internal::Type::RequestParameters::Converter
9
8
  include Lithic::Internal::Type::RequestParameters
10
9
 
11
- # @!parse
12
- # # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
13
- # #
14
- # def initialize(request_options: {}, **) = super
15
-
16
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
17
12
  end
18
13
  end
19
14
  end
@@ -4,11 +4,10 @@ module Lithic
4
4
  module Models
5
5
  # @see Lithic::Resources::Cards#provision
6
6
  class CardProvisionParams < Lithic::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Lithic::Internal::Type::RequestParameters::Converter
7
+ extend Lithic::Internal::Type::RequestParameters::Converter
9
8
  include Lithic::Internal::Type::RequestParameters
10
9
 
11
- # @!attribute [r] certificate
10
+ # @!attribute certificate
12
11
  # Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only
13
12
  # `activationData` in the response. Apple's public leaf certificate. Base64
14
13
  # encoded in PEM format with headers `(-----BEGIN CERTIFICATE-----)` and trailers
@@ -17,11 +16,7 @@ module Lithic
17
16
  # @return [String, nil]
18
17
  optional :certificate, String
19
18
 
20
- # @!parse
21
- # # @return [String]
22
- # attr_writer :certificate
23
-
24
- # @!attribute [r] client_device_id
19
+ # @!attribute client_device_id
25
20
  # Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the
26
21
  # card is on the Visa network. Stable device identification set by the wallet
27
22
  # provider.
@@ -29,11 +24,7 @@ module Lithic
29
24
  # @return [String, nil]
30
25
  optional :client_device_id, String
31
26
 
32
- # @!parse
33
- # # @return [String]
34
- # attr_writer :client_device_id
35
-
36
- # @!attribute [r] client_wallet_account_id
27
+ # @!attribute client_wallet_account_id
37
28
  # Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the
38
29
  # card is on the Visa network. Consumer ID that identifies the wallet account
39
30
  # holder entity.
@@ -41,21 +32,13 @@ module Lithic
41
32
  # @return [String, nil]
42
33
  optional :client_wallet_account_id, String
43
34
 
44
- # @!parse
45
- # # @return [String]
46
- # attr_writer :client_wallet_account_id
47
-
48
- # @!attribute [r] digital_wallet
35
+ # @!attribute digital_wallet
49
36
  # Name of digital wallet provider.
50
37
  #
51
38
  # @return [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet, nil]
52
39
  optional :digital_wallet, enum: -> { Lithic::Models::CardProvisionParams::DigitalWallet }
53
40
 
54
- # @!parse
55
- # # @return [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet]
56
- # attr_writer :digital_wallet
57
-
58
- # @!attribute [r] nonce
41
+ # @!attribute nonce
59
42
  # Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only
60
43
  # `activationData` in the response. Base64 cryptographic nonce provided by the
61
44
  # device's wallet.
@@ -63,11 +46,7 @@ module Lithic
63
46
  # @return [String, nil]
64
47
  optional :nonce, String
65
48
 
66
- # @!parse
67
- # # @return [String]
68
- # attr_writer :nonce
69
-
70
- # @!attribute [r] nonce_signature
49
+ # @!attribute nonce_signature
71
50
  # Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only
72
51
  # `activationData` in the response. Base64 cryptographic nonce provided by the
73
52
  # device's wallet.
@@ -75,33 +54,14 @@ module Lithic
75
54
  # @return [String, nil]
76
55
  optional :nonce_signature, String
77
56
 
78
- # @!parse
79
- # # @return [String]
80
- # attr_writer :nonce_signature
81
-
82
- # @!parse
83
- # # @param certificate [String]
84
- # # @param client_device_id [String]
85
- # # @param client_wallet_account_id [String]
86
- # # @param digital_wallet [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet]
87
- # # @param nonce [String]
88
- # # @param nonce_signature [String]
89
- # # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
90
- # #
91
- # def initialize(
92
- # certificate: nil,
93
- # client_device_id: nil,
94
- # client_wallet_account_id: nil,
95
- # digital_wallet: nil,
96
- # nonce: nil,
97
- # nonce_signature: nil,
98
- # request_options: {},
99
- # **
100
- # )
101
- # super
102
- # end
103
-
104
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
57
+ # @!method initialize(certificate: nil, client_device_id: nil, client_wallet_account_id: nil, digital_wallet: nil, nonce: nil, nonce_signature: nil, request_options: {})
58
+ # @param certificate [String]
59
+ # @param client_device_id [String]
60
+ # @param client_wallet_account_id [String]
61
+ # @param digital_wallet [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet]
62
+ # @param nonce [String]
63
+ # @param nonce_signature [String]
64
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
105
65
 
106
66
  # Name of digital wallet provider.
107
67
  module DigitalWallet
@@ -111,11 +71,8 @@ module Lithic
111
71
  GOOGLE_PAY = :GOOGLE_PAY
112
72
  SAMSUNG_PAY = :SAMSUNG_PAY
113
73
 
114
- finalize!
115
-
116
- # @!parse
117
- # # @return [Array<Symbol>]
118
- # def self.values; end
74
+ # @!method self.values
75
+ # @return [Array<Symbol>]
119
76
  end
120
77
  end
121
78
  end
@@ -4,21 +4,13 @@ module Lithic
4
4
  module Models
5
5
  # @see Lithic::Resources::Cards#provision
6
6
  class CardProvisionResponse < Lithic::Internal::Type::BaseModel
7
- # @!attribute [r] provisioning_payload
7
+ # @!attribute provisioning_payload
8
8
  #
9
9
  # @return [String, nil]
10
10
  optional :provisioning_payload, String
11
11
 
12
- # @!parse
13
- # # @return [String]
14
- # attr_writer :provisioning_payload
15
-
16
- # @!parse
17
- # # @param provisioning_payload [String]
18
- # #
19
- # def initialize(provisioning_payload: nil, **) = super
20
-
21
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
12
+ # @!method initialize(provisioning_payload: nil)
13
+ # @param provisioning_payload [String]
22
14
  end
23
15
  end
24
16
  end