checkbook 1.0.1

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 (459) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +324 -0
  4. data/Rakefile +10 -0
  5. data/checkbook.gemspec +39 -0
  6. data/docs/Approval.md +669 -0
  7. data/docs/Bank.md +645 -0
  8. data/docs/Card.md +290 -0
  9. data/docs/Checkbook.md +370 -0
  10. data/docs/Directory.md +520 -0
  11. data/docs/Interac.md +290 -0
  12. data/docs/Invoice.md +452 -0
  13. data/docs/Mailbox.md +454 -0
  14. data/docs/Payment.md +1247 -0
  15. data/docs/Paypal.md +290 -0
  16. data/docs/Subscription.md +453 -0
  17. data/docs/User.md +722 -0
  18. data/docs/Vcc.md +448 -0
  19. data/docs/Venmo.md +290 -0
  20. data/docs/Wallet.md +292 -0
  21. data/docs/Wire.md +290 -0
  22. data/lib/checkbook/api/approval.rb +662 -0
  23. data/lib/checkbook/api/bank.rb +613 -0
  24. data/lib/checkbook/api/card.rb +284 -0
  25. data/lib/checkbook/api/checkbook.rb +357 -0
  26. data/lib/checkbook/api/directory.rb +522 -0
  27. data/lib/checkbook/api/interac.rb +284 -0
  28. data/lib/checkbook/api/invoice.rb +452 -0
  29. data/lib/checkbook/api/mailbox.rb +441 -0
  30. data/lib/checkbook/api/payment.rb +1188 -0
  31. data/lib/checkbook/api/paypal.rb +284 -0
  32. data/lib/checkbook/api/subscription.rb +463 -0
  33. data/lib/checkbook/api/user.rb +687 -0
  34. data/lib/checkbook/api/vcc.rb +439 -0
  35. data/lib/checkbook/api/venmo.rb +284 -0
  36. data/lib/checkbook/api/wallet.rb +284 -0
  37. data/lib/checkbook/api/wire.rb +284 -0
  38. data/lib/checkbook/api_client.rb +404 -0
  39. data/lib/checkbook/api_error.rb +58 -0
  40. data/lib/checkbook/api_model_base.rb +88 -0
  41. data/lib/checkbook/configuration.rb +316 -0
  42. data/lib/checkbook/models/address.rb +266 -0
  43. data/lib/checkbook/models/address_response.rb +316 -0
  44. data/lib/checkbook/models/api_key_list_response.rb +241 -0
  45. data/lib/checkbook/models/api_key_response.rb +315 -0
  46. data/lib/checkbook/models/approval.rb +445 -0
  47. data/lib/checkbook/models/approval_number.rb +104 -0
  48. data/lib/checkbook/models/approval_recipient.rb +105 -0
  49. data/lib/checkbook/models/attachment.rb +283 -0
  50. data/lib/checkbook/models/bank.rb +475 -0
  51. data/lib/checkbook/models/bank_release_request.rb +238 -0
  52. data/lib/checkbook/models/bank_settings.rb +232 -0
  53. data/lib/checkbook/models/bank_verify_request.rb +311 -0
  54. data/lib/checkbook/models/base_checkbook_request.rb +328 -0
  55. data/lib/checkbook/models/brand.rb +297 -0
  56. data/lib/checkbook/models/brand_response.rb +255 -0
  57. data/lib/checkbook/models/button.rb +221 -0
  58. data/lib/checkbook/models/card.rb +357 -0
  59. data/lib/checkbook/models/card_address.rb +377 -0
  60. data/lib/checkbook/models/check.rb +445 -0
  61. data/lib/checkbook/models/check_address.rb +407 -0
  62. data/lib/checkbook/models/check_response.rb +238 -0
  63. data/lib/checkbook/models/check_settings.rb +230 -0
  64. data/lib/checkbook/models/checkbook_address.rb +442 -0
  65. data/lib/checkbook/models/color.rb +232 -0
  66. data/lib/checkbook/models/convert_check_request.rb +264 -0
  67. data/lib/checkbook/models/counterparty.rb +264 -0
  68. data/lib/checkbook/models/create_bank_request.rb +342 -0
  69. data/lib/checkbook/models/create_bank_response.rb +475 -0
  70. data/lib/checkbook/models/create_card_intent.rb +313 -0
  71. data/lib/checkbook/models/create_card_intent_response.rb +221 -0
  72. data/lib/checkbook/models/create_card_request.rb +284 -0
  73. data/lib/checkbook/models/create_card_response.rb +332 -0
  74. data/lib/checkbook/models/create_check_subscription_request.rb +476 -0
  75. data/lib/checkbook/models/create_check_subscription_request_recipient.rb +104 -0
  76. data/lib/checkbook/models/create_digital_check_request.rb +470 -0
  77. data/lib/checkbook/models/create_digital_check_request_attachment.rb +104 -0
  78. data/lib/checkbook/models/create_digital_check_request_number.rb +105 -0
  79. data/lib/checkbook/models/create_digital_check_request_recipient.rb +104 -0
  80. data/lib/checkbook/models/create_direct_check_request.rb +554 -0
  81. data/lib/checkbook/models/create_direct_check_request_number.rb +104 -0
  82. data/lib/checkbook/models/create_directory_bank_request.rb +342 -0
  83. data/lib/checkbook/models/create_directory_bank_response.rb +329 -0
  84. data/lib/checkbook/models/create_directory_card_request.rb +300 -0
  85. data/lib/checkbook/models/create_directory_card_response.rb +329 -0
  86. data/lib/checkbook/models/create_directory_request.rb +291 -0
  87. data/lib/checkbook/models/create_directory_response.rb +314 -0
  88. data/lib/checkbook/models/create_instant_check_request.rb +487 -0
  89. data/lib/checkbook/models/create_interac_request.rb +247 -0
  90. data/lib/checkbook/models/create_invoice_request.rb +393 -0
  91. data/lib/checkbook/models/create_invoice_request_attachment.rb +104 -0
  92. data/lib/checkbook/models/create_invoice_response.rb +399 -0
  93. data/lib/checkbook/models/create_invoice_subscription_request.rb +471 -0
  94. data/lib/checkbook/models/create_mailbox_response.rb +301 -0
  95. data/lib/checkbook/models/create_multi_check_request.rb +432 -0
  96. data/lib/checkbook/models/create_paypal_request.rb +247 -0
  97. data/lib/checkbook/models/create_physical_check_request.rb +446 -0
  98. data/lib/checkbook/models/create_physical_check_request_number.rb +105 -0
  99. data/lib/checkbook/models/create_physical_check_request_remittance_advice.rb +104 -0
  100. data/lib/checkbook/models/create_subscription_response.rb +454 -0
  101. data/lib/checkbook/models/create_subscription_response_recipient.rb +104 -0
  102. data/lib/checkbook/models/create_user_request.rb +302 -0
  103. data/lib/checkbook/models/create_user_response.rb +304 -0
  104. data/lib/checkbook/models/create_vcc_request.rb +242 -0
  105. data/lib/checkbook/models/create_vcc_response.rb +302 -0
  106. data/lib/checkbook/models/create_venmo_request.rb +247 -0
  107. data/lib/checkbook/models/create_wallet_request.rb +282 -0
  108. data/lib/checkbook/models/create_wallet_response.rb +285 -0
  109. data/lib/checkbook/models/create_wire_request.rb +342 -0
  110. data/lib/checkbook/models/csv_approval_response.rb +240 -0
  111. data/lib/checkbook/models/csv_check_request.rb +313 -0
  112. data/lib/checkbook/models/csv_check_response.rb +240 -0
  113. data/lib/checkbook/models/csv_invoice_request.rb +268 -0
  114. data/lib/checkbook/models/csv_invoice_response.rb +240 -0
  115. data/lib/checkbook/models/csv_multi_check_request.rb +268 -0
  116. data/lib/checkbook/models/deposit_check_request.rb +238 -0
  117. data/lib/checkbook/models/developer.rb +238 -0
  118. data/lib/checkbook/models/digital_recipient.rb +257 -0
  119. data/lib/checkbook/models/directory_account.rb +329 -0
  120. data/lib/checkbook/models/directory_address.rb +277 -0
  121. data/lib/checkbook/models/directory_request_address.rb +392 -0
  122. data/lib/checkbook/models/endorse_check_request.rb +267 -0
  123. data/lib/checkbook/models/error.rb +246 -0
  124. data/lib/checkbook/models/file_row.rb +362 -0
  125. data/lib/checkbook/models/get_api_key_response.rb +253 -0
  126. data/lib/checkbook/models/get_approval_response.rb +434 -0
  127. data/lib/checkbook/models/get_approvals_response.rb +318 -0
  128. data/lib/checkbook/models/get_banks_response.rb +240 -0
  129. data/lib/checkbook/models/get_cards_response.rb +240 -0
  130. data/lib/checkbook/models/get_check_deposited_response.rb +246 -0
  131. data/lib/checkbook/models/get_check_failed_response.rb +224 -0
  132. data/lib/checkbook/models/get_check_response.rb +434 -0
  133. data/lib/checkbook/models/get_check_tracking_response_express.rb +240 -0
  134. data/lib/checkbook/models/get_check_tracking_response_first_class.rb +240 -0
  135. data/lib/checkbook/models/get_checkbook_response.rb +325 -0
  136. data/lib/checkbook/models/get_checkbook_tracking_response_express.rb +240 -0
  137. data/lib/checkbook/models/get_checkbook_tracking_response_first_class.rb +240 -0
  138. data/lib/checkbook/models/get_checkbooks_response.rb +318 -0
  139. data/lib/checkbook/models/get_checks_response.rb +318 -0
  140. data/lib/checkbook/models/get_directories_response.rb +270 -0
  141. data/lib/checkbook/models/get_institutions_response.rb +240 -0
  142. data/lib/checkbook/models/get_interac_response.rb +240 -0
  143. data/lib/checkbook/models/get_invoice_response.rb +468 -0
  144. data/lib/checkbook/models/get_invoices_response.rb +318 -0
  145. data/lib/checkbook/models/get_mail_response.rb +318 -0
  146. data/lib/checkbook/models/get_mailboxes_response.rb +318 -0
  147. data/lib/checkbook/models/get_paypal_response.rb +240 -0
  148. data/lib/checkbook/models/get_subscription_response.rb +522 -0
  149. data/lib/checkbook/models/get_subscriptions_response.rb +318 -0
  150. data/lib/checkbook/models/get_user_response.rb +239 -0
  151. data/lib/checkbook/models/get_vcc_response.rb +393 -0
  152. data/lib/checkbook/models/get_venmo_response.rb +240 -0
  153. data/lib/checkbook/models/get_wallets_response.rb +240 -0
  154. data/lib/checkbook/models/get_wire_response.rb +240 -0
  155. data/lib/checkbook/models/iav_account.rb +276 -0
  156. data/lib/checkbook/models/iav_login_response.rb +245 -0
  157. data/lib/checkbook/models/iav_login_schema.rb +238 -0
  158. data/lib/checkbook/models/iav_plaid_request.rb +238 -0
  159. data/lib/checkbook/models/iav_plaid_response.rb +223 -0
  160. data/lib/checkbook/models/iavmfa_schema.rb +249 -0
  161. data/lib/checkbook/models/inline_response200.rb +222 -0
  162. data/lib/checkbook/models/institution.rb +277 -0
  163. data/lib/checkbook/models/interac_account_response.rb +276 -0
  164. data/lib/checkbook/models/invoice_attachment.rb +283 -0
  165. data/lib/checkbook/models/invoice_file_row.rb +374 -0
  166. data/lib/checkbook/models/login_field.rb +277 -0
  167. data/lib/checkbook/models/mail_response.rb +367 -0
  168. data/lib/checkbook/models/mailbox_address.rb +285 -0
  169. data/lib/checkbook/models/merchant.rb +447 -0
  170. data/lib/checkbook/models/merchant_response.rb +318 -0
  171. data/lib/checkbook/models/merchant_response_address.rb +278 -0
  172. data/lib/checkbook/models/mfa_option.rb +273 -0
  173. data/lib/checkbook/models/mfa_response_field.rb +298 -0
  174. data/lib/checkbook/models/mfa_selection_field.rb +231 -0
  175. data/lib/checkbook/models/multi_file_row.rb +431 -0
  176. data/lib/checkbook/models/multi_recipient.rb +312 -0
  177. data/lib/checkbook/models/new_api_key_request.rb +233 -0
  178. data/lib/checkbook/models/new_api_key_response.rb +263 -0
  179. data/lib/checkbook/models/number.rb +231 -0
  180. data/lib/checkbook/models/number140416527981344.rb +231 -0
  181. data/lib/checkbook/models/numbers.rb +238 -0
  182. data/lib/checkbook/models/numbers140416527982288.rb +238 -0
  183. data/lib/checkbook/models/options.rb +256 -0
  184. data/lib/checkbook/models/parsed_address.rb +271 -0
  185. data/lib/checkbook/models/parsed_address_address.rb +104 -0
  186. data/lib/checkbook/models/pay_invoice_request.rb +284 -0
  187. data/lib/checkbook/models/pay_invoice_response.rb +346 -0
  188. data/lib/checkbook/models/payment.rb +247 -0
  189. data/lib/checkbook/models/paypal_account_response.rb +276 -0
  190. data/lib/checkbook/models/physical_check_recipient.rb +442 -0
  191. data/lib/checkbook/models/pin.rb +283 -0
  192. data/lib/checkbook/models/plaid_account.rb +276 -0
  193. data/lib/checkbook/models/post_bank_iav_request.rb +104 -0
  194. data/lib/checkbook/models/preview_check_request.rb +337 -0
  195. data/lib/checkbook/models/preview_check_request_number.rb +104 -0
  196. data/lib/checkbook/models/preview_check_response.rb +238 -0
  197. data/lib/checkbook/models/provision_vcc_request.rb +348 -0
  198. data/lib/checkbook/models/provision_vcc_response.rb +292 -0
  199. data/lib/checkbook/models/register_user_request.rb +417 -0
  200. data/lib/checkbook/models/release_check_request.rb +238 -0
  201. data/lib/checkbook/models/remittance_advice.rb +296 -0
  202. data/lib/checkbook/models/signature_request.rb +239 -0
  203. data/lib/checkbook/models/subscription_address.rb +407 -0
  204. data/lib/checkbook/models/tracking_event.rb +249 -0
  205. data/lib/checkbook/models/tracking_number.rb +249 -0
  206. data/lib/checkbook/models/trigger_user_webhook_request.rb +262 -0
  207. data/lib/checkbook/models/trigger_webhook_request.rb +271 -0
  208. data/lib/checkbook/models/update_approval_request.rb +329 -0
  209. data/lib/checkbook/models/update_bank_request.rb +257 -0
  210. data/lib/checkbook/models/update_card_request.rb +247 -0
  211. data/lib/checkbook/models/update_check_request.rb +263 -0
  212. data/lib/checkbook/models/update_directory_address.rb +337 -0
  213. data/lib/checkbook/models/update_directory_request.rb +281 -0
  214. data/lib/checkbook/models/update_interac_request.rb +237 -0
  215. data/lib/checkbook/models/update_merchant_address.rb +377 -0
  216. data/lib/checkbook/models/update_paypal_request.rb +237 -0
  217. data/lib/checkbook/models/update_principal_address.rb +377 -0
  218. data/lib/checkbook/models/update_subscription_request.rb +233 -0
  219. data/lib/checkbook/models/update_user_request.rb +266 -0
  220. data/lib/checkbook/models/update_vcc_request.rb +242 -0
  221. data/lib/checkbook/models/update_venmo_request.rb +237 -0
  222. data/lib/checkbook/models/update_wallet_request.rb +237 -0
  223. data/lib/checkbook/models/update_wire_request.rb +237 -0
  224. data/lib/checkbook/models/user.rb +477 -0
  225. data/lib/checkbook/models/user_query_response.rb +271 -0
  226. data/lib/checkbook/models/user_response.rb +355 -0
  227. data/lib/checkbook/models/user_response_query.rb +320 -0
  228. data/lib/checkbook/models/validate_address_request.rb +240 -0
  229. data/lib/checkbook/models/validate_address_response.rb +240 -0
  230. data/lib/checkbook/models/vcc.rb +404 -0
  231. data/lib/checkbook/models/vcc_address.rb +266 -0
  232. data/lib/checkbook/models/vcc_query_response.rb +240 -0
  233. data/lib/checkbook/models/vcc_transaction.rb +285 -0
  234. data/lib/checkbook/models/vcc_transactions_response.rb +270 -0
  235. data/lib/checkbook/models/venmo_account_response.rb +276 -0
  236. data/lib/checkbook/models/verify_check_request.rb +238 -0
  237. data/lib/checkbook/models/verify_check_response.rb +221 -0
  238. data/lib/checkbook/models/verify_user_request.rb +273 -0
  239. data/lib/checkbook/models/wallet.rb +296 -0
  240. data/lib/checkbook/models/wire_account_response.rb +330 -0
  241. data/lib/checkbook/version.rb +15 -0
  242. data/lib/checkbook.rb +255 -0
  243. data/spec/api/approval_spec.rb +151 -0
  244. data/spec/api/bank_spec.rb +142 -0
  245. data/spec/api/card_spec.rb +83 -0
  246. data/spec/api/checkbook_spec.rb +97 -0
  247. data/spec/api/directory_spec.rb +125 -0
  248. data/spec/api/interac_spec.rb +83 -0
  249. data/spec/api/invoice_spec.rb +114 -0
  250. data/spec/api/mailbox_spec.rb +114 -0
  251. data/spec/api/payment_spec.rb +249 -0
  252. data/spec/api/paypal_spec.rb +83 -0
  253. data/spec/api/subscription_spec.rb +115 -0
  254. data/spec/api/user_spec.rb +156 -0
  255. data/spec/api/vcc_spec.rb +113 -0
  256. data/spec/api/venmo_spec.rb +83 -0
  257. data/spec/api/wallet_spec.rb +83 -0
  258. data/spec/api/wire_spec.rb +83 -0
  259. data/spec/models/address_response_spec.rb +54 -0
  260. data/spec/models/address_spec.rb +66 -0
  261. data/spec/models/api_key_list_response_spec.rb +36 -0
  262. data/spec/models/api_key_response_spec.rb +60 -0
  263. data/spec/models/approval_number_spec.rb +32 -0
  264. data/spec/models/approval_recipient_spec.rb +32 -0
  265. data/spec/models/approval_spec.rb +110 -0
  266. data/spec/models/attachment_spec.rb +42 -0
  267. data/spec/models/bank_release_request_spec.rb +36 -0
  268. data/spec/models/bank_settings_spec.rb +42 -0
  269. data/spec/models/bank_spec.rb +98 -0
  270. data/spec/models/bank_verify_request_spec.rb +48 -0
  271. data/spec/models/base_checkbook_request_spec.rb +58 -0
  272. data/spec/models/brand_response_spec.rb +54 -0
  273. data/spec/models/brand_spec.rb +66 -0
  274. data/spec/models/button_spec.rb +36 -0
  275. data/spec/models/card_address_spec.rb +66 -0
  276. data/spec/models/card_spec.rb +66 -0
  277. data/spec/models/check_address_spec.rb +66 -0
  278. data/spec/models/check_response_spec.rb +36 -0
  279. data/spec/models/check_settings_spec.rb +42 -0
  280. data/spec/models/check_spec.rb +110 -0
  281. data/spec/models/checkbook_address_spec.rb +72 -0
  282. data/spec/models/color_spec.rb +42 -0
  283. data/spec/models/convert_check_request_spec.rb +42 -0
  284. data/spec/models/counterparty_spec.rb +42 -0
  285. data/spec/models/create_bank_request_spec.rb +58 -0
  286. data/spec/models/create_bank_response_spec.rb +98 -0
  287. data/spec/models/create_card_intent_response_spec.rb +36 -0
  288. data/spec/models/create_card_intent_spec.rb +58 -0
  289. data/spec/models/create_card_request_spec.rb +54 -0
  290. data/spec/models/create_card_response_spec.rb +60 -0
  291. data/spec/models/create_check_subscription_request_recipient_spec.rb +32 -0
  292. data/spec/models/create_check_subscription_request_spec.rb +88 -0
  293. data/spec/models/create_digital_check_request_attachment_spec.rb +32 -0
  294. data/spec/models/create_digital_check_request_number_spec.rb +32 -0
  295. data/spec/models/create_digital_check_request_recipient_spec.rb +32 -0
  296. data/spec/models/create_digital_check_request_spec.rb +100 -0
  297. data/spec/models/create_direct_check_request_number_spec.rb +32 -0
  298. data/spec/models/create_direct_check_request_spec.rb +116 -0
  299. data/spec/models/create_directory_bank_request_spec.rb +58 -0
  300. data/spec/models/create_directory_bank_response_spec.rb +58 -0
  301. data/spec/models/create_directory_card_request_spec.rb +48 -0
  302. data/spec/models/create_directory_card_response_spec.rb +58 -0
  303. data/spec/models/create_directory_request_spec.rb +48 -0
  304. data/spec/models/create_directory_response_spec.rb +60 -0
  305. data/spec/models/create_instant_check_request_spec.rb +96 -0
  306. data/spec/models/create_interac_request_spec.rb +36 -0
  307. data/spec/models/create_invoice_request_attachment_spec.rb +32 -0
  308. data/spec/models/create_invoice_request_spec.rb +72 -0
  309. data/spec/models/create_invoice_response_spec.rb +78 -0
  310. data/spec/models/create_invoice_subscription_request_spec.rb +82 -0
  311. data/spec/models/create_mailbox_response_spec.rb +54 -0
  312. data/spec/models/create_multi_check_request_spec.rb +88 -0
  313. data/spec/models/create_paypal_request_spec.rb +36 -0
  314. data/spec/models/create_physical_check_request_number_spec.rb +32 -0
  315. data/spec/models/create_physical_check_request_remittance_advice_spec.rb +32 -0
  316. data/spec/models/create_physical_check_request_spec.rb +94 -0
  317. data/spec/models/create_subscription_response_recipient_spec.rb +32 -0
  318. data/spec/models/create_subscription_response_spec.rb +104 -0
  319. data/spec/models/create_user_request_spec.rb +42 -0
  320. data/spec/models/create_user_response_spec.rb +54 -0
  321. data/spec/models/create_vcc_request_spec.rb +48 -0
  322. data/spec/models/create_vcc_response_spec.rb +54 -0
  323. data/spec/models/create_venmo_request_spec.rb +36 -0
  324. data/spec/models/create_wallet_request_spec.rb +46 -0
  325. data/spec/models/create_wallet_response_spec.rb +54 -0
  326. data/spec/models/create_wire_request_spec.rb +58 -0
  327. data/spec/models/csv_approval_response_spec.rb +36 -0
  328. data/spec/models/csv_check_request_spec.rb +52 -0
  329. data/spec/models/csv_check_response_spec.rb +36 -0
  330. data/spec/models/csv_invoice_request_spec.rb +42 -0
  331. data/spec/models/csv_invoice_response_spec.rb +36 -0
  332. data/spec/models/csv_multi_check_request_spec.rb +42 -0
  333. data/spec/models/deposit_check_request_spec.rb +36 -0
  334. data/spec/models/developer_spec.rb +36 -0
  335. data/spec/models/digital_recipient_spec.rb +42 -0
  336. data/spec/models/directory_account_spec.rb +58 -0
  337. data/spec/models/directory_address_spec.rb +66 -0
  338. data/spec/models/directory_request_address_spec.rb +66 -0
  339. data/spec/models/endorse_check_request_spec.rb +42 -0
  340. data/spec/models/error_spec.rb +42 -0
  341. data/spec/models/file_row_spec.rb +72 -0
  342. data/spec/models/get_api_key_response_spec.rb +54 -0
  343. data/spec/models/get_approval_response_spec.rb +100 -0
  344. data/spec/models/get_approvals_response_spec.rb +54 -0
  345. data/spec/models/get_banks_response_spec.rb +36 -0
  346. data/spec/models/get_cards_response_spec.rb +36 -0
  347. data/spec/models/get_check_deposited_response_spec.rb +48 -0
  348. data/spec/models/get_check_failed_response_spec.rb +36 -0
  349. data/spec/models/get_check_response_spec.rb +100 -0
  350. data/spec/models/get_check_tracking_response_express_spec.rb +36 -0
  351. data/spec/models/get_check_tracking_response_first_class_spec.rb +36 -0
  352. data/spec/models/get_checkbook_response_spec.rb +58 -0
  353. data/spec/models/get_checkbook_tracking_response_express_spec.rb +36 -0
  354. data/spec/models/get_checkbook_tracking_response_first_class_spec.rb +36 -0
  355. data/spec/models/get_checkbooks_response_spec.rb +54 -0
  356. data/spec/models/get_checks_response_spec.rb +54 -0
  357. data/spec/models/get_directories_response_spec.rb +54 -0
  358. data/spec/models/get_institutions_response_spec.rb +36 -0
  359. data/spec/models/get_interac_response_spec.rb +36 -0
  360. data/spec/models/get_invoice_response_spec.rb +100 -0
  361. data/spec/models/get_invoices_response_spec.rb +54 -0
  362. data/spec/models/get_mail_response_spec.rb +54 -0
  363. data/spec/models/get_mailboxes_response_spec.rb +54 -0
  364. data/spec/models/get_paypal_response_spec.rb +36 -0
  365. data/spec/models/get_subscription_response_spec.rb +126 -0
  366. data/spec/models/get_subscriptions_response_spec.rb +54 -0
  367. data/spec/models/get_user_response_spec.rb +48 -0
  368. data/spec/models/get_vcc_response_spec.rb +78 -0
  369. data/spec/models/get_venmo_response_spec.rb +36 -0
  370. data/spec/models/get_wallets_response_spec.rb +36 -0
  371. data/spec/models/get_wire_response_spec.rb +36 -0
  372. data/spec/models/iav_account_spec.rb +48 -0
  373. data/spec/models/iav_login_response_spec.rb +48 -0
  374. data/spec/models/iav_login_schema_spec.rb +36 -0
  375. data/spec/models/iav_plaid_request_spec.rb +36 -0
  376. data/spec/models/iav_plaid_response_spec.rb +36 -0
  377. data/spec/models/iavmfa_schema_spec.rb +42 -0
  378. data/spec/models/inline_response200_spec.rb +36 -0
  379. data/spec/models/institution_spec.rb +48 -0
  380. data/spec/models/interac_account_response_spec.rb +48 -0
  381. data/spec/models/invoice_attachment_spec.rb +42 -0
  382. data/spec/models/invoice_file_row_spec.rb +60 -0
  383. data/spec/models/login_field_spec.rb +52 -0
  384. data/spec/models/mail_response_spec.rb +72 -0
  385. data/spec/models/mailbox_address_spec.rb +66 -0
  386. data/spec/models/merchant_response_address_spec.rb +66 -0
  387. data/spec/models/merchant_response_spec.rb +90 -0
  388. data/spec/models/merchant_spec.rb +98 -0
  389. data/spec/models/mfa_option_spec.rb +52 -0
  390. data/spec/models/mfa_response_field_spec.rb +64 -0
  391. data/spec/models/mfa_selection_field_spec.rb +42 -0
  392. data/spec/models/multi_file_row_spec.rb +72 -0
  393. data/spec/models/multi_recipient_spec.rb +54 -0
  394. data/spec/models/new_api_key_request_spec.rb +42 -0
  395. data/spec/models/new_api_key_response_spec.rb +60 -0
  396. data/spec/models/number140416527981344_spec.rb +42 -0
  397. data/spec/models/number_spec.rb +42 -0
  398. data/spec/models/numbers140416527982288_spec.rb +48 -0
  399. data/spec/models/numbers_spec.rb +48 -0
  400. data/spec/models/options_spec.rb +40 -0
  401. data/spec/models/parsed_address_address_spec.rb +32 -0
  402. data/spec/models/parsed_address_spec.rb +46 -0
  403. data/spec/models/pay_invoice_request_spec.rb +48 -0
  404. data/spec/models/pay_invoice_response_spec.rb +60 -0
  405. data/spec/models/payment_spec.rb +36 -0
  406. data/spec/models/paypal_account_response_spec.rb +48 -0
  407. data/spec/models/physical_check_recipient_spec.rb +72 -0
  408. data/spec/models/pin_spec.rb +42 -0
  409. data/spec/models/plaid_account_spec.rb +48 -0
  410. data/spec/models/post_bank_iav_request_spec.rb +32 -0
  411. data/spec/models/preview_check_request_number_spec.rb +32 -0
  412. data/spec/models/preview_check_request_spec.rb +60 -0
  413. data/spec/models/preview_check_response_spec.rb +36 -0
  414. data/spec/models/provision_vcc_request_spec.rb +58 -0
  415. data/spec/models/provision_vcc_response_spec.rb +48 -0
  416. data/spec/models/register_user_request_spec.rb +66 -0
  417. data/spec/models/release_check_request_spec.rb +36 -0
  418. data/spec/models/remittance_advice_spec.rb +54 -0
  419. data/spec/models/signature_request_spec.rb +36 -0
  420. data/spec/models/subscription_address_spec.rb +66 -0
  421. data/spec/models/tracking_event_spec.rb +42 -0
  422. data/spec/models/tracking_number_spec.rb +42 -0
  423. data/spec/models/trigger_user_webhook_request_spec.rb +40 -0
  424. data/spec/models/trigger_webhook_request_spec.rb +46 -0
  425. data/spec/models/update_approval_request_spec.rb +66 -0
  426. data/spec/models/update_bank_request_spec.rb +48 -0
  427. data/spec/models/update_card_request_spec.rb +42 -0
  428. data/spec/models/update_check_request_spec.rb +42 -0
  429. data/spec/models/update_directory_address_spec.rb +66 -0
  430. data/spec/models/update_directory_request_spec.rb +48 -0
  431. data/spec/models/update_interac_request_spec.rb +36 -0
  432. data/spec/models/update_merchant_address_spec.rb +66 -0
  433. data/spec/models/update_paypal_request_spec.rb +36 -0
  434. data/spec/models/update_principal_address_spec.rb +66 -0
  435. data/spec/models/update_subscription_request_spec.rb +42 -0
  436. data/spec/models/update_user_request_spec.rb +66 -0
  437. data/spec/models/update_vcc_request_spec.rb +48 -0
  438. data/spec/models/update_venmo_request_spec.rb +36 -0
  439. data/spec/models/update_wallet_request_spec.rb +36 -0
  440. data/spec/models/update_wire_request_spec.rb +36 -0
  441. data/spec/models/user_query_response_spec.rb +54 -0
  442. data/spec/models/user_response_query_spec.rb +54 -0
  443. data/spec/models/user_response_spec.rb +94 -0
  444. data/spec/models/user_spec.rb +84 -0
  445. data/spec/models/validate_address_request_spec.rb +36 -0
  446. data/spec/models/validate_address_response_spec.rb +36 -0
  447. data/spec/models/vcc_address_spec.rb +60 -0
  448. data/spec/models/vcc_query_response_spec.rb +36 -0
  449. data/spec/models/vcc_spec.rb +84 -0
  450. data/spec/models/vcc_transaction_spec.rb +72 -0
  451. data/spec/models/vcc_transactions_response_spec.rb +54 -0
  452. data/spec/models/venmo_account_response_spec.rb +48 -0
  453. data/spec/models/verify_check_request_spec.rb +36 -0
  454. data/spec/models/verify_check_response_spec.rb +36 -0
  455. data/spec/models/verify_user_request_spec.rb +46 -0
  456. data/spec/models/wallet_spec.rb +60 -0
  457. data/spec/models/wire_account_response_spec.rb +60 -0
  458. data/spec/spec_helper.rb +111 -0
  459. metadata +759 -0
@@ -0,0 +1,662 @@
1
+ =begin
2
+ #Checkbook API
3
+
4
+ #The Checkbook API enables businesses to programmatically send and receive payments using digital checks and other payment methods. With Checkbook, you can automate payment workflows, disburse funds instantly, and manage transactions securely—all without the delays and costs of traditional paper checks.
5
+
6
+ The version of the OpenAPI document: 3.0.0
7
+ Contact: support@checkbook.io
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.16.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Checkbook
16
+ class Approval
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Remove payment approval
23
+ # Cancel the specified check approval
24
+ # @param approval_id [String]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [nil]
27
+ def delete_approval_check(approval_id, opts = {})
28
+ delete_approval_check_with_http_info(approval_id, opts)
29
+ nil
30
+ end
31
+
32
+ # Remove payment approval
33
+ # Cancel the specified check approval
34
+ # @param approval_id [String]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
37
+ def delete_approval_check_with_http_info(approval_id, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: Approval.delete_approval_check ...'
40
+ end
41
+ # verify the required parameter 'approval_id' is set
42
+ if @api_client.config.client_side_validation && approval_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'approval_id' when calling Approval.delete_approval_check"
44
+ end
45
+ # resource path
46
+ local_var_path = '/v3/approval/{approval_id}'.sub('{' + 'approval_id' + '}', CGI.escape(approval_id.to_s))
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
55
+
56
+ # form parameters
57
+ form_params = opts[:form_params] || {}
58
+
59
+ # http body (model)
60
+ post_body = opts[:debug_body]
61
+
62
+ # return_type
63
+ return_type = opts[:debug_return_type]
64
+
65
+ # auth_names
66
+ auth_names = opts[:debug_auth_names] || ['token']
67
+
68
+ new_options = opts.merge(
69
+ :operation => :"Approval.delete_approval_check",
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => return_type
76
+ )
77
+
78
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
79
+ if @api_client.config.debugging
80
+ @api_client.config.logger.debug "API called: Approval#delete_approval_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
+ end
82
+ return data, status_code, headers
83
+ end
84
+
85
+ # Get attachment for payment approval
86
+ # Get the attachment for a payment approval
87
+ # @param approval_id [String]
88
+ # @param [Hash] opts the optional parameters
89
+ # @return [File]
90
+ def get_approval_attachment(approval_id, opts = {})
91
+ data, _status_code, _headers = get_approval_attachment_with_http_info(approval_id, opts)
92
+ data
93
+ end
94
+
95
+ # Get attachment for payment approval
96
+ # Get the attachment for a payment approval
97
+ # @param approval_id [String]
98
+ # @param [Hash] opts the optional parameters
99
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
100
+ def get_approval_attachment_with_http_info(approval_id, opts = {})
101
+ if @api_client.config.debugging
102
+ @api_client.config.logger.debug 'Calling API: Approval.get_approval_attachment ...'
103
+ end
104
+ # verify the required parameter 'approval_id' is set
105
+ if @api_client.config.client_side_validation && approval_id.nil?
106
+ fail ArgumentError, "Missing the required parameter 'approval_id' when calling Approval.get_approval_attachment"
107
+ end
108
+ # resource path
109
+ local_var_path = '/v3/approval/{approval_id}/attachment'.sub('{' + 'approval_id' + '}', CGI.escape(approval_id.to_s))
110
+
111
+ # query parameters
112
+ query_params = opts[:query_params] || {}
113
+
114
+ # header parameters
115
+ header_params = opts[:header_params] || {}
116
+ # HTTP header 'Accept' (if needed)
117
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json']) unless header_params['Accept']
118
+
119
+ # form parameters
120
+ form_params = opts[:form_params] || {}
121
+
122
+ # http body (model)
123
+ post_body = opts[:debug_body]
124
+
125
+ # return_type
126
+ return_type = opts[:debug_return_type] || 'File'
127
+
128
+ # auth_names
129
+ auth_names = opts[:debug_auth_names] || ['token']
130
+
131
+ new_options = opts.merge(
132
+ :operation => :"Approval.get_approval_attachment",
133
+ :header_params => header_params,
134
+ :query_params => query_params,
135
+ :form_params => form_params,
136
+ :body => post_body,
137
+ :auth_names => auth_names,
138
+ :return_type => return_type
139
+ )
140
+
141
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
142
+ if @api_client.config.debugging
143
+ @api_client.config.logger.debug "API called: Approval#get_approval_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
144
+ end
145
+ return data, status_code, headers
146
+ end
147
+
148
+ # Get payment approval
149
+ # Get the specified payment approval
150
+ # @param approval_id [String]
151
+ # @param [Hash] opts the optional parameters
152
+ # @return [GetApprovalResponse]
153
+ def get_approval_check(approval_id, opts = {})
154
+ data, _status_code, _headers = get_approval_check_with_http_info(approval_id, opts)
155
+ data
156
+ end
157
+
158
+ # Get payment approval
159
+ # Get the specified payment approval
160
+ # @param approval_id [String]
161
+ # @param [Hash] opts the optional parameters
162
+ # @return [Array<(GetApprovalResponse, Integer, Hash)>] GetApprovalResponse data, response status code and response headers
163
+ def get_approval_check_with_http_info(approval_id, opts = {})
164
+ if @api_client.config.debugging
165
+ @api_client.config.logger.debug 'Calling API: Approval.get_approval_check ...'
166
+ end
167
+ # verify the required parameter 'approval_id' is set
168
+ if @api_client.config.client_side_validation && approval_id.nil?
169
+ fail ArgumentError, "Missing the required parameter 'approval_id' when calling Approval.get_approval_check"
170
+ end
171
+ # resource path
172
+ local_var_path = '/v3/approval/{approval_id}'.sub('{' + 'approval_id' + '}', CGI.escape(approval_id.to_s))
173
+
174
+ # query parameters
175
+ query_params = opts[:query_params] || {}
176
+
177
+ # header parameters
178
+ header_params = opts[:header_params] || {}
179
+ # HTTP header 'Accept' (if needed)
180
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
181
+
182
+ # form parameters
183
+ form_params = opts[:form_params] || {}
184
+
185
+ # http body (model)
186
+ post_body = opts[:debug_body]
187
+
188
+ # return_type
189
+ return_type = opts[:debug_return_type] || 'GetApprovalResponse'
190
+
191
+ # auth_names
192
+ auth_names = opts[:debug_auth_names] || ['token']
193
+
194
+ new_options = opts.merge(
195
+ :operation => :"Approval.get_approval_check",
196
+ :header_params => header_params,
197
+ :query_params => query_params,
198
+ :form_params => form_params,
199
+ :body => post_body,
200
+ :auth_names => auth_names,
201
+ :return_type => return_type
202
+ )
203
+
204
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
205
+ if @api_client.config.debugging
206
+ @api_client.config.logger.debug "API called: Approval#get_approval_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
207
+ end
208
+ return data, status_code, headers
209
+ end
210
+
211
+ # Get approval payments
212
+ # Return approvals
213
+ # @param [Hash] opts the optional parameters
214
+ # @option opts [String] :direction Direction
215
+ # @option opts [Date] :end_date End date
216
+ # @option opts [Integer] :page Page number (default to 1)
217
+ # @option opts [Integer] :per_page Items per page (default to 50)
218
+ # @option opts [String] :q Query
219
+ # @option opts [String] :sort Sort
220
+ # @option opts [Date] :start_date Start date
221
+ # @option opts [String] :status Status
222
+ # @return [GetApprovalsResponse]
223
+ def get_approval_checks(opts = {})
224
+ data, _status_code, _headers = get_approval_checks_with_http_info(opts)
225
+ data
226
+ end
227
+
228
+ # Get approval payments
229
+ # Return approvals
230
+ # @param [Hash] opts the optional parameters
231
+ # @option opts [String] :direction Direction
232
+ # @option opts [Date] :end_date End date
233
+ # @option opts [Integer] :page Page number (default to 1)
234
+ # @option opts [Integer] :per_page Items per page (default to 50)
235
+ # @option opts [String] :q Query
236
+ # @option opts [String] :sort Sort
237
+ # @option opts [Date] :start_date Start date
238
+ # @option opts [String] :status Status
239
+ # @return [Array<(GetApprovalsResponse, Integer, Hash)>] GetApprovalsResponse data, response status code and response headers
240
+ def get_approval_checks_with_http_info(opts = {})
241
+ if @api_client.config.debugging
242
+ @api_client.config.logger.debug 'Calling API: Approval.get_approval_checks ...'
243
+ end
244
+ allowable_values = ["INCOMING", "OUTGOING"]
245
+ if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
246
+ fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
247
+ end
248
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
249
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling Approval.get_approval_checks, must be greater than or equal to 1.'
250
+ end
251
+
252
+ allowable_values = [10, 25, 50, 100, 250]
253
+ if @api_client.config.client_side_validation && opts[:'per_page'] && !allowable_values.include?(opts[:'per_page'])
254
+ fail ArgumentError, "invalid value for \"per_page\", must be one of #{allowable_values}"
255
+ end
256
+ if @api_client.config.client_side_validation && !opts[:'q'].nil? && opts[:'q'].to_s.length > 180
257
+ fail ArgumentError, 'invalid value for "opts[:"q"]" when calling Approval.get_approval_checks, the character length must be smaller than or equal to 180.'
258
+ end
259
+
260
+ allowable_values = ["+NUMBER", "-NUMBER", "+TYPE", "-TYPE", "+AMOUNT", "-AMOUNT", "+STATUS", "-STATUS", "+DATE", "-DATE", "+UPDATE", "-UPDATE", "+DESCRIPTION", "-DESCRIPTION"]
261
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
262
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
263
+ end
264
+ allowable_values = ["PAID", "IN_PROCESS", "UNPAID", "VOID", "EXPIRED", "PRINTED", "MAILED", "FAILED", "REFUNDED"]
265
+ if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
266
+ fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
267
+ end
268
+ # resource path
269
+ local_var_path = '/v3/approval'
270
+
271
+ # query parameters
272
+ query_params = opts[:query_params] || {}
273
+ query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
274
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
275
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
276
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
277
+ query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
278
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
279
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
280
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
281
+
282
+ # header parameters
283
+ header_params = opts[:header_params] || {}
284
+ # HTTP header 'Accept' (if needed)
285
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
286
+
287
+ # form parameters
288
+ form_params = opts[:form_params] || {}
289
+
290
+ # http body (model)
291
+ post_body = opts[:debug_body]
292
+
293
+ # return_type
294
+ return_type = opts[:debug_return_type] || 'GetApprovalsResponse'
295
+
296
+ # auth_names
297
+ auth_names = opts[:debug_auth_names] || ['token']
298
+
299
+ new_options = opts.merge(
300
+ :operation => :"Approval.get_approval_checks",
301
+ :header_params => header_params,
302
+ :query_params => query_params,
303
+ :form_params => form_params,
304
+ :body => post_body,
305
+ :auth_names => auth_names,
306
+ :return_type => return_type
307
+ )
308
+
309
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
310
+ if @api_client.config.debugging
311
+ @api_client.config.logger.debug "API called: Approval#get_approval_checks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
312
+ end
313
+ return data, status_code, headers
314
+ end
315
+
316
+ # Create approval digital payment
317
+ # Create a new approval digital payment
318
+ # @param create_digital_check_request [CreateDigitalCheckRequest]
319
+ # @param [Hash] opts the optional parameters
320
+ # @return [GetApprovalResponse]
321
+ def post_approval_digital(create_digital_check_request, opts = {})
322
+ data, _status_code, _headers = post_approval_digital_with_http_info(create_digital_check_request, opts)
323
+ data
324
+ end
325
+
326
+ # Create approval digital payment
327
+ # Create a new approval digital payment
328
+ # @param create_digital_check_request [CreateDigitalCheckRequest]
329
+ # @param [Hash] opts the optional parameters
330
+ # @return [Array<(GetApprovalResponse, Integer, Hash)>] GetApprovalResponse data, response status code and response headers
331
+ def post_approval_digital_with_http_info(create_digital_check_request, opts = {})
332
+ if @api_client.config.debugging
333
+ @api_client.config.logger.debug 'Calling API: Approval.post_approval_digital ...'
334
+ end
335
+ # verify the required parameter 'create_digital_check_request' is set
336
+ if @api_client.config.client_side_validation && create_digital_check_request.nil?
337
+ fail ArgumentError, "Missing the required parameter 'create_digital_check_request' when calling Approval.post_approval_digital"
338
+ end
339
+ # resource path
340
+ local_var_path = '/v3/approval/digital'
341
+
342
+ # query parameters
343
+ query_params = opts[:query_params] || {}
344
+
345
+ # header parameters
346
+ header_params = opts[:header_params] || {}
347
+ # HTTP header 'Accept' (if needed)
348
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
349
+ # HTTP header 'Content-Type'
350
+ content_type = @api_client.select_header_content_type(['application/json'])
351
+ if !content_type.nil?
352
+ header_params['Content-Type'] = content_type
353
+ end
354
+
355
+ # form parameters
356
+ form_params = opts[:form_params] || {}
357
+
358
+ # http body (model)
359
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_digital_check_request)
360
+
361
+ # return_type
362
+ return_type = opts[:debug_return_type] || 'GetApprovalResponse'
363
+
364
+ # auth_names
365
+ auth_names = opts[:debug_auth_names] || ['token']
366
+
367
+ new_options = opts.merge(
368
+ :operation => :"Approval.post_approval_digital",
369
+ :header_params => header_params,
370
+ :query_params => query_params,
371
+ :form_params => form_params,
372
+ :body => post_body,
373
+ :auth_names => auth_names,
374
+ :return_type => return_type
375
+ )
376
+
377
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
378
+ if @api_client.config.debugging
379
+ @api_client.config.logger.debug "API called: Approval#post_approval_digital\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
380
+ end
381
+ return data, status_code, headers
382
+ end
383
+
384
+ # Create multi-party payment approval
385
+ # Create a new multi-party payment approval
386
+ # @param create_multi_check_request [CreateMultiCheckRequest]
387
+ # @param [Hash] opts the optional parameters
388
+ # @return [GetApprovalResponse]
389
+ def post_approval_multi(create_multi_check_request, opts = {})
390
+ data, _status_code, _headers = post_approval_multi_with_http_info(create_multi_check_request, opts)
391
+ data
392
+ end
393
+
394
+ # Create multi-party payment approval
395
+ # Create a new multi-party payment approval
396
+ # @param create_multi_check_request [CreateMultiCheckRequest]
397
+ # @param [Hash] opts the optional parameters
398
+ # @return [Array<(GetApprovalResponse, Integer, Hash)>] GetApprovalResponse data, response status code and response headers
399
+ def post_approval_multi_with_http_info(create_multi_check_request, opts = {})
400
+ if @api_client.config.debugging
401
+ @api_client.config.logger.debug 'Calling API: Approval.post_approval_multi ...'
402
+ end
403
+ # verify the required parameter 'create_multi_check_request' is set
404
+ if @api_client.config.client_side_validation && create_multi_check_request.nil?
405
+ fail ArgumentError, "Missing the required parameter 'create_multi_check_request' when calling Approval.post_approval_multi"
406
+ end
407
+ # resource path
408
+ local_var_path = '/v3/approval/multi'
409
+
410
+ # query parameters
411
+ query_params = opts[:query_params] || {}
412
+
413
+ # header parameters
414
+ header_params = opts[:header_params] || {}
415
+ # HTTP header 'Accept' (if needed)
416
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
417
+ # HTTP header 'Content-Type'
418
+ content_type = @api_client.select_header_content_type(['application/json'])
419
+ if !content_type.nil?
420
+ header_params['Content-Type'] = content_type
421
+ end
422
+
423
+ # form parameters
424
+ form_params = opts[:form_params] || {}
425
+
426
+ # http body (model)
427
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_multi_check_request)
428
+
429
+ # return_type
430
+ return_type = opts[:debug_return_type] || 'GetApprovalResponse'
431
+
432
+ # auth_names
433
+ auth_names = opts[:debug_auth_names] || ['token']
434
+
435
+ new_options = opts.merge(
436
+ :operation => :"Approval.post_approval_multi",
437
+ :header_params => header_params,
438
+ :query_params => query_params,
439
+ :form_params => form_params,
440
+ :body => post_body,
441
+ :auth_names => auth_names,
442
+ :return_type => return_type
443
+ )
444
+
445
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
446
+ if @api_client.config.debugging
447
+ @api_client.config.logger.debug "API called: Approval#post_approval_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
448
+ end
449
+ return data, status_code, headers
450
+ end
451
+
452
+ # Create physical check approval
453
+ # Create a new physical check approval
454
+ # @param create_physical_check_request [CreatePhysicalCheckRequest]
455
+ # @param [Hash] opts the optional parameters
456
+ # @return [GetApprovalResponse]
457
+ def post_approval_physical(create_physical_check_request, opts = {})
458
+ data, _status_code, _headers = post_approval_physical_with_http_info(create_physical_check_request, opts)
459
+ data
460
+ end
461
+
462
+ # Create physical check approval
463
+ # Create a new physical check approval
464
+ # @param create_physical_check_request [CreatePhysicalCheckRequest]
465
+ # @param [Hash] opts the optional parameters
466
+ # @return [Array<(GetApprovalResponse, Integer, Hash)>] GetApprovalResponse data, response status code and response headers
467
+ def post_approval_physical_with_http_info(create_physical_check_request, opts = {})
468
+ if @api_client.config.debugging
469
+ @api_client.config.logger.debug 'Calling API: Approval.post_approval_physical ...'
470
+ end
471
+ # verify the required parameter 'create_physical_check_request' is set
472
+ if @api_client.config.client_side_validation && create_physical_check_request.nil?
473
+ fail ArgumentError, "Missing the required parameter 'create_physical_check_request' when calling Approval.post_approval_physical"
474
+ end
475
+ # resource path
476
+ local_var_path = '/v3/approval/physical'
477
+
478
+ # query parameters
479
+ query_params = opts[:query_params] || {}
480
+
481
+ # header parameters
482
+ header_params = opts[:header_params] || {}
483
+ # HTTP header 'Accept' (if needed)
484
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
485
+ # HTTP header 'Content-Type'
486
+ content_type = @api_client.select_header_content_type(['application/json'])
487
+ if !content_type.nil?
488
+ header_params['Content-Type'] = content_type
489
+ end
490
+
491
+ # form parameters
492
+ form_params = opts[:form_params] || {}
493
+
494
+ # http body (model)
495
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_physical_check_request)
496
+
497
+ # return_type
498
+ return_type = opts[:debug_return_type] || 'GetApprovalResponse'
499
+
500
+ # auth_names
501
+ auth_names = opts[:debug_auth_names] || ['token']
502
+
503
+ new_options = opts.merge(
504
+ :operation => :"Approval.post_approval_physical",
505
+ :header_params => header_params,
506
+ :query_params => query_params,
507
+ :form_params => form_params,
508
+ :body => post_body,
509
+ :auth_names => auth_names,
510
+ :return_type => return_type
511
+ )
512
+
513
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
514
+ if @api_client.config.debugging
515
+ @api_client.config.logger.debug "API called: Approval#post_approval_physical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
516
+ end
517
+ return data, status_code, headers
518
+ end
519
+
520
+ # Approve payment
521
+ # Create a live payment from an approval
522
+ # @param release_check_request [ReleaseCheckRequest]
523
+ # @param [Hash] opts the optional parameters
524
+ # @return [GetCheckResponse]
525
+ def post_approval_release(release_check_request, opts = {})
526
+ data, _status_code, _headers = post_approval_release_with_http_info(release_check_request, opts)
527
+ data
528
+ end
529
+
530
+ # Approve payment
531
+ # Create a live payment from an approval
532
+ # @param release_check_request [ReleaseCheckRequest]
533
+ # @param [Hash] opts the optional parameters
534
+ # @return [Array<(GetCheckResponse, Integer, Hash)>] GetCheckResponse data, response status code and response headers
535
+ def post_approval_release_with_http_info(release_check_request, opts = {})
536
+ if @api_client.config.debugging
537
+ @api_client.config.logger.debug 'Calling API: Approval.post_approval_release ...'
538
+ end
539
+ # verify the required parameter 'release_check_request' is set
540
+ if @api_client.config.client_side_validation && release_check_request.nil?
541
+ fail ArgumentError, "Missing the required parameter 'release_check_request' when calling Approval.post_approval_release"
542
+ end
543
+ # resource path
544
+ local_var_path = '/v3/approval/release'
545
+
546
+ # query parameters
547
+ query_params = opts[:query_params] || {}
548
+
549
+ # header parameters
550
+ header_params = opts[:header_params] || {}
551
+ # HTTP header 'Accept' (if needed)
552
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
553
+ # HTTP header 'Content-Type'
554
+ content_type = @api_client.select_header_content_type(['application/json'])
555
+ if !content_type.nil?
556
+ header_params['Content-Type'] = content_type
557
+ end
558
+
559
+ # form parameters
560
+ form_params = opts[:form_params] || {}
561
+
562
+ # http body (model)
563
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(release_check_request)
564
+
565
+ # return_type
566
+ return_type = opts[:debug_return_type] || 'GetCheckResponse'
567
+
568
+ # auth_names
569
+ auth_names = opts[:debug_auth_names] || ['token']
570
+
571
+ new_options = opts.merge(
572
+ :operation => :"Approval.post_approval_release",
573
+ :header_params => header_params,
574
+ :query_params => query_params,
575
+ :form_params => form_params,
576
+ :body => post_body,
577
+ :auth_names => auth_names,
578
+ :return_type => return_type
579
+ )
580
+
581
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
582
+ if @api_client.config.debugging
583
+ @api_client.config.logger.debug "API called: Approval#post_approval_release\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
584
+ end
585
+ return data, status_code, headers
586
+ end
587
+
588
+ # Update payment approval
589
+ # Update the specified payment approval
590
+ # @param approval_id [String]
591
+ # @param update_approval_request [UpdateApprovalRequest]
592
+ # @param [Hash] opts the optional parameters
593
+ # @return [nil]
594
+ def put_approval_check(approval_id, update_approval_request, opts = {})
595
+ put_approval_check_with_http_info(approval_id, update_approval_request, opts)
596
+ nil
597
+ end
598
+
599
+ # Update payment approval
600
+ # Update the specified payment approval
601
+ # @param approval_id [String]
602
+ # @param update_approval_request [UpdateApprovalRequest]
603
+ # @param [Hash] opts the optional parameters
604
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
605
+ def put_approval_check_with_http_info(approval_id, update_approval_request, opts = {})
606
+ if @api_client.config.debugging
607
+ @api_client.config.logger.debug 'Calling API: Approval.put_approval_check ...'
608
+ end
609
+ # verify the required parameter 'approval_id' is set
610
+ if @api_client.config.client_side_validation && approval_id.nil?
611
+ fail ArgumentError, "Missing the required parameter 'approval_id' when calling Approval.put_approval_check"
612
+ end
613
+ # verify the required parameter 'update_approval_request' is set
614
+ if @api_client.config.client_side_validation && update_approval_request.nil?
615
+ fail ArgumentError, "Missing the required parameter 'update_approval_request' when calling Approval.put_approval_check"
616
+ end
617
+ # resource path
618
+ local_var_path = '/v3/approval/{approval_id}'.sub('{' + 'approval_id' + '}', CGI.escape(approval_id.to_s))
619
+
620
+ # query parameters
621
+ query_params = opts[:query_params] || {}
622
+
623
+ # header parameters
624
+ header_params = opts[:header_params] || {}
625
+ # HTTP header 'Accept' (if needed)
626
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
627
+ # HTTP header 'Content-Type'
628
+ content_type = @api_client.select_header_content_type(['application/json'])
629
+ if !content_type.nil?
630
+ header_params['Content-Type'] = content_type
631
+ end
632
+
633
+ # form parameters
634
+ form_params = opts[:form_params] || {}
635
+
636
+ # http body (model)
637
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_approval_request)
638
+
639
+ # return_type
640
+ return_type = opts[:debug_return_type]
641
+
642
+ # auth_names
643
+ auth_names = opts[:debug_auth_names] || ['token']
644
+
645
+ new_options = opts.merge(
646
+ :operation => :"Approval.put_approval_check",
647
+ :header_params => header_params,
648
+ :query_params => query_params,
649
+ :form_params => form_params,
650
+ :body => post_body,
651
+ :auth_names => auth_names,
652
+ :return_type => return_type
653
+ )
654
+
655
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
656
+ if @api_client.config.debugging
657
+ @api_client.config.logger.debug "API called: Approval#put_approval_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
658
+ end
659
+ return data, status_code, headers
660
+ end
661
+ end
662
+ end