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,1899 @@
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, StrictStr, field_validator
19
+ from typing import Optional
20
+ from typing_extensions import Annotated
21
+ from unit_finance_sdk.models.archive_customer_request import ArchiveCustomerRequest
22
+ from unit_finance_sdk.models.create_business_wallet_customer201_response import CreateBusinessWalletCustomer201Response
23
+ from unit_finance_sdk.models.create_business_wallet_customer_request import CreateBusinessWalletCustomerRequest
24
+ from unit_finance_sdk.models.get_customer200_response import GetCustomer200Response
25
+ from unit_finance_sdk.models.list_customers200_response import ListCustomers200Response
26
+ from unit_finance_sdk.models.update_business_customer_officer200_response import UpdateBusinessCustomerOfficer200Response
27
+ from unit_finance_sdk.models.update_business_customer_officer_request import UpdateBusinessCustomerOfficerRequest
28
+ from unit_finance_sdk.models.update_customer200_response import UpdateCustomer200Response
29
+ from unit_finance_sdk.models.update_customer_request import UpdateCustomerRequest
30
+
31
+ from unit_finance_sdk.api_client import ApiClient, RequestSerialized
32
+ from unit_finance_sdk.api_response import ApiResponse
33
+ from unit_finance_sdk.rest import RESTResponseType
34
+
35
+
36
+ class CustomersApi:
37
+ """NOTE: This class is auto generated by OpenAPI Generator
38
+ Ref: https://openapi-generator.tech
39
+
40
+ Do not edit the class manually.
41
+ """
42
+
43
+ def __init__(self, api_client=None) -> None:
44
+ if api_client is None:
45
+ api_client = ApiClient.get_default()
46
+ self.api_client = api_client
47
+
48
+
49
+ @validate_call
50
+ def archive_customer(
51
+ self,
52
+ customer_id: StrictStr,
53
+ archive_customer_request: ArchiveCustomerRequest,
54
+ _request_timeout: Union[
55
+ None,
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Tuple[
58
+ Annotated[StrictFloat, Field(gt=0)],
59
+ Annotated[StrictFloat, Field(gt=0)]
60
+ ]
61
+ ] = None,
62
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
63
+ _content_type: Optional[StrictStr] = None,
64
+ _headers: Optional[Dict[StrictStr, Any]] = None,
65
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
66
+ ) -> UpdateCustomer200Response:
67
+ """Archive a customer
68
+
69
+ Archive a customer. The Customer Archived webhook event will be fired.
70
+
71
+ :param customer_id: (required)
72
+ :type customer_id: str
73
+ :param archive_customer_request: (required)
74
+ :type archive_customer_request: ArchiveCustomerRequest
75
+ :param _request_timeout: timeout setting for this request. If one
76
+ number provided, it will be total request
77
+ timeout. It can also be a pair (tuple) of
78
+ (connection, read) timeouts.
79
+ :type _request_timeout: int, tuple(int, int), optional
80
+ :param _request_auth: set to override the auth_settings for an a single
81
+ request; this effectively ignores the
82
+ authentication in the spec for a single request.
83
+ :type _request_auth: dict, optional
84
+ :param _content_type: force content-type for the request.
85
+ :type _content_type: str, Optional
86
+ :param _headers: set to override the headers for a single
87
+ request; this effectively ignores the headers
88
+ in the spec for a single request.
89
+ :type _headers: dict, optional
90
+ :param _host_index: set to override the host_index for a single
91
+ request; this effectively ignores the host_index
92
+ in the spec for a single request.
93
+ :type _host_index: int, optional
94
+ :return: Returns the result object.
95
+ """ # noqa: E501
96
+
97
+ _param = self._archive_customer_serialize(
98
+ customer_id=customer_id,
99
+ archive_customer_request=archive_customer_request,
100
+ _request_auth=_request_auth,
101
+ _content_type=_content_type,
102
+ _headers=_headers,
103
+ _host_index=_host_index
104
+ )
105
+
106
+ _response_types_map: Dict[str, Optional[str]] = {
107
+ '200': "UpdateCustomer200Response",
108
+ '400': "ErrorDocument",
109
+ '401': "ErrorDocument",
110
+ '404': "ErrorDocument",
111
+ }
112
+ response_data = self.api_client.call_api(
113
+ *_param,
114
+ _request_timeout=_request_timeout
115
+ )
116
+ response_data.read()
117
+ return self.api_client.response_deserialize(
118
+ response_data=response_data,
119
+ response_types_map=_response_types_map,
120
+ ).data
121
+
122
+
123
+ @validate_call
124
+ def archive_customer_with_http_info(
125
+ self,
126
+ customer_id: StrictStr,
127
+ archive_customer_request: ArchiveCustomerRequest,
128
+ _request_timeout: Union[
129
+ None,
130
+ Annotated[StrictFloat, Field(gt=0)],
131
+ Tuple[
132
+ Annotated[StrictFloat, Field(gt=0)],
133
+ Annotated[StrictFloat, Field(gt=0)]
134
+ ]
135
+ ] = None,
136
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
137
+ _content_type: Optional[StrictStr] = None,
138
+ _headers: Optional[Dict[StrictStr, Any]] = None,
139
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
140
+ ) -> ApiResponse[UpdateCustomer200Response]:
141
+ """Archive a customer
142
+
143
+ Archive a customer. The Customer Archived webhook event will be fired.
144
+
145
+ :param customer_id: (required)
146
+ :type customer_id: str
147
+ :param archive_customer_request: (required)
148
+ :type archive_customer_request: ArchiveCustomerRequest
149
+ :param _request_timeout: timeout setting for this request. If one
150
+ number provided, it will be total request
151
+ timeout. It can also be a pair (tuple) of
152
+ (connection, read) timeouts.
153
+ :type _request_timeout: int, tuple(int, int), optional
154
+ :param _request_auth: set to override the auth_settings for an a single
155
+ request; this effectively ignores the
156
+ authentication in the spec for a single request.
157
+ :type _request_auth: dict, optional
158
+ :param _content_type: force content-type for the request.
159
+ :type _content_type: str, Optional
160
+ :param _headers: set to override the headers for a single
161
+ request; this effectively ignores the headers
162
+ in the spec for a single request.
163
+ :type _headers: dict, optional
164
+ :param _host_index: set to override the host_index for a single
165
+ request; this effectively ignores the host_index
166
+ in the spec for a single request.
167
+ :type _host_index: int, optional
168
+ :return: Returns the result object.
169
+ """ # noqa: E501
170
+
171
+ _param = self._archive_customer_serialize(
172
+ customer_id=customer_id,
173
+ archive_customer_request=archive_customer_request,
174
+ _request_auth=_request_auth,
175
+ _content_type=_content_type,
176
+ _headers=_headers,
177
+ _host_index=_host_index
178
+ )
179
+
180
+ _response_types_map: Dict[str, Optional[str]] = {
181
+ '200': "UpdateCustomer200Response",
182
+ '400': "ErrorDocument",
183
+ '401': "ErrorDocument",
184
+ '404': "ErrorDocument",
185
+ }
186
+ response_data = self.api_client.call_api(
187
+ *_param,
188
+ _request_timeout=_request_timeout
189
+ )
190
+ response_data.read()
191
+ return self.api_client.response_deserialize(
192
+ response_data=response_data,
193
+ response_types_map=_response_types_map,
194
+ )
195
+
196
+
197
+ @validate_call
198
+ def archive_customer_without_preload_content(
199
+ self,
200
+ customer_id: StrictStr,
201
+ archive_customer_request: ArchiveCustomerRequest,
202
+ _request_timeout: Union[
203
+ None,
204
+ Annotated[StrictFloat, Field(gt=0)],
205
+ Tuple[
206
+ Annotated[StrictFloat, Field(gt=0)],
207
+ Annotated[StrictFloat, Field(gt=0)]
208
+ ]
209
+ ] = None,
210
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
211
+ _content_type: Optional[StrictStr] = None,
212
+ _headers: Optional[Dict[StrictStr, Any]] = None,
213
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
214
+ ) -> RESTResponseType:
215
+ """Archive a customer
216
+
217
+ Archive a customer. The Customer Archived webhook event will be fired.
218
+
219
+ :param customer_id: (required)
220
+ :type customer_id: str
221
+ :param archive_customer_request: (required)
222
+ :type archive_customer_request: ArchiveCustomerRequest
223
+ :param _request_timeout: timeout setting for this request. If one
224
+ number provided, it will be total request
225
+ timeout. It can also be a pair (tuple) of
226
+ (connection, read) timeouts.
227
+ :type _request_timeout: int, tuple(int, int), optional
228
+ :param _request_auth: set to override the auth_settings for an a single
229
+ request; this effectively ignores the
230
+ authentication in the spec for a single request.
231
+ :type _request_auth: dict, optional
232
+ :param _content_type: force content-type for the request.
233
+ :type _content_type: str, Optional
234
+ :param _headers: set to override the headers for a single
235
+ request; this effectively ignores the headers
236
+ in the spec for a single request.
237
+ :type _headers: dict, optional
238
+ :param _host_index: set to override the host_index for a single
239
+ request; this effectively ignores the host_index
240
+ in the spec for a single request.
241
+ :type _host_index: int, optional
242
+ :return: Returns the result object.
243
+ """ # noqa: E501
244
+
245
+ _param = self._archive_customer_serialize(
246
+ customer_id=customer_id,
247
+ archive_customer_request=archive_customer_request,
248
+ _request_auth=_request_auth,
249
+ _content_type=_content_type,
250
+ _headers=_headers,
251
+ _host_index=_host_index
252
+ )
253
+
254
+ _response_types_map: Dict[str, Optional[str]] = {
255
+ '200': "UpdateCustomer200Response",
256
+ '400': "ErrorDocument",
257
+ '401': "ErrorDocument",
258
+ '404': "ErrorDocument",
259
+ }
260
+ response_data = self.api_client.call_api(
261
+ *_param,
262
+ _request_timeout=_request_timeout
263
+ )
264
+ return response_data.response
265
+
266
+
267
+ def _archive_customer_serialize(
268
+ self,
269
+ customer_id,
270
+ archive_customer_request,
271
+ _request_auth,
272
+ _content_type,
273
+ _headers,
274
+ _host_index,
275
+ ) -> RequestSerialized:
276
+
277
+ _host = None
278
+
279
+ _collection_formats: Dict[str, str] = {
280
+ }
281
+
282
+ _path_params: Dict[str, str] = {}
283
+ _query_params: List[Tuple[str, str]] = []
284
+ _header_params: Dict[str, Optional[str]] = _headers or {}
285
+ _form_params: List[Tuple[str, str]] = []
286
+ _files: Dict[
287
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
288
+ ] = {}
289
+ _body_params: Optional[bytes] = None
290
+
291
+ # process the path parameters
292
+ if customer_id is not None:
293
+ _path_params['customerId'] = customer_id
294
+ # process the query parameters
295
+ # process the header parameters
296
+ # process the form parameters
297
+ # process the body parameter
298
+ if archive_customer_request is not None:
299
+ _body_params = archive_customer_request
300
+
301
+
302
+ # set the HTTP header `Accept`
303
+ if 'Accept' not in _header_params:
304
+ _header_params['Accept'] = self.api_client.select_header_accept(
305
+ [
306
+ 'application/vnd.api+json'
307
+ ]
308
+ )
309
+
310
+ # set the HTTP header `Content-Type`
311
+ if _content_type:
312
+ _header_params['Content-Type'] = _content_type
313
+ else:
314
+ _default_content_type = (
315
+ self.api_client.select_header_content_type(
316
+ [
317
+ 'application/vnd.api+json'
318
+ ]
319
+ )
320
+ )
321
+ if _default_content_type is not None:
322
+ _header_params['Content-Type'] = _default_content_type
323
+
324
+ # authentication setting
325
+ _auth_settings: List[str] = [
326
+ 'bearerAuth'
327
+ ]
328
+
329
+ return self.api_client.param_serialize(
330
+ method='POST',
331
+ resource_path='/customers/{customerId}/archive',
332
+ path_params=_path_params,
333
+ query_params=_query_params,
334
+ header_params=_header_params,
335
+ body=_body_params,
336
+ post_params=_form_params,
337
+ files=_files,
338
+ auth_settings=_auth_settings,
339
+ collection_formats=_collection_formats,
340
+ _host=_host,
341
+ _request_auth=_request_auth
342
+ )
343
+
344
+
345
+
346
+
347
+ @validate_call
348
+ def create_business_wallet_customer(
349
+ self,
350
+ create_business_wallet_customer_request: CreateBusinessWalletCustomerRequest,
351
+ _request_timeout: Union[
352
+ None,
353
+ Annotated[StrictFloat, Field(gt=0)],
354
+ Tuple[
355
+ Annotated[StrictFloat, Field(gt=0)],
356
+ Annotated[StrictFloat, Field(gt=0)]
357
+ ]
358
+ ] = None,
359
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
360
+ _content_type: Optional[StrictStr] = None,
361
+ _headers: Optional[Dict[StrictStr, Any]] = None,
362
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
363
+ ) -> CreateBusinessWalletCustomer201Response:
364
+ """Create a business wallet customer
365
+
366
+ Create a business wallet customer.
367
+
368
+ :param create_business_wallet_customer_request: (required)
369
+ :type create_business_wallet_customer_request: CreateBusinessWalletCustomerRequest
370
+ :param _request_timeout: timeout setting for this request. If one
371
+ number provided, it will be total request
372
+ timeout. It can also be a pair (tuple) of
373
+ (connection, read) timeouts.
374
+ :type _request_timeout: int, tuple(int, int), optional
375
+ :param _request_auth: set to override the auth_settings for an a single
376
+ request; this effectively ignores the
377
+ authentication in the spec for a single request.
378
+ :type _request_auth: dict, optional
379
+ :param _content_type: force content-type for the request.
380
+ :type _content_type: str, Optional
381
+ :param _headers: set to override the headers for a single
382
+ request; this effectively ignores the headers
383
+ in the spec for a single request.
384
+ :type _headers: dict, optional
385
+ :param _host_index: set to override the host_index for a single
386
+ request; this effectively ignores the host_index
387
+ in the spec for a single request.
388
+ :type _host_index: int, optional
389
+ :return: Returns the result object.
390
+ """ # noqa: E501
391
+
392
+ _param = self._create_business_wallet_customer_serialize(
393
+ create_business_wallet_customer_request=create_business_wallet_customer_request,
394
+ _request_auth=_request_auth,
395
+ _content_type=_content_type,
396
+ _headers=_headers,
397
+ _host_index=_host_index
398
+ )
399
+
400
+ _response_types_map: Dict[str, Optional[str]] = {
401
+ '201': "CreateBusinessWalletCustomer201Response",
402
+ '400': "ErrorDocument",
403
+ '401': "ErrorDocument",
404
+ '404': "ErrorDocument",
405
+ }
406
+ response_data = self.api_client.call_api(
407
+ *_param,
408
+ _request_timeout=_request_timeout
409
+ )
410
+ response_data.read()
411
+ return self.api_client.response_deserialize(
412
+ response_data=response_data,
413
+ response_types_map=_response_types_map,
414
+ ).data
415
+
416
+
417
+ @validate_call
418
+ def create_business_wallet_customer_with_http_info(
419
+ self,
420
+ create_business_wallet_customer_request: CreateBusinessWalletCustomerRequest,
421
+ _request_timeout: Union[
422
+ None,
423
+ Annotated[StrictFloat, Field(gt=0)],
424
+ Tuple[
425
+ Annotated[StrictFloat, Field(gt=0)],
426
+ Annotated[StrictFloat, Field(gt=0)]
427
+ ]
428
+ ] = None,
429
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
430
+ _content_type: Optional[StrictStr] = None,
431
+ _headers: Optional[Dict[StrictStr, Any]] = None,
432
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
433
+ ) -> ApiResponse[CreateBusinessWalletCustomer201Response]:
434
+ """Create a business wallet customer
435
+
436
+ Create a business wallet customer.
437
+
438
+ :param create_business_wallet_customer_request: (required)
439
+ :type create_business_wallet_customer_request: CreateBusinessWalletCustomerRequest
440
+ :param _request_timeout: timeout setting for this request. If one
441
+ number provided, it will be total request
442
+ timeout. It can also be a pair (tuple) of
443
+ (connection, read) timeouts.
444
+ :type _request_timeout: int, tuple(int, int), optional
445
+ :param _request_auth: set to override the auth_settings for an a single
446
+ request; this effectively ignores the
447
+ authentication in the spec for a single request.
448
+ :type _request_auth: dict, optional
449
+ :param _content_type: force content-type for the request.
450
+ :type _content_type: str, Optional
451
+ :param _headers: set to override the headers for a single
452
+ request; this effectively ignores the headers
453
+ in the spec for a single request.
454
+ :type _headers: dict, optional
455
+ :param _host_index: set to override the host_index for a single
456
+ request; this effectively ignores the host_index
457
+ in the spec for a single request.
458
+ :type _host_index: int, optional
459
+ :return: Returns the result object.
460
+ """ # noqa: E501
461
+
462
+ _param = self._create_business_wallet_customer_serialize(
463
+ create_business_wallet_customer_request=create_business_wallet_customer_request,
464
+ _request_auth=_request_auth,
465
+ _content_type=_content_type,
466
+ _headers=_headers,
467
+ _host_index=_host_index
468
+ )
469
+
470
+ _response_types_map: Dict[str, Optional[str]] = {
471
+ '201': "CreateBusinessWalletCustomer201Response",
472
+ '400': "ErrorDocument",
473
+ '401': "ErrorDocument",
474
+ '404': "ErrorDocument",
475
+ }
476
+ response_data = self.api_client.call_api(
477
+ *_param,
478
+ _request_timeout=_request_timeout
479
+ )
480
+ response_data.read()
481
+ return self.api_client.response_deserialize(
482
+ response_data=response_data,
483
+ response_types_map=_response_types_map,
484
+ )
485
+
486
+
487
+ @validate_call
488
+ def create_business_wallet_customer_without_preload_content(
489
+ self,
490
+ create_business_wallet_customer_request: CreateBusinessWalletCustomerRequest,
491
+ _request_timeout: Union[
492
+ None,
493
+ Annotated[StrictFloat, Field(gt=0)],
494
+ Tuple[
495
+ Annotated[StrictFloat, Field(gt=0)],
496
+ Annotated[StrictFloat, Field(gt=0)]
497
+ ]
498
+ ] = None,
499
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
500
+ _content_type: Optional[StrictStr] = None,
501
+ _headers: Optional[Dict[StrictStr, Any]] = None,
502
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
503
+ ) -> RESTResponseType:
504
+ """Create a business wallet customer
505
+
506
+ Create a business wallet customer.
507
+
508
+ :param create_business_wallet_customer_request: (required)
509
+ :type create_business_wallet_customer_request: CreateBusinessWalletCustomerRequest
510
+ :param _request_timeout: timeout setting for this request. If one
511
+ number provided, it will be total request
512
+ timeout. It can also be a pair (tuple) of
513
+ (connection, read) timeouts.
514
+ :type _request_timeout: int, tuple(int, int), optional
515
+ :param _request_auth: set to override the auth_settings for an a single
516
+ request; this effectively ignores the
517
+ authentication in the spec for a single request.
518
+ :type _request_auth: dict, optional
519
+ :param _content_type: force content-type for the request.
520
+ :type _content_type: str, Optional
521
+ :param _headers: set to override the headers for a single
522
+ request; this effectively ignores the headers
523
+ in the spec for a single request.
524
+ :type _headers: dict, optional
525
+ :param _host_index: set to override the host_index for a single
526
+ request; this effectively ignores the host_index
527
+ in the spec for a single request.
528
+ :type _host_index: int, optional
529
+ :return: Returns the result object.
530
+ """ # noqa: E501
531
+
532
+ _param = self._create_business_wallet_customer_serialize(
533
+ create_business_wallet_customer_request=create_business_wallet_customer_request,
534
+ _request_auth=_request_auth,
535
+ _content_type=_content_type,
536
+ _headers=_headers,
537
+ _host_index=_host_index
538
+ )
539
+
540
+ _response_types_map: Dict[str, Optional[str]] = {
541
+ '201': "CreateBusinessWalletCustomer201Response",
542
+ '400': "ErrorDocument",
543
+ '401': "ErrorDocument",
544
+ '404': "ErrorDocument",
545
+ }
546
+ response_data = self.api_client.call_api(
547
+ *_param,
548
+ _request_timeout=_request_timeout
549
+ )
550
+ return response_data.response
551
+
552
+
553
+ def _create_business_wallet_customer_serialize(
554
+ self,
555
+ create_business_wallet_customer_request,
556
+ _request_auth,
557
+ _content_type,
558
+ _headers,
559
+ _host_index,
560
+ ) -> RequestSerialized:
561
+
562
+ _host = None
563
+
564
+ _collection_formats: Dict[str, str] = {
565
+ }
566
+
567
+ _path_params: Dict[str, str] = {}
568
+ _query_params: List[Tuple[str, str]] = []
569
+ _header_params: Dict[str, Optional[str]] = _headers or {}
570
+ _form_params: List[Tuple[str, str]] = []
571
+ _files: Dict[
572
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
573
+ ] = {}
574
+ _body_params: Optional[bytes] = None
575
+
576
+ # process the path parameters
577
+ # process the query parameters
578
+ # process the header parameters
579
+ # process the form parameters
580
+ # process the body parameter
581
+ if create_business_wallet_customer_request is not None:
582
+ _body_params = create_business_wallet_customer_request
583
+
584
+
585
+ # set the HTTP header `Accept`
586
+ if 'Accept' not in _header_params:
587
+ _header_params['Accept'] = self.api_client.select_header_accept(
588
+ [
589
+ 'application/vnd.api+json'
590
+ ]
591
+ )
592
+
593
+ # set the HTTP header `Content-Type`
594
+ if _content_type:
595
+ _header_params['Content-Type'] = _content_type
596
+ else:
597
+ _default_content_type = (
598
+ self.api_client.select_header_content_type(
599
+ [
600
+ 'application/vnd.api+json'
601
+ ]
602
+ )
603
+ )
604
+ if _default_content_type is not None:
605
+ _header_params['Content-Type'] = _default_content_type
606
+
607
+ # authentication setting
608
+ _auth_settings: List[str] = [
609
+ 'bearerAuth'
610
+ ]
611
+
612
+ return self.api_client.param_serialize(
613
+ method='POST',
614
+ resource_path='/customers',
615
+ path_params=_path_params,
616
+ query_params=_query_params,
617
+ header_params=_header_params,
618
+ body=_body_params,
619
+ post_params=_form_params,
620
+ files=_files,
621
+ auth_settings=_auth_settings,
622
+ collection_formats=_collection_formats,
623
+ _host=_host,
624
+ _request_auth=_request_auth
625
+ )
626
+
627
+
628
+
629
+
630
+ @validate_call
631
+ def get_customer(
632
+ self,
633
+ customer_id: StrictStr,
634
+ include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resource include: authorizedUser. See Getting Related Resources")] = None,
635
+ _request_timeout: Union[
636
+ None,
637
+ Annotated[StrictFloat, Field(gt=0)],
638
+ Tuple[
639
+ Annotated[StrictFloat, Field(gt=0)],
640
+ Annotated[StrictFloat, Field(gt=0)]
641
+ ]
642
+ ] = None,
643
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
644
+ _content_type: Optional[StrictStr] = None,
645
+ _headers: Optional[Dict[StrictStr, Any]] = None,
646
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
647
+ ) -> GetCustomer200Response:
648
+ """Get a customer
649
+
650
+ Get a customer resource by id.
651
+
652
+ :param customer_id: (required)
653
+ :type customer_id: str
654
+ :param include: Optional. A comma-separated list of related resources to include in the response. Related resource include: authorizedUser. See Getting Related Resources
655
+ :type include: str
656
+ :param _request_timeout: timeout setting for this request. If one
657
+ number provided, it will be total request
658
+ timeout. It can also be a pair (tuple) of
659
+ (connection, read) timeouts.
660
+ :type _request_timeout: int, tuple(int, int), optional
661
+ :param _request_auth: set to override the auth_settings for an a single
662
+ request; this effectively ignores the
663
+ authentication in the spec for a single request.
664
+ :type _request_auth: dict, optional
665
+ :param _content_type: force content-type for the request.
666
+ :type _content_type: str, Optional
667
+ :param _headers: set to override the headers for a single
668
+ request; this effectively ignores the headers
669
+ in the spec for a single request.
670
+ :type _headers: dict, optional
671
+ :param _host_index: set to override the host_index for a single
672
+ request; this effectively ignores the host_index
673
+ in the spec for a single request.
674
+ :type _host_index: int, optional
675
+ :return: Returns the result object.
676
+ """ # noqa: E501
677
+
678
+ _param = self._get_customer_serialize(
679
+ customer_id=customer_id,
680
+ include=include,
681
+ _request_auth=_request_auth,
682
+ _content_type=_content_type,
683
+ _headers=_headers,
684
+ _host_index=_host_index
685
+ )
686
+
687
+ _response_types_map: Dict[str, Optional[str]] = {
688
+ '200': "GetCustomer200Response",
689
+ '400': "ErrorDocument",
690
+ '401': "ErrorDocument",
691
+ '404': "ErrorDocument",
692
+ }
693
+ response_data = self.api_client.call_api(
694
+ *_param,
695
+ _request_timeout=_request_timeout
696
+ )
697
+ response_data.read()
698
+ return self.api_client.response_deserialize(
699
+ response_data=response_data,
700
+ response_types_map=_response_types_map,
701
+ ).data
702
+
703
+
704
+ @validate_call
705
+ def get_customer_with_http_info(
706
+ self,
707
+ customer_id: StrictStr,
708
+ include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resource include: authorizedUser. See Getting Related Resources")] = None,
709
+ _request_timeout: Union[
710
+ None,
711
+ Annotated[StrictFloat, Field(gt=0)],
712
+ Tuple[
713
+ Annotated[StrictFloat, Field(gt=0)],
714
+ Annotated[StrictFloat, Field(gt=0)]
715
+ ]
716
+ ] = None,
717
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
718
+ _content_type: Optional[StrictStr] = None,
719
+ _headers: Optional[Dict[StrictStr, Any]] = None,
720
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
721
+ ) -> ApiResponse[GetCustomer200Response]:
722
+ """Get a customer
723
+
724
+ Get a customer resource by id.
725
+
726
+ :param customer_id: (required)
727
+ :type customer_id: str
728
+ :param include: Optional. A comma-separated list of related resources to include in the response. Related resource include: authorizedUser. See Getting Related Resources
729
+ :type include: str
730
+ :param _request_timeout: timeout setting for this request. If one
731
+ number provided, it will be total request
732
+ timeout. It can also be a pair (tuple) of
733
+ (connection, read) timeouts.
734
+ :type _request_timeout: int, tuple(int, int), optional
735
+ :param _request_auth: set to override the auth_settings for an a single
736
+ request; this effectively ignores the
737
+ authentication in the spec for a single request.
738
+ :type _request_auth: dict, optional
739
+ :param _content_type: force content-type for the request.
740
+ :type _content_type: str, Optional
741
+ :param _headers: set to override the headers for a single
742
+ request; this effectively ignores the headers
743
+ in the spec for a single request.
744
+ :type _headers: dict, optional
745
+ :param _host_index: set to override the host_index for a single
746
+ request; this effectively ignores the host_index
747
+ in the spec for a single request.
748
+ :type _host_index: int, optional
749
+ :return: Returns the result object.
750
+ """ # noqa: E501
751
+
752
+ _param = self._get_customer_serialize(
753
+ customer_id=customer_id,
754
+ include=include,
755
+ _request_auth=_request_auth,
756
+ _content_type=_content_type,
757
+ _headers=_headers,
758
+ _host_index=_host_index
759
+ )
760
+
761
+ _response_types_map: Dict[str, Optional[str]] = {
762
+ '200': "GetCustomer200Response",
763
+ '400': "ErrorDocument",
764
+ '401': "ErrorDocument",
765
+ '404': "ErrorDocument",
766
+ }
767
+ response_data = self.api_client.call_api(
768
+ *_param,
769
+ _request_timeout=_request_timeout
770
+ )
771
+ response_data.read()
772
+ return self.api_client.response_deserialize(
773
+ response_data=response_data,
774
+ response_types_map=_response_types_map,
775
+ )
776
+
777
+
778
+ @validate_call
779
+ def get_customer_without_preload_content(
780
+ self,
781
+ customer_id: StrictStr,
782
+ include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resource include: authorizedUser. See Getting Related Resources")] = None,
783
+ _request_timeout: Union[
784
+ None,
785
+ Annotated[StrictFloat, Field(gt=0)],
786
+ Tuple[
787
+ Annotated[StrictFloat, Field(gt=0)],
788
+ Annotated[StrictFloat, Field(gt=0)]
789
+ ]
790
+ ] = None,
791
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
792
+ _content_type: Optional[StrictStr] = None,
793
+ _headers: Optional[Dict[StrictStr, Any]] = None,
794
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
795
+ ) -> RESTResponseType:
796
+ """Get a customer
797
+
798
+ Get a customer resource by id.
799
+
800
+ :param customer_id: (required)
801
+ :type customer_id: str
802
+ :param include: Optional. A comma-separated list of related resources to include in the response. Related resource include: authorizedUser. See Getting Related Resources
803
+ :type include: str
804
+ :param _request_timeout: timeout setting for this request. If one
805
+ number provided, it will be total request
806
+ timeout. It can also be a pair (tuple) of
807
+ (connection, read) timeouts.
808
+ :type _request_timeout: int, tuple(int, int), optional
809
+ :param _request_auth: set to override the auth_settings for an a single
810
+ request; this effectively ignores the
811
+ authentication in the spec for a single request.
812
+ :type _request_auth: dict, optional
813
+ :param _content_type: force content-type for the request.
814
+ :type _content_type: str, Optional
815
+ :param _headers: set to override the headers for a single
816
+ request; this effectively ignores the headers
817
+ in the spec for a single request.
818
+ :type _headers: dict, optional
819
+ :param _host_index: set to override the host_index for a single
820
+ request; this effectively ignores the host_index
821
+ in the spec for a single request.
822
+ :type _host_index: int, optional
823
+ :return: Returns the result object.
824
+ """ # noqa: E501
825
+
826
+ _param = self._get_customer_serialize(
827
+ customer_id=customer_id,
828
+ include=include,
829
+ _request_auth=_request_auth,
830
+ _content_type=_content_type,
831
+ _headers=_headers,
832
+ _host_index=_host_index
833
+ )
834
+
835
+ _response_types_map: Dict[str, Optional[str]] = {
836
+ '200': "GetCustomer200Response",
837
+ '400': "ErrorDocument",
838
+ '401': "ErrorDocument",
839
+ '404': "ErrorDocument",
840
+ }
841
+ response_data = self.api_client.call_api(
842
+ *_param,
843
+ _request_timeout=_request_timeout
844
+ )
845
+ return response_data.response
846
+
847
+
848
+ def _get_customer_serialize(
849
+ self,
850
+ customer_id,
851
+ include,
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
+ if customer_id is not None:
874
+ _path_params['customerId'] = customer_id
875
+ # process the query parameters
876
+ if include is not None:
877
+
878
+ _query_params.append(('include', include))
879
+
880
+ # process the header parameters
881
+ # process the form parameters
882
+ # process the body parameter
883
+
884
+
885
+ # set the HTTP header `Accept`
886
+ if 'Accept' not in _header_params:
887
+ _header_params['Accept'] = self.api_client.select_header_accept(
888
+ [
889
+ 'application/vnd.api+json'
890
+ ]
891
+ )
892
+
893
+
894
+ # authentication setting
895
+ _auth_settings: List[str] = [
896
+ 'bearerAuth'
897
+ ]
898
+
899
+ return self.api_client.param_serialize(
900
+ method='GET',
901
+ resource_path='/customers/{customerId}',
902
+ path_params=_path_params,
903
+ query_params=_query_params,
904
+ header_params=_header_params,
905
+ body=_body_params,
906
+ post_params=_form_params,
907
+ files=_files,
908
+ auth_settings=_auth_settings,
909
+ collection_formats=_collection_formats,
910
+ _host=_host,
911
+ _request_auth=_request_auth
912
+ )
913
+
914
+
915
+
916
+
917
+ @validate_call
918
+ def list_customers(
919
+ self,
920
+ page_limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.")] = None,
921
+ page_offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Optional. Number of resources to skip. See Pagination.")] = None,
922
+ filter_query: Annotated[Optional[StrictStr], Field(description="Optional. Search term according to the Full-Text Search Rules.")] = None,
923
+ filter_email: Annotated[Optional[StrictStr], Field(description="Optional. Filter customers by email address (case sensitive).")] = None,
924
+ filter_tags: Annotated[Optional[StrictStr], Field(description="Optional. Filter Customers by Tags.")] = None,
925
+ filter_status: Annotated[Optional[StrictStr], Field(description="Optional. Filter customers by status (Active, Archived). Usage example: *filter[status][0]=Active")] = None,
926
+ sort: Annotated[Optional[StrictStr], Field(description="Optional. sort=createdAt for ascending order or sort=-createdAt (leading minus sign) for descending order.")] = None,
927
+ _request_timeout: Union[
928
+ None,
929
+ Annotated[StrictFloat, Field(gt=0)],
930
+ Tuple[
931
+ Annotated[StrictFloat, Field(gt=0)],
932
+ Annotated[StrictFloat, Field(gt=0)]
933
+ ]
934
+ ] = None,
935
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
936
+ _content_type: Optional[StrictStr] = None,
937
+ _headers: Optional[Dict[StrictStr, Any]] = None,
938
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
939
+ ) -> ListCustomers200Response:
940
+ """List customers
941
+
942
+ List customer resources. Paging can be applied.
943
+
944
+ :param page_limit: Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
945
+ :type page_limit: str
946
+ :param page_offset: Optional. Number of resources to skip. See Pagination.
947
+ :type page_offset: str
948
+ :param filter_query: Optional. Search term according to the Full-Text Search Rules.
949
+ :type filter_query: str
950
+ :param filter_email: Optional. Filter customers by email address (case sensitive).
951
+ :type filter_email: str
952
+ :param filter_tags: Optional. Filter Customers by Tags.
953
+ :type filter_tags: str
954
+ :param filter_status: Optional. Filter customers by status (Active, Archived). Usage example: *filter[status][0]=Active
955
+ :type filter_status: str
956
+ :param sort: Optional. sort=createdAt for ascending order or sort=-createdAt (leading minus sign) for descending order.
957
+ :type sort: str
958
+ :param _request_timeout: timeout setting for this request. If one
959
+ number provided, it will be total request
960
+ timeout. It can also be a pair (tuple) of
961
+ (connection, read) timeouts.
962
+ :type _request_timeout: int, tuple(int, int), optional
963
+ :param _request_auth: set to override the auth_settings for an a single
964
+ request; this effectively ignores the
965
+ authentication in the spec for a single request.
966
+ :type _request_auth: dict, optional
967
+ :param _content_type: force content-type for the request.
968
+ :type _content_type: str, Optional
969
+ :param _headers: set to override the headers for a single
970
+ request; this effectively ignores the headers
971
+ in the spec for a single request.
972
+ :type _headers: dict, optional
973
+ :param _host_index: set to override the host_index for a single
974
+ request; this effectively ignores the host_index
975
+ in the spec for a single request.
976
+ :type _host_index: int, optional
977
+ :return: Returns the result object.
978
+ """ # noqa: E501
979
+
980
+ _param = self._list_customers_serialize(
981
+ page_limit=page_limit,
982
+ page_offset=page_offset,
983
+ filter_query=filter_query,
984
+ filter_email=filter_email,
985
+ filter_tags=filter_tags,
986
+ filter_status=filter_status,
987
+ sort=sort,
988
+ _request_auth=_request_auth,
989
+ _content_type=_content_type,
990
+ _headers=_headers,
991
+ _host_index=_host_index
992
+ )
993
+
994
+ _response_types_map: Dict[str, Optional[str]] = {
995
+ '200': "ListCustomers200Response",
996
+ '400': "ErrorDocument",
997
+ '401': "ErrorDocument",
998
+ '404': "ErrorDocument",
999
+ }
1000
+ response_data = self.api_client.call_api(
1001
+ *_param,
1002
+ _request_timeout=_request_timeout
1003
+ )
1004
+ response_data.read()
1005
+ return self.api_client.response_deserialize(
1006
+ response_data=response_data,
1007
+ response_types_map=_response_types_map,
1008
+ ).data
1009
+
1010
+
1011
+ @validate_call
1012
+ def list_customers_with_http_info(
1013
+ self,
1014
+ page_limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.")] = None,
1015
+ page_offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Optional. Number of resources to skip. See Pagination.")] = None,
1016
+ filter_query: Annotated[Optional[StrictStr], Field(description="Optional. Search term according to the Full-Text Search Rules.")] = None,
1017
+ filter_email: Annotated[Optional[StrictStr], Field(description="Optional. Filter customers by email address (case sensitive).")] = None,
1018
+ filter_tags: Annotated[Optional[StrictStr], Field(description="Optional. Filter Customers by Tags.")] = None,
1019
+ filter_status: Annotated[Optional[StrictStr], Field(description="Optional. Filter customers by status (Active, Archived). Usage example: *filter[status][0]=Active")] = None,
1020
+ sort: Annotated[Optional[StrictStr], Field(description="Optional. sort=createdAt for ascending order or sort=-createdAt (leading minus sign) for descending order.")] = None,
1021
+ _request_timeout: Union[
1022
+ None,
1023
+ Annotated[StrictFloat, Field(gt=0)],
1024
+ Tuple[
1025
+ Annotated[StrictFloat, Field(gt=0)],
1026
+ Annotated[StrictFloat, Field(gt=0)]
1027
+ ]
1028
+ ] = None,
1029
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1030
+ _content_type: Optional[StrictStr] = None,
1031
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1032
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1033
+ ) -> ApiResponse[ListCustomers200Response]:
1034
+ """List customers
1035
+
1036
+ List customer resources. Paging can be applied.
1037
+
1038
+ :param page_limit: Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
1039
+ :type page_limit: str
1040
+ :param page_offset: Optional. Number of resources to skip. See Pagination.
1041
+ :type page_offset: str
1042
+ :param filter_query: Optional. Search term according to the Full-Text Search Rules.
1043
+ :type filter_query: str
1044
+ :param filter_email: Optional. Filter customers by email address (case sensitive).
1045
+ :type filter_email: str
1046
+ :param filter_tags: Optional. Filter Customers by Tags.
1047
+ :type filter_tags: str
1048
+ :param filter_status: Optional. Filter customers by status (Active, Archived). Usage example: *filter[status][0]=Active
1049
+ :type filter_status: str
1050
+ :param sort: Optional. sort=createdAt for ascending order or sort=-createdAt (leading minus sign) for descending order.
1051
+ :type sort: str
1052
+ :param _request_timeout: timeout setting for this request. If one
1053
+ number provided, it will be total request
1054
+ timeout. It can also be a pair (tuple) of
1055
+ (connection, read) timeouts.
1056
+ :type _request_timeout: int, tuple(int, int), optional
1057
+ :param _request_auth: set to override the auth_settings for an a single
1058
+ request; this effectively ignores the
1059
+ authentication in the spec for a single request.
1060
+ :type _request_auth: dict, optional
1061
+ :param _content_type: force content-type for the request.
1062
+ :type _content_type: str, Optional
1063
+ :param _headers: set to override the headers for a single
1064
+ request; this effectively ignores the headers
1065
+ in the spec for a single request.
1066
+ :type _headers: dict, optional
1067
+ :param _host_index: set to override the host_index for a single
1068
+ request; this effectively ignores the host_index
1069
+ in the spec for a single request.
1070
+ :type _host_index: int, optional
1071
+ :return: Returns the result object.
1072
+ """ # noqa: E501
1073
+
1074
+ _param = self._list_customers_serialize(
1075
+ page_limit=page_limit,
1076
+ page_offset=page_offset,
1077
+ filter_query=filter_query,
1078
+ filter_email=filter_email,
1079
+ filter_tags=filter_tags,
1080
+ filter_status=filter_status,
1081
+ sort=sort,
1082
+ _request_auth=_request_auth,
1083
+ _content_type=_content_type,
1084
+ _headers=_headers,
1085
+ _host_index=_host_index
1086
+ )
1087
+
1088
+ _response_types_map: Dict[str, Optional[str]] = {
1089
+ '200': "ListCustomers200Response",
1090
+ '400': "ErrorDocument",
1091
+ '401': "ErrorDocument",
1092
+ '404': "ErrorDocument",
1093
+ }
1094
+ response_data = self.api_client.call_api(
1095
+ *_param,
1096
+ _request_timeout=_request_timeout
1097
+ )
1098
+ response_data.read()
1099
+ return self.api_client.response_deserialize(
1100
+ response_data=response_data,
1101
+ response_types_map=_response_types_map,
1102
+ )
1103
+
1104
+
1105
+ @validate_call
1106
+ def list_customers_without_preload_content(
1107
+ self,
1108
+ page_limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.")] = None,
1109
+ page_offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Optional. Number of resources to skip. See Pagination.")] = None,
1110
+ filter_query: Annotated[Optional[StrictStr], Field(description="Optional. Search term according to the Full-Text Search Rules.")] = None,
1111
+ filter_email: Annotated[Optional[StrictStr], Field(description="Optional. Filter customers by email address (case sensitive).")] = None,
1112
+ filter_tags: Annotated[Optional[StrictStr], Field(description="Optional. Filter Customers by Tags.")] = None,
1113
+ filter_status: Annotated[Optional[StrictStr], Field(description="Optional. Filter customers by status (Active, Archived). Usage example: *filter[status][0]=Active")] = None,
1114
+ sort: Annotated[Optional[StrictStr], Field(description="Optional. sort=createdAt for ascending order or sort=-createdAt (leading minus sign) for descending order.")] = None,
1115
+ _request_timeout: Union[
1116
+ None,
1117
+ Annotated[StrictFloat, Field(gt=0)],
1118
+ Tuple[
1119
+ Annotated[StrictFloat, Field(gt=0)],
1120
+ Annotated[StrictFloat, Field(gt=0)]
1121
+ ]
1122
+ ] = None,
1123
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1124
+ _content_type: Optional[StrictStr] = None,
1125
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1126
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1127
+ ) -> RESTResponseType:
1128
+ """List customers
1129
+
1130
+ List customer resources. Paging can be applied.
1131
+
1132
+ :param page_limit: Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
1133
+ :type page_limit: str
1134
+ :param page_offset: Optional. Number of resources to skip. See Pagination.
1135
+ :type page_offset: str
1136
+ :param filter_query: Optional. Search term according to the Full-Text Search Rules.
1137
+ :type filter_query: str
1138
+ :param filter_email: Optional. Filter customers by email address (case sensitive).
1139
+ :type filter_email: str
1140
+ :param filter_tags: Optional. Filter Customers by Tags.
1141
+ :type filter_tags: str
1142
+ :param filter_status: Optional. Filter customers by status (Active, Archived). Usage example: *filter[status][0]=Active
1143
+ :type filter_status: str
1144
+ :param sort: Optional. sort=createdAt for ascending order or sort=-createdAt (leading minus sign) for descending order.
1145
+ :type sort: str
1146
+ :param _request_timeout: timeout setting for this request. If one
1147
+ number provided, it will be total request
1148
+ timeout. It can also be a pair (tuple) of
1149
+ (connection, read) timeouts.
1150
+ :type _request_timeout: int, tuple(int, int), optional
1151
+ :param _request_auth: set to override the auth_settings for an a single
1152
+ request; this effectively ignores the
1153
+ authentication in the spec for a single request.
1154
+ :type _request_auth: dict, optional
1155
+ :param _content_type: force content-type for the request.
1156
+ :type _content_type: str, Optional
1157
+ :param _headers: set to override the headers for a single
1158
+ request; this effectively ignores the headers
1159
+ in the spec for a single request.
1160
+ :type _headers: dict, optional
1161
+ :param _host_index: set to override the host_index for a single
1162
+ request; this effectively ignores the host_index
1163
+ in the spec for a single request.
1164
+ :type _host_index: int, optional
1165
+ :return: Returns the result object.
1166
+ """ # noqa: E501
1167
+
1168
+ _param = self._list_customers_serialize(
1169
+ page_limit=page_limit,
1170
+ page_offset=page_offset,
1171
+ filter_query=filter_query,
1172
+ filter_email=filter_email,
1173
+ filter_tags=filter_tags,
1174
+ filter_status=filter_status,
1175
+ sort=sort,
1176
+ _request_auth=_request_auth,
1177
+ _content_type=_content_type,
1178
+ _headers=_headers,
1179
+ _host_index=_host_index
1180
+ )
1181
+
1182
+ _response_types_map: Dict[str, Optional[str]] = {
1183
+ '200': "ListCustomers200Response",
1184
+ '400': "ErrorDocument",
1185
+ '401': "ErrorDocument",
1186
+ '404': "ErrorDocument",
1187
+ }
1188
+ response_data = self.api_client.call_api(
1189
+ *_param,
1190
+ _request_timeout=_request_timeout
1191
+ )
1192
+ return response_data.response
1193
+
1194
+
1195
+ def _list_customers_serialize(
1196
+ self,
1197
+ page_limit,
1198
+ page_offset,
1199
+ filter_query,
1200
+ filter_email,
1201
+ filter_tags,
1202
+ filter_status,
1203
+ sort,
1204
+ _request_auth,
1205
+ _content_type,
1206
+ _headers,
1207
+ _host_index,
1208
+ ) -> RequestSerialized:
1209
+
1210
+ _host = None
1211
+
1212
+ _collection_formats: Dict[str, str] = {
1213
+ }
1214
+
1215
+ _path_params: Dict[str, str] = {}
1216
+ _query_params: List[Tuple[str, str]] = []
1217
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1218
+ _form_params: List[Tuple[str, str]] = []
1219
+ _files: Dict[
1220
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1221
+ ] = {}
1222
+ _body_params: Optional[bytes] = None
1223
+
1224
+ # process the path parameters
1225
+ # process the query parameters
1226
+ if page_limit is not None:
1227
+
1228
+ _query_params.append(('page[limit]', page_limit))
1229
+
1230
+ if page_offset is not None:
1231
+
1232
+ _query_params.append(('page[offset]', page_offset))
1233
+
1234
+ if filter_query is not None:
1235
+
1236
+ _query_params.append(('filter[query]', filter_query))
1237
+
1238
+ if filter_email is not None:
1239
+
1240
+ _query_params.append(('filter[email]', filter_email))
1241
+
1242
+ if filter_tags is not None:
1243
+
1244
+ _query_params.append(('filter[tags]', filter_tags))
1245
+
1246
+ if filter_status is not None:
1247
+
1248
+ _query_params.append(('filter[status][]', filter_status))
1249
+
1250
+ if sort is not None:
1251
+
1252
+ _query_params.append(('sort', sort))
1253
+
1254
+ # process the header parameters
1255
+ # process the form parameters
1256
+ # process the body parameter
1257
+
1258
+
1259
+ # set the HTTP header `Accept`
1260
+ if 'Accept' not in _header_params:
1261
+ _header_params['Accept'] = self.api_client.select_header_accept(
1262
+ [
1263
+ 'application/vnd.api+json'
1264
+ ]
1265
+ )
1266
+
1267
+
1268
+ # authentication setting
1269
+ _auth_settings: List[str] = [
1270
+ 'bearerAuth'
1271
+ ]
1272
+
1273
+ return self.api_client.param_serialize(
1274
+ method='GET',
1275
+ resource_path='/customers',
1276
+ path_params=_path_params,
1277
+ query_params=_query_params,
1278
+ header_params=_header_params,
1279
+ body=_body_params,
1280
+ post_params=_form_params,
1281
+ files=_files,
1282
+ auth_settings=_auth_settings,
1283
+ collection_formats=_collection_formats,
1284
+ _host=_host,
1285
+ _request_auth=_request_auth
1286
+ )
1287
+
1288
+
1289
+
1290
+
1291
+ @validate_call
1292
+ def update_business_customer_officer(
1293
+ self,
1294
+ customer_id: StrictStr,
1295
+ officer_id: StrictStr,
1296
+ update_business_customer_officer_request: UpdateBusinessCustomerOfficerRequest,
1297
+ _request_timeout: Union[
1298
+ None,
1299
+ Annotated[StrictFloat, Field(gt=0)],
1300
+ Tuple[
1301
+ Annotated[StrictFloat, Field(gt=0)],
1302
+ Annotated[StrictFloat, Field(gt=0)]
1303
+ ]
1304
+ ] = None,
1305
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1306
+ _content_type: Optional[StrictStr] = None,
1307
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1308
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1309
+ ) -> UpdateBusinessCustomerOfficer200Response:
1310
+ """Update a business customer officer
1311
+
1312
+ Update an officer of a business customer.
1313
+
1314
+ :param customer_id: (required)
1315
+ :type customer_id: str
1316
+ :param officer_id: (required)
1317
+ :type officer_id: str
1318
+ :param update_business_customer_officer_request: (required)
1319
+ :type update_business_customer_officer_request: UpdateBusinessCustomerOfficerRequest
1320
+ :param _request_timeout: timeout setting for this request. If one
1321
+ number provided, it will be total request
1322
+ timeout. It can also be a pair (tuple) of
1323
+ (connection, read) timeouts.
1324
+ :type _request_timeout: int, tuple(int, int), optional
1325
+ :param _request_auth: set to override the auth_settings for an a single
1326
+ request; this effectively ignores the
1327
+ authentication in the spec for a single request.
1328
+ :type _request_auth: dict, optional
1329
+ :param _content_type: force content-type for the request.
1330
+ :type _content_type: str, Optional
1331
+ :param _headers: set to override the headers for a single
1332
+ request; this effectively ignores the headers
1333
+ in the spec for a single request.
1334
+ :type _headers: dict, optional
1335
+ :param _host_index: set to override the host_index for a single
1336
+ request; this effectively ignores the host_index
1337
+ in the spec for a single request.
1338
+ :type _host_index: int, optional
1339
+ :return: Returns the result object.
1340
+ """ # noqa: E501
1341
+
1342
+ _param = self._update_business_customer_officer_serialize(
1343
+ customer_id=customer_id,
1344
+ officer_id=officer_id,
1345
+ update_business_customer_officer_request=update_business_customer_officer_request,
1346
+ _request_auth=_request_auth,
1347
+ _content_type=_content_type,
1348
+ _headers=_headers,
1349
+ _host_index=_host_index
1350
+ )
1351
+
1352
+ _response_types_map: Dict[str, Optional[str]] = {
1353
+ '200': "UpdateBusinessCustomerOfficer200Response",
1354
+ '400': "ErrorDocument",
1355
+ '401': "ErrorDocument",
1356
+ '404': "ErrorDocument",
1357
+ }
1358
+ response_data = self.api_client.call_api(
1359
+ *_param,
1360
+ _request_timeout=_request_timeout
1361
+ )
1362
+ response_data.read()
1363
+ return self.api_client.response_deserialize(
1364
+ response_data=response_data,
1365
+ response_types_map=_response_types_map,
1366
+ ).data
1367
+
1368
+
1369
+ @validate_call
1370
+ def update_business_customer_officer_with_http_info(
1371
+ self,
1372
+ customer_id: StrictStr,
1373
+ officer_id: StrictStr,
1374
+ update_business_customer_officer_request: UpdateBusinessCustomerOfficerRequest,
1375
+ _request_timeout: Union[
1376
+ None,
1377
+ Annotated[StrictFloat, Field(gt=0)],
1378
+ Tuple[
1379
+ Annotated[StrictFloat, Field(gt=0)],
1380
+ Annotated[StrictFloat, Field(gt=0)]
1381
+ ]
1382
+ ] = None,
1383
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1384
+ _content_type: Optional[StrictStr] = None,
1385
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1386
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1387
+ ) -> ApiResponse[UpdateBusinessCustomerOfficer200Response]:
1388
+ """Update a business customer officer
1389
+
1390
+ Update an officer of a business customer.
1391
+
1392
+ :param customer_id: (required)
1393
+ :type customer_id: str
1394
+ :param officer_id: (required)
1395
+ :type officer_id: str
1396
+ :param update_business_customer_officer_request: (required)
1397
+ :type update_business_customer_officer_request: UpdateBusinessCustomerOfficerRequest
1398
+ :param _request_timeout: timeout setting for this request. If one
1399
+ number provided, it will be total request
1400
+ timeout. It can also be a pair (tuple) of
1401
+ (connection, read) timeouts.
1402
+ :type _request_timeout: int, tuple(int, int), optional
1403
+ :param _request_auth: set to override the auth_settings for an a single
1404
+ request; this effectively ignores the
1405
+ authentication in the spec for a single request.
1406
+ :type _request_auth: dict, optional
1407
+ :param _content_type: force content-type for the request.
1408
+ :type _content_type: str, Optional
1409
+ :param _headers: set to override the headers for a single
1410
+ request; this effectively ignores the headers
1411
+ in the spec for a single request.
1412
+ :type _headers: dict, optional
1413
+ :param _host_index: set to override the host_index for a single
1414
+ request; this effectively ignores the host_index
1415
+ in the spec for a single request.
1416
+ :type _host_index: int, optional
1417
+ :return: Returns the result object.
1418
+ """ # noqa: E501
1419
+
1420
+ _param = self._update_business_customer_officer_serialize(
1421
+ customer_id=customer_id,
1422
+ officer_id=officer_id,
1423
+ update_business_customer_officer_request=update_business_customer_officer_request,
1424
+ _request_auth=_request_auth,
1425
+ _content_type=_content_type,
1426
+ _headers=_headers,
1427
+ _host_index=_host_index
1428
+ )
1429
+
1430
+ _response_types_map: Dict[str, Optional[str]] = {
1431
+ '200': "UpdateBusinessCustomerOfficer200Response",
1432
+ '400': "ErrorDocument",
1433
+ '401': "ErrorDocument",
1434
+ '404': "ErrorDocument",
1435
+ }
1436
+ response_data = self.api_client.call_api(
1437
+ *_param,
1438
+ _request_timeout=_request_timeout
1439
+ )
1440
+ response_data.read()
1441
+ return self.api_client.response_deserialize(
1442
+ response_data=response_data,
1443
+ response_types_map=_response_types_map,
1444
+ )
1445
+
1446
+
1447
+ @validate_call
1448
+ def update_business_customer_officer_without_preload_content(
1449
+ self,
1450
+ customer_id: StrictStr,
1451
+ officer_id: StrictStr,
1452
+ update_business_customer_officer_request: UpdateBusinessCustomerOfficerRequest,
1453
+ _request_timeout: Union[
1454
+ None,
1455
+ Annotated[StrictFloat, Field(gt=0)],
1456
+ Tuple[
1457
+ Annotated[StrictFloat, Field(gt=0)],
1458
+ Annotated[StrictFloat, Field(gt=0)]
1459
+ ]
1460
+ ] = None,
1461
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1462
+ _content_type: Optional[StrictStr] = None,
1463
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1464
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1465
+ ) -> RESTResponseType:
1466
+ """Update a business customer officer
1467
+
1468
+ Update an officer of a business customer.
1469
+
1470
+ :param customer_id: (required)
1471
+ :type customer_id: str
1472
+ :param officer_id: (required)
1473
+ :type officer_id: str
1474
+ :param update_business_customer_officer_request: (required)
1475
+ :type update_business_customer_officer_request: UpdateBusinessCustomerOfficerRequest
1476
+ :param _request_timeout: timeout setting for this request. If one
1477
+ number provided, it will be total request
1478
+ timeout. It can also be a pair (tuple) of
1479
+ (connection, read) timeouts.
1480
+ :type _request_timeout: int, tuple(int, int), optional
1481
+ :param _request_auth: set to override the auth_settings for an a single
1482
+ request; this effectively ignores the
1483
+ authentication in the spec for a single request.
1484
+ :type _request_auth: dict, optional
1485
+ :param _content_type: force content-type for the request.
1486
+ :type _content_type: str, Optional
1487
+ :param _headers: set to override the headers for a single
1488
+ request; this effectively ignores the headers
1489
+ in the spec for a single request.
1490
+ :type _headers: dict, optional
1491
+ :param _host_index: set to override the host_index for a single
1492
+ request; this effectively ignores the host_index
1493
+ in the spec for a single request.
1494
+ :type _host_index: int, optional
1495
+ :return: Returns the result object.
1496
+ """ # noqa: E501
1497
+
1498
+ _param = self._update_business_customer_officer_serialize(
1499
+ customer_id=customer_id,
1500
+ officer_id=officer_id,
1501
+ update_business_customer_officer_request=update_business_customer_officer_request,
1502
+ _request_auth=_request_auth,
1503
+ _content_type=_content_type,
1504
+ _headers=_headers,
1505
+ _host_index=_host_index
1506
+ )
1507
+
1508
+ _response_types_map: Dict[str, Optional[str]] = {
1509
+ '200': "UpdateBusinessCustomerOfficer200Response",
1510
+ '400': "ErrorDocument",
1511
+ '401': "ErrorDocument",
1512
+ '404': "ErrorDocument",
1513
+ }
1514
+ response_data = self.api_client.call_api(
1515
+ *_param,
1516
+ _request_timeout=_request_timeout
1517
+ )
1518
+ return response_data.response
1519
+
1520
+
1521
+ def _update_business_customer_officer_serialize(
1522
+ self,
1523
+ customer_id,
1524
+ officer_id,
1525
+ update_business_customer_officer_request,
1526
+ _request_auth,
1527
+ _content_type,
1528
+ _headers,
1529
+ _host_index,
1530
+ ) -> RequestSerialized:
1531
+
1532
+ _host = None
1533
+
1534
+ _collection_formats: Dict[str, str] = {
1535
+ }
1536
+
1537
+ _path_params: Dict[str, str] = {}
1538
+ _query_params: List[Tuple[str, str]] = []
1539
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1540
+ _form_params: List[Tuple[str, str]] = []
1541
+ _files: Dict[
1542
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1543
+ ] = {}
1544
+ _body_params: Optional[bytes] = None
1545
+
1546
+ # process the path parameters
1547
+ if customer_id is not None:
1548
+ _path_params['customerId'] = customer_id
1549
+ if officer_id is not None:
1550
+ _path_params['officerId'] = officer_id
1551
+ # process the query parameters
1552
+ # process the header parameters
1553
+ # process the form parameters
1554
+ # process the body parameter
1555
+ if update_business_customer_officer_request is not None:
1556
+ _body_params = update_business_customer_officer_request
1557
+
1558
+
1559
+ # set the HTTP header `Accept`
1560
+ if 'Accept' not in _header_params:
1561
+ _header_params['Accept'] = self.api_client.select_header_accept(
1562
+ [
1563
+ 'application/vnd.api+json'
1564
+ ]
1565
+ )
1566
+
1567
+ # set the HTTP header `Content-Type`
1568
+ if _content_type:
1569
+ _header_params['Content-Type'] = _content_type
1570
+ else:
1571
+ _default_content_type = (
1572
+ self.api_client.select_header_content_type(
1573
+ [
1574
+ 'application/vnd.api+json'
1575
+ ]
1576
+ )
1577
+ )
1578
+ if _default_content_type is not None:
1579
+ _header_params['Content-Type'] = _default_content_type
1580
+
1581
+ # authentication setting
1582
+ _auth_settings: List[str] = [
1583
+ 'bearerAuth'
1584
+ ]
1585
+
1586
+ return self.api_client.param_serialize(
1587
+ method='PATCH',
1588
+ resource_path='/customers/{customerId}/officers/{officerId}',
1589
+ path_params=_path_params,
1590
+ query_params=_query_params,
1591
+ header_params=_header_params,
1592
+ body=_body_params,
1593
+ post_params=_form_params,
1594
+ files=_files,
1595
+ auth_settings=_auth_settings,
1596
+ collection_formats=_collection_formats,
1597
+ _host=_host,
1598
+ _request_auth=_request_auth
1599
+ )
1600
+
1601
+
1602
+
1603
+
1604
+ @validate_call
1605
+ def update_customer(
1606
+ self,
1607
+ customer_id: StrictStr,
1608
+ update_customer_request: UpdateCustomerRequest,
1609
+ _request_timeout: Union[
1610
+ None,
1611
+ Annotated[StrictFloat, Field(gt=0)],
1612
+ Tuple[
1613
+ Annotated[StrictFloat, Field(gt=0)],
1614
+ Annotated[StrictFloat, Field(gt=0)]
1615
+ ]
1616
+ ] = None,
1617
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1618
+ _content_type: Optional[StrictStr] = None,
1619
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1620
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1621
+ ) -> UpdateCustomer200Response:
1622
+ """Update a customer
1623
+
1624
+ Update a customer. The Customer Updated webhook event will be fired. Variants: - **UpdateBusinessCustomer** - **UpdateIndividualCustomer**
1625
+
1626
+ :param customer_id: (required)
1627
+ :type customer_id: str
1628
+ :param update_customer_request: (required)
1629
+ :type update_customer_request: UpdateCustomerRequest
1630
+ :param _request_timeout: timeout setting for this request. If one
1631
+ number provided, it will be total request
1632
+ timeout. It can also be a pair (tuple) of
1633
+ (connection, read) timeouts.
1634
+ :type _request_timeout: int, tuple(int, int), optional
1635
+ :param _request_auth: set to override the auth_settings for an a single
1636
+ request; this effectively ignores the
1637
+ authentication in the spec for a single request.
1638
+ :type _request_auth: dict, optional
1639
+ :param _content_type: force content-type for the request.
1640
+ :type _content_type: str, Optional
1641
+ :param _headers: set to override the headers for a single
1642
+ request; this effectively ignores the headers
1643
+ in the spec for a single request.
1644
+ :type _headers: dict, optional
1645
+ :param _host_index: set to override the host_index for a single
1646
+ request; this effectively ignores the host_index
1647
+ in the spec for a single request.
1648
+ :type _host_index: int, optional
1649
+ :return: Returns the result object.
1650
+ """ # noqa: E501
1651
+
1652
+ _param = self._update_customer_serialize(
1653
+ customer_id=customer_id,
1654
+ update_customer_request=update_customer_request,
1655
+ _request_auth=_request_auth,
1656
+ _content_type=_content_type,
1657
+ _headers=_headers,
1658
+ _host_index=_host_index
1659
+ )
1660
+
1661
+ _response_types_map: Dict[str, Optional[str]] = {
1662
+ '200': "UpdateCustomer200Response",
1663
+ '400': "ErrorDocument",
1664
+ '401': "ErrorDocument",
1665
+ '404': "ErrorDocument",
1666
+ }
1667
+ response_data = self.api_client.call_api(
1668
+ *_param,
1669
+ _request_timeout=_request_timeout
1670
+ )
1671
+ response_data.read()
1672
+ return self.api_client.response_deserialize(
1673
+ response_data=response_data,
1674
+ response_types_map=_response_types_map,
1675
+ ).data
1676
+
1677
+
1678
+ @validate_call
1679
+ def update_customer_with_http_info(
1680
+ self,
1681
+ customer_id: StrictStr,
1682
+ update_customer_request: UpdateCustomerRequest,
1683
+ _request_timeout: Union[
1684
+ None,
1685
+ Annotated[StrictFloat, Field(gt=0)],
1686
+ Tuple[
1687
+ Annotated[StrictFloat, Field(gt=0)],
1688
+ Annotated[StrictFloat, Field(gt=0)]
1689
+ ]
1690
+ ] = None,
1691
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1692
+ _content_type: Optional[StrictStr] = None,
1693
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1694
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1695
+ ) -> ApiResponse[UpdateCustomer200Response]:
1696
+ """Update a customer
1697
+
1698
+ Update a customer. The Customer Updated webhook event will be fired. Variants: - **UpdateBusinessCustomer** - **UpdateIndividualCustomer**
1699
+
1700
+ :param customer_id: (required)
1701
+ :type customer_id: str
1702
+ :param update_customer_request: (required)
1703
+ :type update_customer_request: UpdateCustomerRequest
1704
+ :param _request_timeout: timeout setting for this request. If one
1705
+ number provided, it will be total request
1706
+ timeout. It can also be a pair (tuple) of
1707
+ (connection, read) timeouts.
1708
+ :type _request_timeout: int, tuple(int, int), optional
1709
+ :param _request_auth: set to override the auth_settings for an a single
1710
+ request; this effectively ignores the
1711
+ authentication in the spec for a single request.
1712
+ :type _request_auth: dict, optional
1713
+ :param _content_type: force content-type for the request.
1714
+ :type _content_type: str, Optional
1715
+ :param _headers: set to override the headers for a single
1716
+ request; this effectively ignores the headers
1717
+ in the spec for a single request.
1718
+ :type _headers: dict, optional
1719
+ :param _host_index: set to override the host_index for a single
1720
+ request; this effectively ignores the host_index
1721
+ in the spec for a single request.
1722
+ :type _host_index: int, optional
1723
+ :return: Returns the result object.
1724
+ """ # noqa: E501
1725
+
1726
+ _param = self._update_customer_serialize(
1727
+ customer_id=customer_id,
1728
+ update_customer_request=update_customer_request,
1729
+ _request_auth=_request_auth,
1730
+ _content_type=_content_type,
1731
+ _headers=_headers,
1732
+ _host_index=_host_index
1733
+ )
1734
+
1735
+ _response_types_map: Dict[str, Optional[str]] = {
1736
+ '200': "UpdateCustomer200Response",
1737
+ '400': "ErrorDocument",
1738
+ '401': "ErrorDocument",
1739
+ '404': "ErrorDocument",
1740
+ }
1741
+ response_data = self.api_client.call_api(
1742
+ *_param,
1743
+ _request_timeout=_request_timeout
1744
+ )
1745
+ response_data.read()
1746
+ return self.api_client.response_deserialize(
1747
+ response_data=response_data,
1748
+ response_types_map=_response_types_map,
1749
+ )
1750
+
1751
+
1752
+ @validate_call
1753
+ def update_customer_without_preload_content(
1754
+ self,
1755
+ customer_id: StrictStr,
1756
+ update_customer_request: UpdateCustomerRequest,
1757
+ _request_timeout: Union[
1758
+ None,
1759
+ Annotated[StrictFloat, Field(gt=0)],
1760
+ Tuple[
1761
+ Annotated[StrictFloat, Field(gt=0)],
1762
+ Annotated[StrictFloat, Field(gt=0)]
1763
+ ]
1764
+ ] = None,
1765
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1766
+ _content_type: Optional[StrictStr] = None,
1767
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1768
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1769
+ ) -> RESTResponseType:
1770
+ """Update a customer
1771
+
1772
+ Update a customer. The Customer Updated webhook event will be fired. Variants: - **UpdateBusinessCustomer** - **UpdateIndividualCustomer**
1773
+
1774
+ :param customer_id: (required)
1775
+ :type customer_id: str
1776
+ :param update_customer_request: (required)
1777
+ :type update_customer_request: UpdateCustomerRequest
1778
+ :param _request_timeout: timeout setting for this request. If one
1779
+ number provided, it will be total request
1780
+ timeout. It can also be a pair (tuple) of
1781
+ (connection, read) timeouts.
1782
+ :type _request_timeout: int, tuple(int, int), optional
1783
+ :param _request_auth: set to override the auth_settings for an a single
1784
+ request; this effectively ignores the
1785
+ authentication in the spec for a single request.
1786
+ :type _request_auth: dict, optional
1787
+ :param _content_type: force content-type for the request.
1788
+ :type _content_type: str, Optional
1789
+ :param _headers: set to override the headers for a single
1790
+ request; this effectively ignores the headers
1791
+ in the spec for a single request.
1792
+ :type _headers: dict, optional
1793
+ :param _host_index: set to override the host_index for a single
1794
+ request; this effectively ignores the host_index
1795
+ in the spec for a single request.
1796
+ :type _host_index: int, optional
1797
+ :return: Returns the result object.
1798
+ """ # noqa: E501
1799
+
1800
+ _param = self._update_customer_serialize(
1801
+ customer_id=customer_id,
1802
+ update_customer_request=update_customer_request,
1803
+ _request_auth=_request_auth,
1804
+ _content_type=_content_type,
1805
+ _headers=_headers,
1806
+ _host_index=_host_index
1807
+ )
1808
+
1809
+ _response_types_map: Dict[str, Optional[str]] = {
1810
+ '200': "UpdateCustomer200Response",
1811
+ '400': "ErrorDocument",
1812
+ '401': "ErrorDocument",
1813
+ '404': "ErrorDocument",
1814
+ }
1815
+ response_data = self.api_client.call_api(
1816
+ *_param,
1817
+ _request_timeout=_request_timeout
1818
+ )
1819
+ return response_data.response
1820
+
1821
+
1822
+ def _update_customer_serialize(
1823
+ self,
1824
+ customer_id,
1825
+ update_customer_request,
1826
+ _request_auth,
1827
+ _content_type,
1828
+ _headers,
1829
+ _host_index,
1830
+ ) -> RequestSerialized:
1831
+
1832
+ _host = None
1833
+
1834
+ _collection_formats: Dict[str, str] = {
1835
+ }
1836
+
1837
+ _path_params: Dict[str, str] = {}
1838
+ _query_params: List[Tuple[str, str]] = []
1839
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1840
+ _form_params: List[Tuple[str, str]] = []
1841
+ _files: Dict[
1842
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1843
+ ] = {}
1844
+ _body_params: Optional[bytes] = None
1845
+
1846
+ # process the path parameters
1847
+ if customer_id is not None:
1848
+ _path_params['customerId'] = customer_id
1849
+ # process the query parameters
1850
+ # process the header parameters
1851
+ # process the form parameters
1852
+ # process the body parameter
1853
+ if update_customer_request is not None:
1854
+ _body_params = update_customer_request
1855
+
1856
+
1857
+ # set the HTTP header `Accept`
1858
+ if 'Accept' not in _header_params:
1859
+ _header_params['Accept'] = self.api_client.select_header_accept(
1860
+ [
1861
+ 'application/vnd.api+json'
1862
+ ]
1863
+ )
1864
+
1865
+ # set the HTTP header `Content-Type`
1866
+ if _content_type:
1867
+ _header_params['Content-Type'] = _content_type
1868
+ else:
1869
+ _default_content_type = (
1870
+ self.api_client.select_header_content_type(
1871
+ [
1872
+ 'application/vnd.api+json'
1873
+ ]
1874
+ )
1875
+ )
1876
+ if _default_content_type is not None:
1877
+ _header_params['Content-Type'] = _default_content_type
1878
+
1879
+ # authentication setting
1880
+ _auth_settings: List[str] = [
1881
+ 'bearerAuth'
1882
+ ]
1883
+
1884
+ return self.api_client.param_serialize(
1885
+ method='PATCH',
1886
+ resource_path='/customers/{customerId}',
1887
+ path_params=_path_params,
1888
+ query_params=_query_params,
1889
+ header_params=_header_params,
1890
+ body=_body_params,
1891
+ post_params=_form_params,
1892
+ files=_files,
1893
+ auth_settings=_auth_settings,
1894
+ collection_formats=_collection_formats,
1895
+ _host=_host,
1896
+ _request_auth=_request_auth
1897
+ )
1898
+
1899
+