straddle 0.3.0 → 0.5.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 +127 -0
- data/README.md +32 -1
- data/lib/straddle/client.rb +49 -1
- data/lib/straddle/internal/transport/base_client.rb +5 -0
- data/lib/straddle/internal/transport/pooled_net_requester.rb +13 -11
- data/lib/straddle/internal/util.rb +61 -10
- data/lib/straddle/models/bridge/link_create_paykey_response.rb +8 -0
- data/lib/straddle/models/bridge/link_create_tan_response.rb +8 -0
- data/lib/straddle/models/charge_cancel_params.rb +8 -1
- data/lib/straddle/models/charge_create_params.rb +22 -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 +190 -5
- data/lib/straddle/models/charge_update_params.rb +11 -4
- data/lib/straddle/models/charge_v1.rb +188 -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 +7 -1
- data/lib/straddle/models/embed/account_get_params.rb +11 -1
- data/lib/straddle/models/embed/account_list_params.rb +8 -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_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.rb +2 -2
- data/lib/straddle/models/embed/representative_create_params.rb +2 -2
- data/lib/straddle/models/embed/representative_get_params.rb +7 -1
- data/lib/straddle/models/embed/representative_paged.rb +2 -2
- data/lib/straddle/models/embed/representative_unmask_params.rb +7 -1
- data/lib/straddle/models/embed/representative_update_params.rb +10 -3
- data/lib/straddle/models/funding_event_get_params.rb +7 -1
- data/lib/straddle/models/funding_event_list_params.rb +105 -1
- data/lib/straddle/models/funding_event_summary_item_v1.rb +128 -1
- data/lib/straddle/models/funding_event_summary_paged_v1.rb +128 -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 +40 -1
- data/lib/straddle/models/paykey_reveal_params.rb +7 -1
- data/lib/straddle/models/paykey_reveal_response.rb +8 -0
- data/lib/straddle/models/paykey_summary_paged_v1.rb +19 -1
- data/lib/straddle/models/paykey_unmasked_params.rb +7 -1
- data/lib/straddle/models/paykey_unmasked_v1.rb +8 -0
- data/lib/straddle/models/paykey_update_balance_params.rb +7 -1
- data/lib/straddle/models/paykey_v1.rb +19 -1
- data/lib/straddle/models/paykeys/review_decision_params.rb +7 -1
- data/lib/straddle/models/paykeys/review_get_params.rb +7 -1
- data/lib/straddle/models/paykeys/review_get_response.rb +19 -4
- data/lib/straddle/models/paykeys/review_refresh_review_params.rb +7 -1
- data/lib/straddle/models/payment_list_params.rb +71 -1
- data/lib/straddle/models/payment_summary_paged_v1.rb +110 -4
- data/lib/straddle/models/payout_cancel_params.rb +8 -1
- data/lib/straddle/models/payout_create_params.rb +22 -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 +193 -5
- data/lib/straddle/models/payout_update_params.rb +11 -4
- data/lib/straddle/models/payout_upload_authorization_document_params.rb +57 -0
- data/lib/straddle/models/payout_v1.rb +188 -5
- data/lib/straddle/models/status_details_v1.rb +7 -0
- data/lib/straddle/models.rb +2 -0
- data/lib/straddle/resources/bridge/link.rb +12 -6
- data/lib/straddle/resources/bridge.rb +13 -1
- data/lib/straddle/resources/charges.rb +13 -8
- data/lib/straddle/resources/customers/review.rb +7 -1
- data/lib/straddle/resources/customers.rb +23 -10
- data/lib/straddle/resources/embed/accounts/capability_requests.rb +9 -4
- data/lib/straddle/resources/embed/accounts.rb +29 -15
- data/lib/straddle/resources/embed/linked_bank_accounts.rb +11 -6
- 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 +22 -3
- data/lib/straddle/resources/paykeys/review.rb +7 -2
- data/lib/straddle/resources/paykeys.rb +42 -11
- data/lib/straddle/resources/payments.rb +30 -6
- data/lib/straddle/resources/payouts.rb +60 -7
- data/lib/straddle/version.rb +1 -1
- data/lib/straddle.rb +2 -0
- data/manifest.yaml +1 -0
- data/rbi/straddle/client.rbi +34 -0
- data/rbi/straddle/internal/util.rbi +29 -1
- data/rbi/straddle/models/bridge/link_create_paykey_response.rbi +40 -0
- data/rbi/straddle/models/bridge/link_create_tan_response.rbi +40 -0
- data/rbi/straddle/models/charge_cancel_params.rbi +6 -0
- data/rbi/straddle/models/charge_create_params.rbi +29 -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 +396 -6
- data/rbi/straddle/models/charge_update_params.rbi +9 -3
- data/rbi/straddle/models/charge_v1.rbi +364 -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 +6 -0
- data/rbi/straddle/models/embed/account_get_params.rbi +13 -1
- data/rbi/straddle/models/embed/account_list_params.rbi +9 -0
- 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_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.rbi +2 -2
- data/rbi/straddle/models/embed/representative_create_params.rbi +2 -2
- data/rbi/straddle/models/embed/representative_get_params.rbi +11 -1
- data/rbi/straddle/models/embed/representative_paged.rbi +2 -2
- data/rbi/straddle/models/embed/representative_unmask_params.rbi +11 -1
- data/rbi/straddle/models/embed/representative_update_params.rbi +8 -2
- data/rbi/straddle/models/funding_event_get_params.rbi +6 -0
- data/rbi/straddle/models/funding_event_list_params.rbi +333 -0
- data/rbi/straddle/models/funding_event_summary_item_v1.rbi +392 -0
- data/rbi/straddle/models/funding_event_summary_paged_v1.rbi +393 -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 +52 -0
- data/rbi/straddle/models/paykey_reveal_params.rbi +6 -0
- data/rbi/straddle/models/paykey_reveal_response.rbi +40 -0
- data/rbi/straddle/models/paykey_summary_paged_v1.rbi +55 -3
- data/rbi/straddle/models/paykey_unmasked_params.rbi +6 -0
- data/rbi/straddle/models/paykey_unmasked_v1.rbi +40 -0
- data/rbi/straddle/models/paykey_update_balance_params.rbi +6 -0
- data/rbi/straddle/models/paykey_v1.rbi +52 -3
- data/rbi/straddle/models/paykeys/review_decision_params.rbi +6 -0
- data/rbi/straddle/models/paykeys/review_get_params.rbi +6 -0
- data/rbi/straddle/models/paykeys/review_get_response.rbi +55 -18
- data/rbi/straddle/models/paykeys/review_refresh_review_params.rbi +6 -0
- data/rbi/straddle/models/payment_list_params.rbi +126 -0
- data/rbi/straddle/models/payment_summary_paged_v1.rbi +214 -6
- data/rbi/straddle/models/payout_cancel_params.rbi +6 -0
- data/rbi/straddle/models/payout_create_params.rbi +29 -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 +393 -3
- data/rbi/straddle/models/payout_update_params.rbi +9 -3
- data/rbi/straddle/models/payout_upload_authorization_document_params.rbi +88 -0
- data/rbi/straddle/models/payout_v1.rbi +361 -3
- data/rbi/straddle/models/status_details_v1.rbi +29 -0
- data/rbi/straddle/models.rbi +3 -0
- data/rbi/straddle/resources/bridge/link.rbi +12 -6
- data/rbi/straddle/resources/bridge.rbi +13 -1
- data/rbi/straddle/resources/charges.rbi +13 -8
- data/rbi/straddle/resources/customers/review.rbi +7 -1
- data/rbi/straddle/resources/customers.rbi +20 -8
- data/rbi/straddle/resources/embed/accounts/capability_requests.rbi +6 -2
- data/rbi/straddle/resources/embed/accounts.rbi +22 -10
- data/rbi/straddle/resources/embed/linked_bank_accounts.rbi +8 -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 +27 -0
- data/rbi/straddle/resources/paykeys/review.rbi +7 -2
- data/rbi/straddle/resources/paykeys.rbi +32 -8
- data/rbi/straddle/resources/payments.rbi +28 -3
- data/rbi/straddle/resources/payouts.rbi +44 -7
- data/sig/straddle/internal/util.rbs +14 -0
- data/sig/straddle/models/bridge/link_create_paykey_response.rbs +17 -1
- data/sig/straddle/models/bridge/link_create_tan_response.rbs +17 -1
- data/sig/straddle/models/charge_cancel_params.rbs +5 -0
- data/sig/straddle/models/charge_create_params.rbs +18 -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 +166 -7
- data/sig/straddle/models/charge_update_params.rbs +9 -4
- data/sig/straddle/models/charge_v1.rbs +166 -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 +5 -0
- data/sig/straddle/models/embed/account_get_params.rbs +5 -1
- data/sig/straddle/models/embed/account_list_params.rbs +7 -0
- 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_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 +125 -0
- data/sig/straddle/models/funding_event_summary_item_v1.rbs +164 -0
- data/sig/straddle/models/funding_event_summary_paged_v1.rbs +164 -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 +31 -1
- data/sig/straddle/models/paykey_reveal_params.rbs +5 -0
- data/sig/straddle/models/paykey_reveal_response.rbs +17 -1
- data/sig/straddle/models/paykey_summary_paged_v1.rbs +25 -4
- data/sig/straddle/models/paykey_unmasked_params.rbs +5 -0
- data/sig/straddle/models/paykey_unmasked_v1.rbs +17 -1
- data/sig/straddle/models/paykey_update_balance_params.rbs +5 -0
- data/sig/straddle/models/paykey_v1.rbs +25 -4
- data/sig/straddle/models/paykeys/review_decision_params.rbs +5 -0
- data/sig/straddle/models/paykeys/review_get_params.rbs +5 -0
- data/sig/straddle/models/paykeys/review_get_response.rbs +28 -10
- data/sig/straddle/models/paykeys/review_refresh_review_params.rbs +5 -0
- data/sig/straddle/models/payment_list_params.rbs +80 -2
- data/sig/straddle/models/payment_summary_paged_v1.rbs +89 -7
- data/sig/straddle/models/payout_cancel_params.rbs +5 -0
- data/sig/straddle/models/payout_create_params.rbs +18 -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 +163 -4
- data/sig/straddle/models/payout_update_params.rbs +9 -4
- data/sig/straddle/models/payout_upload_authorization_document_params.rbs +59 -0
- data/sig/straddle/models/payout_v1.rbs +163 -4
- data/sig/straddle/models/status_details_v1.rbs +14 -0
- data/sig/straddle/models.rbs +2 -0
- data/sig/straddle/resources/charges.rbs +2 -2
- data/sig/straddle/resources/embed/accounts.rbs +1 -0
- data/sig/straddle/resources/funding_events.rbs +4 -0
- data/sig/straddle/resources/paykeys.rbs +4 -0
- data/sig/straddle/resources/payments.rbs +7 -0
- data/sig/straddle/resources/payouts.rbs +12 -2
- metadata +19 -2
|
@@ -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.
|
|
@@ -88,6 +88,24 @@ module Straddle
|
|
|
88
88
|
# @return [Array<String>]
|
|
89
89
|
required :funding_ids, Straddle::Internal::Type::ArrayOf[String]
|
|
90
90
|
|
|
91
|
+
# @!attribute has_resubmit
|
|
92
|
+
# Has the payout been resubmitted.
|
|
93
|
+
#
|
|
94
|
+
# @return [Boolean]
|
|
95
|
+
required :has_resubmit, Straddle::Internal::Type::Boolean
|
|
96
|
+
|
|
97
|
+
# @!attribute is_refund
|
|
98
|
+
# Is the payout a refund of an original charge.
|
|
99
|
+
#
|
|
100
|
+
# @return [Boolean]
|
|
101
|
+
required :is_refund, Straddle::Internal::Type::Boolean
|
|
102
|
+
|
|
103
|
+
# @!attribute is_resubmit
|
|
104
|
+
# Is the payout a resubmit of an original payout.
|
|
105
|
+
#
|
|
106
|
+
# @return [Boolean]
|
|
107
|
+
required :is_resubmit, Straddle::Internal::Type::Boolean
|
|
108
|
+
|
|
91
109
|
# @!attribute paykey
|
|
92
110
|
# Value of the `paykey` used for the payout.
|
|
93
111
|
#
|
|
@@ -120,6 +138,12 @@ module Straddle
|
|
|
120
138
|
required :status_history,
|
|
121
139
|
-> { Straddle::Internal::Type::ArrayOf[Straddle::PayoutV1::Data::StatusHistory] }
|
|
122
140
|
|
|
141
|
+
# @!attribute trace_ids
|
|
142
|
+
# Trace Ids.
|
|
143
|
+
#
|
|
144
|
+
# @return [Hash{Symbol=>String}]
|
|
145
|
+
required :trace_ids, Straddle::Internal::Type::HashOf[String]
|
|
146
|
+
|
|
123
147
|
# @!attribute created_at
|
|
124
148
|
# The time the payout was created.
|
|
125
149
|
#
|
|
@@ -132,6 +156,15 @@ module Straddle
|
|
|
132
156
|
# @return [Straddle::Models::CustomerDetailsV1, nil]
|
|
133
157
|
optional :customer_details, -> { Straddle::CustomerDetailsV1 }
|
|
134
158
|
|
|
159
|
+
# @!attribute documents
|
|
160
|
+
# Documents uploaded for this payout (e.g. proof of authorization), in the order
|
|
161
|
+
# they were uploaded.
|
|
162
|
+
#
|
|
163
|
+
# @return [Array<Straddle::Models::PayoutV1::Data::Document>, nil]
|
|
164
|
+
optional :documents,
|
|
165
|
+
-> { Straddle::Internal::Type::ArrayOf[Straddle::PayoutV1::Data::Document] },
|
|
166
|
+
nil?: true
|
|
167
|
+
|
|
135
168
|
# @!attribute effective_at
|
|
136
169
|
# The actual date on which the payment occurred. For payouts, this is the date the
|
|
137
170
|
# funds were sent from your bank account.
|
|
@@ -165,13 +198,21 @@ module Straddle
|
|
|
165
198
|
# @return [Time, nil]
|
|
166
199
|
optional :processed_at, Time, nil?: true
|
|
167
200
|
|
|
201
|
+
# @!attribute related_payments
|
|
202
|
+
# Related payments.
|
|
203
|
+
#
|
|
204
|
+
# @return [Array<Straddle::Models::PayoutV1::Data::RelatedPayment>, nil]
|
|
205
|
+
optional :related_payments,
|
|
206
|
+
-> { Straddle::Internal::Type::ArrayOf[Straddle::PayoutV1::Data::RelatedPayment] },
|
|
207
|
+
nil?: true
|
|
208
|
+
|
|
168
209
|
# @!attribute updated_at
|
|
169
210
|
# The time the payout was last updated.
|
|
170
211
|
#
|
|
171
212
|
# @return [Time, nil]
|
|
172
213
|
optional :updated_at, Time, nil?: true
|
|
173
214
|
|
|
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)
|
|
215
|
+
# @!method initialize(id:, amount:, config:, currency:, description:, device:, external_id:, funding_ids:, has_resubmit:, is_refund:, is_resubmit:, paykey:, payment_date:, status:, status_details:, status_history:, trace_ids:, created_at: nil, customer_details: nil, documents: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, related_payments: nil, updated_at: nil)
|
|
175
216
|
# Some parameter documentations has been truncated, see
|
|
176
217
|
# {Straddle::Models::PayoutV1::Data} for more details.
|
|
177
218
|
#
|
|
@@ -183,7 +224,7 @@ module Straddle
|
|
|
183
224
|
#
|
|
184
225
|
# @param currency [String] The currency of the payout. Only USD is supported.
|
|
185
226
|
#
|
|
186
|
-
# @param description [String] An arbitrary description for the payout.
|
|
227
|
+
# @param description [String, nil] An arbitrary description for the payout.
|
|
187
228
|
#
|
|
188
229
|
# @param device [Straddle::Models::DeviceInfoV1] Information about the device used when the customer authorized the payout.
|
|
189
230
|
#
|
|
@@ -191,6 +232,12 @@ module Straddle
|
|
|
191
232
|
#
|
|
192
233
|
# @param funding_ids [Array<String>] Funding Ids
|
|
193
234
|
#
|
|
235
|
+
# @param has_resubmit [Boolean] Has the payout been resubmitted.
|
|
236
|
+
#
|
|
237
|
+
# @param is_refund [Boolean] Is the payout a refund of an original charge.
|
|
238
|
+
#
|
|
239
|
+
# @param is_resubmit [Boolean] Is the payout a resubmit of an original payout.
|
|
240
|
+
#
|
|
194
241
|
# @param paykey [String] Value of the `paykey` used for the payout.
|
|
195
242
|
#
|
|
196
243
|
# @param payment_date [Date] The desired date on which the payment should be occur. For payouts, this means t
|
|
@@ -201,10 +248,14 @@ module Straddle
|
|
|
201
248
|
#
|
|
202
249
|
# @param status_history [Array<Straddle::Models::PayoutV1::Data::StatusHistory>] History of the status changes for the payout.
|
|
203
250
|
#
|
|
251
|
+
# @param trace_ids [Hash{Symbol=>String}] Trace Ids.
|
|
252
|
+
#
|
|
204
253
|
# @param created_at [Time, nil] The time the payout was created.
|
|
205
254
|
#
|
|
206
255
|
# @param customer_details [Straddle::Models::CustomerDetailsV1] Information about the customer associated with the payout.
|
|
207
256
|
#
|
|
257
|
+
# @param documents [Array<Straddle::Models::PayoutV1::Data::Document>, nil] Documents uploaded for this payout (e.g. proof of authorization), in the order t
|
|
258
|
+
#
|
|
208
259
|
# @param effective_at [Time, nil] The actual date on which the payment occurred. For payouts, this is the date the
|
|
209
260
|
#
|
|
210
261
|
# @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
@@ -215,19 +266,37 @@ module Straddle
|
|
|
215
266
|
#
|
|
216
267
|
# @param processed_at [Time, nil] The time the payout was processed by Straddle and originated to the payment rail
|
|
217
268
|
#
|
|
269
|
+
# @param related_payments [Array<Straddle::Models::PayoutV1::Data::RelatedPayment>, nil] Related payments.
|
|
270
|
+
#
|
|
218
271
|
# @param updated_at [Time, nil] The time the payout was last updated.
|
|
219
272
|
|
|
220
273
|
# @see Straddle::Models::PayoutV1::Data#config
|
|
221
274
|
class Config < Straddle::Internal::Type::BaseModel
|
|
275
|
+
# @!attribute auto_hold
|
|
276
|
+
# Defines whether to automatically place this charge on hold after being created.
|
|
277
|
+
#
|
|
278
|
+
# @return [Boolean, nil]
|
|
279
|
+
optional :auto_hold, Straddle::Internal::Type::Boolean, nil?: true
|
|
280
|
+
|
|
281
|
+
# @!attribute auto_hold_message
|
|
282
|
+
# The reason the payout is being automatically held on creation.
|
|
283
|
+
#
|
|
284
|
+
# @return [String, nil]
|
|
285
|
+
optional :auto_hold_message, String, nil?: true
|
|
286
|
+
|
|
222
287
|
# @!attribute sandbox_outcome
|
|
223
288
|
# Payment will simulate processing if not Standard.
|
|
224
289
|
#
|
|
225
290
|
# @return [Symbol, Straddle::Models::PayoutV1::Data::Config::SandboxOutcome, nil]
|
|
226
291
|
optional :sandbox_outcome, enum: -> { Straddle::PayoutV1::Data::Config::SandboxOutcome }
|
|
227
292
|
|
|
228
|
-
# @!method initialize(sandbox_outcome: nil)
|
|
293
|
+
# @!method initialize(auto_hold: nil, auto_hold_message: nil, sandbox_outcome: nil)
|
|
229
294
|
# Configuration for the payout.
|
|
230
295
|
#
|
|
296
|
+
# @param auto_hold [Boolean, nil] Defines whether to automatically place this charge on hold after being created.
|
|
297
|
+
#
|
|
298
|
+
# @param auto_hold_message [String, nil] The reason the payout is being automatically held on creation.
|
|
299
|
+
#
|
|
231
300
|
# @param sandbox_outcome [Symbol, Straddle::Models::PayoutV1::Data::Config::SandboxOutcome] Payment will simulate processing if not Standard.
|
|
232
301
|
|
|
233
302
|
# Payment will simulate processing if not Standard.
|
|
@@ -247,6 +316,8 @@ module Straddle
|
|
|
247
316
|
REVERSED_CUSTOMER_DISPUTE = :reversed_customer_dispute
|
|
248
317
|
FAILED_CLOSED_BANK_ACCOUNT = :failed_closed_bank_account
|
|
249
318
|
REVERSED_CLOSED_BANK_ACCOUNT = :reversed_closed_bank_account
|
|
319
|
+
FAILED_NOT_AUTHORIZED = :failed_not_authorized
|
|
320
|
+
REVERSED_NOT_AUTHORIZED = :reversed_not_authorized
|
|
250
321
|
|
|
251
322
|
# @!method self.values
|
|
252
323
|
# @return [Array<Symbol>]
|
|
@@ -267,6 +338,7 @@ module Straddle
|
|
|
267
338
|
PENDING = :pending
|
|
268
339
|
PAID = :paid
|
|
269
340
|
REVERSED = :reversed
|
|
341
|
+
VALIDATING = :validating
|
|
270
342
|
|
|
271
343
|
# @!method self.values
|
|
272
344
|
# @return [Array<Symbol>]
|
|
@@ -354,6 +426,13 @@ module Straddle
|
|
|
354
426
|
OK = :ok
|
|
355
427
|
OTHER_NETWORK_RETURN = :other_network_return
|
|
356
428
|
PAYOUT_REFUSED = :payout_refused
|
|
429
|
+
CANCEL_REQUEST = :cancel_request
|
|
430
|
+
FAILED_VERIFICATION = :failed_verification
|
|
431
|
+
REQUIRE_REVIEW = :require_review
|
|
432
|
+
BLOCKED_BY_SYSTEM = :blocked_by_system
|
|
433
|
+
WATCHTOWER_REVIEW = :watchtower_review
|
|
434
|
+
VALIDATING = :validating
|
|
435
|
+
AUTO_HOLD = :auto_hold
|
|
357
436
|
|
|
358
437
|
# @!method self.values
|
|
359
438
|
# @return [Array<Symbol>]
|
|
@@ -390,6 +469,59 @@ module Straddle
|
|
|
390
469
|
PENDING = :pending
|
|
391
470
|
PAID = :paid
|
|
392
471
|
REVERSED = :reversed
|
|
472
|
+
VALIDATING = :validating
|
|
473
|
+
|
|
474
|
+
# @!method self.values
|
|
475
|
+
# @return [Array<Symbol>]
|
|
476
|
+
end
|
|
477
|
+
end
|
|
478
|
+
|
|
479
|
+
class Document < Straddle::Internal::Type::BaseModel
|
|
480
|
+
# @!attribute document_id
|
|
481
|
+
# Unique identifier for this document.
|
|
482
|
+
#
|
|
483
|
+
# @return [String]
|
|
484
|
+
required :document_id, String
|
|
485
|
+
|
|
486
|
+
# @!attribute document_name
|
|
487
|
+
# The file name of this document as uploaded.
|
|
488
|
+
#
|
|
489
|
+
# @return [String]
|
|
490
|
+
required :document_name, String
|
|
491
|
+
|
|
492
|
+
# @!attribute document_size
|
|
493
|
+
# The size of this document in bytes.
|
|
494
|
+
#
|
|
495
|
+
# @return [Integer]
|
|
496
|
+
required :document_size, Integer
|
|
497
|
+
|
|
498
|
+
# @!attribute document_type
|
|
499
|
+
#
|
|
500
|
+
# @return [Symbol, Straddle::Models::PayoutV1::Data::Document::DocumentType]
|
|
501
|
+
required :document_type, enum: -> { Straddle::PayoutV1::Data::Document::DocumentType }
|
|
502
|
+
|
|
503
|
+
# @!attribute uploaded_at
|
|
504
|
+
# The UTC timestamp when this document was uploaded.
|
|
505
|
+
#
|
|
506
|
+
# @return [Time]
|
|
507
|
+
required :uploaded_at, Time
|
|
508
|
+
|
|
509
|
+
# @!method initialize(document_id:, document_name:, document_size:, document_type:, uploaded_at:)
|
|
510
|
+
# @param document_id [String] Unique identifier for this document.
|
|
511
|
+
#
|
|
512
|
+
# @param document_name [String] The file name of this document as uploaded.
|
|
513
|
+
#
|
|
514
|
+
# @param document_size [Integer] The size of this document in bytes.
|
|
515
|
+
#
|
|
516
|
+
# @param document_type [Symbol, Straddle::Models::PayoutV1::Data::Document::DocumentType]
|
|
517
|
+
#
|
|
518
|
+
# @param uploaded_at [Time] The UTC timestamp when this document was uploaded.
|
|
519
|
+
|
|
520
|
+
# @see Straddle::Models::PayoutV1::Data::Document#document_type
|
|
521
|
+
module DocumentType
|
|
522
|
+
extend Straddle::Internal::Type::Enum
|
|
523
|
+
|
|
524
|
+
PAYMENT_AUTHORIZATION = :payment_authorization
|
|
393
525
|
|
|
394
526
|
# @!method self.values
|
|
395
527
|
# @return [Array<Symbol>]
|
|
@@ -407,6 +539,57 @@ module Straddle
|
|
|
407
539
|
# @!method self.values
|
|
408
540
|
# @return [Array<Symbol>]
|
|
409
541
|
end
|
|
542
|
+
|
|
543
|
+
class RelatedPayment < Straddle::Internal::Type::BaseModel
|
|
544
|
+
# @!attribute id
|
|
545
|
+
# The ID of the related payment.
|
|
546
|
+
#
|
|
547
|
+
# @return [String]
|
|
548
|
+
required :id, String
|
|
549
|
+
|
|
550
|
+
# @!attribute payment_type
|
|
551
|
+
# The type of payment.
|
|
552
|
+
#
|
|
553
|
+
# @return [Symbol, Straddle::Models::PayoutV1::Data::RelatedPayment::PaymentType]
|
|
554
|
+
required :payment_type, enum: -> { Straddle::PayoutV1::Data::RelatedPayment::PaymentType }
|
|
555
|
+
|
|
556
|
+
# @!attribute relationship
|
|
557
|
+
#
|
|
558
|
+
# @return [Symbol, Straddle::Models::PayoutV1::Data::RelatedPayment::Relationship]
|
|
559
|
+
required :relationship, enum: -> { Straddle::PayoutV1::Data::RelatedPayment::Relationship }
|
|
560
|
+
|
|
561
|
+
# @!method initialize(id:, payment_type:, relationship:)
|
|
562
|
+
# @param id [String] The ID of the related payment.
|
|
563
|
+
#
|
|
564
|
+
# @param payment_type [Symbol, Straddle::Models::PayoutV1::Data::RelatedPayment::PaymentType] The type of payment.
|
|
565
|
+
#
|
|
566
|
+
# @param relationship [Symbol, Straddle::Models::PayoutV1::Data::RelatedPayment::Relationship]
|
|
567
|
+
|
|
568
|
+
# The type of payment.
|
|
569
|
+
#
|
|
570
|
+
# @see Straddle::Models::PayoutV1::Data::RelatedPayment#payment_type
|
|
571
|
+
module PaymentType
|
|
572
|
+
extend Straddle::Internal::Type::Enum
|
|
573
|
+
|
|
574
|
+
CHARGE = :charge
|
|
575
|
+
PAYOUT = :payout
|
|
576
|
+
|
|
577
|
+
# @!method self.values
|
|
578
|
+
# @return [Array<Symbol>]
|
|
579
|
+
end
|
|
580
|
+
|
|
581
|
+
# @see Straddle::Models::PayoutV1::Data::RelatedPayment#relationship
|
|
582
|
+
module Relationship
|
|
583
|
+
extend Straddle::Internal::Type::Enum
|
|
584
|
+
|
|
585
|
+
ORIGINAL = :original
|
|
586
|
+
RESUBMIT = :resubmit
|
|
587
|
+
REFUND = :refund
|
|
588
|
+
|
|
589
|
+
# @!method self.values
|
|
590
|
+
# @return [Array<Symbol>]
|
|
591
|
+
end
|
|
592
|
+
end
|
|
410
593
|
end
|
|
411
594
|
|
|
412
595
|
# 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
|
@@ -141,6 +141,8 @@ module Straddle
|
|
|
141
141
|
|
|
142
142
|
PayoutUpdateParams = Straddle::Models::PayoutUpdateParams
|
|
143
143
|
|
|
144
|
+
PayoutUploadAuthorizationDocumentParams = Straddle::Models::PayoutUploadAuthorizationDocumentParams
|
|
145
|
+
|
|
144
146
|
PayoutV1 = Straddle::Models::PayoutV1
|
|
145
147
|
|
|
146
148
|
ReportCreateTotalCustomersByStatusParams = Straddle::Models::ReportCreateTotalCustomersByStatusParams
|
|
@@ -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.
|
|
@@ -15,13 +21,13 @@ module Straddle
|
|
|
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
|
|
25
31
|
#
|
|
26
32
|
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
27
33
|
#
|
|
@@ -72,7 +78,7 @@ module Straddle
|
|
|
72
78
|
#
|
|
73
79
|
# @param quiltt_token [String] Body param: Quiltt processor token generated by your application for use with th
|
|
74
80
|
#
|
|
75
|
-
# @param config [Straddle::Models::Bridge::LinkCreatePaykeyParams::Config] Body param
|
|
81
|
+
# @param config [Straddle::Models::Bridge::LinkCreatePaykeyParams::Config] Body param
|
|
76
82
|
#
|
|
77
83
|
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
78
84
|
#
|
|
@@ -115,7 +121,7 @@ module Straddle
|
|
|
115
121
|
#
|
|
116
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: {})
|
|
117
123
|
#
|
|
118
|
-
# @param account_type [Symbol, Straddle::Models::Bridge::LinkCreateTanParams::AccountType] Body param
|
|
124
|
+
# @param account_type [Symbol, Straddle::Models::Bridge::LinkCreateTanParams::AccountType] Body param
|
|
119
125
|
#
|
|
120
126
|
# @param customer_id [String] Body param: Unique identifier of the related customer object.
|
|
121
127
|
#
|
|
@@ -123,7 +129,7 @@ module Straddle
|
|
|
123
129
|
#
|
|
124
130
|
# @param tan [String] Body param: Tokenized account number.
|
|
125
131
|
#
|
|
126
|
-
# @param config [Straddle::Models::Bridge::LinkCreateTanParams::Config] Body param
|
|
132
|
+
# @param config [Straddle::Models::Bridge::LinkCreateTanParams::Config] Body param
|
|
127
133
|
#
|
|
128
134
|
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
129
135
|
#
|
|
@@ -174,7 +180,7 @@ module Straddle
|
|
|
174
180
|
#
|
|
175
181
|
# @param plaid_token [String] Body param: Plaid processor token generated by your application for use with the
|
|
176
182
|
#
|
|
177
|
-
# @param config [Straddle::Models::Bridge::LinkPlaidParams::Config] Body param
|
|
183
|
+
# @param config [Straddle::Models::Bridge::LinkPlaidParams::Config] Body param
|
|
178
184
|
#
|
|
179
185
|
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
180
186
|
#
|
|
@@ -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
|
|
|
@@ -15,7 +27,7 @@ module Straddle
|
|
|
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
|
|
19
31
|
#
|
|
20
32
|
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
21
33
|
#
|
|
@@ -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
|
#
|
|
@@ -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",
|
|
@@ -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"
|