lithic 0.1.0.pre.alpha.14 → 0.1.0.pre.alpha.15

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