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.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +324 -0
- data/Rakefile +10 -0
- data/checkbook.gemspec +39 -0
- data/docs/Approval.md +669 -0
- data/docs/Bank.md +645 -0
- data/docs/Card.md +290 -0
- data/docs/Checkbook.md +370 -0
- data/docs/Directory.md +520 -0
- data/docs/Interac.md +290 -0
- data/docs/Invoice.md +452 -0
- data/docs/Mailbox.md +454 -0
- data/docs/Payment.md +1247 -0
- data/docs/Paypal.md +290 -0
- data/docs/Subscription.md +453 -0
- data/docs/User.md +722 -0
- data/docs/Vcc.md +448 -0
- data/docs/Venmo.md +290 -0
- data/docs/Wallet.md +292 -0
- data/docs/Wire.md +290 -0
- data/lib/checkbook/api/approval.rb +662 -0
- data/lib/checkbook/api/bank.rb +613 -0
- data/lib/checkbook/api/card.rb +284 -0
- data/lib/checkbook/api/checkbook.rb +357 -0
- data/lib/checkbook/api/directory.rb +522 -0
- data/lib/checkbook/api/interac.rb +284 -0
- data/lib/checkbook/api/invoice.rb +452 -0
- data/lib/checkbook/api/mailbox.rb +441 -0
- data/lib/checkbook/api/payment.rb +1188 -0
- data/lib/checkbook/api/paypal.rb +284 -0
- data/lib/checkbook/api/subscription.rb +463 -0
- data/lib/checkbook/api/user.rb +687 -0
- data/lib/checkbook/api/vcc.rb +439 -0
- data/lib/checkbook/api/venmo.rb +284 -0
- data/lib/checkbook/api/wallet.rb +284 -0
- data/lib/checkbook/api/wire.rb +284 -0
- data/lib/checkbook/api_client.rb +404 -0
- data/lib/checkbook/api_error.rb +58 -0
- data/lib/checkbook/api_model_base.rb +88 -0
- data/lib/checkbook/configuration.rb +316 -0
- data/lib/checkbook/models/address.rb +266 -0
- data/lib/checkbook/models/address_response.rb +316 -0
- data/lib/checkbook/models/api_key_list_response.rb +241 -0
- data/lib/checkbook/models/api_key_response.rb +315 -0
- data/lib/checkbook/models/approval.rb +445 -0
- data/lib/checkbook/models/approval_number.rb +104 -0
- data/lib/checkbook/models/approval_recipient.rb +105 -0
- data/lib/checkbook/models/attachment.rb +283 -0
- data/lib/checkbook/models/bank.rb +475 -0
- data/lib/checkbook/models/bank_release_request.rb +238 -0
- data/lib/checkbook/models/bank_settings.rb +232 -0
- data/lib/checkbook/models/bank_verify_request.rb +311 -0
- data/lib/checkbook/models/base_checkbook_request.rb +328 -0
- data/lib/checkbook/models/brand.rb +297 -0
- data/lib/checkbook/models/brand_response.rb +255 -0
- data/lib/checkbook/models/button.rb +221 -0
- data/lib/checkbook/models/card.rb +357 -0
- data/lib/checkbook/models/card_address.rb +377 -0
- data/lib/checkbook/models/check.rb +445 -0
- data/lib/checkbook/models/check_address.rb +407 -0
- data/lib/checkbook/models/check_response.rb +238 -0
- data/lib/checkbook/models/check_settings.rb +230 -0
- data/lib/checkbook/models/checkbook_address.rb +442 -0
- data/lib/checkbook/models/color.rb +232 -0
- data/lib/checkbook/models/convert_check_request.rb +264 -0
- data/lib/checkbook/models/counterparty.rb +264 -0
- data/lib/checkbook/models/create_bank_request.rb +342 -0
- data/lib/checkbook/models/create_bank_response.rb +475 -0
- data/lib/checkbook/models/create_card_intent.rb +313 -0
- data/lib/checkbook/models/create_card_intent_response.rb +221 -0
- data/lib/checkbook/models/create_card_request.rb +284 -0
- data/lib/checkbook/models/create_card_response.rb +332 -0
- data/lib/checkbook/models/create_check_subscription_request.rb +476 -0
- data/lib/checkbook/models/create_check_subscription_request_recipient.rb +104 -0
- data/lib/checkbook/models/create_digital_check_request.rb +470 -0
- data/lib/checkbook/models/create_digital_check_request_attachment.rb +104 -0
- data/lib/checkbook/models/create_digital_check_request_number.rb +105 -0
- data/lib/checkbook/models/create_digital_check_request_recipient.rb +104 -0
- data/lib/checkbook/models/create_direct_check_request.rb +554 -0
- data/lib/checkbook/models/create_direct_check_request_number.rb +104 -0
- data/lib/checkbook/models/create_directory_bank_request.rb +342 -0
- data/lib/checkbook/models/create_directory_bank_response.rb +329 -0
- data/lib/checkbook/models/create_directory_card_request.rb +300 -0
- data/lib/checkbook/models/create_directory_card_response.rb +329 -0
- data/lib/checkbook/models/create_directory_request.rb +291 -0
- data/lib/checkbook/models/create_directory_response.rb +314 -0
- data/lib/checkbook/models/create_instant_check_request.rb +487 -0
- data/lib/checkbook/models/create_interac_request.rb +247 -0
- data/lib/checkbook/models/create_invoice_request.rb +393 -0
- data/lib/checkbook/models/create_invoice_request_attachment.rb +104 -0
- data/lib/checkbook/models/create_invoice_response.rb +399 -0
- data/lib/checkbook/models/create_invoice_subscription_request.rb +471 -0
- data/lib/checkbook/models/create_mailbox_response.rb +301 -0
- data/lib/checkbook/models/create_multi_check_request.rb +432 -0
- data/lib/checkbook/models/create_paypal_request.rb +247 -0
- data/lib/checkbook/models/create_physical_check_request.rb +446 -0
- data/lib/checkbook/models/create_physical_check_request_number.rb +105 -0
- data/lib/checkbook/models/create_physical_check_request_remittance_advice.rb +104 -0
- data/lib/checkbook/models/create_subscription_response.rb +454 -0
- data/lib/checkbook/models/create_subscription_response_recipient.rb +104 -0
- data/lib/checkbook/models/create_user_request.rb +302 -0
- data/lib/checkbook/models/create_user_response.rb +304 -0
- data/lib/checkbook/models/create_vcc_request.rb +242 -0
- data/lib/checkbook/models/create_vcc_response.rb +302 -0
- data/lib/checkbook/models/create_venmo_request.rb +247 -0
- data/lib/checkbook/models/create_wallet_request.rb +282 -0
- data/lib/checkbook/models/create_wallet_response.rb +285 -0
- data/lib/checkbook/models/create_wire_request.rb +342 -0
- data/lib/checkbook/models/csv_approval_response.rb +240 -0
- data/lib/checkbook/models/csv_check_request.rb +313 -0
- data/lib/checkbook/models/csv_check_response.rb +240 -0
- data/lib/checkbook/models/csv_invoice_request.rb +268 -0
- data/lib/checkbook/models/csv_invoice_response.rb +240 -0
- data/lib/checkbook/models/csv_multi_check_request.rb +268 -0
- data/lib/checkbook/models/deposit_check_request.rb +238 -0
- data/lib/checkbook/models/developer.rb +238 -0
- data/lib/checkbook/models/digital_recipient.rb +257 -0
- data/lib/checkbook/models/directory_account.rb +329 -0
- data/lib/checkbook/models/directory_address.rb +277 -0
- data/lib/checkbook/models/directory_request_address.rb +392 -0
- data/lib/checkbook/models/endorse_check_request.rb +267 -0
- data/lib/checkbook/models/error.rb +246 -0
- data/lib/checkbook/models/file_row.rb +362 -0
- data/lib/checkbook/models/get_api_key_response.rb +253 -0
- data/lib/checkbook/models/get_approval_response.rb +434 -0
- data/lib/checkbook/models/get_approvals_response.rb +318 -0
- data/lib/checkbook/models/get_banks_response.rb +240 -0
- data/lib/checkbook/models/get_cards_response.rb +240 -0
- data/lib/checkbook/models/get_check_deposited_response.rb +246 -0
- data/lib/checkbook/models/get_check_failed_response.rb +224 -0
- data/lib/checkbook/models/get_check_response.rb +434 -0
- data/lib/checkbook/models/get_check_tracking_response_express.rb +240 -0
- data/lib/checkbook/models/get_check_tracking_response_first_class.rb +240 -0
- data/lib/checkbook/models/get_checkbook_response.rb +325 -0
- data/lib/checkbook/models/get_checkbook_tracking_response_express.rb +240 -0
- data/lib/checkbook/models/get_checkbook_tracking_response_first_class.rb +240 -0
- data/lib/checkbook/models/get_checkbooks_response.rb +318 -0
- data/lib/checkbook/models/get_checks_response.rb +318 -0
- data/lib/checkbook/models/get_directories_response.rb +270 -0
- data/lib/checkbook/models/get_institutions_response.rb +240 -0
- data/lib/checkbook/models/get_interac_response.rb +240 -0
- data/lib/checkbook/models/get_invoice_response.rb +468 -0
- data/lib/checkbook/models/get_invoices_response.rb +318 -0
- data/lib/checkbook/models/get_mail_response.rb +318 -0
- data/lib/checkbook/models/get_mailboxes_response.rb +318 -0
- data/lib/checkbook/models/get_paypal_response.rb +240 -0
- data/lib/checkbook/models/get_subscription_response.rb +522 -0
- data/lib/checkbook/models/get_subscriptions_response.rb +318 -0
- data/lib/checkbook/models/get_user_response.rb +239 -0
- data/lib/checkbook/models/get_vcc_response.rb +393 -0
- data/lib/checkbook/models/get_venmo_response.rb +240 -0
- data/lib/checkbook/models/get_wallets_response.rb +240 -0
- data/lib/checkbook/models/get_wire_response.rb +240 -0
- data/lib/checkbook/models/iav_account.rb +276 -0
- data/lib/checkbook/models/iav_login_response.rb +245 -0
- data/lib/checkbook/models/iav_login_schema.rb +238 -0
- data/lib/checkbook/models/iav_plaid_request.rb +238 -0
- data/lib/checkbook/models/iav_plaid_response.rb +223 -0
- data/lib/checkbook/models/iavmfa_schema.rb +249 -0
- data/lib/checkbook/models/inline_response200.rb +222 -0
- data/lib/checkbook/models/institution.rb +277 -0
- data/lib/checkbook/models/interac_account_response.rb +276 -0
- data/lib/checkbook/models/invoice_attachment.rb +283 -0
- data/lib/checkbook/models/invoice_file_row.rb +374 -0
- data/lib/checkbook/models/login_field.rb +277 -0
- data/lib/checkbook/models/mail_response.rb +367 -0
- data/lib/checkbook/models/mailbox_address.rb +285 -0
- data/lib/checkbook/models/merchant.rb +447 -0
- data/lib/checkbook/models/merchant_response.rb +318 -0
- data/lib/checkbook/models/merchant_response_address.rb +278 -0
- data/lib/checkbook/models/mfa_option.rb +273 -0
- data/lib/checkbook/models/mfa_response_field.rb +298 -0
- data/lib/checkbook/models/mfa_selection_field.rb +231 -0
- data/lib/checkbook/models/multi_file_row.rb +431 -0
- data/lib/checkbook/models/multi_recipient.rb +312 -0
- data/lib/checkbook/models/new_api_key_request.rb +233 -0
- data/lib/checkbook/models/new_api_key_response.rb +263 -0
- data/lib/checkbook/models/number.rb +231 -0
- data/lib/checkbook/models/number140416527981344.rb +231 -0
- data/lib/checkbook/models/numbers.rb +238 -0
- data/lib/checkbook/models/numbers140416527982288.rb +238 -0
- data/lib/checkbook/models/options.rb +256 -0
- data/lib/checkbook/models/parsed_address.rb +271 -0
- data/lib/checkbook/models/parsed_address_address.rb +104 -0
- data/lib/checkbook/models/pay_invoice_request.rb +284 -0
- data/lib/checkbook/models/pay_invoice_response.rb +346 -0
- data/lib/checkbook/models/payment.rb +247 -0
- data/lib/checkbook/models/paypal_account_response.rb +276 -0
- data/lib/checkbook/models/physical_check_recipient.rb +442 -0
- data/lib/checkbook/models/pin.rb +283 -0
- data/lib/checkbook/models/plaid_account.rb +276 -0
- data/lib/checkbook/models/post_bank_iav_request.rb +104 -0
- data/lib/checkbook/models/preview_check_request.rb +337 -0
- data/lib/checkbook/models/preview_check_request_number.rb +104 -0
- data/lib/checkbook/models/preview_check_response.rb +238 -0
- data/lib/checkbook/models/provision_vcc_request.rb +348 -0
- data/lib/checkbook/models/provision_vcc_response.rb +292 -0
- data/lib/checkbook/models/register_user_request.rb +417 -0
- data/lib/checkbook/models/release_check_request.rb +238 -0
- data/lib/checkbook/models/remittance_advice.rb +296 -0
- data/lib/checkbook/models/signature_request.rb +239 -0
- data/lib/checkbook/models/subscription_address.rb +407 -0
- data/lib/checkbook/models/tracking_event.rb +249 -0
- data/lib/checkbook/models/tracking_number.rb +249 -0
- data/lib/checkbook/models/trigger_user_webhook_request.rb +262 -0
- data/lib/checkbook/models/trigger_webhook_request.rb +271 -0
- data/lib/checkbook/models/update_approval_request.rb +329 -0
- data/lib/checkbook/models/update_bank_request.rb +257 -0
- data/lib/checkbook/models/update_card_request.rb +247 -0
- data/lib/checkbook/models/update_check_request.rb +263 -0
- data/lib/checkbook/models/update_directory_address.rb +337 -0
- data/lib/checkbook/models/update_directory_request.rb +281 -0
- data/lib/checkbook/models/update_interac_request.rb +237 -0
- data/lib/checkbook/models/update_merchant_address.rb +377 -0
- data/lib/checkbook/models/update_paypal_request.rb +237 -0
- data/lib/checkbook/models/update_principal_address.rb +377 -0
- data/lib/checkbook/models/update_subscription_request.rb +233 -0
- data/lib/checkbook/models/update_user_request.rb +266 -0
- data/lib/checkbook/models/update_vcc_request.rb +242 -0
- data/lib/checkbook/models/update_venmo_request.rb +237 -0
- data/lib/checkbook/models/update_wallet_request.rb +237 -0
- data/lib/checkbook/models/update_wire_request.rb +237 -0
- data/lib/checkbook/models/user.rb +477 -0
- data/lib/checkbook/models/user_query_response.rb +271 -0
- data/lib/checkbook/models/user_response.rb +355 -0
- data/lib/checkbook/models/user_response_query.rb +320 -0
- data/lib/checkbook/models/validate_address_request.rb +240 -0
- data/lib/checkbook/models/validate_address_response.rb +240 -0
- data/lib/checkbook/models/vcc.rb +404 -0
- data/lib/checkbook/models/vcc_address.rb +266 -0
- data/lib/checkbook/models/vcc_query_response.rb +240 -0
- data/lib/checkbook/models/vcc_transaction.rb +285 -0
- data/lib/checkbook/models/vcc_transactions_response.rb +270 -0
- data/lib/checkbook/models/venmo_account_response.rb +276 -0
- data/lib/checkbook/models/verify_check_request.rb +238 -0
- data/lib/checkbook/models/verify_check_response.rb +221 -0
- data/lib/checkbook/models/verify_user_request.rb +273 -0
- data/lib/checkbook/models/wallet.rb +296 -0
- data/lib/checkbook/models/wire_account_response.rb +330 -0
- data/lib/checkbook/version.rb +15 -0
- data/lib/checkbook.rb +255 -0
- data/spec/api/approval_spec.rb +151 -0
- data/spec/api/bank_spec.rb +142 -0
- data/spec/api/card_spec.rb +83 -0
- data/spec/api/checkbook_spec.rb +97 -0
- data/spec/api/directory_spec.rb +125 -0
- data/spec/api/interac_spec.rb +83 -0
- data/spec/api/invoice_spec.rb +114 -0
- data/spec/api/mailbox_spec.rb +114 -0
- data/spec/api/payment_spec.rb +249 -0
- data/spec/api/paypal_spec.rb +83 -0
- data/spec/api/subscription_spec.rb +115 -0
- data/spec/api/user_spec.rb +156 -0
- data/spec/api/vcc_spec.rb +113 -0
- data/spec/api/venmo_spec.rb +83 -0
- data/spec/api/wallet_spec.rb +83 -0
- data/spec/api/wire_spec.rb +83 -0
- data/spec/models/address_response_spec.rb +54 -0
- data/spec/models/address_spec.rb +66 -0
- data/spec/models/api_key_list_response_spec.rb +36 -0
- data/spec/models/api_key_response_spec.rb +60 -0
- data/spec/models/approval_number_spec.rb +32 -0
- data/spec/models/approval_recipient_spec.rb +32 -0
- data/spec/models/approval_spec.rb +110 -0
- data/spec/models/attachment_spec.rb +42 -0
- data/spec/models/bank_release_request_spec.rb +36 -0
- data/spec/models/bank_settings_spec.rb +42 -0
- data/spec/models/bank_spec.rb +98 -0
- data/spec/models/bank_verify_request_spec.rb +48 -0
- data/spec/models/base_checkbook_request_spec.rb +58 -0
- data/spec/models/brand_response_spec.rb +54 -0
- data/spec/models/brand_spec.rb +66 -0
- data/spec/models/button_spec.rb +36 -0
- data/spec/models/card_address_spec.rb +66 -0
- data/spec/models/card_spec.rb +66 -0
- data/spec/models/check_address_spec.rb +66 -0
- data/spec/models/check_response_spec.rb +36 -0
- data/spec/models/check_settings_spec.rb +42 -0
- data/spec/models/check_spec.rb +110 -0
- data/spec/models/checkbook_address_spec.rb +72 -0
- data/spec/models/color_spec.rb +42 -0
- data/spec/models/convert_check_request_spec.rb +42 -0
- data/spec/models/counterparty_spec.rb +42 -0
- data/spec/models/create_bank_request_spec.rb +58 -0
- data/spec/models/create_bank_response_spec.rb +98 -0
- data/spec/models/create_card_intent_response_spec.rb +36 -0
- data/spec/models/create_card_intent_spec.rb +58 -0
- data/spec/models/create_card_request_spec.rb +54 -0
- data/spec/models/create_card_response_spec.rb +60 -0
- data/spec/models/create_check_subscription_request_recipient_spec.rb +32 -0
- data/spec/models/create_check_subscription_request_spec.rb +88 -0
- data/spec/models/create_digital_check_request_attachment_spec.rb +32 -0
- data/spec/models/create_digital_check_request_number_spec.rb +32 -0
- data/spec/models/create_digital_check_request_recipient_spec.rb +32 -0
- data/spec/models/create_digital_check_request_spec.rb +100 -0
- data/spec/models/create_direct_check_request_number_spec.rb +32 -0
- data/spec/models/create_direct_check_request_spec.rb +116 -0
- data/spec/models/create_directory_bank_request_spec.rb +58 -0
- data/spec/models/create_directory_bank_response_spec.rb +58 -0
- data/spec/models/create_directory_card_request_spec.rb +48 -0
- data/spec/models/create_directory_card_response_spec.rb +58 -0
- data/spec/models/create_directory_request_spec.rb +48 -0
- data/spec/models/create_directory_response_spec.rb +60 -0
- data/spec/models/create_instant_check_request_spec.rb +96 -0
- data/spec/models/create_interac_request_spec.rb +36 -0
- data/spec/models/create_invoice_request_attachment_spec.rb +32 -0
- data/spec/models/create_invoice_request_spec.rb +72 -0
- data/spec/models/create_invoice_response_spec.rb +78 -0
- data/spec/models/create_invoice_subscription_request_spec.rb +82 -0
- data/spec/models/create_mailbox_response_spec.rb +54 -0
- data/spec/models/create_multi_check_request_spec.rb +88 -0
- data/spec/models/create_paypal_request_spec.rb +36 -0
- data/spec/models/create_physical_check_request_number_spec.rb +32 -0
- data/spec/models/create_physical_check_request_remittance_advice_spec.rb +32 -0
- data/spec/models/create_physical_check_request_spec.rb +94 -0
- data/spec/models/create_subscription_response_recipient_spec.rb +32 -0
- data/spec/models/create_subscription_response_spec.rb +104 -0
- data/spec/models/create_user_request_spec.rb +42 -0
- data/spec/models/create_user_response_spec.rb +54 -0
- data/spec/models/create_vcc_request_spec.rb +48 -0
- data/spec/models/create_vcc_response_spec.rb +54 -0
- data/spec/models/create_venmo_request_spec.rb +36 -0
- data/spec/models/create_wallet_request_spec.rb +46 -0
- data/spec/models/create_wallet_response_spec.rb +54 -0
- data/spec/models/create_wire_request_spec.rb +58 -0
- data/spec/models/csv_approval_response_spec.rb +36 -0
- data/spec/models/csv_check_request_spec.rb +52 -0
- data/spec/models/csv_check_response_spec.rb +36 -0
- data/spec/models/csv_invoice_request_spec.rb +42 -0
- data/spec/models/csv_invoice_response_spec.rb +36 -0
- data/spec/models/csv_multi_check_request_spec.rb +42 -0
- data/spec/models/deposit_check_request_spec.rb +36 -0
- data/spec/models/developer_spec.rb +36 -0
- data/spec/models/digital_recipient_spec.rb +42 -0
- data/spec/models/directory_account_spec.rb +58 -0
- data/spec/models/directory_address_spec.rb +66 -0
- data/spec/models/directory_request_address_spec.rb +66 -0
- data/spec/models/endorse_check_request_spec.rb +42 -0
- data/spec/models/error_spec.rb +42 -0
- data/spec/models/file_row_spec.rb +72 -0
- data/spec/models/get_api_key_response_spec.rb +54 -0
- data/spec/models/get_approval_response_spec.rb +100 -0
- data/spec/models/get_approvals_response_spec.rb +54 -0
- data/spec/models/get_banks_response_spec.rb +36 -0
- data/spec/models/get_cards_response_spec.rb +36 -0
- data/spec/models/get_check_deposited_response_spec.rb +48 -0
- data/spec/models/get_check_failed_response_spec.rb +36 -0
- data/spec/models/get_check_response_spec.rb +100 -0
- data/spec/models/get_check_tracking_response_express_spec.rb +36 -0
- data/spec/models/get_check_tracking_response_first_class_spec.rb +36 -0
- data/spec/models/get_checkbook_response_spec.rb +58 -0
- data/spec/models/get_checkbook_tracking_response_express_spec.rb +36 -0
- data/spec/models/get_checkbook_tracking_response_first_class_spec.rb +36 -0
- data/spec/models/get_checkbooks_response_spec.rb +54 -0
- data/spec/models/get_checks_response_spec.rb +54 -0
- data/spec/models/get_directories_response_spec.rb +54 -0
- data/spec/models/get_institutions_response_spec.rb +36 -0
- data/spec/models/get_interac_response_spec.rb +36 -0
- data/spec/models/get_invoice_response_spec.rb +100 -0
- data/spec/models/get_invoices_response_spec.rb +54 -0
- data/spec/models/get_mail_response_spec.rb +54 -0
- data/spec/models/get_mailboxes_response_spec.rb +54 -0
- data/spec/models/get_paypal_response_spec.rb +36 -0
- data/spec/models/get_subscription_response_spec.rb +126 -0
- data/spec/models/get_subscriptions_response_spec.rb +54 -0
- data/spec/models/get_user_response_spec.rb +48 -0
- data/spec/models/get_vcc_response_spec.rb +78 -0
- data/spec/models/get_venmo_response_spec.rb +36 -0
- data/spec/models/get_wallets_response_spec.rb +36 -0
- data/spec/models/get_wire_response_spec.rb +36 -0
- data/spec/models/iav_account_spec.rb +48 -0
- data/spec/models/iav_login_response_spec.rb +48 -0
- data/spec/models/iav_login_schema_spec.rb +36 -0
- data/spec/models/iav_plaid_request_spec.rb +36 -0
- data/spec/models/iav_plaid_response_spec.rb +36 -0
- data/spec/models/iavmfa_schema_spec.rb +42 -0
- data/spec/models/inline_response200_spec.rb +36 -0
- data/spec/models/institution_spec.rb +48 -0
- data/spec/models/interac_account_response_spec.rb +48 -0
- data/spec/models/invoice_attachment_spec.rb +42 -0
- data/spec/models/invoice_file_row_spec.rb +60 -0
- data/spec/models/login_field_spec.rb +52 -0
- data/spec/models/mail_response_spec.rb +72 -0
- data/spec/models/mailbox_address_spec.rb +66 -0
- data/spec/models/merchant_response_address_spec.rb +66 -0
- data/spec/models/merchant_response_spec.rb +90 -0
- data/spec/models/merchant_spec.rb +98 -0
- data/spec/models/mfa_option_spec.rb +52 -0
- data/spec/models/mfa_response_field_spec.rb +64 -0
- data/spec/models/mfa_selection_field_spec.rb +42 -0
- data/spec/models/multi_file_row_spec.rb +72 -0
- data/spec/models/multi_recipient_spec.rb +54 -0
- data/spec/models/new_api_key_request_spec.rb +42 -0
- data/spec/models/new_api_key_response_spec.rb +60 -0
- data/spec/models/number140416527981344_spec.rb +42 -0
- data/spec/models/number_spec.rb +42 -0
- data/spec/models/numbers140416527982288_spec.rb +48 -0
- data/spec/models/numbers_spec.rb +48 -0
- data/spec/models/options_spec.rb +40 -0
- data/spec/models/parsed_address_address_spec.rb +32 -0
- data/spec/models/parsed_address_spec.rb +46 -0
- data/spec/models/pay_invoice_request_spec.rb +48 -0
- data/spec/models/pay_invoice_response_spec.rb +60 -0
- data/spec/models/payment_spec.rb +36 -0
- data/spec/models/paypal_account_response_spec.rb +48 -0
- data/spec/models/physical_check_recipient_spec.rb +72 -0
- data/spec/models/pin_spec.rb +42 -0
- data/spec/models/plaid_account_spec.rb +48 -0
- data/spec/models/post_bank_iav_request_spec.rb +32 -0
- data/spec/models/preview_check_request_number_spec.rb +32 -0
- data/spec/models/preview_check_request_spec.rb +60 -0
- data/spec/models/preview_check_response_spec.rb +36 -0
- data/spec/models/provision_vcc_request_spec.rb +58 -0
- data/spec/models/provision_vcc_response_spec.rb +48 -0
- data/spec/models/register_user_request_spec.rb +66 -0
- data/spec/models/release_check_request_spec.rb +36 -0
- data/spec/models/remittance_advice_spec.rb +54 -0
- data/spec/models/signature_request_spec.rb +36 -0
- data/spec/models/subscription_address_spec.rb +66 -0
- data/spec/models/tracking_event_spec.rb +42 -0
- data/spec/models/tracking_number_spec.rb +42 -0
- data/spec/models/trigger_user_webhook_request_spec.rb +40 -0
- data/spec/models/trigger_webhook_request_spec.rb +46 -0
- data/spec/models/update_approval_request_spec.rb +66 -0
- data/spec/models/update_bank_request_spec.rb +48 -0
- data/spec/models/update_card_request_spec.rb +42 -0
- data/spec/models/update_check_request_spec.rb +42 -0
- data/spec/models/update_directory_address_spec.rb +66 -0
- data/spec/models/update_directory_request_spec.rb +48 -0
- data/spec/models/update_interac_request_spec.rb +36 -0
- data/spec/models/update_merchant_address_spec.rb +66 -0
- data/spec/models/update_paypal_request_spec.rb +36 -0
- data/spec/models/update_principal_address_spec.rb +66 -0
- data/spec/models/update_subscription_request_spec.rb +42 -0
- data/spec/models/update_user_request_spec.rb +66 -0
- data/spec/models/update_vcc_request_spec.rb +48 -0
- data/spec/models/update_venmo_request_spec.rb +36 -0
- data/spec/models/update_wallet_request_spec.rb +36 -0
- data/spec/models/update_wire_request_spec.rb +36 -0
- data/spec/models/user_query_response_spec.rb +54 -0
- data/spec/models/user_response_query_spec.rb +54 -0
- data/spec/models/user_response_spec.rb +94 -0
- data/spec/models/user_spec.rb +84 -0
- data/spec/models/validate_address_request_spec.rb +36 -0
- data/spec/models/validate_address_response_spec.rb +36 -0
- data/spec/models/vcc_address_spec.rb +60 -0
- data/spec/models/vcc_query_response_spec.rb +36 -0
- data/spec/models/vcc_spec.rb +84 -0
- data/spec/models/vcc_transaction_spec.rb +72 -0
- data/spec/models/vcc_transactions_response_spec.rb +54 -0
- data/spec/models/venmo_account_response_spec.rb +48 -0
- data/spec/models/verify_check_request_spec.rb +36 -0
- data/spec/models/verify_check_response_spec.rb +36 -0
- data/spec/models/verify_user_request_spec.rb +46 -0
- data/spec/models/wallet_spec.rb +60 -0
- data/spec/models/wire_account_response_spec.rb +60 -0
- data/spec/spec_helper.rb +111 -0
- metadata +759 -0
|
@@ -0,0 +1,284 @@
|
|
|
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 Card
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Remove card
|
|
23
|
+
# Remove the specified card
|
|
24
|
+
# @param card_id [String]
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [nil]
|
|
27
|
+
def delete_card(card_id, opts = {})
|
|
28
|
+
delete_card_with_http_info(card_id, opts)
|
|
29
|
+
nil
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Remove card
|
|
33
|
+
# Remove the specified card
|
|
34
|
+
# @param card_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_card_with_http_info(card_id, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: Card.delete_card ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'card_id' is set
|
|
42
|
+
if @api_client.config.client_side_validation && card_id.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'card_id' when calling Card.delete_card"
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/v3/account/card/{card_id}'.sub('{' + 'card_id' + '}', CGI.escape(card_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 => :"Card.delete_card",
|
|
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: Card#delete_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
81
|
+
end
|
|
82
|
+
return data, status_code, headers
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Get cards
|
|
86
|
+
# Return the cards
|
|
87
|
+
# @param [Hash] opts the optional parameters
|
|
88
|
+
# @return [GetCardsResponse]
|
|
89
|
+
def get_cards(opts = {})
|
|
90
|
+
data, _status_code, _headers = get_cards_with_http_info(opts)
|
|
91
|
+
data
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Get cards
|
|
95
|
+
# Return the cards
|
|
96
|
+
# @param [Hash] opts the optional parameters
|
|
97
|
+
# @return [Array<(GetCardsResponse, Integer, Hash)>] GetCardsResponse data, response status code and response headers
|
|
98
|
+
def get_cards_with_http_info(opts = {})
|
|
99
|
+
if @api_client.config.debugging
|
|
100
|
+
@api_client.config.logger.debug 'Calling API: Card.get_cards ...'
|
|
101
|
+
end
|
|
102
|
+
# resource path
|
|
103
|
+
local_var_path = '/v3/account/card'
|
|
104
|
+
|
|
105
|
+
# query parameters
|
|
106
|
+
query_params = opts[:query_params] || {}
|
|
107
|
+
|
|
108
|
+
# header parameters
|
|
109
|
+
header_params = opts[:header_params] || {}
|
|
110
|
+
# HTTP header 'Accept' (if needed)
|
|
111
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
112
|
+
|
|
113
|
+
# form parameters
|
|
114
|
+
form_params = opts[:form_params] || {}
|
|
115
|
+
|
|
116
|
+
# http body (model)
|
|
117
|
+
post_body = opts[:debug_body]
|
|
118
|
+
|
|
119
|
+
# return_type
|
|
120
|
+
return_type = opts[:debug_return_type] || 'GetCardsResponse'
|
|
121
|
+
|
|
122
|
+
# auth_names
|
|
123
|
+
auth_names = opts[:debug_auth_names] || ['token']
|
|
124
|
+
|
|
125
|
+
new_options = opts.merge(
|
|
126
|
+
:operation => :"Card.get_cards",
|
|
127
|
+
:header_params => header_params,
|
|
128
|
+
:query_params => query_params,
|
|
129
|
+
:form_params => form_params,
|
|
130
|
+
:body => post_body,
|
|
131
|
+
:auth_names => auth_names,
|
|
132
|
+
:return_type => return_type
|
|
133
|
+
)
|
|
134
|
+
|
|
135
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
136
|
+
if @api_client.config.debugging
|
|
137
|
+
@api_client.config.logger.debug "API called: Card#get_cards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
138
|
+
end
|
|
139
|
+
return data, status_code, headers
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
# Add card
|
|
143
|
+
# Add a new card
|
|
144
|
+
# @param create_card_request [CreateCardRequest]
|
|
145
|
+
# @param [Hash] opts the optional parameters
|
|
146
|
+
# @return [CreateCardResponse]
|
|
147
|
+
def post_card(create_card_request, opts = {})
|
|
148
|
+
data, _status_code, _headers = post_card_with_http_info(create_card_request, opts)
|
|
149
|
+
data
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
# Add card
|
|
153
|
+
# Add a new card
|
|
154
|
+
# @param create_card_request [CreateCardRequest]
|
|
155
|
+
# @param [Hash] opts the optional parameters
|
|
156
|
+
# @return [Array<(CreateCardResponse, Integer, Hash)>] CreateCardResponse data, response status code and response headers
|
|
157
|
+
def post_card_with_http_info(create_card_request, opts = {})
|
|
158
|
+
if @api_client.config.debugging
|
|
159
|
+
@api_client.config.logger.debug 'Calling API: Card.post_card ...'
|
|
160
|
+
end
|
|
161
|
+
# verify the required parameter 'create_card_request' is set
|
|
162
|
+
if @api_client.config.client_side_validation && create_card_request.nil?
|
|
163
|
+
fail ArgumentError, "Missing the required parameter 'create_card_request' when calling Card.post_card"
|
|
164
|
+
end
|
|
165
|
+
# resource path
|
|
166
|
+
local_var_path = '/v3/account/card'
|
|
167
|
+
|
|
168
|
+
# query parameters
|
|
169
|
+
query_params = opts[:query_params] || {}
|
|
170
|
+
|
|
171
|
+
# header parameters
|
|
172
|
+
header_params = opts[:header_params] || {}
|
|
173
|
+
# HTTP header 'Accept' (if needed)
|
|
174
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
175
|
+
# HTTP header 'Content-Type'
|
|
176
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
177
|
+
if !content_type.nil?
|
|
178
|
+
header_params['Content-Type'] = content_type
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
# form parameters
|
|
182
|
+
form_params = opts[:form_params] || {}
|
|
183
|
+
|
|
184
|
+
# http body (model)
|
|
185
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_card_request)
|
|
186
|
+
|
|
187
|
+
# return_type
|
|
188
|
+
return_type = opts[:debug_return_type] || 'CreateCardResponse'
|
|
189
|
+
|
|
190
|
+
# auth_names
|
|
191
|
+
auth_names = opts[:debug_auth_names] || ['token']
|
|
192
|
+
|
|
193
|
+
new_options = opts.merge(
|
|
194
|
+
:operation => :"Card.post_card",
|
|
195
|
+
:header_params => header_params,
|
|
196
|
+
:query_params => query_params,
|
|
197
|
+
:form_params => form_params,
|
|
198
|
+
:body => post_body,
|
|
199
|
+
:auth_names => auth_names,
|
|
200
|
+
:return_type => return_type
|
|
201
|
+
)
|
|
202
|
+
|
|
203
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
204
|
+
if @api_client.config.debugging
|
|
205
|
+
@api_client.config.logger.debug "API called: Card#post_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
206
|
+
end
|
|
207
|
+
return data, status_code, headers
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# Update card
|
|
211
|
+
# Update the specified card
|
|
212
|
+
# @param card_id [String]
|
|
213
|
+
# @param update_card_request [UpdateCardRequest]
|
|
214
|
+
# @param [Hash] opts the optional parameters
|
|
215
|
+
# @return [nil]
|
|
216
|
+
def put_card(card_id, update_card_request, opts = {})
|
|
217
|
+
put_card_with_http_info(card_id, update_card_request, opts)
|
|
218
|
+
nil
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
# Update card
|
|
222
|
+
# Update the specified card
|
|
223
|
+
# @param card_id [String]
|
|
224
|
+
# @param update_card_request [UpdateCardRequest]
|
|
225
|
+
# @param [Hash] opts the optional parameters
|
|
226
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
227
|
+
def put_card_with_http_info(card_id, update_card_request, opts = {})
|
|
228
|
+
if @api_client.config.debugging
|
|
229
|
+
@api_client.config.logger.debug 'Calling API: Card.put_card ...'
|
|
230
|
+
end
|
|
231
|
+
# verify the required parameter 'card_id' is set
|
|
232
|
+
if @api_client.config.client_side_validation && card_id.nil?
|
|
233
|
+
fail ArgumentError, "Missing the required parameter 'card_id' when calling Card.put_card"
|
|
234
|
+
end
|
|
235
|
+
# verify the required parameter 'update_card_request' is set
|
|
236
|
+
if @api_client.config.client_side_validation && update_card_request.nil?
|
|
237
|
+
fail ArgumentError, "Missing the required parameter 'update_card_request' when calling Card.put_card"
|
|
238
|
+
end
|
|
239
|
+
# resource path
|
|
240
|
+
local_var_path = '/v3/account/card/{card_id}'.sub('{' + 'card_id' + '}', CGI.escape(card_id.to_s))
|
|
241
|
+
|
|
242
|
+
# query parameters
|
|
243
|
+
query_params = opts[:query_params] || {}
|
|
244
|
+
|
|
245
|
+
# header parameters
|
|
246
|
+
header_params = opts[:header_params] || {}
|
|
247
|
+
# HTTP header 'Accept' (if needed)
|
|
248
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
249
|
+
# HTTP header 'Content-Type'
|
|
250
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
251
|
+
if !content_type.nil?
|
|
252
|
+
header_params['Content-Type'] = content_type
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# form parameters
|
|
256
|
+
form_params = opts[:form_params] || {}
|
|
257
|
+
|
|
258
|
+
# http body (model)
|
|
259
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_card_request)
|
|
260
|
+
|
|
261
|
+
# return_type
|
|
262
|
+
return_type = opts[:debug_return_type]
|
|
263
|
+
|
|
264
|
+
# auth_names
|
|
265
|
+
auth_names = opts[:debug_auth_names] || ['token']
|
|
266
|
+
|
|
267
|
+
new_options = opts.merge(
|
|
268
|
+
:operation => :"Card.put_card",
|
|
269
|
+
:header_params => header_params,
|
|
270
|
+
:query_params => query_params,
|
|
271
|
+
:form_params => form_params,
|
|
272
|
+
:body => post_body,
|
|
273
|
+
:auth_names => auth_names,
|
|
274
|
+
:return_type => return_type
|
|
275
|
+
)
|
|
276
|
+
|
|
277
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
278
|
+
if @api_client.config.debugging
|
|
279
|
+
@api_client.config.logger.debug "API called: Card#put_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
280
|
+
end
|
|
281
|
+
return data, status_code, headers
|
|
282
|
+
end
|
|
283
|
+
end
|
|
284
|
+
end
|
|
@@ -0,0 +1,357 @@
|
|
|
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 Checkbook
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Cancel a checkbook
|
|
23
|
+
# Cancel the specified checkbook order
|
|
24
|
+
# @param checkbook_id [String]
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [nil]
|
|
27
|
+
def delete_checkbook(checkbook_id, opts = {})
|
|
28
|
+
delete_checkbook_with_http_info(checkbook_id, opts)
|
|
29
|
+
nil
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Cancel a checkbook
|
|
33
|
+
# Cancel the specified checkbook order
|
|
34
|
+
# @param checkbook_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_checkbook_with_http_info(checkbook_id, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: Checkbook.delete_checkbook ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'checkbook_id' is set
|
|
42
|
+
if @api_client.config.client_side_validation && checkbook_id.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'checkbook_id' when calling Checkbook.delete_checkbook"
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/v3/checkbook/{checkbook_id}'.sub('{' + 'checkbook_id' + '}', CGI.escape(checkbook_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 => :"Checkbook.delete_checkbook",
|
|
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: Checkbook#delete_checkbook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
81
|
+
end
|
|
82
|
+
return data, status_code, headers
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Get checkbook
|
|
86
|
+
# Get the specified checkbook
|
|
87
|
+
# @param checkbook_id [String]
|
|
88
|
+
# @param [Hash] opts the optional parameters
|
|
89
|
+
# @return [GetCheckbookResponse]
|
|
90
|
+
def get_checkbook(checkbook_id, opts = {})
|
|
91
|
+
data, _status_code, _headers = get_checkbook_with_http_info(checkbook_id, opts)
|
|
92
|
+
data
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# Get checkbook
|
|
96
|
+
# Get the specified checkbook
|
|
97
|
+
# @param checkbook_id [String]
|
|
98
|
+
# @param [Hash] opts the optional parameters
|
|
99
|
+
# @return [Array<(GetCheckbookResponse, Integer, Hash)>] GetCheckbookResponse data, response status code and response headers
|
|
100
|
+
def get_checkbook_with_http_info(checkbook_id, opts = {})
|
|
101
|
+
if @api_client.config.debugging
|
|
102
|
+
@api_client.config.logger.debug 'Calling API: Checkbook.get_checkbook ...'
|
|
103
|
+
end
|
|
104
|
+
# verify the required parameter 'checkbook_id' is set
|
|
105
|
+
if @api_client.config.client_side_validation && checkbook_id.nil?
|
|
106
|
+
fail ArgumentError, "Missing the required parameter 'checkbook_id' when calling Checkbook.get_checkbook"
|
|
107
|
+
end
|
|
108
|
+
# resource path
|
|
109
|
+
local_var_path = '/v3/checkbook/{checkbook_id}'.sub('{' + 'checkbook_id' + '}', CGI.escape(checkbook_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/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] || 'GetCheckbookResponse'
|
|
127
|
+
|
|
128
|
+
# auth_names
|
|
129
|
+
auth_names = opts[:debug_auth_names] || ['token']
|
|
130
|
+
|
|
131
|
+
new_options = opts.merge(
|
|
132
|
+
:operation => :"Checkbook.get_checkbook",
|
|
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: Checkbook#get_checkbook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
144
|
+
end
|
|
145
|
+
return data, status_code, headers
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# Get tracking details on checkbooks
|
|
149
|
+
# Get tracking details on checkbook
|
|
150
|
+
# @param checkbook_id [String]
|
|
151
|
+
# @param [Hash] opts the optional parameters
|
|
152
|
+
# @return [GetCheckbookTrackingResponseExpress]
|
|
153
|
+
def get_checkbook_tracking(checkbook_id, opts = {})
|
|
154
|
+
data, _status_code, _headers = get_checkbook_tracking_with_http_info(checkbook_id, opts)
|
|
155
|
+
data
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Get tracking details on checkbooks
|
|
159
|
+
# Get tracking details on checkbook
|
|
160
|
+
# @param checkbook_id [String]
|
|
161
|
+
# @param [Hash] opts the optional parameters
|
|
162
|
+
# @return [Array<(GetCheckbookTrackingResponseExpress, Integer, Hash)>] GetCheckbookTrackingResponseExpress data, response status code and response headers
|
|
163
|
+
def get_checkbook_tracking_with_http_info(checkbook_id, opts = {})
|
|
164
|
+
if @api_client.config.debugging
|
|
165
|
+
@api_client.config.logger.debug 'Calling API: Checkbook.get_checkbook_tracking ...'
|
|
166
|
+
end
|
|
167
|
+
# verify the required parameter 'checkbook_id' is set
|
|
168
|
+
if @api_client.config.client_side_validation && checkbook_id.nil?
|
|
169
|
+
fail ArgumentError, "Missing the required parameter 'checkbook_id' when calling Checkbook.get_checkbook_tracking"
|
|
170
|
+
end
|
|
171
|
+
# resource path
|
|
172
|
+
local_var_path = '/v3/checkbook/{checkbook_id}/tracking'.sub('{' + 'checkbook_id' + '}', CGI.escape(checkbook_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] || 'GetCheckbookTrackingResponseExpress'
|
|
190
|
+
|
|
191
|
+
# auth_names
|
|
192
|
+
auth_names = opts[:debug_auth_names] || ['token']
|
|
193
|
+
|
|
194
|
+
new_options = opts.merge(
|
|
195
|
+
:operation => :"Checkbook.get_checkbook_tracking",
|
|
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: Checkbook#get_checkbook_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
207
|
+
end
|
|
208
|
+
return data, status_code, headers
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
# Get checkbooks
|
|
212
|
+
# Return the checkbooks issued for a user
|
|
213
|
+
# @param [Hash] opts the optional parameters
|
|
214
|
+
# @option opts [Integer] :page Page number (default to 1)
|
|
215
|
+
# @option opts [Integer] :per_page Items per page (default to 50)
|
|
216
|
+
# @option opts [String] :q Query
|
|
217
|
+
# @return [GetCheckbooksResponse]
|
|
218
|
+
def get_checkbooks(opts = {})
|
|
219
|
+
data, _status_code, _headers = get_checkbooks_with_http_info(opts)
|
|
220
|
+
data
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
# Get checkbooks
|
|
224
|
+
# Return the checkbooks issued for a user
|
|
225
|
+
# @param [Hash] opts the optional parameters
|
|
226
|
+
# @option opts [Integer] :page Page number (default to 1)
|
|
227
|
+
# @option opts [Integer] :per_page Items per page (default to 50)
|
|
228
|
+
# @option opts [String] :q Query
|
|
229
|
+
# @return [Array<(GetCheckbooksResponse, Integer, Hash)>] GetCheckbooksResponse data, response status code and response headers
|
|
230
|
+
def get_checkbooks_with_http_info(opts = {})
|
|
231
|
+
if @api_client.config.debugging
|
|
232
|
+
@api_client.config.logger.debug 'Calling API: Checkbook.get_checkbooks ...'
|
|
233
|
+
end
|
|
234
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
|
235
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling Checkbook.get_checkbooks, must be greater than or equal to 1.'
|
|
236
|
+
end
|
|
237
|
+
|
|
238
|
+
allowable_values = [10, 25, 50]
|
|
239
|
+
if @api_client.config.client_side_validation && opts[:'per_page'] && !allowable_values.include?(opts[:'per_page'])
|
|
240
|
+
fail ArgumentError, "invalid value for \"per_page\", must be one of #{allowable_values}"
|
|
241
|
+
end
|
|
242
|
+
if @api_client.config.client_side_validation && !opts[:'q'].nil? && opts[:'q'].to_s.length > 180
|
|
243
|
+
fail ArgumentError, 'invalid value for "opts[:"q"]" when calling Checkbook.get_checkbooks, the character length must be smaller than or equal to 180.'
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
# resource path
|
|
247
|
+
local_var_path = '/v3/checkbook'
|
|
248
|
+
|
|
249
|
+
# query parameters
|
|
250
|
+
query_params = opts[:query_params] || {}
|
|
251
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
252
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
|
253
|
+
query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
|
|
254
|
+
|
|
255
|
+
# header parameters
|
|
256
|
+
header_params = opts[:header_params] || {}
|
|
257
|
+
# HTTP header 'Accept' (if needed)
|
|
258
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
259
|
+
|
|
260
|
+
# form parameters
|
|
261
|
+
form_params = opts[:form_params] || {}
|
|
262
|
+
|
|
263
|
+
# http body (model)
|
|
264
|
+
post_body = opts[:debug_body]
|
|
265
|
+
|
|
266
|
+
# return_type
|
|
267
|
+
return_type = opts[:debug_return_type] || 'GetCheckbooksResponse'
|
|
268
|
+
|
|
269
|
+
# auth_names
|
|
270
|
+
auth_names = opts[:debug_auth_names] || ['token']
|
|
271
|
+
|
|
272
|
+
new_options = opts.merge(
|
|
273
|
+
:operation => :"Checkbook.get_checkbooks",
|
|
274
|
+
:header_params => header_params,
|
|
275
|
+
:query_params => query_params,
|
|
276
|
+
:form_params => form_params,
|
|
277
|
+
:body => post_body,
|
|
278
|
+
:auth_names => auth_names,
|
|
279
|
+
:return_type => return_type
|
|
280
|
+
)
|
|
281
|
+
|
|
282
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
283
|
+
if @api_client.config.debugging
|
|
284
|
+
@api_client.config.logger.debug "API called: Checkbook#get_checkbooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
285
|
+
end
|
|
286
|
+
return data, status_code, headers
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
# Order a checkbook
|
|
290
|
+
# Order a new Checkbook > [!NOTE] > The address printed on the checkbook is the user's merchant address provided in `merchant` object when calling [`PUT /v3/user`](#tag/user/put/v3/user). If the user does not have a merchant address, the shipping address provided in the `recipient` object will be printed on the checkbook.
|
|
291
|
+
# @param base_checkbook_request [BaseCheckbookRequest]
|
|
292
|
+
# @param [Hash] opts the optional parameters
|
|
293
|
+
# @return [GetCheckbookResponse]
|
|
294
|
+
def order_checkbook(base_checkbook_request, opts = {})
|
|
295
|
+
data, _status_code, _headers = order_checkbook_with_http_info(base_checkbook_request, opts)
|
|
296
|
+
data
|
|
297
|
+
end
|
|
298
|
+
|
|
299
|
+
# Order a checkbook
|
|
300
|
+
# Order a new Checkbook > [!NOTE] > The address printed on the checkbook is the user's merchant address provided in `merchant` object when calling [`PUT /v3/user`](#tag/user/put/v3/user). If the user does not have a merchant address, the shipping address provided in the `recipient` object will be printed on the checkbook.
|
|
301
|
+
# @param base_checkbook_request [BaseCheckbookRequest]
|
|
302
|
+
# @param [Hash] opts the optional parameters
|
|
303
|
+
# @return [Array<(GetCheckbookResponse, Integer, Hash)>] GetCheckbookResponse data, response status code and response headers
|
|
304
|
+
def order_checkbook_with_http_info(base_checkbook_request, opts = {})
|
|
305
|
+
if @api_client.config.debugging
|
|
306
|
+
@api_client.config.logger.debug 'Calling API: Checkbook.order_checkbook ...'
|
|
307
|
+
end
|
|
308
|
+
# verify the required parameter 'base_checkbook_request' is set
|
|
309
|
+
if @api_client.config.client_side_validation && base_checkbook_request.nil?
|
|
310
|
+
fail ArgumentError, "Missing the required parameter 'base_checkbook_request' when calling Checkbook.order_checkbook"
|
|
311
|
+
end
|
|
312
|
+
# resource path
|
|
313
|
+
local_var_path = '/v3/checkbook'
|
|
314
|
+
|
|
315
|
+
# query parameters
|
|
316
|
+
query_params = opts[:query_params] || {}
|
|
317
|
+
|
|
318
|
+
# header parameters
|
|
319
|
+
header_params = opts[:header_params] || {}
|
|
320
|
+
# HTTP header 'Accept' (if needed)
|
|
321
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
322
|
+
# HTTP header 'Content-Type'
|
|
323
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
324
|
+
if !content_type.nil?
|
|
325
|
+
header_params['Content-Type'] = content_type
|
|
326
|
+
end
|
|
327
|
+
|
|
328
|
+
# form parameters
|
|
329
|
+
form_params = opts[:form_params] || {}
|
|
330
|
+
|
|
331
|
+
# http body (model)
|
|
332
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(base_checkbook_request)
|
|
333
|
+
|
|
334
|
+
# return_type
|
|
335
|
+
return_type = opts[:debug_return_type] || 'GetCheckbookResponse'
|
|
336
|
+
|
|
337
|
+
# auth_names
|
|
338
|
+
auth_names = opts[:debug_auth_names] || ['token']
|
|
339
|
+
|
|
340
|
+
new_options = opts.merge(
|
|
341
|
+
:operation => :"Checkbook.order_checkbook",
|
|
342
|
+
:header_params => header_params,
|
|
343
|
+
:query_params => query_params,
|
|
344
|
+
:form_params => form_params,
|
|
345
|
+
:body => post_body,
|
|
346
|
+
:auth_names => auth_names,
|
|
347
|
+
:return_type => return_type
|
|
348
|
+
)
|
|
349
|
+
|
|
350
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
351
|
+
if @api_client.config.debugging
|
|
352
|
+
@api_client.config.logger.debug "API called: Checkbook#order_checkbook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
353
|
+
end
|
|
354
|
+
return data, status_code, headers
|
|
355
|
+
end
|
|
356
|
+
end
|
|
357
|
+
end
|