straddle 0.1.1 → 0.2.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 +43 -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 +12 -8
- data/lib/straddle/internal/transport/pooled_net_requester.rb +8 -19
- 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 +4 -3
- data/lib/straddle/models/bridge/link_bank_account_params.rb +9 -5
- data/lib/straddle/models/bridge/link_create_paykey_params.rb +9 -5
- data/lib/straddle/models/bridge/link_create_tan_params.rb +9 -5
- data/lib/straddle/models/bridge/link_plaid_params.rb +8 -1
- data/lib/straddle/models/bridge_initialize_params.rb +8 -1
- 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_refresh_review_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/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_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/paykey_cancel_params.rb +7 -1
- data/lib/straddle/models/paykey_review_params.rb +54 -0
- 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 +2 -0
- data/lib/straddle/resources/bridge/link.rb +16 -4
- data/lib/straddle/resources/bridge.rb +4 -1
- data/lib/straddle/resources/charges.rb +20 -5
- data/lib/straddle/resources/customers/review.rb +4 -1
- data/lib/straddle/resources/customers.rb +16 -4
- 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 +51 -5
- data/lib/straddle/resources/embed/organizations.rb +5 -2
- data/lib/straddle/resources/embed/representatives.rb +14 -4
- data/lib/straddle/resources/paykeys.rb +47 -1
- data/lib/straddle/resources/payouts.rb +20 -5
- data/lib/straddle/version.rb +1 -1
- data/lib/straddle.rb +2 -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 +5 -6
- 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 +9 -0
- data/rbi/straddle/models/bridge/link_create_paykey_params.rbi +9 -0
- data/rbi/straddle/models/bridge/link_create_tan_params.rbi +9 -0
- data/rbi/straddle/models/bridge/link_plaid_params.rbi +9 -0
- data/rbi/straddle/models/bridge_initialize_params.rbi +9 -0
- 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_refresh_review_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/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_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/paykey_cancel_params.rbi +9 -0
- data/rbi/straddle/models/paykey_review_params.rbi +98 -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 +2 -0
- data/rbi/straddle/resources/bridge/link.rbi +12 -0
- data/rbi/straddle/resources/bridge.rbi +3 -0
- data/rbi/straddle/resources/charges.rbi +15 -0
- data/rbi/straddle/resources/customers/review.rbi +3 -0
- data/rbi/straddle/resources/customers.rbi +12 -0
- 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 +46 -1
- data/rbi/straddle/resources/embed/organizations.rbi +3 -0
- data/rbi/straddle/resources/embed/representatives.rbi +14 -0
- data/rbi/straddle/resources/paykeys.rbi +34 -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 +1 -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 +7 -0
- data/sig/straddle/models/bridge/link_create_paykey_params.rbs +7 -0
- data/sig/straddle/models/bridge/link_create_tan_params.rbs +7 -0
- data/sig/straddle/models/bridge/link_plaid_params.rbs +7 -0
- data/sig/straddle/models/bridge_initialize_params.rbs +7 -0
- 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_refresh_review_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/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_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/paykey_cancel_params.rbs +7 -0
- data/sig/straddle/models/paykey_review_params.rbs +65 -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 +2 -0
- data/sig/straddle/resources/bridge/link.rbs +4 -0
- data/sig/straddle/resources/bridge.rbs +1 -0
- data/sig/straddle/resources/charges.rbs +5 -0
- data/sig/straddle/resources/customers/review.rbs +1 -0
- data/sig/straddle/resources/customers.rbs +4 -0
- 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 +14 -1
- data/sig/straddle/resources/embed/organizations.rbs +1 -0
- data/sig/straddle/resources/embed/representatives.rbs +4 -0
- data/sig/straddle/resources/paykeys.rbs +11 -0
- data/sig/straddle/resources/payouts.rbs +5 -0
- metadata +9 -3
|
@@ -281,10 +281,7 @@ module Straddle
|
|
|
281
281
|
# @!attribute customer_types
|
|
282
282
|
#
|
|
283
283
|
# @return [Straddle::Models::Embed::AccountPagedV1::Data::Capabilities::CustomerTypes]
|
|
284
|
-
required :customer_types,
|
|
285
|
-
-> {
|
|
286
|
-
Straddle::Embed::AccountPagedV1::Data::Capabilities::CustomerTypes
|
|
287
|
-
}
|
|
284
|
+
required :customer_types, -> { Straddle::Embed::AccountPagedV1::Data::Capabilities::CustomerTypes }
|
|
288
285
|
|
|
289
286
|
# @!attribute payment_types
|
|
290
287
|
#
|
|
@@ -386,10 +383,7 @@ module Straddle
|
|
|
386
383
|
# Straddle.
|
|
387
384
|
#
|
|
388
385
|
# @return [Symbol, Straddle::Models::Embed::AccountPagedV1::Data::Settings::Charges::FundingTime]
|
|
389
|
-
required :funding_time,
|
|
390
|
-
enum: -> {
|
|
391
|
-
Straddle::Embed::AccountPagedV1::Data::Settings::Charges::FundingTime
|
|
392
|
-
}
|
|
386
|
+
required :funding_time, enum: -> { Straddle::Embed::AccountPagedV1::Data::Settings::Charges::FundingTime }
|
|
393
387
|
|
|
394
388
|
# @!attribute linked_bank_account_id
|
|
395
389
|
# The unique identifier of the linked bank account associated with charges. This
|
|
@@ -464,10 +458,7 @@ module Straddle
|
|
|
464
458
|
# Straddle.
|
|
465
459
|
#
|
|
466
460
|
# @return [Symbol, Straddle::Models::Embed::AccountPagedV1::Data::Settings::Payouts::FundingTime]
|
|
467
|
-
required :funding_time,
|
|
468
|
-
enum: -> {
|
|
469
|
-
Straddle::Embed::AccountPagedV1::Data::Settings::Payouts::FundingTime
|
|
470
|
-
}
|
|
461
|
+
required :funding_time, enum: -> { Straddle::Embed::AccountPagedV1::Data::Settings::Payouts::FundingTime }
|
|
471
462
|
|
|
472
463
|
# @!attribute linked_bank_account_id
|
|
473
464
|
# The unique identifier of the linked bank account to use for payouts.
|
|
@@ -18,14 +18,20 @@ 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]
|
|
24
29
|
optional :request_id, String
|
|
25
30
|
|
|
26
|
-
# @!method initialize(final_status: nil, correlation_id: nil, request_id: nil, request_options: {})
|
|
31
|
+
# @!method initialize(final_status: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
27
32
|
# @param final_status [Symbol, Straddle::Models::Embed::AccountSimulateParams::FinalStatus]
|
|
28
33
|
# @param correlation_id [String]
|
|
34
|
+
# @param idempotency_key [String]
|
|
29
35
|
# @param request_id [String]
|
|
30
36
|
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
|
|
31
37
|
|
|
@@ -32,12 +32,17 @@ module Straddle
|
|
|
32
32
|
# @return [String, nil]
|
|
33
33
|
optional :correlation_id, String
|
|
34
34
|
|
|
35
|
+
# @!attribute idempotency_key
|
|
36
|
+
#
|
|
37
|
+
# @return [String, nil]
|
|
38
|
+
optional :idempotency_key, String
|
|
39
|
+
|
|
35
40
|
# @!attribute request_id
|
|
36
41
|
#
|
|
37
42
|
# @return [String, nil]
|
|
38
43
|
optional :request_id, String
|
|
39
44
|
|
|
40
|
-
# @!method initialize(business_profile:, external_id: nil, metadata: nil, correlation_id: nil, request_id: nil, request_options: {})
|
|
45
|
+
# @!method initialize(business_profile:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
41
46
|
# Some parameter documentations has been truncated, see
|
|
42
47
|
# {Straddle::Models::Embed::AccountUpdateParams} for more details.
|
|
43
48
|
#
|
|
@@ -49,6 +54,8 @@ module Straddle
|
|
|
49
54
|
#
|
|
50
55
|
# @param correlation_id [String]
|
|
51
56
|
#
|
|
57
|
+
# @param idempotency_key [String]
|
|
58
|
+
#
|
|
52
59
|
# @param request_id [String]
|
|
53
60
|
#
|
|
54
61
|
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -384,10 +384,7 @@ module Straddle
|
|
|
384
384
|
# Straddle.
|
|
385
385
|
#
|
|
386
386
|
# @return [Symbol, Straddle::Models::Embed::AccountV1::Data::Settings::Charges::FundingTime]
|
|
387
|
-
required :funding_time,
|
|
388
|
-
enum: -> {
|
|
389
|
-
Straddle::Embed::AccountV1::Data::Settings::Charges::FundingTime
|
|
390
|
-
}
|
|
387
|
+
required :funding_time, enum: -> { Straddle::Embed::AccountV1::Data::Settings::Charges::FundingTime }
|
|
391
388
|
|
|
392
389
|
# @!attribute linked_bank_account_id
|
|
393
390
|
# The unique identifier of the linked bank account associated with charges. This
|
|
@@ -461,10 +458,7 @@ module Straddle
|
|
|
461
458
|
# Straddle.
|
|
462
459
|
#
|
|
463
460
|
# @return [Symbol, Straddle::Models::Embed::AccountV1::Data::Settings::Payouts::FundingTime]
|
|
464
|
-
required :funding_time,
|
|
465
|
-
enum: -> {
|
|
466
|
-
Straddle::Embed::AccountV1::Data::Settings::Payouts::FundingTime
|
|
467
|
-
}
|
|
461
|
+
required :funding_time, enum: -> { Straddle::Embed::AccountV1::Data::Settings::Payouts::FundingTime }
|
|
468
462
|
|
|
469
463
|
# @!attribute linked_bank_account_id
|
|
470
464
|
# The unique identifier of the linked bank account to use for payouts.
|
|
@@ -53,12 +53,17 @@ module Straddle
|
|
|
53
53
|
# @return [String, nil]
|
|
54
54
|
optional :correlation_id, String
|
|
55
55
|
|
|
56
|
+
# @!attribute idempotency_key
|
|
57
|
+
#
|
|
58
|
+
# @return [String, nil]
|
|
59
|
+
optional :idempotency_key, String
|
|
60
|
+
|
|
56
61
|
# @!attribute request_id
|
|
57
62
|
#
|
|
58
63
|
# @return [String, nil]
|
|
59
64
|
optional :request_id, String
|
|
60
65
|
|
|
61
|
-
# @!method initialize(businesses: nil, charges: nil, individuals: nil, internet: nil, payouts: nil, signed_agreement: nil, correlation_id: nil, request_id: nil, request_options: {})
|
|
66
|
+
# @!method initialize(businesses: nil, charges: nil, individuals: nil, internet: nil, payouts: nil, signed_agreement: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
62
67
|
# Some parameter documentations has been truncated, see
|
|
63
68
|
# {Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams} for more
|
|
64
69
|
# details.
|
|
@@ -77,6 +82,8 @@ module Straddle
|
|
|
77
82
|
#
|
|
78
83
|
# @param correlation_id [String]
|
|
79
84
|
#
|
|
85
|
+
# @param idempotency_key [String]
|
|
86
|
+
#
|
|
80
87
|
# @param request_id [String]
|
|
81
88
|
#
|
|
82
89
|
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -10,9 +10,7 @@ module Straddle
|
|
|
10
10
|
#
|
|
11
11
|
# @return [Array<Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data>]
|
|
12
12
|
required :data,
|
|
13
|
-
-> {
|
|
14
|
-
Straddle::Internal::Type::ArrayOf[Straddle::Embed::Accounts::CapabilityRequestPagedV1::Data]
|
|
15
|
-
}
|
|
13
|
+
-> { Straddle::Internal::Type::ArrayOf[Straddle::Embed::Accounts::CapabilityRequestPagedV1::Data] }
|
|
16
14
|
|
|
17
15
|
# @!attribute meta
|
|
18
16
|
# Metadata about the API request, including an identifier, timestamp, and
|
|
@@ -31,10 +29,7 @@ module Straddle
|
|
|
31
29
|
# - "none" means no data is returned.
|
|
32
30
|
#
|
|
33
31
|
# @return [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::ResponseType]
|
|
34
|
-
required :response_type,
|
|
35
|
-
enum: -> {
|
|
36
|
-
Straddle::Embed::Accounts::CapabilityRequestPagedV1::ResponseType
|
|
37
|
-
}
|
|
32
|
+
required :response_type, enum: -> { Straddle::Embed::Accounts::CapabilityRequestPagedV1::ResponseType }
|
|
38
33
|
|
|
39
34
|
# @!method initialize(data:, meta:, response_type:)
|
|
40
35
|
# Some parameter documentations has been truncated, see
|
|
@@ -65,10 +60,7 @@ module Straddle
|
|
|
65
60
|
# `consent_type` for `signed_agreement` or `internet` payment authorization.
|
|
66
61
|
#
|
|
67
62
|
# @return [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data::Category]
|
|
68
|
-
required :category,
|
|
69
|
-
enum: -> {
|
|
70
|
-
Straddle::Embed::Accounts::CapabilityRequestPagedV1::Data::Category
|
|
71
|
-
}
|
|
63
|
+
required :category, enum: -> { Straddle::Embed::Accounts::CapabilityRequestPagedV1::Data::Category }
|
|
72
64
|
|
|
73
65
|
# @!attribute created_at
|
|
74
66
|
# Timestamp of when the capability request was created.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Straddle
|
|
4
|
+
module Models
|
|
5
|
+
module Embed
|
|
6
|
+
# @see Straddle::Resources::Embed::LinkedBankAccounts#cancel
|
|
7
|
+
class LinkedBankAccountCancelParams < Straddle::Internal::Type::BaseModel
|
|
8
|
+
extend Straddle::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Straddle::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute correlation_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String, nil]
|
|
14
|
+
optional :correlation_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute idempotency_key
|
|
17
|
+
#
|
|
18
|
+
# @return [String, nil]
|
|
19
|
+
optional :idempotency_key, String
|
|
20
|
+
|
|
21
|
+
# @!attribute request_id
|
|
22
|
+
#
|
|
23
|
+
# @return [String, nil]
|
|
24
|
+
optional :request_id, String
|
|
25
|
+
|
|
26
|
+
# @!method initialize(correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
27
|
+
# @param correlation_id [String]
|
|
28
|
+
# @param idempotency_key [String]
|
|
29
|
+
# @param request_id [String]
|
|
30
|
+
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
@@ -12,14 +12,20 @@ module Straddle
|
|
|
12
12
|
# The unique identifier of the Straddle account to associate this bank account
|
|
13
13
|
# with.
|
|
14
14
|
#
|
|
15
|
-
# @return [String]
|
|
16
|
-
required :account_id, String
|
|
15
|
+
# @return [String, nil]
|
|
16
|
+
required :account_id, String, nil?: true
|
|
17
17
|
|
|
18
18
|
# @!attribute bank_account
|
|
19
19
|
#
|
|
20
20
|
# @return [Straddle::Models::Embed::LinkedBankAccountCreateParams::BankAccount]
|
|
21
21
|
required :bank_account, -> { Straddle::Embed::LinkedBankAccountCreateParams::BankAccount }
|
|
22
22
|
|
|
23
|
+
# @!attribute description
|
|
24
|
+
# Optional description for the bank account.
|
|
25
|
+
#
|
|
26
|
+
# @return [String, nil]
|
|
27
|
+
optional :description, String, nil?: true
|
|
28
|
+
|
|
23
29
|
# @!attribute metadata
|
|
24
30
|
# Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
25
31
|
# information about the linked bank account in a structured format.
|
|
@@ -27,28 +33,58 @@ module Straddle
|
|
|
27
33
|
# @return [Hash{Symbol=>String, nil}, nil]
|
|
28
34
|
optional :metadata, Straddle::Internal::Type::HashOf[String, nil?: true], nil?: true
|
|
29
35
|
|
|
36
|
+
# @!attribute platform_id
|
|
37
|
+
# The unique identifier of the Straddle Platform to associate this bank account
|
|
38
|
+
# with.
|
|
39
|
+
#
|
|
40
|
+
# @return [String, nil]
|
|
41
|
+
optional :platform_id, String, nil?: true
|
|
42
|
+
|
|
43
|
+
# @!attribute purposes
|
|
44
|
+
# The purposes for the linked bank account.
|
|
45
|
+
#
|
|
46
|
+
# @return [Array<Symbol, Straddle::Models::Embed::LinkedBankAccountCreateParams::Purpose>, nil]
|
|
47
|
+
optional :purposes,
|
|
48
|
+
-> {
|
|
49
|
+
Straddle::Internal::Type::ArrayOf[enum: Straddle::Embed::LinkedBankAccountCreateParams::Purpose]
|
|
50
|
+
},
|
|
51
|
+
nil?: true
|
|
52
|
+
|
|
30
53
|
# @!attribute correlation_id
|
|
31
54
|
#
|
|
32
55
|
# @return [String, nil]
|
|
33
56
|
optional :correlation_id, String
|
|
34
57
|
|
|
58
|
+
# @!attribute idempotency_key
|
|
59
|
+
#
|
|
60
|
+
# @return [String, nil]
|
|
61
|
+
optional :idempotency_key, String
|
|
62
|
+
|
|
35
63
|
# @!attribute request_id
|
|
36
64
|
#
|
|
37
65
|
# @return [String, nil]
|
|
38
66
|
optional :request_id, String
|
|
39
67
|
|
|
40
|
-
# @!method initialize(account_id:, bank_account:, metadata: nil, correlation_id: nil, request_id: nil, request_options: {})
|
|
68
|
+
# @!method initialize(account_id:, bank_account:, description: nil, metadata: nil, platform_id: nil, purposes: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
41
69
|
# Some parameter documentations has been truncated, see
|
|
42
70
|
# {Straddle::Models::Embed::LinkedBankAccountCreateParams} for more details.
|
|
43
71
|
#
|
|
44
|
-
# @param account_id [String] The unique identifier of the Straddle account to associate this bank account wit
|
|
72
|
+
# @param account_id [String, nil] The unique identifier of the Straddle account to associate this bank account wit
|
|
45
73
|
#
|
|
46
74
|
# @param bank_account [Straddle::Models::Embed::LinkedBankAccountCreateParams::BankAccount]
|
|
47
75
|
#
|
|
76
|
+
# @param description [String, nil] Optional description for the bank account.
|
|
77
|
+
#
|
|
48
78
|
# @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
49
79
|
#
|
|
80
|
+
# @param platform_id [String, nil] The unique identifier of the Straddle Platform to associate this bank account wi
|
|
81
|
+
#
|
|
82
|
+
# @param purposes [Array<Symbol, Straddle::Models::Embed::LinkedBankAccountCreateParams::Purpose>, nil] The purposes for the linked bank account.
|
|
83
|
+
#
|
|
50
84
|
# @param correlation_id [String]
|
|
51
85
|
#
|
|
86
|
+
# @param idempotency_key [String]
|
|
87
|
+
#
|
|
52
88
|
# @param request_id [String]
|
|
53
89
|
#
|
|
54
90
|
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -84,6 +120,17 @@ module Straddle
|
|
|
84
120
|
#
|
|
85
121
|
# @param routing_number [String] The routing number of the bank account.
|
|
86
122
|
end
|
|
123
|
+
|
|
124
|
+
module Purpose
|
|
125
|
+
extend Straddle::Internal::Type::Enum
|
|
126
|
+
|
|
127
|
+
CHARGES = :charges
|
|
128
|
+
PAYOUTS = :payouts
|
|
129
|
+
BILLING = :billing
|
|
130
|
+
|
|
131
|
+
# @!method self.values
|
|
132
|
+
# @return [Array<Symbol>]
|
|
133
|
+
end
|
|
87
134
|
end
|
|
88
135
|
end
|
|
89
136
|
end
|
|
@@ -7,10 +7,7 @@ module Straddle
|
|
|
7
7
|
# @!attribute data
|
|
8
8
|
#
|
|
9
9
|
# @return [Array<Straddle::Models::Embed::LinkedBankAccountPagedV1::Data>]
|
|
10
|
-
required :data,
|
|
11
|
-
-> {
|
|
12
|
-
Straddle::Internal::Type::ArrayOf[Straddle::Embed::LinkedBankAccountPagedV1::Data]
|
|
13
|
-
}
|
|
10
|
+
required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::Embed::LinkedBankAccountPagedV1::Data] }
|
|
14
11
|
|
|
15
12
|
# @!attribute meta
|
|
16
13
|
# Metadata about the API request, including an identifier, timestamp, and
|
|
@@ -65,6 +62,13 @@ module Straddle
|
|
|
65
62
|
# @return [Time]
|
|
66
63
|
required :created_at, Time
|
|
67
64
|
|
|
65
|
+
# @!attribute purposes
|
|
66
|
+
# The purposes for the linked bank account.
|
|
67
|
+
#
|
|
68
|
+
# @return [Array<Symbol, Straddle::Models::Embed::LinkedBankAccountPagedV1::Data::Purpose>]
|
|
69
|
+
required :purposes,
|
|
70
|
+
-> { Straddle::Internal::Type::ArrayOf[enum: Straddle::Embed::LinkedBankAccountPagedV1::Data::Purpose] }
|
|
71
|
+
|
|
68
72
|
# @!attribute status
|
|
69
73
|
# The current status of the linked bank account.
|
|
70
74
|
#
|
|
@@ -82,6 +86,12 @@ module Straddle
|
|
|
82
86
|
# @return [Time]
|
|
83
87
|
required :updated_at, Time
|
|
84
88
|
|
|
89
|
+
# @!attribute description
|
|
90
|
+
# Optional description for the bank account.
|
|
91
|
+
#
|
|
92
|
+
# @return [String, nil]
|
|
93
|
+
optional :description, String, nil?: true
|
|
94
|
+
|
|
85
95
|
# @!attribute metadata
|
|
86
96
|
# Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
87
97
|
# information about the linked bank account in a structured format.
|
|
@@ -95,7 +105,7 @@ module Straddle
|
|
|
95
105
|
# @return [String, nil]
|
|
96
106
|
optional :platform_id, String, nil?: true
|
|
97
107
|
|
|
98
|
-
# @!method initialize(id:, account_id:, bank_account:, created_at:, status:, status_detail:, updated_at:, metadata: nil, platform_id: nil)
|
|
108
|
+
# @!method initialize(id:, account_id:, bank_account:, created_at:, purposes:, status:, status_detail:, updated_at:, description: nil, metadata: nil, platform_id: nil)
|
|
99
109
|
# Some parameter documentations has been truncated, see
|
|
100
110
|
# {Straddle::Models::Embed::LinkedBankAccountPagedV1::Data} for more details.
|
|
101
111
|
#
|
|
@@ -107,12 +117,16 @@ module Straddle
|
|
|
107
117
|
#
|
|
108
118
|
# @param created_at [Time] Timestamp of when the bank account object was created.
|
|
109
119
|
#
|
|
120
|
+
# @param purposes [Array<Symbol, Straddle::Models::Embed::LinkedBankAccountPagedV1::Data::Purpose>] The purposes for the linked bank account.
|
|
121
|
+
#
|
|
110
122
|
# @param status [Symbol, Straddle::Models::Embed::LinkedBankAccountPagedV1::Data::Status] The current status of the linked bank account.
|
|
111
123
|
#
|
|
112
124
|
# @param status_detail [Straddle::Models::Embed::LinkedBankAccountPagedV1::Data::StatusDetail]
|
|
113
125
|
#
|
|
114
126
|
# @param updated_at [Time] Timestamp of the most recent update to the linked bank account.
|
|
115
127
|
#
|
|
128
|
+
# @param description [String, nil] Optional description for the bank account.
|
|
129
|
+
#
|
|
116
130
|
# @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
117
131
|
#
|
|
118
132
|
# @param platform_id [String, nil] The unique identifier of the Straddle Platform relatd to this bank account.
|
|
@@ -146,6 +160,17 @@ module Straddle
|
|
|
146
160
|
# @param routing_number [String]
|
|
147
161
|
end
|
|
148
162
|
|
|
163
|
+
module Purpose
|
|
164
|
+
extend Straddle::Internal::Type::Enum
|
|
165
|
+
|
|
166
|
+
CHARGES = :charges
|
|
167
|
+
PAYOUTS = :payouts
|
|
168
|
+
BILLING = :billing
|
|
169
|
+
|
|
170
|
+
# @!method self.values
|
|
171
|
+
# @return [Array<Symbol>]
|
|
172
|
+
end
|
|
173
|
+
|
|
149
174
|
# The current status of the linked bank account.
|
|
150
175
|
#
|
|
151
176
|
# @see Straddle::Models::Embed::LinkedBankAccountPagedV1::Data#status
|
|
@@ -157,6 +182,7 @@ module Straddle
|
|
|
157
182
|
ACTIVE = :active
|
|
158
183
|
REJECTED = :rejected
|
|
159
184
|
INACTIVE = :inactive
|
|
185
|
+
CANCELED = :canceled
|
|
160
186
|
|
|
161
187
|
# @!method self.values
|
|
162
188
|
# @return [Array<Symbol>]
|
|
@@ -182,20 +208,14 @@ module Straddle
|
|
|
182
208
|
# handling.
|
|
183
209
|
#
|
|
184
210
|
# @return [Symbol, Straddle::Models::Embed::LinkedBankAccountPagedV1::Data::StatusDetail::Reason]
|
|
185
|
-
required :reason,
|
|
186
|
-
enum: -> {
|
|
187
|
-
Straddle::Embed::LinkedBankAccountPagedV1::Data::StatusDetail::Reason
|
|
188
|
-
}
|
|
211
|
+
required :reason, enum: -> { Straddle::Embed::LinkedBankAccountPagedV1::Data::StatusDetail::Reason }
|
|
189
212
|
|
|
190
213
|
# @!attribute source
|
|
191
214
|
# Identifies the origin of the status change (e.g., `watchtower`). This helps in
|
|
192
215
|
# tracking the cause of status updates.
|
|
193
216
|
#
|
|
194
217
|
# @return [Symbol, Straddle::Models::Embed::LinkedBankAccountPagedV1::Data::StatusDetail::Source]
|
|
195
|
-
required :source,
|
|
196
|
-
enum: -> {
|
|
197
|
-
Straddle::Embed::LinkedBankAccountPagedV1::Data::StatusDetail::Source
|
|
198
|
-
}
|
|
218
|
+
required :source, enum: -> { Straddle::Embed::LinkedBankAccountPagedV1::Data::StatusDetail::Source }
|
|
199
219
|
|
|
200
220
|
# @!method initialize(code:, message:, reason:, source:)
|
|
201
221
|
# Some parameter documentations has been truncated, see
|
|
@@ -146,6 +146,7 @@ module Straddle
|
|
|
146
146
|
ACTIVE = :active
|
|
147
147
|
REJECTED = :rejected
|
|
148
148
|
INACTIVE = :inactive
|
|
149
|
+
CANCELED = :canceled
|
|
149
150
|
|
|
150
151
|
# @!method self.values
|
|
151
152
|
# @return [Array<Symbol>]
|
|
@@ -171,20 +172,14 @@ module Straddle
|
|
|
171
172
|
# handling.
|
|
172
173
|
#
|
|
173
174
|
# @return [Symbol, Straddle::Models::Embed::LinkedBankAccountUnmaskV1::Data::StatusDetail::Reason]
|
|
174
|
-
required :reason,
|
|
175
|
-
enum: -> {
|
|
176
|
-
Straddle::Embed::LinkedBankAccountUnmaskV1::Data::StatusDetail::Reason
|
|
177
|
-
}
|
|
175
|
+
required :reason, enum: -> { Straddle::Embed::LinkedBankAccountUnmaskV1::Data::StatusDetail::Reason }
|
|
178
176
|
|
|
179
177
|
# @!attribute source
|
|
180
178
|
# Identifies the origin of the status change (e.g., `watchtower`). This helps in
|
|
181
179
|
# tracking the cause of status updates.
|
|
182
180
|
#
|
|
183
181
|
# @return [Symbol, Straddle::Models::Embed::LinkedBankAccountUnmaskV1::Data::StatusDetail::Source]
|
|
184
|
-
required :source,
|
|
185
|
-
enum: -> {
|
|
186
|
-
Straddle::Embed::LinkedBankAccountUnmaskV1::Data::StatusDetail::Source
|
|
187
|
-
}
|
|
182
|
+
required :source, enum: -> { Straddle::Embed::LinkedBankAccountUnmaskV1::Data::StatusDetail::Source }
|
|
188
183
|
|
|
189
184
|
# @!method initialize(code:, message:, reason:, source:)
|
|
190
185
|
# Some parameter documentations has been truncated, see
|
|
@@ -25,12 +25,17 @@ module Straddle
|
|
|
25
25
|
# @return [String, nil]
|
|
26
26
|
optional :correlation_id, String
|
|
27
27
|
|
|
28
|
+
# @!attribute idempotency_key
|
|
29
|
+
#
|
|
30
|
+
# @return [String, nil]
|
|
31
|
+
optional :idempotency_key, String
|
|
32
|
+
|
|
28
33
|
# @!attribute request_id
|
|
29
34
|
#
|
|
30
35
|
# @return [String, nil]
|
|
31
36
|
optional :request_id, String
|
|
32
37
|
|
|
33
|
-
# @!method initialize(bank_account:, metadata: nil, correlation_id: nil, request_id: nil, request_options: {})
|
|
38
|
+
# @!method initialize(bank_account:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
34
39
|
# Some parameter documentations has been truncated, see
|
|
35
40
|
# {Straddle::Models::Embed::LinkedBankAccountUpdateParams} for more details.
|
|
36
41
|
#
|
|
@@ -40,6 +45,8 @@ module Straddle
|
|
|
40
45
|
#
|
|
41
46
|
# @param correlation_id [String]
|
|
42
47
|
#
|
|
48
|
+
# @param idempotency_key [String]
|
|
49
|
+
#
|
|
43
50
|
# @param request_id [String]
|
|
44
51
|
#
|
|
45
52
|
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -63,6 +63,13 @@ module Straddle
|
|
|
63
63
|
# @return [Time]
|
|
64
64
|
required :created_at, Time
|
|
65
65
|
|
|
66
|
+
# @!attribute purposes
|
|
67
|
+
# The purposes for the linked bank account.
|
|
68
|
+
#
|
|
69
|
+
# @return [Array<Symbol, Straddle::Models::Embed::LinkedBankAccountV1::Data::Purpose>]
|
|
70
|
+
required :purposes,
|
|
71
|
+
-> { Straddle::Internal::Type::ArrayOf[enum: Straddle::Embed::LinkedBankAccountV1::Data::Purpose] }
|
|
72
|
+
|
|
66
73
|
# @!attribute status
|
|
67
74
|
# The current status of the linked bank account.
|
|
68
75
|
#
|
|
@@ -80,6 +87,12 @@ module Straddle
|
|
|
80
87
|
# @return [Time]
|
|
81
88
|
required :updated_at, Time
|
|
82
89
|
|
|
90
|
+
# @!attribute description
|
|
91
|
+
# Optional description for the bank account.
|
|
92
|
+
#
|
|
93
|
+
# @return [String, nil]
|
|
94
|
+
optional :description, String, nil?: true
|
|
95
|
+
|
|
83
96
|
# @!attribute metadata
|
|
84
97
|
# Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
85
98
|
# information about the linked bank account in a structured format.
|
|
@@ -93,7 +106,7 @@ module Straddle
|
|
|
93
106
|
# @return [String, nil]
|
|
94
107
|
optional :platform_id, String, nil?: true
|
|
95
108
|
|
|
96
|
-
# @!method initialize(id:, account_id:, bank_account:, created_at:, status:, status_detail:, updated_at:, metadata: nil, platform_id: nil)
|
|
109
|
+
# @!method initialize(id:, account_id:, bank_account:, created_at:, purposes:, status:, status_detail:, updated_at:, description: nil, metadata: nil, platform_id: nil)
|
|
97
110
|
# Some parameter documentations has been truncated, see
|
|
98
111
|
# {Straddle::Models::Embed::LinkedBankAccountV1::Data} for more details.
|
|
99
112
|
#
|
|
@@ -105,12 +118,16 @@ module Straddle
|
|
|
105
118
|
#
|
|
106
119
|
# @param created_at [Time] Timestamp of when the bank account object was created.
|
|
107
120
|
#
|
|
121
|
+
# @param purposes [Array<Symbol, Straddle::Models::Embed::LinkedBankAccountV1::Data::Purpose>] The purposes for the linked bank account.
|
|
122
|
+
#
|
|
108
123
|
# @param status [Symbol, Straddle::Models::Embed::LinkedBankAccountV1::Data::Status] The current status of the linked bank account.
|
|
109
124
|
#
|
|
110
125
|
# @param status_detail [Straddle::Models::Embed::LinkedBankAccountV1::Data::StatusDetail]
|
|
111
126
|
#
|
|
112
127
|
# @param updated_at [Time] Timestamp of the most recent update to the linked bank account.
|
|
113
128
|
#
|
|
129
|
+
# @param description [String, nil] Optional description for the bank account.
|
|
130
|
+
#
|
|
114
131
|
# @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
115
132
|
#
|
|
116
133
|
# @param platform_id [String, nil] The unique identifier of the Straddle Platform relatd to this bank account.
|
|
@@ -144,6 +161,17 @@ module Straddle
|
|
|
144
161
|
# @param routing_number [String]
|
|
145
162
|
end
|
|
146
163
|
|
|
164
|
+
module Purpose
|
|
165
|
+
extend Straddle::Internal::Type::Enum
|
|
166
|
+
|
|
167
|
+
CHARGES = :charges
|
|
168
|
+
PAYOUTS = :payouts
|
|
169
|
+
BILLING = :billing
|
|
170
|
+
|
|
171
|
+
# @!method self.values
|
|
172
|
+
# @return [Array<Symbol>]
|
|
173
|
+
end
|
|
174
|
+
|
|
147
175
|
# The current status of the linked bank account.
|
|
148
176
|
#
|
|
149
177
|
# @see Straddle::Models::Embed::LinkedBankAccountV1::Data#status
|
|
@@ -155,6 +183,7 @@ module Straddle
|
|
|
155
183
|
ACTIVE = :active
|
|
156
184
|
REJECTED = :rejected
|
|
157
185
|
INACTIVE = :inactive
|
|
186
|
+
CANCELED = :canceled
|
|
158
187
|
|
|
159
188
|
# @!method self.values
|
|
160
189
|
# @return [Array<Symbol>]
|
|
@@ -33,12 +33,17 @@ module Straddle
|
|
|
33
33
|
# @return [String, nil]
|
|
34
34
|
optional :correlation_id, String
|
|
35
35
|
|
|
36
|
+
# @!attribute idempotency_key
|
|
37
|
+
#
|
|
38
|
+
# @return [String, nil]
|
|
39
|
+
optional :idempotency_key, String
|
|
40
|
+
|
|
36
41
|
# @!attribute request_id
|
|
37
42
|
#
|
|
38
43
|
# @return [String, nil]
|
|
39
44
|
optional :request_id, String
|
|
40
45
|
|
|
41
|
-
# @!method initialize(name:, external_id: nil, metadata: nil, correlation_id: nil, request_id: nil, request_options: {})
|
|
46
|
+
# @!method initialize(name:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
42
47
|
# Some parameter documentations has been truncated, see
|
|
43
48
|
# {Straddle::Models::Embed::OrganizationCreateParams} for more details.
|
|
44
49
|
#
|
|
@@ -50,6 +55,8 @@ module Straddle
|
|
|
50
55
|
#
|
|
51
56
|
# @param correlation_id [String]
|
|
52
57
|
#
|
|
58
|
+
# @param idempotency_key [String]
|
|
59
|
+
#
|
|
53
60
|
# @param request_id [String]
|
|
54
61
|
#
|
|
55
62
|
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -128,6 +128,13 @@ module Straddle
|
|
|
128
128
|
# @return [String, nil]
|
|
129
129
|
optional :external_id, String, nil?: true
|
|
130
130
|
|
|
131
|
+
# @!attribute metadata
|
|
132
|
+
# Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
133
|
+
# information about the represetative in a structured format.
|
|
134
|
+
#
|
|
135
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
136
|
+
optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
|
|
137
|
+
|
|
131
138
|
# @!attribute phone
|
|
132
139
|
#
|
|
133
140
|
# @return [String, nil]
|
|
@@ -140,7 +147,7 @@ module Straddle
|
|
|
140
147
|
# @return [String, nil]
|
|
141
148
|
optional :user_id, String, nil?: true
|
|
142
149
|
|
|
143
|
-
# @!method initialize(id:, account_id:, created_at:, dob:, email:, first_name:, last_name:, mobile_number:, name:, relationship:, ssn_last4:, status:, status_detail:, updated_at:, external_id: nil, phone: nil, user_id: nil)
|
|
150
|
+
# @!method initialize(id:, account_id:, created_at:, dob:, email:, first_name:, last_name:, mobile_number:, name:, relationship:, ssn_last4:, status:, status_detail:, updated_at:, external_id: nil, metadata: nil, phone: nil, user_id: nil)
|
|
144
151
|
# Some parameter documentations has been truncated, see
|
|
145
152
|
# {Straddle::Models::Embed::Representative::Data} for more details.
|
|
146
153
|
#
|
|
@@ -174,6 +181,8 @@ module Straddle
|
|
|
174
181
|
#
|
|
175
182
|
# @param external_id [String, nil] Unique identifier for the representative in your database, used for cross-refere
|
|
176
183
|
#
|
|
184
|
+
# @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
185
|
+
#
|
|
177
186
|
# @param phone [String, nil]
|
|
178
187
|
#
|
|
179
188
|
# @param user_id [String, nil] The unique identifier of the user account associated with this representative, i
|
|
@@ -62,17 +62,29 @@ module Straddle
|
|
|
62
62
|
# @return [String, nil]
|
|
63
63
|
optional :external_id, String, nil?: true
|
|
64
64
|
|
|
65
|
+
# @!attribute metadata
|
|
66
|
+
# Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
67
|
+
# information about the represetative in a structured format.
|
|
68
|
+
#
|
|
69
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
70
|
+
optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
|
|
71
|
+
|
|
65
72
|
# @!attribute correlation_id
|
|
66
73
|
#
|
|
67
74
|
# @return [String, nil]
|
|
68
75
|
optional :correlation_id, String
|
|
69
76
|
|
|
77
|
+
# @!attribute idempotency_key
|
|
78
|
+
#
|
|
79
|
+
# @return [String, nil]
|
|
80
|
+
optional :idempotency_key, String
|
|
81
|
+
|
|
70
82
|
# @!attribute request_id
|
|
71
83
|
#
|
|
72
84
|
# @return [String, nil]
|
|
73
85
|
optional :request_id, String
|
|
74
86
|
|
|
75
|
-
# @!method initialize(account_id:, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, correlation_id: nil, request_id: nil, request_options: {})
|
|
87
|
+
# @!method initialize(account_id:, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
|
|
76
88
|
# Some parameter documentations has been truncated, see
|
|
77
89
|
# {Straddle::Models::Embed::RepresentativeCreateParams} for more details.
|
|
78
90
|
#
|
|
@@ -94,8 +106,12 @@ module Straddle
|
|
|
94
106
|
#
|
|
95
107
|
# @param external_id [String, nil] Unique identifier for the representative in your database, used for cross-refere
|
|
96
108
|
#
|
|
109
|
+
# @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
110
|
+
#
|
|
97
111
|
# @param correlation_id [String]
|
|
98
112
|
#
|
|
113
|
+
# @param idempotency_key [String]
|
|
114
|
+
#
|
|
99
115
|
# @param request_id [String]
|
|
100
116
|
#
|
|
101
117
|
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
|