straddle 0.2.0 → 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.
Files changed (111) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +23 -0
  3. data/README.md +1 -1
  4. data/lib/straddle/internal/transport/base_client.rb +7 -1
  5. data/lib/straddle/internal/transport/pooled_net_requester.rb +36 -26
  6. data/lib/straddle/internal/util.rb +5 -5
  7. data/lib/straddle/models/bridge/link_bank_account_params.rb +31 -2
  8. data/lib/straddle/models/bridge/link_create_paykey_params.rb +31 -2
  9. data/lib/straddle/models/bridge/link_create_paykey_response.rb +31 -2
  10. data/lib/straddle/models/bridge/link_create_tan_params.rb +30 -2
  11. data/lib/straddle/models/bridge/link_create_tan_response.rb +31 -2
  12. data/lib/straddle/models/bridge/link_plaid_params.rb +30 -2
  13. data/lib/straddle/models/bridge_initialize_params.rb +30 -2
  14. data/lib/straddle/models/customers/review_refresh_review_params.rb +40 -0
  15. data/lib/straddle/models/embed/linked_bank_account_list_params.rb +51 -1
  16. data/lib/straddle/models/funding_event_list_params.rb +9 -1
  17. data/lib/straddle/models/funding_event_summary_item_v1.rb +25 -1
  18. data/lib/straddle/models/funding_event_summary_paged_v1.rb +25 -1
  19. data/lib/straddle/models/paykey_reveal_response.rb +31 -2
  20. data/lib/straddle/models/paykey_summary_paged_v1.rb +30 -2
  21. data/lib/straddle/models/paykey_unmasked_v1.rb +30 -2
  22. data/lib/straddle/models/{customer_refresh_review_params.rb → paykey_update_balance_params.rb} +2 -2
  23. data/lib/straddle/models/paykey_v1.rb +30 -2
  24. data/lib/straddle/models/paykeys/review_decision_params.rb +56 -0
  25. data/lib/straddle/models/paykeys/review_get_params.rb +34 -0
  26. data/lib/straddle/models/paykeys/review_get_response.rb +642 -0
  27. data/lib/straddle/models/paykeys/review_refresh_review_params.rb +40 -0
  28. data/lib/straddle/models/payment_summary_paged_v1.rb +9 -1
  29. data/lib/straddle/models.rb +3 -3
  30. data/lib/straddle/resources/bridge/link.rb +12 -4
  31. data/lib/straddle/resources/bridge.rb +3 -1
  32. data/lib/straddle/resources/customers/review.rb +37 -0
  33. data/lib/straddle/resources/customers.rb +0 -37
  34. data/lib/straddle/resources/embed/linked_bank_accounts.rb +15 -2
  35. data/lib/straddle/resources/funding_events.rb +4 -1
  36. data/lib/straddle/resources/paykeys/review.rb +128 -0
  37. data/lib/straddle/resources/paykeys.rb +36 -39
  38. data/lib/straddle/version.rb +1 -1
  39. data/lib/straddle.rb +8 -2
  40. data/manifest.yaml +1 -0
  41. data/rbi/straddle/internal/transport/base_client.rbi +5 -0
  42. data/rbi/straddle/internal/transport/pooled_net_requester.rbi +6 -2
  43. data/rbi/straddle/internal/type/base_model.rbi +8 -4
  44. data/rbi/straddle/models/bridge/link_bank_account_params.rbi +76 -1
  45. data/rbi/straddle/models/bridge/link_create_paykey_params.rbi +76 -1
  46. data/rbi/straddle/models/bridge/link_create_paykey_response.rbi +76 -1
  47. data/rbi/straddle/models/bridge/link_create_tan_params.rbi +76 -1
  48. data/rbi/straddle/models/bridge/link_create_tan_response.rbi +76 -1
  49. data/rbi/straddle/models/bridge/link_plaid_params.rbi +76 -1
  50. data/rbi/straddle/models/bridge_initialize_params.rbi +76 -1
  51. data/rbi/straddle/models/customers/review_refresh_review_params.rbi +76 -0
  52. data/rbi/straddle/models/embed/linked_bank_account_list_params.rbi +149 -0
  53. data/rbi/straddle/models/funding_event_list_params.rbi +8 -0
  54. data/rbi/straddle/models/funding_event_summary_item_v1.rbi +24 -0
  55. data/rbi/straddle/models/funding_event_summary_paged_v1.rbi +24 -0
  56. data/rbi/straddle/models/paykey_reveal_response.rbi +76 -1
  57. data/rbi/straddle/models/paykey_summary_paged_v1.rbi +76 -1
  58. data/rbi/straddle/models/paykey_unmasked_v1.rbi +76 -1
  59. data/rbi/straddle/models/{customer_refresh_review_params.rbi → paykey_update_balance_params.rbi} +2 -2
  60. data/rbi/straddle/models/paykey_v1.rbi +76 -1
  61. data/rbi/straddle/models/paykeys/review_decision_params.rbi +115 -0
  62. data/rbi/straddle/models/paykeys/review_get_params.rbi +67 -0
  63. data/rbi/straddle/models/paykeys/review_get_response.rbi +1524 -0
  64. data/rbi/straddle/models/paykeys/review_refresh_review_params.rbi +76 -0
  65. data/rbi/straddle/models/payment_summary_paged_v1.rbi +8 -0
  66. data/rbi/straddle/models.rbi +3 -3
  67. data/rbi/straddle/resources/bridge/link.rbi +16 -0
  68. data/rbi/straddle/resources/bridge.rbi +4 -0
  69. data/rbi/straddle/resources/customers/review.rbi +27 -0
  70. data/rbi/straddle/resources/customers.rbi +0 -27
  71. data/rbi/straddle/resources/embed/linked_bank_accounts.rbi +10 -0
  72. data/rbi/straddle/resources/funding_events.rbi +3 -0
  73. data/rbi/straddle/resources/paykeys/review.rbi +94 -0
  74. data/rbi/straddle/resources/paykeys.rbi +19 -21
  75. data/sig/straddle/internal/transport/base_client.rbs +2 -0
  76. data/sig/straddle/internal/transport/pooled_net_requester.rbs +4 -1
  77. data/sig/straddle/models/bridge/link_bank_account_params.rbs +28 -1
  78. data/sig/straddle/models/bridge/link_create_paykey_params.rbs +28 -1
  79. data/sig/straddle/models/bridge/link_create_paykey_response.rbs +28 -1
  80. data/sig/straddle/models/bridge/link_create_tan_params.rbs +28 -1
  81. data/sig/straddle/models/bridge/link_create_tan_response.rbs +28 -1
  82. data/sig/straddle/models/bridge/link_plaid_params.rbs +28 -1
  83. data/sig/straddle/models/bridge_initialize_params.rbs +28 -1
  84. data/sig/straddle/models/customers/review_refresh_review_params.rbs +51 -0
  85. data/sig/straddle/models/embed/linked_bank_account_list_params.rbs +46 -0
  86. data/sig/straddle/models/funding_event_list_params.rbs +5 -0
  87. data/sig/straddle/models/funding_event_summary_item_v1.rbs +15 -0
  88. data/sig/straddle/models/funding_event_summary_paged_v1.rbs +15 -0
  89. data/sig/straddle/models/paykey_reveal_response.rbs +28 -1
  90. data/sig/straddle/models/paykey_summary_paged_v1.rbs +28 -1
  91. data/sig/straddle/models/paykey_unmasked_v1.rbs +28 -1
  92. data/sig/straddle/models/{customer_refresh_review_params.rbs → paykey_update_balance_params.rbs} +2 -2
  93. data/sig/straddle/models/paykey_v1.rbs +28 -1
  94. data/sig/straddle/models/paykeys/review_decision_params.rbs +67 -0
  95. data/sig/straddle/models/paykeys/review_get_params.rbs +44 -0
  96. data/sig/straddle/models/paykeys/review_get_response.rbs +627 -0
  97. data/sig/straddle/models/paykeys/review_refresh_review_params.rbs +51 -0
  98. data/sig/straddle/models/payment_summary_paged_v1.rbs +5 -0
  99. data/sig/straddle/models.rbs +3 -3
  100. data/sig/straddle/resources/bridge/link.rbs +4 -0
  101. data/sig/straddle/resources/bridge.rbs +1 -0
  102. data/sig/straddle/resources/customers/review.rbs +9 -0
  103. data/sig/straddle/resources/customers.rbs +0 -9
  104. data/sig/straddle/resources/embed/linked_bank_accounts.rbs +2 -0
  105. data/sig/straddle/resources/funding_events.rbs +1 -0
  106. data/sig/straddle/resources/paykeys/review.rbs +36 -0
  107. data/sig/straddle/resources/paykeys.rbs +7 -6
  108. metadata +23 -8
  109. data/lib/straddle/models/paykey_review_params.rb +0 -54
  110. data/rbi/straddle/models/paykey_review_params.rbi +0 -98
  111. data/sig/straddle/models/paykey_review_params.rbs +0 -65
@@ -19,6 +19,13 @@ module Straddle
19
19
  # @return [Straddle::Models::BridgeInitializeParams::Config, nil]
20
20
  optional :config, -> { Straddle::BridgeInitializeParams::Config }
21
21
 
22
+ # @!attribute external_id
23
+ # Unique identifier for the paykey in your database, used for cross-referencing
24
+ # between Straddle and your systems.
25
+ #
26
+ # @return [String, nil]
27
+ optional :external_id, String, nil?: true
28
+
22
29
  # @!attribute correlation_id
23
30
  #
24
31
  # @return [String, nil]
@@ -39,7 +46,7 @@ module Straddle
39
46
  # @return [String, nil]
40
47
  optional :straddle_account_id, String
41
48
 
42
- # @!method initialize(customer_id:, config: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
49
+ # @!method initialize(customer_id:, config: nil, external_id: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
43
50
  # Some parameter documentations has been truncated, see
44
51
  # {Straddle::Models::BridgeInitializeParams} for more details.
45
52
  #
@@ -47,6 +54,8 @@ module Straddle
47
54
  #
48
55
  # @param config [Straddle::Models::BridgeInitializeParams::Config]
49
56
  #
57
+ # @param external_id [String, nil] Unique identifier for the paykey in your database, used for cross-referencing be
58
+ #
50
59
  # @param correlation_id [String]
51
60
  #
52
61
  # @param idempotency_key [String]
@@ -58,14 +67,32 @@ module Straddle
58
67
  # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
59
68
 
60
69
  class Config < Straddle::Internal::Type::BaseModel
70
+ # @!attribute processing_method
71
+ #
72
+ # @return [Symbol, Straddle::Models::BridgeInitializeParams::Config::ProcessingMethod, nil]
73
+ optional :processing_method, enum: -> { Straddle::BridgeInitializeParams::Config::ProcessingMethod }
74
+
61
75
  # @!attribute sandbox_outcome
62
76
  #
63
77
  # @return [Symbol, Straddle::Models::BridgeInitializeParams::Config::SandboxOutcome, nil]
64
78
  optional :sandbox_outcome, enum: -> { Straddle::BridgeInitializeParams::Config::SandboxOutcome }
65
79
 
66
- # @!method initialize(sandbox_outcome: nil)
80
+ # @!method initialize(processing_method: nil, sandbox_outcome: nil)
81
+ # @param processing_method [Symbol, Straddle::Models::BridgeInitializeParams::Config::ProcessingMethod]
67
82
  # @param sandbox_outcome [Symbol, Straddle::Models::BridgeInitializeParams::Config::SandboxOutcome]
68
83
 
84
+ # @see Straddle::Models::BridgeInitializeParams::Config#processing_method
85
+ module ProcessingMethod
86
+ extend Straddle::Internal::Type::Enum
87
+
88
+ INLINE = :inline
89
+ BACKGROUND = :background
90
+ SKIP = :skip
91
+
92
+ # @!method self.values
93
+ # @return [Array<Symbol>]
94
+ end
95
+
69
96
  # @see Straddle::Models::BridgeInitializeParams::Config#sandbox_outcome
70
97
  module SandboxOutcome
71
98
  extend Straddle::Internal::Type::Enum
@@ -73,6 +100,7 @@ module Straddle
73
100
  STANDARD = :standard
74
101
  ACTIVE = :active
75
102
  REJECTED = :rejected
103
+ REVIEW = :review
76
104
 
77
105
  # @!method self.values
78
106
  # @return [Array<Symbol>]
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Straddle
4
+ module Models
5
+ module Customers
6
+ # @see Straddle::Resources::Customers::Review#refresh_review
7
+ class ReviewRefreshReviewParams < 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
+ # @!attribute straddle_account_id
27
+ #
28
+ # @return [String, nil]
29
+ optional :straddle_account_id, String
30
+
31
+ # @!method initialize(correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
32
+ # @param correlation_id [String]
33
+ # @param idempotency_key [String]
34
+ # @param request_id [String]
35
+ # @param straddle_account_id [String]
36
+ # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
37
+ end
38
+ end
39
+ end
40
+ end
@@ -31,6 +31,13 @@ module Straddle
31
31
  # @return [Integer, nil]
32
32
  optional :page_size, Integer
33
33
 
34
+ # @!attribute purpose
35
+ # The purpose of the linked bank accounts to return. Possible values: 'charges',
36
+ # 'payouts', 'billing'.
37
+ #
38
+ # @return [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Purpose, nil]
39
+ optional :purpose, enum: -> { Straddle::Embed::LinkedBankAccountListParams::Purpose }
40
+
34
41
  # @!attribute sort_by
35
42
  # Sort By.
36
43
  #
@@ -43,6 +50,13 @@ module Straddle
43
50
  # @return [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::SortOrder, nil]
44
51
  optional :sort_order, enum: -> { Straddle::Embed::LinkedBankAccountListParams::SortOrder }
45
52
 
53
+ # @!attribute status
54
+ # The status of the linked bank accounts to return. Possible values: 'created',
55
+ # 'onboarding', 'active', 'inactive', 'rejected'.
56
+ #
57
+ # @return [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Status, nil]
58
+ optional :status, enum: -> { Straddle::Embed::LinkedBankAccountListParams::Status }
59
+
46
60
  # @!attribute correlation_id
47
61
  #
48
62
  # @return [String, nil]
@@ -53,7 +67,10 @@ module Straddle
53
67
  # @return [String, nil]
54
68
  optional :request_id, String
55
69
 
56
- # @!method initialize(account_id: nil, level: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, request_options: {})
70
+ # @!method initialize(account_id: nil, level: nil, page_number: nil, page_size: nil, purpose: nil, sort_by: nil, sort_order: nil, status: nil, correlation_id: nil, request_id: nil, request_options: {})
71
+ # Some parameter documentations has been truncated, see
72
+ # {Straddle::Models::Embed::LinkedBankAccountListParams} for more details.
73
+ #
57
74
  # @param account_id [String] The unique identifier of the related account.
58
75
  #
59
76
  # @param level [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Level]
@@ -62,10 +79,14 @@ module Straddle
62
79
  #
63
80
  # @param page_size [Integer] Page size. Max value: 1000
64
81
  #
82
+ # @param purpose [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Purpose] The purpose of the linked bank accounts to return. Possible values: 'charges', '
83
+ #
65
84
  # @param sort_by [String] Sort By.
66
85
  #
67
86
  # @param sort_order [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::SortOrder] Sort Order.
68
87
  #
88
+ # @param status [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Status] The status of the linked bank accounts to return. Possible values: 'created', 'o
89
+ #
69
90
  # @param correlation_id [String]
70
91
  #
71
92
  # @param request_id [String]
@@ -82,6 +103,19 @@ module Straddle
82
103
  # @return [Array<Symbol>]
83
104
  end
84
105
 
106
+ # The purpose of the linked bank accounts to return. Possible values: 'charges',
107
+ # 'payouts', 'billing'.
108
+ module Purpose
109
+ extend Straddle::Internal::Type::Enum
110
+
111
+ CHARGES = :charges
112
+ PAYOUTS = :payouts
113
+ BILLING = :billing
114
+
115
+ # @!method self.values
116
+ # @return [Array<Symbol>]
117
+ end
118
+
85
119
  # Sort Order.
86
120
  module SortOrder
87
121
  extend Straddle::Internal::Type::Enum
@@ -92,6 +126,22 @@ module Straddle
92
126
  # @!method self.values
93
127
  # @return [Array<Symbol>]
94
128
  end
129
+
130
+ # The status of the linked bank accounts to return. Possible values: 'created',
131
+ # 'onboarding', 'active', 'inactive', 'rejected'.
132
+ module Status
133
+ extend Straddle::Internal::Type::Enum
134
+
135
+ CREATED = :created
136
+ ONBOARDING = :onboarding
137
+ ACTIVE = :active
138
+ REJECTED = :rejected
139
+ INACTIVE = :inactive
140
+ CANCELED = :canceled
141
+
142
+ # @!method self.values
143
+ # @return [Array<Symbol>]
144
+ end
95
145
  end
96
146
  end
97
147
  end
@@ -45,6 +45,12 @@ module Straddle
45
45
  # @return [Integer, nil]
46
46
  optional :page_size, Integer
47
47
 
48
+ # @!attribute search_text
49
+ # Search text.
50
+ #
51
+ # @return [String, nil]
52
+ optional :search_text, String, nil?: true
53
+
48
54
  # @!attribute sort_by
49
55
  # The field to sort the results by.
50
56
  #
@@ -78,7 +84,7 @@ module Straddle
78
84
  # @return [String, nil]
79
85
  optional :straddle_account_id, String
80
86
 
81
- # @!method initialize(created_from: nil, created_to: nil, direction: nil, event_type: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, trace_number: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
87
+ # @!method initialize(created_from: nil, created_to: nil, direction: nil, event_type: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, trace_number: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
82
88
  # Some parameter documentations has been truncated, see
83
89
  # {Straddle::Models::FundingEventListParams} for more details.
84
90
  #
@@ -94,6 +100,8 @@ module Straddle
94
100
  #
95
101
  # @param page_size [Integer] Results page size. Max value: 1000
96
102
  #
103
+ # @param search_text [String, nil] Search text.
104
+ #
97
105
  # @param sort_by [Symbol, Straddle::Models::FundingEventListParams::SortBy] The field to sort the results by.
98
106
  #
99
107
  # @param sort_order [Symbol, Straddle::Models::FundingEventListParams::SortOrder] The order in which to sort the results.
@@ -51,6 +51,12 @@ module Straddle
51
51
  # @return [Integer]
52
52
  required :amount, Integer
53
53
 
54
+ # @!attribute created_at
55
+ # Created at.
56
+ #
57
+ # @return [Time]
58
+ required :created_at, Time
59
+
54
60
  # @!attribute direction
55
61
  # Describes the direction of the funding event from the perspective of the
56
62
  # `linked_bank_account`.
@@ -71,6 +77,12 @@ module Straddle
71
77
  # @return [Integer]
72
78
  required :payment_count, Integer
73
79
 
80
+ # @!attribute trace_ids
81
+ # Trace Ids.
82
+ #
83
+ # @return [Hash{Symbol=>String}]
84
+ required :trace_ids, Straddle::Internal::Type::HashOf[String]
85
+
74
86
  # @!attribute trace_numbers
75
87
  # Trace number.
76
88
  #
@@ -85,13 +97,19 @@ module Straddle
85
97
  # @return [Date]
86
98
  required :transfer_date, Date
87
99
 
100
+ # @!attribute updated_at
101
+ # Updated at.
102
+ #
103
+ # @return [Time]
104
+ required :updated_at, Time
105
+
88
106
  # @!attribute trace_number
89
107
  # The trace number of the funding event.
90
108
  #
91
109
  # @return [String, nil]
92
110
  optional :trace_number, String, nil?: true
93
111
 
94
- # @!method initialize(id:, amount:, direction:, event_type:, payment_count:, trace_numbers:, transfer_date:, trace_number: nil)
112
+ # @!method initialize(id:, amount:, created_at:, direction:, event_type:, payment_count:, trace_ids:, trace_numbers:, transfer_date:, updated_at:, trace_number: nil)
95
113
  # Some parameter documentations has been truncated, see
96
114
  # {Straddle::Models::FundingEventSummaryItemV1::Data} for more details.
97
115
  #
@@ -99,16 +117,22 @@ module Straddle
99
117
  #
100
118
  # @param amount [Integer] The amount of the funding event in cents.
101
119
  #
120
+ # @param created_at [Time] Created at.
121
+ #
102
122
  # @param direction [Symbol, Straddle::Models::FundingEventSummaryItemV1::Data::Direction] Describes the direction of the funding event from the perspective of the `linked
103
123
  #
104
124
  # @param event_type [Symbol, Straddle::Models::FundingEventSummaryItemV1::Data::EventType] The funding event types describes the direction and reason for the funding event
105
125
  #
106
126
  # @param payment_count [Integer] The number of payments associated with the funding event.
107
127
  #
128
+ # @param trace_ids [Hash{Symbol=>String}] Trace Ids.
129
+ #
108
130
  # @param trace_numbers [Array<String>] Trace number.
109
131
  #
110
132
  # @param transfer_date [Date] The date on which the funding event occurred. For `deposits` and `returns`, this
111
133
  #
134
+ # @param updated_at [Time] Updated at.
135
+ #
112
136
  # @param trace_number [String, nil] The trace number of the funding event.
113
137
 
114
138
  # Describes the direction of the funding event from the perspective of the
@@ -48,6 +48,12 @@ module Straddle
48
48
  # @return [Integer]
49
49
  required :amount, Integer
50
50
 
51
+ # @!attribute created_at
52
+ # Created at.
53
+ #
54
+ # @return [Time]
55
+ required :created_at, Time
56
+
51
57
  # @!attribute direction
52
58
  # Describes the direction of the funding event from the perspective of the
53
59
  # `linked_bank_account`.
@@ -68,6 +74,12 @@ module Straddle
68
74
  # @return [Integer]
69
75
  required :payment_count, Integer
70
76
 
77
+ # @!attribute trace_ids
78
+ # Trace Ids.
79
+ #
80
+ # @return [Hash{Symbol=>String}]
81
+ required :trace_ids, Straddle::Internal::Type::HashOf[String]
82
+
71
83
  # @!attribute trace_numbers
72
84
  # Trace number.
73
85
  #
@@ -82,13 +94,19 @@ module Straddle
82
94
  # @return [Date]
83
95
  required :transfer_date, Date
84
96
 
97
+ # @!attribute updated_at
98
+ # Updated at.
99
+ #
100
+ # @return [Time]
101
+ required :updated_at, Time
102
+
85
103
  # @!attribute trace_number
86
104
  # The trace number of the funding event.
87
105
  #
88
106
  # @return [String, nil]
89
107
  optional :trace_number, String, nil?: true
90
108
 
91
- # @!method initialize(id:, amount:, direction:, event_type:, payment_count:, trace_numbers:, transfer_date:, trace_number: nil)
109
+ # @!method initialize(id:, amount:, created_at:, direction:, event_type:, payment_count:, trace_ids:, trace_numbers:, transfer_date:, updated_at:, trace_number: nil)
92
110
  # Some parameter documentations has been truncated, see
93
111
  # {Straddle::Models::FundingEventSummaryPagedV1::Data} for more details.
94
112
  #
@@ -96,16 +114,22 @@ module Straddle
96
114
  #
97
115
  # @param amount [Integer] The amount of the funding event in cents.
98
116
  #
117
+ # @param created_at [Time] Created at.
118
+ #
99
119
  # @param direction [Symbol, Straddle::Models::FundingEventSummaryPagedV1::Data::Direction] Describes the direction of the funding event from the perspective of the `linked
100
120
  #
101
121
  # @param event_type [Symbol, Straddle::Models::FundingEventSummaryPagedV1::Data::EventType] The funding event types describes the direction and reason for the funding event
102
122
  #
103
123
  # @param payment_count [Integer] The number of payments associated with the funding event.
104
124
  #
125
+ # @param trace_ids [Hash{Symbol=>String}] Trace Ids.
126
+ #
105
127
  # @param trace_numbers [Array<String>] Trace number.
106
128
  #
107
129
  # @param transfer_date [Date] The date on which the funding event occurred. For `deposits` and `returns`, this
108
130
  #
131
+ # @param updated_at [Time] Updated at.
132
+ #
109
133
  # @param trace_number [String, nil] The trace number of the funding event.
110
134
 
111
135
  # Describes the direction of the funding event from the perspective of the
@@ -108,6 +108,13 @@ module Straddle
108
108
  # @return [Time, nil]
109
109
  optional :expires_at, Time, nil?: true
110
110
 
111
+ # @!attribute external_id
112
+ # Unique identifier for the paykey in your database, used for cross-referencing
113
+ # between Straddle and your systems.
114
+ #
115
+ # @return [String, nil]
116
+ optional :external_id, String, nil?: true
117
+
111
118
  # @!attribute institution_name
112
119
  # Name of the financial institution.
113
120
  #
@@ -126,7 +133,7 @@ module Straddle
126
133
  # @return [Straddle::Models::PaykeyRevealResponse::Data::StatusDetails, nil]
127
134
  optional :status_details, -> { Straddle::Models::PaykeyRevealResponse::Data::StatusDetails }
128
135
 
129
- # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, institution_name: nil, metadata: nil, status_details: nil)
136
+ # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, metadata: nil, status_details: nil)
130
137
  # Some parameter documentations has been truncated, see
131
138
  # {Straddle::Models::PaykeyRevealResponse::Data} for more details.
132
139
  #
@@ -154,6 +161,8 @@ module Straddle
154
161
  #
155
162
  # @param expires_at [Time, nil] Expiration date and time of the paykey, if applicable.
156
163
  #
164
+ # @param external_id [String, nil] Unique identifier for the paykey in your database, used for cross-referencing be
165
+ #
157
166
  # @param institution_name [String, nil] Name of the financial institution.
158
167
  #
159
168
  # @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
@@ -162,15 +171,34 @@ module Straddle
162
171
 
163
172
  # @see Straddle::Models::PaykeyRevealResponse::Data#config
164
173
  class Config < Straddle::Internal::Type::BaseModel
174
+ # @!attribute processing_method
175
+ #
176
+ # @return [Symbol, Straddle::Models::PaykeyRevealResponse::Data::Config::ProcessingMethod, nil]
177
+ optional :processing_method,
178
+ enum: -> { Straddle::Models::PaykeyRevealResponse::Data::Config::ProcessingMethod }
179
+
165
180
  # @!attribute sandbox_outcome
166
181
  #
167
182
  # @return [Symbol, Straddle::Models::PaykeyRevealResponse::Data::Config::SandboxOutcome, nil]
168
183
  optional :sandbox_outcome,
169
184
  enum: -> { Straddle::Models::PaykeyRevealResponse::Data::Config::SandboxOutcome }
170
185
 
171
- # @!method initialize(sandbox_outcome: nil)
186
+ # @!method initialize(processing_method: nil, sandbox_outcome: nil)
187
+ # @param processing_method [Symbol, Straddle::Models::PaykeyRevealResponse::Data::Config::ProcessingMethod]
172
188
  # @param sandbox_outcome [Symbol, Straddle::Models::PaykeyRevealResponse::Data::Config::SandboxOutcome]
173
189
 
190
+ # @see Straddle::Models::PaykeyRevealResponse::Data::Config#processing_method
191
+ module ProcessingMethod
192
+ extend Straddle::Internal::Type::Enum
193
+
194
+ INLINE = :inline
195
+ BACKGROUND = :background
196
+ SKIP = :skip
197
+
198
+ # @!method self.values
199
+ # @return [Array<Symbol>]
200
+ end
201
+
174
202
  # @see Straddle::Models::PaykeyRevealResponse::Data::Config#sandbox_outcome
175
203
  module SandboxOutcome
176
204
  extend Straddle::Internal::Type::Enum
@@ -178,6 +206,7 @@ module Straddle
178
206
  STANDARD = :standard
179
207
  ACTIVE = :active
180
208
  REJECTED = :rejected
209
+ REVIEW = :review
181
210
 
182
211
  # @!method self.values
183
212
  # @return [Array<Symbol>]
@@ -100,6 +100,13 @@ module Straddle
100
100
  # @return [Time, nil]
101
101
  optional :expires_at, Time, nil?: true
102
102
 
103
+ # @!attribute external_id
104
+ # Unique identifier for the paykey in your database, used for cross-referencing
105
+ # between Straddle and your systems.
106
+ #
107
+ # @return [String, nil]
108
+ optional :external_id, String, nil?: true
109
+
103
110
  # @!attribute institution_name
104
111
  # Name of the financial institution.
105
112
  #
@@ -111,7 +118,7 @@ module Straddle
111
118
  # @return [Straddle::Models::PaykeySummaryPagedV1::Data::StatusDetails, nil]
112
119
  optional :status_details, -> { Straddle::PaykeySummaryPagedV1::Data::StatusDetails }
113
120
 
114
- # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, bank_data: nil, customer_id: nil, expires_at: nil, institution_name: nil, status_details: nil)
121
+ # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, status_details: nil)
115
122
  # Some parameter documentations has been truncated, see
116
123
  # {Straddle::Models::PaykeySummaryPagedV1::Data} for more details.
117
124
  #
@@ -137,20 +144,40 @@ module Straddle
137
144
  #
138
145
  # @param expires_at [Time, nil] Expiration date and time of the paykey, if applicable.
139
146
  #
147
+ # @param external_id [String, nil] Unique identifier for the paykey in your database, used for cross-referencing be
148
+ #
140
149
  # @param institution_name [String, nil] Name of the financial institution.
141
150
  #
142
151
  # @param status_details [Straddle::Models::PaykeySummaryPagedV1::Data::StatusDetails]
143
152
 
144
153
  # @see Straddle::Models::PaykeySummaryPagedV1::Data#config
145
154
  class Config < Straddle::Internal::Type::BaseModel
155
+ # @!attribute processing_method
156
+ #
157
+ # @return [Symbol, Straddle::Models::PaykeySummaryPagedV1::Data::Config::ProcessingMethod, nil]
158
+ optional :processing_method, enum: -> { Straddle::PaykeySummaryPagedV1::Data::Config::ProcessingMethod }
159
+
146
160
  # @!attribute sandbox_outcome
147
161
  #
148
162
  # @return [Symbol, Straddle::Models::PaykeySummaryPagedV1::Data::Config::SandboxOutcome, nil]
149
163
  optional :sandbox_outcome, enum: -> { Straddle::PaykeySummaryPagedV1::Data::Config::SandboxOutcome }
150
164
 
151
- # @!method initialize(sandbox_outcome: nil)
165
+ # @!method initialize(processing_method: nil, sandbox_outcome: nil)
166
+ # @param processing_method [Symbol, Straddle::Models::PaykeySummaryPagedV1::Data::Config::ProcessingMethod]
152
167
  # @param sandbox_outcome [Symbol, Straddle::Models::PaykeySummaryPagedV1::Data::Config::SandboxOutcome]
153
168
 
169
+ # @see Straddle::Models::PaykeySummaryPagedV1::Data::Config#processing_method
170
+ module ProcessingMethod
171
+ extend Straddle::Internal::Type::Enum
172
+
173
+ INLINE = :inline
174
+ BACKGROUND = :background
175
+ SKIP = :skip
176
+
177
+ # @!method self.values
178
+ # @return [Array<Symbol>]
179
+ end
180
+
154
181
  # @see Straddle::Models::PaykeySummaryPagedV1::Data::Config#sandbox_outcome
155
182
  module SandboxOutcome
156
183
  extend Straddle::Internal::Type::Enum
@@ -158,6 +185,7 @@ module Straddle
158
185
  STANDARD = :standard
159
186
  ACTIVE = :active
160
187
  REJECTED = :rejected
188
+ REVIEW = :review
161
189
 
162
190
  # @!method self.values
163
191
  # @return [Array<Symbol>]
@@ -107,6 +107,13 @@ module Straddle
107
107
  # @return [Time, nil]
108
108
  optional :expires_at, Time, nil?: true
109
109
 
110
+ # @!attribute external_id
111
+ # Unique identifier for the paykey in your database, used for cross-referencing
112
+ # between Straddle and your systems.
113
+ #
114
+ # @return [String, nil]
115
+ optional :external_id, String, nil?: true
116
+
110
117
  # @!attribute institution_name
111
118
  # Name of the financial institution.
112
119
  #
@@ -125,7 +132,7 @@ module Straddle
125
132
  # @return [Straddle::Models::PaykeyUnmaskedV1::Data::StatusDetails, nil]
126
133
  optional :status_details, -> { Straddle::PaykeyUnmaskedV1::Data::StatusDetails }
127
134
 
128
- # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, institution_name: nil, metadata: nil, status_details: nil)
135
+ # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, metadata: nil, status_details: nil)
129
136
  # Some parameter documentations has been truncated, see
130
137
  # {Straddle::Models::PaykeyUnmaskedV1::Data} for more details.
131
138
  #
@@ -153,6 +160,8 @@ module Straddle
153
160
  #
154
161
  # @param expires_at [Time, nil] Expiration date and time of the paykey, if applicable.
155
162
  #
163
+ # @param external_id [String, nil] Unique identifier for the paykey in your database, used for cross-referencing be
164
+ #
156
165
  # @param institution_name [String, nil] Name of the financial institution.
157
166
  #
158
167
  # @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
@@ -161,14 +170,32 @@ module Straddle
161
170
 
162
171
  # @see Straddle::Models::PaykeyUnmaskedV1::Data#config
163
172
  class Config < Straddle::Internal::Type::BaseModel
173
+ # @!attribute processing_method
174
+ #
175
+ # @return [Symbol, Straddle::Models::PaykeyUnmaskedV1::Data::Config::ProcessingMethod, nil]
176
+ optional :processing_method, enum: -> { Straddle::PaykeyUnmaskedV1::Data::Config::ProcessingMethod }
177
+
164
178
  # @!attribute sandbox_outcome
165
179
  #
166
180
  # @return [Symbol, Straddle::Models::PaykeyUnmaskedV1::Data::Config::SandboxOutcome, nil]
167
181
  optional :sandbox_outcome, enum: -> { Straddle::PaykeyUnmaskedV1::Data::Config::SandboxOutcome }
168
182
 
169
- # @!method initialize(sandbox_outcome: nil)
183
+ # @!method initialize(processing_method: nil, sandbox_outcome: nil)
184
+ # @param processing_method [Symbol, Straddle::Models::PaykeyUnmaskedV1::Data::Config::ProcessingMethod]
170
185
  # @param sandbox_outcome [Symbol, Straddle::Models::PaykeyUnmaskedV1::Data::Config::SandboxOutcome]
171
186
 
187
+ # @see Straddle::Models::PaykeyUnmaskedV1::Data::Config#processing_method
188
+ module ProcessingMethod
189
+ extend Straddle::Internal::Type::Enum
190
+
191
+ INLINE = :inline
192
+ BACKGROUND = :background
193
+ SKIP = :skip
194
+
195
+ # @!method self.values
196
+ # @return [Array<Symbol>]
197
+ end
198
+
172
199
  # @see Straddle::Models::PaykeyUnmaskedV1::Data::Config#sandbox_outcome
173
200
  module SandboxOutcome
174
201
  extend Straddle::Internal::Type::Enum
@@ -176,6 +203,7 @@ module Straddle
176
203
  STANDARD = :standard
177
204
  ACTIVE = :active
178
205
  REJECTED = :rejected
206
+ REVIEW = :review
179
207
 
180
208
  # @!method self.values
181
209
  # @return [Array<Symbol>]
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Straddle
4
4
  module Models
5
- # @see Straddle::Resources::Customers#refresh_review
6
- class CustomerRefreshReviewParams < Straddle::Internal::Type::BaseModel
5
+ # @see Straddle::Resources::Paykeys#update_balance
6
+ class PaykeyUpdateBalanceParams < Straddle::Internal::Type::BaseModel
7
7
  extend Straddle::Internal::Type::RequestParameters::Converter
8
8
  include Straddle::Internal::Type::RequestParameters
9
9