straddle 0.1.0.pre.alpha.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/.ignore +2 -0
- data/CHANGELOG.md +9 -0
- data/README.md +344 -0
- data/SECURITY.md +27 -0
- data/lib/straddle/client.rb +125 -0
- data/lib/straddle/errors.rb +214 -0
- data/lib/straddle/file_part.rb +55 -0
- data/lib/straddle/internal/page_number_schema.rb +127 -0
- data/lib/straddle/internal/transport/base_client.rb +563 -0
- data/lib/straddle/internal/transport/pooled_net_requester.rb +209 -0
- data/lib/straddle/internal/type/array_of.rb +167 -0
- data/lib/straddle/internal/type/base_model.rb +536 -0
- data/lib/straddle/internal/type/base_page.rb +55 -0
- data/lib/straddle/internal/type/boolean.rb +77 -0
- data/lib/straddle/internal/type/converter.rb +300 -0
- data/lib/straddle/internal/type/enum.rb +131 -0
- data/lib/straddle/internal/type/file_input.rb +108 -0
- data/lib/straddle/internal/type/hash_of.rb +187 -0
- data/lib/straddle/internal/type/request_parameters.rb +42 -0
- data/lib/straddle/internal/type/union.rb +235 -0
- data/lib/straddle/internal/type/unknown.rb +81 -0
- data/lib/straddle/internal/util.rb +914 -0
- data/lib/straddle/internal.rb +20 -0
- data/lib/straddle/models/bridge/link_bank_account_params.rb +122 -0
- data/lib/straddle/models/bridge/link_create_paykey_params.rb +98 -0
- data/lib/straddle/models/bridge/link_create_paykey_response.rb +411 -0
- data/lib/straddle/models/bridge/link_create_tan_params.rb +122 -0
- data/lib/straddle/models/bridge/link_create_tan_response.rb +411 -0
- data/lib/straddle/models/bridge/link_plaid_params.rb +95 -0
- data/lib/straddle/models/bridge_initialize_params.rb +76 -0
- data/lib/straddle/models/bridge_token_v1.rb +74 -0
- data/lib/straddle/models/charge_cancel_params.rb +43 -0
- data/lib/straddle/models/charge_create_params.rb +191 -0
- data/lib/straddle/models/charge_get_params.rb +32 -0
- data/lib/straddle/models/charge_hold_params.rb +43 -0
- data/lib/straddle/models/charge_release_params.rb +43 -0
- data/lib/straddle/models/charge_unmask_params.rb +32 -0
- data/lib/straddle/models/charge_unmask_response.rb +485 -0
- data/lib/straddle/models/charge_update_params.rb +72 -0
- data/lib/straddle/models/charge_v1.rb +485 -0
- data/lib/straddle/models/customer_address_v1.rb +51 -0
- data/lib/straddle/models/customer_create_params.rb +287 -0
- data/lib/straddle/models/customer_delete_params.rb +32 -0
- data/lib/straddle/models/customer_details_v1.rb +63 -0
- data/lib/straddle/models/customer_get_params.rb +32 -0
- data/lib/straddle/models/customer_list_params.rb +173 -0
- data/lib/straddle/models/customer_refresh_review_params.rb +32 -0
- data/lib/straddle/models/customer_summary_paged_v1.rb +248 -0
- data/lib/straddle/models/customer_unmasked_params.rb +32 -0
- data/lib/straddle/models/customer_unmasked_v1.rb +366 -0
- data/lib/straddle/models/customer_update_params.rb +239 -0
- data/lib/straddle/models/customer_v1.rb +371 -0
- data/lib/straddle/models/customers/customer_review_v1.rb +1091 -0
- data/lib/straddle/models/customers/identity_verification_breakdown_v1.rb +79 -0
- data/lib/straddle/models/customers/review_decision_params.rb +56 -0
- data/lib/straddle/models/customers/review_get_params.rb +34 -0
- data/lib/straddle/models/device_info_v1.rb +20 -0
- data/lib/straddle/models/device_unmasked_v1.rb +20 -0
- data/lib/straddle/models/embed/account_create_params.rb +106 -0
- data/lib/straddle/models/embed/account_get_params.rb +28 -0
- data/lib/straddle/models/embed/account_list_params.rb +116 -0
- data/lib/straddle/models/embed/account_onboard_params.rb +34 -0
- data/lib/straddle/models/embed/account_paged_v1.rb +561 -0
- data/lib/straddle/models/embed/account_simulate_params.rb +44 -0
- data/lib/straddle/models/embed/account_update_params.rb +58 -0
- data/lib/straddle/models/embed/account_v1.rb +557 -0
- data/lib/straddle/models/embed/accounts/capability_request_create_params.rb +227 -0
- data/lib/straddle/models/embed/accounts/capability_request_list_params.rb +139 -0
- data/lib/straddle/models/embed/accounts/capability_request_paged_v1.rb +201 -0
- data/lib/straddle/models/embed/address_v1.rb +84 -0
- data/lib/straddle/models/embed/business_profile_v1.rb +88 -0
- data/lib/straddle/models/embed/capability_v1.rb +28 -0
- data/lib/straddle/models/embed/industry_v1.rb +37 -0
- data/lib/straddle/models/embed/linked_bank_account_create_params.rb +90 -0
- data/lib/straddle/models/embed/linked_bank_account_get_params.rb +28 -0
- data/lib/straddle/models/embed/linked_bank_account_list_params.rb +98 -0
- data/lib/straddle/models/embed/linked_bank_account_paged_v1.rb +271 -0
- data/lib/straddle/models/embed/linked_bank_account_unmask_params.rb +28 -0
- data/lib/straddle/models/embed/linked_bank_account_unmask_v1.rb +262 -0
- data/lib/straddle/models/embed/linked_bank_account_update_params.rb +81 -0
- data/lib/straddle/models/embed/linked_bank_account_v1.rb +263 -0
- data/lib/straddle/models/embed/organization_create_params.rb +59 -0
- data/lib/straddle/models/embed/organization_get_params.rb +28 -0
- data/lib/straddle/models/embed/organization_list_params.rb +89 -0
- data/lib/straddle/models/embed/organization_paged_v1.rb +120 -0
- data/lib/straddle/models/embed/organization_v1.rb +121 -0
- data/lib/straddle/models/embed/representative.rb +351 -0
- data/lib/straddle/models/embed/representative_create_params.rb +160 -0
- data/lib/straddle/models/embed/representative_get_params.rb +28 -0
- data/lib/straddle/models/embed/representative_list_params.rb +112 -0
- data/lib/straddle/models/embed/representative_paged.rb +352 -0
- data/lib/straddle/models/embed/representative_unmask_params.rb +28 -0
- data/lib/straddle/models/embed/representative_update_params.rb +152 -0
- data/lib/straddle/models/embed/support_channels_v1.rb +34 -0
- data/lib/straddle/models/embed/terms_of_service_v1.rb +68 -0
- data/lib/straddle/models/funding_event_get_params.rb +32 -0
- data/lib/straddle/models/funding_event_list_params.rb +161 -0
- data/lib/straddle/models/funding_event_summary_item_v1.rb +167 -0
- data/lib/straddle/models/funding_event_summary_paged_v1.rb +249 -0
- data/lib/straddle/models/paged_response_metadata.rb +93 -0
- data/lib/straddle/models/paykey_cancel_params.rb +38 -0
- data/lib/straddle/models/paykey_details_v1.rb +45 -0
- data/lib/straddle/models/paykey_get_params.rb +32 -0
- data/lib/straddle/models/paykey_list_params.rb +137 -0
- data/lib/straddle/models/paykey_reveal_params.rb +32 -0
- data/lib/straddle/models/paykey_reveal_response.rb +405 -0
- data/lib/straddle/models/paykey_summary_paged_v1.rb +431 -0
- data/lib/straddle/models/paykey_unmasked_params.rb +32 -0
- data/lib/straddle/models/paykey_unmasked_v1.rb +399 -0
- data/lib/straddle/models/paykey_v1.rb +403 -0
- data/lib/straddle/models/payment_list_params.rb +361 -0
- data/lib/straddle/models/payment_summary_paged_v1.rb +325 -0
- data/lib/straddle/models/payout_cancel_params.rb +43 -0
- data/lib/straddle/models/payout_create_params.rb +145 -0
- data/lib/straddle/models/payout_get_params.rb +32 -0
- data/lib/straddle/models/payout_hold_params.rb +43 -0
- data/lib/straddle/models/payout_release_params.rb +43 -0
- data/lib/straddle/models/payout_unmask_params.rb +32 -0
- data/lib/straddle/models/payout_unmask_response.rb +433 -0
- data/lib/straddle/models/payout_update_params.rb +72 -0
- data/lib/straddle/models/payout_v1.rb +434 -0
- data/lib/straddle/models/report_create_total_customers_by_status_params.rb +32 -0
- data/lib/straddle/models/report_create_total_customers_by_status_response.rb +98 -0
- data/lib/straddle/models/response_metadata.rb +26 -0
- data/lib/straddle/models/status_details_v1.rb +102 -0
- data/lib/straddle/models.rb +149 -0
- data/lib/straddle/request_options.rb +77 -0
- data/lib/straddle/resources/bridge/link.rb +204 -0
- data/lib/straddle/resources/bridge.rb +58 -0
- data/lib/straddle/resources/charges.rb +305 -0
- data/lib/straddle/resources/customers/review.rb +99 -0
- data/lib/straddle/resources/customers.rb +349 -0
- data/lib/straddle/resources/embed/accounts/capability_requests.rb +115 -0
- data/lib/straddle/resources/embed/accounts.rb +251 -0
- data/lib/straddle/resources/embed/linked_bank_accounts.rb +199 -0
- data/lib/straddle/resources/embed/organizations.rb +129 -0
- data/lib/straddle/resources/embed/representatives.rb +233 -0
- data/lib/straddle/resources/embed.rb +30 -0
- data/lib/straddle/resources/funding_events.rb +114 -0
- data/lib/straddle/resources/paykeys.rb +207 -0
- data/lib/straddle/resources/payments.rb +131 -0
- data/lib/straddle/resources/payouts.rb +303 -0
- data/lib/straddle/resources/reports.rb +42 -0
- data/lib/straddle/version.rb +5 -0
- data/lib/straddle.rb +172 -0
- data/manifest.yaml +15 -0
- data/rbi/straddle/client.rbi +93 -0
- data/rbi/straddle/errors.rbi +178 -0
- data/rbi/straddle/file_part.rbi +37 -0
- data/rbi/straddle/internal/page_number_schema.rbi +79 -0
- data/rbi/straddle/internal/transport/base_client.rbi +293 -0
- data/rbi/straddle/internal/transport/pooled_net_requester.rbi +79 -0
- data/rbi/straddle/internal/type/array_of.rbi +104 -0
- data/rbi/straddle/internal/type/base_model.rbi +302 -0
- data/rbi/straddle/internal/type/base_page.rbi +42 -0
- data/rbi/straddle/internal/type/boolean.rbi +58 -0
- data/rbi/straddle/internal/type/converter.rbi +162 -0
- data/rbi/straddle/internal/type/enum.rbi +82 -0
- data/rbi/straddle/internal/type/file_input.rbi +59 -0
- data/rbi/straddle/internal/type/hash_of.rbi +104 -0
- data/rbi/straddle/internal/type/request_parameters.rbi +29 -0
- data/rbi/straddle/internal/type/union.rbi +121 -0
- data/rbi/straddle/internal/type/unknown.rbi +58 -0
- data/rbi/straddle/internal/util.rbi +487 -0
- data/rbi/straddle/internal.rbi +16 -0
- data/rbi/straddle/models/bridge/link_bank_account_params.rbi +248 -0
- data/rbi/straddle/models/bridge/link_create_paykey_params.rbi +196 -0
- data/rbi/straddle/models/bridge/link_create_paykey_response.rbi +976 -0
- data/rbi/straddle/models/bridge/link_create_tan_params.rbi +243 -0
- data/rbi/straddle/models/bridge/link_create_tan_response.rbi +972 -0
- data/rbi/straddle/models/bridge/link_plaid_params.rbi +192 -0
- data/rbi/straddle/models/bridge_initialize_params.rbi +169 -0
- data/rbi/straddle/models/bridge_token_v1.rbi +122 -0
- data/rbi/straddle/models/charge_cancel_params.rbi +70 -0
- data/rbi/straddle/models/charge_create_params.rbi +369 -0
- data/rbi/straddle/models/charge_get_params.rbi +62 -0
- data/rbi/straddle/models/charge_hold_params.rbi +70 -0
- data/rbi/straddle/models/charge_release_params.rbi +70 -0
- data/rbi/straddle/models/charge_unmask_params.rbi +62 -0
- data/rbi/straddle/models/charge_unmask_response.rbi +1078 -0
- data/rbi/straddle/models/charge_update_params.rbi +98 -0
- data/rbi/straddle/models/charge_v1.rbi +932 -0
- data/rbi/straddle/models/customer_address_v1.rbi +71 -0
- data/rbi/straddle/models/customer_create_params.rbi +542 -0
- data/rbi/straddle/models/customer_delete_params.rbi +62 -0
- data/rbi/straddle/models/customer_details_v1.rbi +101 -0
- data/rbi/straddle/models/customer_get_params.rbi +62 -0
- data/rbi/straddle/models/customer_list_params.rbi +306 -0
- data/rbi/straddle/models/customer_refresh_review_params.rbi +65 -0
- data/rbi/straddle/models/customer_summary_paged_v1.rbi +432 -0
- data/rbi/straddle/models/customer_unmasked_params.rbi +62 -0
- data/rbi/straddle/models/customer_unmasked_v1.rbi +700 -0
- data/rbi/straddle/models/customer_update_params.rbi +381 -0
- data/rbi/straddle/models/customer_v1.rbi +667 -0
- data/rbi/straddle/models/customers/customer_review_v1.rbi +2212 -0
- data/rbi/straddle/models/customers/identity_verification_breakdown_v1.rbi +194 -0
- data/rbi/straddle/models/customers/review_decision_params.rbi +110 -0
- data/rbi/straddle/models/customers/review_get_params.rbi +67 -0
- data/rbi/straddle/models/device_info_v1.rbi +29 -0
- data/rbi/straddle/models/device_unmasked_v1.rbi +29 -0
- data/rbi/straddle/models/embed/account_create_params.rbi +190 -0
- data/rbi/straddle/models/embed/account_get_params.rbi +54 -0
- data/rbi/straddle/models/embed/account_list_params.rbi +250 -0
- data/rbi/straddle/models/embed/account_onboard_params.rbi +71 -0
- data/rbi/straddle/models/embed/account_paged_v1.rbi +1193 -0
- data/rbi/straddle/models/embed/account_simulate_params.rbi +111 -0
- data/rbi/straddle/models/embed/account_update_params.rbi +91 -0
- data/rbi/straddle/models/embed/account_v1.rbi +1162 -0
- data/rbi/straddle/models/embed/accounts/capability_request_create_params.rbi +434 -0
- data/rbi/straddle/models/embed/accounts/capability_request_list_params.rbi +364 -0
- data/rbi/straddle/models/embed/accounts/capability_request_paged_v1.rbi +409 -0
- data/rbi/straddle/models/embed/address_v1.rbi +104 -0
- data/rbi/straddle/models/embed/business_profile_v1.rbi +125 -0
- data/rbi/straddle/models/embed/capability_v1.rbi +70 -0
- data/rbi/straddle/models/embed/industry_v1.rbi +55 -0
- data/rbi/straddle/models/embed/linked_bank_account_create_params.rbi +149 -0
- data/rbi/straddle/models/embed/linked_bank_account_get_params.rbi +54 -0
- data/rbi/straddle/models/embed/linked_bank_account_list_params.rbi +213 -0
- data/rbi/straddle/models/embed/linked_bank_account_paged_v1.rbi +539 -0
- data/rbi/straddle/models/embed/linked_bank_account_unmask_params.rbi +54 -0
- data/rbi/straddle/models/embed/linked_bank_account_unmask_v1.rbi +535 -0
- data/rbi/straddle/models/embed/linked_bank_account_update_params.rbi +139 -0
- data/rbi/straddle/models/embed/linked_bank_account_v1.rbi +532 -0
- data/rbi/straddle/models/embed/organization_create_params.rbi +86 -0
- data/rbi/straddle/models/embed/organization_get_params.rbi +54 -0
- data/rbi/straddle/models/embed/organization_list_params.rbi +169 -0
- data/rbi/straddle/models/embed/organization_paged_v1.rbi +206 -0
- data/rbi/straddle/models/embed/organization_v1.rbi +202 -0
- data/rbi/straddle/models/embed/representative.rbi +609 -0
- data/rbi/straddle/models/embed/representative_create_params.rbi +225 -0
- data/rbi/straddle/models/embed/representative_get_params.rbi +54 -0
- data/rbi/straddle/models/embed/representative_list_params.rbi +229 -0
- data/rbi/straddle/models/embed/representative_paged.rbi +623 -0
- data/rbi/straddle/models/embed/representative_unmask_params.rbi +54 -0
- data/rbi/straddle/models/embed/representative_update_params.rbi +217 -0
- data/rbi/straddle/models/embed/support_channels_v1.rbi +58 -0
- data/rbi/straddle/models/embed/terms_of_service_v1.rbi +113 -0
- data/rbi/straddle/models/funding_event_get_params.rbi +62 -0
- data/rbi/straddle/models/funding_event_list_params.rbi +311 -0
- data/rbi/straddle/models/funding_event_summary_item_v1.rbi +319 -0
- data/rbi/straddle/models/funding_event_summary_paged_v1.rbi +451 -0
- data/rbi/straddle/models/paged_response_metadata.rbi +125 -0
- data/rbi/straddle/models/paykey_cancel_params.rbi +68 -0
- data/rbi/straddle/models/paykey_details_v1.rbi +65 -0
- data/rbi/straddle/models/paykey_get_params.rbi +62 -0
- data/rbi/straddle/models/paykey_list_params.rbi +253 -0
- data/rbi/straddle/models/paykey_reveal_params.rbi +62 -0
- data/rbi/straddle/models/paykey_reveal_response.rbi +953 -0
- data/rbi/straddle/models/paykey_summary_paged_v1.rbi +926 -0
- data/rbi/straddle/models/paykey_unmasked_params.rbi +62 -0
- data/rbi/straddle/models/paykey_unmasked_v1.rbi +871 -0
- data/rbi/straddle/models/paykey_v1.rbi +800 -0
- data/rbi/straddle/models/payment_list_params.rbi +781 -0
- data/rbi/straddle/models/payment_summary_paged_v1.rbi +536 -0
- data/rbi/straddle/models/payout_cancel_params.rbi +70 -0
- data/rbi/straddle/models/payout_create_params.rbi +275 -0
- data/rbi/straddle/models/payout_get_params.rbi +62 -0
- data/rbi/straddle/models/payout_hold_params.rbi +70 -0
- data/rbi/straddle/models/payout_release_params.rbi +70 -0
- data/rbi/straddle/models/payout_unmask_params.rbi +62 -0
- data/rbi/straddle/models/payout_unmask_response.rbi +966 -0
- data/rbi/straddle/models/payout_update_params.rbi +98 -0
- data/rbi/straddle/models/payout_v1.rbi +836 -0
- data/rbi/straddle/models/report_create_total_customers_by_status_params.rbi +65 -0
- data/rbi/straddle/models/report_create_total_customers_by_status_response.rbi +191 -0
- data/rbi/straddle/models/response_metadata.rbi +42 -0
- data/rbi/straddle/models/status_details_v1.rbi +207 -0
- data/rbi/straddle/models.rbi +112 -0
- data/rbi/straddle/request_options.rbi +59 -0
- data/rbi/straddle/resources/bridge/link.rbi +175 -0
- data/rbi/straddle/resources/bridge.rbi +44 -0
- data/rbi/straddle/resources/charges.rbi +242 -0
- data/rbi/straddle/resources/customers/review.rbi +75 -0
- data/rbi/straddle/resources/customers.rbi +307 -0
- data/rbi/straddle/resources/embed/accounts/capability_requests.rbi +116 -0
- data/rbi/straddle/resources/embed/accounts.rbi +216 -0
- data/rbi/straddle/resources/embed/linked_bank_accounts.rbi +169 -0
- data/rbi/straddle/resources/embed/organizations.rbi +110 -0
- data/rbi/straddle/resources/embed/representatives.rbi +208 -0
- data/rbi/straddle/resources/embed.rbi +24 -0
- data/rbi/straddle/resources/funding_events.rbi +94 -0
- data/rbi/straddle/resources/paykeys.rbi +161 -0
- data/rbi/straddle/resources/payments.rbi +125 -0
- data/rbi/straddle/resources/payouts.rbi +237 -0
- data/rbi/straddle/resources/reports.rbi +31 -0
- data/rbi/straddle/version.rbi +5 -0
- data/sig/straddle/client.rbs +48 -0
- data/sig/straddle/errors.rbs +110 -0
- data/sig/straddle/file_part.rbs +21 -0
- data/sig/straddle/internal/page_number_schema.rbs +52 -0
- data/sig/straddle/internal/transport/base_client.rbs +131 -0
- data/sig/straddle/internal/transport/pooled_net_requester.rbs +45 -0
- data/sig/straddle/internal/type/array_of.rbs +48 -0
- data/sig/straddle/internal/type/base_model.rbs +102 -0
- data/sig/straddle/internal/type/base_page.rbs +24 -0
- data/sig/straddle/internal/type/boolean.rbs +26 -0
- data/sig/straddle/internal/type/converter.rbs +62 -0
- data/sig/straddle/internal/type/enum.rbs +32 -0
- data/sig/straddle/internal/type/file_input.rbs +25 -0
- data/sig/straddle/internal/type/hash_of.rbs +48 -0
- data/sig/straddle/internal/type/request_parameters.rbs +17 -0
- data/sig/straddle/internal/type/union.rbs +52 -0
- data/sig/straddle/internal/type/unknown.rbs +26 -0
- data/sig/straddle/internal/util.rbs +185 -0
- data/sig/straddle/internal.rbs +9 -0
- data/sig/straddle/models/bridge/link_bank_account_params.rbs +122 -0
- data/sig/straddle/models/bridge/link_create_paykey_params.rbs +101 -0
- data/sig/straddle/models/bridge/link_create_paykey_response.rbs +389 -0
- data/sig/straddle/models/bridge/link_create_tan_params.rbs +122 -0
- data/sig/straddle/models/bridge/link_create_tan_response.rbs +389 -0
- data/sig/straddle/models/bridge/link_plaid_params.rbs +101 -0
- data/sig/straddle/models/bridge_initialize_params.rbs +89 -0
- data/sig/straddle/models/bridge_token_v1.rbs +53 -0
- data/sig/straddle/models/charge_cancel_params.rbs +47 -0
- data/sig/straddle/models/charge_create_params.rbs +172 -0
- data/sig/straddle/models/charge_get_params.rbs +42 -0
- data/sig/straddle/models/charge_hold_params.rbs +47 -0
- data/sig/straddle/models/charge_release_params.rbs +47 -0
- data/sig/straddle/models/charge_unmask_params.rbs +42 -0
- data/sig/straddle/models/charge_unmask_response.rbs +437 -0
- data/sig/straddle/models/charge_update_params.rbs +62 -0
- data/sig/straddle/models/charge_v1.rbs +427 -0
- data/sig/straddle/models/customer_address_v1.rbs +40 -0
- data/sig/straddle/models/customer_create_params.rbs +235 -0
- data/sig/straddle/models/customer_delete_params.rbs +42 -0
- data/sig/straddle/models/customer_details_v1.rbs +51 -0
- data/sig/straddle/models/customer_get_params.rbs +42 -0
- data/sig/straddle/models/customer_list_params.rbs +182 -0
- data/sig/straddle/models/customer_refresh_review_params.rbs +42 -0
- data/sig/straddle/models/customer_summary_paged_v1.rbs +194 -0
- data/sig/straddle/models/customer_unmasked_params.rbs +42 -0
- data/sig/straddle/models/customer_unmasked_v1.rbs +285 -0
- data/sig/straddle/models/customer_update_params.rbs +173 -0
- data/sig/straddle/models/customer_v1.rbs +297 -0
- data/sig/straddle/models/customers/customer_review_v1.rbs +1001 -0
- data/sig/straddle/models/customers/identity_verification_breakdown_v1.rbs +81 -0
- data/sig/straddle/models/customers/review_decision_params.rbs +60 -0
- data/sig/straddle/models/customers/review_get_params.rbs +44 -0
- data/sig/straddle/models/device_info_v1.rbs +13 -0
- data/sig/straddle/models/device_unmasked_v1.rbs +13 -0
- data/sig/straddle/models/embed/account_create_params.rbs +89 -0
- data/sig/straddle/models/embed/account_get_params.rbs +34 -0
- data/sig/straddle/models/embed/account_list_params.rbs +127 -0
- data/sig/straddle/models/embed/account_onboard_params.rbs +42 -0
- data/sig/straddle/models/embed/account_paged_v1.rbs +493 -0
- data/sig/straddle/models/embed/account_simulate_params.rbs +57 -0
- data/sig/straddle/models/embed/account_update_params.rbs +52 -0
- data/sig/straddle/models/embed/account_v1.rbs +493 -0
- data/sig/straddle/models/embed/accounts/capability_request_create_params.rbs +207 -0
- data/sig/straddle/models/embed/accounts/capability_request_list_params.rbs +153 -0
- data/sig/straddle/models/embed/accounts/capability_request_paged_v1.rbs +153 -0
- data/sig/straddle/models/embed/address_v1.rbs +62 -0
- data/sig/straddle/models/embed/business_profile_v1.rbs +75 -0
- data/sig/straddle/models/embed/capability_v1.rbs +33 -0
- data/sig/straddle/models/embed/industry_v1.rbs +23 -0
- data/sig/straddle/models/embed/linked_bank_account_create_params.rbs +79 -0
- data/sig/straddle/models/embed/linked_bank_account_get_params.rbs +34 -0
- data/sig/straddle/models/embed/linked_bank_account_list_params.rbs +105 -0
- data/sig/straddle/models/embed/linked_bank_account_paged_v1.rbs +215 -0
- data/sig/straddle/models/embed/linked_bank_account_unmask_params.rbs +34 -0
- data/sig/straddle/models/embed/linked_bank_account_unmask_v1.rbs +210 -0
- data/sig/straddle/models/embed/linked_bank_account_update_params.rbs +74 -0
- data/sig/straddle/models/embed/linked_bank_account_v1.rbs +215 -0
- data/sig/straddle/models/embed/organization_create_params.rbs +52 -0
- data/sig/straddle/models/embed/organization_get_params.rbs +34 -0
- data/sig/straddle/models/embed/organization_list_params.rbs +92 -0
- data/sig/straddle/models/embed/organization_paged_v1.rbs +87 -0
- data/sig/straddle/models/embed/organization_v1.rbs +87 -0
- data/sig/straddle/models/embed/representative.rbs +260 -0
- data/sig/straddle/models/embed/representative_create_params.rbs +119 -0
- data/sig/straddle/models/embed/representative_get_params.rbs +34 -0
- data/sig/straddle/models/embed/representative_list_params.rbs +119 -0
- data/sig/straddle/models/embed/representative_paged.rbs +260 -0
- data/sig/straddle/models/embed/representative_unmask_params.rbs +34 -0
- data/sig/straddle/models/embed/representative_update_params.rbs +114 -0
- data/sig/straddle/models/embed/support_channels_v1.rbs +24 -0
- data/sig/straddle/models/embed/terms_of_service_v1.rbs +53 -0
- data/sig/straddle/models/funding_event_get_params.rbs +42 -0
- data/sig/straddle/models/funding_event_list_params.rbs +155 -0
- data/sig/straddle/models/funding_event_summary_item_v1.rbs +123 -0
- data/sig/straddle/models/funding_event_summary_paged_v1.rbs +191 -0
- data/sig/straddle/models/paged_response_metadata.rbs +71 -0
- data/sig/straddle/models/paykey_cancel_params.rbs +47 -0
- data/sig/straddle/models/paykey_details_v1.rbs +30 -0
- data/sig/straddle/models/paykey_get_params.rbs +42 -0
- data/sig/straddle/models/paykey_list_params.rbs +151 -0
- data/sig/straddle/models/paykey_reveal_params.rbs +42 -0
- data/sig/straddle/models/paykey_reveal_response.rbs +386 -0
- data/sig/straddle/models/paykey_summary_paged_v1.rbs +401 -0
- data/sig/straddle/models/paykey_unmasked_params.rbs +42 -0
- data/sig/straddle/models/paykey_unmasked_v1.rbs +386 -0
- data/sig/straddle/models/paykey_v1.rbs +386 -0
- data/sig/straddle/models/payment_list_params.rbs +391 -0
- data/sig/straddle/models/payment_summary_paged_v1.rbs +252 -0
- data/sig/straddle/models/payout_cancel_params.rbs +47 -0
- data/sig/straddle/models/payout_create_params.rbs +143 -0
- data/sig/straddle/models/payout_get_params.rbs +42 -0
- data/sig/straddle/models/payout_hold_params.rbs +47 -0
- data/sig/straddle/models/payout_release_params.rbs +47 -0
- data/sig/straddle/models/payout_unmask_params.rbs +42 -0
- data/sig/straddle/models/payout_unmask_response.rbs +404 -0
- data/sig/straddle/models/payout_update_params.rbs +62 -0
- data/sig/straddle/models/payout_v1.rbs +394 -0
- data/sig/straddle/models/report_create_total_customers_by_status_params.rbs +42 -0
- data/sig/straddle/models/report_create_total_customers_by_status_response.rbs +80 -0
- data/sig/straddle/models/response_metadata.rbs +19 -0
- data/sig/straddle/models/status_details_v1.rbs +104 -0
- data/sig/straddle/models.rbs +109 -0
- data/sig/straddle/request_options.rbs +34 -0
- data/sig/straddle/resources/bridge/link.rbs +57 -0
- data/sig/straddle/resources/bridge.rbs +18 -0
- data/sig/straddle/resources/charges.rbs +79 -0
- data/sig/straddle/resources/customers/review.rbs +26 -0
- data/sig/straddle/resources/customers.rbs +94 -0
- data/sig/straddle/resources/embed/accounts/capability_requests.rbs +38 -0
- data/sig/straddle/resources/embed/accounts.rbs +69 -0
- data/sig/straddle/resources/embed/linked_bank_accounts.rbs +53 -0
- data/sig/straddle/resources/embed/organizations.rbs +37 -0
- data/sig/straddle/resources/embed/representatives.rbs +67 -0
- data/sig/straddle/resources/embed.rbs +15 -0
- data/sig/straddle/resources/funding_events.rbs +31 -0
- data/sig/straddle/resources/paykeys.rbs +54 -0
- data/sig/straddle/resources/payments.rbs +40 -0
- data/sig/straddle/resources/payouts.rbs +78 -0
- data/sig/straddle/resources/reports.rbs +14 -0
- data/sig/straddle/version.rbs +3 -0
- metadata +485 -0
|
@@ -0,0 +1,361 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Straddle
|
|
4
|
+
module Models
|
|
5
|
+
# @see Straddle::Resources::Payments#list
|
|
6
|
+
class PaymentListParams < Straddle::Internal::Type::BaseModel
|
|
7
|
+
extend Straddle::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Straddle::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute customer_id
|
|
11
|
+
# Search using the `customer_id` of a `charge` or `payout`.
|
|
12
|
+
#
|
|
13
|
+
# @return [String, nil]
|
|
14
|
+
optional :customer_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute default_page_size
|
|
17
|
+
#
|
|
18
|
+
# @return [Integer, nil]
|
|
19
|
+
optional :default_page_size, Integer
|
|
20
|
+
|
|
21
|
+
# @!attribute default_sort
|
|
22
|
+
# The field to sort the results by.
|
|
23
|
+
#
|
|
24
|
+
# @return [Symbol, Straddle::Models::PaymentListParams::DefaultSort, nil]
|
|
25
|
+
optional :default_sort, enum: -> { Straddle::PaymentListParams::DefaultSort }
|
|
26
|
+
|
|
27
|
+
# @!attribute default_sort_order
|
|
28
|
+
#
|
|
29
|
+
# @return [Symbol, Straddle::Models::PaymentListParams::DefaultSortOrder, nil]
|
|
30
|
+
optional :default_sort_order, enum: -> { Straddle::PaymentListParams::DefaultSortOrder }
|
|
31
|
+
|
|
32
|
+
# @!attribute external_id
|
|
33
|
+
# Search using the `external_id` of a `charge` or `payout`.
|
|
34
|
+
#
|
|
35
|
+
# @return [String, nil]
|
|
36
|
+
optional :external_id, String
|
|
37
|
+
|
|
38
|
+
# @!attribute funding_id
|
|
39
|
+
# Search using the `funding_id` of a `charge` or `payout`.
|
|
40
|
+
#
|
|
41
|
+
# @return [String, nil]
|
|
42
|
+
optional :funding_id, String
|
|
43
|
+
|
|
44
|
+
# @!attribute max_amount
|
|
45
|
+
# Search using a maximum `amount` of a `charge` or `payout`.
|
|
46
|
+
#
|
|
47
|
+
# @return [Integer, nil]
|
|
48
|
+
optional :max_amount, Integer
|
|
49
|
+
|
|
50
|
+
# @!attribute max_created_at
|
|
51
|
+
# Search using the latest `created_at` date of a `charge` or `payout`.
|
|
52
|
+
#
|
|
53
|
+
# @return [Time, nil]
|
|
54
|
+
optional :max_created_at, Time
|
|
55
|
+
|
|
56
|
+
# @!attribute max_effective_at
|
|
57
|
+
# Search using the latest `effective_date` of a `charge` or `payout`.
|
|
58
|
+
#
|
|
59
|
+
# @return [Time, nil]
|
|
60
|
+
optional :max_effective_at, Time
|
|
61
|
+
|
|
62
|
+
# @!attribute max_payment_date
|
|
63
|
+
# Search using the latest `payment_date` of a `charge` or `payout`.
|
|
64
|
+
#
|
|
65
|
+
# @return [Date, nil]
|
|
66
|
+
optional :max_payment_date, Date
|
|
67
|
+
|
|
68
|
+
# @!attribute min_amount
|
|
69
|
+
# Search using the minimum `amount of a `charge`or`payout`.
|
|
70
|
+
#
|
|
71
|
+
# @return [Integer, nil]
|
|
72
|
+
optional :min_amount, Integer
|
|
73
|
+
|
|
74
|
+
# @!attribute min_created_at
|
|
75
|
+
# Search using the earliest `created_at` date of a `charge` or `payout`.
|
|
76
|
+
#
|
|
77
|
+
# @return [Time, nil]
|
|
78
|
+
optional :min_created_at, Time
|
|
79
|
+
|
|
80
|
+
# @!attribute min_effective_at
|
|
81
|
+
# Search using the earliest `effective_date` of a `charge` or `payout`.
|
|
82
|
+
#
|
|
83
|
+
# @return [Time, nil]
|
|
84
|
+
optional :min_effective_at, Time
|
|
85
|
+
|
|
86
|
+
# @!attribute min_payment_date
|
|
87
|
+
# Search using the earliest ` `of a `charge` or `payout`.
|
|
88
|
+
#
|
|
89
|
+
# @return [Date, nil]
|
|
90
|
+
optional :min_payment_date, Date
|
|
91
|
+
|
|
92
|
+
# @!attribute page_number
|
|
93
|
+
# Results page number. Starts at page 1.
|
|
94
|
+
#
|
|
95
|
+
# @return [Integer, nil]
|
|
96
|
+
optional :page_number, Integer
|
|
97
|
+
|
|
98
|
+
# @!attribute page_size
|
|
99
|
+
# Results page size. Max value: 1000
|
|
100
|
+
#
|
|
101
|
+
# @return [Integer, nil]
|
|
102
|
+
optional :page_size, Integer
|
|
103
|
+
|
|
104
|
+
# @!attribute paykey
|
|
105
|
+
# Search using the `paykey` of a `charge` or `payout`.
|
|
106
|
+
#
|
|
107
|
+
# @return [String, nil]
|
|
108
|
+
optional :paykey, String
|
|
109
|
+
|
|
110
|
+
# @!attribute paykey_id
|
|
111
|
+
# Search using the `paykey_id` of a `charge` or `payout`.
|
|
112
|
+
#
|
|
113
|
+
# @return [String, nil]
|
|
114
|
+
optional :paykey_id, String
|
|
115
|
+
|
|
116
|
+
# @!attribute payment_id
|
|
117
|
+
# Search using the `id` of a `charge` or `payout`.
|
|
118
|
+
#
|
|
119
|
+
# @return [String, nil]
|
|
120
|
+
optional :payment_id, String
|
|
121
|
+
|
|
122
|
+
# @!attribute payment_status
|
|
123
|
+
# Search by the status of a `charge` or `payout`.
|
|
124
|
+
#
|
|
125
|
+
# @return [Array<Symbol, Straddle::Models::PaymentListParams::PaymentStatus>, nil]
|
|
126
|
+
optional :payment_status,
|
|
127
|
+
-> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaymentListParams::PaymentStatus] }
|
|
128
|
+
|
|
129
|
+
# @!attribute payment_type
|
|
130
|
+
# Search by the type of a `charge` or `payout`.
|
|
131
|
+
#
|
|
132
|
+
# @return [Array<Symbol, Straddle::Models::PaymentListParams::PaymentType>, nil]
|
|
133
|
+
optional :payment_type,
|
|
134
|
+
-> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaymentListParams::PaymentType] }
|
|
135
|
+
|
|
136
|
+
# @!attribute search_text
|
|
137
|
+
# Search using a text string associated with a `charge` or `payout`.
|
|
138
|
+
#
|
|
139
|
+
# @return [String, nil]
|
|
140
|
+
optional :search_text, String
|
|
141
|
+
|
|
142
|
+
# @!attribute sort_by
|
|
143
|
+
# The field to sort the results by.
|
|
144
|
+
#
|
|
145
|
+
# @return [Symbol, Straddle::Models::PaymentListParams::SortBy, nil]
|
|
146
|
+
optional :sort_by, enum: -> { Straddle::PaymentListParams::SortBy }
|
|
147
|
+
|
|
148
|
+
# @!attribute sort_order
|
|
149
|
+
#
|
|
150
|
+
# @return [Symbol, Straddle::Models::PaymentListParams::SortOrder, nil]
|
|
151
|
+
optional :sort_order, enum: -> { Straddle::PaymentListParams::SortOrder }
|
|
152
|
+
|
|
153
|
+
# @!attribute status_reason
|
|
154
|
+
# Reason for latest payment status change.
|
|
155
|
+
#
|
|
156
|
+
# @return [Array<Symbol, Straddle::Models::PaymentListParams::StatusReason>, nil]
|
|
157
|
+
optional :status_reason,
|
|
158
|
+
-> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaymentListParams::StatusReason] }
|
|
159
|
+
|
|
160
|
+
# @!attribute status_source
|
|
161
|
+
# Source of latest payment status change.
|
|
162
|
+
#
|
|
163
|
+
# @return [Array<Symbol, Straddle::Models::PaymentListParams::StatusSource>, nil]
|
|
164
|
+
optional :status_source,
|
|
165
|
+
-> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaymentListParams::StatusSource] }
|
|
166
|
+
|
|
167
|
+
# @!attribute correlation_id
|
|
168
|
+
#
|
|
169
|
+
# @return [String, nil]
|
|
170
|
+
optional :correlation_id, String
|
|
171
|
+
|
|
172
|
+
# @!attribute request_id
|
|
173
|
+
#
|
|
174
|
+
# @return [String, nil]
|
|
175
|
+
optional :request_id, String
|
|
176
|
+
|
|
177
|
+
# @!attribute straddle_account_id
|
|
178
|
+
#
|
|
179
|
+
# @return [String, nil]
|
|
180
|
+
optional :straddle_account_id, String
|
|
181
|
+
|
|
182
|
+
# @!method initialize(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
183
|
+
# @param customer_id [String] Search using the `customer_id` of a `charge` or `payout`.
|
|
184
|
+
#
|
|
185
|
+
# @param default_page_size [Integer]
|
|
186
|
+
#
|
|
187
|
+
# @param default_sort [Symbol, Straddle::Models::PaymentListParams::DefaultSort] The field to sort the results by.
|
|
188
|
+
#
|
|
189
|
+
# @param default_sort_order [Symbol, Straddle::Models::PaymentListParams::DefaultSortOrder]
|
|
190
|
+
#
|
|
191
|
+
# @param external_id [String] Search using the `external_id` of a `charge` or `payout`.
|
|
192
|
+
#
|
|
193
|
+
# @param funding_id [String] Search using the `funding_id` of a `charge` or `payout`.
|
|
194
|
+
#
|
|
195
|
+
# @param max_amount [Integer] Search using a maximum `amount` of a `charge` or `payout`.
|
|
196
|
+
#
|
|
197
|
+
# @param max_created_at [Time] Search using the latest `created_at` date of a `charge` or `payout`.
|
|
198
|
+
#
|
|
199
|
+
# @param max_effective_at [Time] Search using the latest `effective_date` of a `charge` or `payout`.
|
|
200
|
+
#
|
|
201
|
+
# @param max_payment_date [Date] Search using the latest `payment_date` of a `charge` or `payout`.
|
|
202
|
+
#
|
|
203
|
+
# @param min_amount [Integer] Search using the minimum `amount of a `charge`or`payout`.
|
|
204
|
+
#
|
|
205
|
+
# @param min_created_at [Time] Search using the earliest `created_at` date of a `charge` or `payout`.
|
|
206
|
+
#
|
|
207
|
+
# @param min_effective_at [Time] Search using the earliest `effective_date` of a `charge` or `payout`.
|
|
208
|
+
#
|
|
209
|
+
# @param min_payment_date [Date] Search using the earliest ` `of a `charge` or `payout`.
|
|
210
|
+
#
|
|
211
|
+
# @param page_number [Integer] Results page number. Starts at page 1.
|
|
212
|
+
#
|
|
213
|
+
# @param page_size [Integer] Results page size. Max value: 1000
|
|
214
|
+
#
|
|
215
|
+
# @param paykey [String] Search using the `paykey` of a `charge` or `payout`.
|
|
216
|
+
#
|
|
217
|
+
# @param paykey_id [String] Search using the `paykey_id` of a `charge` or `payout`.
|
|
218
|
+
#
|
|
219
|
+
# @param payment_id [String] Search using the `id` of a `charge` or `payout`.
|
|
220
|
+
#
|
|
221
|
+
# @param payment_status [Array<Symbol, Straddle::Models::PaymentListParams::PaymentStatus>] Search by the status of a `charge` or `payout`.
|
|
222
|
+
#
|
|
223
|
+
# @param payment_type [Array<Symbol, Straddle::Models::PaymentListParams::PaymentType>] Search by the type of a `charge` or `payout`.
|
|
224
|
+
#
|
|
225
|
+
# @param search_text [String] Search using a text string associated with a `charge` or `payout`.
|
|
226
|
+
#
|
|
227
|
+
# @param sort_by [Symbol, Straddle::Models::PaymentListParams::SortBy] The field to sort the results by.
|
|
228
|
+
#
|
|
229
|
+
# @param sort_order [Symbol, Straddle::Models::PaymentListParams::SortOrder]
|
|
230
|
+
#
|
|
231
|
+
# @param status_reason [Array<Symbol, Straddle::Models::PaymentListParams::StatusReason>] Reason for latest payment status change.
|
|
232
|
+
#
|
|
233
|
+
# @param status_source [Array<Symbol, Straddle::Models::PaymentListParams::StatusSource>] Source of latest payment status change.
|
|
234
|
+
#
|
|
235
|
+
# @param correlation_id [String]
|
|
236
|
+
#
|
|
237
|
+
# @param request_id [String]
|
|
238
|
+
#
|
|
239
|
+
# @param straddle_account_id [String]
|
|
240
|
+
#
|
|
241
|
+
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
|
|
242
|
+
|
|
243
|
+
# The field to sort the results by.
|
|
244
|
+
module DefaultSort
|
|
245
|
+
extend Straddle::Internal::Type::Enum
|
|
246
|
+
|
|
247
|
+
CREATED_AT = :created_at
|
|
248
|
+
PAYMENT_DATE = :payment_date
|
|
249
|
+
EFFECTIVE_AT = :effective_at
|
|
250
|
+
ID = :id
|
|
251
|
+
AMOUNT = :amount
|
|
252
|
+
|
|
253
|
+
# @!method self.values
|
|
254
|
+
# @return [Array<Symbol>]
|
|
255
|
+
end
|
|
256
|
+
|
|
257
|
+
module DefaultSortOrder
|
|
258
|
+
extend Straddle::Internal::Type::Enum
|
|
259
|
+
|
|
260
|
+
ASC = :asc
|
|
261
|
+
DESC = :desc
|
|
262
|
+
|
|
263
|
+
# @!method self.values
|
|
264
|
+
# @return [Array<Symbol>]
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
# The current status of the `charge` or `payout`.
|
|
268
|
+
module PaymentStatus
|
|
269
|
+
extend Straddle::Internal::Type::Enum
|
|
270
|
+
|
|
271
|
+
CREATED = :created
|
|
272
|
+
SCHEDULED = :scheduled
|
|
273
|
+
FAILED = :failed
|
|
274
|
+
CANCELLED = :cancelled
|
|
275
|
+
ON_HOLD = :on_hold
|
|
276
|
+
PENDING = :pending
|
|
277
|
+
PAID = :paid
|
|
278
|
+
REVERSED = :reversed
|
|
279
|
+
|
|
280
|
+
# @!method self.values
|
|
281
|
+
# @return [Array<Symbol>]
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
# The type of payment.
|
|
285
|
+
module PaymentType
|
|
286
|
+
extend Straddle::Internal::Type::Enum
|
|
287
|
+
|
|
288
|
+
CHARGE = :charge
|
|
289
|
+
PAYOUT = :payout
|
|
290
|
+
|
|
291
|
+
# @!method self.values
|
|
292
|
+
# @return [Array<Symbol>]
|
|
293
|
+
end
|
|
294
|
+
|
|
295
|
+
# The field to sort the results by.
|
|
296
|
+
module SortBy
|
|
297
|
+
extend Straddle::Internal::Type::Enum
|
|
298
|
+
|
|
299
|
+
CREATED_AT = :created_at
|
|
300
|
+
PAYMENT_DATE = :payment_date
|
|
301
|
+
EFFECTIVE_AT = :effective_at
|
|
302
|
+
ID = :id
|
|
303
|
+
AMOUNT = :amount
|
|
304
|
+
|
|
305
|
+
# @!method self.values
|
|
306
|
+
# @return [Array<Symbol>]
|
|
307
|
+
end
|
|
308
|
+
|
|
309
|
+
module SortOrder
|
|
310
|
+
extend Straddle::Internal::Type::Enum
|
|
311
|
+
|
|
312
|
+
ASC = :asc
|
|
313
|
+
DESC = :desc
|
|
314
|
+
|
|
315
|
+
# @!method self.values
|
|
316
|
+
# @return [Array<Symbol>]
|
|
317
|
+
end
|
|
318
|
+
|
|
319
|
+
module StatusReason
|
|
320
|
+
extend Straddle::Internal::Type::Enum
|
|
321
|
+
|
|
322
|
+
INSUFFICIENT_FUNDS = :insufficient_funds
|
|
323
|
+
CLOSED_BANK_ACCOUNT = :closed_bank_account
|
|
324
|
+
INVALID_BANK_ACCOUNT = :invalid_bank_account
|
|
325
|
+
INVALID_ROUTING = :invalid_routing
|
|
326
|
+
DISPUTED = :disputed
|
|
327
|
+
PAYMENT_STOPPED = :payment_stopped
|
|
328
|
+
OWNER_DECEASED = :owner_deceased
|
|
329
|
+
FROZEN_BANK_ACCOUNT = :frozen_bank_account
|
|
330
|
+
RISK_REVIEW = :risk_review
|
|
331
|
+
FRAUDULENT = :fraudulent
|
|
332
|
+
DUPLICATE_ENTRY = :duplicate_entry
|
|
333
|
+
INVALID_PAYKEY = :invalid_paykey
|
|
334
|
+
PAYMENT_BLOCKED = :payment_blocked
|
|
335
|
+
AMOUNT_TOO_LARGE = :amount_too_large
|
|
336
|
+
TOO_MANY_ATTEMPTS = :too_many_attempts
|
|
337
|
+
INTERNAL_SYSTEM_ERROR = :internal_system_error
|
|
338
|
+
USER_REQUEST = :user_request
|
|
339
|
+
OK = :ok
|
|
340
|
+
OTHER_NETWORK_RETURN = :other_network_return
|
|
341
|
+
PAYOUT_REFUSED = :payout_refused
|
|
342
|
+
|
|
343
|
+
# @!method self.values
|
|
344
|
+
# @return [Array<Symbol>]
|
|
345
|
+
end
|
|
346
|
+
|
|
347
|
+
module StatusSource
|
|
348
|
+
extend Straddle::Internal::Type::Enum
|
|
349
|
+
|
|
350
|
+
WATCHTOWER = :watchtower
|
|
351
|
+
BANK_DECLINE = :bank_decline
|
|
352
|
+
CUSTOMER_DISPUTE = :customer_dispute
|
|
353
|
+
USER_ACTION = :user_action
|
|
354
|
+
SYSTEM = :system
|
|
355
|
+
|
|
356
|
+
# @!method self.values
|
|
357
|
+
# @return [Array<Symbol>]
|
|
358
|
+
end
|
|
359
|
+
end
|
|
360
|
+
end
|
|
361
|
+
end
|
|
@@ -0,0 +1,325 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Straddle
|
|
4
|
+
module Models
|
|
5
|
+
class PaymentSummaryPagedV1 < Straddle::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute data
|
|
7
|
+
#
|
|
8
|
+
# @return [Array<Straddle::Models::PaymentSummaryPagedV1::Data>]
|
|
9
|
+
required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::PaymentSummaryPagedV1::Data] }
|
|
10
|
+
|
|
11
|
+
# @!attribute meta
|
|
12
|
+
#
|
|
13
|
+
# @return [Straddle::Models::PaymentSummaryPagedV1::Meta]
|
|
14
|
+
required :meta, -> { Straddle::PaymentSummaryPagedV1::Meta }
|
|
15
|
+
|
|
16
|
+
# @!attribute response_type
|
|
17
|
+
# Indicates the structure of the returned content.
|
|
18
|
+
#
|
|
19
|
+
# - "object" means the `data` field contains a single JSON object.
|
|
20
|
+
# - "array" means the `data` field contains an array of objects.
|
|
21
|
+
# - "error" means the `data` field contains an error object with details of the
|
|
22
|
+
# issue.
|
|
23
|
+
# - "none" means no data is returned.
|
|
24
|
+
#
|
|
25
|
+
# @return [Symbol, Straddle::Models::PaymentSummaryPagedV1::ResponseType]
|
|
26
|
+
required :response_type, enum: -> { Straddle::PaymentSummaryPagedV1::ResponseType }
|
|
27
|
+
|
|
28
|
+
# @!method initialize(data:, meta:, response_type:)
|
|
29
|
+
# Some parameter documentations has been truncated, see
|
|
30
|
+
# {Straddle::Models::PaymentSummaryPagedV1} for more details.
|
|
31
|
+
#
|
|
32
|
+
# @param data [Array<Straddle::Models::PaymentSummaryPagedV1::Data>]
|
|
33
|
+
#
|
|
34
|
+
# @param meta [Straddle::Models::PaymentSummaryPagedV1::Meta]
|
|
35
|
+
#
|
|
36
|
+
# @param response_type [Symbol, Straddle::Models::PaymentSummaryPagedV1::ResponseType] Indicates the structure of the returned content.
|
|
37
|
+
|
|
38
|
+
class Data < Straddle::Internal::Type::BaseModel
|
|
39
|
+
# @!attribute id
|
|
40
|
+
# Unique identifier for the `charge` or `payout`.
|
|
41
|
+
#
|
|
42
|
+
# @return [String]
|
|
43
|
+
required :id, String
|
|
44
|
+
|
|
45
|
+
# @!attribute amount
|
|
46
|
+
# The amount of the `charge` or `payout` in cents.
|
|
47
|
+
#
|
|
48
|
+
# @return [Integer]
|
|
49
|
+
required :amount, Integer
|
|
50
|
+
|
|
51
|
+
# @!attribute created_at
|
|
52
|
+
# The time the `charge` or `payout` was created.
|
|
53
|
+
#
|
|
54
|
+
# @return [Time]
|
|
55
|
+
required :created_at, Time
|
|
56
|
+
|
|
57
|
+
# @!attribute currency
|
|
58
|
+
# The currency of the `charge` or `payout`. Only USD is supported.
|
|
59
|
+
#
|
|
60
|
+
# @return [String]
|
|
61
|
+
required :currency, String
|
|
62
|
+
|
|
63
|
+
# @!attribute description
|
|
64
|
+
# An arbitrary description for the `charge` or `payout`.
|
|
65
|
+
#
|
|
66
|
+
# @return [String]
|
|
67
|
+
required :description, String
|
|
68
|
+
|
|
69
|
+
# @!attribute external_id
|
|
70
|
+
# Unique identifier for the `charge` or `payout` in your database. This value must
|
|
71
|
+
# be unique across all charges or payouts.
|
|
72
|
+
#
|
|
73
|
+
# @return [String]
|
|
74
|
+
required :external_id, String
|
|
75
|
+
|
|
76
|
+
# @!attribute funding_ids
|
|
77
|
+
# Funding ids.
|
|
78
|
+
#
|
|
79
|
+
# @return [Array<String>]
|
|
80
|
+
required :funding_ids, Straddle::Internal::Type::ArrayOf[String]
|
|
81
|
+
|
|
82
|
+
# @!attribute paykey
|
|
83
|
+
# Value of the `paykey` used for the `charge` or `payout`.
|
|
84
|
+
#
|
|
85
|
+
# @return [String]
|
|
86
|
+
required :paykey, String
|
|
87
|
+
|
|
88
|
+
# @!attribute payment_date
|
|
89
|
+
# The desired date on which the payment should be occur. For charges, this means
|
|
90
|
+
# the date you want the customer to be debited on. For payouts, this means the
|
|
91
|
+
# date you want the funds to be sent from your bank account.
|
|
92
|
+
#
|
|
93
|
+
# @return [Date]
|
|
94
|
+
required :payment_date, Date
|
|
95
|
+
|
|
96
|
+
# @!attribute payment_type
|
|
97
|
+
# The type of payment. Valid values are `charge` or `payout`.
|
|
98
|
+
#
|
|
99
|
+
# @return [Symbol, Straddle::Models::PaymentSummaryPagedV1::Data::PaymentType]
|
|
100
|
+
required :payment_type, enum: -> { Straddle::PaymentSummaryPagedV1::Data::PaymentType }
|
|
101
|
+
|
|
102
|
+
# @!attribute status
|
|
103
|
+
# The current status of the `charge` or `payout`.
|
|
104
|
+
#
|
|
105
|
+
# @return [Symbol, Straddle::Models::PaymentSummaryPagedV1::Data::Status]
|
|
106
|
+
required :status, enum: -> { Straddle::PaymentSummaryPagedV1::Data::Status }
|
|
107
|
+
|
|
108
|
+
# @!attribute status_details
|
|
109
|
+
# Details about the current status of the `charge` or `payout`.
|
|
110
|
+
#
|
|
111
|
+
# @return [Straddle::Models::StatusDetailsV1]
|
|
112
|
+
required :status_details, -> { Straddle::StatusDetailsV1 }
|
|
113
|
+
|
|
114
|
+
# @!attribute updated_at
|
|
115
|
+
# The time the `charge` or `payout` was last updated.
|
|
116
|
+
#
|
|
117
|
+
# @return [Time]
|
|
118
|
+
required :updated_at, Time
|
|
119
|
+
|
|
120
|
+
# @!attribute customer_details
|
|
121
|
+
# Information about the customer associated with the charge or payout.
|
|
122
|
+
#
|
|
123
|
+
# @return [Straddle::Models::CustomerDetailsV1, nil]
|
|
124
|
+
optional :customer_details, -> { Straddle::CustomerDetailsV1 }
|
|
125
|
+
|
|
126
|
+
# @!attribute effective_at
|
|
127
|
+
# The actual date on which the payment occurred. For charges, this is the date the
|
|
128
|
+
# customer was debited. For payouts, this is the date the funds were sent from
|
|
129
|
+
# your bank account.
|
|
130
|
+
#
|
|
131
|
+
# @return [Time, nil]
|
|
132
|
+
optional :effective_at, Time, nil?: true
|
|
133
|
+
|
|
134
|
+
# @!attribute funding_id
|
|
135
|
+
# Unique identifier for the funding event associated with the `charge` or
|
|
136
|
+
# `payout`.
|
|
137
|
+
#
|
|
138
|
+
# @return [String, nil]
|
|
139
|
+
optional :funding_id, String, nil?: true
|
|
140
|
+
|
|
141
|
+
# @!attribute paykey_details
|
|
142
|
+
# Information about the paykey used for the `charge` or `payout`.
|
|
143
|
+
#
|
|
144
|
+
# @return [Straddle::Models::PaykeyDetailsV1, nil]
|
|
145
|
+
optional :paykey_details, -> { Straddle::PaykeyDetailsV1 }
|
|
146
|
+
|
|
147
|
+
# @!method initialize(id:, amount:, created_at:, currency:, description:, external_id:, funding_ids:, paykey:, payment_date:, payment_type:, status:, status_details:, updated_at:, customer_details: nil, effective_at: nil, funding_id: nil, paykey_details: nil)
|
|
148
|
+
# Some parameter documentations has been truncated, see
|
|
149
|
+
# {Straddle::Models::PaymentSummaryPagedV1::Data} for more details.
|
|
150
|
+
#
|
|
151
|
+
# @param id [String] Unique identifier for the `charge` or `payout`.
|
|
152
|
+
#
|
|
153
|
+
# @param amount [Integer] The amount of the `charge` or `payout` in cents.
|
|
154
|
+
#
|
|
155
|
+
# @param created_at [Time] The time the `charge` or `payout` was created.
|
|
156
|
+
#
|
|
157
|
+
# @param currency [String] The currency of the `charge` or `payout`. Only USD is supported.
|
|
158
|
+
#
|
|
159
|
+
# @param description [String] An arbitrary description for the `charge` or `payout`.
|
|
160
|
+
#
|
|
161
|
+
# @param external_id [String] Unique identifier for the `charge` or `payout` in your database. This value must
|
|
162
|
+
#
|
|
163
|
+
# @param funding_ids [Array<String>] Funding ids.
|
|
164
|
+
#
|
|
165
|
+
# @param paykey [String] Value of the `paykey` used for the `charge` or `payout`.
|
|
166
|
+
#
|
|
167
|
+
# @param payment_date [Date] The desired date on which the payment should be occur. For charges, this means t
|
|
168
|
+
#
|
|
169
|
+
# @param payment_type [Symbol, Straddle::Models::PaymentSummaryPagedV1::Data::PaymentType] The type of payment. Valid values are `charge` or `payout`.
|
|
170
|
+
#
|
|
171
|
+
# @param status [Symbol, Straddle::Models::PaymentSummaryPagedV1::Data::Status] The current status of the `charge` or `payout`.
|
|
172
|
+
#
|
|
173
|
+
# @param status_details [Straddle::Models::StatusDetailsV1] Details about the current status of the `charge` or `payout`.
|
|
174
|
+
#
|
|
175
|
+
# @param updated_at [Time] The time the `charge` or `payout` was last updated.
|
|
176
|
+
#
|
|
177
|
+
# @param customer_details [Straddle::Models::CustomerDetailsV1] Information about the customer associated with the charge or payout.
|
|
178
|
+
#
|
|
179
|
+
# @param effective_at [Time, nil] The actual date on which the payment occurred. For charges, this is the date the
|
|
180
|
+
#
|
|
181
|
+
# @param funding_id [String, nil] Unique identifier for the funding event associated with the `charge` or `payout`
|
|
182
|
+
#
|
|
183
|
+
# @param paykey_details [Straddle::Models::PaykeyDetailsV1] Information about the paykey used for the `charge` or `payout`.
|
|
184
|
+
|
|
185
|
+
# The type of payment. Valid values are `charge` or `payout`.
|
|
186
|
+
#
|
|
187
|
+
# @see Straddle::Models::PaymentSummaryPagedV1::Data#payment_type
|
|
188
|
+
module PaymentType
|
|
189
|
+
extend Straddle::Internal::Type::Enum
|
|
190
|
+
|
|
191
|
+
CHARGE = :charge
|
|
192
|
+
PAYOUT = :payout
|
|
193
|
+
|
|
194
|
+
# @!method self.values
|
|
195
|
+
# @return [Array<Symbol>]
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
# The current status of the `charge` or `payout`.
|
|
199
|
+
#
|
|
200
|
+
# @see Straddle::Models::PaymentSummaryPagedV1::Data#status
|
|
201
|
+
module Status
|
|
202
|
+
extend Straddle::Internal::Type::Enum
|
|
203
|
+
|
|
204
|
+
CREATED = :created
|
|
205
|
+
SCHEDULED = :scheduled
|
|
206
|
+
FAILED = :failed
|
|
207
|
+
CANCELLED = :cancelled
|
|
208
|
+
ON_HOLD = :on_hold
|
|
209
|
+
PENDING = :pending
|
|
210
|
+
PAID = :paid
|
|
211
|
+
REVERSED = :reversed
|
|
212
|
+
|
|
213
|
+
# @!method self.values
|
|
214
|
+
# @return [Array<Symbol>]
|
|
215
|
+
end
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
# @see Straddle::Models::PaymentSummaryPagedV1#meta
|
|
219
|
+
class Meta < Straddle::Internal::Type::BaseModel
|
|
220
|
+
# @!attribute api_request_id
|
|
221
|
+
# Unique identifier for this API request, useful for troubleshooting.
|
|
222
|
+
#
|
|
223
|
+
# @return [String]
|
|
224
|
+
required :api_request_id, String
|
|
225
|
+
|
|
226
|
+
# @!attribute api_request_timestamp
|
|
227
|
+
# Timestamp for this API request, useful for troubleshooting.
|
|
228
|
+
#
|
|
229
|
+
# @return [Time]
|
|
230
|
+
required :api_request_timestamp, Time
|
|
231
|
+
|
|
232
|
+
# @!attribute max_page_size
|
|
233
|
+
# Maximum allowed page size for this endpoint.
|
|
234
|
+
#
|
|
235
|
+
# @return [Integer]
|
|
236
|
+
required :max_page_size, Integer
|
|
237
|
+
|
|
238
|
+
# @!attribute page_number
|
|
239
|
+
# Page number for paginated results.
|
|
240
|
+
#
|
|
241
|
+
# @return [Integer]
|
|
242
|
+
required :page_number, Integer
|
|
243
|
+
|
|
244
|
+
# @!attribute page_size
|
|
245
|
+
# Number of items per page in this response.
|
|
246
|
+
#
|
|
247
|
+
# @return [Integer]
|
|
248
|
+
required :page_size, Integer
|
|
249
|
+
|
|
250
|
+
# @!attribute sort_by
|
|
251
|
+
# The field that the results were sorted by.
|
|
252
|
+
#
|
|
253
|
+
# @return [String]
|
|
254
|
+
required :sort_by, String
|
|
255
|
+
|
|
256
|
+
# @!attribute sort_order
|
|
257
|
+
#
|
|
258
|
+
# @return [Symbol, Straddle::Models::PaymentSummaryPagedV1::Meta::SortOrder]
|
|
259
|
+
required :sort_order, enum: -> { Straddle::PaymentSummaryPagedV1::Meta::SortOrder }
|
|
260
|
+
|
|
261
|
+
# @!attribute total_items
|
|
262
|
+
#
|
|
263
|
+
# @return [Integer]
|
|
264
|
+
required :total_items, Integer
|
|
265
|
+
|
|
266
|
+
# @!attribute total_pages
|
|
267
|
+
# The number of pages available.
|
|
268
|
+
#
|
|
269
|
+
# @return [Integer]
|
|
270
|
+
required :total_pages, Integer
|
|
271
|
+
|
|
272
|
+
# @!method initialize(api_request_id:, api_request_timestamp:, max_page_size:, page_number:, page_size:, sort_by:, sort_order:, total_items:, total_pages:)
|
|
273
|
+
# @param api_request_id [String] Unique identifier for this API request, useful for troubleshooting.
|
|
274
|
+
#
|
|
275
|
+
# @param api_request_timestamp [Time] Timestamp for this API request, useful for troubleshooting.
|
|
276
|
+
#
|
|
277
|
+
# @param max_page_size [Integer] Maximum allowed page size for this endpoint.
|
|
278
|
+
#
|
|
279
|
+
# @param page_number [Integer] Page number for paginated results.
|
|
280
|
+
#
|
|
281
|
+
# @param page_size [Integer] Number of items per page in this response.
|
|
282
|
+
#
|
|
283
|
+
# @param sort_by [String] The field that the results were sorted by.
|
|
284
|
+
#
|
|
285
|
+
# @param sort_order [Symbol, Straddle::Models::PaymentSummaryPagedV1::Meta::SortOrder]
|
|
286
|
+
#
|
|
287
|
+
# @param total_items [Integer]
|
|
288
|
+
#
|
|
289
|
+
# @param total_pages [Integer] The number of pages available.
|
|
290
|
+
|
|
291
|
+
# @see Straddle::Models::PaymentSummaryPagedV1::Meta#sort_order
|
|
292
|
+
module SortOrder
|
|
293
|
+
extend Straddle::Internal::Type::Enum
|
|
294
|
+
|
|
295
|
+
ASC = :asc
|
|
296
|
+
DESC = :desc
|
|
297
|
+
|
|
298
|
+
# @!method self.values
|
|
299
|
+
# @return [Array<Symbol>]
|
|
300
|
+
end
|
|
301
|
+
end
|
|
302
|
+
|
|
303
|
+
# Indicates the structure of the returned content.
|
|
304
|
+
#
|
|
305
|
+
# - "object" means the `data` field contains a single JSON object.
|
|
306
|
+
# - "array" means the `data` field contains an array of objects.
|
|
307
|
+
# - "error" means the `data` field contains an error object with details of the
|
|
308
|
+
# issue.
|
|
309
|
+
# - "none" means no data is returned.
|
|
310
|
+
#
|
|
311
|
+
# @see Straddle::Models::PaymentSummaryPagedV1#response_type
|
|
312
|
+
module ResponseType
|
|
313
|
+
extend Straddle::Internal::Type::Enum
|
|
314
|
+
|
|
315
|
+
OBJECT = :object
|
|
316
|
+
ARRAY = :array
|
|
317
|
+
ERROR = :error
|
|
318
|
+
NONE = :none
|
|
319
|
+
|
|
320
|
+
# @!method self.values
|
|
321
|
+
# @return [Array<Symbol>]
|
|
322
|
+
end
|
|
323
|
+
end
|
|
324
|
+
end
|
|
325
|
+
end
|