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
@@ -85,39 +85,19 @@ module Lithic
85
85
  # @return [Time]
86
86
  required :updated, Time
87
87
 
88
- # @!parse
89
- # # @param token [String]
90
- # # @param category [Symbol, Lithic::Models::BookTransferResponse::Category]
91
- # # @param created [Time]
92
- # # @param currency [String]
93
- # # @param events [Array<Lithic::Models::BookTransferResponse::Event>]
94
- # # @param from_financial_account_token [String]
95
- # # @param pending_amount [Integer]
96
- # # @param result [Symbol, Lithic::Models::BookTransferResponse::Result]
97
- # # @param settled_amount [Integer]
98
- # # @param status [Symbol, Lithic::Models::BookTransferResponse::Status]
99
- # # @param to_financial_account_token [Object]
100
- # # @param updated [Time]
101
- # #
102
- # def initialize(
103
- # token:,
104
- # category:,
105
- # created:,
106
- # currency:,
107
- # events:,
108
- # from_financial_account_token:,
109
- # pending_amount:,
110
- # result:,
111
- # settled_amount:,
112
- # status:,
113
- # to_financial_account_token:,
114
- # updated:,
115
- # **
116
- # )
117
- # super
118
- # end
119
-
120
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
88
+ # @!method initialize(token:, category:, created:, currency:, events:, from_financial_account_token:, pending_amount:, result:, settled_amount:, status:, to_financial_account_token:, updated:)
89
+ # @param token [String]
90
+ # @param category [Symbol, Lithic::Models::BookTransferResponse::Category]
91
+ # @param created [Time]
92
+ # @param currency [String]
93
+ # @param events [Array<Lithic::Models::BookTransferResponse::Event>]
94
+ # @param from_financial_account_token [String]
95
+ # @param pending_amount [Integer]
96
+ # @param result [Symbol, Lithic::Models::BookTransferResponse::Result]
97
+ # @param settled_amount [Integer]
98
+ # @param status [Symbol, Lithic::Models::BookTransferResponse::Status]
99
+ # @param to_financial_account_token [Object]
100
+ # @param updated [Time]
121
101
 
122
102
  # Category of the book transfer
123
103
  #
@@ -133,11 +113,8 @@ module Lithic
133
113
  REWARD = :REWARD
134
114
  TRANSFER = :TRANSFER
135
115
 
136
- finalize!
137
-
138
- # @!parse
139
- # # @return [Array<Symbol>]
140
- # def self.values; end
116
+ # @!method self.values
117
+ # @return [Array<Symbol>]
141
118
  end
142
119
 
143
120
  class Event < Lithic::Internal::Type::BaseModel
@@ -192,19 +169,15 @@ module Lithic
192
169
  # @return [String]
193
170
  required :type, String
194
171
 
195
- # @!parse
196
- # # @param token [String]
197
- # # @param amount [Integer]
198
- # # @param created [Time]
199
- # # @param detailed_results [Array<Symbol, Lithic::Models::BookTransferResponse::Event::DetailedResult>]
200
- # # @param memo [String]
201
- # # @param result [Symbol, Lithic::Models::BookTransferResponse::Event::Result]
202
- # # @param subtype [String]
203
- # # @param type [String]
204
- # #
205
- # def initialize(token:, amount:, created:, detailed_results:, memo:, result:, subtype:, type:, **) = super
206
-
207
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
172
+ # @!method initialize(token:, amount:, created:, detailed_results:, memo:, result:, subtype:, type:)
173
+ # @param token [String]
174
+ # @param amount [Integer]
175
+ # @param created [Time]
176
+ # @param detailed_results [Array<Symbol, Lithic::Models::BookTransferResponse::Event::DetailedResult>]
177
+ # @param memo [String]
178
+ # @param result [Symbol, Lithic::Models::BookTransferResponse::Event::Result]
179
+ # @param subtype [String]
180
+ # @param type [String]
208
181
 
209
182
  module DetailedResult
210
183
  extend Lithic::Internal::Type::Enum
@@ -212,11 +185,8 @@ module Lithic
212
185
  APPROVED = :APPROVED
213
186
  FUNDS_INSUFFICIENT = :FUNDS_INSUFFICIENT
214
187
 
215
- finalize!
216
-
217
- # @!parse
218
- # # @return [Array<Symbol>]
219
- # def self.values; end
188
+ # @!method self.values
189
+ # @return [Array<Symbol>]
220
190
  end
221
191
 
222
192
  # APPROVED financial events were successful while DECLINED financial events were
@@ -229,11 +199,8 @@ module Lithic
229
199
  APPROVED = :APPROVED
230
200
  DECLINED = :DECLINED
231
201
 
232
- finalize!
233
-
234
- # @!parse
235
- # # @return [Array<Symbol>]
236
- # def self.values; end
202
+ # @!method self.values
203
+ # @return [Array<Symbol>]
237
204
  end
238
205
  end
239
206
 
@@ -247,11 +214,8 @@ module Lithic
247
214
  APPROVED = :APPROVED
248
215
  DECLINED = :DECLINED
249
216
 
250
- finalize!
251
-
252
- # @!parse
253
- # # @return [Array<Symbol>]
254
- # def self.values; end
217
+ # @!method self.values
218
+ # @return [Array<Symbol>]
255
219
  end
256
220
 
257
221
  # Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The
@@ -265,11 +229,8 @@ module Lithic
265
229
  REVERSED = :REVERSED
266
230
  SETTLED = :SETTLED
267
231
 
268
- finalize!
269
-
270
- # @!parse
271
- # # @return [Array<Symbol>]
272
- # def self.values; end
232
+ # @!method self.values
233
+ # @return [Array<Symbol>]
273
234
  end
274
235
  end
275
236
  end
@@ -4,16 +4,11 @@ module Lithic
4
4
  module Models
5
5
  # @see Lithic::Resources::BookTransfers#retrieve
6
6
  class BookTransferRetrieveParams < 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,27 +4,18 @@ module Lithic
4
4
  module Models
5
5
  # @see Lithic::Resources::BookTransfers#reverse
6
6
  class BookTransferReverseParams < 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] memo
10
+ # @!attribute memo
12
11
  # Optional descriptor for the reversal.
13
12
  #
14
13
  # @return [String, nil]
15
14
  optional :memo, String
16
15
 
17
- # @!parse
18
- # # @return [String]
19
- # attr_writer :memo
20
-
21
- # @!parse
22
- # # @param memo [String]
23
- # # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
24
- # #
25
- # def initialize(memo: nil, request_options: {}, **) = super
26
-
27
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
16
+ # @!method initialize(memo: nil, request_options: {})
17
+ # @param memo [String]
18
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
28
19
  end
29
20
  end
30
21
  end
@@ -4,8 +4,7 @@ module Lithic
4
4
  module Models
5
5
  # @see Lithic::Resources::Cards#convert_physical
6
6
  class CardConvertPhysicalParams < 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
10
  # @!attribute shipping_address
@@ -14,17 +13,13 @@ module Lithic
14
13
  # @return [Lithic::Models::ShippingAddress]
15
14
  required :shipping_address, -> { Lithic::Models::ShippingAddress }
16
15
 
17
- # @!attribute [r] carrier
16
+ # @!attribute carrier
18
17
  # If omitted, the previous carrier will be used.
19
18
  #
20
19
  # @return [Lithic::Models::Carrier, nil]
21
20
  optional :carrier, -> { Lithic::Models::Carrier }
22
21
 
23
- # @!parse
24
- # # @return [Lithic::Models::Carrier]
25
- # attr_writer :carrier
26
-
27
- # @!attribute [r] product_id
22
+ # @!attribute product_id
28
23
  # Specifies the configuration (e.g. physical card art) that the card should be
29
24
  # manufactured with, and only applies to cards of type `PHYSICAL`. This must be
30
25
  # configured with Lithic before use.
@@ -32,11 +27,7 @@ module Lithic
32
27
  # @return [String, nil]
33
28
  optional :product_id, String
34
29
 
35
- # @!parse
36
- # # @return [String]
37
- # attr_writer :product_id
38
-
39
- # @!attribute [r] shipping_method
30
+ # @!attribute shipping_method
40
31
  # Shipping method for the card. Only applies to cards of type PHYSICAL. Use of
41
32
  # options besides `STANDARD` require additional permissions.
42
33
  #
@@ -53,20 +44,12 @@ module Lithic
53
44
  # @return [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod, nil]
54
45
  optional :shipping_method, enum: -> { Lithic::Models::CardConvertPhysicalParams::ShippingMethod }
55
46
 
56
- # @!parse
57
- # # @return [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod]
58
- # attr_writer :shipping_method
59
-
60
- # @!parse
61
- # # @param shipping_address [Lithic::Models::ShippingAddress]
62
- # # @param carrier [Lithic::Models::Carrier]
63
- # # @param product_id [String]
64
- # # @param shipping_method [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod]
65
- # # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
66
- # #
67
- # def initialize(shipping_address:, carrier: nil, product_id: nil, shipping_method: nil, request_options: {}, **) = super
68
-
69
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
47
+ # @!method initialize(shipping_address:, carrier: nil, product_id: nil, shipping_method: nil, request_options: {})
48
+ # @param shipping_address [Lithic::Models::ShippingAddress]
49
+ # @param carrier [Lithic::Models::Carrier]
50
+ # @param product_id [String]
51
+ # @param shipping_method [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod]
52
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
70
53
 
71
54
  # Shipping method for the card. Only applies to cards of type PHYSICAL. Use of
72
55
  # options besides `STANDARD` require additional permissions.
@@ -90,11 +73,8 @@ module Lithic
90
73
  STANDARD = :STANDARD
91
74
  STANDARD_WITH_TRACKING = :STANDARD_WITH_TRACKING
92
75
 
93
- finalize!
94
-
95
- # @!parse
96
- # # @return [Array<Symbol>]
97
- # def self.values; end
76
+ # @!method self.values
77
+ # @return [Array<Symbol>]
98
78
  end
99
79
  end
100
80
  end
@@ -0,0 +1,391 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ # @see Lithic::Resources::Cards#convert_physical
6
+ class CardConvertPhysicalResponse < 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::CardConvertPhysicalResponse::Funding]
35
+ required :funding, -> { Lithic::Models::CardConvertPhysicalResponse::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::CardConvertPhysicalResponse::PinStatus]
48
+ required :pin_status, enum: -> { Lithic::Models::CardConvertPhysicalResponse::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::CardConvertPhysicalResponse::SpendLimitDuration]
61
+ required :spend_limit_duration,
62
+ enum: -> { Lithic::Models::CardConvertPhysicalResponse::SpendLimitDuration }
63
+
64
+ # @!attribute state
65
+ # Card state values: _ `CLOSED` - Card will no longer approve authorizations.
66
+ # Closing a card cannot be undone. _ `OPEN` - Card will approve authorizations (if
67
+ # they match card and account parameters). _ `PAUSED` - Card will decline
68
+ # authorizations, but can be resumed at a later time. _ `PENDING_FULFILLMENT` -
69
+ # The initial state for cards of type `PHYSICAL`. The card is provisioned pending
70
+ # manufacturing and fulfillment. Cards in this state can accept authorizations for
71
+ # e-commerce purchases, but not for "Card Present" purchases where the physical
72
+ # card itself is present. \* `PENDING_ACTIVATION` - At regular intervals, cards of
73
+ # type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card production
74
+ # warehouse and updated to state `PENDING_ACTIVATION`. Similar to
75
+ # `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce
76
+ # transactions or can be added to mobile wallets. API clients should update the
77
+ # card's state to `OPEN` only after the cardholder confirms receipt of the card.
78
+ # In sandbox, the same daily batch fulfillment occurs, but no cards are actually
79
+ # manufactured.
80
+ #
81
+ # @return [Symbol, Lithic::Models::CardConvertPhysicalResponse::State]
82
+ required :state, enum: -> { Lithic::Models::CardConvertPhysicalResponse::State }
83
+
84
+ # @!attribute type
85
+ # Card types: _ `VIRTUAL` - Card will authorize at any merchant and can be added
86
+ # to a digital wallet like Apple Pay or Google Pay (if the card program is digital
87
+ # wallet-enabled). _ `PHYSICAL` - Manufactured and sent to the cardholder. We
88
+ # offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe
89
+ # functionality. _ `SINGLE_USE` - Card is closed upon first successful
90
+ # authorization. _ `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first
91
+ # merchant that successfully authorizes the card. _ `UNLOCKED` - _[Deprecated]_
92
+ # Similar behavior to VIRTUAL cards, please use VIRTUAL instead. _
93
+ # `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use
94
+ # VIRTUAL instead.
95
+ #
96
+ # @return [Symbol, Lithic::Models::CardConvertPhysicalResponse::Type]
97
+ required :type, enum: -> { Lithic::Models::CardConvertPhysicalResponse::Type }
98
+
99
+ # @!attribute auth_rule_tokens
100
+ # List of identifiers for the Auth Rule(s) that are applied on the card. This
101
+ # field is deprecated and will no longer be populated in the `Card` object. The
102
+ # key will be removed from the schema in a future release. Use the `/auth_rules`
103
+ # endpoints to fetch Auth Rule information instead.
104
+ #
105
+ # @return [Array<String>, nil]
106
+ optional :auth_rule_tokens, Lithic::Internal::Type::ArrayOf[String]
107
+
108
+ # @!attribute cardholder_currency
109
+ # 3-character alphabetic ISO 4217 code for the currency of the cardholder.
110
+ #
111
+ # @return [String, nil]
112
+ optional :cardholder_currency, String
113
+
114
+ # @!attribute cvv
115
+ # Three digit cvv printed on the back of the card.
116
+ #
117
+ # @return [String, nil]
118
+ optional :cvv, String
119
+
120
+ # @!attribute digital_card_art_token
121
+ # Specifies the digital card art to be displayed in the user's digital wallet
122
+ # after tokenization. This artwork must be approved by Mastercard and configured
123
+ # by Lithic to use.
124
+ #
125
+ # @return [String, nil]
126
+ optional :digital_card_art_token, String
127
+
128
+ # @!attribute exp_month
129
+ # Two digit (MM) expiry month.
130
+ #
131
+ # @return [String, nil]
132
+ optional :exp_month, String
133
+
134
+ # @!attribute exp_year
135
+ # Four digit (yyyy) expiry year.
136
+ #
137
+ # @return [String, nil]
138
+ optional :exp_year, String
139
+
140
+ # @!attribute hostname
141
+ # Hostname of card's locked merchant (will be empty if not applicable).
142
+ #
143
+ # @return [String, nil]
144
+ optional :hostname, String
145
+
146
+ # @!attribute memo
147
+ # Friendly name to identify the card.
148
+ #
149
+ # @return [String, nil]
150
+ optional :memo, String
151
+
152
+ # @!attribute pan
153
+ # Primary Account Number (PAN) (i.e. the card number). Customers must be PCI
154
+ # compliant to have PAN returned as a field in production. Please contact
155
+ # support@lithic.com for questions.
156
+ #
157
+ # @return [String, nil]
158
+ optional :pan, String
159
+
160
+ # @!attribute pending_commands
161
+ # Indicates if there are offline PIN changes pending card interaction with an
162
+ # offline PIN terminal. Possible commands are: CHANGE_PIN, UNBLOCK_PIN. Applicable
163
+ # only to cards issued in markets supporting offline PINs.
164
+ #
165
+ # @return [Array<String>, nil]
166
+ optional :pending_commands, Lithic::Internal::Type::ArrayOf[String]
167
+
168
+ # @!attribute product_id
169
+ # Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic
170
+ # before use. Specifies the configuration (i.e., physical card art) that the card
171
+ # should be manufactured with.
172
+ #
173
+ # @return [String, nil]
174
+ optional :product_id, String
175
+
176
+ # @!attribute replacement_for
177
+ # If the card is a replacement for another card, the globally unique identifier
178
+ # for the card that was replaced.
179
+ #
180
+ # @return [String, nil]
181
+ optional :replacement_for, String, nil?: true
182
+
183
+ # @!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)
184
+ # Card details with potentially PCI sensitive information for Enterprise customers
185
+ #
186
+ # @param token [String]
187
+ # @param account_token [String]
188
+ # @param card_program_token [String]
189
+ # @param created [Time]
190
+ # @param funding [Lithic::Models::CardConvertPhysicalResponse::Funding]
191
+ # @param last_four [String]
192
+ # @param pin_status [Symbol, Lithic::Models::CardConvertPhysicalResponse::PinStatus]
193
+ # @param spend_limit [Integer]
194
+ # @param spend_limit_duration [Symbol, Lithic::Models::CardConvertPhysicalResponse::SpendLimitDuration]
195
+ # @param state [Symbol, Lithic::Models::CardConvertPhysicalResponse::State]
196
+ # @param type [Symbol, Lithic::Models::CardConvertPhysicalResponse::Type]
197
+ # @param auth_rule_tokens [Array<String>]
198
+ # @param cardholder_currency [String]
199
+ # @param cvv [String]
200
+ # @param digital_card_art_token [String]
201
+ # @param exp_month [String]
202
+ # @param exp_year [String]
203
+ # @param hostname [String]
204
+ # @param memo [String]
205
+ # @param pan [String]
206
+ # @param pending_commands [Array<String>]
207
+ # @param product_id [String]
208
+ # @param replacement_for [String, nil]
209
+
210
+ # @see Lithic::Models::CardConvertPhysicalResponse#funding
211
+ class Funding < Lithic::Internal::Type::BaseModel
212
+ # @!attribute token
213
+ # A globally unique identifier for this FundingAccount.
214
+ #
215
+ # @return [String]
216
+ required :token, String
217
+
218
+ # @!attribute created
219
+ # An RFC 3339 string representing when this funding source was added to the Lithic
220
+ # account. This may be `null`. UTC time zone.
221
+ #
222
+ # @return [Time]
223
+ required :created, Time
224
+
225
+ # @!attribute last_four
226
+ # The last 4 digits of the account (e.g. bank account, debit card) associated with
227
+ # this FundingAccount. This may be null.
228
+ #
229
+ # @return [String]
230
+ required :last_four, String
231
+
232
+ # @!attribute state
233
+ # State of funding source. Funding source states: _ `ENABLED` - The funding
234
+ # account is available to use for card creation and transactions. _ `PENDING` -
235
+ # The funding account is still being verified e.g. bank micro-deposits
236
+ # verification. \* `DELETED` - The founding account has been deleted.
237
+ #
238
+ # @return [Symbol, Lithic::Models::CardConvertPhysicalResponse::Funding::State]
239
+ required :state, enum: -> { Lithic::Models::CardConvertPhysicalResponse::Funding::State }
240
+
241
+ # @!attribute type
242
+ # Types of funding source: _ `DEPOSITORY_CHECKING` - Bank checking account. _
243
+ # `DEPOSITORY_SAVINGS` - Bank savings account.
244
+ #
245
+ # @return [Symbol, Lithic::Models::CardConvertPhysicalResponse::Funding::Type]
246
+ required :type, enum: -> { Lithic::Models::CardConvertPhysicalResponse::Funding::Type }
247
+
248
+ # @!attribute account_name
249
+ # Account name identifying the funding source. This may be `null`.
250
+ #
251
+ # @return [String, nil]
252
+ optional :account_name, String
253
+
254
+ # @!attribute nickname
255
+ # The nickname given to the `FundingAccount` or `null` if it has no nickname.
256
+ #
257
+ # @return [String, nil]
258
+ optional :nickname, String
259
+
260
+ # @!method initialize(token:, created:, last_four:, state:, type:, account_name: nil, nickname: nil)
261
+ # Deprecated: Funding account for the card.
262
+ #
263
+ # @param token [String]
264
+ # @param created [Time]
265
+ # @param last_four [String]
266
+ # @param state [Symbol, Lithic::Models::CardConvertPhysicalResponse::Funding::State]
267
+ # @param type [Symbol, Lithic::Models::CardConvertPhysicalResponse::Funding::Type]
268
+ # @param account_name [String]
269
+ # @param nickname [String]
270
+
271
+ # State of funding source. Funding source states: _ `ENABLED` - The funding
272
+ # account is available to use for card creation and transactions. _ `PENDING` -
273
+ # The funding account is still being verified e.g. bank micro-deposits
274
+ # verification. \* `DELETED` - The founding account has been deleted.
275
+ #
276
+ # @see Lithic::Models::CardConvertPhysicalResponse::Funding#state
277
+ module State
278
+ extend Lithic::Internal::Type::Enum
279
+
280
+ DELETED = :DELETED
281
+ ENABLED = :ENABLED
282
+ PENDING = :PENDING
283
+
284
+ # @!method self.values
285
+ # @return [Array<Symbol>]
286
+ end
287
+
288
+ # Types of funding source: _ `DEPOSITORY_CHECKING` - Bank checking account. _
289
+ # `DEPOSITORY_SAVINGS` - Bank savings account.
290
+ #
291
+ # @see Lithic::Models::CardConvertPhysicalResponse::Funding#type
292
+ module Type
293
+ extend Lithic::Internal::Type::Enum
294
+
295
+ DEPOSITORY_CHECKING = :DEPOSITORY_CHECKING
296
+ DEPOSITORY_SAVINGS = :DEPOSITORY_SAVINGS
297
+
298
+ # @!method self.values
299
+ # @return [Array<Symbol>]
300
+ end
301
+ end
302
+
303
+ # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
304
+ # attempts).
305
+ #
306
+ # @see Lithic::Models::CardConvertPhysicalResponse#pin_status
307
+ module PinStatus
308
+ extend Lithic::Internal::Type::Enum
309
+
310
+ OK = :OK
311
+ BLOCKED = :BLOCKED
312
+ NOT_SET = :NOT_SET
313
+
314
+ # @!method self.values
315
+ # @return [Array<Symbol>]
316
+ end
317
+
318
+ # Spend limit duration
319
+ #
320
+ # @see Lithic::Models::CardConvertPhysicalResponse#spend_limit_duration
321
+ module SpendLimitDuration
322
+ extend Lithic::Internal::Type::Enum
323
+
324
+ ANNUALLY = :ANNUALLY
325
+ FOREVER = :FOREVER
326
+ MONTHLY = :MONTHLY
327
+ TRANSACTION = :TRANSACTION
328
+ DAILY = :DAILY
329
+
330
+ # @!method self.values
331
+ # @return [Array<Symbol>]
332
+ end
333
+
334
+ # Card state values: _ `CLOSED` - Card will no longer approve authorizations.
335
+ # Closing a card cannot be undone. _ `OPEN` - Card will approve authorizations (if
336
+ # they match card and account parameters). _ `PAUSED` - Card will decline
337
+ # authorizations, but can be resumed at a later time. _ `PENDING_FULFILLMENT` -
338
+ # The initial state for cards of type `PHYSICAL`. The card is provisioned pending
339
+ # manufacturing and fulfillment. Cards in this state can accept authorizations for
340
+ # e-commerce purchases, but not for "Card Present" purchases where the physical
341
+ # card itself is present. \* `PENDING_ACTIVATION` - At regular intervals, cards of
342
+ # type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card production
343
+ # warehouse and updated to state `PENDING_ACTIVATION`. Similar to
344
+ # `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce
345
+ # transactions or can be added to mobile wallets. API clients should update the
346
+ # card's state to `OPEN` only after the cardholder confirms receipt of the card.
347
+ # In sandbox, the same daily batch fulfillment occurs, but no cards are actually
348
+ # manufactured.
349
+ #
350
+ # @see Lithic::Models::CardConvertPhysicalResponse#state
351
+ module State
352
+ extend Lithic::Internal::Type::Enum
353
+
354
+ CLOSED = :CLOSED
355
+ OPEN = :OPEN
356
+ PAUSED = :PAUSED
357
+ PENDING_ACTIVATION = :PENDING_ACTIVATION
358
+ PENDING_FULFILLMENT = :PENDING_FULFILLMENT
359
+
360
+ # @!method self.values
361
+ # @return [Array<Symbol>]
362
+ end
363
+
364
+ # Card types: _ `VIRTUAL` - Card will authorize at any merchant and can be added
365
+ # to a digital wallet like Apple Pay or Google Pay (if the card program is digital
366
+ # wallet-enabled). _ `PHYSICAL` - Manufactured and sent to the cardholder. We
367
+ # offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe
368
+ # functionality. _ `SINGLE_USE` - Card is closed upon first successful
369
+ # authorization. _ `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first
370
+ # merchant that successfully authorizes the card. _ `UNLOCKED` - _[Deprecated]_
371
+ # Similar behavior to VIRTUAL cards, please use VIRTUAL instead. _
372
+ # `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use
373
+ # VIRTUAL instead.
374
+ #
375
+ # @see Lithic::Models::CardConvertPhysicalResponse#type
376
+ module Type
377
+ extend Lithic::Internal::Type::Enum
378
+
379
+ MERCHANT_LOCKED = :MERCHANT_LOCKED
380
+ PHYSICAL = :PHYSICAL
381
+ SINGLE_USE = :SINGLE_USE
382
+ VIRTUAL = :VIRTUAL
383
+ UNLOCKED = :UNLOCKED
384
+ DIGITAL_WALLET = :DIGITAL_WALLET
385
+
386
+ # @!method self.values
387
+ # @return [Array<Symbol>]
388
+ end
389
+ end
390
+ end
391
+ end