unit-openapi-python-sdk 0.0.2__py3-none-any.whl → 0.9.0__py3-none-any.whl

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 (539) hide show
  1. unit_finance_sdk/__init__.py +1090 -0
  2. unit_finance_sdk/api/__init__.py +13 -0
  3. unit_finance_sdk/api/accounts_api.py +5206 -0
  4. unit_finance_sdk/api/applications_api.py +1866 -0
  5. unit_finance_sdk/api/cards_api.py +3636 -0
  6. unit_finance_sdk/api/check_deposits_api.py +3370 -0
  7. unit_finance_sdk/api/counterparties_api.py +1853 -0
  8. unit_finance_sdk/api/customers_api.py +1899 -0
  9. unit_finance_sdk/api/fees_api.py +604 -0
  10. unit_finance_sdk/api/payments_api.py +6892 -0
  11. unit_finance_sdk/api/transactions_api.py +1497 -0
  12. unit_finance_sdk/api_client.py +804 -0
  13. unit_finance_sdk/api_response.py +21 -0
  14. unit_finance_sdk/configuration.py +606 -0
  15. unit_finance_sdk/exceptions.py +218 -0
  16. unit_finance_sdk/models/__init__.py +529 -0
  17. unit_finance_sdk/models/account_end_of_day.py +122 -0
  18. unit_finance_sdk/models/account_end_of_day_attributes.py +110 -0
  19. unit_finance_sdk/models/account_end_of_day_relationships.py +115 -0
  20. unit_finance_sdk/models/account_hold.py +122 -0
  21. unit_finance_sdk/models/account_hold_attributes.py +114 -0
  22. unit_finance_sdk/models/account_low_balance_closure_transaction.py +122 -0
  23. unit_finance_sdk/models/account_low_balance_closure_transaction_attributes.py +118 -0
  24. unit_finance_sdk/models/account_low_balance_closure_transaction_relationships.py +120 -0
  25. unit_finance_sdk/models/ach_counterparty.py +122 -0
  26. unit_finance_sdk/models/ach_counterparty_attributes.py +118 -0
  27. unit_finance_sdk/models/ach_payment.py +122 -0
  28. unit_finance_sdk/models/ach_payment_attributes.py +137 -0
  29. unit_finance_sdk/models/ach_payment_relationships.py +130 -0
  30. unit_finance_sdk/models/ach_received_payment.py +122 -0
  31. unit_finance_sdk/models/ach_received_payment_attributes.py +138 -0
  32. unit_finance_sdk/models/ach_received_payment_relationships.py +130 -0
  33. unit_finance_sdk/models/add_account_owners200_response.py +105 -0
  34. unit_finance_sdk/models/add_account_owners_request.py +109 -0
  35. unit_finance_sdk/models/address_type.py +112 -0
  36. unit_finance_sdk/models/adjustment_transaction.py +122 -0
  37. unit_finance_sdk/models/adjustment_transaction_attributes.py +114 -0
  38. unit_finance_sdk/models/annual_income_type.py +41 -0
  39. unit_finance_sdk/models/annual_revenue_type.py +45 -0
  40. unit_finance_sdk/models/application_document.py +116 -0
  41. unit_finance_sdk/models/application_document_attributes.py +126 -0
  42. unit_finance_sdk/models/archive_customer_data.py +114 -0
  43. unit_finance_sdk/models/archive_customer_data_attributes.py +101 -0
  44. unit_finance_sdk/models/archive_customer_request.py +105 -0
  45. unit_finance_sdk/models/atm_transaction.py +122 -0
  46. unit_finance_sdk/models/atm_transaction_attributes.py +134 -0
  47. unit_finance_sdk/models/atm_transaction_relationships.py +120 -0
  48. unit_finance_sdk/models/authorized_user_type.py +117 -0
  49. unit_finance_sdk/models/batch_release.py +122 -0
  50. unit_finance_sdk/models/batch_release_attributes.py +113 -0
  51. unit_finance_sdk/models/batch_release_relationships.py +110 -0
  52. unit_finance_sdk/models/beneficial_owner.py +116 -0
  53. unit_finance_sdk/models/beneficial_owner_attributes.py +140 -0
  54. unit_finance_sdk/models/beneficial_owner_request_type.py +136 -0
  55. unit_finance_sdk/models/beneficial_owner_type.py +142 -0
  56. unit_finance_sdk/models/book_payment.py +122 -0
  57. unit_finance_sdk/models/book_payment_attributes.py +116 -0
  58. unit_finance_sdk/models/book_payment_relationships.py +135 -0
  59. unit_finance_sdk/models/book_transaction.py +122 -0
  60. unit_finance_sdk/models/book_transaction_attributes.py +118 -0
  61. unit_finance_sdk/models/book_transaction_relationships.py +135 -0
  62. unit_finance_sdk/models/business_annual_revenue_type.py +40 -0
  63. unit_finance_sdk/models/business_application.py +122 -0
  64. unit_finance_sdk/models/business_application_attributes.py +197 -0
  65. unit_finance_sdk/models/business_application_relationships.py +131 -0
  66. unit_finance_sdk/models/business_contact_type.py +115 -0
  67. unit_finance_sdk/models/business_credit_card.py +118 -0
  68. unit_finance_sdk/models/business_customer.py +122 -0
  69. unit_finance_sdk/models/business_customer_attributes.py +188 -0
  70. unit_finance_sdk/models/business_customer_relationships.py +125 -0
  71. unit_finance_sdk/models/business_debit_card.py +122 -0
  72. unit_finance_sdk/models/business_debit_card_attributes.py +148 -0
  73. unit_finance_sdk/models/business_number_of_employees_type.py +40 -0
  74. unit_finance_sdk/models/business_vertical_type.py +66 -0
  75. unit_finance_sdk/models/business_virtual_credit_card.py +118 -0
  76. unit_finance_sdk/models/business_virtual_debit_card.py +122 -0
  77. unit_finance_sdk/models/business_virtual_debit_card_attributes.py +141 -0
  78. unit_finance_sdk/models/business_wallet_customer.py +122 -0
  79. unit_finance_sdk/models/business_wallet_customer_attributes.py +124 -0
  80. unit_finance_sdk/models/business_wallet_customer_relationships.py +105 -0
  81. unit_finance_sdk/models/cancel_application201_response.py +115 -0
  82. unit_finance_sdk/models/cancel_application_data.py +114 -0
  83. unit_finance_sdk/models/cancel_application_data_attributes.py +101 -0
  84. unit_finance_sdk/models/cancel_application_request.py +105 -0
  85. unit_finance_sdk/models/cancel_payment200_response.py +105 -0
  86. unit_finance_sdk/models/cancel_payment200_response_data.py +140 -0
  87. unit_finance_sdk/models/card_reversal_transaction.py +122 -0
  88. unit_finance_sdk/models/card_reversal_transaction_attributes.py +114 -0
  89. unit_finance_sdk/models/card_reversal_transaction_relationships.py +125 -0
  90. unit_finance_sdk/models/card_transaction.py +122 -0
  91. unit_finance_sdk/models/card_transaction_attributes.py +152 -0
  92. unit_finance_sdk/models/card_transaction_attributes_card_verification_data.py +101 -0
  93. unit_finance_sdk/models/card_transaction_attributes_merchant.py +109 -0
  94. unit_finance_sdk/models/card_transaction_relationships.py +125 -0
  95. unit_finance_sdk/models/cash_deposit_barcode.py +122 -0
  96. unit_finance_sdk/models/cash_deposit_barcode_attributes.py +108 -0
  97. unit_finance_sdk/models/cash_deposit_barcode_relationships.py +110 -0
  98. unit_finance_sdk/models/cash_deposit_transaction.py +122 -0
  99. unit_finance_sdk/models/cash_deposit_transaction_attributes.py +112 -0
  100. unit_finance_sdk/models/cash_flow_type.py +37 -0
  101. unit_finance_sdk/models/chargeback_transaction.py +122 -0
  102. unit_finance_sdk/models/chargeback_transaction_attributes.py +118 -0
  103. unit_finance_sdk/models/chargeback_transaction_relationships.py +125 -0
  104. unit_finance_sdk/models/check_counterparty_type.py +105 -0
  105. unit_finance_sdk/models/check_deposit.py +122 -0
  106. unit_finance_sdk/models/check_deposit_attributes.py +124 -0
  107. unit_finance_sdk/models/check_deposit_relationships.py +120 -0
  108. unit_finance_sdk/models/check_deposit_transaction.py +122 -0
  109. unit_finance_sdk/models/check_deposit_transaction_attributes.py +112 -0
  110. unit_finance_sdk/models/check_deposit_transaction_relationships.py +120 -0
  111. unit_finance_sdk/models/check_payment_transaction.py +122 -0
  112. unit_finance_sdk/models/check_payment_transaction_relationships.py +120 -0
  113. unit_finance_sdk/models/clear_ach_debit_payment200_response.py +105 -0
  114. unit_finance_sdk/models/close_account_request.py +151 -0
  115. unit_finance_sdk/models/close_card200_response.py +105 -0
  116. unit_finance_sdk/models/close_credit_account_data.py +114 -0
  117. unit_finance_sdk/models/close_credit_account_data_attributes.py +103 -0
  118. unit_finance_sdk/models/close_credit_account_request.py +105 -0
  119. unit_finance_sdk/models/close_deposit_account_data.py +114 -0
  120. unit_finance_sdk/models/close_deposit_account_data_attributes.py +105 -0
  121. unit_finance_sdk/models/close_deposit_account_request.py +105 -0
  122. unit_finance_sdk/models/close_wallet_data.py +114 -0
  123. unit_finance_sdk/models/close_wallet_data_attributes.py +105 -0
  124. unit_finance_sdk/models/close_wallet_request.py +105 -0
  125. unit_finance_sdk/models/coordinates_type.py +103 -0
  126. unit_finance_sdk/models/counterparty_balance.py +122 -0
  127. unit_finance_sdk/models/counterparty_balance_attributes.py +103 -0
  128. unit_finance_sdk/models/counterparty_balance_relationships.py +110 -0
  129. unit_finance_sdk/models/counterparty_type.py +107 -0
  130. unit_finance_sdk/models/create_a_book_payment_data.py +120 -0
  131. unit_finance_sdk/models/create_a_book_payment_data_attributes.py +109 -0
  132. unit_finance_sdk/models/create_a_book_payment_data_relationships.py +110 -0
  133. unit_finance_sdk/models/create_a_book_payment_request.py +105 -0
  134. unit_finance_sdk/models/create_a_wire_payment_data.py +120 -0
  135. unit_finance_sdk/models/create_a_wire_payment_data_attributes.py +113 -0
  136. unit_finance_sdk/models/create_a_wire_payment_request.py +105 -0
  137. unit_finance_sdk/models/create_account201_response.py +105 -0
  138. unit_finance_sdk/models/create_account_hold201_response.py +105 -0
  139. unit_finance_sdk/models/create_account_hold_data.py +120 -0
  140. unit_finance_sdk/models/create_account_hold_data_attributes.py +108 -0
  141. unit_finance_sdk/models/create_account_hold_request.py +105 -0
  142. unit_finance_sdk/models/create_account_request.py +151 -0
  143. unit_finance_sdk/models/create_ach_payment_data.py +120 -0
  144. unit_finance_sdk/models/create_ach_payment_data_attributes.py +123 -0
  145. unit_finance_sdk/models/create_ach_payment_existing_counterparty_data.py +120 -0
  146. unit_finance_sdk/models/create_ach_payment_existing_counterparty_data_attributes.py +119 -0
  147. unit_finance_sdk/models/create_ach_payment_existing_counterparty_data_relationships.py +110 -0
  148. unit_finance_sdk/models/create_ach_payment_existing_counterparty_request.py +105 -0
  149. unit_finance_sdk/models/create_ach_payment_plaid_token_data.py +120 -0
  150. unit_finance_sdk/models/create_ach_payment_plaid_token_data_attributes.py +123 -0
  151. unit_finance_sdk/models/create_ach_payment_plaid_token_request.py +105 -0
  152. unit_finance_sdk/models/create_ach_payment_request.py +105 -0
  153. unit_finance_sdk/models/create_application201_response.py +115 -0
  154. unit_finance_sdk/models/create_application201_response_included_inner.py +140 -0
  155. unit_finance_sdk/models/create_application_request.py +151 -0
  156. unit_finance_sdk/models/create_batch_releases201_response.py +109 -0
  157. unit_finance_sdk/models/create_batch_releases_data.py +114 -0
  158. unit_finance_sdk/models/create_batch_releases_data_attributes.py +117 -0
  159. unit_finance_sdk/models/create_batch_releases_request.py +105 -0
  160. unit_finance_sdk/models/create_bulk_payment201_response.py +105 -0
  161. unit_finance_sdk/models/create_bulk_payment201_response_data.py +107 -0
  162. unit_finance_sdk/models/create_bulk_payment201_response_data_attributes.py +101 -0
  163. unit_finance_sdk/models/create_bulk_payment_request.py +109 -0
  164. unit_finance_sdk/models/create_bulk_payment_request_data_inner.py +179 -0
  165. unit_finance_sdk/models/create_business_application_data.py +114 -0
  166. unit_finance_sdk/models/create_business_application_data_attributes.py +189 -0
  167. unit_finance_sdk/models/create_business_application_request.py +105 -0
  168. unit_finance_sdk/models/create_business_credit_card_data.py +120 -0
  169. unit_finance_sdk/models/create_business_credit_card_data_attributes.py +148 -0
  170. unit_finance_sdk/models/create_business_credit_card_request.py +105 -0
  171. unit_finance_sdk/models/create_business_debit_card_data.py +120 -0
  172. unit_finance_sdk/models/create_business_debit_card_request.py +105 -0
  173. unit_finance_sdk/models/create_business_virtual_credit_card_data.py +120 -0
  174. unit_finance_sdk/models/create_business_virtual_credit_card_data_attributes.py +137 -0
  175. unit_finance_sdk/models/create_business_virtual_credit_card_request.py +105 -0
  176. unit_finance_sdk/models/create_business_virtual_debit_card_data.py +120 -0
  177. unit_finance_sdk/models/create_business_virtual_debit_card_data_attributes.py +137 -0
  178. unit_finance_sdk/models/create_business_virtual_debit_card_request.py +105 -0
  179. unit_finance_sdk/models/create_business_wallet_customer201_response.py +105 -0
  180. unit_finance_sdk/models/create_business_wallet_customer_data.py +114 -0
  181. unit_finance_sdk/models/create_business_wallet_customer_data_attributes.py +119 -0
  182. unit_finance_sdk/models/create_business_wallet_customer_request.py +105 -0
  183. unit_finance_sdk/models/create_card201_response.py +105 -0
  184. unit_finance_sdk/models/create_card201_response_data.py +196 -0
  185. unit_finance_sdk/models/create_card_request.py +193 -0
  186. unit_finance_sdk/models/create_check_deposit201_response.py +105 -0
  187. unit_finance_sdk/models/create_check_deposit_data.py +120 -0
  188. unit_finance_sdk/models/create_check_deposit_data_attributes.py +109 -0
  189. unit_finance_sdk/models/create_check_deposit_request.py +105 -0
  190. unit_finance_sdk/models/create_check_deposit_send_link201_response.py +105 -0
  191. unit_finance_sdk/models/create_check_deposit_send_link201_response_data.py +108 -0
  192. unit_finance_sdk/models/create_check_deposit_send_link_data.py +120 -0
  193. unit_finance_sdk/models/create_check_deposit_send_link_data_attributes.py +103 -0
  194. unit_finance_sdk/models/create_check_deposit_send_link_data_relationships.py +115 -0
  195. unit_finance_sdk/models/create_check_deposit_send_link_request.py +105 -0
  196. unit_finance_sdk/models/create_counterparty201_response.py +105 -0
  197. unit_finance_sdk/models/create_counterparty_body.py +137 -0
  198. unit_finance_sdk/models/create_counterparty_data.py +120 -0
  199. unit_finance_sdk/models/create_counterparty_data_attributes.py +115 -0
  200. unit_finance_sdk/models/create_counterparty_request.py +105 -0
  201. unit_finance_sdk/models/create_counterparty_with_plaid_token_data.py +120 -0
  202. unit_finance_sdk/models/create_counterparty_with_plaid_token_data_attributes.py +113 -0
  203. unit_finance_sdk/models/create_counterparty_with_plaid_token_request.py +105 -0
  204. unit_finance_sdk/models/create_credit_account_data.py +120 -0
  205. unit_finance_sdk/models/create_credit_account_data_attributes.py +107 -0
  206. unit_finance_sdk/models/create_credit_account_request.py +105 -0
  207. unit_finance_sdk/models/create_deposit_account_data.py +120 -0
  208. unit_finance_sdk/models/create_deposit_account_data_attributes.py +105 -0
  209. unit_finance_sdk/models/create_deposit_account_data_relationships.py +105 -0
  210. unit_finance_sdk/models/create_deposit_account_request.py +105 -0
  211. unit_finance_sdk/models/create_fee201_response.py +105 -0
  212. unit_finance_sdk/models/create_fee_data.py +120 -0
  213. unit_finance_sdk/models/create_fee_data_attributes.py +107 -0
  214. unit_finance_sdk/models/create_fee_data_relationships.py +105 -0
  215. unit_finance_sdk/models/create_fee_request.py +105 -0
  216. unit_finance_sdk/models/create_individual_application_data.py +114 -0
  217. unit_finance_sdk/models/create_individual_application_data_attributes.py +158 -0
  218. unit_finance_sdk/models/create_individual_application_request.py +105 -0
  219. unit_finance_sdk/models/create_individual_debit_card_data.py +120 -0
  220. unit_finance_sdk/models/create_individual_debit_card_data_attributes.py +119 -0
  221. unit_finance_sdk/models/create_individual_debit_card_request.py +105 -0
  222. unit_finance_sdk/models/create_individual_virtual_debit_card_data.py +120 -0
  223. unit_finance_sdk/models/create_individual_virtual_debit_card_data_attributes.py +107 -0
  224. unit_finance_sdk/models/create_individual_virtual_debit_card_request.py +105 -0
  225. unit_finance_sdk/models/create_payment201_response.py +105 -0
  226. unit_finance_sdk/models/create_payment201_response_data.py +154 -0
  227. unit_finance_sdk/models/create_payment_request.py +179 -0
  228. unit_finance_sdk/models/create_recurring_credit_ach_payment_data.py +120 -0
  229. unit_finance_sdk/models/create_recurring_credit_ach_payment_data_attributes.py +117 -0
  230. unit_finance_sdk/models/create_recurring_credit_ach_payment_request.py +105 -0
  231. unit_finance_sdk/models/create_recurring_credit_book_payment_data.py +120 -0
  232. unit_finance_sdk/models/create_recurring_credit_book_payment_data_attributes.py +115 -0
  233. unit_finance_sdk/models/create_recurring_credit_book_payment_request.py +105 -0
  234. unit_finance_sdk/models/create_recurring_debit_ach_payment_data.py +120 -0
  235. unit_finance_sdk/models/create_recurring_debit_ach_payment_data_attributes.py +119 -0
  236. unit_finance_sdk/models/create_recurring_debit_ach_payment_request.py +105 -0
  237. unit_finance_sdk/models/create_recurring_payment201_response.py +105 -0
  238. unit_finance_sdk/models/create_recurring_payment_request.py +151 -0
  239. unit_finance_sdk/models/create_schedule_type.py +112 -0
  240. unit_finance_sdk/models/create_sole_proprietor_application_data.py +114 -0
  241. unit_finance_sdk/models/create_sole_proprietor_application_data_attributes.py +174 -0
  242. unit_finance_sdk/models/create_sole_proprietor_application_request.py +105 -0
  243. unit_finance_sdk/models/create_wallet_data.py +120 -0
  244. unit_finance_sdk/models/create_wallet_data_attributes.py +105 -0
  245. unit_finance_sdk/models/create_wallet_request.py +105 -0
  246. unit_finance_sdk/models/credit_account.py +122 -0
  247. unit_finance_sdk/models/credit_account_attributes.py +130 -0
  248. unit_finance_sdk/models/credit_account_relationships.py +105 -0
  249. unit_finance_sdk/models/currency_conversion_type.py +105 -0
  250. unit_finance_sdk/models/deposit_account.py +122 -0
  251. unit_finance_sdk/models/deposit_account_attributes.py +138 -0
  252. unit_finance_sdk/models/deposit_account_relationships.py +110 -0
  253. unit_finance_sdk/models/device_fingerprint_type.py +103 -0
  254. unit_finance_sdk/models/dishonored_ach_transaction.py +122 -0
  255. unit_finance_sdk/models/dishonored_ach_transaction_attributes.py +124 -0
  256. unit_finance_sdk/models/dispute_transaction.py +122 -0
  257. unit_finance_sdk/models/dispute_transaction_attributes.py +116 -0
  258. unit_finance_sdk/models/dispute_transaction_relationships.py +120 -0
  259. unit_finance_sdk/models/error_document.py +109 -0
  260. unit_finance_sdk/models/error_document_errors_inner.py +115 -0
  261. unit_finance_sdk/models/error_document_errors_inner_source.py +101 -0
  262. unit_finance_sdk/models/fee.py +122 -0
  263. unit_finance_sdk/models/fee_attributes.py +105 -0
  264. unit_finance_sdk/models/fee_relationships.py +105 -0
  265. unit_finance_sdk/models/fee_reversal.py +122 -0
  266. unit_finance_sdk/models/fee_reversal_attributes.py +103 -0
  267. unit_finance_sdk/models/fee_reversal_relationships.py +110 -0
  268. unit_finance_sdk/models/fee_reversal_transaction.py +122 -0
  269. unit_finance_sdk/models/fee_reversal_transaction_relationships.py +120 -0
  270. unit_finance_sdk/models/fee_transaction.py +122 -0
  271. unit_finance_sdk/models/freeze_account_request.py +151 -0
  272. unit_finance_sdk/models/freeze_card_data.py +114 -0
  273. unit_finance_sdk/models/freeze_card_data_attributes.py +101 -0
  274. unit_finance_sdk/models/freeze_card_request.py +105 -0
  275. unit_finance_sdk/models/freeze_credit_account_data.py +114 -0
  276. unit_finance_sdk/models/freeze_credit_account_request.py +105 -0
  277. unit_finance_sdk/models/freeze_deposit_account_data.py +114 -0
  278. unit_finance_sdk/models/freeze_deposit_account_data_attributes.py +103 -0
  279. unit_finance_sdk/models/freeze_deposit_account_request.py +105 -0
  280. unit_finance_sdk/models/freeze_wallet_data.py +114 -0
  281. unit_finance_sdk/models/freeze_wallet_data_attributes.py +103 -0
  282. unit_finance_sdk/models/freeze_wallet_request.py +105 -0
  283. unit_finance_sdk/models/full_name_type.py +103 -0
  284. unit_finance_sdk/models/generate_barcode_data.py +120 -0
  285. unit_finance_sdk/models/generate_barcode_data_attributes.py +101 -0
  286. unit_finance_sdk/models/generate_barcode_data_relationships.py +110 -0
  287. unit_finance_sdk/models/generate_cash_deposit_barcode200_response.py +105 -0
  288. unit_finance_sdk/models/generate_cash_deposit_barcode_request.py +105 -0
  289. unit_finance_sdk/models/get_account_balance_history200_response.py +115 -0
  290. unit_finance_sdk/models/get_account_limits200_response.py +105 -0
  291. unit_finance_sdk/models/get_account_limits200_response_data.py +105 -0
  292. unit_finance_sdk/models/get_available_deposit_products200_response.py +109 -0
  293. unit_finance_sdk/models/get_available_deposit_products200_response_data_inner.py +107 -0
  294. unit_finance_sdk/models/get_available_deposit_products200_response_data_inner_attributes.py +101 -0
  295. unit_finance_sdk/models/get_card200_response.py +115 -0
  296. unit_finance_sdk/models/get_card_pin_status200_response.py +105 -0
  297. unit_finance_sdk/models/get_check_deposit200_response.py +115 -0
  298. unit_finance_sdk/models/get_counterparty_balance200_response.py +105 -0
  299. unit_finance_sdk/models/get_customer200_response.py +115 -0
  300. unit_finance_sdk/models/get_expected_ach_completion_date200_response.py +105 -0
  301. unit_finance_sdk/models/get_expected_ach_completion_date200_response_data.py +103 -0
  302. unit_finance_sdk/models/get_expected_ach_completion_date_data.py +120 -0
  303. unit_finance_sdk/models/get_expected_ach_completion_date_data_attributes.py +108 -0
  304. unit_finance_sdk/models/get_expected_ach_completion_date_request.py +105 -0
  305. unit_finance_sdk/models/get_received_payment200_response.py +115 -0
  306. unit_finance_sdk/models/get_transaction200_response.py +115 -0
  307. unit_finance_sdk/models/get_wire_drawdown200_response.py +115 -0
  308. unit_finance_sdk/models/individual_application.py +122 -0
  309. unit_finance_sdk/models/individual_application_attributes.py +154 -0
  310. unit_finance_sdk/models/individual_application_relationships.py +121 -0
  311. unit_finance_sdk/models/individual_customer.py +118 -0
  312. unit_finance_sdk/models/individual_customer_relationships.py +115 -0
  313. unit_finance_sdk/models/individual_debit_card.py +122 -0
  314. unit_finance_sdk/models/individual_debit_card_attributes.py +120 -0
  315. unit_finance_sdk/models/individual_virtual_debit_card.py +122 -0
  316. unit_finance_sdk/models/individual_virtual_debit_card_attributes.py +112 -0
  317. unit_finance_sdk/models/industry_type.py +47 -0
  318. unit_finance_sdk/models/interest_share_transaction.py +122 -0
  319. unit_finance_sdk/models/interest_share_transaction_relationships.py +120 -0
  320. unit_finance_sdk/models/interest_transaction.py +122 -0
  321. unit_finance_sdk/models/list200_response.py +115 -0
  322. unit_finance_sdk/models/list200_response_data_inner.py +140 -0
  323. unit_finance_sdk/models/list_account_holds200_response.py +115 -0
  324. unit_finance_sdk/models/list_accounts200_response.py +111 -0
  325. unit_finance_sdk/models/list_accounts200_response_data_inner.py +154 -0
  326. unit_finance_sdk/models/list_cards200_response.py +119 -0
  327. unit_finance_sdk/models/list_cards200_response_data_inner.py +168 -0
  328. unit_finance_sdk/models/list_check_deposits200_response.py +125 -0
  329. unit_finance_sdk/models/list_counterparties200_response.py +109 -0
  330. unit_finance_sdk/models/list_customers200_response.py +115 -0
  331. unit_finance_sdk/models/list_customers200_response_data_inner.py +140 -0
  332. unit_finance_sdk/models/list_received_payments200_response.py +125 -0
  333. unit_finance_sdk/models/list_received_payments200_response_data_inner.py +140 -0
  334. unit_finance_sdk/models/list_recurring_payments200_response.py +115 -0
  335. unit_finance_sdk/models/list_recurring_payments200_response_data_inner.py +154 -0
  336. unit_finance_sdk/models/list_store_locations200_response.py +115 -0
  337. unit_finance_sdk/models/list_transactions200_response.py +125 -0
  338. unit_finance_sdk/models/list_transactions200_response_included_inner.py +140 -0
  339. unit_finance_sdk/models/list_wire_drawdowns200_response.py +125 -0
  340. unit_finance_sdk/models/meta.py +105 -0
  341. unit_finance_sdk/models/meta_pagination.py +105 -0
  342. unit_finance_sdk/models/negative_balance_coverage_transaction.py +122 -0
  343. unit_finance_sdk/models/number_of_employees_type.py +44 -0
  344. unit_finance_sdk/models/occupation_type.py +58 -0
  345. unit_finance_sdk/models/officer.py +122 -0
  346. unit_finance_sdk/models/officer_attributes.py +142 -0
  347. unit_finance_sdk/models/officer_relationships.py +110 -0
  348. unit_finance_sdk/models/officer_request_type.py +136 -0
  349. unit_finance_sdk/models/officer_type.py +144 -0
  350. unit_finance_sdk/models/originated_ach_transaction.py +122 -0
  351. unit_finance_sdk/models/originated_ach_transaction_attributes.py +126 -0
  352. unit_finance_sdk/models/originated_ach_transaction_relationships.py +125 -0
  353. unit_finance_sdk/models/payment_advance_transaction.py +122 -0
  354. unit_finance_sdk/models/payment_advance_transaction_attributes.py +112 -0
  355. unit_finance_sdk/models/payment_advance_transaction_relationships.py +115 -0
  356. unit_finance_sdk/models/payment_canceled_transaction.py +122 -0
  357. unit_finance_sdk/models/payment_canceled_transaction_relationships.py +125 -0
  358. unit_finance_sdk/models/phone_type.py +103 -0
  359. unit_finance_sdk/models/pin_status.py +114 -0
  360. unit_finance_sdk/models/pin_status_attributes.py +101 -0
  361. unit_finance_sdk/models/product_type.py +38 -0
  362. unit_finance_sdk/models/purchase_transaction.py +122 -0
  363. unit_finance_sdk/models/purchase_transaction_attributes.py +164 -0
  364. unit_finance_sdk/models/purchase_transaction_attributes_merchant.py +109 -0
  365. unit_finance_sdk/models/purchase_transaction_relationships.py +130 -0
  366. unit_finance_sdk/models/push_to_card_reversal_transaction.py +122 -0
  367. unit_finance_sdk/models/push_to_card_reversal_transaction_relationships.py +130 -0
  368. unit_finance_sdk/models/push_to_card_transaction.py +122 -0
  369. unit_finance_sdk/models/push_to_card_transaction_relationships.py +125 -0
  370. unit_finance_sdk/models/real_time_counterparty_type.py +105 -0
  371. unit_finance_sdk/models/realtime_received_payment.py +122 -0
  372. unit_finance_sdk/models/realtime_received_payment_attributes.py +120 -0
  373. unit_finance_sdk/models/realtime_received_payment_relationships.py +115 -0
  374. unit_finance_sdk/models/received_ach_transaction.py +122 -0
  375. unit_finance_sdk/models/received_ach_transaction_attributes.py +124 -0
  376. unit_finance_sdk/models/recurring_credit_ach_payment.py +122 -0
  377. unit_finance_sdk/models/recurring_credit_ach_payment_attributes.py +122 -0
  378. unit_finance_sdk/models/recurring_credit_ach_payment_relationships.py +120 -0
  379. unit_finance_sdk/models/recurring_credit_book_payment.py +122 -0
  380. unit_finance_sdk/models/recurring_credit_book_payment_attributes.py +122 -0
  381. unit_finance_sdk/models/recurring_credit_book_payment_relationships.py +120 -0
  382. unit_finance_sdk/models/recurring_debit_ach_payment.py +122 -0
  383. unit_finance_sdk/models/relationship.py +110 -0
  384. unit_finance_sdk/models/relationship_data.py +146 -0
  385. unit_finance_sdk/models/release_account_hold_data.py +114 -0
  386. unit_finance_sdk/models/release_account_hold_data_attributes.py +103 -0
  387. unit_finance_sdk/models/release_account_hold_request.py +105 -0
  388. unit_finance_sdk/models/release_transaction.py +122 -0
  389. unit_finance_sdk/models/release_transaction_attributes.py +130 -0
  390. unit_finance_sdk/models/remove_account_owners_request.py +109 -0
  391. unit_finance_sdk/models/reopen_account200_response.py +105 -0
  392. unit_finance_sdk/models/reopen_account200_response_data.py +140 -0
  393. unit_finance_sdk/models/repaid_payment_advance_transaction.py +122 -0
  394. unit_finance_sdk/models/repaid_payment_advance_transaction_attributes.py +112 -0
  395. unit_finance_sdk/models/repaid_payment_advance_transaction_relationships.py +120 -0
  396. unit_finance_sdk/models/replace_card200_response.py +105 -0
  397. unit_finance_sdk/models/replace_card200_response_data.py +140 -0
  398. unit_finance_sdk/models/replace_card_data.py +114 -0
  399. unit_finance_sdk/models/replace_card_data_attributes.py +105 -0
  400. unit_finance_sdk/models/replace_card_request.py +105 -0
  401. unit_finance_sdk/models/requested_product_type.py +40 -0
  402. unit_finance_sdk/models/resource_identifier.py +103 -0
  403. unit_finance_sdk/models/returned_ach_transaction.py +122 -0
  404. unit_finance_sdk/models/returned_ach_transaction_attributes.py +120 -0
  405. unit_finance_sdk/models/returned_ach_transaction_relationships.py +120 -0
  406. unit_finance_sdk/models/returned_check_deposit_transaction.py +122 -0
  407. unit_finance_sdk/models/returned_check_deposit_transaction_attributes.py +114 -0
  408. unit_finance_sdk/models/returned_check_payment_transaction.py +122 -0
  409. unit_finance_sdk/models/returned_check_payment_transaction_attributes.py +114 -0
  410. unit_finance_sdk/models/returned_received_ach_transaction.py +122 -0
  411. unit_finance_sdk/models/returned_received_ach_transaction_attributes.py +116 -0
  412. unit_finance_sdk/models/returned_received_ach_transaction_relationships.py +120 -0
  413. unit_finance_sdk/models/returned_wire_transaction.py +122 -0
  414. unit_finance_sdk/models/returned_wire_transaction_attributes.py +118 -0
  415. unit_finance_sdk/models/reverse_fee201_response.py +105 -0
  416. unit_finance_sdk/models/reverse_fee_data.py +120 -0
  417. unit_finance_sdk/models/reverse_fee_data_attributes.py +105 -0
  418. unit_finance_sdk/models/reverse_fee_data_relationships.py +110 -0
  419. unit_finance_sdk/models/reverse_fee_request.py +105 -0
  420. unit_finance_sdk/models/reward_transaction.py +122 -0
  421. unit_finance_sdk/models/reward_transaction_attributes.py +118 -0
  422. unit_finance_sdk/models/reward_transaction_relationships.py +125 -0
  423. unit_finance_sdk/models/rich_merchant_data_type.py +131 -0
  424. unit_finance_sdk/models/rich_merchant_data_type_address.py +107 -0
  425. unit_finance_sdk/models/rich_merchant_data_type_categories_inner.py +103 -0
  426. unit_finance_sdk/models/schedule_type.py +114 -0
  427. unit_finance_sdk/models/send_drawdown_payment200_response.py +105 -0
  428. unit_finance_sdk/models/send_drawdown_payment_data.py +114 -0
  429. unit_finance_sdk/models/send_drawdown_payment_data_attributes.py +103 -0
  430. unit_finance_sdk/models/send_drawdown_payment_request.py +105 -0
  431. unit_finance_sdk/models/sole_proprietor_annual_revenue_type.py +40 -0
  432. unit_finance_sdk/models/sole_proprietor_number_of_employees_type.py +39 -0
  433. unit_finance_sdk/models/source_of_income_type.py +41 -0
  434. unit_finance_sdk/models/store_location.py +116 -0
  435. unit_finance_sdk/models/store_location_attributes.py +123 -0
  436. unit_finance_sdk/models/to_many_relationship.py +109 -0
  437. unit_finance_sdk/models/total_accrued_interest_type.py +101 -0
  438. unit_finance_sdk/models/transaction.py +588 -0
  439. unit_finance_sdk/models/update_account_request.py +151 -0
  440. unit_finance_sdk/models/update_ach_payment_data.py +114 -0
  441. unit_finance_sdk/models/update_ach_payment_data_attributes.py +103 -0
  442. unit_finance_sdk/models/update_ach_payment_request.py +105 -0
  443. unit_finance_sdk/models/update_ach_received_payment_data.py +114 -0
  444. unit_finance_sdk/models/update_ach_received_payment_data_attributes.py +101 -0
  445. unit_finance_sdk/models/update_ach_received_payment_request.py +105 -0
  446. unit_finance_sdk/models/update_application_request.py +165 -0
  447. unit_finance_sdk/models/update_book_payment_data.py +114 -0
  448. unit_finance_sdk/models/update_book_payment_data_attributes.py +101 -0
  449. unit_finance_sdk/models/update_book_payment_request.py +105 -0
  450. unit_finance_sdk/models/update_book_transaction_data.py +120 -0
  451. unit_finance_sdk/models/update_book_transaction_data_attributes.py +103 -0
  452. unit_finance_sdk/models/update_book_transaction_request.py +105 -0
  453. unit_finance_sdk/models/update_business_application_data.py +114 -0
  454. unit_finance_sdk/models/update_business_application_data_attributes.py +121 -0
  455. unit_finance_sdk/models/update_business_application_request.py +105 -0
  456. unit_finance_sdk/models/update_business_beneficial_owner201_response.py +105 -0
  457. unit_finance_sdk/models/update_business_beneficial_owner_data.py +120 -0
  458. unit_finance_sdk/models/update_business_beneficial_owner_data_attributes.py +110 -0
  459. unit_finance_sdk/models/update_business_beneficial_owner_data_relationships.py +105 -0
  460. unit_finance_sdk/models/update_business_beneficial_owner_request.py +105 -0
  461. unit_finance_sdk/models/update_business_customer_data.py +114 -0
  462. unit_finance_sdk/models/update_business_customer_data_attributes.py +170 -0
  463. unit_finance_sdk/models/update_business_customer_officer200_response.py +105 -0
  464. unit_finance_sdk/models/update_business_customer_officer_data.py +114 -0
  465. unit_finance_sdk/models/update_business_customer_officer_data_attributes.py +110 -0
  466. unit_finance_sdk/models/update_business_customer_officer_request.py +105 -0
  467. unit_finance_sdk/models/update_business_customer_request.py +105 -0
  468. unit_finance_sdk/models/update_business_officer_data.py +114 -0
  469. unit_finance_sdk/models/update_business_officer_data_attributes.py +108 -0
  470. unit_finance_sdk/models/update_business_officer_request.py +105 -0
  471. unit_finance_sdk/models/update_card200_response.py +105 -0
  472. unit_finance_sdk/models/update_card200_response_data.py +168 -0
  473. unit_finance_sdk/models/update_card_data.py +114 -0
  474. unit_finance_sdk/models/update_card_data_attributes.py +121 -0
  475. unit_finance_sdk/models/update_card_request.py +105 -0
  476. unit_finance_sdk/models/update_chargeback_transaction_data.py +120 -0
  477. unit_finance_sdk/models/update_chargeback_transaction_data_attributes.py +103 -0
  478. unit_finance_sdk/models/update_chargeback_transaction_request.py +105 -0
  479. unit_finance_sdk/models/update_check_deposit_request.py +105 -0
  480. unit_finance_sdk/models/update_counterparty200_response.py +111 -0
  481. unit_finance_sdk/models/update_counterparty_data.py +114 -0
  482. unit_finance_sdk/models/update_counterparty_data_attributes.py +107 -0
  483. unit_finance_sdk/models/update_counterparty_request.py +105 -0
  484. unit_finance_sdk/models/update_credit_account_data.py +114 -0
  485. unit_finance_sdk/models/update_credit_account_data_attributes.py +103 -0
  486. unit_finance_sdk/models/update_credit_account_request.py +105 -0
  487. unit_finance_sdk/models/update_customer200_response.py +105 -0
  488. unit_finance_sdk/models/update_customer_request.py +137 -0
  489. unit_finance_sdk/models/update_data.py +114 -0
  490. unit_finance_sdk/models/update_data_attributes.py +103 -0
  491. unit_finance_sdk/models/update_deposit_account_data.py +114 -0
  492. unit_finance_sdk/models/update_deposit_account_data_attributes.py +103 -0
  493. unit_finance_sdk/models/update_deposit_account_request.py +105 -0
  494. unit_finance_sdk/models/update_individual_application_data.py +114 -0
  495. unit_finance_sdk/models/update_individual_application_data_attributes.py +110 -0
  496. unit_finance_sdk/models/update_individual_application_request.py +105 -0
  497. unit_finance_sdk/models/update_individual_customer_data.py +114 -0
  498. unit_finance_sdk/models/update_individual_customer_data_attributes.py +149 -0
  499. unit_finance_sdk/models/update_individual_customer_request.py +105 -0
  500. unit_finance_sdk/models/update_payment200_response.py +105 -0
  501. unit_finance_sdk/models/update_payment200_response_data.py +140 -0
  502. unit_finance_sdk/models/update_payment_request.py +137 -0
  503. unit_finance_sdk/models/update_realtime_received_payment_data.py +114 -0
  504. unit_finance_sdk/models/update_realtime_received_payment_request.py +105 -0
  505. unit_finance_sdk/models/update_received_payment200_response.py +105 -0
  506. unit_finance_sdk/models/update_received_payment_request.py +137 -0
  507. unit_finance_sdk/models/update_sole_proprietor_application_data.py +114 -0
  508. unit_finance_sdk/models/update_sole_proprietor_application_data_attributes.py +112 -0
  509. unit_finance_sdk/models/update_sole_proprietor_application_request.py +105 -0
  510. unit_finance_sdk/models/update_tags_data.py +114 -0
  511. unit_finance_sdk/models/update_tags_data_attributes.py +101 -0
  512. unit_finance_sdk/models/update_tags_request.py +105 -0
  513. unit_finance_sdk/models/update_transaction200_response.py +105 -0
  514. unit_finance_sdk/models/update_transaction_request.py +137 -0
  515. unit_finance_sdk/models/update_wallet_data.py +114 -0
  516. unit_finance_sdk/models/update_wallet_data_attributes.py +105 -0
  517. unit_finance_sdk/models/update_wallet_request.py +105 -0
  518. unit_finance_sdk/models/wallet_account.py +122 -0
  519. unit_finance_sdk/models/wallet_account_attributes.py +128 -0
  520. unit_finance_sdk/models/wire_counterparty_type.py +111 -0
  521. unit_finance_sdk/models/wire_drawdown.py +122 -0
  522. unit_finance_sdk/models/wire_drawdown_attributes.py +128 -0
  523. unit_finance_sdk/models/wire_drawdown_relationships.py +115 -0
  524. unit_finance_sdk/models/wire_payment.py +122 -0
  525. unit_finance_sdk/models/wire_payment_attributes.py +122 -0
  526. unit_finance_sdk/models/wire_payment_relationships.py +125 -0
  527. unit_finance_sdk/models/wire_transaction.py +122 -0
  528. unit_finance_sdk/models/wire_transaction_attributes.py +132 -0
  529. unit_finance_sdk/models/write_off_transaction.py +122 -0
  530. unit_finance_sdk/py.typed +0 -0
  531. unit_finance_sdk/rest.py +263 -0
  532. unit_openapi_python_sdk-0.9.0.dist-info/METADATA +730 -0
  533. unit_openapi_python_sdk-0.9.0.dist-info/RECORD +535 -0
  534. {unit_openapi_python_sdk-0.0.2.dist-info → unit_openapi_python_sdk-0.9.0.dist-info}/WHEEL +1 -1
  535. unit_openapi_python_sdk-0.9.0.dist-info/top_level.txt +1 -0
  536. unit_openapi_python_sdk-0.0.2.dist-info/LICENSE.md +0 -373
  537. unit_openapi_python_sdk-0.0.2.dist-info/METADATA +0 -18
  538. unit_openapi_python_sdk-0.0.2.dist-info/RECORD +0 -5
  539. unit_openapi_python_sdk-0.0.2.dist-info/top_level.txt +0 -1
@@ -0,0 +1,3370 @@
1
+ """
2
+ Unit API
3
+
4
+ JSON:API-compliant banking API.
5
+
6
+ The version of the OpenAPI document: 0.9.0
7
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
8
+
9
+ Do not edit the class manually.
10
+ """ # noqa: E501
11
+
12
+
13
+ import warnings
14
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
15
+ from typing import Any, Dict, List, Optional, Tuple, Union
16
+ from typing_extensions import Annotated
17
+
18
+ from pydantic import Field, StrictBytes, StrictStr
19
+ from typing import Any, Dict, Optional, Tuple, Union
20
+ from typing_extensions import Annotated
21
+ from unit_finance_sdk.models.create_check_deposit201_response import CreateCheckDeposit201Response
22
+ from unit_finance_sdk.models.create_check_deposit_request import CreateCheckDepositRequest
23
+ from unit_finance_sdk.models.create_check_deposit_send_link201_response import CreateCheckDepositSendLink201Response
24
+ from unit_finance_sdk.models.create_check_deposit_send_link_request import CreateCheckDepositSendLinkRequest
25
+ from unit_finance_sdk.models.get_check_deposit200_response import GetCheckDeposit200Response
26
+ from unit_finance_sdk.models.list_check_deposits200_response import ListCheckDeposits200Response
27
+ from unit_finance_sdk.models.update_check_deposit_request import UpdateCheckDepositRequest
28
+
29
+ from unit_finance_sdk.api_client import ApiClient, RequestSerialized
30
+ from unit_finance_sdk.api_response import ApiResponse
31
+ from unit_finance_sdk.rest import RESTResponseType
32
+
33
+
34
+ class CheckDepositsApi:
35
+ """NOTE: This class is auto generated by OpenAPI Generator
36
+ Ref: https://openapi-generator.tech
37
+
38
+ Do not edit the class manually.
39
+ """
40
+
41
+ def __init__(self, api_client=None) -> None:
42
+ if api_client is None:
43
+ api_client = ApiClient.get_default()
44
+ self.api_client = api_client
45
+
46
+
47
+ @validate_call
48
+ def clear_check_deposit(
49
+ self,
50
+ check_deposit_id: StrictStr,
51
+ body: Optional[Dict[str, Any]] = None,
52
+ _request_timeout: Union[
53
+ None,
54
+ Annotated[StrictFloat, Field(gt=0)],
55
+ Tuple[
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Annotated[StrictFloat, Field(gt=0)]
58
+ ]
59
+ ] = None,
60
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
61
+ _content_type: Optional[StrictStr] = None,
62
+ _headers: Optional[Dict[StrictStr, Any]] = None,
63
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
64
+ ) -> CreateCheckDeposit201Response:
65
+ """Clear a check deposit
66
+
67
+ Clears a check deposit while in `Clearing` status. Overrides the original clearing period, making funds available immediately. Requires the Dynamic Clearing Period feature to be enabled.
68
+
69
+ :param check_deposit_id: (required)
70
+ :type check_deposit_id: str
71
+ :param body:
72
+ :type body: object
73
+ :param _request_timeout: timeout setting for this request. If one
74
+ number provided, it will be total request
75
+ timeout. It can also be a pair (tuple) of
76
+ (connection, read) timeouts.
77
+ :type _request_timeout: int, tuple(int, int), optional
78
+ :param _request_auth: set to override the auth_settings for an a single
79
+ request; this effectively ignores the
80
+ authentication in the spec for a single request.
81
+ :type _request_auth: dict, optional
82
+ :param _content_type: force content-type for the request.
83
+ :type _content_type: str, Optional
84
+ :param _headers: set to override the headers for a single
85
+ request; this effectively ignores the headers
86
+ in the spec for a single request.
87
+ :type _headers: dict, optional
88
+ :param _host_index: set to override the host_index for a single
89
+ request; this effectively ignores the host_index
90
+ in the spec for a single request.
91
+ :type _host_index: int, optional
92
+ :return: Returns the result object.
93
+ """ # noqa: E501
94
+
95
+ _param = self._clear_check_deposit_serialize(
96
+ check_deposit_id=check_deposit_id,
97
+ body=body,
98
+ _request_auth=_request_auth,
99
+ _content_type=_content_type,
100
+ _headers=_headers,
101
+ _host_index=_host_index
102
+ )
103
+
104
+ _response_types_map: Dict[str, Optional[str]] = {
105
+ '200': "CreateCheckDeposit201Response",
106
+ '400': "ErrorDocument",
107
+ '401': "ErrorDocument",
108
+ '404': "ErrorDocument",
109
+ }
110
+ response_data = self.api_client.call_api(
111
+ *_param,
112
+ _request_timeout=_request_timeout
113
+ )
114
+ response_data.read()
115
+ return self.api_client.response_deserialize(
116
+ response_data=response_data,
117
+ response_types_map=_response_types_map,
118
+ ).data
119
+
120
+
121
+ @validate_call
122
+ def clear_check_deposit_with_http_info(
123
+ self,
124
+ check_deposit_id: StrictStr,
125
+ body: Optional[Dict[str, Any]] = None,
126
+ _request_timeout: Union[
127
+ None,
128
+ Annotated[StrictFloat, Field(gt=0)],
129
+ Tuple[
130
+ Annotated[StrictFloat, Field(gt=0)],
131
+ Annotated[StrictFloat, Field(gt=0)]
132
+ ]
133
+ ] = None,
134
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
135
+ _content_type: Optional[StrictStr] = None,
136
+ _headers: Optional[Dict[StrictStr, Any]] = None,
137
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
138
+ ) -> ApiResponse[CreateCheckDeposit201Response]:
139
+ """Clear a check deposit
140
+
141
+ Clears a check deposit while in `Clearing` status. Overrides the original clearing period, making funds available immediately. Requires the Dynamic Clearing Period feature to be enabled.
142
+
143
+ :param check_deposit_id: (required)
144
+ :type check_deposit_id: str
145
+ :param body:
146
+ :type body: object
147
+ :param _request_timeout: timeout setting for this request. If one
148
+ number provided, it will be total request
149
+ timeout. It can also be a pair (tuple) of
150
+ (connection, read) timeouts.
151
+ :type _request_timeout: int, tuple(int, int), optional
152
+ :param _request_auth: set to override the auth_settings for an a single
153
+ request; this effectively ignores the
154
+ authentication in the spec for a single request.
155
+ :type _request_auth: dict, optional
156
+ :param _content_type: force content-type for the request.
157
+ :type _content_type: str, Optional
158
+ :param _headers: set to override the headers for a single
159
+ request; this effectively ignores the headers
160
+ in the spec for a single request.
161
+ :type _headers: dict, optional
162
+ :param _host_index: set to override the host_index for a single
163
+ request; this effectively ignores the host_index
164
+ in the spec for a single request.
165
+ :type _host_index: int, optional
166
+ :return: Returns the result object.
167
+ """ # noqa: E501
168
+
169
+ _param = self._clear_check_deposit_serialize(
170
+ check_deposit_id=check_deposit_id,
171
+ body=body,
172
+ _request_auth=_request_auth,
173
+ _content_type=_content_type,
174
+ _headers=_headers,
175
+ _host_index=_host_index
176
+ )
177
+
178
+ _response_types_map: Dict[str, Optional[str]] = {
179
+ '200': "CreateCheckDeposit201Response",
180
+ '400': "ErrorDocument",
181
+ '401': "ErrorDocument",
182
+ '404': "ErrorDocument",
183
+ }
184
+ response_data = self.api_client.call_api(
185
+ *_param,
186
+ _request_timeout=_request_timeout
187
+ )
188
+ response_data.read()
189
+ return self.api_client.response_deserialize(
190
+ response_data=response_data,
191
+ response_types_map=_response_types_map,
192
+ )
193
+
194
+
195
+ @validate_call
196
+ def clear_check_deposit_without_preload_content(
197
+ self,
198
+ check_deposit_id: StrictStr,
199
+ body: Optional[Dict[str, Any]] = None,
200
+ _request_timeout: Union[
201
+ None,
202
+ Annotated[StrictFloat, Field(gt=0)],
203
+ Tuple[
204
+ Annotated[StrictFloat, Field(gt=0)],
205
+ Annotated[StrictFloat, Field(gt=0)]
206
+ ]
207
+ ] = None,
208
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
209
+ _content_type: Optional[StrictStr] = None,
210
+ _headers: Optional[Dict[StrictStr, Any]] = None,
211
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
212
+ ) -> RESTResponseType:
213
+ """Clear a check deposit
214
+
215
+ Clears a check deposit while in `Clearing` status. Overrides the original clearing period, making funds available immediately. Requires the Dynamic Clearing Period feature to be enabled.
216
+
217
+ :param check_deposit_id: (required)
218
+ :type check_deposit_id: str
219
+ :param body:
220
+ :type body: object
221
+ :param _request_timeout: timeout setting for this request. If one
222
+ number provided, it will be total request
223
+ timeout. It can also be a pair (tuple) of
224
+ (connection, read) timeouts.
225
+ :type _request_timeout: int, tuple(int, int), optional
226
+ :param _request_auth: set to override the auth_settings for an a single
227
+ request; this effectively ignores the
228
+ authentication in the spec for a single request.
229
+ :type _request_auth: dict, optional
230
+ :param _content_type: force content-type for the request.
231
+ :type _content_type: str, Optional
232
+ :param _headers: set to override the headers for a single
233
+ request; this effectively ignores the headers
234
+ in the spec for a single request.
235
+ :type _headers: dict, optional
236
+ :param _host_index: set to override the host_index for a single
237
+ request; this effectively ignores the host_index
238
+ in the spec for a single request.
239
+ :type _host_index: int, optional
240
+ :return: Returns the result object.
241
+ """ # noqa: E501
242
+
243
+ _param = self._clear_check_deposit_serialize(
244
+ check_deposit_id=check_deposit_id,
245
+ body=body,
246
+ _request_auth=_request_auth,
247
+ _content_type=_content_type,
248
+ _headers=_headers,
249
+ _host_index=_host_index
250
+ )
251
+
252
+ _response_types_map: Dict[str, Optional[str]] = {
253
+ '200': "CreateCheckDeposit201Response",
254
+ '400': "ErrorDocument",
255
+ '401': "ErrorDocument",
256
+ '404': "ErrorDocument",
257
+ }
258
+ response_data = self.api_client.call_api(
259
+ *_param,
260
+ _request_timeout=_request_timeout
261
+ )
262
+ return response_data.response
263
+
264
+
265
+ def _clear_check_deposit_serialize(
266
+ self,
267
+ check_deposit_id,
268
+ body,
269
+ _request_auth,
270
+ _content_type,
271
+ _headers,
272
+ _host_index,
273
+ ) -> RequestSerialized:
274
+
275
+ _host = None
276
+
277
+ _collection_formats: Dict[str, str] = {
278
+ }
279
+
280
+ _path_params: Dict[str, str] = {}
281
+ _query_params: List[Tuple[str, str]] = []
282
+ _header_params: Dict[str, Optional[str]] = _headers or {}
283
+ _form_params: List[Tuple[str, str]] = []
284
+ _files: Dict[
285
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
286
+ ] = {}
287
+ _body_params: Optional[bytes] = None
288
+
289
+ # process the path parameters
290
+ if check_deposit_id is not None:
291
+ _path_params['checkDepositId'] = check_deposit_id
292
+ # process the query parameters
293
+ # process the header parameters
294
+ # process the form parameters
295
+ # process the body parameter
296
+ if body is not None:
297
+ _body_params = body
298
+
299
+
300
+ # set the HTTP header `Accept`
301
+ if 'Accept' not in _header_params:
302
+ _header_params['Accept'] = self.api_client.select_header_accept(
303
+ [
304
+ 'application/vnd.api+json'
305
+ ]
306
+ )
307
+
308
+ # set the HTTP header `Content-Type`
309
+ if _content_type:
310
+ _header_params['Content-Type'] = _content_type
311
+ else:
312
+ _default_content_type = (
313
+ self.api_client.select_header_content_type(
314
+ [
315
+ 'application/vnd.api+json'
316
+ ]
317
+ )
318
+ )
319
+ if _default_content_type is not None:
320
+ _header_params['Content-Type'] = _default_content_type
321
+
322
+ # authentication setting
323
+ _auth_settings: List[str] = [
324
+ 'bearerAuth'
325
+ ]
326
+
327
+ return self.api_client.param_serialize(
328
+ method='POST',
329
+ resource_path='/check-deposits/{checkDepositId}/clear',
330
+ path_params=_path_params,
331
+ query_params=_query_params,
332
+ header_params=_header_params,
333
+ body=_body_params,
334
+ post_params=_form_params,
335
+ files=_files,
336
+ auth_settings=_auth_settings,
337
+ collection_formats=_collection_formats,
338
+ _host=_host,
339
+ _request_auth=_request_auth
340
+ )
341
+
342
+
343
+
344
+
345
+ @validate_call
346
+ def confirm_check_deposit_details(
347
+ self,
348
+ check_deposit_id: StrictStr,
349
+ body: Optional[Dict[str, Any]] = None,
350
+ _request_timeout: Union[
351
+ None,
352
+ Annotated[StrictFloat, Field(gt=0)],
353
+ Tuple[
354
+ Annotated[StrictFloat, Field(gt=0)],
355
+ Annotated[StrictFloat, Field(gt=0)]
356
+ ]
357
+ ] = None,
358
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
359
+ _content_type: Optional[StrictStr] = None,
360
+ _headers: Optional[Dict[StrictStr, Any]] = None,
361
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
362
+ ) -> None:
363
+ """Confirm check deposit details
364
+
365
+ Confirms a check deposit details when it's in `AwaitingCustomerConfirmation` status
366
+
367
+ :param check_deposit_id: (required)
368
+ :type check_deposit_id: str
369
+ :param body:
370
+ :type body: object
371
+ :param _request_timeout: timeout setting for this request. If one
372
+ number provided, it will be total request
373
+ timeout. It can also be a pair (tuple) of
374
+ (connection, read) timeouts.
375
+ :type _request_timeout: int, tuple(int, int), optional
376
+ :param _request_auth: set to override the auth_settings for an a single
377
+ request; this effectively ignores the
378
+ authentication in the spec for a single request.
379
+ :type _request_auth: dict, optional
380
+ :param _content_type: force content-type for the request.
381
+ :type _content_type: str, Optional
382
+ :param _headers: set to override the headers for a single
383
+ request; this effectively ignores the headers
384
+ in the spec for a single request.
385
+ :type _headers: dict, optional
386
+ :param _host_index: set to override the host_index for a single
387
+ request; this effectively ignores the host_index
388
+ in the spec for a single request.
389
+ :type _host_index: int, optional
390
+ :return: Returns the result object.
391
+ """ # noqa: E501
392
+
393
+ _param = self._confirm_check_deposit_details_serialize(
394
+ check_deposit_id=check_deposit_id,
395
+ body=body,
396
+ _request_auth=_request_auth,
397
+ _content_type=_content_type,
398
+ _headers=_headers,
399
+ _host_index=_host_index
400
+ )
401
+
402
+ _response_types_map: Dict[str, Optional[str]] = {
403
+ '200': None,
404
+ '400': "ErrorDocument",
405
+ '401': "ErrorDocument",
406
+ '404': "ErrorDocument",
407
+ }
408
+ response_data = self.api_client.call_api(
409
+ *_param,
410
+ _request_timeout=_request_timeout
411
+ )
412
+ response_data.read()
413
+ return self.api_client.response_deserialize(
414
+ response_data=response_data,
415
+ response_types_map=_response_types_map,
416
+ ).data
417
+
418
+
419
+ @validate_call
420
+ def confirm_check_deposit_details_with_http_info(
421
+ self,
422
+ check_deposit_id: StrictStr,
423
+ body: Optional[Dict[str, Any]] = None,
424
+ _request_timeout: Union[
425
+ None,
426
+ Annotated[StrictFloat, Field(gt=0)],
427
+ Tuple[
428
+ Annotated[StrictFloat, Field(gt=0)],
429
+ Annotated[StrictFloat, Field(gt=0)]
430
+ ]
431
+ ] = None,
432
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
433
+ _content_type: Optional[StrictStr] = None,
434
+ _headers: Optional[Dict[StrictStr, Any]] = None,
435
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
436
+ ) -> ApiResponse[None]:
437
+ """Confirm check deposit details
438
+
439
+ Confirms a check deposit details when it's in `AwaitingCustomerConfirmation` status
440
+
441
+ :param check_deposit_id: (required)
442
+ :type check_deposit_id: str
443
+ :param body:
444
+ :type body: object
445
+ :param _request_timeout: timeout setting for this request. If one
446
+ number provided, it will be total request
447
+ timeout. It can also be a pair (tuple) of
448
+ (connection, read) timeouts.
449
+ :type _request_timeout: int, tuple(int, int), optional
450
+ :param _request_auth: set to override the auth_settings for an a single
451
+ request; this effectively ignores the
452
+ authentication in the spec for a single request.
453
+ :type _request_auth: dict, optional
454
+ :param _content_type: force content-type for the request.
455
+ :type _content_type: str, Optional
456
+ :param _headers: set to override the headers for a single
457
+ request; this effectively ignores the headers
458
+ in the spec for a single request.
459
+ :type _headers: dict, optional
460
+ :param _host_index: set to override the host_index for a single
461
+ request; this effectively ignores the host_index
462
+ in the spec for a single request.
463
+ :type _host_index: int, optional
464
+ :return: Returns the result object.
465
+ """ # noqa: E501
466
+
467
+ _param = self._confirm_check_deposit_details_serialize(
468
+ check_deposit_id=check_deposit_id,
469
+ body=body,
470
+ _request_auth=_request_auth,
471
+ _content_type=_content_type,
472
+ _headers=_headers,
473
+ _host_index=_host_index
474
+ )
475
+
476
+ _response_types_map: Dict[str, Optional[str]] = {
477
+ '200': None,
478
+ '400': "ErrorDocument",
479
+ '401': "ErrorDocument",
480
+ '404': "ErrorDocument",
481
+ }
482
+ response_data = self.api_client.call_api(
483
+ *_param,
484
+ _request_timeout=_request_timeout
485
+ )
486
+ response_data.read()
487
+ return self.api_client.response_deserialize(
488
+ response_data=response_data,
489
+ response_types_map=_response_types_map,
490
+ )
491
+
492
+
493
+ @validate_call
494
+ def confirm_check_deposit_details_without_preload_content(
495
+ self,
496
+ check_deposit_id: StrictStr,
497
+ body: Optional[Dict[str, Any]] = None,
498
+ _request_timeout: Union[
499
+ None,
500
+ Annotated[StrictFloat, Field(gt=0)],
501
+ Tuple[
502
+ Annotated[StrictFloat, Field(gt=0)],
503
+ Annotated[StrictFloat, Field(gt=0)]
504
+ ]
505
+ ] = None,
506
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
507
+ _content_type: Optional[StrictStr] = None,
508
+ _headers: Optional[Dict[StrictStr, Any]] = None,
509
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
510
+ ) -> RESTResponseType:
511
+ """Confirm check deposit details
512
+
513
+ Confirms a check deposit details when it's in `AwaitingCustomerConfirmation` status
514
+
515
+ :param check_deposit_id: (required)
516
+ :type check_deposit_id: str
517
+ :param body:
518
+ :type body: object
519
+ :param _request_timeout: timeout setting for this request. If one
520
+ number provided, it will be total request
521
+ timeout. It can also be a pair (tuple) of
522
+ (connection, read) timeouts.
523
+ :type _request_timeout: int, tuple(int, int), optional
524
+ :param _request_auth: set to override the auth_settings for an a single
525
+ request; this effectively ignores the
526
+ authentication in the spec for a single request.
527
+ :type _request_auth: dict, optional
528
+ :param _content_type: force content-type for the request.
529
+ :type _content_type: str, Optional
530
+ :param _headers: set to override the headers for a single
531
+ request; this effectively ignores the headers
532
+ in the spec for a single request.
533
+ :type _headers: dict, optional
534
+ :param _host_index: set to override the host_index for a single
535
+ request; this effectively ignores the host_index
536
+ in the spec for a single request.
537
+ :type _host_index: int, optional
538
+ :return: Returns the result object.
539
+ """ # noqa: E501
540
+
541
+ _param = self._confirm_check_deposit_details_serialize(
542
+ check_deposit_id=check_deposit_id,
543
+ body=body,
544
+ _request_auth=_request_auth,
545
+ _content_type=_content_type,
546
+ _headers=_headers,
547
+ _host_index=_host_index
548
+ )
549
+
550
+ _response_types_map: Dict[str, Optional[str]] = {
551
+ '200': None,
552
+ '400': "ErrorDocument",
553
+ '401': "ErrorDocument",
554
+ '404': "ErrorDocument",
555
+ }
556
+ response_data = self.api_client.call_api(
557
+ *_param,
558
+ _request_timeout=_request_timeout
559
+ )
560
+ return response_data.response
561
+
562
+
563
+ def _confirm_check_deposit_details_serialize(
564
+ self,
565
+ check_deposit_id,
566
+ body,
567
+ _request_auth,
568
+ _content_type,
569
+ _headers,
570
+ _host_index,
571
+ ) -> RequestSerialized:
572
+
573
+ _host = None
574
+
575
+ _collection_formats: Dict[str, str] = {
576
+ }
577
+
578
+ _path_params: Dict[str, str] = {}
579
+ _query_params: List[Tuple[str, str]] = []
580
+ _header_params: Dict[str, Optional[str]] = _headers or {}
581
+ _form_params: List[Tuple[str, str]] = []
582
+ _files: Dict[
583
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
584
+ ] = {}
585
+ _body_params: Optional[bytes] = None
586
+
587
+ # process the path parameters
588
+ if check_deposit_id is not None:
589
+ _path_params['checkDepositId'] = check_deposit_id
590
+ # process the query parameters
591
+ # process the header parameters
592
+ # process the form parameters
593
+ # process the body parameter
594
+ if body is not None:
595
+ _body_params = body
596
+
597
+
598
+ # set the HTTP header `Accept`
599
+ if 'Accept' not in _header_params:
600
+ _header_params['Accept'] = self.api_client.select_header_accept(
601
+ [
602
+ 'application/vnd.api+json'
603
+ ]
604
+ )
605
+
606
+ # set the HTTP header `Content-Type`
607
+ if _content_type:
608
+ _header_params['Content-Type'] = _content_type
609
+ else:
610
+ _default_content_type = (
611
+ self.api_client.select_header_content_type(
612
+ [
613
+ 'application/vnd.api+json'
614
+ ]
615
+ )
616
+ )
617
+ if _default_content_type is not None:
618
+ _header_params['Content-Type'] = _default_content_type
619
+
620
+ # authentication setting
621
+ _auth_settings: List[str] = [
622
+ 'bearerAuth'
623
+ ]
624
+
625
+ return self.api_client.param_serialize(
626
+ method='POST',
627
+ resource_path='/check-deposits/{checkDepositId}/confirm',
628
+ path_params=_path_params,
629
+ query_params=_query_params,
630
+ header_params=_header_params,
631
+ body=_body_params,
632
+ post_params=_form_params,
633
+ files=_files,
634
+ auth_settings=_auth_settings,
635
+ collection_formats=_collection_formats,
636
+ _host=_host,
637
+ _request_auth=_request_auth
638
+ )
639
+
640
+
641
+
642
+
643
+ @validate_call
644
+ def create_check_deposit(
645
+ self,
646
+ create_check_deposit_request: CreateCheckDepositRequest,
647
+ _request_timeout: Union[
648
+ None,
649
+ Annotated[StrictFloat, Field(gt=0)],
650
+ Tuple[
651
+ Annotated[StrictFloat, Field(gt=0)],
652
+ Annotated[StrictFloat, Field(gt=0)]
653
+ ]
654
+ ] = None,
655
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
656
+ _content_type: Optional[StrictStr] = None,
657
+ _headers: Optional[Dict[StrictStr, Any]] = None,
658
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
659
+ ) -> CreateCheckDeposit201Response:
660
+ """Create a check deposit
661
+
662
+ Creates a check deposit for an `Account`.
663
+
664
+ :param create_check_deposit_request: (required)
665
+ :type create_check_deposit_request: CreateCheckDepositRequest
666
+ :param _request_timeout: timeout setting for this request. If one
667
+ number provided, it will be total request
668
+ timeout. It can also be a pair (tuple) of
669
+ (connection, read) timeouts.
670
+ :type _request_timeout: int, tuple(int, int), optional
671
+ :param _request_auth: set to override the auth_settings for an a single
672
+ request; this effectively ignores the
673
+ authentication in the spec for a single request.
674
+ :type _request_auth: dict, optional
675
+ :param _content_type: force content-type for the request.
676
+ :type _content_type: str, Optional
677
+ :param _headers: set to override the headers for a single
678
+ request; this effectively ignores the headers
679
+ in the spec for a single request.
680
+ :type _headers: dict, optional
681
+ :param _host_index: set to override the host_index for a single
682
+ request; this effectively ignores the host_index
683
+ in the spec for a single request.
684
+ :type _host_index: int, optional
685
+ :return: Returns the result object.
686
+ """ # noqa: E501
687
+
688
+ _param = self._create_check_deposit_serialize(
689
+ create_check_deposit_request=create_check_deposit_request,
690
+ _request_auth=_request_auth,
691
+ _content_type=_content_type,
692
+ _headers=_headers,
693
+ _host_index=_host_index
694
+ )
695
+
696
+ _response_types_map: Dict[str, Optional[str]] = {
697
+ '201': "CreateCheckDeposit201Response",
698
+ '400': "ErrorDocument",
699
+ '401': "ErrorDocument",
700
+ '404': "ErrorDocument",
701
+ }
702
+ response_data = self.api_client.call_api(
703
+ *_param,
704
+ _request_timeout=_request_timeout
705
+ )
706
+ response_data.read()
707
+ return self.api_client.response_deserialize(
708
+ response_data=response_data,
709
+ response_types_map=_response_types_map,
710
+ ).data
711
+
712
+
713
+ @validate_call
714
+ def create_check_deposit_with_http_info(
715
+ self,
716
+ create_check_deposit_request: CreateCheckDepositRequest,
717
+ _request_timeout: Union[
718
+ None,
719
+ Annotated[StrictFloat, Field(gt=0)],
720
+ Tuple[
721
+ Annotated[StrictFloat, Field(gt=0)],
722
+ Annotated[StrictFloat, Field(gt=0)]
723
+ ]
724
+ ] = None,
725
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
726
+ _content_type: Optional[StrictStr] = None,
727
+ _headers: Optional[Dict[StrictStr, Any]] = None,
728
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
729
+ ) -> ApiResponse[CreateCheckDeposit201Response]:
730
+ """Create a check deposit
731
+
732
+ Creates a check deposit for an `Account`.
733
+
734
+ :param create_check_deposit_request: (required)
735
+ :type create_check_deposit_request: CreateCheckDepositRequest
736
+ :param _request_timeout: timeout setting for this request. If one
737
+ number provided, it will be total request
738
+ timeout. It can also be a pair (tuple) of
739
+ (connection, read) timeouts.
740
+ :type _request_timeout: int, tuple(int, int), optional
741
+ :param _request_auth: set to override the auth_settings for an a single
742
+ request; this effectively ignores the
743
+ authentication in the spec for a single request.
744
+ :type _request_auth: dict, optional
745
+ :param _content_type: force content-type for the request.
746
+ :type _content_type: str, Optional
747
+ :param _headers: set to override the headers for a single
748
+ request; this effectively ignores the headers
749
+ in the spec for a single request.
750
+ :type _headers: dict, optional
751
+ :param _host_index: set to override the host_index for a single
752
+ request; this effectively ignores the host_index
753
+ in the spec for a single request.
754
+ :type _host_index: int, optional
755
+ :return: Returns the result object.
756
+ """ # noqa: E501
757
+
758
+ _param = self._create_check_deposit_serialize(
759
+ create_check_deposit_request=create_check_deposit_request,
760
+ _request_auth=_request_auth,
761
+ _content_type=_content_type,
762
+ _headers=_headers,
763
+ _host_index=_host_index
764
+ )
765
+
766
+ _response_types_map: Dict[str, Optional[str]] = {
767
+ '201': "CreateCheckDeposit201Response",
768
+ '400': "ErrorDocument",
769
+ '401': "ErrorDocument",
770
+ '404': "ErrorDocument",
771
+ }
772
+ response_data = self.api_client.call_api(
773
+ *_param,
774
+ _request_timeout=_request_timeout
775
+ )
776
+ response_data.read()
777
+ return self.api_client.response_deserialize(
778
+ response_data=response_data,
779
+ response_types_map=_response_types_map,
780
+ )
781
+
782
+
783
+ @validate_call
784
+ def create_check_deposit_without_preload_content(
785
+ self,
786
+ create_check_deposit_request: CreateCheckDepositRequest,
787
+ _request_timeout: Union[
788
+ None,
789
+ Annotated[StrictFloat, Field(gt=0)],
790
+ Tuple[
791
+ Annotated[StrictFloat, Field(gt=0)],
792
+ Annotated[StrictFloat, Field(gt=0)]
793
+ ]
794
+ ] = None,
795
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
796
+ _content_type: Optional[StrictStr] = None,
797
+ _headers: Optional[Dict[StrictStr, Any]] = None,
798
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
799
+ ) -> RESTResponseType:
800
+ """Create a check deposit
801
+
802
+ Creates a check deposit for an `Account`.
803
+
804
+ :param create_check_deposit_request: (required)
805
+ :type create_check_deposit_request: CreateCheckDepositRequest
806
+ :param _request_timeout: timeout setting for this request. If one
807
+ number provided, it will be total request
808
+ timeout. It can also be a pair (tuple) of
809
+ (connection, read) timeouts.
810
+ :type _request_timeout: int, tuple(int, int), optional
811
+ :param _request_auth: set to override the auth_settings for an a single
812
+ request; this effectively ignores the
813
+ authentication in the spec for a single request.
814
+ :type _request_auth: dict, optional
815
+ :param _content_type: force content-type for the request.
816
+ :type _content_type: str, Optional
817
+ :param _headers: set to override the headers for a single
818
+ request; this effectively ignores the headers
819
+ in the spec for a single request.
820
+ :type _headers: dict, optional
821
+ :param _host_index: set to override the host_index for a single
822
+ request; this effectively ignores the host_index
823
+ in the spec for a single request.
824
+ :type _host_index: int, optional
825
+ :return: Returns the result object.
826
+ """ # noqa: E501
827
+
828
+ _param = self._create_check_deposit_serialize(
829
+ create_check_deposit_request=create_check_deposit_request,
830
+ _request_auth=_request_auth,
831
+ _content_type=_content_type,
832
+ _headers=_headers,
833
+ _host_index=_host_index
834
+ )
835
+
836
+ _response_types_map: Dict[str, Optional[str]] = {
837
+ '201': "CreateCheckDeposit201Response",
838
+ '400': "ErrorDocument",
839
+ '401': "ErrorDocument",
840
+ '404': "ErrorDocument",
841
+ }
842
+ response_data = self.api_client.call_api(
843
+ *_param,
844
+ _request_timeout=_request_timeout
845
+ )
846
+ return response_data.response
847
+
848
+
849
+ def _create_check_deposit_serialize(
850
+ self,
851
+ create_check_deposit_request,
852
+ _request_auth,
853
+ _content_type,
854
+ _headers,
855
+ _host_index,
856
+ ) -> RequestSerialized:
857
+
858
+ _host = None
859
+
860
+ _collection_formats: Dict[str, str] = {
861
+ }
862
+
863
+ _path_params: Dict[str, str] = {}
864
+ _query_params: List[Tuple[str, str]] = []
865
+ _header_params: Dict[str, Optional[str]] = _headers or {}
866
+ _form_params: List[Tuple[str, str]] = []
867
+ _files: Dict[
868
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
869
+ ] = {}
870
+ _body_params: Optional[bytes] = None
871
+
872
+ # process the path parameters
873
+ # process the query parameters
874
+ # process the header parameters
875
+ # process the form parameters
876
+ # process the body parameter
877
+ if create_check_deposit_request is not None:
878
+ _body_params = create_check_deposit_request
879
+
880
+
881
+ # set the HTTP header `Accept`
882
+ if 'Accept' not in _header_params:
883
+ _header_params['Accept'] = self.api_client.select_header_accept(
884
+ [
885
+ 'application/vnd.api+json'
886
+ ]
887
+ )
888
+
889
+ # set the HTTP header `Content-Type`
890
+ if _content_type:
891
+ _header_params['Content-Type'] = _content_type
892
+ else:
893
+ _default_content_type = (
894
+ self.api_client.select_header_content_type(
895
+ [
896
+ 'application/vnd.api+json'
897
+ ]
898
+ )
899
+ )
900
+ if _default_content_type is not None:
901
+ _header_params['Content-Type'] = _default_content_type
902
+
903
+ # authentication setting
904
+ _auth_settings: List[str] = [
905
+ 'bearerAuth'
906
+ ]
907
+
908
+ return self.api_client.param_serialize(
909
+ method='POST',
910
+ resource_path='/check-deposits',
911
+ path_params=_path_params,
912
+ query_params=_query_params,
913
+ header_params=_header_params,
914
+ body=_body_params,
915
+ post_params=_form_params,
916
+ files=_files,
917
+ auth_settings=_auth_settings,
918
+ collection_formats=_collection_formats,
919
+ _host=_host,
920
+ _request_auth=_request_auth
921
+ )
922
+
923
+
924
+
925
+
926
+ @validate_call
927
+ def create_check_deposit_send_link(
928
+ self,
929
+ create_check_deposit_send_link_request: CreateCheckDepositSendLinkRequest,
930
+ _request_timeout: Union[
931
+ None,
932
+ Annotated[StrictFloat, Field(gt=0)],
933
+ Tuple[
934
+ Annotated[StrictFloat, Field(gt=0)],
935
+ Annotated[StrictFloat, Field(gt=0)]
936
+ ]
937
+ ] = None,
938
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
939
+ _content_type: Optional[StrictStr] = None,
940
+ _headers: Optional[Dict[StrictStr, Any]] = None,
941
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
942
+ ) -> CreateCheckDepositSendLink201Response:
943
+ """Create a check deposit send link
944
+
945
+ Creates a shareable link for the Check Deposit component for an `Account`. The link can be sent to an end user via SMS or email and used to complete a check deposit. Unless a White Label Theme is customized, the component uses the default theme. Unless an Email Domain is customized the link will be created under a default domain starting in `https://application-form.sh`.
946
+
947
+ :param create_check_deposit_send_link_request: (required)
948
+ :type create_check_deposit_send_link_request: CreateCheckDepositSendLinkRequest
949
+ :param _request_timeout: timeout setting for this request. If one
950
+ number provided, it will be total request
951
+ timeout. It can also be a pair (tuple) of
952
+ (connection, read) timeouts.
953
+ :type _request_timeout: int, tuple(int, int), optional
954
+ :param _request_auth: set to override the auth_settings for an a single
955
+ request; this effectively ignores the
956
+ authentication in the spec for a single request.
957
+ :type _request_auth: dict, optional
958
+ :param _content_type: force content-type for the request.
959
+ :type _content_type: str, Optional
960
+ :param _headers: set to override the headers for a single
961
+ request; this effectively ignores the headers
962
+ in the spec for a single request.
963
+ :type _headers: dict, optional
964
+ :param _host_index: set to override the host_index for a single
965
+ request; this effectively ignores the host_index
966
+ in the spec for a single request.
967
+ :type _host_index: int, optional
968
+ :return: Returns the result object.
969
+ """ # noqa: E501
970
+
971
+ _param = self._create_check_deposit_send_link_serialize(
972
+ create_check_deposit_send_link_request=create_check_deposit_send_link_request,
973
+ _request_auth=_request_auth,
974
+ _content_type=_content_type,
975
+ _headers=_headers,
976
+ _host_index=_host_index
977
+ )
978
+
979
+ _response_types_map: Dict[str, Optional[str]] = {
980
+ '201': "CreateCheckDepositSendLink201Response",
981
+ '400': "ErrorDocument",
982
+ '401': "ErrorDocument",
983
+ '404': "ErrorDocument",
984
+ }
985
+ response_data = self.api_client.call_api(
986
+ *_param,
987
+ _request_timeout=_request_timeout
988
+ )
989
+ response_data.read()
990
+ return self.api_client.response_deserialize(
991
+ response_data=response_data,
992
+ response_types_map=_response_types_map,
993
+ ).data
994
+
995
+
996
+ @validate_call
997
+ def create_check_deposit_send_link_with_http_info(
998
+ self,
999
+ create_check_deposit_send_link_request: CreateCheckDepositSendLinkRequest,
1000
+ _request_timeout: Union[
1001
+ None,
1002
+ Annotated[StrictFloat, Field(gt=0)],
1003
+ Tuple[
1004
+ Annotated[StrictFloat, Field(gt=0)],
1005
+ Annotated[StrictFloat, Field(gt=0)]
1006
+ ]
1007
+ ] = None,
1008
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1009
+ _content_type: Optional[StrictStr] = None,
1010
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1011
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1012
+ ) -> ApiResponse[CreateCheckDepositSendLink201Response]:
1013
+ """Create a check deposit send link
1014
+
1015
+ Creates a shareable link for the Check Deposit component for an `Account`. The link can be sent to an end user via SMS or email and used to complete a check deposit. Unless a White Label Theme is customized, the component uses the default theme. Unless an Email Domain is customized the link will be created under a default domain starting in `https://application-form.sh`.
1016
+
1017
+ :param create_check_deposit_send_link_request: (required)
1018
+ :type create_check_deposit_send_link_request: CreateCheckDepositSendLinkRequest
1019
+ :param _request_timeout: timeout setting for this request. If one
1020
+ number provided, it will be total request
1021
+ timeout. It can also be a pair (tuple) of
1022
+ (connection, read) timeouts.
1023
+ :type _request_timeout: int, tuple(int, int), optional
1024
+ :param _request_auth: set to override the auth_settings for an a single
1025
+ request; this effectively ignores the
1026
+ authentication in the spec for a single request.
1027
+ :type _request_auth: dict, optional
1028
+ :param _content_type: force content-type for the request.
1029
+ :type _content_type: str, Optional
1030
+ :param _headers: set to override the headers for a single
1031
+ request; this effectively ignores the headers
1032
+ in the spec for a single request.
1033
+ :type _headers: dict, optional
1034
+ :param _host_index: set to override the host_index for a single
1035
+ request; this effectively ignores the host_index
1036
+ in the spec for a single request.
1037
+ :type _host_index: int, optional
1038
+ :return: Returns the result object.
1039
+ """ # noqa: E501
1040
+
1041
+ _param = self._create_check_deposit_send_link_serialize(
1042
+ create_check_deposit_send_link_request=create_check_deposit_send_link_request,
1043
+ _request_auth=_request_auth,
1044
+ _content_type=_content_type,
1045
+ _headers=_headers,
1046
+ _host_index=_host_index
1047
+ )
1048
+
1049
+ _response_types_map: Dict[str, Optional[str]] = {
1050
+ '201': "CreateCheckDepositSendLink201Response",
1051
+ '400': "ErrorDocument",
1052
+ '401': "ErrorDocument",
1053
+ '404': "ErrorDocument",
1054
+ }
1055
+ response_data = self.api_client.call_api(
1056
+ *_param,
1057
+ _request_timeout=_request_timeout
1058
+ )
1059
+ response_data.read()
1060
+ return self.api_client.response_deserialize(
1061
+ response_data=response_data,
1062
+ response_types_map=_response_types_map,
1063
+ )
1064
+
1065
+
1066
+ @validate_call
1067
+ def create_check_deposit_send_link_without_preload_content(
1068
+ self,
1069
+ create_check_deposit_send_link_request: CreateCheckDepositSendLinkRequest,
1070
+ _request_timeout: Union[
1071
+ None,
1072
+ Annotated[StrictFloat, Field(gt=0)],
1073
+ Tuple[
1074
+ Annotated[StrictFloat, Field(gt=0)],
1075
+ Annotated[StrictFloat, Field(gt=0)]
1076
+ ]
1077
+ ] = None,
1078
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1079
+ _content_type: Optional[StrictStr] = None,
1080
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1081
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1082
+ ) -> RESTResponseType:
1083
+ """Create a check deposit send link
1084
+
1085
+ Creates a shareable link for the Check Deposit component for an `Account`. The link can be sent to an end user via SMS or email and used to complete a check deposit. Unless a White Label Theme is customized, the component uses the default theme. Unless an Email Domain is customized the link will be created under a default domain starting in `https://application-form.sh`.
1086
+
1087
+ :param create_check_deposit_send_link_request: (required)
1088
+ :type create_check_deposit_send_link_request: CreateCheckDepositSendLinkRequest
1089
+ :param _request_timeout: timeout setting for this request. If one
1090
+ number provided, it will be total request
1091
+ timeout. It can also be a pair (tuple) of
1092
+ (connection, read) timeouts.
1093
+ :type _request_timeout: int, tuple(int, int), optional
1094
+ :param _request_auth: set to override the auth_settings for an a single
1095
+ request; this effectively ignores the
1096
+ authentication in the spec for a single request.
1097
+ :type _request_auth: dict, optional
1098
+ :param _content_type: force content-type for the request.
1099
+ :type _content_type: str, Optional
1100
+ :param _headers: set to override the headers for a single
1101
+ request; this effectively ignores the headers
1102
+ in the spec for a single request.
1103
+ :type _headers: dict, optional
1104
+ :param _host_index: set to override the host_index for a single
1105
+ request; this effectively ignores the host_index
1106
+ in the spec for a single request.
1107
+ :type _host_index: int, optional
1108
+ :return: Returns the result object.
1109
+ """ # noqa: E501
1110
+
1111
+ _param = self._create_check_deposit_send_link_serialize(
1112
+ create_check_deposit_send_link_request=create_check_deposit_send_link_request,
1113
+ _request_auth=_request_auth,
1114
+ _content_type=_content_type,
1115
+ _headers=_headers,
1116
+ _host_index=_host_index
1117
+ )
1118
+
1119
+ _response_types_map: Dict[str, Optional[str]] = {
1120
+ '201': "CreateCheckDepositSendLink201Response",
1121
+ '400': "ErrorDocument",
1122
+ '401': "ErrorDocument",
1123
+ '404': "ErrorDocument",
1124
+ }
1125
+ response_data = self.api_client.call_api(
1126
+ *_param,
1127
+ _request_timeout=_request_timeout
1128
+ )
1129
+ return response_data.response
1130
+
1131
+
1132
+ def _create_check_deposit_send_link_serialize(
1133
+ self,
1134
+ create_check_deposit_send_link_request,
1135
+ _request_auth,
1136
+ _content_type,
1137
+ _headers,
1138
+ _host_index,
1139
+ ) -> RequestSerialized:
1140
+
1141
+ _host = None
1142
+
1143
+ _collection_formats: Dict[str, str] = {
1144
+ }
1145
+
1146
+ _path_params: Dict[str, str] = {}
1147
+ _query_params: List[Tuple[str, str]] = []
1148
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1149
+ _form_params: List[Tuple[str, str]] = []
1150
+ _files: Dict[
1151
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1152
+ ] = {}
1153
+ _body_params: Optional[bytes] = None
1154
+
1155
+ # process the path parameters
1156
+ # process the query parameters
1157
+ # process the header parameters
1158
+ # process the form parameters
1159
+ # process the body parameter
1160
+ if create_check_deposit_send_link_request is not None:
1161
+ _body_params = create_check_deposit_send_link_request
1162
+
1163
+
1164
+ # set the HTTP header `Accept`
1165
+ if 'Accept' not in _header_params:
1166
+ _header_params['Accept'] = self.api_client.select_header_accept(
1167
+ [
1168
+ 'application/vnd.api+json'
1169
+ ]
1170
+ )
1171
+
1172
+ # set the HTTP header `Content-Type`
1173
+ if _content_type:
1174
+ _header_params['Content-Type'] = _content_type
1175
+ else:
1176
+ _default_content_type = (
1177
+ self.api_client.select_header_content_type(
1178
+ [
1179
+ 'application/vnd.api+json'
1180
+ ]
1181
+ )
1182
+ )
1183
+ if _default_content_type is not None:
1184
+ _header_params['Content-Type'] = _default_content_type
1185
+
1186
+ # authentication setting
1187
+ _auth_settings: List[str] = [
1188
+ 'bearerAuth'
1189
+ ]
1190
+
1191
+ return self.api_client.param_serialize(
1192
+ method='POST',
1193
+ resource_path='/white-label/send-link',
1194
+ path_params=_path_params,
1195
+ query_params=_query_params,
1196
+ header_params=_header_params,
1197
+ body=_body_params,
1198
+ post_params=_form_params,
1199
+ files=_files,
1200
+ auth_settings=_auth_settings,
1201
+ collection_formats=_collection_formats,
1202
+ _host=_host,
1203
+ _request_auth=_request_auth
1204
+ )
1205
+
1206
+
1207
+
1208
+
1209
+ @validate_call
1210
+ def get_check_deposit(
1211
+ self,
1212
+ check_deposit_id: StrictStr,
1213
+ include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources")] = None,
1214
+ _request_timeout: Union[
1215
+ None,
1216
+ Annotated[StrictFloat, Field(gt=0)],
1217
+ Tuple[
1218
+ Annotated[StrictFloat, Field(gt=0)],
1219
+ Annotated[StrictFloat, Field(gt=0)]
1220
+ ]
1221
+ ] = None,
1222
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1223
+ _content_type: Optional[StrictStr] = None,
1224
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1225
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1226
+ ) -> GetCheckDeposit200Response:
1227
+ """Get a check deposit by id
1228
+
1229
+ Get a check deposit by id.
1230
+
1231
+ :param check_deposit_id: (required)
1232
+ :type check_deposit_id: str
1233
+ :param include: Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources
1234
+ :type include: str
1235
+ :param _request_timeout: timeout setting for this request. If one
1236
+ number provided, it will be total request
1237
+ timeout. It can also be a pair (tuple) of
1238
+ (connection, read) timeouts.
1239
+ :type _request_timeout: int, tuple(int, int), optional
1240
+ :param _request_auth: set to override the auth_settings for an a single
1241
+ request; this effectively ignores the
1242
+ authentication in the spec for a single request.
1243
+ :type _request_auth: dict, optional
1244
+ :param _content_type: force content-type for the request.
1245
+ :type _content_type: str, Optional
1246
+ :param _headers: set to override the headers for a single
1247
+ request; this effectively ignores the headers
1248
+ in the spec for a single request.
1249
+ :type _headers: dict, optional
1250
+ :param _host_index: set to override the host_index for a single
1251
+ request; this effectively ignores the host_index
1252
+ in the spec for a single request.
1253
+ :type _host_index: int, optional
1254
+ :return: Returns the result object.
1255
+ """ # noqa: E501
1256
+
1257
+ _param = self._get_check_deposit_serialize(
1258
+ check_deposit_id=check_deposit_id,
1259
+ include=include,
1260
+ _request_auth=_request_auth,
1261
+ _content_type=_content_type,
1262
+ _headers=_headers,
1263
+ _host_index=_host_index
1264
+ )
1265
+
1266
+ _response_types_map: Dict[str, Optional[str]] = {
1267
+ '200': "GetCheckDeposit200Response",
1268
+ '400': "ErrorDocument",
1269
+ '401': "ErrorDocument",
1270
+ '404': "ErrorDocument",
1271
+ }
1272
+ response_data = self.api_client.call_api(
1273
+ *_param,
1274
+ _request_timeout=_request_timeout
1275
+ )
1276
+ response_data.read()
1277
+ return self.api_client.response_deserialize(
1278
+ response_data=response_data,
1279
+ response_types_map=_response_types_map,
1280
+ ).data
1281
+
1282
+
1283
+ @validate_call
1284
+ def get_check_deposit_with_http_info(
1285
+ self,
1286
+ check_deposit_id: StrictStr,
1287
+ include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources")] = None,
1288
+ _request_timeout: Union[
1289
+ None,
1290
+ Annotated[StrictFloat, Field(gt=0)],
1291
+ Tuple[
1292
+ Annotated[StrictFloat, Field(gt=0)],
1293
+ Annotated[StrictFloat, Field(gt=0)]
1294
+ ]
1295
+ ] = None,
1296
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1297
+ _content_type: Optional[StrictStr] = None,
1298
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1299
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1300
+ ) -> ApiResponse[GetCheckDeposit200Response]:
1301
+ """Get a check deposit by id
1302
+
1303
+ Get a check deposit by id.
1304
+
1305
+ :param check_deposit_id: (required)
1306
+ :type check_deposit_id: str
1307
+ :param include: Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources
1308
+ :type include: str
1309
+ :param _request_timeout: timeout setting for this request. If one
1310
+ number provided, it will be total request
1311
+ timeout. It can also be a pair (tuple) of
1312
+ (connection, read) timeouts.
1313
+ :type _request_timeout: int, tuple(int, int), optional
1314
+ :param _request_auth: set to override the auth_settings for an a single
1315
+ request; this effectively ignores the
1316
+ authentication in the spec for a single request.
1317
+ :type _request_auth: dict, optional
1318
+ :param _content_type: force content-type for the request.
1319
+ :type _content_type: str, Optional
1320
+ :param _headers: set to override the headers for a single
1321
+ request; this effectively ignores the headers
1322
+ in the spec for a single request.
1323
+ :type _headers: dict, optional
1324
+ :param _host_index: set to override the host_index for a single
1325
+ request; this effectively ignores the host_index
1326
+ in the spec for a single request.
1327
+ :type _host_index: int, optional
1328
+ :return: Returns the result object.
1329
+ """ # noqa: E501
1330
+
1331
+ _param = self._get_check_deposit_serialize(
1332
+ check_deposit_id=check_deposit_id,
1333
+ include=include,
1334
+ _request_auth=_request_auth,
1335
+ _content_type=_content_type,
1336
+ _headers=_headers,
1337
+ _host_index=_host_index
1338
+ )
1339
+
1340
+ _response_types_map: Dict[str, Optional[str]] = {
1341
+ '200': "GetCheckDeposit200Response",
1342
+ '400': "ErrorDocument",
1343
+ '401': "ErrorDocument",
1344
+ '404': "ErrorDocument",
1345
+ }
1346
+ response_data = self.api_client.call_api(
1347
+ *_param,
1348
+ _request_timeout=_request_timeout
1349
+ )
1350
+ response_data.read()
1351
+ return self.api_client.response_deserialize(
1352
+ response_data=response_data,
1353
+ response_types_map=_response_types_map,
1354
+ )
1355
+
1356
+
1357
+ @validate_call
1358
+ def get_check_deposit_without_preload_content(
1359
+ self,
1360
+ check_deposit_id: StrictStr,
1361
+ include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources")] = None,
1362
+ _request_timeout: Union[
1363
+ None,
1364
+ Annotated[StrictFloat, Field(gt=0)],
1365
+ Tuple[
1366
+ Annotated[StrictFloat, Field(gt=0)],
1367
+ Annotated[StrictFloat, Field(gt=0)]
1368
+ ]
1369
+ ] = None,
1370
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1371
+ _content_type: Optional[StrictStr] = None,
1372
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1373
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1374
+ ) -> RESTResponseType:
1375
+ """Get a check deposit by id
1376
+
1377
+ Get a check deposit by id.
1378
+
1379
+ :param check_deposit_id: (required)
1380
+ :type check_deposit_id: str
1381
+ :param include: Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources
1382
+ :type include: str
1383
+ :param _request_timeout: timeout setting for this request. If one
1384
+ number provided, it will be total request
1385
+ timeout. It can also be a pair (tuple) of
1386
+ (connection, read) timeouts.
1387
+ :type _request_timeout: int, tuple(int, int), optional
1388
+ :param _request_auth: set to override the auth_settings for an a single
1389
+ request; this effectively ignores the
1390
+ authentication in the spec for a single request.
1391
+ :type _request_auth: dict, optional
1392
+ :param _content_type: force content-type for the request.
1393
+ :type _content_type: str, Optional
1394
+ :param _headers: set to override the headers for a single
1395
+ request; this effectively ignores the headers
1396
+ in the spec for a single request.
1397
+ :type _headers: dict, optional
1398
+ :param _host_index: set to override the host_index for a single
1399
+ request; this effectively ignores the host_index
1400
+ in the spec for a single request.
1401
+ :type _host_index: int, optional
1402
+ :return: Returns the result object.
1403
+ """ # noqa: E501
1404
+
1405
+ _param = self._get_check_deposit_serialize(
1406
+ check_deposit_id=check_deposit_id,
1407
+ include=include,
1408
+ _request_auth=_request_auth,
1409
+ _content_type=_content_type,
1410
+ _headers=_headers,
1411
+ _host_index=_host_index
1412
+ )
1413
+
1414
+ _response_types_map: Dict[str, Optional[str]] = {
1415
+ '200': "GetCheckDeposit200Response",
1416
+ '400': "ErrorDocument",
1417
+ '401': "ErrorDocument",
1418
+ '404': "ErrorDocument",
1419
+ }
1420
+ response_data = self.api_client.call_api(
1421
+ *_param,
1422
+ _request_timeout=_request_timeout
1423
+ )
1424
+ return response_data.response
1425
+
1426
+
1427
+ def _get_check_deposit_serialize(
1428
+ self,
1429
+ check_deposit_id,
1430
+ include,
1431
+ _request_auth,
1432
+ _content_type,
1433
+ _headers,
1434
+ _host_index,
1435
+ ) -> RequestSerialized:
1436
+
1437
+ _host = None
1438
+
1439
+ _collection_formats: Dict[str, str] = {
1440
+ }
1441
+
1442
+ _path_params: Dict[str, str] = {}
1443
+ _query_params: List[Tuple[str, str]] = []
1444
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1445
+ _form_params: List[Tuple[str, str]] = []
1446
+ _files: Dict[
1447
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1448
+ ] = {}
1449
+ _body_params: Optional[bytes] = None
1450
+
1451
+ # process the path parameters
1452
+ if check_deposit_id is not None:
1453
+ _path_params['checkDepositId'] = check_deposit_id
1454
+ # process the query parameters
1455
+ if include is not None:
1456
+
1457
+ _query_params.append(('include', include))
1458
+
1459
+ # process the header parameters
1460
+ # process the form parameters
1461
+ # process the body parameter
1462
+
1463
+
1464
+ # set the HTTP header `Accept`
1465
+ if 'Accept' not in _header_params:
1466
+ _header_params['Accept'] = self.api_client.select_header_accept(
1467
+ [
1468
+ 'application/vnd.api+json'
1469
+ ]
1470
+ )
1471
+
1472
+
1473
+ # authentication setting
1474
+ _auth_settings: List[str] = [
1475
+ 'bearerAuth'
1476
+ ]
1477
+
1478
+ return self.api_client.param_serialize(
1479
+ method='GET',
1480
+ resource_path='/check-deposits/{checkDepositId}',
1481
+ path_params=_path_params,
1482
+ query_params=_query_params,
1483
+ header_params=_header_params,
1484
+ body=_body_params,
1485
+ post_params=_form_params,
1486
+ files=_files,
1487
+ auth_settings=_auth_settings,
1488
+ collection_formats=_collection_formats,
1489
+ _host=_host,
1490
+ _request_auth=_request_auth
1491
+ )
1492
+
1493
+
1494
+
1495
+
1496
+ @validate_call
1497
+ def get_check_deposit_back_image(
1498
+ self,
1499
+ check_deposit_id: StrictStr,
1500
+ _request_timeout: Union[
1501
+ None,
1502
+ Annotated[StrictFloat, Field(gt=0)],
1503
+ Tuple[
1504
+ Annotated[StrictFloat, Field(gt=0)],
1505
+ Annotated[StrictFloat, Field(gt=0)]
1506
+ ]
1507
+ ] = None,
1508
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1509
+ _content_type: Optional[StrictStr] = None,
1510
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1511
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1512
+ ) -> bytes:
1513
+ """Get a check deposit back image
1514
+
1515
+ Get a check deposit back image by check deposit id.
1516
+
1517
+ :param check_deposit_id: (required)
1518
+ :type check_deposit_id: str
1519
+ :param _request_timeout: timeout setting for this request. If one
1520
+ number provided, it will be total request
1521
+ timeout. It can also be a pair (tuple) of
1522
+ (connection, read) timeouts.
1523
+ :type _request_timeout: int, tuple(int, int), optional
1524
+ :param _request_auth: set to override the auth_settings for an a single
1525
+ request; this effectively ignores the
1526
+ authentication in the spec for a single request.
1527
+ :type _request_auth: dict, optional
1528
+ :param _content_type: force content-type for the request.
1529
+ :type _content_type: str, Optional
1530
+ :param _headers: set to override the headers for a single
1531
+ request; this effectively ignores the headers
1532
+ in the spec for a single request.
1533
+ :type _headers: dict, optional
1534
+ :param _host_index: set to override the host_index for a single
1535
+ request; this effectively ignores the host_index
1536
+ in the spec for a single request.
1537
+ :type _host_index: int, optional
1538
+ :return: Returns the result object.
1539
+ """ # noqa: E501
1540
+
1541
+ _param = self._get_check_deposit_back_image_serialize(
1542
+ check_deposit_id=check_deposit_id,
1543
+ _request_auth=_request_auth,
1544
+ _content_type=_content_type,
1545
+ _headers=_headers,
1546
+ _host_index=_host_index
1547
+ )
1548
+
1549
+ _response_types_map: Dict[str, Optional[str]] = {
1550
+ '200': "bytes",
1551
+ '400': "ErrorDocument",
1552
+ '401': "ErrorDocument",
1553
+ '404': "ErrorDocument",
1554
+ }
1555
+ response_data = self.api_client.call_api(
1556
+ *_param,
1557
+ _request_timeout=_request_timeout
1558
+ )
1559
+ response_data.read()
1560
+ return self.api_client.response_deserialize(
1561
+ response_data=response_data,
1562
+ response_types_map=_response_types_map,
1563
+ ).data
1564
+
1565
+
1566
+ @validate_call
1567
+ def get_check_deposit_back_image_with_http_info(
1568
+ self,
1569
+ check_deposit_id: StrictStr,
1570
+ _request_timeout: Union[
1571
+ None,
1572
+ Annotated[StrictFloat, Field(gt=0)],
1573
+ Tuple[
1574
+ Annotated[StrictFloat, Field(gt=0)],
1575
+ Annotated[StrictFloat, Field(gt=0)]
1576
+ ]
1577
+ ] = None,
1578
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1579
+ _content_type: Optional[StrictStr] = None,
1580
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1581
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1582
+ ) -> ApiResponse[bytes]:
1583
+ """Get a check deposit back image
1584
+
1585
+ Get a check deposit back image by check deposit id.
1586
+
1587
+ :param check_deposit_id: (required)
1588
+ :type check_deposit_id: str
1589
+ :param _request_timeout: timeout setting for this request. If one
1590
+ number provided, it will be total request
1591
+ timeout. It can also be a pair (tuple) of
1592
+ (connection, read) timeouts.
1593
+ :type _request_timeout: int, tuple(int, int), optional
1594
+ :param _request_auth: set to override the auth_settings for an a single
1595
+ request; this effectively ignores the
1596
+ authentication in the spec for a single request.
1597
+ :type _request_auth: dict, optional
1598
+ :param _content_type: force content-type for the request.
1599
+ :type _content_type: str, Optional
1600
+ :param _headers: set to override the headers for a single
1601
+ request; this effectively ignores the headers
1602
+ in the spec for a single request.
1603
+ :type _headers: dict, optional
1604
+ :param _host_index: set to override the host_index for a single
1605
+ request; this effectively ignores the host_index
1606
+ in the spec for a single request.
1607
+ :type _host_index: int, optional
1608
+ :return: Returns the result object.
1609
+ """ # noqa: E501
1610
+
1611
+ _param = self._get_check_deposit_back_image_serialize(
1612
+ check_deposit_id=check_deposit_id,
1613
+ _request_auth=_request_auth,
1614
+ _content_type=_content_type,
1615
+ _headers=_headers,
1616
+ _host_index=_host_index
1617
+ )
1618
+
1619
+ _response_types_map: Dict[str, Optional[str]] = {
1620
+ '200': "bytes",
1621
+ '400': "ErrorDocument",
1622
+ '401': "ErrorDocument",
1623
+ '404': "ErrorDocument",
1624
+ }
1625
+ response_data = self.api_client.call_api(
1626
+ *_param,
1627
+ _request_timeout=_request_timeout
1628
+ )
1629
+ response_data.read()
1630
+ return self.api_client.response_deserialize(
1631
+ response_data=response_data,
1632
+ response_types_map=_response_types_map,
1633
+ )
1634
+
1635
+
1636
+ @validate_call
1637
+ def get_check_deposit_back_image_without_preload_content(
1638
+ self,
1639
+ check_deposit_id: StrictStr,
1640
+ _request_timeout: Union[
1641
+ None,
1642
+ Annotated[StrictFloat, Field(gt=0)],
1643
+ Tuple[
1644
+ Annotated[StrictFloat, Field(gt=0)],
1645
+ Annotated[StrictFloat, Field(gt=0)]
1646
+ ]
1647
+ ] = None,
1648
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1649
+ _content_type: Optional[StrictStr] = None,
1650
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1651
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1652
+ ) -> RESTResponseType:
1653
+ """Get a check deposit back image
1654
+
1655
+ Get a check deposit back image by check deposit id.
1656
+
1657
+ :param check_deposit_id: (required)
1658
+ :type check_deposit_id: str
1659
+ :param _request_timeout: timeout setting for this request. If one
1660
+ number provided, it will be total request
1661
+ timeout. It can also be a pair (tuple) of
1662
+ (connection, read) timeouts.
1663
+ :type _request_timeout: int, tuple(int, int), optional
1664
+ :param _request_auth: set to override the auth_settings for an a single
1665
+ request; this effectively ignores the
1666
+ authentication in the spec for a single request.
1667
+ :type _request_auth: dict, optional
1668
+ :param _content_type: force content-type for the request.
1669
+ :type _content_type: str, Optional
1670
+ :param _headers: set to override the headers for a single
1671
+ request; this effectively ignores the headers
1672
+ in the spec for a single request.
1673
+ :type _headers: dict, optional
1674
+ :param _host_index: set to override the host_index for a single
1675
+ request; this effectively ignores the host_index
1676
+ in the spec for a single request.
1677
+ :type _host_index: int, optional
1678
+ :return: Returns the result object.
1679
+ """ # noqa: E501
1680
+
1681
+ _param = self._get_check_deposit_back_image_serialize(
1682
+ check_deposit_id=check_deposit_id,
1683
+ _request_auth=_request_auth,
1684
+ _content_type=_content_type,
1685
+ _headers=_headers,
1686
+ _host_index=_host_index
1687
+ )
1688
+
1689
+ _response_types_map: Dict[str, Optional[str]] = {
1690
+ '200': "bytes",
1691
+ '400': "ErrorDocument",
1692
+ '401': "ErrorDocument",
1693
+ '404': "ErrorDocument",
1694
+ }
1695
+ response_data = self.api_client.call_api(
1696
+ *_param,
1697
+ _request_timeout=_request_timeout
1698
+ )
1699
+ return response_data.response
1700
+
1701
+
1702
+ def _get_check_deposit_back_image_serialize(
1703
+ self,
1704
+ check_deposit_id,
1705
+ _request_auth,
1706
+ _content_type,
1707
+ _headers,
1708
+ _host_index,
1709
+ ) -> RequestSerialized:
1710
+
1711
+ _host = None
1712
+
1713
+ _collection_formats: Dict[str, str] = {
1714
+ }
1715
+
1716
+ _path_params: Dict[str, str] = {}
1717
+ _query_params: List[Tuple[str, str]] = []
1718
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1719
+ _form_params: List[Tuple[str, str]] = []
1720
+ _files: Dict[
1721
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1722
+ ] = {}
1723
+ _body_params: Optional[bytes] = None
1724
+
1725
+ # process the path parameters
1726
+ if check_deposit_id is not None:
1727
+ _path_params['checkDepositId'] = check_deposit_id
1728
+ # process the query parameters
1729
+ # process the header parameters
1730
+ # process the form parameters
1731
+ # process the body parameter
1732
+
1733
+
1734
+ # set the HTTP header `Accept`
1735
+ if 'Accept' not in _header_params:
1736
+ _header_params['Accept'] = self.api_client.select_header_accept(
1737
+ [
1738
+ 'image/jpeg',
1739
+ 'application/vnd.api+json'
1740
+ ]
1741
+ )
1742
+
1743
+
1744
+ # authentication setting
1745
+ _auth_settings: List[str] = [
1746
+ 'bearerAuth'
1747
+ ]
1748
+
1749
+ return self.api_client.param_serialize(
1750
+ method='GET',
1751
+ resource_path='/check-deposits/{checkDepositId}/back',
1752
+ path_params=_path_params,
1753
+ query_params=_query_params,
1754
+ header_params=_header_params,
1755
+ body=_body_params,
1756
+ post_params=_form_params,
1757
+ files=_files,
1758
+ auth_settings=_auth_settings,
1759
+ collection_formats=_collection_formats,
1760
+ _host=_host,
1761
+ _request_auth=_request_auth
1762
+ )
1763
+
1764
+
1765
+
1766
+
1767
+ @validate_call
1768
+ def get_check_deposit_front_image(
1769
+ self,
1770
+ check_deposit_id: StrictStr,
1771
+ _request_timeout: Union[
1772
+ None,
1773
+ Annotated[StrictFloat, Field(gt=0)],
1774
+ Tuple[
1775
+ Annotated[StrictFloat, Field(gt=0)],
1776
+ Annotated[StrictFloat, Field(gt=0)]
1777
+ ]
1778
+ ] = None,
1779
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1780
+ _content_type: Optional[StrictStr] = None,
1781
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1782
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1783
+ ) -> bytes:
1784
+ """Get a check deposit front image
1785
+
1786
+ Get a check deposit front image by check deposit id.
1787
+
1788
+ :param check_deposit_id: (required)
1789
+ :type check_deposit_id: str
1790
+ :param _request_timeout: timeout setting for this request. If one
1791
+ number provided, it will be total request
1792
+ timeout. It can also be a pair (tuple) of
1793
+ (connection, read) timeouts.
1794
+ :type _request_timeout: int, tuple(int, int), optional
1795
+ :param _request_auth: set to override the auth_settings for an a single
1796
+ request; this effectively ignores the
1797
+ authentication in the spec for a single request.
1798
+ :type _request_auth: dict, optional
1799
+ :param _content_type: force content-type for the request.
1800
+ :type _content_type: str, Optional
1801
+ :param _headers: set to override the headers for a single
1802
+ request; this effectively ignores the headers
1803
+ in the spec for a single request.
1804
+ :type _headers: dict, optional
1805
+ :param _host_index: set to override the host_index for a single
1806
+ request; this effectively ignores the host_index
1807
+ in the spec for a single request.
1808
+ :type _host_index: int, optional
1809
+ :return: Returns the result object.
1810
+ """ # noqa: E501
1811
+
1812
+ _param = self._get_check_deposit_front_image_serialize(
1813
+ check_deposit_id=check_deposit_id,
1814
+ _request_auth=_request_auth,
1815
+ _content_type=_content_type,
1816
+ _headers=_headers,
1817
+ _host_index=_host_index
1818
+ )
1819
+
1820
+ _response_types_map: Dict[str, Optional[str]] = {
1821
+ '200': "bytes",
1822
+ '400': "ErrorDocument",
1823
+ '401': "ErrorDocument",
1824
+ '404': "ErrorDocument",
1825
+ }
1826
+ response_data = self.api_client.call_api(
1827
+ *_param,
1828
+ _request_timeout=_request_timeout
1829
+ )
1830
+ response_data.read()
1831
+ return self.api_client.response_deserialize(
1832
+ response_data=response_data,
1833
+ response_types_map=_response_types_map,
1834
+ ).data
1835
+
1836
+
1837
+ @validate_call
1838
+ def get_check_deposit_front_image_with_http_info(
1839
+ self,
1840
+ check_deposit_id: StrictStr,
1841
+ _request_timeout: Union[
1842
+ None,
1843
+ Annotated[StrictFloat, Field(gt=0)],
1844
+ Tuple[
1845
+ Annotated[StrictFloat, Field(gt=0)],
1846
+ Annotated[StrictFloat, Field(gt=0)]
1847
+ ]
1848
+ ] = None,
1849
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1850
+ _content_type: Optional[StrictStr] = None,
1851
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1852
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1853
+ ) -> ApiResponse[bytes]:
1854
+ """Get a check deposit front image
1855
+
1856
+ Get a check deposit front image by check deposit id.
1857
+
1858
+ :param check_deposit_id: (required)
1859
+ :type check_deposit_id: str
1860
+ :param _request_timeout: timeout setting for this request. If one
1861
+ number provided, it will be total request
1862
+ timeout. It can also be a pair (tuple) of
1863
+ (connection, read) timeouts.
1864
+ :type _request_timeout: int, tuple(int, int), optional
1865
+ :param _request_auth: set to override the auth_settings for an a single
1866
+ request; this effectively ignores the
1867
+ authentication in the spec for a single request.
1868
+ :type _request_auth: dict, optional
1869
+ :param _content_type: force content-type for the request.
1870
+ :type _content_type: str, Optional
1871
+ :param _headers: set to override the headers for a single
1872
+ request; this effectively ignores the headers
1873
+ in the spec for a single request.
1874
+ :type _headers: dict, optional
1875
+ :param _host_index: set to override the host_index for a single
1876
+ request; this effectively ignores the host_index
1877
+ in the spec for a single request.
1878
+ :type _host_index: int, optional
1879
+ :return: Returns the result object.
1880
+ """ # noqa: E501
1881
+
1882
+ _param = self._get_check_deposit_front_image_serialize(
1883
+ check_deposit_id=check_deposit_id,
1884
+ _request_auth=_request_auth,
1885
+ _content_type=_content_type,
1886
+ _headers=_headers,
1887
+ _host_index=_host_index
1888
+ )
1889
+
1890
+ _response_types_map: Dict[str, Optional[str]] = {
1891
+ '200': "bytes",
1892
+ '400': "ErrorDocument",
1893
+ '401': "ErrorDocument",
1894
+ '404': "ErrorDocument",
1895
+ }
1896
+ response_data = self.api_client.call_api(
1897
+ *_param,
1898
+ _request_timeout=_request_timeout
1899
+ )
1900
+ response_data.read()
1901
+ return self.api_client.response_deserialize(
1902
+ response_data=response_data,
1903
+ response_types_map=_response_types_map,
1904
+ )
1905
+
1906
+
1907
+ @validate_call
1908
+ def get_check_deposit_front_image_without_preload_content(
1909
+ self,
1910
+ check_deposit_id: StrictStr,
1911
+ _request_timeout: Union[
1912
+ None,
1913
+ Annotated[StrictFloat, Field(gt=0)],
1914
+ Tuple[
1915
+ Annotated[StrictFloat, Field(gt=0)],
1916
+ Annotated[StrictFloat, Field(gt=0)]
1917
+ ]
1918
+ ] = None,
1919
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1920
+ _content_type: Optional[StrictStr] = None,
1921
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1922
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1923
+ ) -> RESTResponseType:
1924
+ """Get a check deposit front image
1925
+
1926
+ Get a check deposit front image by check deposit id.
1927
+
1928
+ :param check_deposit_id: (required)
1929
+ :type check_deposit_id: str
1930
+ :param _request_timeout: timeout setting for this request. If one
1931
+ number provided, it will be total request
1932
+ timeout. It can also be a pair (tuple) of
1933
+ (connection, read) timeouts.
1934
+ :type _request_timeout: int, tuple(int, int), optional
1935
+ :param _request_auth: set to override the auth_settings for an a single
1936
+ request; this effectively ignores the
1937
+ authentication in the spec for a single request.
1938
+ :type _request_auth: dict, optional
1939
+ :param _content_type: force content-type for the request.
1940
+ :type _content_type: str, Optional
1941
+ :param _headers: set to override the headers for a single
1942
+ request; this effectively ignores the headers
1943
+ in the spec for a single request.
1944
+ :type _headers: dict, optional
1945
+ :param _host_index: set to override the host_index for a single
1946
+ request; this effectively ignores the host_index
1947
+ in the spec for a single request.
1948
+ :type _host_index: int, optional
1949
+ :return: Returns the result object.
1950
+ """ # noqa: E501
1951
+
1952
+ _param = self._get_check_deposit_front_image_serialize(
1953
+ check_deposit_id=check_deposit_id,
1954
+ _request_auth=_request_auth,
1955
+ _content_type=_content_type,
1956
+ _headers=_headers,
1957
+ _host_index=_host_index
1958
+ )
1959
+
1960
+ _response_types_map: Dict[str, Optional[str]] = {
1961
+ '200': "bytes",
1962
+ '400': "ErrorDocument",
1963
+ '401': "ErrorDocument",
1964
+ '404': "ErrorDocument",
1965
+ }
1966
+ response_data = self.api_client.call_api(
1967
+ *_param,
1968
+ _request_timeout=_request_timeout
1969
+ )
1970
+ return response_data.response
1971
+
1972
+
1973
+ def _get_check_deposit_front_image_serialize(
1974
+ self,
1975
+ check_deposit_id,
1976
+ _request_auth,
1977
+ _content_type,
1978
+ _headers,
1979
+ _host_index,
1980
+ ) -> RequestSerialized:
1981
+
1982
+ _host = None
1983
+
1984
+ _collection_formats: Dict[str, str] = {
1985
+ }
1986
+
1987
+ _path_params: Dict[str, str] = {}
1988
+ _query_params: List[Tuple[str, str]] = []
1989
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1990
+ _form_params: List[Tuple[str, str]] = []
1991
+ _files: Dict[
1992
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1993
+ ] = {}
1994
+ _body_params: Optional[bytes] = None
1995
+
1996
+ # process the path parameters
1997
+ if check_deposit_id is not None:
1998
+ _path_params['checkDepositId'] = check_deposit_id
1999
+ # process the query parameters
2000
+ # process the header parameters
2001
+ # process the form parameters
2002
+ # process the body parameter
2003
+
2004
+
2005
+ # set the HTTP header `Accept`
2006
+ if 'Accept' not in _header_params:
2007
+ _header_params['Accept'] = self.api_client.select_header_accept(
2008
+ [
2009
+ 'image/jpeg',
2010
+ 'application/vnd.api+json'
2011
+ ]
2012
+ )
2013
+
2014
+
2015
+ # authentication setting
2016
+ _auth_settings: List[str] = [
2017
+ 'bearerAuth'
2018
+ ]
2019
+
2020
+ return self.api_client.param_serialize(
2021
+ method='GET',
2022
+ resource_path='/check-deposits/{checkDepositId}/front',
2023
+ path_params=_path_params,
2024
+ query_params=_query_params,
2025
+ header_params=_header_params,
2026
+ body=_body_params,
2027
+ post_params=_form_params,
2028
+ files=_files,
2029
+ auth_settings=_auth_settings,
2030
+ collection_formats=_collection_formats,
2031
+ _host=_host,
2032
+ _request_auth=_request_auth
2033
+ )
2034
+
2035
+
2036
+
2037
+
2038
+ @validate_call
2039
+ def list_check_deposits(
2040
+ self,
2041
+ page_limit: Annotated[Optional[StrictStr], Field(description="Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.")] = None,
2042
+ page_offset: Annotated[Optional[StrictStr], Field(description="Number of resources to skip. See Pagination.")] = None,
2043
+ filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account id.")] = None,
2044
+ filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified customer id.")] = None,
2045
+ filter_status: Annotated[Optional[StrictStr], Field(description="Optional. Filter by Check Deposit Status. Usage Example: filter[status][0]=PendingReview&filter[status][1]=AwaitingImages")] = None,
2046
+ filter_tags: Annotated[Optional[StrictStr], Field(description="Optional. Filter check deposits by Tags.")] = None,
2047
+ filter_from_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters the Check Deposits that have an amount that is *higher or equal to* the specified amount (in cents). e.g. 5000")] = None,
2048
+ filter_to_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters the Check Deposits that have an amount that is *lower or equal to* the specified amount (in cents). e.g. 7000")] = None,
2049
+ sort: Annotated[Optional[StrictStr], Field(description="Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.")] = None,
2050
+ include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources")] = None,
2051
+ _request_timeout: Union[
2052
+ None,
2053
+ Annotated[StrictFloat, Field(gt=0)],
2054
+ Tuple[
2055
+ Annotated[StrictFloat, Field(gt=0)],
2056
+ Annotated[StrictFloat, Field(gt=0)]
2057
+ ]
2058
+ ] = None,
2059
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2060
+ _content_type: Optional[StrictStr] = None,
2061
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2062
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2063
+ ) -> ListCheckDeposits200Response:
2064
+ """List check deposits
2065
+
2066
+ List check deposit resources. Filtering, paging and sorting can be applied.
2067
+
2068
+ :param page_limit: Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
2069
+ :type page_limit: str
2070
+ :param page_offset: Number of resources to skip. See Pagination.
2071
+ :type page_offset: str
2072
+ :param filter_account_id: Optional. Filters the results by the specified account id.
2073
+ :type filter_account_id: str
2074
+ :param filter_customer_id: Optional. Filters the results by the specified customer id.
2075
+ :type filter_customer_id: str
2076
+ :param filter_status: Optional. Filter by Check Deposit Status. Usage Example: filter[status][0]=PendingReview&filter[status][1]=AwaitingImages
2077
+ :type filter_status: str
2078
+ :param filter_tags: Optional. Filter check deposits by Tags.
2079
+ :type filter_tags: str
2080
+ :param filter_from_amount: Optional. Filters the Check Deposits that have an amount that is *higher or equal to* the specified amount (in cents). e.g. 5000
2081
+ :type filter_from_amount: str
2082
+ :param filter_to_amount: Optional. Filters the Check Deposits that have an amount that is *lower or equal to* the specified amount (in cents). e.g. 7000
2083
+ :type filter_to_amount: str
2084
+ :param sort: Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.
2085
+ :type sort: str
2086
+ :param include: Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources
2087
+ :type include: str
2088
+ :param _request_timeout: timeout setting for this request. If one
2089
+ number provided, it will be total request
2090
+ timeout. It can also be a pair (tuple) of
2091
+ (connection, read) timeouts.
2092
+ :type _request_timeout: int, tuple(int, int), optional
2093
+ :param _request_auth: set to override the auth_settings for an a single
2094
+ request; this effectively ignores the
2095
+ authentication in the spec for a single request.
2096
+ :type _request_auth: dict, optional
2097
+ :param _content_type: force content-type for the request.
2098
+ :type _content_type: str, Optional
2099
+ :param _headers: set to override the headers for a single
2100
+ request; this effectively ignores the headers
2101
+ in the spec for a single request.
2102
+ :type _headers: dict, optional
2103
+ :param _host_index: set to override the host_index for a single
2104
+ request; this effectively ignores the host_index
2105
+ in the spec for a single request.
2106
+ :type _host_index: int, optional
2107
+ :return: Returns the result object.
2108
+ """ # noqa: E501
2109
+
2110
+ _param = self._list_check_deposits_serialize(
2111
+ page_limit=page_limit,
2112
+ page_offset=page_offset,
2113
+ filter_account_id=filter_account_id,
2114
+ filter_customer_id=filter_customer_id,
2115
+ filter_status=filter_status,
2116
+ filter_tags=filter_tags,
2117
+ filter_from_amount=filter_from_amount,
2118
+ filter_to_amount=filter_to_amount,
2119
+ sort=sort,
2120
+ include=include,
2121
+ _request_auth=_request_auth,
2122
+ _content_type=_content_type,
2123
+ _headers=_headers,
2124
+ _host_index=_host_index
2125
+ )
2126
+
2127
+ _response_types_map: Dict[str, Optional[str]] = {
2128
+ '200': "ListCheckDeposits200Response",
2129
+ '400': "ErrorDocument",
2130
+ '401': "ErrorDocument",
2131
+ '404': "ErrorDocument",
2132
+ }
2133
+ response_data = self.api_client.call_api(
2134
+ *_param,
2135
+ _request_timeout=_request_timeout
2136
+ )
2137
+ response_data.read()
2138
+ return self.api_client.response_deserialize(
2139
+ response_data=response_data,
2140
+ response_types_map=_response_types_map,
2141
+ ).data
2142
+
2143
+
2144
+ @validate_call
2145
+ def list_check_deposits_with_http_info(
2146
+ self,
2147
+ page_limit: Annotated[Optional[StrictStr], Field(description="Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.")] = None,
2148
+ page_offset: Annotated[Optional[StrictStr], Field(description="Number of resources to skip. See Pagination.")] = None,
2149
+ filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account id.")] = None,
2150
+ filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified customer id.")] = None,
2151
+ filter_status: Annotated[Optional[StrictStr], Field(description="Optional. Filter by Check Deposit Status. Usage Example: filter[status][0]=PendingReview&filter[status][1]=AwaitingImages")] = None,
2152
+ filter_tags: Annotated[Optional[StrictStr], Field(description="Optional. Filter check deposits by Tags.")] = None,
2153
+ filter_from_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters the Check Deposits that have an amount that is *higher or equal to* the specified amount (in cents). e.g. 5000")] = None,
2154
+ filter_to_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters the Check Deposits that have an amount that is *lower or equal to* the specified amount (in cents). e.g. 7000")] = None,
2155
+ sort: Annotated[Optional[StrictStr], Field(description="Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.")] = None,
2156
+ include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources")] = None,
2157
+ _request_timeout: Union[
2158
+ None,
2159
+ Annotated[StrictFloat, Field(gt=0)],
2160
+ Tuple[
2161
+ Annotated[StrictFloat, Field(gt=0)],
2162
+ Annotated[StrictFloat, Field(gt=0)]
2163
+ ]
2164
+ ] = None,
2165
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2166
+ _content_type: Optional[StrictStr] = None,
2167
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2168
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2169
+ ) -> ApiResponse[ListCheckDeposits200Response]:
2170
+ """List check deposits
2171
+
2172
+ List check deposit resources. Filtering, paging and sorting can be applied.
2173
+
2174
+ :param page_limit: Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
2175
+ :type page_limit: str
2176
+ :param page_offset: Number of resources to skip. See Pagination.
2177
+ :type page_offset: str
2178
+ :param filter_account_id: Optional. Filters the results by the specified account id.
2179
+ :type filter_account_id: str
2180
+ :param filter_customer_id: Optional. Filters the results by the specified customer id.
2181
+ :type filter_customer_id: str
2182
+ :param filter_status: Optional. Filter by Check Deposit Status. Usage Example: filter[status][0]=PendingReview&filter[status][1]=AwaitingImages
2183
+ :type filter_status: str
2184
+ :param filter_tags: Optional. Filter check deposits by Tags.
2185
+ :type filter_tags: str
2186
+ :param filter_from_amount: Optional. Filters the Check Deposits that have an amount that is *higher or equal to* the specified amount (in cents). e.g. 5000
2187
+ :type filter_from_amount: str
2188
+ :param filter_to_amount: Optional. Filters the Check Deposits that have an amount that is *lower or equal to* the specified amount (in cents). e.g. 7000
2189
+ :type filter_to_amount: str
2190
+ :param sort: Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.
2191
+ :type sort: str
2192
+ :param include: Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources
2193
+ :type include: str
2194
+ :param _request_timeout: timeout setting for this request. If one
2195
+ number provided, it will be total request
2196
+ timeout. It can also be a pair (tuple) of
2197
+ (connection, read) timeouts.
2198
+ :type _request_timeout: int, tuple(int, int), optional
2199
+ :param _request_auth: set to override the auth_settings for an a single
2200
+ request; this effectively ignores the
2201
+ authentication in the spec for a single request.
2202
+ :type _request_auth: dict, optional
2203
+ :param _content_type: force content-type for the request.
2204
+ :type _content_type: str, Optional
2205
+ :param _headers: set to override the headers for a single
2206
+ request; this effectively ignores the headers
2207
+ in the spec for a single request.
2208
+ :type _headers: dict, optional
2209
+ :param _host_index: set to override the host_index for a single
2210
+ request; this effectively ignores the host_index
2211
+ in the spec for a single request.
2212
+ :type _host_index: int, optional
2213
+ :return: Returns the result object.
2214
+ """ # noqa: E501
2215
+
2216
+ _param = self._list_check_deposits_serialize(
2217
+ page_limit=page_limit,
2218
+ page_offset=page_offset,
2219
+ filter_account_id=filter_account_id,
2220
+ filter_customer_id=filter_customer_id,
2221
+ filter_status=filter_status,
2222
+ filter_tags=filter_tags,
2223
+ filter_from_amount=filter_from_amount,
2224
+ filter_to_amount=filter_to_amount,
2225
+ sort=sort,
2226
+ include=include,
2227
+ _request_auth=_request_auth,
2228
+ _content_type=_content_type,
2229
+ _headers=_headers,
2230
+ _host_index=_host_index
2231
+ )
2232
+
2233
+ _response_types_map: Dict[str, Optional[str]] = {
2234
+ '200': "ListCheckDeposits200Response",
2235
+ '400': "ErrorDocument",
2236
+ '401': "ErrorDocument",
2237
+ '404': "ErrorDocument",
2238
+ }
2239
+ response_data = self.api_client.call_api(
2240
+ *_param,
2241
+ _request_timeout=_request_timeout
2242
+ )
2243
+ response_data.read()
2244
+ return self.api_client.response_deserialize(
2245
+ response_data=response_data,
2246
+ response_types_map=_response_types_map,
2247
+ )
2248
+
2249
+
2250
+ @validate_call
2251
+ def list_check_deposits_without_preload_content(
2252
+ self,
2253
+ page_limit: Annotated[Optional[StrictStr], Field(description="Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.")] = None,
2254
+ page_offset: Annotated[Optional[StrictStr], Field(description="Number of resources to skip. See Pagination.")] = None,
2255
+ filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account id.")] = None,
2256
+ filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified customer id.")] = None,
2257
+ filter_status: Annotated[Optional[StrictStr], Field(description="Optional. Filter by Check Deposit Status. Usage Example: filter[status][0]=PendingReview&filter[status][1]=AwaitingImages")] = None,
2258
+ filter_tags: Annotated[Optional[StrictStr], Field(description="Optional. Filter check deposits by Tags.")] = None,
2259
+ filter_from_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters the Check Deposits that have an amount that is *higher or equal to* the specified amount (in cents). e.g. 5000")] = None,
2260
+ filter_to_amount: Annotated[Optional[StrictStr], Field(description="Optional. Filters the Check Deposits that have an amount that is *lower or equal to* the specified amount (in cents). e.g. 7000")] = None,
2261
+ sort: Annotated[Optional[StrictStr], Field(description="Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.")] = None,
2262
+ include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources")] = None,
2263
+ _request_timeout: Union[
2264
+ None,
2265
+ Annotated[StrictFloat, Field(gt=0)],
2266
+ Tuple[
2267
+ Annotated[StrictFloat, Field(gt=0)],
2268
+ Annotated[StrictFloat, Field(gt=0)]
2269
+ ]
2270
+ ] = None,
2271
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2272
+ _content_type: Optional[StrictStr] = None,
2273
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2274
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2275
+ ) -> RESTResponseType:
2276
+ """List check deposits
2277
+
2278
+ List check deposit resources. Filtering, paging and sorting can be applied.
2279
+
2280
+ :param page_limit: Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
2281
+ :type page_limit: str
2282
+ :param page_offset: Number of resources to skip. See Pagination.
2283
+ :type page_offset: str
2284
+ :param filter_account_id: Optional. Filters the results by the specified account id.
2285
+ :type filter_account_id: str
2286
+ :param filter_customer_id: Optional. Filters the results by the specified customer id.
2287
+ :type filter_customer_id: str
2288
+ :param filter_status: Optional. Filter by Check Deposit Status. Usage Example: filter[status][0]=PendingReview&filter[status][1]=AwaitingImages
2289
+ :type filter_status: str
2290
+ :param filter_tags: Optional. Filter check deposits by Tags.
2291
+ :type filter_tags: str
2292
+ :param filter_from_amount: Optional. Filters the Check Deposits that have an amount that is *higher or equal to* the specified amount (in cents). e.g. 5000
2293
+ :type filter_from_amount: str
2294
+ :param filter_to_amount: Optional. Filters the Check Deposits that have an amount that is *lower or equal to* the specified amount (in cents). e.g. 7000
2295
+ :type filter_to_amount: str
2296
+ :param sort: Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.
2297
+ :type sort: str
2298
+ :param include: Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources
2299
+ :type include: str
2300
+ :param _request_timeout: timeout setting for this request. If one
2301
+ number provided, it will be total request
2302
+ timeout. It can also be a pair (tuple) of
2303
+ (connection, read) timeouts.
2304
+ :type _request_timeout: int, tuple(int, int), optional
2305
+ :param _request_auth: set to override the auth_settings for an a single
2306
+ request; this effectively ignores the
2307
+ authentication in the spec for a single request.
2308
+ :type _request_auth: dict, optional
2309
+ :param _content_type: force content-type for the request.
2310
+ :type _content_type: str, Optional
2311
+ :param _headers: set to override the headers for a single
2312
+ request; this effectively ignores the headers
2313
+ in the spec for a single request.
2314
+ :type _headers: dict, optional
2315
+ :param _host_index: set to override the host_index for a single
2316
+ request; this effectively ignores the host_index
2317
+ in the spec for a single request.
2318
+ :type _host_index: int, optional
2319
+ :return: Returns the result object.
2320
+ """ # noqa: E501
2321
+
2322
+ _param = self._list_check_deposits_serialize(
2323
+ page_limit=page_limit,
2324
+ page_offset=page_offset,
2325
+ filter_account_id=filter_account_id,
2326
+ filter_customer_id=filter_customer_id,
2327
+ filter_status=filter_status,
2328
+ filter_tags=filter_tags,
2329
+ filter_from_amount=filter_from_amount,
2330
+ filter_to_amount=filter_to_amount,
2331
+ sort=sort,
2332
+ include=include,
2333
+ _request_auth=_request_auth,
2334
+ _content_type=_content_type,
2335
+ _headers=_headers,
2336
+ _host_index=_host_index
2337
+ )
2338
+
2339
+ _response_types_map: Dict[str, Optional[str]] = {
2340
+ '200': "ListCheckDeposits200Response",
2341
+ '400': "ErrorDocument",
2342
+ '401': "ErrorDocument",
2343
+ '404': "ErrorDocument",
2344
+ }
2345
+ response_data = self.api_client.call_api(
2346
+ *_param,
2347
+ _request_timeout=_request_timeout
2348
+ )
2349
+ return response_data.response
2350
+
2351
+
2352
+ def _list_check_deposits_serialize(
2353
+ self,
2354
+ page_limit,
2355
+ page_offset,
2356
+ filter_account_id,
2357
+ filter_customer_id,
2358
+ filter_status,
2359
+ filter_tags,
2360
+ filter_from_amount,
2361
+ filter_to_amount,
2362
+ sort,
2363
+ include,
2364
+ _request_auth,
2365
+ _content_type,
2366
+ _headers,
2367
+ _host_index,
2368
+ ) -> RequestSerialized:
2369
+
2370
+ _host = None
2371
+
2372
+ _collection_formats: Dict[str, str] = {
2373
+ }
2374
+
2375
+ _path_params: Dict[str, str] = {}
2376
+ _query_params: List[Tuple[str, str]] = []
2377
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2378
+ _form_params: List[Tuple[str, str]] = []
2379
+ _files: Dict[
2380
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2381
+ ] = {}
2382
+ _body_params: Optional[bytes] = None
2383
+
2384
+ # process the path parameters
2385
+ # process the query parameters
2386
+ if page_limit is not None:
2387
+
2388
+ _query_params.append(('page[limit]', page_limit))
2389
+
2390
+ if page_offset is not None:
2391
+
2392
+ _query_params.append(('page[offset]', page_offset))
2393
+
2394
+ if filter_account_id is not None:
2395
+
2396
+ _query_params.append(('filter[accountId]', filter_account_id))
2397
+
2398
+ if filter_customer_id is not None:
2399
+
2400
+ _query_params.append(('filter[customerId]', filter_customer_id))
2401
+
2402
+ if filter_status is not None:
2403
+
2404
+ _query_params.append(('filter[status]', filter_status))
2405
+
2406
+ if filter_tags is not None:
2407
+
2408
+ _query_params.append(('filter[tags]', filter_tags))
2409
+
2410
+ if filter_from_amount is not None:
2411
+
2412
+ _query_params.append(('filter[fromAmount]', filter_from_amount))
2413
+
2414
+ if filter_to_amount is not None:
2415
+
2416
+ _query_params.append(('filter[toAmount]', filter_to_amount))
2417
+
2418
+ if sort is not None:
2419
+
2420
+ _query_params.append(('sort', sort))
2421
+
2422
+ if include is not None:
2423
+
2424
+ _query_params.append(('include', include))
2425
+
2426
+ # process the header parameters
2427
+ # process the form parameters
2428
+ # process the body parameter
2429
+
2430
+
2431
+ # set the HTTP header `Accept`
2432
+ if 'Accept' not in _header_params:
2433
+ _header_params['Accept'] = self.api_client.select_header_accept(
2434
+ [
2435
+ 'application/vnd.api+json'
2436
+ ]
2437
+ )
2438
+
2439
+
2440
+ # authentication setting
2441
+ _auth_settings: List[str] = [
2442
+ 'bearerAuth'
2443
+ ]
2444
+
2445
+ return self.api_client.param_serialize(
2446
+ method='GET',
2447
+ resource_path='/check-deposits',
2448
+ path_params=_path_params,
2449
+ query_params=_query_params,
2450
+ header_params=_header_params,
2451
+ body=_body_params,
2452
+ post_params=_form_params,
2453
+ files=_files,
2454
+ auth_settings=_auth_settings,
2455
+ collection_formats=_collection_formats,
2456
+ _host=_host,
2457
+ _request_auth=_request_auth
2458
+ )
2459
+
2460
+
2461
+
2462
+
2463
+ @validate_call
2464
+ def update_check_deposit(
2465
+ self,
2466
+ check_deposit_id: StrictStr,
2467
+ update_check_deposit_request: UpdateCheckDepositRequest,
2468
+ _request_timeout: Union[
2469
+ None,
2470
+ Annotated[StrictFloat, Field(gt=0)],
2471
+ Tuple[
2472
+ Annotated[StrictFloat, Field(gt=0)],
2473
+ Annotated[StrictFloat, Field(gt=0)]
2474
+ ]
2475
+ ] = None,
2476
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2477
+ _content_type: Optional[StrictStr] = None,
2478
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2479
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2480
+ ) -> CreateCheckDeposit201Response:
2481
+ """Update a check deposit
2482
+
2483
+ Update a check deposit.
2484
+
2485
+ :param check_deposit_id: (required)
2486
+ :type check_deposit_id: str
2487
+ :param update_check_deposit_request: (required)
2488
+ :type update_check_deposit_request: UpdateCheckDepositRequest
2489
+ :param _request_timeout: timeout setting for this request. If one
2490
+ number provided, it will be total request
2491
+ timeout. It can also be a pair (tuple) of
2492
+ (connection, read) timeouts.
2493
+ :type _request_timeout: int, tuple(int, int), optional
2494
+ :param _request_auth: set to override the auth_settings for an a single
2495
+ request; this effectively ignores the
2496
+ authentication in the spec for a single request.
2497
+ :type _request_auth: dict, optional
2498
+ :param _content_type: force content-type for the request.
2499
+ :type _content_type: str, Optional
2500
+ :param _headers: set to override the headers for a single
2501
+ request; this effectively ignores the headers
2502
+ in the spec for a single request.
2503
+ :type _headers: dict, optional
2504
+ :param _host_index: set to override the host_index for a single
2505
+ request; this effectively ignores the host_index
2506
+ in the spec for a single request.
2507
+ :type _host_index: int, optional
2508
+ :return: Returns the result object.
2509
+ """ # noqa: E501
2510
+
2511
+ _param = self._update_check_deposit_serialize(
2512
+ check_deposit_id=check_deposit_id,
2513
+ update_check_deposit_request=update_check_deposit_request,
2514
+ _request_auth=_request_auth,
2515
+ _content_type=_content_type,
2516
+ _headers=_headers,
2517
+ _host_index=_host_index
2518
+ )
2519
+
2520
+ _response_types_map: Dict[str, Optional[str]] = {
2521
+ '200': "CreateCheckDeposit201Response",
2522
+ '400': "ErrorDocument",
2523
+ '401': "ErrorDocument",
2524
+ '404': "ErrorDocument",
2525
+ }
2526
+ response_data = self.api_client.call_api(
2527
+ *_param,
2528
+ _request_timeout=_request_timeout
2529
+ )
2530
+ response_data.read()
2531
+ return self.api_client.response_deserialize(
2532
+ response_data=response_data,
2533
+ response_types_map=_response_types_map,
2534
+ ).data
2535
+
2536
+
2537
+ @validate_call
2538
+ def update_check_deposit_with_http_info(
2539
+ self,
2540
+ check_deposit_id: StrictStr,
2541
+ update_check_deposit_request: UpdateCheckDepositRequest,
2542
+ _request_timeout: Union[
2543
+ None,
2544
+ Annotated[StrictFloat, Field(gt=0)],
2545
+ Tuple[
2546
+ Annotated[StrictFloat, Field(gt=0)],
2547
+ Annotated[StrictFloat, Field(gt=0)]
2548
+ ]
2549
+ ] = None,
2550
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2551
+ _content_type: Optional[StrictStr] = None,
2552
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2553
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2554
+ ) -> ApiResponse[CreateCheckDeposit201Response]:
2555
+ """Update a check deposit
2556
+
2557
+ Update a check deposit.
2558
+
2559
+ :param check_deposit_id: (required)
2560
+ :type check_deposit_id: str
2561
+ :param update_check_deposit_request: (required)
2562
+ :type update_check_deposit_request: UpdateCheckDepositRequest
2563
+ :param _request_timeout: timeout setting for this request. If one
2564
+ number provided, it will be total request
2565
+ timeout. It can also be a pair (tuple) of
2566
+ (connection, read) timeouts.
2567
+ :type _request_timeout: int, tuple(int, int), optional
2568
+ :param _request_auth: set to override the auth_settings for an a single
2569
+ request; this effectively ignores the
2570
+ authentication in the spec for a single request.
2571
+ :type _request_auth: dict, optional
2572
+ :param _content_type: force content-type for the request.
2573
+ :type _content_type: str, Optional
2574
+ :param _headers: set to override the headers for a single
2575
+ request; this effectively ignores the headers
2576
+ in the spec for a single request.
2577
+ :type _headers: dict, optional
2578
+ :param _host_index: set to override the host_index for a single
2579
+ request; this effectively ignores the host_index
2580
+ in the spec for a single request.
2581
+ :type _host_index: int, optional
2582
+ :return: Returns the result object.
2583
+ """ # noqa: E501
2584
+
2585
+ _param = self._update_check_deposit_serialize(
2586
+ check_deposit_id=check_deposit_id,
2587
+ update_check_deposit_request=update_check_deposit_request,
2588
+ _request_auth=_request_auth,
2589
+ _content_type=_content_type,
2590
+ _headers=_headers,
2591
+ _host_index=_host_index
2592
+ )
2593
+
2594
+ _response_types_map: Dict[str, Optional[str]] = {
2595
+ '200': "CreateCheckDeposit201Response",
2596
+ '400': "ErrorDocument",
2597
+ '401': "ErrorDocument",
2598
+ '404': "ErrorDocument",
2599
+ }
2600
+ response_data = self.api_client.call_api(
2601
+ *_param,
2602
+ _request_timeout=_request_timeout
2603
+ )
2604
+ response_data.read()
2605
+ return self.api_client.response_deserialize(
2606
+ response_data=response_data,
2607
+ response_types_map=_response_types_map,
2608
+ )
2609
+
2610
+
2611
+ @validate_call
2612
+ def update_check_deposit_without_preload_content(
2613
+ self,
2614
+ check_deposit_id: StrictStr,
2615
+ update_check_deposit_request: UpdateCheckDepositRequest,
2616
+ _request_timeout: Union[
2617
+ None,
2618
+ Annotated[StrictFloat, Field(gt=0)],
2619
+ Tuple[
2620
+ Annotated[StrictFloat, Field(gt=0)],
2621
+ Annotated[StrictFloat, Field(gt=0)]
2622
+ ]
2623
+ ] = None,
2624
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2625
+ _content_type: Optional[StrictStr] = None,
2626
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2627
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2628
+ ) -> RESTResponseType:
2629
+ """Update a check deposit
2630
+
2631
+ Update a check deposit.
2632
+
2633
+ :param check_deposit_id: (required)
2634
+ :type check_deposit_id: str
2635
+ :param update_check_deposit_request: (required)
2636
+ :type update_check_deposit_request: UpdateCheckDepositRequest
2637
+ :param _request_timeout: timeout setting for this request. If one
2638
+ number provided, it will be total request
2639
+ timeout. It can also be a pair (tuple) of
2640
+ (connection, read) timeouts.
2641
+ :type _request_timeout: int, tuple(int, int), optional
2642
+ :param _request_auth: set to override the auth_settings for an a single
2643
+ request; this effectively ignores the
2644
+ authentication in the spec for a single request.
2645
+ :type _request_auth: dict, optional
2646
+ :param _content_type: force content-type for the request.
2647
+ :type _content_type: str, Optional
2648
+ :param _headers: set to override the headers for a single
2649
+ request; this effectively ignores the headers
2650
+ in the spec for a single request.
2651
+ :type _headers: dict, optional
2652
+ :param _host_index: set to override the host_index for a single
2653
+ request; this effectively ignores the host_index
2654
+ in the spec for a single request.
2655
+ :type _host_index: int, optional
2656
+ :return: Returns the result object.
2657
+ """ # noqa: E501
2658
+
2659
+ _param = self._update_check_deposit_serialize(
2660
+ check_deposit_id=check_deposit_id,
2661
+ update_check_deposit_request=update_check_deposit_request,
2662
+ _request_auth=_request_auth,
2663
+ _content_type=_content_type,
2664
+ _headers=_headers,
2665
+ _host_index=_host_index
2666
+ )
2667
+
2668
+ _response_types_map: Dict[str, Optional[str]] = {
2669
+ '200': "CreateCheckDeposit201Response",
2670
+ '400': "ErrorDocument",
2671
+ '401': "ErrorDocument",
2672
+ '404': "ErrorDocument",
2673
+ }
2674
+ response_data = self.api_client.call_api(
2675
+ *_param,
2676
+ _request_timeout=_request_timeout
2677
+ )
2678
+ return response_data.response
2679
+
2680
+
2681
+ def _update_check_deposit_serialize(
2682
+ self,
2683
+ check_deposit_id,
2684
+ update_check_deposit_request,
2685
+ _request_auth,
2686
+ _content_type,
2687
+ _headers,
2688
+ _host_index,
2689
+ ) -> RequestSerialized:
2690
+
2691
+ _host = None
2692
+
2693
+ _collection_formats: Dict[str, str] = {
2694
+ }
2695
+
2696
+ _path_params: Dict[str, str] = {}
2697
+ _query_params: List[Tuple[str, str]] = []
2698
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2699
+ _form_params: List[Tuple[str, str]] = []
2700
+ _files: Dict[
2701
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2702
+ ] = {}
2703
+ _body_params: Optional[bytes] = None
2704
+
2705
+ # process the path parameters
2706
+ if check_deposit_id is not None:
2707
+ _path_params['checkDepositId'] = check_deposit_id
2708
+ # process the query parameters
2709
+ # process the header parameters
2710
+ # process the form parameters
2711
+ # process the body parameter
2712
+ if update_check_deposit_request is not None:
2713
+ _body_params = update_check_deposit_request
2714
+
2715
+
2716
+ # set the HTTP header `Accept`
2717
+ if 'Accept' not in _header_params:
2718
+ _header_params['Accept'] = self.api_client.select_header_accept(
2719
+ [
2720
+ 'application/vnd.api+json'
2721
+ ]
2722
+ )
2723
+
2724
+ # set the HTTP header `Content-Type`
2725
+ if _content_type:
2726
+ _header_params['Content-Type'] = _content_type
2727
+ else:
2728
+ _default_content_type = (
2729
+ self.api_client.select_header_content_type(
2730
+ [
2731
+ 'application/vnd.api+json'
2732
+ ]
2733
+ )
2734
+ )
2735
+ if _default_content_type is not None:
2736
+ _header_params['Content-Type'] = _default_content_type
2737
+
2738
+ # authentication setting
2739
+ _auth_settings: List[str] = [
2740
+ 'bearerAuth'
2741
+ ]
2742
+
2743
+ return self.api_client.param_serialize(
2744
+ method='PATCH',
2745
+ resource_path='/check-deposits/{checkDepositId}',
2746
+ path_params=_path_params,
2747
+ query_params=_query_params,
2748
+ header_params=_header_params,
2749
+ body=_body_params,
2750
+ post_params=_form_params,
2751
+ files=_files,
2752
+ auth_settings=_auth_settings,
2753
+ collection_formats=_collection_formats,
2754
+ _host=_host,
2755
+ _request_auth=_request_auth
2756
+ )
2757
+
2758
+
2759
+
2760
+
2761
+ @validate_call
2762
+ def upload_check_deposit_back_image(
2763
+ self,
2764
+ check_deposit_id: StrictStr,
2765
+ body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
2766
+ _request_timeout: Union[
2767
+ None,
2768
+ Annotated[StrictFloat, Field(gt=0)],
2769
+ Tuple[
2770
+ Annotated[StrictFloat, Field(gt=0)],
2771
+ Annotated[StrictFloat, Field(gt=0)]
2772
+ ]
2773
+ ] = None,
2774
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2775
+ _content_type: Optional[StrictStr] = None,
2776
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2777
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2778
+ ) -> CreateCheckDeposit201Response:
2779
+ """Upload a check deposit back image
2780
+
2781
+ Uploads a check back-side image file. Currently only `jpeg` file type is supported.
2782
+
2783
+ :param check_deposit_id: (required)
2784
+ :type check_deposit_id: str
2785
+ :param body: (required)
2786
+ :type body: bytes
2787
+ :param _request_timeout: timeout setting for this request. If one
2788
+ number provided, it will be total request
2789
+ timeout. It can also be a pair (tuple) of
2790
+ (connection, read) timeouts.
2791
+ :type _request_timeout: int, tuple(int, int), optional
2792
+ :param _request_auth: set to override the auth_settings for an a single
2793
+ request; this effectively ignores the
2794
+ authentication in the spec for a single request.
2795
+ :type _request_auth: dict, optional
2796
+ :param _content_type: force content-type for the request.
2797
+ :type _content_type: str, Optional
2798
+ :param _headers: set to override the headers for a single
2799
+ request; this effectively ignores the headers
2800
+ in the spec for a single request.
2801
+ :type _headers: dict, optional
2802
+ :param _host_index: set to override the host_index for a single
2803
+ request; this effectively ignores the host_index
2804
+ in the spec for a single request.
2805
+ :type _host_index: int, optional
2806
+ :return: Returns the result object.
2807
+ """ # noqa: E501
2808
+
2809
+ _param = self._upload_check_deposit_back_image_serialize(
2810
+ check_deposit_id=check_deposit_id,
2811
+ body=body,
2812
+ _request_auth=_request_auth,
2813
+ _content_type=_content_type,
2814
+ _headers=_headers,
2815
+ _host_index=_host_index
2816
+ )
2817
+
2818
+ _response_types_map: Dict[str, Optional[str]] = {
2819
+ '200': "CreateCheckDeposit201Response",
2820
+ '400': "ErrorDocument",
2821
+ '401': "ErrorDocument",
2822
+ '404': "ErrorDocument",
2823
+ }
2824
+ response_data = self.api_client.call_api(
2825
+ *_param,
2826
+ _request_timeout=_request_timeout
2827
+ )
2828
+ response_data.read()
2829
+ return self.api_client.response_deserialize(
2830
+ response_data=response_data,
2831
+ response_types_map=_response_types_map,
2832
+ ).data
2833
+
2834
+
2835
+ @validate_call
2836
+ def upload_check_deposit_back_image_with_http_info(
2837
+ self,
2838
+ check_deposit_id: StrictStr,
2839
+ body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
2840
+ _request_timeout: Union[
2841
+ None,
2842
+ Annotated[StrictFloat, Field(gt=0)],
2843
+ Tuple[
2844
+ Annotated[StrictFloat, Field(gt=0)],
2845
+ Annotated[StrictFloat, Field(gt=0)]
2846
+ ]
2847
+ ] = None,
2848
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2849
+ _content_type: Optional[StrictStr] = None,
2850
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2851
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2852
+ ) -> ApiResponse[CreateCheckDeposit201Response]:
2853
+ """Upload a check deposit back image
2854
+
2855
+ Uploads a check back-side image file. Currently only `jpeg` file type is supported.
2856
+
2857
+ :param check_deposit_id: (required)
2858
+ :type check_deposit_id: str
2859
+ :param body: (required)
2860
+ :type body: bytes
2861
+ :param _request_timeout: timeout setting for this request. If one
2862
+ number provided, it will be total request
2863
+ timeout. It can also be a pair (tuple) of
2864
+ (connection, read) timeouts.
2865
+ :type _request_timeout: int, tuple(int, int), optional
2866
+ :param _request_auth: set to override the auth_settings for an a single
2867
+ request; this effectively ignores the
2868
+ authentication in the spec for a single request.
2869
+ :type _request_auth: dict, optional
2870
+ :param _content_type: force content-type for the request.
2871
+ :type _content_type: str, Optional
2872
+ :param _headers: set to override the headers for a single
2873
+ request; this effectively ignores the headers
2874
+ in the spec for a single request.
2875
+ :type _headers: dict, optional
2876
+ :param _host_index: set to override the host_index for a single
2877
+ request; this effectively ignores the host_index
2878
+ in the spec for a single request.
2879
+ :type _host_index: int, optional
2880
+ :return: Returns the result object.
2881
+ """ # noqa: E501
2882
+
2883
+ _param = self._upload_check_deposit_back_image_serialize(
2884
+ check_deposit_id=check_deposit_id,
2885
+ body=body,
2886
+ _request_auth=_request_auth,
2887
+ _content_type=_content_type,
2888
+ _headers=_headers,
2889
+ _host_index=_host_index
2890
+ )
2891
+
2892
+ _response_types_map: Dict[str, Optional[str]] = {
2893
+ '200': "CreateCheckDeposit201Response",
2894
+ '400': "ErrorDocument",
2895
+ '401': "ErrorDocument",
2896
+ '404': "ErrorDocument",
2897
+ }
2898
+ response_data = self.api_client.call_api(
2899
+ *_param,
2900
+ _request_timeout=_request_timeout
2901
+ )
2902
+ response_data.read()
2903
+ return self.api_client.response_deserialize(
2904
+ response_data=response_data,
2905
+ response_types_map=_response_types_map,
2906
+ )
2907
+
2908
+
2909
+ @validate_call
2910
+ def upload_check_deposit_back_image_without_preload_content(
2911
+ self,
2912
+ check_deposit_id: StrictStr,
2913
+ body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
2914
+ _request_timeout: Union[
2915
+ None,
2916
+ Annotated[StrictFloat, Field(gt=0)],
2917
+ Tuple[
2918
+ Annotated[StrictFloat, Field(gt=0)],
2919
+ Annotated[StrictFloat, Field(gt=0)]
2920
+ ]
2921
+ ] = None,
2922
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2923
+ _content_type: Optional[StrictStr] = None,
2924
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2925
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2926
+ ) -> RESTResponseType:
2927
+ """Upload a check deposit back image
2928
+
2929
+ Uploads a check back-side image file. Currently only `jpeg` file type is supported.
2930
+
2931
+ :param check_deposit_id: (required)
2932
+ :type check_deposit_id: str
2933
+ :param body: (required)
2934
+ :type body: bytes
2935
+ :param _request_timeout: timeout setting for this request. If one
2936
+ number provided, it will be total request
2937
+ timeout. It can also be a pair (tuple) of
2938
+ (connection, read) timeouts.
2939
+ :type _request_timeout: int, tuple(int, int), optional
2940
+ :param _request_auth: set to override the auth_settings for an a single
2941
+ request; this effectively ignores the
2942
+ authentication in the spec for a single request.
2943
+ :type _request_auth: dict, optional
2944
+ :param _content_type: force content-type for the request.
2945
+ :type _content_type: str, Optional
2946
+ :param _headers: set to override the headers for a single
2947
+ request; this effectively ignores the headers
2948
+ in the spec for a single request.
2949
+ :type _headers: dict, optional
2950
+ :param _host_index: set to override the host_index for a single
2951
+ request; this effectively ignores the host_index
2952
+ in the spec for a single request.
2953
+ :type _host_index: int, optional
2954
+ :return: Returns the result object.
2955
+ """ # noqa: E501
2956
+
2957
+ _param = self._upload_check_deposit_back_image_serialize(
2958
+ check_deposit_id=check_deposit_id,
2959
+ body=body,
2960
+ _request_auth=_request_auth,
2961
+ _content_type=_content_type,
2962
+ _headers=_headers,
2963
+ _host_index=_host_index
2964
+ )
2965
+
2966
+ _response_types_map: Dict[str, Optional[str]] = {
2967
+ '200': "CreateCheckDeposit201Response",
2968
+ '400': "ErrorDocument",
2969
+ '401': "ErrorDocument",
2970
+ '404': "ErrorDocument",
2971
+ }
2972
+ response_data = self.api_client.call_api(
2973
+ *_param,
2974
+ _request_timeout=_request_timeout
2975
+ )
2976
+ return response_data.response
2977
+
2978
+
2979
+ def _upload_check_deposit_back_image_serialize(
2980
+ self,
2981
+ check_deposit_id,
2982
+ body,
2983
+ _request_auth,
2984
+ _content_type,
2985
+ _headers,
2986
+ _host_index,
2987
+ ) -> RequestSerialized:
2988
+
2989
+ _host = None
2990
+
2991
+ _collection_formats: Dict[str, str] = {
2992
+ }
2993
+
2994
+ _path_params: Dict[str, str] = {}
2995
+ _query_params: List[Tuple[str, str]] = []
2996
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2997
+ _form_params: List[Tuple[str, str]] = []
2998
+ _files: Dict[
2999
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3000
+ ] = {}
3001
+ _body_params: Optional[bytes] = None
3002
+
3003
+ # process the path parameters
3004
+ if check_deposit_id is not None:
3005
+ _path_params['checkDepositId'] = check_deposit_id
3006
+ # process the query parameters
3007
+ # process the header parameters
3008
+ # process the form parameters
3009
+ # process the body parameter
3010
+ if body is not None:
3011
+ # convert to byte array if the input is a file name (str)
3012
+ if isinstance(body, str):
3013
+ with open(body, "rb") as _fp:
3014
+ _body_params = _fp.read()
3015
+ elif isinstance(body, tuple):
3016
+ # drop the filename from the tuple
3017
+ _body_params = body[1]
3018
+ else:
3019
+ _body_params = body
3020
+
3021
+
3022
+ # set the HTTP header `Accept`
3023
+ if 'Accept' not in _header_params:
3024
+ _header_params['Accept'] = self.api_client.select_header_accept(
3025
+ [
3026
+ 'application/vnd.api+json'
3027
+ ]
3028
+ )
3029
+
3030
+ # set the HTTP header `Content-Type`
3031
+ if _content_type:
3032
+ _header_params['Content-Type'] = _content_type
3033
+ else:
3034
+ _default_content_type = (
3035
+ self.api_client.select_header_content_type(
3036
+ [
3037
+ 'image/jpeg'
3038
+ ]
3039
+ )
3040
+ )
3041
+ if _default_content_type is not None:
3042
+ _header_params['Content-Type'] = _default_content_type
3043
+
3044
+ # authentication setting
3045
+ _auth_settings: List[str] = [
3046
+ 'bearerAuth'
3047
+ ]
3048
+
3049
+ return self.api_client.param_serialize(
3050
+ method='PUT',
3051
+ resource_path='/check-deposits/{checkDepositId}/back',
3052
+ path_params=_path_params,
3053
+ query_params=_query_params,
3054
+ header_params=_header_params,
3055
+ body=_body_params,
3056
+ post_params=_form_params,
3057
+ files=_files,
3058
+ auth_settings=_auth_settings,
3059
+ collection_formats=_collection_formats,
3060
+ _host=_host,
3061
+ _request_auth=_request_auth
3062
+ )
3063
+
3064
+
3065
+
3066
+
3067
+ @validate_call
3068
+ def upload_check_deposit_front_image(
3069
+ self,
3070
+ check_deposit_id: StrictStr,
3071
+ body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
3072
+ _request_timeout: Union[
3073
+ None,
3074
+ Annotated[StrictFloat, Field(gt=0)],
3075
+ Tuple[
3076
+ Annotated[StrictFloat, Field(gt=0)],
3077
+ Annotated[StrictFloat, Field(gt=0)]
3078
+ ]
3079
+ ] = None,
3080
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3081
+ _content_type: Optional[StrictStr] = None,
3082
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3083
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3084
+ ) -> CreateCheckDeposit201Response:
3085
+ """Upload a check deposit front image
3086
+
3087
+ Uploads a check front-side image file. Currently only `jpeg` file type is supported.
3088
+
3089
+ :param check_deposit_id: (required)
3090
+ :type check_deposit_id: str
3091
+ :param body: (required)
3092
+ :type body: bytes
3093
+ :param _request_timeout: timeout setting for this request. If one
3094
+ number provided, it will be total request
3095
+ timeout. It can also be a pair (tuple) of
3096
+ (connection, read) timeouts.
3097
+ :type _request_timeout: int, tuple(int, int), optional
3098
+ :param _request_auth: set to override the auth_settings for an a single
3099
+ request; this effectively ignores the
3100
+ authentication in the spec for a single request.
3101
+ :type _request_auth: dict, optional
3102
+ :param _content_type: force content-type for the request.
3103
+ :type _content_type: str, Optional
3104
+ :param _headers: set to override the headers for a single
3105
+ request; this effectively ignores the headers
3106
+ in the spec for a single request.
3107
+ :type _headers: dict, optional
3108
+ :param _host_index: set to override the host_index for a single
3109
+ request; this effectively ignores the host_index
3110
+ in the spec for a single request.
3111
+ :type _host_index: int, optional
3112
+ :return: Returns the result object.
3113
+ """ # noqa: E501
3114
+
3115
+ _param = self._upload_check_deposit_front_image_serialize(
3116
+ check_deposit_id=check_deposit_id,
3117
+ body=body,
3118
+ _request_auth=_request_auth,
3119
+ _content_type=_content_type,
3120
+ _headers=_headers,
3121
+ _host_index=_host_index
3122
+ )
3123
+
3124
+ _response_types_map: Dict[str, Optional[str]] = {
3125
+ '200': "CreateCheckDeposit201Response",
3126
+ '400': "ErrorDocument",
3127
+ '401': "ErrorDocument",
3128
+ '404': "ErrorDocument",
3129
+ }
3130
+ response_data = self.api_client.call_api(
3131
+ *_param,
3132
+ _request_timeout=_request_timeout
3133
+ )
3134
+ response_data.read()
3135
+ return self.api_client.response_deserialize(
3136
+ response_data=response_data,
3137
+ response_types_map=_response_types_map,
3138
+ ).data
3139
+
3140
+
3141
+ @validate_call
3142
+ def upload_check_deposit_front_image_with_http_info(
3143
+ self,
3144
+ check_deposit_id: StrictStr,
3145
+ body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
3146
+ _request_timeout: Union[
3147
+ None,
3148
+ Annotated[StrictFloat, Field(gt=0)],
3149
+ Tuple[
3150
+ Annotated[StrictFloat, Field(gt=0)],
3151
+ Annotated[StrictFloat, Field(gt=0)]
3152
+ ]
3153
+ ] = None,
3154
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3155
+ _content_type: Optional[StrictStr] = None,
3156
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3157
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3158
+ ) -> ApiResponse[CreateCheckDeposit201Response]:
3159
+ """Upload a check deposit front image
3160
+
3161
+ Uploads a check front-side image file. Currently only `jpeg` file type is supported.
3162
+
3163
+ :param check_deposit_id: (required)
3164
+ :type check_deposit_id: str
3165
+ :param body: (required)
3166
+ :type body: bytes
3167
+ :param _request_timeout: timeout setting for this request. If one
3168
+ number provided, it will be total request
3169
+ timeout. It can also be a pair (tuple) of
3170
+ (connection, read) timeouts.
3171
+ :type _request_timeout: int, tuple(int, int), optional
3172
+ :param _request_auth: set to override the auth_settings for an a single
3173
+ request; this effectively ignores the
3174
+ authentication in the spec for a single request.
3175
+ :type _request_auth: dict, optional
3176
+ :param _content_type: force content-type for the request.
3177
+ :type _content_type: str, Optional
3178
+ :param _headers: set to override the headers for a single
3179
+ request; this effectively ignores the headers
3180
+ in the spec for a single request.
3181
+ :type _headers: dict, optional
3182
+ :param _host_index: set to override the host_index for a single
3183
+ request; this effectively ignores the host_index
3184
+ in the spec for a single request.
3185
+ :type _host_index: int, optional
3186
+ :return: Returns the result object.
3187
+ """ # noqa: E501
3188
+
3189
+ _param = self._upload_check_deposit_front_image_serialize(
3190
+ check_deposit_id=check_deposit_id,
3191
+ body=body,
3192
+ _request_auth=_request_auth,
3193
+ _content_type=_content_type,
3194
+ _headers=_headers,
3195
+ _host_index=_host_index
3196
+ )
3197
+
3198
+ _response_types_map: Dict[str, Optional[str]] = {
3199
+ '200': "CreateCheckDeposit201Response",
3200
+ '400': "ErrorDocument",
3201
+ '401': "ErrorDocument",
3202
+ '404': "ErrorDocument",
3203
+ }
3204
+ response_data = self.api_client.call_api(
3205
+ *_param,
3206
+ _request_timeout=_request_timeout
3207
+ )
3208
+ response_data.read()
3209
+ return self.api_client.response_deserialize(
3210
+ response_data=response_data,
3211
+ response_types_map=_response_types_map,
3212
+ )
3213
+
3214
+
3215
+ @validate_call
3216
+ def upload_check_deposit_front_image_without_preload_content(
3217
+ self,
3218
+ check_deposit_id: StrictStr,
3219
+ body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
3220
+ _request_timeout: Union[
3221
+ None,
3222
+ Annotated[StrictFloat, Field(gt=0)],
3223
+ Tuple[
3224
+ Annotated[StrictFloat, Field(gt=0)],
3225
+ Annotated[StrictFloat, Field(gt=0)]
3226
+ ]
3227
+ ] = None,
3228
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3229
+ _content_type: Optional[StrictStr] = None,
3230
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3231
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3232
+ ) -> RESTResponseType:
3233
+ """Upload a check deposit front image
3234
+
3235
+ Uploads a check front-side image file. Currently only `jpeg` file type is supported.
3236
+
3237
+ :param check_deposit_id: (required)
3238
+ :type check_deposit_id: str
3239
+ :param body: (required)
3240
+ :type body: bytes
3241
+ :param _request_timeout: timeout setting for this request. If one
3242
+ number provided, it will be total request
3243
+ timeout. It can also be a pair (tuple) of
3244
+ (connection, read) timeouts.
3245
+ :type _request_timeout: int, tuple(int, int), optional
3246
+ :param _request_auth: set to override the auth_settings for an a single
3247
+ request; this effectively ignores the
3248
+ authentication in the spec for a single request.
3249
+ :type _request_auth: dict, optional
3250
+ :param _content_type: force content-type for the request.
3251
+ :type _content_type: str, Optional
3252
+ :param _headers: set to override the headers for a single
3253
+ request; this effectively ignores the headers
3254
+ in the spec for a single request.
3255
+ :type _headers: dict, optional
3256
+ :param _host_index: set to override the host_index for a single
3257
+ request; this effectively ignores the host_index
3258
+ in the spec for a single request.
3259
+ :type _host_index: int, optional
3260
+ :return: Returns the result object.
3261
+ """ # noqa: E501
3262
+
3263
+ _param = self._upload_check_deposit_front_image_serialize(
3264
+ check_deposit_id=check_deposit_id,
3265
+ body=body,
3266
+ _request_auth=_request_auth,
3267
+ _content_type=_content_type,
3268
+ _headers=_headers,
3269
+ _host_index=_host_index
3270
+ )
3271
+
3272
+ _response_types_map: Dict[str, Optional[str]] = {
3273
+ '200': "CreateCheckDeposit201Response",
3274
+ '400': "ErrorDocument",
3275
+ '401': "ErrorDocument",
3276
+ '404': "ErrorDocument",
3277
+ }
3278
+ response_data = self.api_client.call_api(
3279
+ *_param,
3280
+ _request_timeout=_request_timeout
3281
+ )
3282
+ return response_data.response
3283
+
3284
+
3285
+ def _upload_check_deposit_front_image_serialize(
3286
+ self,
3287
+ check_deposit_id,
3288
+ body,
3289
+ _request_auth,
3290
+ _content_type,
3291
+ _headers,
3292
+ _host_index,
3293
+ ) -> RequestSerialized:
3294
+
3295
+ _host = None
3296
+
3297
+ _collection_formats: Dict[str, str] = {
3298
+ }
3299
+
3300
+ _path_params: Dict[str, str] = {}
3301
+ _query_params: List[Tuple[str, str]] = []
3302
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3303
+ _form_params: List[Tuple[str, str]] = []
3304
+ _files: Dict[
3305
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3306
+ ] = {}
3307
+ _body_params: Optional[bytes] = None
3308
+
3309
+ # process the path parameters
3310
+ if check_deposit_id is not None:
3311
+ _path_params['checkDepositId'] = check_deposit_id
3312
+ # process the query parameters
3313
+ # process the header parameters
3314
+ # process the form parameters
3315
+ # process the body parameter
3316
+ if body is not None:
3317
+ # convert to byte array if the input is a file name (str)
3318
+ if isinstance(body, str):
3319
+ with open(body, "rb") as _fp:
3320
+ _body_params = _fp.read()
3321
+ elif isinstance(body, tuple):
3322
+ # drop the filename from the tuple
3323
+ _body_params = body[1]
3324
+ else:
3325
+ _body_params = body
3326
+
3327
+
3328
+ # set the HTTP header `Accept`
3329
+ if 'Accept' not in _header_params:
3330
+ _header_params['Accept'] = self.api_client.select_header_accept(
3331
+ [
3332
+ 'application/vnd.api+json'
3333
+ ]
3334
+ )
3335
+
3336
+ # set the HTTP header `Content-Type`
3337
+ if _content_type:
3338
+ _header_params['Content-Type'] = _content_type
3339
+ else:
3340
+ _default_content_type = (
3341
+ self.api_client.select_header_content_type(
3342
+ [
3343
+ 'image/jpeg'
3344
+ ]
3345
+ )
3346
+ )
3347
+ if _default_content_type is not None:
3348
+ _header_params['Content-Type'] = _default_content_type
3349
+
3350
+ # authentication setting
3351
+ _auth_settings: List[str] = [
3352
+ 'bearerAuth'
3353
+ ]
3354
+
3355
+ return self.api_client.param_serialize(
3356
+ method='PUT',
3357
+ resource_path='/check-deposits/{checkDepositId}/front',
3358
+ path_params=_path_params,
3359
+ query_params=_query_params,
3360
+ header_params=_header_params,
3361
+ body=_body_params,
3362
+ post_params=_form_params,
3363
+ files=_files,
3364
+ auth_settings=_auth_settings,
3365
+ collection_formats=_collection_formats,
3366
+ _host=_host,
3367
+ _request_auth=_request_auth
3368
+ )
3369
+
3370
+