straddle 0.2.0 → 0.4.0
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 +4 -4
- data/CHANGELOG.md +97 -0
- data/README.md +10 -1
- data/lib/straddle/client.rb +34 -0
- data/lib/straddle/internal/transport/base_client.rb +7 -1
- data/lib/straddle/internal/transport/pooled_net_requester.rb +39 -27
- data/lib/straddle/internal/util.rb +44 -8
- data/lib/straddle/models/bridge/link_bank_account_params.rb +31 -2
- data/lib/straddle/models/bridge/link_create_paykey_params.rb +31 -2
- data/lib/straddle/models/bridge/link_create_paykey_response.rb +39 -2
- data/lib/straddle/models/bridge/link_create_tan_params.rb +30 -2
- data/lib/straddle/models/bridge/link_create_tan_response.rb +39 -2
- data/lib/straddle/models/bridge/link_plaid_params.rb +30 -2
- data/lib/straddle/models/bridge_initialize_params.rb +30 -2
- data/lib/straddle/models/charge_cancel_params.rb +8 -1
- data/lib/straddle/models/charge_create_params.rb +20 -4
- data/lib/straddle/models/charge_get_params.rb +7 -1
- data/lib/straddle/models/charge_hold_params.rb +8 -1
- data/lib/straddle/models/charge_release_params.rb +8 -1
- data/lib/straddle/models/charge_unmask_params.rb +7 -1
- data/lib/straddle/models/charge_unmask_response.rb +59 -5
- data/lib/straddle/models/charge_update_params.rb +11 -4
- data/lib/straddle/models/charge_v1.rb +59 -5
- data/lib/straddle/models/customer_delete_params.rb +7 -1
- data/lib/straddle/models/customer_get_params.rb +7 -1
- data/lib/straddle/models/customer_unmasked_params.rb +7 -1
- data/lib/straddle/models/customer_update_params.rb +8 -1
- data/lib/straddle/models/customers/review_decision_params.rb +8 -1
- data/lib/straddle/models/customers/review_get_params.rb +7 -1
- data/lib/straddle/models/customers/review_refresh_review_params.rb +46 -0
- data/lib/straddle/models/embed/account_get_params.rb +11 -1
- data/lib/straddle/models/embed/account_onboard_params.rb +7 -1
- data/lib/straddle/models/embed/account_paged_v1.rb +4 -0
- data/lib/straddle/models/embed/account_simulate_params.rb +7 -1
- data/lib/straddle/models/embed/account_update_params.rb +8 -1
- data/lib/straddle/models/embed/account_v1.rb +4 -0
- data/lib/straddle/models/embed/accounts/capability_request_create_params.rb +8 -1
- data/lib/straddle/models/embed/accounts/capability_request_list_params.rb +8 -1
- data/lib/straddle/models/embed/accounts/capability_request_paged_v1.rb +9 -1
- data/lib/straddle/models/embed/address_v1.rb +14 -38
- data/lib/straddle/models/embed/linked_bank_account_cancel_params.rb +7 -1
- data/lib/straddle/models/embed/linked_bank_account_get_params.rb +7 -1
- data/lib/straddle/models/embed/linked_bank_account_list_params.rb +51 -1
- data/lib/straddle/models/embed/linked_bank_account_unmask_params.rb +7 -1
- data/lib/straddle/models/embed/linked_bank_account_update_params.rb +8 -1
- data/lib/straddle/models/embed/organization_get_params.rb +7 -1
- data/lib/straddle/models/embed/representative_get_params.rb +7 -1
- data/lib/straddle/models/embed/representative_unmask_params.rb +7 -1
- data/lib/straddle/models/embed/representative_update_params.rb +8 -1
- data/lib/straddle/models/funding_event_get_params.rb +7 -1
- data/lib/straddle/models/funding_event_list_params.rb +113 -1
- data/lib/straddle/models/funding_event_summary_item_v1.rb +152 -1
- data/lib/straddle/models/funding_event_summary_paged_v1.rb +152 -1
- data/lib/straddle/models/paykey_cancel_params.rb +7 -1
- data/lib/straddle/models/paykey_get_params.rb +7 -1
- data/lib/straddle/models/paykey_list_params.rb +24 -1
- data/lib/straddle/models/paykey_reveal_params.rb +7 -1
- data/lib/straddle/models/paykey_reveal_response.rb +39 -2
- data/lib/straddle/models/paykey_summary_paged_v1.rb +48 -2
- data/lib/straddle/models/paykey_unmasked_params.rb +7 -1
- data/lib/straddle/models/paykey_unmasked_v1.rb +38 -2
- data/lib/straddle/models/{customer_refresh_review_params.rb → paykey_update_balance_params.rb} +9 -3
- data/lib/straddle/models/paykey_v1.rb +48 -2
- data/lib/straddle/models/paykeys/review_decision_params.rb +62 -0
- data/lib/straddle/models/paykeys/review_get_params.rb +40 -0
- data/lib/straddle/models/paykeys/review_get_response.rb +657 -0
- data/lib/straddle/models/paykeys/review_refresh_review_params.rb +46 -0
- data/lib/straddle/models/payment_list_params.rb +17 -1
- data/lib/straddle/models/payment_summary_paged_v1.rb +21 -4
- data/lib/straddle/models/payout_cancel_params.rb +8 -1
- data/lib/straddle/models/payout_create_params.rb +20 -4
- data/lib/straddle/models/payout_get_params.rb +7 -1
- data/lib/straddle/models/payout_hold_params.rb +8 -1
- data/lib/straddle/models/payout_release_params.rb +8 -1
- data/lib/straddle/models/payout_unmask_params.rb +7 -1
- data/lib/straddle/models/payout_unmask_response.rb +59 -5
- data/lib/straddle/models/payout_update_params.rb +11 -4
- data/lib/straddle/models/payout_v1.rb +59 -5
- data/lib/straddle/models/status_details_v1.rb +7 -0
- data/lib/straddle/models.rb +3 -3
- data/lib/straddle/resources/bridge/link.rb +24 -10
- data/lib/straddle/resources/bridge.rb +16 -2
- data/lib/straddle/resources/charges.rb +13 -8
- data/lib/straddle/resources/customers/review.rb +44 -1
- data/lib/straddle/resources/customers.rb +23 -47
- data/lib/straddle/resources/embed/accounts/capability_requests.rb +9 -4
- data/lib/straddle/resources/embed/accounts.rb +25 -14
- data/lib/straddle/resources/embed/linked_bank_accounts.rb +25 -7
- data/lib/straddle/resources/embed/organizations.rb +7 -2
- data/lib/straddle/resources/embed/representatives.rb +15 -8
- data/lib/straddle/resources/embed.rb +19 -0
- data/lib/straddle/resources/funding_events.rb +25 -3
- data/lib/straddle/resources/paykeys/review.rb +133 -0
- data/lib/straddle/resources/paykeys.rb +72 -50
- data/lib/straddle/resources/payments.rb +12 -6
- data/lib/straddle/resources/payouts.rb +11 -7
- data/lib/straddle/version.rb +1 -1
- data/lib/straddle.rb +9 -2
- data/manifest.yaml +2 -0
- data/rbi/straddle/client.rbi +34 -0
- data/rbi/straddle/internal/transport/base_client.rbi +5 -0
- data/rbi/straddle/internal/transport/pooled_net_requester.rbi +6 -2
- data/rbi/straddle/internal/type/base_model.rbi +8 -4
- data/rbi/straddle/internal/util.rbi +21 -1
- data/rbi/straddle/models/bridge/link_bank_account_params.rbi +76 -1
- data/rbi/straddle/models/bridge/link_create_paykey_params.rbi +76 -1
- data/rbi/straddle/models/bridge/link_create_paykey_response.rbi +116 -1
- data/rbi/straddle/models/bridge/link_create_tan_params.rbi +76 -1
- data/rbi/straddle/models/bridge/link_create_tan_response.rbi +116 -1
- data/rbi/straddle/models/bridge/link_plaid_params.rbi +76 -1
- data/rbi/straddle/models/bridge_initialize_params.rbi +76 -1
- data/rbi/straddle/models/charge_cancel_params.rbi +6 -0
- data/rbi/straddle/models/charge_create_params.rbi +19 -3
- data/rbi/straddle/models/charge_get_params.rbi +6 -0
- data/rbi/straddle/models/charge_hold_params.rbi +6 -0
- data/rbi/straddle/models/charge_release_params.rbi +6 -0
- data/rbi/straddle/models/charge_unmask_params.rbi +6 -0
- data/rbi/straddle/models/charge_unmask_response.rbi +143 -6
- data/rbi/straddle/models/charge_update_params.rbi +9 -3
- data/rbi/straddle/models/charge_v1.rbi +135 -6
- data/rbi/straddle/models/customer_delete_params.rbi +6 -0
- data/rbi/straddle/models/customer_get_params.rbi +6 -0
- data/rbi/straddle/models/customer_unmasked_params.rbi +6 -0
- data/rbi/straddle/models/customer_update_params.rbi +6 -0
- data/rbi/straddle/models/customers/review_decision_params.rbi +6 -0
- data/rbi/straddle/models/customers/review_get_params.rbi +6 -0
- data/rbi/straddle/models/customers/review_refresh_review_params.rbi +82 -0
- data/rbi/straddle/models/embed/account_get_params.rbi +13 -1
- data/rbi/straddle/models/embed/account_onboard_params.rbi +6 -0
- data/rbi/straddle/models/embed/account_paged_v1.rbi +20 -0
- data/rbi/straddle/models/embed/account_simulate_params.rbi +6 -0
- data/rbi/straddle/models/embed/account_update_params.rbi +6 -0
- data/rbi/straddle/models/embed/account_v1.rbi +20 -0
- data/rbi/straddle/models/embed/accounts/capability_request_create_params.rbi +6 -0
- data/rbi/straddle/models/embed/accounts/capability_request_list_params.rbi +6 -0
- data/rbi/straddle/models/embed/accounts/capability_request_paged_v1.rbi +8 -0
- data/rbi/straddle/models/embed/address_v1.rbi +18 -42
- data/rbi/straddle/models/embed/linked_bank_account_cancel_params.rbi +6 -0
- data/rbi/straddle/models/embed/linked_bank_account_get_params.rbi +11 -1
- data/rbi/straddle/models/embed/linked_bank_account_list_params.rbi +149 -0
- data/rbi/straddle/models/embed/linked_bank_account_unmask_params.rbi +11 -1
- data/rbi/straddle/models/embed/linked_bank_account_update_params.rbi +6 -0
- data/rbi/straddle/models/embed/organization_get_params.rbi +11 -1
- data/rbi/straddle/models/embed/representative_get_params.rbi +11 -1
- data/rbi/straddle/models/embed/representative_unmask_params.rbi +11 -1
- data/rbi/straddle/models/embed/representative_update_params.rbi +6 -0
- data/rbi/straddle/models/funding_event_get_params.rbi +6 -0
- data/rbi/straddle/models/funding_event_list_params.rbi +341 -0
- data/rbi/straddle/models/funding_event_summary_item_v1.rbi +416 -0
- data/rbi/straddle/models/funding_event_summary_paged_v1.rbi +417 -0
- data/rbi/straddle/models/paykey_cancel_params.rbi +6 -0
- data/rbi/straddle/models/paykey_get_params.rbi +6 -0
- data/rbi/straddle/models/paykey_list_params.rbi +30 -0
- data/rbi/straddle/models/paykey_reveal_params.rbi +6 -0
- data/rbi/straddle/models/paykey_reveal_response.rbi +116 -1
- data/rbi/straddle/models/paykey_summary_paged_v1.rbi +131 -4
- data/rbi/straddle/models/paykey_unmasked_params.rbi +6 -0
- data/rbi/straddle/models/paykey_unmasked_v1.rbi +116 -1
- data/rbi/straddle/models/{customer_refresh_review_params.rbi → paykey_update_balance_params.rbi} +8 -2
- data/rbi/straddle/models/paykey_v1.rbi +128 -4
- data/rbi/straddle/models/paykeys/review_decision_params.rbi +121 -0
- data/rbi/straddle/models/paykeys/review_get_params.rbi +73 -0
- data/rbi/straddle/models/paykeys/review_get_response.rbi +1561 -0
- data/rbi/straddle/models/paykeys/review_refresh_review_params.rbi +82 -0
- data/rbi/straddle/models/payment_list_params.rbi +51 -0
- data/rbi/straddle/models/payment_summary_paged_v1.rbi +24 -3
- data/rbi/straddle/models/payout_cancel_params.rbi +6 -0
- data/rbi/straddle/models/payout_create_params.rbi +19 -3
- data/rbi/straddle/models/payout_get_params.rbi +6 -0
- data/rbi/straddle/models/payout_hold_params.rbi +6 -0
- data/rbi/straddle/models/payout_release_params.rbi +6 -0
- data/rbi/straddle/models/payout_unmask_params.rbi +6 -0
- data/rbi/straddle/models/payout_unmask_response.rbi +140 -3
- data/rbi/straddle/models/payout_update_params.rbi +9 -3
- data/rbi/straddle/models/payout_v1.rbi +132 -3
- data/rbi/straddle/models/status_details_v1.rbi +29 -0
- data/rbi/straddle/models.rbi +3 -3
- data/rbi/straddle/resources/bridge/link.rbi +28 -6
- data/rbi/straddle/resources/bridge.rbi +17 -1
- data/rbi/straddle/resources/charges.rbi +13 -8
- data/rbi/straddle/resources/customers/review.rbi +34 -1
- data/rbi/straddle/resources/customers.rbi +20 -35
- data/rbi/straddle/resources/embed/accounts/capability_requests.rbi +6 -2
- data/rbi/straddle/resources/embed/accounts.rbi +19 -10
- data/rbi/straddle/resources/embed/linked_bank_accounts.rbi +18 -4
- data/rbi/straddle/resources/embed/organizations.rbi +4 -0
- data/rbi/straddle/resources/embed/representatives.rbi +12 -6
- data/rbi/straddle/resources/embed.rbi +19 -0
- data/rbi/straddle/resources/funding_events.rbi +30 -0
- data/rbi/straddle/resources/paykeys/review.rbi +99 -0
- data/rbi/straddle/resources/paykeys.rbi +45 -29
- data/rbi/straddle/resources/payments.rbi +8 -3
- data/rbi/straddle/resources/payouts.rbi +11 -7
- data/sig/straddle/internal/transport/base_client.rbs +2 -0
- data/sig/straddle/internal/transport/pooled_net_requester.rbs +4 -1
- data/sig/straddle/internal/util.rbs +10 -0
- data/sig/straddle/models/bridge/link_bank_account_params.rbs +28 -1
- data/sig/straddle/models/bridge/link_create_paykey_params.rbs +28 -1
- data/sig/straddle/models/bridge/link_create_paykey_response.rbs +45 -2
- data/sig/straddle/models/bridge/link_create_tan_params.rbs +28 -1
- data/sig/straddle/models/bridge/link_create_tan_response.rbs +45 -2
- data/sig/straddle/models/bridge/link_plaid_params.rbs +28 -1
- data/sig/straddle/models/bridge_initialize_params.rbs +28 -1
- data/sig/straddle/models/charge_cancel_params.rbs +5 -0
- data/sig/straddle/models/charge_create_params.rbs +14 -4
- data/sig/straddle/models/charge_get_params.rbs +5 -0
- data/sig/straddle/models/charge_hold_params.rbs +5 -0
- data/sig/straddle/models/charge_release_params.rbs +5 -0
- data/sig/straddle/models/charge_unmask_params.rbs +5 -0
- data/sig/straddle/models/charge_unmask_response.rbs +57 -7
- data/sig/straddle/models/charge_update_params.rbs +9 -4
- data/sig/straddle/models/charge_v1.rbs +57 -7
- data/sig/straddle/models/customer_delete_params.rbs +5 -0
- data/sig/straddle/models/customer_get_params.rbs +5 -0
- data/sig/straddle/models/customer_unmasked_params.rbs +5 -0
- data/sig/straddle/models/customer_update_params.rbs +5 -0
- data/sig/straddle/models/customers/review_decision_params.rbs +5 -0
- data/sig/straddle/models/customers/review_get_params.rbs +5 -0
- data/sig/straddle/models/customers/review_refresh_review_params.rbs +56 -0
- data/sig/straddle/models/embed/account_get_params.rbs +5 -1
- data/sig/straddle/models/embed/account_onboard_params.rbs +5 -0
- data/sig/straddle/models/embed/account_paged_v1.rbs +18 -2
- data/sig/straddle/models/embed/account_simulate_params.rbs +5 -0
- data/sig/straddle/models/embed/account_update_params.rbs +5 -0
- data/sig/straddle/models/embed/account_v1.rbs +18 -2
- data/sig/straddle/models/embed/accounts/capability_request_create_params.rbs +5 -0
- data/sig/straddle/models/embed/accounts/capability_request_list_params.rbs +5 -0
- data/sig/straddle/models/embed/accounts/capability_request_paged_v1.rbs +5 -0
- data/sig/straddle/models/embed/address_v1.rbs +12 -27
- data/sig/straddle/models/embed/linked_bank_account_cancel_params.rbs +10 -1
- data/sig/straddle/models/embed/linked_bank_account_get_params.rbs +9 -1
- data/sig/straddle/models/embed/linked_bank_account_list_params.rbs +46 -0
- data/sig/straddle/models/embed/linked_bank_account_unmask_params.rbs +9 -1
- data/sig/straddle/models/embed/linked_bank_account_update_params.rbs +5 -0
- data/sig/straddle/models/embed/organization_get_params.rbs +5 -1
- data/sig/straddle/models/embed/representative_get_params.rbs +9 -1
- data/sig/straddle/models/embed/representative_unmask_params.rbs +9 -1
- data/sig/straddle/models/embed/representative_update_params.rbs +5 -0
- data/sig/straddle/models/funding_event_get_params.rbs +5 -0
- data/sig/straddle/models/funding_event_list_params.rbs +130 -0
- data/sig/straddle/models/funding_event_summary_item_v1.rbs +179 -0
- data/sig/straddle/models/funding_event_summary_paged_v1.rbs +179 -0
- data/sig/straddle/models/paykey_cancel_params.rbs +5 -0
- data/sig/straddle/models/paykey_get_params.rbs +5 -0
- data/sig/straddle/models/paykey_list_params.rbs +17 -1
- data/sig/straddle/models/paykey_reveal_params.rbs +5 -0
- data/sig/straddle/models/paykey_reveal_response.rbs +45 -2
- data/sig/straddle/models/paykey_summary_paged_v1.rbs +53 -5
- data/sig/straddle/models/paykey_unmasked_params.rbs +5 -0
- data/sig/straddle/models/paykey_unmasked_v1.rbs +45 -2
- data/sig/straddle/models/{customer_refresh_review_params.rbs → paykey_update_balance_params.rbs} +7 -2
- data/sig/straddle/models/paykey_v1.rbs +53 -5
- data/sig/straddle/models/paykeys/review_decision_params.rbs +72 -0
- data/sig/straddle/models/paykeys/review_get_params.rbs +49 -0
- data/sig/straddle/models/paykeys/review_get_response.rbs +645 -0
- data/sig/straddle/models/paykeys/review_refresh_review_params.rbs +56 -0
- data/sig/straddle/models/payment_list_params.rbs +23 -0
- data/sig/straddle/models/payment_summary_paged_v1.rbs +16 -4
- data/sig/straddle/models/payout_cancel_params.rbs +5 -0
- data/sig/straddle/models/payout_create_params.rbs +14 -4
- data/sig/straddle/models/payout_get_params.rbs +5 -0
- data/sig/straddle/models/payout_hold_params.rbs +5 -0
- data/sig/straddle/models/payout_release_params.rbs +5 -0
- data/sig/straddle/models/payout_unmask_params.rbs +5 -0
- data/sig/straddle/models/payout_unmask_response.rbs +54 -4
- data/sig/straddle/models/payout_update_params.rbs +9 -4
- data/sig/straddle/models/payout_v1.rbs +54 -4
- data/sig/straddle/models/status_details_v1.rbs +14 -0
- data/sig/straddle/models.rbs +3 -3
- data/sig/straddle/resources/bridge/link.rbs +4 -0
- data/sig/straddle/resources/bridge.rbs +1 -0
- data/sig/straddle/resources/charges.rbs +2 -2
- data/sig/straddle/resources/customers/review.rbs +9 -0
- data/sig/straddle/resources/customers.rbs +0 -9
- data/sig/straddle/resources/embed/linked_bank_accounts.rbs +2 -0
- data/sig/straddle/resources/funding_events.rbs +5 -0
- data/sig/straddle/resources/paykeys/review.rbs +36 -0
- data/sig/straddle/resources/paykeys.rbs +9 -6
- data/sig/straddle/resources/payments.rbs +1 -0
- data/sig/straddle/resources/payouts.rbs +2 -2
- metadata +37 -8
- data/lib/straddle/models/paykey_review_params.rb +0 -54
- data/rbi/straddle/models/paykey_review_params.rbi +0 -98
- data/sig/straddle/models/paykey_review_params.rbs +0 -65
|
@@ -3,7 +3,16 @@
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
5
|
class Embed
|
|
6
|
+
# Accounts represent businesses using Straddle through your platform. Each account
|
|
7
|
+
# must complete automated verification before processing payments. Use accounts to
|
|
8
|
+
# manage your users' payment capabilities, track verification status, and control
|
|
9
|
+
# access to features. Accounts can be instantly created in sandbox and require
|
|
10
|
+
# additional verification for production access.
|
|
6
11
|
class Accounts
|
|
12
|
+
# Capabilities enable specific features and services for an Account. Use
|
|
13
|
+
# capability requests to unlock higher processing limits, new payment types, or
|
|
14
|
+
# additional platform features as your users' businesses grow. Track approval
|
|
15
|
+
# status and manage documentation requirements through a single interface.
|
|
7
16
|
# @return [Straddle::Resources::Embed::Accounts::CapabilityRequests]
|
|
8
17
|
attr_reader :capability_requests
|
|
9
18
|
|
|
@@ -20,7 +29,7 @@ module Straddle
|
|
|
20
29
|
#
|
|
21
30
|
# @param account_type [Symbol, Straddle::Models::Embed::AccountCreateParams::AccountType] Body param: The type of account to be created. Currently, only `business` is sup
|
|
22
31
|
#
|
|
23
|
-
# @param business_profile [Straddle::Models::Embed::BusinessProfileV1] Body param
|
|
32
|
+
# @param business_profile [Straddle::Models::Embed::BusinessProfileV1] Body param
|
|
24
33
|
#
|
|
25
34
|
# @param organization_id [String] Body param: The unique identifier of the organization related to this account.
|
|
26
35
|
#
|
|
@@ -61,9 +70,9 @@ module Straddle
|
|
|
61
70
|
#
|
|
62
71
|
# @overload update(account_id, business_profile:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
63
72
|
#
|
|
64
|
-
# @param account_id [String] Path param
|
|
73
|
+
# @param account_id [String] Path param
|
|
65
74
|
#
|
|
66
|
-
# @param business_profile [Straddle::Models::Embed::BusinessProfileV1] Body param
|
|
75
|
+
# @param business_profile [Straddle::Models::Embed::BusinessProfileV1] Body param
|
|
67
76
|
#
|
|
68
77
|
# @param external_id [String, nil] Body param: Unique identifier for the account in your database, used for cross-r
|
|
69
78
|
#
|
|
@@ -108,15 +117,15 @@ module Straddle
|
|
|
108
117
|
#
|
|
109
118
|
# @param page_size [Integer] Query param: Page size. Default value: 100. Max value: 1000
|
|
110
119
|
#
|
|
111
|
-
# @param search_text [String] Query param
|
|
120
|
+
# @param search_text [String] Query param
|
|
112
121
|
#
|
|
113
122
|
# @param sort_by [String] Query param: Sort By. Default value: 'id'.
|
|
114
123
|
#
|
|
115
124
|
# @param sort_order [Symbol, Straddle::Models::Embed::AccountListParams::SortOrder] Query param: Sort Order. Default value: 'asc'.
|
|
116
125
|
#
|
|
117
|
-
# @param status [Symbol, Straddle::Models::Embed::AccountListParams::Status] Query param
|
|
126
|
+
# @param status [Symbol, Straddle::Models::Embed::AccountListParams::Status] Query param
|
|
118
127
|
#
|
|
119
|
-
# @param type [Symbol, Straddle::Models::Embed::AccountListParams::Type] Query param
|
|
128
|
+
# @param type [Symbol, Straddle::Models::Embed::AccountListParams::Type] Query param
|
|
120
129
|
#
|
|
121
130
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
122
131
|
#
|
|
@@ -128,12 +137,13 @@ module Straddle
|
|
|
128
137
|
#
|
|
129
138
|
# @see Straddle::Models::Embed::AccountListParams
|
|
130
139
|
def list(params = {})
|
|
131
|
-
parsed, options = Straddle::Embed::AccountListParams.dump_request(params)
|
|
132
140
|
query_params = [:page_number, :page_size, :search_text, :sort_by, :sort_order, :status, :type]
|
|
141
|
+
parsed, options = Straddle::Embed::AccountListParams.dump_request(params)
|
|
142
|
+
query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
133
143
|
@client.request(
|
|
134
144
|
method: :get,
|
|
135
145
|
path: "v1/accounts",
|
|
136
|
-
query:
|
|
146
|
+
query: query,
|
|
137
147
|
headers: parsed.except(*query_params).transform_keys(
|
|
138
148
|
correlation_id: "correlation-id",
|
|
139
149
|
request_id: "request-id"
|
|
@@ -181,9 +191,9 @@ module Straddle
|
|
|
181
191
|
#
|
|
182
192
|
# @overload onboard(account_id, terms_of_service:, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
183
193
|
#
|
|
184
|
-
# @param account_id [String] Path param
|
|
194
|
+
# @param account_id [String] Path param
|
|
185
195
|
#
|
|
186
|
-
# @param terms_of_service [Straddle::Models::Embed::TermsOfServiceV1] Body param
|
|
196
|
+
# @param terms_of_service [Straddle::Models::Embed::TermsOfServiceV1] Body param
|
|
187
197
|
#
|
|
188
198
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
189
199
|
#
|
|
@@ -218,9 +228,9 @@ module Straddle
|
|
|
218
228
|
#
|
|
219
229
|
# @overload simulate(account_id, final_status: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
220
230
|
#
|
|
221
|
-
# @param account_id [String] Path param
|
|
231
|
+
# @param account_id [String] Path param
|
|
222
232
|
#
|
|
223
|
-
# @param final_status [Symbol, Straddle::Models::Embed::AccountSimulateParams::FinalStatus] Query param
|
|
233
|
+
# @param final_status [Symbol, Straddle::Models::Embed::AccountSimulateParams::FinalStatus] Query param
|
|
224
234
|
#
|
|
225
235
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
226
236
|
#
|
|
@@ -234,12 +244,13 @@ module Straddle
|
|
|
234
244
|
#
|
|
235
245
|
# @see Straddle::Models::Embed::AccountSimulateParams
|
|
236
246
|
def simulate(account_id, params = {})
|
|
237
|
-
parsed, options = Straddle::Embed::AccountSimulateParams.dump_request(params)
|
|
238
247
|
query_params = [:final_status]
|
|
248
|
+
parsed, options = Straddle::Embed::AccountSimulateParams.dump_request(params)
|
|
249
|
+
query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
239
250
|
@client.request(
|
|
240
251
|
method: :post,
|
|
241
252
|
path: ["v1/accounts/%1$s/simulate", account_id],
|
|
242
|
-
query:
|
|
253
|
+
query: query,
|
|
243
254
|
headers: parsed.except(*query_params).transform_keys(
|
|
244
255
|
correlation_id: "correlation-id",
|
|
245
256
|
idempotency_key: "idempotency-key",
|
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
5
|
class Embed
|
|
6
|
+
# Linked bank accounts connect your platform users' external bank accounts to
|
|
7
|
+
# Straddle for settlements and payment funding. Each linked account undergoes
|
|
8
|
+
# automated verification and continuous monitoring. Use linked accounts to manage
|
|
9
|
+
# where clients receive deposits, fund payouts, and track settlement preferences.
|
|
6
10
|
class LinkedBankAccounts
|
|
7
11
|
# Some parameter documentations has been truncated, see
|
|
8
12
|
# {Straddle::Models::Embed::LinkedBankAccountCreateParams} for more details.
|
|
@@ -16,7 +20,7 @@ module Straddle
|
|
|
16
20
|
#
|
|
17
21
|
# @param account_id [String, nil] Body param: The unique identifier of the Straddle account to associate this bank
|
|
18
22
|
#
|
|
19
|
-
# @param bank_account [Straddle::Models::Embed::LinkedBankAccountCreateParams::BankAccount] Body param
|
|
23
|
+
# @param bank_account [Straddle::Models::Embed::LinkedBankAccountCreateParams::BankAccount] Body param
|
|
20
24
|
#
|
|
21
25
|
# @param description [String, nil] Body param: Optional description for the bank account.
|
|
22
26
|
#
|
|
@@ -61,9 +65,9 @@ module Straddle
|
|
|
61
65
|
#
|
|
62
66
|
# @overload update(linked_bank_account_id, bank_account:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
63
67
|
#
|
|
64
|
-
# @param linked_bank_account_id [String] Path param
|
|
68
|
+
# @param linked_bank_account_id [String] Path param
|
|
65
69
|
#
|
|
66
|
-
# @param bank_account [Straddle::Models::Embed::LinkedBankAccountUpdateParams::BankAccount] Body param
|
|
70
|
+
# @param bank_account [Straddle::Models::Embed::LinkedBankAccountUpdateParams::BankAccount] Body param
|
|
67
71
|
#
|
|
68
72
|
# @param metadata [Hash{Symbol=>String, nil}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
|
|
69
73
|
#
|
|
@@ -100,20 +104,24 @@ module Straddle
|
|
|
100
104
|
# recently created appearing first. This endpoint supports pagination to handle
|
|
101
105
|
# accounts with multiple linked bank accounts.
|
|
102
106
|
#
|
|
103
|
-
# @overload list(account_id: nil, level: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, request_options: {})
|
|
107
|
+
# @overload list(account_id: nil, level: nil, page_number: nil, page_size: nil, purpose: nil, sort_by: nil, sort_order: nil, status: nil, correlation_id: nil, request_id: nil, request_options: {})
|
|
104
108
|
#
|
|
105
109
|
# @param account_id [String] Query param: The unique identifier of the related account.
|
|
106
110
|
#
|
|
107
|
-
# @param level [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Level] Query param
|
|
111
|
+
# @param level [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Level] Query param
|
|
108
112
|
#
|
|
109
113
|
# @param page_number [Integer] Query param: Results page number. Starts at page 1.
|
|
110
114
|
#
|
|
111
115
|
# @param page_size [Integer] Query param: Page size. Max value: 1000
|
|
112
116
|
#
|
|
117
|
+
# @param purpose [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Purpose] Query param: The purpose of the linked bank accounts to return. Possible values:
|
|
118
|
+
#
|
|
113
119
|
# @param sort_by [String] Query param: Sort By.
|
|
114
120
|
#
|
|
115
121
|
# @param sort_order [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::SortOrder] Query param: Sort Order.
|
|
116
122
|
#
|
|
123
|
+
# @param status [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Status] Query param: The status of the linked bank accounts to return. Possible values:
|
|
124
|
+
#
|
|
117
125
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
118
126
|
#
|
|
119
127
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
@@ -124,12 +132,22 @@ module Straddle
|
|
|
124
132
|
#
|
|
125
133
|
# @see Straddle::Models::Embed::LinkedBankAccountListParams
|
|
126
134
|
def list(params = {})
|
|
135
|
+
query_params = [
|
|
136
|
+
:account_id,
|
|
137
|
+
:level,
|
|
138
|
+
:page_number,
|
|
139
|
+
:page_size,
|
|
140
|
+
:purpose,
|
|
141
|
+
:sort_by,
|
|
142
|
+
:sort_order,
|
|
143
|
+
:status
|
|
144
|
+
]
|
|
127
145
|
parsed, options = Straddle::Embed::LinkedBankAccountListParams.dump_request(params)
|
|
128
|
-
|
|
146
|
+
query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
129
147
|
@client.request(
|
|
130
148
|
method: :get,
|
|
131
149
|
path: "v1/linked_bank_accounts",
|
|
132
|
-
query:
|
|
150
|
+
query: query,
|
|
133
151
|
headers: parsed.except(*query_params).transform_keys(
|
|
134
152
|
correlation_id: "correlation-id",
|
|
135
153
|
request_id: "request-id"
|
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
5
|
class Embed
|
|
6
|
+
# Organizations are a powerful feature in Straddle that allow you to manage
|
|
7
|
+
# multiple accounts under a single umbrella. This hierarchical structure is
|
|
8
|
+
# particularly useful for businesses with complex operations, multiple
|
|
9
|
+
# departments, or legally related entities.
|
|
6
10
|
class Organizations
|
|
7
11
|
# Some parameter documentations has been truncated, see
|
|
8
12
|
# {Straddle::Models::Embed::OrganizationCreateParams} for more details.
|
|
@@ -76,12 +80,13 @@ module Straddle
|
|
|
76
80
|
#
|
|
77
81
|
# @see Straddle::Models::Embed::OrganizationListParams
|
|
78
82
|
def list(params = {})
|
|
79
|
-
parsed, options = Straddle::Embed::OrganizationListParams.dump_request(params)
|
|
80
83
|
query_params = [:external_id, :name, :page_number, :page_size, :sort_by, :sort_order]
|
|
84
|
+
parsed, options = Straddle::Embed::OrganizationListParams.dump_request(params)
|
|
85
|
+
query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
81
86
|
@client.request(
|
|
82
87
|
method: :get,
|
|
83
88
|
path: "v1/organizations",
|
|
84
|
-
query:
|
|
89
|
+
query: query,
|
|
85
90
|
headers: parsed.except(*query_params).transform_keys(
|
|
86
91
|
correlation_id: "correlation-id",
|
|
87
92
|
request_id: "request-id"
|
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
5
|
class Embed
|
|
6
|
+
# Representatives are individuals who have legal authority or significant
|
|
7
|
+
# responsibility within a business entity associated with a Straddle account. Each
|
|
8
|
+
# representative undergoes automated verification as part of KYC/KYB compliance.
|
|
9
|
+
# Use representatives to collect and verify beneficial owners, control persons,
|
|
10
|
+
# and authorized signers required for account onboarding. Representatives also
|
|
11
|
+
# determine who can legally operate the account and make important changes.
|
|
6
12
|
class Representatives
|
|
7
13
|
# Some parameter documentations has been truncated, see
|
|
8
14
|
# {Straddle::Models::Embed::RepresentativeCreateParams} for more details.
|
|
@@ -25,7 +31,7 @@ module Straddle
|
|
|
25
31
|
#
|
|
26
32
|
# @param mobile_number [String] Body param: The mobile phone number of the representative.
|
|
27
33
|
#
|
|
28
|
-
# @param relationship [Straddle::Models::Embed::RepresentativeCreateParams::Relationship] Body param
|
|
34
|
+
# @param relationship [Straddle::Models::Embed::RepresentativeCreateParams::Relationship] Body param
|
|
29
35
|
#
|
|
30
36
|
# @param ssn_last4 [String] Body param: The last 4 digits of the representative's Social Security Number.
|
|
31
37
|
#
|
|
@@ -67,7 +73,7 @@ module Straddle
|
|
|
67
73
|
#
|
|
68
74
|
# @overload update(representative_id, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
69
75
|
#
|
|
70
|
-
# @param representative_id [String] Path param
|
|
76
|
+
# @param representative_id [String] Path param
|
|
71
77
|
#
|
|
72
78
|
# @param dob [Date] Body param: The date of birth of the representative, in ISO 8601 format (YYYY-MM
|
|
73
79
|
#
|
|
@@ -79,7 +85,7 @@ module Straddle
|
|
|
79
85
|
#
|
|
80
86
|
# @param mobile_number [String] Body param: The mobile phone number of the representative.
|
|
81
87
|
#
|
|
82
|
-
# @param relationship [Straddle::Models::Embed::RepresentativeUpdateParams::Relationship] Body param
|
|
88
|
+
# @param relationship [Straddle::Models::Embed::RepresentativeUpdateParams::Relationship] Body param
|
|
83
89
|
#
|
|
84
90
|
# @param ssn_last4 [String] Body param: The last 4 digits of the representative's Social Security Number.
|
|
85
91
|
#
|
|
@@ -124,15 +130,15 @@ module Straddle
|
|
|
124
130
|
#
|
|
125
131
|
# @param account_id [String] Query param: The unique identifier of the account to list representatives for.
|
|
126
132
|
#
|
|
127
|
-
# @param level [Symbol, Straddle::Models::Embed::RepresentativeListParams::Level] Query param
|
|
133
|
+
# @param level [Symbol, Straddle::Models::Embed::RepresentativeListParams::Level] Query param
|
|
128
134
|
#
|
|
129
|
-
# @param organization_id [String] Query param
|
|
135
|
+
# @param organization_id [String] Query param
|
|
130
136
|
#
|
|
131
137
|
# @param page_number [Integer] Query param: Results page number. Starts at page 1.
|
|
132
138
|
#
|
|
133
139
|
# @param page_size [Integer] Query param: Page size. Max value: 1000
|
|
134
140
|
#
|
|
135
|
-
# @param platform_id [String] Query param
|
|
141
|
+
# @param platform_id [String] Query param
|
|
136
142
|
#
|
|
137
143
|
# @param sort_by [String] Query param: Sort By.
|
|
138
144
|
#
|
|
@@ -148,7 +154,6 @@ module Straddle
|
|
|
148
154
|
#
|
|
149
155
|
# @see Straddle::Models::Embed::RepresentativeListParams
|
|
150
156
|
def list(params = {})
|
|
151
|
-
parsed, options = Straddle::Embed::RepresentativeListParams.dump_request(params)
|
|
152
157
|
query_params =
|
|
153
158
|
[
|
|
154
159
|
:account_id,
|
|
@@ -160,10 +165,12 @@ module Straddle
|
|
|
160
165
|
:sort_by,
|
|
161
166
|
:sort_order
|
|
162
167
|
]
|
|
168
|
+
parsed, options = Straddle::Embed::RepresentativeListParams.dump_request(params)
|
|
169
|
+
query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
163
170
|
@client.request(
|
|
164
171
|
method: :get,
|
|
165
172
|
path: "v1/representatives",
|
|
166
|
-
query:
|
|
173
|
+
query: query,
|
|
167
174
|
headers: parsed.except(*query_params).transform_keys(
|
|
168
175
|
correlation_id: "correlation-id",
|
|
169
176
|
request_id: "request-id"
|
|
@@ -3,15 +3,34 @@
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
5
|
class Embed
|
|
6
|
+
# Accounts represent businesses using Straddle through your platform. Each account
|
|
7
|
+
# must complete automated verification before processing payments. Use accounts to
|
|
8
|
+
# manage your users' payment capabilities, track verification status, and control
|
|
9
|
+
# access to features. Accounts can be instantly created in sandbox and require
|
|
10
|
+
# additional verification for production access.
|
|
6
11
|
# @return [Straddle::Resources::Embed::Accounts]
|
|
7
12
|
attr_reader :accounts
|
|
8
13
|
|
|
14
|
+
# Linked bank accounts connect your platform users' external bank accounts to
|
|
15
|
+
# Straddle for settlements and payment funding. Each linked account undergoes
|
|
16
|
+
# automated verification and continuous monitoring. Use linked accounts to manage
|
|
17
|
+
# where clients receive deposits, fund payouts, and track settlement preferences.
|
|
9
18
|
# @return [Straddle::Resources::Embed::LinkedBankAccounts]
|
|
10
19
|
attr_reader :linked_bank_accounts
|
|
11
20
|
|
|
21
|
+
# Organizations are a powerful feature in Straddle that allow you to manage
|
|
22
|
+
# multiple accounts under a single umbrella. This hierarchical structure is
|
|
23
|
+
# particularly useful for businesses with complex operations, multiple
|
|
24
|
+
# departments, or legally related entities.
|
|
12
25
|
# @return [Straddle::Resources::Embed::Organizations]
|
|
13
26
|
attr_reader :organizations
|
|
14
27
|
|
|
28
|
+
# Representatives are individuals who have legal authority or significant
|
|
29
|
+
# responsibility within a business entity associated with a Straddle account. Each
|
|
30
|
+
# representative undergoes automated verification as part of KYC/KYB compliance.
|
|
31
|
+
# Use representatives to collect and verify beneficial owners, control persons,
|
|
32
|
+
# and authorized signers required for account onboarding. Representatives also
|
|
33
|
+
# determine who can legally operate the account and make important changes.
|
|
15
34
|
# @return [Straddle::Resources::Embed::Representatives]
|
|
16
35
|
attr_reader :representatives
|
|
17
36
|
|
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
|
+
# Funding events represent all money movement between Straddle and an Account's
|
|
6
|
+
# external bank accounts. They are automatically generated when charges settle or
|
|
7
|
+
# payouts are initiated. Each event provides detailed tracking of settlement
|
|
8
|
+
# status, fee breakdowns, and reconciliation data across both incoming and
|
|
9
|
+
# outgoing transfers. Use funding events to monitor your platform's entire money
|
|
10
|
+
# movement lifecycle.
|
|
5
11
|
class FundingEvents
|
|
6
12
|
# Some parameter documentations has been truncated, see
|
|
7
13
|
# {Straddle::Models::FundingEventListParams} for more details.
|
|
@@ -9,7 +15,7 @@ module Straddle
|
|
|
9
15
|
# Retrieves a list of funding events for your account. This endpoint supports
|
|
10
16
|
# advanced sorting and filtering options.
|
|
11
17
|
#
|
|
12
|
-
# @overload list(created_from: nil, created_to: nil, direction: nil, event_type: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, trace_number: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
18
|
+
# @overload list(created_from: nil, created_to: nil, direction: nil, event_type: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, status: nil, status_reason: nil, status_source: nil, trace_id: nil, trace_number: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
13
19
|
#
|
|
14
20
|
# @param created_from [Date, nil] Query param: The start date of the range to filter by using the `YYYY-MM-DD` for
|
|
15
21
|
#
|
|
@@ -23,10 +29,20 @@ module Straddle
|
|
|
23
29
|
#
|
|
24
30
|
# @param page_size [Integer] Query param: Results page size. Max value: 1000
|
|
25
31
|
#
|
|
32
|
+
# @param search_text [String, nil] Query param: Search text.
|
|
33
|
+
#
|
|
26
34
|
# @param sort_by [Symbol, Straddle::Models::FundingEventListParams::SortBy] Query param: The field to sort the results by.
|
|
27
35
|
#
|
|
28
36
|
# @param sort_order [Symbol, Straddle::Models::FundingEventListParams::SortOrder] Query param: The order in which to sort the results.
|
|
29
37
|
#
|
|
38
|
+
# @param status [Array<Symbol, Straddle::Models::FundingEventListParams::Status>, nil] Query param: Funding Event status.
|
|
39
|
+
#
|
|
40
|
+
# @param status_reason [Array<Symbol, Straddle::Models::FundingEventListParams::StatusReason>, nil] Query param: Reason for latest payment status change.
|
|
41
|
+
#
|
|
42
|
+
# @param status_source [Array<Symbol, Straddle::Models::FundingEventListParams::StatusSource>, nil] Query param: Source of latest payment status change.
|
|
43
|
+
#
|
|
44
|
+
# @param trace_id [String, nil] Query param: Trace Id.
|
|
45
|
+
#
|
|
30
46
|
# @param trace_number [String, nil] Query param: Trace number.
|
|
31
47
|
#
|
|
32
48
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
@@ -41,7 +57,6 @@ module Straddle
|
|
|
41
57
|
#
|
|
42
58
|
# @see Straddle::Models::FundingEventListParams
|
|
43
59
|
def list(params = {})
|
|
44
|
-
parsed, options = Straddle::FundingEventListParams.dump_request(params)
|
|
45
60
|
query_params =
|
|
46
61
|
[
|
|
47
62
|
:created_from,
|
|
@@ -50,14 +65,21 @@ module Straddle
|
|
|
50
65
|
:event_type,
|
|
51
66
|
:page_number,
|
|
52
67
|
:page_size,
|
|
68
|
+
:search_text,
|
|
53
69
|
:sort_by,
|
|
54
70
|
:sort_order,
|
|
71
|
+
:status,
|
|
72
|
+
:status_reason,
|
|
73
|
+
:status_source,
|
|
74
|
+
:trace_id,
|
|
55
75
|
:trace_number
|
|
56
76
|
]
|
|
77
|
+
parsed, options = Straddle::FundingEventListParams.dump_request(params)
|
|
78
|
+
query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
57
79
|
@client.request(
|
|
58
80
|
method: :get,
|
|
59
81
|
path: "v1/funding_events",
|
|
60
|
-
query:
|
|
82
|
+
query: query,
|
|
61
83
|
headers: parsed.except(*query_params).transform_keys(
|
|
62
84
|
correlation_id: "correlation-id",
|
|
63
85
|
request_id: "request-id",
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Straddle
|
|
4
|
+
module Resources
|
|
5
|
+
class Paykeys
|
|
6
|
+
# Paykeys are secure tokens that link verified customer identities to their bank
|
|
7
|
+
# accounts. Each Paykey includes built-in balance checking, fraud detection
|
|
8
|
+
# through LSTM machine learning models, and can be reused for subscriptions and
|
|
9
|
+
# recurring payments without storing sensitive data. Paykeys eliminate fraud by
|
|
10
|
+
# ensuring the person initiating payment owns the funding account.
|
|
11
|
+
class Review
|
|
12
|
+
# Some parameter documentations has been truncated, see
|
|
13
|
+
# {Straddle::Models::Paykeys::ReviewDecisionParams} for more details.
|
|
14
|
+
#
|
|
15
|
+
# Update the status of a paykey when in review status
|
|
16
|
+
#
|
|
17
|
+
# @overload decision(id, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
18
|
+
#
|
|
19
|
+
# @param id [String] Path param
|
|
20
|
+
#
|
|
21
|
+
# @param status [Symbol, Straddle::Models::Paykeys::ReviewDecisionParams::Status] Body param
|
|
22
|
+
#
|
|
23
|
+
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
24
|
+
#
|
|
25
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
26
|
+
#
|
|
27
|
+
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
28
|
+
#
|
|
29
|
+
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
30
|
+
#
|
|
31
|
+
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
32
|
+
#
|
|
33
|
+
# @return [Straddle::Models::PaykeyV1]
|
|
34
|
+
#
|
|
35
|
+
# @see Straddle::Models::Paykeys::ReviewDecisionParams
|
|
36
|
+
def decision(id, params)
|
|
37
|
+
parsed, options = Straddle::Paykeys::ReviewDecisionParams.dump_request(params)
|
|
38
|
+
header_params =
|
|
39
|
+
{
|
|
40
|
+
correlation_id: "correlation-id",
|
|
41
|
+
idempotency_key: "idempotency-key",
|
|
42
|
+
request_id: "request-id",
|
|
43
|
+
straddle_account_id: "straddle-account-id"
|
|
44
|
+
}
|
|
45
|
+
@client.request(
|
|
46
|
+
method: :patch,
|
|
47
|
+
path: ["v1/paykeys/%1$s/review", id],
|
|
48
|
+
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
49
|
+
body: parsed.except(*header_params.keys),
|
|
50
|
+
model: Straddle::PaykeyV1,
|
|
51
|
+
options: options
|
|
52
|
+
)
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Get additional details about a paykey.
|
|
56
|
+
#
|
|
57
|
+
# @overload get(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
58
|
+
#
|
|
59
|
+
# @param id [String]
|
|
60
|
+
#
|
|
61
|
+
# @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
|
|
62
|
+
#
|
|
63
|
+
# @param request_id [String] Optional client generated identifier to trace and debug a request.
|
|
64
|
+
#
|
|
65
|
+
# @param straddle_account_id [String] For use by platforms to specify an account id and set scope of a request.
|
|
66
|
+
#
|
|
67
|
+
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
68
|
+
#
|
|
69
|
+
# @return [Straddle::Models::Paykeys::ReviewGetResponse]
|
|
70
|
+
#
|
|
71
|
+
# @see Straddle::Models::Paykeys::ReviewGetParams
|
|
72
|
+
def get(id, params = {})
|
|
73
|
+
parsed, options = Straddle::Paykeys::ReviewGetParams.dump_request(params)
|
|
74
|
+
@client.request(
|
|
75
|
+
method: :get,
|
|
76
|
+
path: ["v1/paykeys/%1$s/review", id],
|
|
77
|
+
headers: parsed.transform_keys(
|
|
78
|
+
correlation_id: "correlation-id",
|
|
79
|
+
request_id: "request-id",
|
|
80
|
+
straddle_account_id: "straddle-account-id"
|
|
81
|
+
),
|
|
82
|
+
model: Straddle::Models::Paykeys::ReviewGetResponse,
|
|
83
|
+
options: options
|
|
84
|
+
)
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Updates the decision of a paykey's review validation. This endpoint allows you
|
|
88
|
+
# to refresh the outcome of a paykey's decision and is useful for correcting or
|
|
89
|
+
# updating the status of a paykey's verification.
|
|
90
|
+
#
|
|
91
|
+
# @overload refresh_review(id, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
92
|
+
#
|
|
93
|
+
# @param id [String]
|
|
94
|
+
#
|
|
95
|
+
# @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
|
|
96
|
+
#
|
|
97
|
+
# @param idempotency_key [String] Optional client generated value to use for idempotent requests.
|
|
98
|
+
#
|
|
99
|
+
# @param request_id [String] Optional client generated identifier to trace and debug a request.
|
|
100
|
+
#
|
|
101
|
+
# @param straddle_account_id [String] For use by platforms to specify an account id and set scope of a request.
|
|
102
|
+
#
|
|
103
|
+
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
104
|
+
#
|
|
105
|
+
# @return [Straddle::Models::PaykeyV1]
|
|
106
|
+
#
|
|
107
|
+
# @see Straddle::Models::Paykeys::ReviewRefreshReviewParams
|
|
108
|
+
def refresh_review(id, params = {})
|
|
109
|
+
parsed, options = Straddle::Paykeys::ReviewRefreshReviewParams.dump_request(params)
|
|
110
|
+
@client.request(
|
|
111
|
+
method: :put,
|
|
112
|
+
path: ["v1/paykeys/%1$s/refresh_review", id],
|
|
113
|
+
headers: parsed.transform_keys(
|
|
114
|
+
correlation_id: "correlation-id",
|
|
115
|
+
idempotency_key: "idempotency-key",
|
|
116
|
+
request_id: "request-id",
|
|
117
|
+
straddle_account_id: "straddle-account-id"
|
|
118
|
+
),
|
|
119
|
+
model: Straddle::PaykeyV1,
|
|
120
|
+
options: options
|
|
121
|
+
)
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
# @api private
|
|
125
|
+
#
|
|
126
|
+
# @param client [Straddle::Client]
|
|
127
|
+
def initialize(client:)
|
|
128
|
+
@client = client
|
|
129
|
+
end
|
|
130
|
+
end
|
|
131
|
+
end
|
|
132
|
+
end
|
|
133
|
+
end
|