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
|
@@ -66,8 +66,8 @@ module Straddle
|
|
|
66
66
|
# @!attribute description
|
|
67
67
|
# An arbitrary description for the payout.
|
|
68
68
|
#
|
|
69
|
-
# @return [String]
|
|
70
|
-
required :description, String
|
|
69
|
+
# @return [String, nil]
|
|
70
|
+
required :description, String, nil?: true
|
|
71
71
|
|
|
72
72
|
# @!attribute device
|
|
73
73
|
# Information about the device used when the customer authorized the payout.
|
|
@@ -120,6 +120,12 @@ module Straddle
|
|
|
120
120
|
required :status_history,
|
|
121
121
|
-> { Straddle::Internal::Type::ArrayOf[Straddle::PayoutV1::Data::StatusHistory] }
|
|
122
122
|
|
|
123
|
+
# @!attribute trace_ids
|
|
124
|
+
# Trace Ids.
|
|
125
|
+
#
|
|
126
|
+
# @return [Hash{Symbol=>String}]
|
|
127
|
+
required :trace_ids, Straddle::Internal::Type::HashOf[String]
|
|
128
|
+
|
|
123
129
|
# @!attribute created_at
|
|
124
130
|
# The time the payout was created.
|
|
125
131
|
#
|
|
@@ -165,13 +171,21 @@ module Straddle
|
|
|
165
171
|
# @return [Time, nil]
|
|
166
172
|
optional :processed_at, Time, nil?: true
|
|
167
173
|
|
|
174
|
+
# @!attribute related_payments
|
|
175
|
+
# Related payments.
|
|
176
|
+
#
|
|
177
|
+
# @return [Hash{Symbol=>Symbol, Straddle::Models::PayoutV1::Data::RelatedPayment}, nil]
|
|
178
|
+
optional :related_payments,
|
|
179
|
+
-> { Straddle::Internal::Type::HashOf[enum: Straddle::PayoutV1::Data::RelatedPayment] },
|
|
180
|
+
nil?: true
|
|
181
|
+
|
|
168
182
|
# @!attribute updated_at
|
|
169
183
|
# The time the payout was last updated.
|
|
170
184
|
#
|
|
171
185
|
# @return [Time, nil]
|
|
172
186
|
optional :updated_at, Time, nil?: true
|
|
173
187
|
|
|
174
|
-
# @!method initialize(id:, amount:, config:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, created_at: nil, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, updated_at: nil)
|
|
188
|
+
# @!method initialize(id:, amount:, config:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, trace_ids:, created_at: nil, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, related_payments: nil, updated_at: nil)
|
|
175
189
|
# Some parameter documentations has been truncated, see
|
|
176
190
|
# {Straddle::Models::PayoutV1::Data} for more details.
|
|
177
191
|
#
|
|
@@ -183,7 +197,7 @@ module Straddle
|
|
|
183
197
|
#
|
|
184
198
|
# @param currency [String] The currency of the payout. Only USD is supported.
|
|
185
199
|
#
|
|
186
|
-
# @param description [String] An arbitrary description for the payout.
|
|
200
|
+
# @param description [String, nil] An arbitrary description for the payout.
|
|
187
201
|
#
|
|
188
202
|
# @param device [Straddle::Models::DeviceInfoV1] Information about the device used when the customer authorized the payout.
|
|
189
203
|
#
|
|
@@ -201,6 +215,8 @@ module Straddle
|
|
|
201
215
|
#
|
|
202
216
|
# @param status_history [Array<Straddle::Models::PayoutV1::Data::StatusHistory>] History of the status changes for the payout.
|
|
203
217
|
#
|
|
218
|
+
# @param trace_ids [Hash{Symbol=>String}] Trace Ids.
|
|
219
|
+
#
|
|
204
220
|
# @param created_at [Time, nil] The time the payout was created.
|
|
205
221
|
#
|
|
206
222
|
# @param customer_details [Straddle::Models::CustomerDetailsV1] Information about the customer associated with the payout.
|
|
@@ -215,19 +231,37 @@ module Straddle
|
|
|
215
231
|
#
|
|
216
232
|
# @param processed_at [Time, nil] The time the payout was processed by Straddle and originated to the payment rail
|
|
217
233
|
#
|
|
234
|
+
# @param related_payments [Hash{Symbol=>Symbol, Straddle::Models::PayoutV1::Data::RelatedPayment}, nil] Related payments.
|
|
235
|
+
#
|
|
218
236
|
# @param updated_at [Time, nil] The time the payout was last updated.
|
|
219
237
|
|
|
220
238
|
# @see Straddle::Models::PayoutV1::Data#config
|
|
221
239
|
class Config < Straddle::Internal::Type::BaseModel
|
|
240
|
+
# @!attribute auto_hold
|
|
241
|
+
# Defines whether to automatically place this charge on hold after being created.
|
|
242
|
+
#
|
|
243
|
+
# @return [Boolean, nil]
|
|
244
|
+
optional :auto_hold, Straddle::Internal::Type::Boolean, nil?: true
|
|
245
|
+
|
|
246
|
+
# @!attribute auto_hold_message
|
|
247
|
+
# The reason the payout is being automatically held on creation.
|
|
248
|
+
#
|
|
249
|
+
# @return [String, nil]
|
|
250
|
+
optional :auto_hold_message, String, nil?: true
|
|
251
|
+
|
|
222
252
|
# @!attribute sandbox_outcome
|
|
223
253
|
# Payment will simulate processing if not Standard.
|
|
224
254
|
#
|
|
225
255
|
# @return [Symbol, Straddle::Models::PayoutV1::Data::Config::SandboxOutcome, nil]
|
|
226
256
|
optional :sandbox_outcome, enum: -> { Straddle::PayoutV1::Data::Config::SandboxOutcome }
|
|
227
257
|
|
|
228
|
-
# @!method initialize(sandbox_outcome: nil)
|
|
258
|
+
# @!method initialize(auto_hold: nil, auto_hold_message: nil, sandbox_outcome: nil)
|
|
229
259
|
# Configuration for the payout.
|
|
230
260
|
#
|
|
261
|
+
# @param auto_hold [Boolean, nil] Defines whether to automatically place this charge on hold after being created.
|
|
262
|
+
#
|
|
263
|
+
# @param auto_hold_message [String, nil] The reason the payout is being automatically held on creation.
|
|
264
|
+
#
|
|
231
265
|
# @param sandbox_outcome [Symbol, Straddle::Models::PayoutV1::Data::Config::SandboxOutcome] Payment will simulate processing if not Standard.
|
|
232
266
|
|
|
233
267
|
# Payment will simulate processing if not Standard.
|
|
@@ -267,6 +301,7 @@ module Straddle
|
|
|
267
301
|
PENDING = :pending
|
|
268
302
|
PAID = :paid
|
|
269
303
|
REVERSED = :reversed
|
|
304
|
+
VALIDATING = :validating
|
|
270
305
|
|
|
271
306
|
# @!method self.values
|
|
272
307
|
# @return [Array<Symbol>]
|
|
@@ -354,6 +389,13 @@ module Straddle
|
|
|
354
389
|
OK = :ok
|
|
355
390
|
OTHER_NETWORK_RETURN = :other_network_return
|
|
356
391
|
PAYOUT_REFUSED = :payout_refused
|
|
392
|
+
CANCEL_REQUEST = :cancel_request
|
|
393
|
+
FAILED_VERIFICATION = :failed_verification
|
|
394
|
+
REQUIRE_REVIEW = :require_review
|
|
395
|
+
BLOCKED_BY_SYSTEM = :blocked_by_system
|
|
396
|
+
WATCHTOWER_REVIEW = :watchtower_review
|
|
397
|
+
VALIDATING = :validating
|
|
398
|
+
AUTO_HOLD = :auto_hold
|
|
357
399
|
|
|
358
400
|
# @!method self.values
|
|
359
401
|
# @return [Array<Symbol>]
|
|
@@ -390,6 +432,7 @@ module Straddle
|
|
|
390
432
|
PENDING = :pending
|
|
391
433
|
PAID = :paid
|
|
392
434
|
REVERSED = :reversed
|
|
435
|
+
VALIDATING = :validating
|
|
393
436
|
|
|
394
437
|
# @!method self.values
|
|
395
438
|
# @return [Array<Symbol>]
|
|
@@ -407,6 +450,17 @@ module Straddle
|
|
|
407
450
|
# @!method self.values
|
|
408
451
|
# @return [Array<Symbol>]
|
|
409
452
|
end
|
|
453
|
+
|
|
454
|
+
module RelatedPayment
|
|
455
|
+
extend Straddle::Internal::Type::Enum
|
|
456
|
+
|
|
457
|
+
ORIGINAL = :original
|
|
458
|
+
RESUBMIT = :resubmit
|
|
459
|
+
REFUND = :refund
|
|
460
|
+
|
|
461
|
+
# @!method self.values
|
|
462
|
+
# @return [Array<Symbol>]
|
|
463
|
+
end
|
|
410
464
|
end
|
|
411
465
|
|
|
412
466
|
# Indicates the structure of the returned content.
|
|
@@ -76,6 +76,13 @@ module Straddle
|
|
|
76
76
|
OK = :ok
|
|
77
77
|
OTHER_NETWORK_RETURN = :other_network_return
|
|
78
78
|
PAYOUT_REFUSED = :payout_refused
|
|
79
|
+
CANCEL_REQUEST = :cancel_request
|
|
80
|
+
FAILED_VERIFICATION = :failed_verification
|
|
81
|
+
REQUIRE_REVIEW = :require_review
|
|
82
|
+
BLOCKED_BY_SYSTEM = :blocked_by_system
|
|
83
|
+
WATCHTOWER_REVIEW = :watchtower_review
|
|
84
|
+
VALIDATING = :validating
|
|
85
|
+
AUTO_HOLD = :auto_hold
|
|
79
86
|
|
|
80
87
|
# @!method self.values
|
|
81
88
|
# @return [Array<Symbol>]
|
data/lib/straddle/models.rb
CHANGED
|
@@ -73,8 +73,6 @@ module Straddle
|
|
|
73
73
|
|
|
74
74
|
CustomerListParams = Straddle::Models::CustomerListParams
|
|
75
75
|
|
|
76
|
-
CustomerRefreshReviewParams = Straddle::Models::CustomerRefreshReviewParams
|
|
77
|
-
|
|
78
76
|
Customers = Straddle::Models::Customers
|
|
79
77
|
|
|
80
78
|
CustomerSummaryPagedV1 = Straddle::Models::CustomerSummaryPagedV1
|
|
@@ -113,7 +111,7 @@ module Straddle
|
|
|
113
111
|
|
|
114
112
|
PaykeyRevealParams = Straddle::Models::PaykeyRevealParams
|
|
115
113
|
|
|
116
|
-
|
|
114
|
+
Paykeys = Straddle::Models::Paykeys
|
|
117
115
|
|
|
118
116
|
PaykeySummaryPagedV1 = Straddle::Models::PaykeySummaryPagedV1
|
|
119
117
|
|
|
@@ -121,6 +119,8 @@ module Straddle
|
|
|
121
119
|
|
|
122
120
|
PaykeyUnmaskedV1 = Straddle::Models::PaykeyUnmaskedV1
|
|
123
121
|
|
|
122
|
+
PaykeyUpdateBalanceParams = Straddle::Models::PaykeyUpdateBalanceParams
|
|
123
|
+
|
|
124
124
|
PaykeyV1 = Straddle::Models::PaykeyV1
|
|
125
125
|
|
|
126
126
|
PaymentListParams = Straddle::Models::PaymentListParams
|
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
5
|
class Bridge
|
|
6
|
+
# Bridge provides a comprehensive suite of tools for connecting customer bank
|
|
7
|
+
# accounts. Use it to generate secure widget sessions for instant account
|
|
8
|
+
# verification, accept tokens from major providers like Plaid and Finicity, or
|
|
9
|
+
# verify accounts directly via our API. Bridge handles all sensitive banking
|
|
10
|
+
# credentials and ensures secure, compliant connections with support for 90% of US
|
|
11
|
+
# bank accounts.
|
|
6
12
|
class Link
|
|
7
13
|
# Some parameter documentations has been truncated, see
|
|
8
14
|
# {Straddle::Models::Bridge::LinkBankAccountParams} for more details.
|
|
@@ -11,17 +17,19 @@ module Straddle
|
|
|
11
17
|
# source. This endpoint allows you to create a secure payment token linked to a
|
|
12
18
|
# specific bank account.
|
|
13
19
|
#
|
|
14
|
-
# @overload bank_account(account_number:, account_type:, customer_id:, routing_number:, config: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
20
|
+
# @overload bank_account(account_number:, account_type:, customer_id:, routing_number:, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
15
21
|
#
|
|
16
22
|
# @param account_number [String] Body param: The bank account number.
|
|
17
23
|
#
|
|
18
|
-
# @param account_type [Symbol, Straddle::Models::Bridge::LinkBankAccountParams::AccountType] Body param
|
|
24
|
+
# @param account_type [Symbol, Straddle::Models::Bridge::LinkBankAccountParams::AccountType] Body param
|
|
19
25
|
#
|
|
20
26
|
# @param customer_id [String] Body param: Unique identifier of the related customer object.
|
|
21
27
|
#
|
|
22
28
|
# @param routing_number [String] Body param: The routing number of the bank account.
|
|
23
29
|
#
|
|
24
|
-
# @param config [Straddle::Models::Bridge::LinkBankAccountParams::Config] Body param
|
|
30
|
+
# @param config [Straddle::Models::Bridge::LinkBankAccountParams::Config] Body param
|
|
31
|
+
#
|
|
32
|
+
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
25
33
|
#
|
|
26
34
|
# @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
|
|
27
35
|
#
|
|
@@ -64,13 +72,15 @@ module Straddle
|
|
|
64
72
|
# you to create a secure payment token linked to a bank account authenticated
|
|
65
73
|
# through Quiltt.
|
|
66
74
|
#
|
|
67
|
-
# @overload create_paykey(customer_id:, quiltt_token:, config: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
75
|
+
# @overload create_paykey(customer_id:, quiltt_token:, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
68
76
|
#
|
|
69
77
|
# @param customer_id [String] Body param: Unique identifier of the related customer object.
|
|
70
78
|
#
|
|
71
79
|
# @param quiltt_token [String] Body param: Quiltt processor token generated by your application for use with th
|
|
72
80
|
#
|
|
73
|
-
# @param config [Straddle::Models::Bridge::LinkCreatePaykeyParams::Config] Body param
|
|
81
|
+
# @param config [Straddle::Models::Bridge::LinkCreatePaykeyParams::Config] Body param
|
|
82
|
+
#
|
|
83
|
+
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
74
84
|
#
|
|
75
85
|
# @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
|
|
76
86
|
#
|
|
@@ -109,9 +119,9 @@ module Straddle
|
|
|
109
119
|
# Some parameter documentations has been truncated, see
|
|
110
120
|
# {Straddle::Models::Bridge::LinkCreateTanParams} for more details.
|
|
111
121
|
#
|
|
112
|
-
# @overload create_tan(account_type:, customer_id:, routing_number:, tan:, config: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
122
|
+
# @overload create_tan(account_type:, customer_id:, routing_number:, tan:, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
113
123
|
#
|
|
114
|
-
# @param account_type [Symbol, Straddle::Models::Bridge::LinkCreateTanParams::AccountType] Body param
|
|
124
|
+
# @param account_type [Symbol, Straddle::Models::Bridge::LinkCreateTanParams::AccountType] Body param
|
|
115
125
|
#
|
|
116
126
|
# @param customer_id [String] Body param: Unique identifier of the related customer object.
|
|
117
127
|
#
|
|
@@ -119,7 +129,9 @@ module Straddle
|
|
|
119
129
|
#
|
|
120
130
|
# @param tan [String] Body param: Tokenized account number.
|
|
121
131
|
#
|
|
122
|
-
# @param config [Straddle::Models::Bridge::LinkCreateTanParams::Config] Body param
|
|
132
|
+
# @param config [Straddle::Models::Bridge::LinkCreateTanParams::Config] Body param
|
|
133
|
+
#
|
|
134
|
+
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
123
135
|
#
|
|
124
136
|
# @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
|
|
125
137
|
#
|
|
@@ -162,13 +174,15 @@ module Straddle
|
|
|
162
174
|
# endpoint allows you to create a secure payment token linked to a bank account
|
|
163
175
|
# authenticated through Plaid.
|
|
164
176
|
#
|
|
165
|
-
# @overload plaid(customer_id:, plaid_token:, config: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
177
|
+
# @overload plaid(customer_id:, plaid_token:, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
166
178
|
#
|
|
167
179
|
# @param customer_id [String] Body param: Unique identifier of the related customer object.
|
|
168
180
|
#
|
|
169
181
|
# @param plaid_token [String] Body param: Plaid processor token generated by your application for use with the
|
|
170
182
|
#
|
|
171
|
-
# @param config [Straddle::Models::Bridge::LinkPlaidParams::Config] Body param
|
|
183
|
+
# @param config [Straddle::Models::Bridge::LinkPlaidParams::Config] Body param
|
|
184
|
+
#
|
|
185
|
+
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
172
186
|
#
|
|
173
187
|
# @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
|
|
174
188
|
#
|
|
@@ -2,7 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
|
+
# Bridge provides a comprehensive suite of tools for connecting customer bank
|
|
6
|
+
# accounts. Use it to generate secure widget sessions for instant account
|
|
7
|
+
# verification, accept tokens from major providers like Plaid and Finicity, or
|
|
8
|
+
# verify accounts directly via our API. Bridge handles all sensitive banking
|
|
9
|
+
# credentials and ensures secure, compliant connections with support for 90% of US
|
|
10
|
+
# bank accounts.
|
|
5
11
|
class Bridge
|
|
12
|
+
# Bridge provides a comprehensive suite of tools for connecting customer bank
|
|
13
|
+
# accounts. Use it to generate secure widget sessions for instant account
|
|
14
|
+
# verification, accept tokens from major providers like Plaid and Finicity, or
|
|
15
|
+
# verify accounts directly via our API. Bridge handles all sensitive banking
|
|
16
|
+
# credentials and ensures secure, compliant connections with support for 90% of US
|
|
17
|
+
# bank accounts.
|
|
6
18
|
# @return [Straddle::Resources::Bridge::Link]
|
|
7
19
|
attr_reader :link
|
|
8
20
|
|
|
@@ -11,11 +23,13 @@ module Straddle
|
|
|
11
23
|
#
|
|
12
24
|
# Use this endpoint to generate a session token for use in the Bridge widget.
|
|
13
25
|
#
|
|
14
|
-
# @overload initialize_(customer_id:, config: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
26
|
+
# @overload initialize_(customer_id:, config: nil, external_id: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
15
27
|
#
|
|
16
28
|
# @param customer_id [String] Body param: The Straddle generated unique identifier of the `customer` to create
|
|
17
29
|
#
|
|
18
|
-
# @param config [Straddle::Models::BridgeInitializeParams::Config] Body param
|
|
30
|
+
# @param config [Straddle::Models::BridgeInitializeParams::Config] Body param
|
|
31
|
+
#
|
|
32
|
+
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
19
33
|
#
|
|
20
34
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
21
35
|
#
|
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
|
+
# Charges represent attempts to debit money from a customer's bank account using a
|
|
6
|
+
# Paykey. Each charge includes automatic balance verification, real-time fraud
|
|
7
|
+
# screening, and multi-rail optimization and detailed status tracking throughout
|
|
8
|
+
# the payment lifecycle. Use charges to accept bank payments with confidence
|
|
9
|
+
# knowing every transaction is protected.
|
|
5
10
|
class Charges
|
|
6
11
|
# Some parameter documentations has been truncated, see
|
|
7
12
|
# {Straddle::Models::ChargeCreateParams} for more details.
|
|
@@ -12,15 +17,15 @@ module Straddle
|
|
|
12
17
|
#
|
|
13
18
|
# @param amount [Integer] Body param: The amount of the charge in cents.
|
|
14
19
|
#
|
|
15
|
-
# @param config [Straddle::Models::ChargeCreateParams::Config] Body param
|
|
20
|
+
# @param config [Straddle::Models::ChargeCreateParams::Config] Body param
|
|
16
21
|
#
|
|
17
22
|
# @param consent_type [Symbol, Straddle::Models::ChargeCreateParams::ConsentType] Body param: The channel or mechanism through which the payment was authorized. U
|
|
18
23
|
#
|
|
19
24
|
# @param currency [String] Body param: The currency of the charge. Only USD is supported.
|
|
20
25
|
#
|
|
21
|
-
# @param description [String] Body param: An arbitrary description for the charge.
|
|
26
|
+
# @param description [String, nil] Body param: An arbitrary description for the charge.
|
|
22
27
|
#
|
|
23
|
-
# @param device [Straddle::Models::DeviceInfoV1] Body param
|
|
28
|
+
# @param device [Straddle::Models::DeviceInfoV1] Body param
|
|
24
29
|
#
|
|
25
30
|
# @param external_id [String] Body param: Unique identifier for the charge in your database. This value must b
|
|
26
31
|
#
|
|
@@ -70,11 +75,11 @@ module Straddle
|
|
|
70
75
|
#
|
|
71
76
|
# @overload update(id, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
72
77
|
#
|
|
73
|
-
# @param id [String] Path param
|
|
78
|
+
# @param id [String] Path param
|
|
74
79
|
#
|
|
75
80
|
# @param amount [Integer] Body param: The amount of the charge in cents.
|
|
76
81
|
#
|
|
77
|
-
# @param description [String] Body param: An arbitrary description for the charge.
|
|
82
|
+
# @param description [String, nil] Body param: An arbitrary description for the charge.
|
|
78
83
|
#
|
|
79
84
|
# @param payment_date [Date] Body param: The desired date on which the payment should be occur. For charges,
|
|
80
85
|
#
|
|
@@ -120,7 +125,7 @@ module Straddle
|
|
|
120
125
|
#
|
|
121
126
|
# @overload cancel(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
122
127
|
#
|
|
123
|
-
# @param id [String] Path param
|
|
128
|
+
# @param id [String] Path param
|
|
124
129
|
#
|
|
125
130
|
# @param reason [String, nil] Body param: Details about why the charge status was updated.
|
|
126
131
|
#
|
|
@@ -197,7 +202,7 @@ module Straddle
|
|
|
197
202
|
#
|
|
198
203
|
# @overload hold(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
199
204
|
#
|
|
200
|
-
# @param id [String] Path param
|
|
205
|
+
# @param id [String] Path param
|
|
201
206
|
#
|
|
202
207
|
# @param reason [String, nil] Body param: Details about why the charge status was updated.
|
|
203
208
|
#
|
|
@@ -241,7 +246,7 @@ module Straddle
|
|
|
241
246
|
#
|
|
242
247
|
# @overload release(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
243
248
|
#
|
|
244
|
-
# @param id [String] Path param
|
|
249
|
+
# @param id [String] Path param
|
|
245
250
|
#
|
|
246
251
|
# @param reason [String, nil] Body param: Details about why the charge status was updated.
|
|
247
252
|
#
|
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
5
|
class Customers
|
|
6
|
+
# Customers represent the end users who send or receive payments through your
|
|
7
|
+
# integration. Each customer undergoes automatic identity verification and fraud
|
|
8
|
+
# screening upon creation. Use customers to track payment history, manage bank
|
|
9
|
+
# account connections, and maintain a secure record of all transactions associated
|
|
10
|
+
# with a user. Customers can be either individuals or businesses with appropriate
|
|
11
|
+
# compliance checks for each type.
|
|
6
12
|
class Review
|
|
7
13
|
# Some parameter documentations has been truncated, see
|
|
8
14
|
# {Straddle::Models::Customers::ReviewDecisionParams} for more details.
|
|
@@ -14,7 +20,7 @@ module Straddle
|
|
|
14
20
|
#
|
|
15
21
|
# @overload decision(id, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
16
22
|
#
|
|
17
|
-
# @param id [String] Path param
|
|
23
|
+
# @param id [String] Path param
|
|
18
24
|
#
|
|
19
25
|
# @param status [Symbol, Straddle::Models::Customers::ReviewDecisionParams::Status] Body param: The final status of the customer review.
|
|
20
26
|
#
|
|
@@ -90,6 +96,43 @@ module Straddle
|
|
|
90
96
|
)
|
|
91
97
|
end
|
|
92
98
|
|
|
99
|
+
# Updates the decision of a customer's identity validation. This endpoint allows
|
|
100
|
+
# you to modify the outcome of a customer decision and is useful for correcting or
|
|
101
|
+
# updating the status of a customer's verification.
|
|
102
|
+
#
|
|
103
|
+
# @overload refresh_review(id, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
104
|
+
#
|
|
105
|
+
# @param id [String]
|
|
106
|
+
#
|
|
107
|
+
# @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
|
|
108
|
+
#
|
|
109
|
+
# @param idempotency_key [String] Optional client generated value to use for idempotent requests.
|
|
110
|
+
#
|
|
111
|
+
# @param request_id [String] Optional client generated identifier to trace and debug a request.
|
|
112
|
+
#
|
|
113
|
+
# @param straddle_account_id [String] For use by platforms to specify an account id and set scope of a request.
|
|
114
|
+
#
|
|
115
|
+
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
116
|
+
#
|
|
117
|
+
# @return [Straddle::Models::CustomerV1]
|
|
118
|
+
#
|
|
119
|
+
# @see Straddle::Models::Customers::ReviewRefreshReviewParams
|
|
120
|
+
def refresh_review(id, params = {})
|
|
121
|
+
parsed, options = Straddle::Customers::ReviewRefreshReviewParams.dump_request(params)
|
|
122
|
+
@client.request(
|
|
123
|
+
method: :put,
|
|
124
|
+
path: ["v1/customers/%1$s/refresh_review", id],
|
|
125
|
+
headers: parsed.transform_keys(
|
|
126
|
+
correlation_id: "correlation-id",
|
|
127
|
+
idempotency_key: "idempotency-key",
|
|
128
|
+
request_id: "request-id",
|
|
129
|
+
straddle_account_id: "straddle-account-id"
|
|
130
|
+
),
|
|
131
|
+
model: Straddle::CustomerV1,
|
|
132
|
+
options: options
|
|
133
|
+
)
|
|
134
|
+
end
|
|
135
|
+
|
|
93
136
|
# @api private
|
|
94
137
|
#
|
|
95
138
|
# @param client [Straddle::Client]
|
|
@@ -2,7 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
module Straddle
|
|
4
4
|
module Resources
|
|
5
|
+
# Customers represent the end users who send or receive payments through your
|
|
6
|
+
# integration. Each customer undergoes automatic identity verification and fraud
|
|
7
|
+
# screening upon creation. Use customers to track payment history, manage bank
|
|
8
|
+
# account connections, and maintain a secure record of all transactions associated
|
|
9
|
+
# with a user. Customers can be either individuals or businesses with appropriate
|
|
10
|
+
# compliance checks for each type.
|
|
5
11
|
class Customers
|
|
12
|
+
# Customers represent the end users who send or receive payments through your
|
|
13
|
+
# integration. Each customer undergoes automatic identity verification and fraud
|
|
14
|
+
# screening upon creation. Use customers to track payment history, manage bank
|
|
15
|
+
# account connections, and maintain a secure record of all transactions associated
|
|
16
|
+
# with a user. Customers can be either individuals or businesses with appropriate
|
|
17
|
+
# compliance checks for each type.
|
|
6
18
|
# @return [Straddle::Resources::Customers::Review]
|
|
7
19
|
attr_reader :review
|
|
8
20
|
|
|
@@ -15,7 +27,7 @@ module Straddle
|
|
|
15
27
|
#
|
|
16
28
|
# @overload create(device:, email:, name:, phone:, type:, address: nil, compliance_profile: nil, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
17
29
|
#
|
|
18
|
-
# @param device [Straddle::Models::DeviceUnmaskedV1] Body param
|
|
30
|
+
# @param device [Straddle::Models::DeviceUnmaskedV1] Body param
|
|
19
31
|
#
|
|
20
32
|
# @param email [String] Body param: The customer's email address.
|
|
21
33
|
#
|
|
@@ -23,14 +35,14 @@ module Straddle
|
|
|
23
35
|
#
|
|
24
36
|
# @param phone [String] Body param: The customer's phone number in E.164 format. Mobile number is prefer
|
|
25
37
|
#
|
|
26
|
-
# @param type [Symbol, Straddle::Models::CustomerCreateParams::Type] Body param
|
|
38
|
+
# @param type [Symbol, Straddle::Models::CustomerCreateParams::Type] Body param
|
|
27
39
|
#
|
|
28
40
|
# @param address [Straddle::Models::CustomerAddressV1, nil] Body param: An object containing the customer's address. **This is optional.** I
|
|
29
41
|
#
|
|
30
42
|
# @param compliance_profile [Straddle::Models::CustomerCreateParams::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile, nil] Body param: An object containing the customer's compliance profile. \*\*This is
|
|
31
43
|
# op
|
|
32
44
|
#
|
|
33
|
-
# @param config [Straddle::Models::CustomerCreateParams::Config] Body param
|
|
45
|
+
# @param config [Straddle::Models::CustomerCreateParams::Config] Body param
|
|
34
46
|
#
|
|
35
47
|
# @param external_id [String, nil] Body param: Unique identifier for the customer in your database, used for cross-
|
|
36
48
|
#
|
|
@@ -76,9 +88,9 @@ module Straddle
|
|
|
76
88
|
#
|
|
77
89
|
# @overload update(id, device:, email:, name:, phone:, status:, address: nil, compliance_profile: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
78
90
|
#
|
|
79
|
-
# @param id [String] Path param
|
|
91
|
+
# @param id [String] Path param
|
|
80
92
|
#
|
|
81
|
-
# @param device [Straddle::Models::DeviceUnmaskedV1] Body param
|
|
93
|
+
# @param device [Straddle::Models::DeviceUnmaskedV1] Body param
|
|
82
94
|
#
|
|
83
95
|
# @param email [String] Body param: The customer's email address.
|
|
84
96
|
#
|
|
@@ -86,7 +98,7 @@ module Straddle
|
|
|
86
98
|
#
|
|
87
99
|
# @param phone [String] Body param: The customer's phone number in E.164 format.
|
|
88
100
|
#
|
|
89
|
-
# @param status [Symbol, Straddle::Models::CustomerUpdateParams::Status] Body param
|
|
101
|
+
# @param status [Symbol, Straddle::Models::CustomerUpdateParams::Status] Body param
|
|
90
102
|
#
|
|
91
103
|
# @param address [Straddle::Models::CustomerAddressV1, nil] Body param: An object containing the customer's address. This is optional, but i
|
|
92
104
|
#
|
|
@@ -154,9 +166,9 @@ module Straddle
|
|
|
154
166
|
#
|
|
155
167
|
# @param search_text [String] Query param: General search term to filter customers.
|
|
156
168
|
#
|
|
157
|
-
# @param sort_by [Symbol, Straddle::Models::CustomerListParams::SortBy] Query param
|
|
169
|
+
# @param sort_by [Symbol, Straddle::Models::CustomerListParams::SortBy] Query param
|
|
158
170
|
#
|
|
159
|
-
# @param sort_order [Symbol, Straddle::Models::CustomerListParams::SortOrder] Query param
|
|
171
|
+
# @param sort_order [Symbol, Straddle::Models::CustomerListParams::SortOrder] Query param
|
|
160
172
|
#
|
|
161
173
|
# @param status [Array<Symbol, Straddle::Models::CustomerListParams::Status>] Query param: Filter customers by their current `status`.
|
|
162
174
|
#
|
|
@@ -174,7 +186,6 @@ module Straddle
|
|
|
174
186
|
#
|
|
175
187
|
# @see Straddle::Models::CustomerListParams
|
|
176
188
|
def list(params = {})
|
|
177
|
-
parsed, options = Straddle::CustomerListParams.dump_request(params)
|
|
178
189
|
query_params =
|
|
179
190
|
[
|
|
180
191
|
:created_from,
|
|
@@ -190,10 +201,12 @@ module Straddle
|
|
|
190
201
|
:status,
|
|
191
202
|
:types
|
|
192
203
|
]
|
|
204
|
+
parsed, options = Straddle::CustomerListParams.dump_request(params)
|
|
205
|
+
query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
193
206
|
@client.request(
|
|
194
207
|
method: :get,
|
|
195
208
|
path: "v1/customers",
|
|
196
|
-
query:
|
|
209
|
+
query: query,
|
|
197
210
|
headers: parsed.except(*query_params).transform_keys(
|
|
198
211
|
correlation_id: "correlation-id",
|
|
199
212
|
request_id: "request-id",
|
|
@@ -276,43 +289,6 @@ module Straddle
|
|
|
276
289
|
)
|
|
277
290
|
end
|
|
278
291
|
|
|
279
|
-
# Updates the decision of a customer's identity validation. This endpoint allows
|
|
280
|
-
# you to modify the outcome of a customer decision and is useful for correcting or
|
|
281
|
-
# updating the status of a customer's verification.
|
|
282
|
-
#
|
|
283
|
-
# @overload refresh_review(id, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
284
|
-
#
|
|
285
|
-
# @param id [String]
|
|
286
|
-
#
|
|
287
|
-
# @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
|
|
288
|
-
#
|
|
289
|
-
# @param idempotency_key [String] Optional client generated value to use for idempotent requests.
|
|
290
|
-
#
|
|
291
|
-
# @param request_id [String] Optional client generated identifier to trace and debug a request.
|
|
292
|
-
#
|
|
293
|
-
# @param straddle_account_id [String] For use by platforms to specify an account id and set scope of a request.
|
|
294
|
-
#
|
|
295
|
-
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
296
|
-
#
|
|
297
|
-
# @return [Straddle::Models::CustomerV1]
|
|
298
|
-
#
|
|
299
|
-
# @see Straddle::Models::CustomerRefreshReviewParams
|
|
300
|
-
def refresh_review(id, params = {})
|
|
301
|
-
parsed, options = Straddle::CustomerRefreshReviewParams.dump_request(params)
|
|
302
|
-
@client.request(
|
|
303
|
-
method: :put,
|
|
304
|
-
path: ["v1/customers/%1$s/refresh_review", id],
|
|
305
|
-
headers: parsed.transform_keys(
|
|
306
|
-
correlation_id: "correlation-id",
|
|
307
|
-
idempotency_key: "idempotency-key",
|
|
308
|
-
request_id: "request-id",
|
|
309
|
-
straddle_account_id: "straddle-account-id"
|
|
310
|
-
),
|
|
311
|
-
model: Straddle::CustomerV1,
|
|
312
|
-
options: options
|
|
313
|
-
)
|
|
314
|
-
end
|
|
315
|
-
|
|
316
292
|
# Retrieves the unmasked details, including PII, of an existing customer. Supply
|
|
317
293
|
# the unique customer ID that was returned from your 'create customer' request,
|
|
318
294
|
# and Straddle will return the corresponding customer information. This endpoint
|
|
@@ -4,6 +4,10 @@ module Straddle
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Embed
|
|
6
6
|
class Accounts
|
|
7
|
+
# Capabilities enable specific features and services for an Account. Use
|
|
8
|
+
# capability requests to unlock higher processing limits, new payment types, or
|
|
9
|
+
# additional platform features as your users' businesses grow. Track approval
|
|
10
|
+
# status and manage documentation requirements through a single interface.
|
|
7
11
|
class CapabilityRequests
|
|
8
12
|
# Some parameter documentations has been truncated, see
|
|
9
13
|
# {Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams} for more
|
|
@@ -14,7 +18,7 @@ module Straddle
|
|
|
14
18
|
#
|
|
15
19
|
# @overload create(account_id, businesses: nil, charges: nil, individuals: nil, internet: nil, payouts: nil, signed_agreement: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
16
20
|
#
|
|
17
|
-
# @param account_id [String] Path param
|
|
21
|
+
# @param account_id [String] Path param
|
|
18
22
|
#
|
|
19
23
|
# @param businesses [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Businesses] Body param: Allows the account to accept payments from businesses.
|
|
20
24
|
#
|
|
@@ -63,7 +67,7 @@ module Straddle
|
|
|
63
67
|
#
|
|
64
68
|
# @overload list(account_id, category: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
|
|
65
69
|
#
|
|
66
|
-
# @param account_id [String] Path param
|
|
70
|
+
# @param account_id [String] Path param
|
|
67
71
|
#
|
|
68
72
|
# @param category [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::Category] Query param: Filter capability requests by category.
|
|
69
73
|
#
|
|
@@ -89,12 +93,13 @@ module Straddle
|
|
|
89
93
|
#
|
|
90
94
|
# @see Straddle::Models::Embed::Accounts::CapabilityRequestListParams
|
|
91
95
|
def list(account_id, params = {})
|
|
92
|
-
parsed, options = Straddle::Embed::Accounts::CapabilityRequestListParams.dump_request(params)
|
|
93
96
|
query_params = [:category, :page_number, :page_size, :sort_by, :sort_order, :status, :type]
|
|
97
|
+
parsed, options = Straddle::Embed::Accounts::CapabilityRequestListParams.dump_request(params)
|
|
98
|
+
query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
94
99
|
@client.request(
|
|
95
100
|
method: :get,
|
|
96
101
|
path: ["v1/accounts/%1$s/capability_requests", account_id],
|
|
97
|
-
query:
|
|
102
|
+
query: query,
|
|
98
103
|
headers: parsed.except(*query_params).transform_keys(
|
|
99
104
|
correlation_id: "correlation-id",
|
|
100
105
|
request_id: "request-id"
|