straddle 0.1.1 → 0.3.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 +66 -0
- data/README.md +2 -2
- data/SECURITY.md +1 -1
- data/lib/straddle/client.rb +3 -3
- data/lib/straddle/errors.rb +25 -11
- data/lib/straddle/file_part.rb +10 -7
- data/lib/straddle/internal/page_number_schema.rb +1 -1
- data/lib/straddle/internal/transport/base_client.rb +19 -9
- data/lib/straddle/internal/transport/pooled_net_requester.rb +41 -42
- data/lib/straddle/internal/type/array_of.rb +1 -0
- data/lib/straddle/internal/type/base_model.rb +4 -9
- data/lib/straddle/internal/type/base_page.rb +1 -1
- data/lib/straddle/internal/type/converter.rb +27 -0
- data/lib/straddle/internal/type/file_input.rb +7 -4
- data/lib/straddle/internal/type/hash_of.rb +1 -0
- data/lib/straddle/internal/type/union.rb +9 -7
- data/lib/straddle/internal/util.rb +9 -8
- data/lib/straddle/models/bridge/link_bank_account_params.rb +39 -6
- data/lib/straddle/models/bridge/link_create_paykey_params.rb +39 -6
- data/lib/straddle/models/bridge/link_create_paykey_response.rb +31 -2
- data/lib/straddle/models/bridge/link_create_tan_params.rb +38 -6
- data/lib/straddle/models/bridge/link_create_tan_response.rb +31 -2
- data/lib/straddle/models/bridge/link_plaid_params.rb +37 -2
- data/lib/straddle/models/bridge_initialize_params.rb +37 -2
- data/lib/straddle/models/charge_cancel_params.rb +8 -1
- data/lib/straddle/models/charge_create_params.rb +8 -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_update_params.rb +8 -1
- data/lib/straddle/models/customer_create_params.rb +8 -1
- data/lib/straddle/models/customer_delete_params.rb +7 -1
- data/lib/straddle/models/customer_unmasked_v1.rb +1 -4
- data/lib/straddle/models/customer_update_params.rb +8 -1
- data/lib/straddle/models/customers/customer_review_v1.rb +15 -50
- data/lib/straddle/models/customers/review_decision_params.rb +8 -1
- data/lib/straddle/models/customers/review_refresh_review_params.rb +40 -0
- data/lib/straddle/models/embed/account_create_params.rb +8 -1
- data/lib/straddle/models/embed/account_onboard_params.rb +7 -1
- data/lib/straddle/models/embed/account_paged_v1.rb +3 -12
- 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 +2 -8
- data/lib/straddle/models/embed/accounts/capability_request_create_params.rb +8 -1
- data/lib/straddle/models/embed/accounts/capability_request_paged_v1.rb +3 -11
- data/lib/straddle/models/embed/linked_bank_account_cancel_params.rb +34 -0
- data/lib/straddle/models/embed/linked_bank_account_create_params.rb +51 -4
- data/lib/straddle/models/embed/linked_bank_account_list_params.rb +51 -1
- data/lib/straddle/models/embed/linked_bank_account_paged_v1.rb +33 -13
- data/lib/straddle/models/embed/linked_bank_account_unmask_v1.rb +3 -8
- data/lib/straddle/models/embed/linked_bank_account_update_params.rb +8 -1
- data/lib/straddle/models/embed/linked_bank_account_v1.rb +30 -1
- data/lib/straddle/models/embed/organization_create_params.rb +8 -1
- data/lib/straddle/models/embed/representative.rb +10 -1
- data/lib/straddle/models/embed/representative_create_params.rb +17 -1
- data/lib/straddle/models/embed/representative_paged.rb +10 -1
- data/lib/straddle/models/embed/representative_update_params.rb +17 -1
- data/lib/straddle/models/funding_event_list_params.rb +9 -1
- data/lib/straddle/models/funding_event_summary_item_v1.rb +25 -1
- data/lib/straddle/models/funding_event_summary_paged_v1.rb +25 -1
- data/lib/straddle/models/paykey_cancel_params.rb +7 -1
- data/lib/straddle/models/paykey_reveal_response.rb +31 -2
- data/lib/straddle/models/paykey_summary_paged_v1.rb +30 -2
- data/lib/straddle/models/paykey_unmasked_v1.rb +30 -2
- data/lib/straddle/models/{customer_refresh_review_params.rb → paykey_update_balance_params.rb} +9 -3
- data/lib/straddle/models/paykey_v1.rb +30 -2
- data/lib/straddle/models/paykeys/review_decision_params.rb +56 -0
- data/lib/straddle/models/paykeys/review_get_params.rb +34 -0
- data/lib/straddle/models/paykeys/review_get_response.rb +642 -0
- data/lib/straddle/models/paykeys/review_refresh_review_params.rb +40 -0
- data/lib/straddle/models/payment_summary_paged_v1.rb +9 -1
- data/lib/straddle/models/payout_cancel_params.rb +8 -1
- data/lib/straddle/models/payout_create_params.rb +8 -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_update_params.rb +8 -1
- data/lib/straddle/models.rb +4 -2
- data/lib/straddle/resources/bridge/link.rb +24 -4
- data/lib/straddle/resources/bridge.rb +6 -1
- data/lib/straddle/resources/charges.rb +20 -5
- data/lib/straddle/resources/customers/review.rb +41 -1
- data/lib/straddle/resources/customers.rb +12 -37
- data/lib/straddle/resources/embed/accounts/capability_requests.rb +5 -2
- data/lib/straddle/resources/embed/accounts.rb +19 -7
- data/lib/straddle/resources/embed/linked_bank_accounts.rb +66 -7
- data/lib/straddle/resources/embed/organizations.rb +5 -2
- data/lib/straddle/resources/embed/representatives.rb +14 -4
- data/lib/straddle/resources/funding_events.rb +4 -1
- data/lib/straddle/resources/paykeys/review.rb +128 -0
- data/lib/straddle/resources/paykeys.rb +44 -1
- data/lib/straddle/resources/payouts.rb +20 -5
- data/lib/straddle/version.rb +1 -1
- data/lib/straddle.rb +9 -1
- data/manifest.yaml +1 -0
- data/rbi/straddle/client.rbi +4 -4
- data/rbi/straddle/errors.rbi +31 -4
- data/rbi/straddle/file_part.rbi +1 -1
- data/rbi/straddle/internal/transport/base_client.rbi +10 -6
- 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/type/base_page.rbi +1 -1
- data/rbi/straddle/internal/type/converter.rbi +54 -0
- data/rbi/straddle/internal/type/union.rbi +9 -2
- data/rbi/straddle/internal/util.rbi +1 -1
- data/rbi/straddle/models/bridge/link_bank_account_params.rbi +85 -1
- data/rbi/straddle/models/bridge/link_create_paykey_params.rbi +85 -1
- data/rbi/straddle/models/bridge/link_create_paykey_response.rbi +76 -1
- data/rbi/straddle/models/bridge/link_create_tan_params.rbi +85 -1
- data/rbi/straddle/models/bridge/link_create_tan_response.rbi +76 -1
- data/rbi/straddle/models/bridge/link_plaid_params.rbi +85 -1
- data/rbi/straddle/models/bridge_initialize_params.rbi +85 -1
- data/rbi/straddle/models/charge_cancel_params.rbi +9 -0
- data/rbi/straddle/models/charge_create_params.rbi +9 -0
- data/rbi/straddle/models/charge_hold_params.rbi +9 -0
- data/rbi/straddle/models/charge_release_params.rbi +9 -0
- data/rbi/straddle/models/charge_update_params.rbi +9 -0
- data/rbi/straddle/models/customer_create_params.rbi +9 -0
- data/rbi/straddle/models/customer_delete_params.rbi +9 -0
- data/rbi/straddle/models/customer_update_params.rbi +9 -0
- data/rbi/straddle/models/customers/review_decision_params.rbi +9 -0
- data/rbi/straddle/models/customers/review_refresh_review_params.rbi +76 -0
- data/rbi/straddle/models/embed/account_create_params.rbi +9 -0
- data/rbi/straddle/models/embed/account_onboard_params.rbi +9 -0
- data/rbi/straddle/models/embed/account_simulate_params.rbi +9 -0
- data/rbi/straddle/models/embed/account_update_params.rbi +9 -0
- data/rbi/straddle/models/embed/accounts/capability_request_create_params.rbi +9 -0
- data/rbi/straddle/models/embed/linked_bank_account_cancel_params.rbi +67 -0
- data/rbi/straddle/models/embed/linked_bank_account_create_params.rbi +95 -3
- data/rbi/straddle/models/embed/linked_bank_account_list_params.rbi +149 -0
- data/rbi/straddle/models/embed/linked_bank_account_paged_v1.rbi +72 -0
- data/rbi/straddle/models/embed/linked_bank_account_unmask_v1.rbi +5 -0
- data/rbi/straddle/models/embed/linked_bank_account_update_params.rbi +9 -0
- data/rbi/straddle/models/embed/linked_bank_account_v1.rbi +72 -0
- data/rbi/straddle/models/embed/organization_create_params.rbi +9 -0
- data/rbi/straddle/models/embed/representative.rbi +10 -0
- data/rbi/straddle/models/embed/representative_create_params.rbi +19 -0
- data/rbi/straddle/models/embed/representative_paged.rbi +10 -0
- data/rbi/straddle/models/embed/representative_update_params.rbi +19 -0
- data/rbi/straddle/models/funding_event_list_params.rbi +8 -0
- data/rbi/straddle/models/funding_event_summary_item_v1.rbi +24 -0
- data/rbi/straddle/models/funding_event_summary_paged_v1.rbi +24 -0
- data/rbi/straddle/models/paykey_cancel_params.rbi +9 -0
- data/rbi/straddle/models/paykey_reveal_response.rbi +76 -1
- data/rbi/straddle/models/paykey_summary_paged_v1.rbi +76 -1
- data/rbi/straddle/models/paykey_unmasked_v1.rbi +76 -1
- data/rbi/straddle/models/{customer_refresh_review_params.rbi → paykey_update_balance_params.rbi} +11 -2
- data/rbi/straddle/models/paykey_v1.rbi +76 -1
- data/rbi/straddle/models/paykeys/review_decision_params.rbi +115 -0
- data/rbi/straddle/models/paykeys/review_get_params.rbi +67 -0
- data/rbi/straddle/models/paykeys/review_get_response.rbi +1524 -0
- data/rbi/straddle/models/paykeys/review_refresh_review_params.rbi +76 -0
- data/rbi/straddle/models/payment_summary_paged_v1.rbi +8 -0
- data/rbi/straddle/models/payout_cancel_params.rbi +9 -0
- data/rbi/straddle/models/payout_create_params.rbi +9 -0
- data/rbi/straddle/models/payout_hold_params.rbi +9 -0
- data/rbi/straddle/models/payout_release_params.rbi +9 -0
- data/rbi/straddle/models/payout_update_params.rbi +9 -0
- data/rbi/straddle/models.rbi +4 -2
- data/rbi/straddle/resources/bridge/link.rbi +28 -0
- data/rbi/straddle/resources/bridge.rbi +7 -0
- data/rbi/straddle/resources/charges.rbi +15 -0
- data/rbi/straddle/resources/customers/review.rbi +30 -0
- data/rbi/straddle/resources/customers.rbi +9 -24
- data/rbi/straddle/resources/embed/accounts/capability_requests.rbi +3 -0
- data/rbi/straddle/resources/embed/accounts.rbi +12 -0
- data/rbi/straddle/resources/embed/linked_bank_accounts.rbi +56 -1
- data/rbi/straddle/resources/embed/organizations.rbi +3 -0
- data/rbi/straddle/resources/embed/representatives.rbi +14 -0
- data/rbi/straddle/resources/funding_events.rbi +3 -0
- data/rbi/straddle/resources/paykeys/review.rbi +94 -0
- data/rbi/straddle/resources/paykeys.rbi +32 -0
- data/rbi/straddle/resources/payouts.rbi +15 -0
- data/sig/straddle/client.rbs +2 -2
- data/sig/straddle/errors.rbs +7 -0
- data/sig/straddle/file_part.rbs +1 -1
- data/sig/straddle/internal/transport/base_client.rbs +3 -1
- data/sig/straddle/internal/transport/pooled_net_requester.rbs +4 -1
- data/sig/straddle/internal/type/converter.rbs +17 -0
- data/sig/straddle/internal/type/union.rbs +2 -2
- data/sig/straddle/models/bridge/link_bank_account_params.rbs +35 -1
- data/sig/straddle/models/bridge/link_create_paykey_params.rbs +35 -1
- data/sig/straddle/models/bridge/link_create_paykey_response.rbs +28 -1
- data/sig/straddle/models/bridge/link_create_tan_params.rbs +35 -1
- data/sig/straddle/models/bridge/link_create_tan_response.rbs +28 -1
- data/sig/straddle/models/bridge/link_plaid_params.rbs +35 -1
- data/sig/straddle/models/bridge_initialize_params.rbs +35 -1
- data/sig/straddle/models/charge_cancel_params.rbs +7 -0
- data/sig/straddle/models/charge_create_params.rbs +7 -0
- data/sig/straddle/models/charge_hold_params.rbs +7 -0
- data/sig/straddle/models/charge_release_params.rbs +7 -0
- data/sig/straddle/models/charge_update_params.rbs +7 -0
- data/sig/straddle/models/customer_create_params.rbs +7 -0
- data/sig/straddle/models/customer_delete_params.rbs +7 -0
- data/sig/straddle/models/customer_update_params.rbs +7 -0
- data/sig/straddle/models/customers/review_decision_params.rbs +7 -0
- data/sig/straddle/models/customers/review_refresh_review_params.rbs +51 -0
- data/sig/straddle/models/embed/account_create_params.rbs +7 -0
- data/sig/straddle/models/embed/account_onboard_params.rbs +7 -0
- data/sig/straddle/models/embed/account_simulate_params.rbs +7 -0
- data/sig/straddle/models/embed/account_update_params.rbs +7 -0
- data/sig/straddle/models/embed/accounts/capability_request_create_params.rbs +7 -0
- data/sig/straddle/models/embed/linked_bank_account_cancel_params.rbs +40 -0
- data/sig/straddle/models/embed/linked_bank_account_create_params.rbs +38 -4
- data/sig/straddle/models/embed/linked_bank_account_list_params.rbs +46 -0
- data/sig/straddle/models/embed/linked_bank_account_paged_v1.rbs +25 -1
- data/sig/straddle/models/embed/linked_bank_account_unmask_v1.rbs +3 -1
- data/sig/straddle/models/embed/linked_bank_account_update_params.rbs +7 -0
- data/sig/straddle/models/embed/linked_bank_account_v1.rbs +25 -1
- data/sig/straddle/models/embed/organization_create_params.rbs +7 -0
- data/sig/straddle/models/embed/representative.rbs +5 -0
- data/sig/straddle/models/embed/representative_create_params.rbs +12 -0
- data/sig/straddle/models/embed/representative_paged.rbs +5 -0
- data/sig/straddle/models/embed/representative_update_params.rbs +12 -0
- data/sig/straddle/models/funding_event_list_params.rbs +5 -0
- data/sig/straddle/models/funding_event_summary_item_v1.rbs +15 -0
- data/sig/straddle/models/funding_event_summary_paged_v1.rbs +15 -0
- data/sig/straddle/models/paykey_cancel_params.rbs +7 -0
- data/sig/straddle/models/paykey_reveal_response.rbs +28 -1
- data/sig/straddle/models/paykey_summary_paged_v1.rbs +28 -1
- data/sig/straddle/models/paykey_unmasked_v1.rbs +28 -1
- data/sig/straddle/models/{customer_refresh_review_params.rbs → paykey_update_balance_params.rbs} +9 -2
- data/sig/straddle/models/paykey_v1.rbs +28 -1
- data/sig/straddle/models/paykeys/review_decision_params.rbs +67 -0
- data/sig/straddle/models/paykeys/review_get_params.rbs +44 -0
- data/sig/straddle/models/paykeys/review_get_response.rbs +627 -0
- data/sig/straddle/models/paykeys/review_refresh_review_params.rbs +51 -0
- data/sig/straddle/models/payment_summary_paged_v1.rbs +5 -0
- data/sig/straddle/models/payout_cancel_params.rbs +7 -0
- data/sig/straddle/models/payout_create_params.rbs +7 -0
- data/sig/straddle/models/payout_hold_params.rbs +7 -0
- data/sig/straddle/models/payout_release_params.rbs +7 -0
- data/sig/straddle/models/payout_update_params.rbs +7 -0
- data/sig/straddle/models.rbs +4 -2
- data/sig/straddle/resources/bridge/link.rbs +8 -0
- data/sig/straddle/resources/bridge.rbs +2 -0
- data/sig/straddle/resources/charges.rbs +5 -0
- data/sig/straddle/resources/customers/review.rbs +10 -0
- data/sig/straddle/resources/customers.rbs +3 -8
- data/sig/straddle/resources/embed/accounts/capability_requests.rbs +1 -0
- data/sig/straddle/resources/embed/accounts.rbs +4 -0
- data/sig/straddle/resources/embed/linked_bank_accounts.rbs +16 -1
- data/sig/straddle/resources/embed/organizations.rbs +1 -0
- data/sig/straddle/resources/embed/representatives.rbs +4 -0
- data/sig/straddle/resources/funding_events.rbs +1 -0
- data/sig/straddle/resources/paykeys/review.rbs +36 -0
- data/sig/straddle/resources/paykeys.rbs +12 -0
- data/sig/straddle/resources/payouts.rbs +5 -0
- metadata +27 -6
|
@@ -111,6 +111,12 @@ module Straddle
|
|
|
111
111
|
# @return [Straddle::Models::StatusDetailsV1]
|
|
112
112
|
required :status_details, -> { Straddle::StatusDetailsV1 }
|
|
113
113
|
|
|
114
|
+
# @!attribute trace_ids
|
|
115
|
+
# Trace ids.
|
|
116
|
+
#
|
|
117
|
+
# @return [Hash{Symbol=>String}]
|
|
118
|
+
required :trace_ids, Straddle::Internal::Type::HashOf[String]
|
|
119
|
+
|
|
114
120
|
# @!attribute updated_at
|
|
115
121
|
# The time the `charge` or `payout` was last updated.
|
|
116
122
|
#
|
|
@@ -144,7 +150,7 @@ module Straddle
|
|
|
144
150
|
# @return [Straddle::Models::PaykeyDetailsV1, nil]
|
|
145
151
|
optional :paykey_details, -> { Straddle::PaykeyDetailsV1 }
|
|
146
152
|
|
|
147
|
-
# @!method initialize(id:, amount:, created_at:, currency:, description:, external_id:, funding_ids:, paykey:, payment_date:, payment_type:, status:, status_details:, updated_at:, customer_details: nil, effective_at: nil, funding_id: nil, paykey_details: nil)
|
|
153
|
+
# @!method initialize(id:, amount:, created_at:, currency:, description:, external_id:, funding_ids:, paykey:, payment_date:, payment_type:, status:, status_details:, trace_ids:, updated_at:, customer_details: nil, effective_at: nil, funding_id: nil, paykey_details: nil)
|
|
148
154
|
# Some parameter documentations has been truncated, see
|
|
149
155
|
# {Straddle::Models::PaymentSummaryPagedV1::Data} for more details.
|
|
150
156
|
#
|
|
@@ -172,6 +178,8 @@ module Straddle
|
|
|
172
178
|
#
|
|
173
179
|
# @param status_details [Straddle::Models::StatusDetailsV1] Details about the current status of the `charge` or `payout`.
|
|
174
180
|
#
|
|
181
|
+
# @param trace_ids [Hash{Symbol=>String}] Trace ids.
|
|
182
|
+
#
|
|
175
183
|
# @param updated_at [Time] The time the `charge` or `payout` was last updated.
|
|
176
184
|
#
|
|
177
185
|
# @param customer_details [Straddle::Models::CustomerDetailsV1] Information about the customer associated with the charge or payout.
|
|
@@ -18,6 +18,11 @@ module Straddle
|
|
|
18
18
|
# @return [String, nil]
|
|
19
19
|
optional :correlation_id, String
|
|
20
20
|
|
|
21
|
+
# @!attribute idempotency_key
|
|
22
|
+
#
|
|
23
|
+
# @return [String, nil]
|
|
24
|
+
optional :idempotency_key, String
|
|
25
|
+
|
|
21
26
|
# @!attribute request_id
|
|
22
27
|
#
|
|
23
28
|
# @return [String, nil]
|
|
@@ -28,11 +33,13 @@ module Straddle
|
|
|
28
33
|
# @return [String, nil]
|
|
29
34
|
optional :straddle_account_id, String
|
|
30
35
|
|
|
31
|
-
# @!method initialize(reason:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
36
|
+
# @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
32
37
|
# @param reason [String] Details about why the payout status was updated.
|
|
33
38
|
#
|
|
34
39
|
# @param correlation_id [String]
|
|
35
40
|
#
|
|
41
|
+
# @param idempotency_key [String]
|
|
42
|
+
#
|
|
36
43
|
# @param request_id [String]
|
|
37
44
|
#
|
|
38
45
|
# @param straddle_account_id [String]
|
|
@@ -68,6 +68,11 @@ module Straddle
|
|
|
68
68
|
# @return [String, nil]
|
|
69
69
|
optional :correlation_id, String
|
|
70
70
|
|
|
71
|
+
# @!attribute idempotency_key
|
|
72
|
+
#
|
|
73
|
+
# @return [String, nil]
|
|
74
|
+
optional :idempotency_key, String
|
|
75
|
+
|
|
71
76
|
# @!attribute request_id
|
|
72
77
|
#
|
|
73
78
|
# @return [String, nil]
|
|
@@ -78,7 +83,7 @@ module Straddle
|
|
|
78
83
|
# @return [String, nil]
|
|
79
84
|
optional :straddle_account_id, String
|
|
80
85
|
|
|
81
|
-
# @!method initialize(amount:, currency:, description:, device:, external_id:, paykey:, payment_date:, config: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
86
|
+
# @!method initialize(amount:, currency:, description:, device:, external_id:, paykey:, payment_date:, config: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
82
87
|
# Some parameter documentations has been truncated, see
|
|
83
88
|
# {Straddle::Models::PayoutCreateParams} for more details.
|
|
84
89
|
#
|
|
@@ -102,6 +107,8 @@ module Straddle
|
|
|
102
107
|
#
|
|
103
108
|
# @param correlation_id [String]
|
|
104
109
|
#
|
|
110
|
+
# @param idempotency_key [String]
|
|
111
|
+
#
|
|
105
112
|
# @param request_id [String]
|
|
106
113
|
#
|
|
107
114
|
# @param straddle_account_id [String]
|
|
@@ -18,6 +18,11 @@ module Straddle
|
|
|
18
18
|
# @return [String, nil]
|
|
19
19
|
optional :correlation_id, String
|
|
20
20
|
|
|
21
|
+
# @!attribute idempotency_key
|
|
22
|
+
#
|
|
23
|
+
# @return [String, nil]
|
|
24
|
+
optional :idempotency_key, String
|
|
25
|
+
|
|
21
26
|
# @!attribute request_id
|
|
22
27
|
#
|
|
23
28
|
# @return [String, nil]
|
|
@@ -28,11 +33,13 @@ module Straddle
|
|
|
28
33
|
# @return [String, nil]
|
|
29
34
|
optional :straddle_account_id, String
|
|
30
35
|
|
|
31
|
-
# @!method initialize(reason:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
36
|
+
# @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
32
37
|
# @param reason [String] Details about why the payout status was updated.
|
|
33
38
|
#
|
|
34
39
|
# @param correlation_id [String]
|
|
35
40
|
#
|
|
41
|
+
# @param idempotency_key [String]
|
|
42
|
+
#
|
|
36
43
|
# @param request_id [String]
|
|
37
44
|
#
|
|
38
45
|
# @param straddle_account_id [String]
|
|
@@ -18,6 +18,11 @@ module Straddle
|
|
|
18
18
|
# @return [String, nil]
|
|
19
19
|
optional :correlation_id, String
|
|
20
20
|
|
|
21
|
+
# @!attribute idempotency_key
|
|
22
|
+
#
|
|
23
|
+
# @return [String, nil]
|
|
24
|
+
optional :idempotency_key, String
|
|
25
|
+
|
|
21
26
|
# @!attribute request_id
|
|
22
27
|
#
|
|
23
28
|
# @return [String, nil]
|
|
@@ -28,11 +33,13 @@ module Straddle
|
|
|
28
33
|
# @return [String, nil]
|
|
29
34
|
optional :straddle_account_id, String
|
|
30
35
|
|
|
31
|
-
# @!method initialize(reason:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
36
|
+
# @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
32
37
|
# @param reason [String] Details about why the payout status was updated.
|
|
33
38
|
#
|
|
34
39
|
# @param correlation_id [String]
|
|
35
40
|
#
|
|
41
|
+
# @param idempotency_key [String]
|
|
42
|
+
#
|
|
36
43
|
# @param request_id [String]
|
|
37
44
|
#
|
|
38
45
|
# @param straddle_account_id [String]
|
|
@@ -38,6 +38,11 @@ module Straddle
|
|
|
38
38
|
# @return [String, nil]
|
|
39
39
|
optional :correlation_id, String
|
|
40
40
|
|
|
41
|
+
# @!attribute idempotency_key
|
|
42
|
+
#
|
|
43
|
+
# @return [String, nil]
|
|
44
|
+
optional :idempotency_key, String
|
|
45
|
+
|
|
41
46
|
# @!attribute request_id
|
|
42
47
|
#
|
|
43
48
|
# @return [String, nil]
|
|
@@ -48,7 +53,7 @@ module Straddle
|
|
|
48
53
|
# @return [String, nil]
|
|
49
54
|
optional :straddle_account_id, String
|
|
50
55
|
|
|
51
|
-
# @!method initialize(amount:, description:, payment_date:, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
56
|
+
# @!method initialize(amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
52
57
|
# Some parameter documentations has been truncated, see
|
|
53
58
|
# {Straddle::Models::PayoutUpdateParams} for more details.
|
|
54
59
|
#
|
|
@@ -62,6 +67,8 @@ module Straddle
|
|
|
62
67
|
#
|
|
63
68
|
# @param correlation_id [String]
|
|
64
69
|
#
|
|
70
|
+
# @param idempotency_key [String]
|
|
71
|
+
#
|
|
65
72
|
# @param request_id [String]
|
|
66
73
|
#
|
|
67
74
|
# @param straddle_account_id [String]
|
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,12 +111,16 @@ module Straddle
|
|
|
113
111
|
|
|
114
112
|
PaykeyRevealParams = Straddle::Models::PaykeyRevealParams
|
|
115
113
|
|
|
114
|
+
Paykeys = Straddle::Models::Paykeys
|
|
115
|
+
|
|
116
116
|
PaykeySummaryPagedV1 = Straddle::Models::PaykeySummaryPagedV1
|
|
117
117
|
|
|
118
118
|
PaykeyUnmaskedParams = Straddle::Models::PaykeyUnmaskedParams
|
|
119
119
|
|
|
120
120
|
PaykeyUnmaskedV1 = Straddle::Models::PaykeyUnmaskedV1
|
|
121
121
|
|
|
122
|
+
PaykeyUpdateBalanceParams = Straddle::Models::PaykeyUpdateBalanceParams
|
|
123
|
+
|
|
122
124
|
PaykeyV1 = Straddle::Models::PaykeyV1
|
|
123
125
|
|
|
124
126
|
PaymentListParams = Straddle::Models::PaymentListParams
|
|
@@ -11,7 +11,7 @@ module Straddle
|
|
|
11
11
|
# source. This endpoint allows you to create a secure payment token linked to a
|
|
12
12
|
# specific bank account.
|
|
13
13
|
#
|
|
14
|
-
# @overload bank_account(account_number:, account_type:, customer_id:, routing_number:, config: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
14
|
+
# @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
15
|
#
|
|
16
16
|
# @param account_number [String] Body param: The bank account number.
|
|
17
17
|
#
|
|
@@ -23,10 +23,14 @@ module Straddle
|
|
|
23
23
|
#
|
|
24
24
|
# @param config [Straddle::Models::Bridge::LinkBankAccountParams::Config] Body param:
|
|
25
25
|
#
|
|
26
|
+
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
27
|
+
#
|
|
26
28
|
# @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
|
|
27
29
|
#
|
|
28
30
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
29
31
|
#
|
|
32
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
33
|
+
#
|
|
30
34
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
31
35
|
#
|
|
32
36
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -41,6 +45,7 @@ module Straddle
|
|
|
41
45
|
header_params =
|
|
42
46
|
{
|
|
43
47
|
correlation_id: "correlation-id",
|
|
48
|
+
idempotency_key: "idempotency-key",
|
|
44
49
|
request_id: "request-id",
|
|
45
50
|
straddle_account_id: "straddle-account-id"
|
|
46
51
|
}
|
|
@@ -61,7 +66,7 @@ module Straddle
|
|
|
61
66
|
# you to create a secure payment token linked to a bank account authenticated
|
|
62
67
|
# through Quiltt.
|
|
63
68
|
#
|
|
64
|
-
# @overload create_paykey(customer_id:, quiltt_token:, config: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
69
|
+
# @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: {})
|
|
65
70
|
#
|
|
66
71
|
# @param customer_id [String] Body param: Unique identifier of the related customer object.
|
|
67
72
|
#
|
|
@@ -69,10 +74,14 @@ module Straddle
|
|
|
69
74
|
#
|
|
70
75
|
# @param config [Straddle::Models::Bridge::LinkCreatePaykeyParams::Config] Body param:
|
|
71
76
|
#
|
|
77
|
+
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
78
|
+
#
|
|
72
79
|
# @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
|
|
73
80
|
#
|
|
74
81
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
75
82
|
#
|
|
83
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
84
|
+
#
|
|
76
85
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
77
86
|
#
|
|
78
87
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -87,6 +96,7 @@ module Straddle
|
|
|
87
96
|
header_params =
|
|
88
97
|
{
|
|
89
98
|
correlation_id: "correlation-id",
|
|
99
|
+
idempotency_key: "idempotency-key",
|
|
90
100
|
request_id: "request-id",
|
|
91
101
|
straddle_account_id: "straddle-account-id"
|
|
92
102
|
}
|
|
@@ -103,7 +113,7 @@ module Straddle
|
|
|
103
113
|
# Some parameter documentations has been truncated, see
|
|
104
114
|
# {Straddle::Models::Bridge::LinkCreateTanParams} for more details.
|
|
105
115
|
#
|
|
106
|
-
# @overload create_tan(account_type:, customer_id:, routing_number:, tan:, config: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
116
|
+
# @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: {})
|
|
107
117
|
#
|
|
108
118
|
# @param account_type [Symbol, Straddle::Models::Bridge::LinkCreateTanParams::AccountType] Body param:
|
|
109
119
|
#
|
|
@@ -115,10 +125,14 @@ module Straddle
|
|
|
115
125
|
#
|
|
116
126
|
# @param config [Straddle::Models::Bridge::LinkCreateTanParams::Config] Body param:
|
|
117
127
|
#
|
|
128
|
+
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
129
|
+
#
|
|
118
130
|
# @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
|
|
119
131
|
#
|
|
120
132
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
121
133
|
#
|
|
134
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
135
|
+
#
|
|
122
136
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
123
137
|
#
|
|
124
138
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -133,6 +147,7 @@ module Straddle
|
|
|
133
147
|
header_params =
|
|
134
148
|
{
|
|
135
149
|
correlation_id: "correlation-id",
|
|
150
|
+
idempotency_key: "idempotency-key",
|
|
136
151
|
request_id: "request-id",
|
|
137
152
|
straddle_account_id: "straddle-account-id"
|
|
138
153
|
}
|
|
@@ -153,7 +168,7 @@ module Straddle
|
|
|
153
168
|
# endpoint allows you to create a secure payment token linked to a bank account
|
|
154
169
|
# authenticated through Plaid.
|
|
155
170
|
#
|
|
156
|
-
# @overload plaid(customer_id:, plaid_token:, config: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
171
|
+
# @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: {})
|
|
157
172
|
#
|
|
158
173
|
# @param customer_id [String] Body param: Unique identifier of the related customer object.
|
|
159
174
|
#
|
|
@@ -161,10 +176,14 @@ module Straddle
|
|
|
161
176
|
#
|
|
162
177
|
# @param config [Straddle::Models::Bridge::LinkPlaidParams::Config] Body param:
|
|
163
178
|
#
|
|
179
|
+
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
180
|
+
#
|
|
164
181
|
# @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
|
|
165
182
|
#
|
|
166
183
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
167
184
|
#
|
|
185
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
186
|
+
#
|
|
168
187
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
169
188
|
#
|
|
170
189
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -179,6 +198,7 @@ module Straddle
|
|
|
179
198
|
header_params =
|
|
180
199
|
{
|
|
181
200
|
correlation_id: "correlation-id",
|
|
201
|
+
idempotency_key: "idempotency-key",
|
|
182
202
|
request_id: "request-id",
|
|
183
203
|
straddle_account_id: "straddle-account-id"
|
|
184
204
|
}
|
|
@@ -11,14 +11,18 @@ module Straddle
|
|
|
11
11
|
#
|
|
12
12
|
# Use this endpoint to generate a session token for use in the Bridge widget.
|
|
13
13
|
#
|
|
14
|
-
# @overload initialize_(customer_id:, config: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
14
|
+
# @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
15
|
#
|
|
16
16
|
# @param customer_id [String] Body param: The Straddle generated unique identifier of the `customer` to create
|
|
17
17
|
#
|
|
18
18
|
# @param config [Straddle::Models::BridgeInitializeParams::Config] Body param:
|
|
19
19
|
#
|
|
20
|
+
# @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
|
|
21
|
+
#
|
|
20
22
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
21
23
|
#
|
|
24
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
25
|
+
#
|
|
22
26
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
23
27
|
#
|
|
24
28
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -33,6 +37,7 @@ module Straddle
|
|
|
33
37
|
header_params =
|
|
34
38
|
{
|
|
35
39
|
correlation_id: "correlation-id",
|
|
40
|
+
idempotency_key: "idempotency-key",
|
|
36
41
|
request_id: "request-id",
|
|
37
42
|
straddle_account_id: "straddle-account-id"
|
|
38
43
|
}
|
|
@@ -8,7 +8,7 @@ module Straddle
|
|
|
8
8
|
#
|
|
9
9
|
# Use charges to collect money from a customer for the sale of goods or services.
|
|
10
10
|
#
|
|
11
|
-
# @overload create(amount:, config:, consent_type:, currency:, description:, device:, external_id:, paykey:, payment_date:, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
11
|
+
# @overload create(amount:, config:, consent_type:, currency:, description:, device:, external_id:, paykey:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
12
12
|
#
|
|
13
13
|
# @param amount [Integer] Body param: The amount of the charge in cents.
|
|
14
14
|
#
|
|
@@ -32,6 +32,8 @@ module Straddle
|
|
|
32
32
|
#
|
|
33
33
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
34
34
|
#
|
|
35
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
36
|
+
#
|
|
35
37
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
36
38
|
#
|
|
37
39
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -46,6 +48,7 @@ module Straddle
|
|
|
46
48
|
header_params =
|
|
47
49
|
{
|
|
48
50
|
correlation_id: "correlation-id",
|
|
51
|
+
idempotency_key: "idempotency-key",
|
|
49
52
|
request_id: "request-id",
|
|
50
53
|
straddle_account_id: "straddle-account-id"
|
|
51
54
|
}
|
|
@@ -65,7 +68,7 @@ module Straddle
|
|
|
65
68
|
# Change the values of parameters associated with a charge prior to processing.
|
|
66
69
|
# The status of the charge must be `created`, `scheduled`, or `on_hold`.
|
|
67
70
|
#
|
|
68
|
-
# @overload update(id, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
71
|
+
# @overload update(id, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
69
72
|
#
|
|
70
73
|
# @param id [String] Path param:
|
|
71
74
|
#
|
|
@@ -79,6 +82,8 @@ module Straddle
|
|
|
79
82
|
#
|
|
80
83
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
81
84
|
#
|
|
85
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
86
|
+
#
|
|
82
87
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
83
88
|
#
|
|
84
89
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -93,6 +98,7 @@ module Straddle
|
|
|
93
98
|
header_params =
|
|
94
99
|
{
|
|
95
100
|
correlation_id: "correlation-id",
|
|
101
|
+
idempotency_key: "idempotency-key",
|
|
96
102
|
request_id: "request-id",
|
|
97
103
|
straddle_account_id: "straddle-account-id"
|
|
98
104
|
}
|
|
@@ -112,7 +118,7 @@ module Straddle
|
|
|
112
118
|
# Cancel a charge to prevent it from being originated for processing. The status
|
|
113
119
|
# of the charge must be `created`, `scheduled`, or `on_hold`.
|
|
114
120
|
#
|
|
115
|
-
# @overload cancel(id, reason: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
121
|
+
# @overload cancel(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
116
122
|
#
|
|
117
123
|
# @param id [String] Path param:
|
|
118
124
|
#
|
|
@@ -120,6 +126,8 @@ module Straddle
|
|
|
120
126
|
#
|
|
121
127
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
122
128
|
#
|
|
129
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
130
|
+
#
|
|
123
131
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
124
132
|
#
|
|
125
133
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -134,6 +142,7 @@ module Straddle
|
|
|
134
142
|
header_params =
|
|
135
143
|
{
|
|
136
144
|
correlation_id: "correlation-id",
|
|
145
|
+
idempotency_key: "idempotency-key",
|
|
137
146
|
request_id: "request-id",
|
|
138
147
|
straddle_account_id: "straddle-account-id"
|
|
139
148
|
}
|
|
@@ -186,7 +195,7 @@ module Straddle
|
|
|
186
195
|
# Place a charge on hold to prevent it from being originated for processing. The
|
|
187
196
|
# status of the charge must be `created` or `scheduled`.
|
|
188
197
|
#
|
|
189
|
-
# @overload hold(id, reason: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
198
|
+
# @overload hold(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
190
199
|
#
|
|
191
200
|
# @param id [String] Path param:
|
|
192
201
|
#
|
|
@@ -194,6 +203,8 @@ module Straddle
|
|
|
194
203
|
#
|
|
195
204
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
196
205
|
#
|
|
206
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
207
|
+
#
|
|
197
208
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
198
209
|
#
|
|
199
210
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -208,6 +219,7 @@ module Straddle
|
|
|
208
219
|
header_params =
|
|
209
220
|
{
|
|
210
221
|
correlation_id: "correlation-id",
|
|
222
|
+
idempotency_key: "idempotency-key",
|
|
211
223
|
request_id: "request-id",
|
|
212
224
|
straddle_account_id: "straddle-account-id"
|
|
213
225
|
}
|
|
@@ -227,7 +239,7 @@ module Straddle
|
|
|
227
239
|
# Release a charge from an `on_hold` status to allow it to be rescheduled for
|
|
228
240
|
# processing.
|
|
229
241
|
#
|
|
230
|
-
# @overload release(id, reason: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
242
|
+
# @overload release(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
231
243
|
#
|
|
232
244
|
# @param id [String] Path param:
|
|
233
245
|
#
|
|
@@ -235,6 +247,8 @@ module Straddle
|
|
|
235
247
|
#
|
|
236
248
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
237
249
|
#
|
|
250
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
251
|
+
#
|
|
238
252
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
239
253
|
#
|
|
240
254
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -249,6 +263,7 @@ module Straddle
|
|
|
249
263
|
header_params =
|
|
250
264
|
{
|
|
251
265
|
correlation_id: "correlation-id",
|
|
266
|
+
idempotency_key: "idempotency-key",
|
|
252
267
|
request_id: "request-id",
|
|
253
268
|
straddle_account_id: "straddle-account-id"
|
|
254
269
|
}
|
|
@@ -12,7 +12,7 @@ module Straddle
|
|
|
12
12
|
# or updating the status of a customer's verification. Note that this endpoint is
|
|
13
13
|
# only available for customers with a current status of `review`.
|
|
14
14
|
#
|
|
15
|
-
# @overload decision(id, status:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
15
|
+
# @overload decision(id, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
16
16
|
#
|
|
17
17
|
# @param id [String] Path param:
|
|
18
18
|
#
|
|
@@ -20,6 +20,8 @@ module Straddle
|
|
|
20
20
|
#
|
|
21
21
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
22
22
|
#
|
|
23
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
24
|
+
#
|
|
23
25
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
24
26
|
#
|
|
25
27
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -34,6 +36,7 @@ module Straddle
|
|
|
34
36
|
header_params =
|
|
35
37
|
{
|
|
36
38
|
correlation_id: "correlation-id",
|
|
39
|
+
idempotency_key: "idempotency-key",
|
|
37
40
|
request_id: "request-id",
|
|
38
41
|
straddle_account_id: "straddle-account-id"
|
|
39
42
|
}
|
|
@@ -87,6 +90,43 @@ module Straddle
|
|
|
87
90
|
)
|
|
88
91
|
end
|
|
89
92
|
|
|
93
|
+
# Updates the decision of a customer's identity validation. This endpoint allows
|
|
94
|
+
# you to modify the outcome of a customer decision and is useful for correcting or
|
|
95
|
+
# updating the status of a customer's verification.
|
|
96
|
+
#
|
|
97
|
+
# @overload refresh_review(id, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
98
|
+
#
|
|
99
|
+
# @param id [String]
|
|
100
|
+
#
|
|
101
|
+
# @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
|
|
102
|
+
#
|
|
103
|
+
# @param idempotency_key [String] Optional client generated value to use for idempotent requests.
|
|
104
|
+
#
|
|
105
|
+
# @param request_id [String] Optional client generated identifier to trace and debug a request.
|
|
106
|
+
#
|
|
107
|
+
# @param straddle_account_id [String] For use by platforms to specify an account id and set scope of a request.
|
|
108
|
+
#
|
|
109
|
+
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
110
|
+
#
|
|
111
|
+
# @return [Straddle::Models::CustomerV1]
|
|
112
|
+
#
|
|
113
|
+
# @see Straddle::Models::Customers::ReviewRefreshReviewParams
|
|
114
|
+
def refresh_review(id, params = {})
|
|
115
|
+
parsed, options = Straddle::Customers::ReviewRefreshReviewParams.dump_request(params)
|
|
116
|
+
@client.request(
|
|
117
|
+
method: :put,
|
|
118
|
+
path: ["v1/customers/%1$s/refresh_review", id],
|
|
119
|
+
headers: parsed.transform_keys(
|
|
120
|
+
correlation_id: "correlation-id",
|
|
121
|
+
idempotency_key: "idempotency-key",
|
|
122
|
+
request_id: "request-id",
|
|
123
|
+
straddle_account_id: "straddle-account-id"
|
|
124
|
+
),
|
|
125
|
+
model: Straddle::CustomerV1,
|
|
126
|
+
options: options
|
|
127
|
+
)
|
|
128
|
+
end
|
|
129
|
+
|
|
90
130
|
# @api private
|
|
91
131
|
#
|
|
92
132
|
# @param client [Straddle::Client]
|
|
@@ -13,7 +13,7 @@ module Straddle
|
|
|
13
13
|
# risk assessment scores. This endpoint allows you to create a customer profile
|
|
14
14
|
# and associate it with paykeys and payments.
|
|
15
15
|
#
|
|
16
|
-
# @overload create(device:, email:, name:, phone:, type:, address: nil, compliance_profile: nil, config: nil, external_id: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
16
|
+
# @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
17
|
#
|
|
18
18
|
# @param device [Straddle::Models::DeviceUnmaskedV1] Body param:
|
|
19
19
|
#
|
|
@@ -38,6 +38,8 @@ module Straddle
|
|
|
38
38
|
#
|
|
39
39
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
40
40
|
#
|
|
41
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
42
|
+
#
|
|
41
43
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
42
44
|
#
|
|
43
45
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -52,6 +54,7 @@ module Straddle
|
|
|
52
54
|
header_params =
|
|
53
55
|
{
|
|
54
56
|
correlation_id: "correlation-id",
|
|
57
|
+
idempotency_key: "idempotency-key",
|
|
55
58
|
request_id: "request-id",
|
|
56
59
|
straddle_account_id: "straddle-account-id"
|
|
57
60
|
}
|
|
@@ -71,7 +74,7 @@ module Straddle
|
|
|
71
74
|
# Updates an existing customer's information. This endpoint allows you to modify
|
|
72
75
|
# the customer's contact details, PII, and metadata.
|
|
73
76
|
#
|
|
74
|
-
# @overload update(id, device:, email:, name:, phone:, status:, address: nil, compliance_profile: nil, external_id: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
77
|
+
# @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: {})
|
|
75
78
|
#
|
|
76
79
|
# @param id [String] Path param:
|
|
77
80
|
#
|
|
@@ -95,6 +98,8 @@ module Straddle
|
|
|
95
98
|
#
|
|
96
99
|
# @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
|
|
97
100
|
#
|
|
101
|
+
# @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
|
|
102
|
+
#
|
|
98
103
|
# @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
|
|
99
104
|
#
|
|
100
105
|
# @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
|
|
@@ -109,6 +114,7 @@ module Straddle
|
|
|
109
114
|
header_params =
|
|
110
115
|
{
|
|
111
116
|
correlation_id: "correlation-id",
|
|
117
|
+
idempotency_key: "idempotency-key",
|
|
112
118
|
request_id: "request-id",
|
|
113
119
|
straddle_account_id: "straddle-account-id"
|
|
114
120
|
}
|
|
@@ -203,12 +209,14 @@ module Straddle
|
|
|
203
209
|
# undone and should only be used to satisfy regulatory requirements or for privacy
|
|
204
210
|
# compliance.
|
|
205
211
|
#
|
|
206
|
-
# @overload delete(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
212
|
+
# @overload delete(id, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
207
213
|
#
|
|
208
214
|
# @param id [String]
|
|
209
215
|
#
|
|
210
216
|
# @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
|
|
211
217
|
#
|
|
218
|
+
# @param idempotency_key [String] Optional client generated value to use for idempotent requests.
|
|
219
|
+
#
|
|
212
220
|
# @param request_id [String] Optional client generated identifier to trace and debug a request.
|
|
213
221
|
#
|
|
214
222
|
# @param straddle_account_id [String] For use by platforms to specify an account id and set scope of a request.
|
|
@@ -225,6 +233,7 @@ module Straddle
|
|
|
225
233
|
path: ["v1/customers/%1$s", id],
|
|
226
234
|
headers: parsed.transform_keys(
|
|
227
235
|
correlation_id: "correlation-id",
|
|
236
|
+
idempotency_key: "idempotency-key",
|
|
228
237
|
request_id: "request-id",
|
|
229
238
|
straddle_account_id: "straddle-account-id"
|
|
230
239
|
),
|
|
@@ -267,40 +276,6 @@ module Straddle
|
|
|
267
276
|
)
|
|
268
277
|
end
|
|
269
278
|
|
|
270
|
-
# Updates the decision of a customer's identity validation. This endpoint allows
|
|
271
|
-
# you to modify the outcome of a customer decision and is useful for correcting or
|
|
272
|
-
# updating the status of a customer's verification.
|
|
273
|
-
#
|
|
274
|
-
# @overload refresh_review(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
275
|
-
#
|
|
276
|
-
# @param id [String]
|
|
277
|
-
#
|
|
278
|
-
# @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
|
|
279
|
-
#
|
|
280
|
-
# @param request_id [String] Optional client generated identifier to trace and debug a request.
|
|
281
|
-
#
|
|
282
|
-
# @param straddle_account_id [String] For use by platforms to specify an account id and set scope of a request.
|
|
283
|
-
#
|
|
284
|
-
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
285
|
-
#
|
|
286
|
-
# @return [Straddle::Models::CustomerV1]
|
|
287
|
-
#
|
|
288
|
-
# @see Straddle::Models::CustomerRefreshReviewParams
|
|
289
|
-
def refresh_review(id, params = {})
|
|
290
|
-
parsed, options = Straddle::CustomerRefreshReviewParams.dump_request(params)
|
|
291
|
-
@client.request(
|
|
292
|
-
method: :put,
|
|
293
|
-
path: ["v1/customers/%1$s/refresh_review", id],
|
|
294
|
-
headers: parsed.transform_keys(
|
|
295
|
-
correlation_id: "correlation-id",
|
|
296
|
-
request_id: "request-id",
|
|
297
|
-
straddle_account_id: "straddle-account-id"
|
|
298
|
-
),
|
|
299
|
-
model: Straddle::CustomerV1,
|
|
300
|
-
options: options
|
|
301
|
-
)
|
|
302
|
-
end
|
|
303
|
-
|
|
304
279
|
# Retrieves the unmasked details, including PII, of an existing customer. Supply
|
|
305
280
|
# the unique customer ID that was returned from your 'create customer' request,
|
|
306
281
|
# and Straddle will return the corresponding customer information. This endpoint
|